diff --git a/docs/assets/images/chainlens-block-details.png b/docs/assets/images/chainlens-block-details.png new file mode 100644 index 00000000000..756a3145bb0 Binary files /dev/null and b/docs/assets/images/chainlens-block-details.png differ diff --git a/docs/assets/images/chainlens-block.png b/docs/assets/images/chainlens-block.png new file mode 100644 index 00000000000..be5efc1e408 Binary files /dev/null and b/docs/assets/images/chainlens-block.png differ diff --git a/docs/assets/images/chainlens-contract-details.png b/docs/assets/images/chainlens-contract-details.png new file mode 100644 index 00000000000..4afad979c29 Binary files /dev/null and b/docs/assets/images/chainlens-contract-details.png differ diff --git a/docs/assets/images/chainlens-contracts.png b/docs/assets/images/chainlens-contracts.png new file mode 100644 index 00000000000..fc2ea290c75 Binary files /dev/null and b/docs/assets/images/chainlens-contracts.png differ diff --git a/docs/assets/images/chainlens-dashboard.png b/docs/assets/images/chainlens-dashboard.png new file mode 100644 index 00000000000..5db9998e163 Binary files /dev/null and b/docs/assets/images/chainlens-dashboard.png differ diff --git a/docs/assets/images/chainlens-events.png b/docs/assets/images/chainlens-events.png new file mode 100644 index 00000000000..08540f9494a Binary files /dev/null and b/docs/assets/images/chainlens-events.png differ diff --git a/docs/assets/images/chainlens-loading.png b/docs/assets/images/chainlens-loading.png new file mode 100644 index 00000000000..499e1afa3eb Binary files /dev/null and b/docs/assets/images/chainlens-loading.png differ diff --git a/docs/assets/images/chainlens-transaction-details.png b/docs/assets/images/chainlens-transaction-details.png new file mode 100644 index 00000000000..39cd74e3f7e Binary files /dev/null and b/docs/assets/images/chainlens-transaction-details.png differ diff --git a/docs/assets/images/chainlens-transactions.png b/docs/assets/images/chainlens-transactions.png new file mode 100644 index 00000000000..e8aad29d83c Binary files /dev/null and b/docs/assets/images/chainlens-transactions.png differ diff --git a/docs/assets/images/sirato-block-details.png b/docs/assets/images/sirato-block-details.png deleted file mode 100644 index 6b8922515fd..00000000000 Binary files a/docs/assets/images/sirato-block-details.png and /dev/null differ diff --git a/docs/assets/images/sirato-blocks.png b/docs/assets/images/sirato-blocks.png deleted file mode 100644 index 9d90941ce7e..00000000000 Binary files a/docs/assets/images/sirato-blocks.png and /dev/null differ diff --git a/docs/assets/images/sirato-contract-details.png b/docs/assets/images/sirato-contract-details.png deleted file mode 100644 index a662d4da7ab..00000000000 Binary files a/docs/assets/images/sirato-contract-details.png and /dev/null differ diff --git a/docs/assets/images/sirato-contracts.png b/docs/assets/images/sirato-contracts.png deleted file mode 100644 index a46eecbfb6d..00000000000 Binary files a/docs/assets/images/sirato-contracts.png and /dev/null differ diff --git a/docs/assets/images/sirato-dashboard.png b/docs/assets/images/sirato-dashboard.png deleted file mode 100644 index 5a2effaadd2..00000000000 Binary files a/docs/assets/images/sirato-dashboard.png and /dev/null differ diff --git a/docs/assets/images/sirato-events.png b/docs/assets/images/sirato-events.png deleted file mode 100644 index ad40a9fdfcc..00000000000 Binary files a/docs/assets/images/sirato-events.png and /dev/null differ diff --git a/docs/assets/images/sirato-loading.png b/docs/assets/images/sirato-loading.png deleted file mode 100644 index e15bf4cc6d8..00000000000 Binary files a/docs/assets/images/sirato-loading.png and /dev/null differ diff --git a/docs/assets/images/sirato-token-details.png b/docs/assets/images/sirato-token-details.png deleted file mode 100644 index d2b125df12e..00000000000 Binary files a/docs/assets/images/sirato-token-details.png and /dev/null differ diff --git a/docs/assets/images/sirato-tokens.png b/docs/assets/images/sirato-tokens.png deleted file mode 100644 index ba7d1fc5b48..00000000000 Binary files a/docs/assets/images/sirato-tokens.png and /dev/null differ diff --git a/docs/assets/images/sirato-transaction-details.png b/docs/assets/images/sirato-transaction-details.png deleted file mode 100644 index abbb4f650ab..00000000000 Binary files a/docs/assets/images/sirato-transaction-details.png and /dev/null differ diff --git a/docs/assets/images/sirato-transactions.png b/docs/assets/images/sirato-transactions.png deleted file mode 100644 index 49ec42ae607..00000000000 Binary files a/docs/assets/images/sirato-transactions.png and /dev/null differ diff --git a/docs/private-networks/how-to/monitor/chainlens.md b/docs/private-networks/how-to/monitor/chainlens.md new file mode 100644 index 00000000000..0e5f507621f --- /dev/null +++ b/docs/private-networks/how-to/monitor/chainlens.md @@ -0,0 +1,116 @@ +--- +title: Use Chainlens Explorer +sidebar_position: 7 +description: Use Chainlens Explorer on a privacy-enabled Besu network +tags: + - private networks +--- + +# Use Chainlens Blockchain Explorer + +[Chainlens Blockchain Explorer](https://chainlens.com/) supports public and private EVM networks. +This page describes how to use the free version of Chainlens with its built-in support for +[privacy-enabled](../../concepts/privacy/index.md) Besu networks created using the +[Developer Quickstart](../../tutorials/quickstart.md). + +Chainlens provides an overview of the entire network, including block information, contract +metadata, transaction searches, and [more](https://chainlens.com/). + +:::note +You must connect to one of the privacy nodes (for example, `member1besu`), not the dedicated RPC, to +allow access for Besu [privacy API methods](../../reference/api/index.md#priv-methods). +In production networks, you must [secure access](../../../public-networks/how-to/use-besu-api/authenticate.md) +to RPC nodes. +::: + +## Prerequisites + +[Docker and Docker Compose](https://docs.docker.com/compose/install/) installed. + +## Start Chainlens + +Clone the [Chainlens GitHub repository](https://github.com/web3labs/chainlens-free): + +```bash +git clone https://github.com/web3labs/chainlens-free +``` + +The repository contains a `docker-compose` directory to allow Chainlens to start with a Developer +Quickstart test network. +From the `docker-compose` directory, run the following command: + +```bash +NODE_ENDPOINT=http://rpcnode:8545 docker-compose -f docker-compose.yml -f chainlens-extensions/docker-compose-quorum-dev-quickstart.yml up +``` + +This command does two things: + +- Sets up the node endpoint +- Tells Docker to run by using the two Docker Compose files provided + +The first `docker-compose.yml` file in the command contains all the services required for Chainlens. + +The second file named `docker-compose-quorum-dev-quickstart` contains the network settings required to start +Chainlens on the same network as the Besu development node. + +Next, open `http://localhost/` on your browser. +You’ll see the new initialization page while it boots up. +This may take 5–10 minutes for the all services to start and the ingestion sync to complete. + +![`Chainlens_loading`](../../../assets/images/chainlens-loading.png) + +## View on Chainlens + +After starting Chainlens, you can view information about your network. + +:::note +Screenshots in this section are taken from the [Chainlens Goerli network](https://goerli.chainlens.com/dashboard). +::: + +The **Dashboard** page provides an aggregated view of network activities. + +![`Chainlens_dashboard`](../../../assets/images/chainlens-dashboard.png) + +The **Network** page provides an overview of the network status and connected peers. +This page is disabled by default, and is only visible if you set `DISPLAY_NETWOR_TAB=enabled` using +the following command: + +```bash +NODE_ENDPOINT=http://member1besu:8545 DISPLAY_NETWORK_TAB=enabled docker-compose -f docker-compose.yml -f chainlens-extensions/docker-compose-quorum-dev-quickstart.yml up +``` + +The **Blocks** page shows a real-time view of the finalized blocks. + +![Chainlens blocks](../../../assets/images/chainlens-block.png) + +You can view a given block details by selecting a block hash or number. + +![Chainlens block details](../../../assets/images/chainlens-block-details.png) + +The **Transactions** page shows a paginated view of new and historical transactions. + +![Chainlens transactions](../../../assets/images/chainlens-transactions.png) + +If you select any transaction hash, you can get the **transaction details.** + +![Chainlens transaction_details](../../../assets/images/chainlens-transaction-details.png) + +The **Contracts** page shows all the smart contracts deployed on the network. + +![Chainlens contracts](../../../assets/images/chainlens-contracts.png) + +You can view a smart contract details by selecting the contract address. + +![Chainlens contract details](../../../assets/images/chainlens-contract-details.png) + +The **Events** page shows all the events generated on the network. + +![Chainlens events](../../../assets/images/chainlens-events.png) + +## Stop Chainlens + +To stop all the services from running, run the following command: + +```bash +docker-compose down +``` diff --git a/docs/private-networks/how-to/monitor/index.md b/docs/private-networks/how-to/monitor/index.md index 8dae03bb8ee..08ff29aede2 100644 --- a/docs/private-networks/how-to/monitor/index.md +++ b/docs/private-networks/how-to/monitor/index.md @@ -15,6 +15,6 @@ You can also use the following monitoring tools in private networks: - [Quorum Hibernate](quorum-hibernate.md) - [Splunk](splunk.md) - [OpenTelemetry](opentelemetry.md) -- [Sirato Explorer](sirato-explorer.md) +- [Chainlens Explorer](chainlens.md) For an overview of monitoring Hyperledger Besu, view [this recording](https://www.youtube.com/watch?v=7BuutRe0I28&feature=youtu.be). diff --git a/docs/private-networks/how-to/monitor/sirato-explorer.md b/docs/private-networks/how-to/monitor/sirato-explorer.md deleted file mode 100644 index 0b197267531..00000000000 --- a/docs/private-networks/how-to/monitor/sirato-explorer.md +++ /dev/null @@ -1,125 +0,0 @@ ---- -title: Use Sirato Explorer -sidebar_position: 7 -description: Use Sirato Explorer on a privacy-enabled Besu network -tags: - - private networks ---- - -# Use Sirato Blockchain Explorer - -[Sirato Blockchain Explorer](https://www.web3labs.com/sirato) supports public and private EVM networks. This page describes how to use the free version of Sirato with its built-in support for [privacy-enabled](../../concepts/privacy/index.md) Besu networks created using the [Developer Quickstart](../../tutorials/quickstart.md). - -Sirato provides an overview of the entire network, including block information, contract metadata, transaction searches, and [more](https://medium.com/web3labs/epirus-ethereum-saas-blockchain-explorer-d5d961717d15). - -:::note - -You must connect to one of the privacy nodes (for example, `member1besu`), not the dedicated RPC, in order to allow access for Besu [privacy API methods](../../reference/api/index.md#priv-methods). In production networks, you must [secure access](../../../public-networks/how-to/use-besu-api/authenticate.md) to RPC nodes. - -::: - -## Prerequisites - -[Docker and Docker Compose](https://docs.docker.com/compose/install/) installed. - -## Start Sirato - -Clone the [Sirato GitHub repository](https://github.com/web3labs/sirato-free): - -```bash -git clone https://github.com/web3labs/sirato-free -``` - -The repository contains Docker Compose scripts to allow Sirato to start with a Developer Quickstart test network. - -From the Sirato directory, run the following script: - - - -# Command - -```bash -./start_sirato_besu.sh -``` - -# Result - -```bash -************************************* -Sirator Explorer for Besu -************************************* -Starting explorer --------------------- -[+] Running 5/5 - ⠿ Container docker-compose-mongodb-1 Started 3.3s - ⠿ Container docker-compose-api-1 Started 4.1s - ⠿ Container docker-compose-ingestion-1 Started 4.2s - ⠿ Container docker-compose-web-1 Started 4.4s - ⠿ Container docker-compose-nginx-1 Started 5.0s ----------------------------------- -Services ----------------------------------- -Sirato explorer HTTP endpoint : http://localhost:260012 -Sirato is connected to node : http://rpcnode:8545 -``` - - - -Open `http://localhost/` on your browser. You’ll see the new initialization page while it boots up. This may take 5–10 minutes for the all services to start and the ingestion sync to complete. - -![`Sirato-dashboard`](../../../assets/images/sirato-loading.png) - -## Use Sirato - -The **Dashboard** page provides an aggregated view of network activities. - -![`Epirus-dashboard`](../../../assets/images/sirato-dashboard.png) - -The **Network** page provides an overview of the network status and connected peers. This page is disabled by default, and is only visible if you set `DISPLAY_NETWOR_TAB=enabled` using the following command: - -```bash -NODE_ENDPOINT=http://member1besu:8545 DISPLAY_NETWORK_TAB=enabled docker-compose -f docker-compose.yml -f sirato-extensions/docker-compose-quorum-dev-quickstart.yml up -``` - -![Sirato network](../../../assets/images/sirato-network.png) - -The **Blocks** page shows a real-time view of the finalized blocks. - -![Sirato blocks](../../../assets/images/sirato-blocks.png) - -You can view a given block details by selecting a block hash or number. - -![Sirato block details](../../../assets/images/sirato-block-details.png) - -The **Transactions** page shows a paginated view of new and historical transactions. - -![Sirato transactions](../../../assets/images/sirato-transactions.png) - -## Stop Sirato - -To stop all the services from running, run the following script: - - - -# Command - -```bash -./stop.sh -``` - -# Result - -```bash -************************************* -Sirator Explorer for Besu -************************************* -Stopping explorer -[+] Running 5/5 - ⠿ Container docker-compose-nginx-1 Stopped 0.5s - ⠿ Container docker-compose-ingestion-1 Stopped 4.0s - ⠿ Container docker-compose-web-1 Stopped 10.3s - ⠿ Container docker-compose-api-1 Stopped 2.9s - ⠿ Container docker-compose-mongodb-1 Stopped -``` - - diff --git a/docs/private-networks/tutorials/quickstart.md b/docs/private-networks/tutorials/quickstart.md index 54760801e41..d89b5d31a63 100644 --- a/docs/private-networks/tutorials/quickstart.md +++ b/docs/private-networks/tutorials/quickstart.md @@ -105,30 +105,35 @@ To display the list of endpoints again, run: ## Use a block explorer -You can [use Sirato Blockchain Explorer](../how-to/monitor/sirato-explorer.md) to analyze block information, contract metadata, transaction searches, and more. Sirato has built-in support for privacy-enabled Besu networks. +You can [use Chainlens Blockchain Explorer](../how-to/monitor/chainlens.md) to analyze block +information, contract metadata, transaction searches, and more. +Chainlens has built-in support for privacy-enabled Besu networks. :::note - -You must connect to one of the privacy nodes (for example, `member1besu`), not the dedicated RPC, in order to allow access for Besu [privacy API methods](../reference/api/index.md#priv-methods). In production networks, you must [secure access](../../public-networks/how-to/use-besu-api/authenticate.md) to RPC nodes. - +You must connect to one of the privacy nodes (for example, `member1besu`), not the dedicated RPC, +to allow access for Besu [privacy API methods](../reference/api/index.md#priv-methods). +In production networks, you must [secure access](../../public-networks/how-to/use-besu-api/authenticate.md) +to RPC nodes. ::: -Clone the [Sirato GitHub repository](https://github.com/web3labs/sirato-free): +Clone the [Chainlens GitHub repository](https://github.com/web3labs/chainlens-free): ```bash -git clone https://github.com/web3labs/sirato-free +git clone https://github.com/web3labs/chainlens-free ``` -From the Sirato directory, run the following command: +From the `docker-compose` directory, run the following command: ```bash cd docker-compose -NODE_ENDPOINT=member1besu PORT=26000 docker-compose -f docker-compose.yml -f sirato-extensions/docker-compose-quorum-dev-quickstart.yml up +NODE_ENDPOINT=member1besu PORT=26000 docker-compose -f docker-compose.yml -f chainlens-extensions/docker-compose-quorum-dev-quickstart.yml up ``` -Open `http://localhost/` on your browser. You’ll see the new initialization page while it boots up. This may take 5–10 minutes for the all services to start and the ingestion sync to complete. +Open `http://localhost/` on your browser. +You’ll see the new initialization page while it boots up. +This may take 5–10 minutes for the all services to start and the ingestion sync to complete. -To stop all the services from running, run the following script from the `docker-compose` directory: +To stop all the services from running, run the following command from the `docker-compose` directory: ```bash docker-compose down -v diff --git a/docs/public-networks/reference/projects-using-besu.md b/docs/public-networks/reference/projects-using-besu.md index 7684be3a024..801ed4448db 100644 --- a/docs/public-networks/reference/projects-using-besu.md +++ b/docs/public-networks/reference/projects-using-besu.md @@ -15,4 +15,4 @@ The following block explorers are compatible with Besu: - [BlockScout](https://github.com/blockscout/blockscout#readme) - See the [project documentation](https://docs.blockscout.com/) for setup instructions. -- [Sirato Blockchain Explorer](https://www.web3labs.com/sirato) - See how to [use Sirato with privacy-enabled networks](../../private-networks/how-to/monitor/sirato-explorer.md). +- [Chainlens Blockchain Explorer](https://www.web3labs.com/chainlens) - See how to [use Chainlens with privacy-enabled networks](../../private-networks/how-to/monitor/chainlens.md). diff --git a/project-words.txt b/project-words.txt index 98cfeed9b1d..b86bf40d00a 100644 --- a/project-words.txt +++ b/project-words.txt @@ -7,6 +7,7 @@ Metaspace PONLY Prysm Randao +Chainlens Sirato Snapsync UPNPP