Skip to content

Commit

Permalink
Merge pull request #22 from blockscout/vb-besu-support
Browse files Browse the repository at this point in the history
Besu variant added to the docs
  • Loading branch information
vbaranov authored Jun 17, 2020
2 parents afe215b + 95e39b0 commit ca22834
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 7 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,12 @@

## Supported Clients

BlockScout currently supports `Parity`, `Geth`, and `Ganache` clients. To define the node variant, it's advised to define the `ETHEREUM_JSONRPC_VARIANT` environment variable. Correct values include:
BlockScout currently supports Parity, Geth, Nethermind, Hyperledger Besu, and Ganache clients. To define the node variant, it's advised to define the `ETHEREUM_JSONRPC_VARIANT` environment variable. Correct values include:

1. `parity` \(default\)
1. `parity` the same for Parity and Nethermind \(default\)
2. `geth`
3. `ganache`
3. `besu`
5. `ganache`

{% hint style="info" %}
BlockScout currently requires a full archive node in order to import every state change for every address on the target network.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -62,13 +62,14 @@ otherwise, application inside the container cannot read environment variables in

**Available options are:**

* `parity` - Parity JSON RPC \(**Default**\)
* `parity` - Parity JSON RPC (it works fine for Nethermind client as well) \(**Default**\)
* `geth` - Geth JSON RPC
* `besu` - Hyperledger Besu RPC
* `ganache` - Ganache JSON RPC

| Variable | Description | Default value |
| :--- | :--- | :--- |
| `ETHEREUM_JSONRPC_VARIANT` | Variant of your JSON RPC service: `parity`, `geth` or `ganache` | `parity` |
| `ETHEREUM_JSONRPC_VARIANT` | Variant of your JSON RPC service: `parity`, `geth`, `besu` or `ganache` | `parity` |
| `ETHEREUM_JSONRPC_HTTP_URL` | HTTP JSON RPC URL Only for `geth` or `ganache` variant | See below - based on JSONRPC variant |
| `ETHEREUM_JSONRPC_WS_URL` | WS JSON RPC url | See below - based on JSONRPC variant |
| `ETHEREUM_JSONRPC_TRACE_URL` | Trace URL **Only for `parity` variant** | `http://localhost:8545` |
Expand All @@ -85,11 +86,13 @@ otherwise, application inside the container cannot read environment variables in

* For `parity` - `http://localhost:8545`
* For `geth` - `https://mainnet.infura.io/8lTvJTKmHPCHazkneJsY`
* For `besu` - `http://localhost:8545`
* For `ganache` - `http://localhost:7545`

`ETHEREUM_JSONRPC_WS_URL` default values:

* For `parity` - `ws://localhost:8546`
* For `geth` - `wss://mainnet.infura.io/8lTvJTKmHPCHazkneJsY/ws`
* For `besu` - `ws://localhost:8546`
* For `ganache` - `ws://localhost:7545`

4 changes: 2 additions & 2 deletions for-developers/information-and-settings/env-variables.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,9 @@ You will find deprecated ENV vars in [Deprecated ENV Variables](https://docs.blo
| `SUBNETWORK` || Environment variable for the subnetwork such as Core or Sokol Network. This will be displayed as selected in the chains list dropdown. | POA Sokol | all | |
| `LOGO` || Environment variable for the header logo image location. The logo files names for different chains can be found [here](https://github.com/poanetwork/blockscout/tree/master/apps/block_scout_web/assets/static/images) | /images/blockscout\_logo.svg | all | |
| `LOGO_FOOTER` || Environment variable for the footer logo image location. The logo files names for different chains can be found [here](https://github.com/poanetwork/blockscout/tree/master/apps/block_scout_web/assets/static/images) | /images/blockscout\_logo.svg | | |
| `ETHEREUM_JSONRPC_VARIANT` || Tells the application which RPC Client the node is using \(i.e. `geth`, `parity`, or `ganache`\) \([See Client Settings for more info](client-settings-parity-geth-ganache.md)\) | parity | all | |
| `ETHEREUM_JSONRPC_VARIANT` || Tells the application which RPC Client the node is using \(i.e. `geth`, `parity`, `besu`, or `ganache`\) \([See Client Settings for more info](client-settings-parity-geth-ganache.md)\) | parity | all | |
| `ETHEREUM_JSONRPC_HTTP_URL` || The RPC endpoint used to fetch blocks, transactions, receipts, tokens. | localhost:8545 | all | |
| `ETHEREUM_JSONRPC_TRACE_URL` | | The RPC endpoint specifically for the Geth/Parity client used by trace\_block and trace\_replayTransaction. This can be used to designate a tracing node. | localhost:8545 | all | |
| `ETHEREUM_JSONRPC_TRACE_URL` | | The RPC endpoint specifically for the Geth/Parity/Besu client used by trace\_block and trace\_replayTransaction. This can be used to designate a tracing node. | localhost:8545 | all | |
| `ETHEREUM_JSONRPC_WS_URL` || The WebSockets RPC endpoint used to subscribe to the `newHeads` subscription alerting the indexer to fetch new blocks. | ws://localhost:8546 | all | |
| `ETHEREUM_JSONRPC_TRANSPORT` | | Specifies the transport for blockscout to connect to the Ethereum Node. Available transports are `http` and `ipc`. If `ipc` is selected, also set `IPC_PATH` variable | http | v3.1.0+ | |
| `IPC_PATH` | | Path to the ipc file of the running node if IPC transport is chosen | \(empty\) | v2.1.1+ | |
Expand Down

0 comments on commit ca22834

Please sign in to comment.