Skip to content

Commit

Permalink
Add Sirato Explorer docs (#1265)
Browse files Browse the repository at this point in the history
* Add Sirato Explorer docs

Signed-off-by: Alexandra Tran <[email protected]>

* CI fixes

Signed-off-by: Alexandra Tran <[email protected]>

* fix left-padding the image alt text

Signed-off-by: Alexandra Tran <[email protected]>

* minor edit

Signed-off-by: Alexandra Tran <[email protected]>

---------

Signed-off-by: Alexandra Tran <[email protected]>
  • Loading branch information
alexandratran authored Feb 9, 2023
1 parent 8bd2d8a commit 12150d2
Show file tree
Hide file tree
Showing 21 changed files with 159 additions and 14 deletions.
1 change: 1 addition & 0 deletions CI/vale/styles/Vocab/Besu/accept.txt
Original file line number Diff line number Diff line change
Expand Up @@ -150,6 +150,7 @@ Ropsten
Mordor
[sS]andbox(ed|ing)
[sS]epolia
Sirato
Slack
[sS]lashable
Splunk
Expand Down
Binary file removed docs/assets/images/ExplorerBlockDetails.png
Binary file not shown.
Binary file removed docs/assets/images/ExplorerSearch.png
Binary file not shown.
Binary file removed docs/assets/images/ExplorerSummary.png
Binary file not shown.
Binary file added docs/assets/images/sirato-block-details.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/sirato-blocks.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/sirato-contract-details.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/sirato-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/sirato-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/sirato-events.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/sirato-loading.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/sirato-network.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/sirato-token-details.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/sirato-tokens.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/sirato-transactions.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions docs/private-networks/how-to/monitor/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ 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)

For an overview of monitoring Hyperledger Besu, view
[this recording](https://www.youtube.com/watch?v=7BuutRe0I28&feature=youtu.be).
123 changes: 123 additions & 0 deletions docs/private-networks/how-to/monitor/sirato-explorer.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,123 @@
---
description: Use Sirato Explorer on a privacy-enabled Besu network
---

# 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
```
37 changes: 26 additions & 11 deletions docs/private-networks/tutorials/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -110,25 +110,40 @@ To display the list of endpoints again, run:
./list.sh
```

## Block explorer
## Use a block explorer

This tutorial uses a modified version of the [Alethio Ethereum Lite Explorer](https://github.com/Alethio/ethereum-lite-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.

Access the explorer at [`http://localhost:25000`](http://localhost:25000) as displayed when starting
the private network.
!!! 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):

The block explorer displays a summary of the private network, indicating four peers.
```bash
git clone https://github.com/web3labs/sirato-free
```

Select the block number to the right of **Best Block** to display the block details:
From the Sirato directory, run the following command:

![Block Details](../../assets/images/ExplorerBlockDetails.png)
```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
```

You can explore blocks by selecting the blocks under **`Bk`** on the left-hand side.
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.

You can search for a specific block, transaction hash, or address by selecting the :mag:
in the top left-hand corner.
To stop all the services from running, run the following script from the `docker-compose` directory:

![Explorer Search](../../assets/images/ExplorerSearch.png)
```bash
docker-compose down -v
```

## Monitor nodes with Prometheus and Grafana

Expand Down
10 changes: 7 additions & 3 deletions docs/public-networks/reference/projects-using-besu.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,10 @@ tags:

## Block explorers

- [BlockScout](https://github.com/blockscout/blockscout#readme) is a Besu-compatible blockchain explorer for inspecting
and analyzing Ethereum-based blockchains.
See the [project documentation](https://docs.blockscout.com/) for setup instructions.
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).
1 change: 1 addition & 0 deletions mkdocs.navigation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -132,6 +132,7 @@ nav:
- Use Quorum Hibernate: private-networks/how-to/monitor/quorum-hibernate.md
- Use Splunk: private-networks/how-to/monitor/splunk.md
- Use OpenTelemtry: private-networks/how-to/monitor/opentelemetry.md
- Use Sirato Explorer: private-networks/how-to/monitor/sirato-explorer.md
- Use privacy:
- Use EEA-compliant privacy: private-networks/how-to/use-privacy/eea-compliant.md
- Use Besu-extended privacy: private-networks/how-to/use-privacy/besu-extended.md
Expand Down

0 comments on commit 12150d2

Please sign in to comment.