Updated Sirato to Chainlens (#1377)

* updated Sirato to Chainlens Signed-off-by: Nischal Sharma <[email protected]> * updated chainlens-free links Signed-off-by: Nischal Sharma <[email protected]> * Content edits Signed-off-by: Alexandra Tran <[email protected]> * fixed directory names Signed-off-by: Nischal Sharma <[email protected]> --------- Signed-off-by: Nischal Sharma <[email protected]> Signed-off-by: Alexandra Tran <[email protected]> Co-authored-by: Alexandra Tran <[email protected]> Co-authored-by: Alexandra Tran Carrillo <[email protected]>
hyperledger · Aug 17, 2023 · 7432323 · 7432323
1 parent 91dbee9
commit 7432323
Show file tree

Hide file tree

Showing 26 changed files with 134 additions and 137 deletions.
diff --git a/docs/assets/images/chainlens-block-details.png b/docs/assets/images/chainlens-block-details.png
diff --git a/docs/assets/images/chainlens-block.png b/docs/assets/images/chainlens-block.png
diff --git a/docs/assets/images/chainlens-contract-details.png b/docs/assets/images/chainlens-contract-details.png
diff --git a/docs/assets/images/chainlens-contracts.png b/docs/assets/images/chainlens-contracts.png
diff --git a/docs/assets/images/chainlens-dashboard.png b/docs/assets/images/chainlens-dashboard.png
diff --git a/docs/assets/images/chainlens-events.png b/docs/assets/images/chainlens-events.png
diff --git a/docs/assets/images/chainlens-loading.png b/docs/assets/images/chainlens-loading.png
diff --git a/docs/assets/images/chainlens-transaction-details.png b/docs/assets/images/chainlens-transaction-details.png
diff --git a/docs/assets/images/chainlens-transactions.png b/docs/assets/images/chainlens-transactions.png
diff --git a/docs/assets/images/sirato-block-details.png b/docs/assets/images/sirato-block-details.png
diff --git a/docs/assets/images/sirato-blocks.png b/docs/assets/images/sirato-blocks.png
diff --git a/docs/assets/images/sirato-contract-details.png b/docs/assets/images/sirato-contract-details.png
diff --git a/docs/assets/images/sirato-contracts.png b/docs/assets/images/sirato-contracts.png
diff --git a/docs/assets/images/sirato-dashboard.png b/docs/assets/images/sirato-dashboard.png
diff --git a/docs/assets/images/sirato-events.png b/docs/assets/images/sirato-events.png
diff --git a/docs/assets/images/sirato-loading.png b/docs/assets/images/sirato-loading.png
diff --git a/docs/assets/images/sirato-token-details.png b/docs/assets/images/sirato-token-details.png
diff --git a/docs/assets/images/sirato-tokens.png b/docs/assets/images/sirato-tokens.png
diff --git a/docs/assets/images/sirato-transaction-details.png b/docs/assets/images/sirato-transaction-details.png
diff --git a/docs/assets/images/sirato-transactions.png b/docs/assets/images/sirato-transactions.png
diff --git a/docs/private-networks/how-to/monitor/chainlens.md 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
@@ -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
diff --git 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
@@ -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
@@ -7,6 +7,7 @@ Metaspace
 PONLY
 Prysm
 Randao
+Chainlens
 Sirato
 Snapsync
 UPNPP
Original file line number	Diff line number	Diff line change
Expand Up		@@ -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).
-Original file line number
+Diff line change
@@ Expand Up / @@ -7,6 +7,7 @@ Metaspace @@
     PONLY
     Prysm
     Randao
+    Chainlens
     Sirato
     Snapsync
     UPNPP
@@ Expand Down @@