Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated Sirato to Chainlens #1377

Merged
merged 5 commits into from
Aug 17, 2023
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/images/chainlens-block.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/images/chainlens-contracts.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/images/chainlens-dashboard.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/images/chainlens-events.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/images/chainlens-transactions.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/assets/images/sirato-block-details.png
Binary file not shown.
Binary file removed docs/assets/images/sirato-blocks.png
Binary file not shown.
Binary file removed docs/assets/images/sirato-contract-details.png
Binary file not shown.
Binary file removed docs/assets/images/sirato-contracts.png
Binary file not shown.
Binary file removed docs/assets/images/sirato-dashboard.png
Binary file not shown.
Binary file removed docs/assets/images/sirato-events.png
Binary file not shown.
Binary file removed docs/assets/images/sirato-token-details.png
Binary file not shown.
Binary file removed docs/assets/images/sirato-tokens.png
Binary file not shown.
Binary file not shown.
Binary file removed docs/assets/images/sirato-transactions.png
Binary file not shown.
118 changes: 118 additions & 0 deletions docs/private-networks/how-to/monitor/chainlens.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,118 @@
---
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, 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 Chainlens

Clone the [Chainlens GitHub repository](https://github.com/web3labs/chainlens-free):

```bash
git clone https://github.com/web3labs/chainlens-free
```

The repository contains Docker Compose directory to allow Chainlens to start with a Developer Quickstart test network.

From the docker-compose directory, run the following command:

<!--tabs-->

# Command

```bash
NODE_ENDPOINT=http://rpcnode:8545 docker-compose -f docker-compose.yml -f sirato-extensions/docker-compose-quorum-dev-quickstart.yml up
NickSneo marked this conversation as resolved.
Show resolved Hide resolved
```

The command above does two things:

- It sets up the node endpoint
- Tells docker to run by using the two docker compose files provided.

The first docker-compose file in the command contains all the services required for Chainlens.

The second file named docker-compose-besu contains the network settings required to start Chainlens on the same network as Besu dev node.



# Result

<!--/tabs-->

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)

## Chainlens Overview

*screenshots are taken from [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 sirato-extensions/docker-compose-quorum-dev-quickstart.yml up
NickSneo marked this conversation as resolved.
Show resolved Hide resolved
```



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 click on 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:

<!--tabs-->

# Command

```bash
docker-compose down
```
2 changes: 1 addition & 1 deletion docs/private-networks/how-to/monitor/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
125 changes: 0 additions & 125 deletions docs/private-networks/how-to/monitor/sirato-explorer.md

This file was deleted.

8 changes: 4 additions & 4 deletions docs/private-networks/tutorials/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,21 +105,21 @@ 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.

:::

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
Expand Down
2 changes: 1 addition & 1 deletion docs/public-networks/reference/projects-using-besu.md
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).
1 change: 1 addition & 0 deletions project-words.txt
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ Metaspace
PONLY
Prysm
Randao
Chainlens
Sirato
Snapsync
UPNPP
Expand Down