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.

Sign up for GitHub

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

Jump to bottom

Env vars for multiple json rpc urls #332

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Env vars for multiple json rpc urls #332

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 6 additions & 0 deletions setup/env-variables/backend-env-variables.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,12 @@ _**Note**_**: Before release 5.1.2, all environment variables of time format sup
| `TEST_DATABASE_URL` | Defines the endpoint of the Postgres Database that is used during testing. Implemented in [#9662](https://github.com/blockscout/blockscout/pull/9662). | <p>Version: v6.6.0+<br>Default: (empty)<br>Applications: API, Indexer</p> |
| `ETHEREUM_JSONRPC_VARIANT` | Tells the application which RPC Client the node is using (i.e. `erigon`, `geth`, `nethermind`, `besu`, `filecoin`, or `ganache`) (See Client Settings for more info) | <p>Required: ✅<br>Version: All<br>Default: <code>geth</code><br>Applications: API, Indexer</p> |
| `ETHEREUM_JSONRPC_HTTP_URL` | The RPC endpoint used to fetch blocks, transactions, receipts, tokens. | <p>Required: ✅<br>Version: All<br>Default: <code>localhost:8545</code><br>Applications: API, Indexer</p> |
| `ETHEREUM_JSONRPC_HTTP_URLS` | Analogue of `ETHEREUM_JSONRPC_HTTP_URL` for multiple values. Implemented in [#10934](https://github.com/blockscout/blockscout/pull/10934) | <p>Version: master<br>Default: (empty)<br>Applications: API, Indexer</p> |
| `DATABASE_READ_ONLY_API_URL` | Defines the Postgres Database read-only replica endpoint. If provided, most of the read queries from API v2 and UI go through this endpoint. | <p>Required: ✅<br>Version: All<br>Default: (empty)<br>Applications: API</p> |
| `TEST_DATABASE_READ_ONLY_API_URL` | Defines the endpoint of the Postgres Database read-only replica used during testing. If provided, most read queries from API v2 and UI go through this endpoint. Implemented in [#9662](https://github.com/blockscout/blockscout/pull/9662). | <p>Version: v6.6.0+<br>Default: (empty)<br>Applications: API</p> |
| `DATABASE_QUEUE_TARGET` | Management of [DB queue target](https://hexdocs.pm/db\_connection/DBConnection.html#start\_link/2-queue-config). Implemented in [#8991](https://github.com/blockscout/blockscout/pull/8991). | <p>Version: v5.4.0+<br>Default: <code>50ms</code><br>Applications: API, Indexer</p> |
| `ETHEREUM_JSONRPC_TRACE_URL` | The RPC endpoint specifically for the Erigon/Geth/Nethermind/Besu client used by `trace_block` and `trace_replayTransaction`. This can be used to designate a tracing node. | <p>Version: All<br>Default: <code>localhost:8545</code><br>Applications: API, Indexer</p> |
| `ETHEREUM_JSONRPC_TRACE_URLS` | Analogue of `ETHEREUM_JSONRPC_TRACE_URL` for multiple values. Implemented in [#10934](https://github.com/blockscout/blockscout/pull/10934) | <p>Version: master<br>Default: (empty)<br>Applications: API, Indexer</p> |
| `ETHEREUM_JSONRPC_WS_URL` | The WebSockets RPC endpoint used to subscribe to the `newHeads` subscription alerting the indexer to fetch new blocks. | <p>Version: All<br>Default: <code>ws://localhost:8546</code><br>Applications: Indexer</p> |
| `ETHEREUM_JSONRPC_FALLBACK_WS_URL` | The fallback WebSockets RPC endpoint used to subscribe to the `newHeads` subscription alerting the indexer to fetch new blocks. Implemented in [#10407](https://github.com/blockscout/blockscout/pull/10407). | <p>Version: v6.8.0+<br>Default: (empty)<br>Applications: Indexer</p> |
| `ETHEREUM_JSONRPC_WS_RETRY_INTERVAL` | The interval between retries of connecting to WebSocket RPC endpoint after the previous attempt is failed. Implemented in [#10407](https://github.com/blockscout/blockscout/pull/10407). | <p>Version: v6.8.0+<br>Default: 1m<br>Applications: Indexer</p> |
Expand All @@ -35,10 +37,14 @@ _**Note**_**: Before release 5.1.2, all environment variables of time format sup
| `ETHEREUM_JSONRPC_PASSWORD` | Password in basic auth for JSON RPC endpoint. Implemented in [#6897](https://github.com/blockscout/blockscout/pull/6897) | <p>Version: v5.1.2+<br>Default: (empty)<br>Applications: API, Indexer</p> |
| `ETHEREUM_JSONRPC_HTTP_HEADERS` | Custom headers for JSON RPC endpoint in form of json object, example: `{"x-api-key": "nbvkhadvnbkdfav", "x-id": "ndjkfvndfkjv"}`. Implemented in [#7898](https://github.com/blockscout/blockscout/pull/7898) | <p>Version: v5.2.1+<br>Default: (empty)<br>Applications: API, Indexer</p> |
| `ETHEREUM_JSONRPC_FALLBACK_HTTP_URL` | Fallback JSON RPC HTTP url. Implemented in [#7246](https://github.com/blockscout/blockscout/pull/7246) | <p>Version: v5.1.4+<br>Default: (empty)<br>Applications: API, Indexer</p> |
| `ETHEREUM_JSONRPC_FALLBACK_HTTP_URLS` | Analogue of `ETHEREUM_JSONRPC_FALLBACK_HTTP_URL` for multiple values. Implemented in [#10934](https://github.com/blockscout/blockscout/pull/10934) | <p>Version: master<br>Default: (empty)<br>Applications: API, Indexer</p> |
| `ETHEREUM_JSONRPC_FALLBACK_TRACE_URL` | Fallback JSON RPC trace url. Implemented in [#7246](https://github.com/blockscout/blockscout/pull/7246) | <p>Version: v5.1.4+<br>Default: (empty)<br>Applications: API, Indexer</p> |
| `ETHEREUM_JSONRPC_FALLBACK_TRACE_URLS` | Analogue of `ETHEREUM_JSONRPC_FALLBACK_TRACE_URL` for multiple values. Implemented in [#10934](https://github.com/blockscout/blockscout/pull/10934) | <p>Version: master<br>Default: (empty)<br>Applications: API, Indexer</p> |
| `ETHEREUM_JSONRPC_FALLBACK_ETH_CALL_URL` | Fallback JSON RPC `eth_call` url. Implemented in [#9511](https://github.com/blockscout/blockscout/pull/9511) | <p>Version: v6.3.0+<br>Default: (empty)<br>Applications: API, Indexer</p> |
| `ETHEREUM_JSONRPC_FALLBACK_ETH_CALL_URLS` | Analogue of `ETHEREUM_JSONRPC_FALLBACK_ETH_CALL_URL` for multiple values. Implemented in [#10934](https://github.com/blockscout/blockscout/pull/10934) | <p>Version: master<br>Default: (empty)<br>Applications: API, Indexer</p> |
| `ETHEREUM_JSONRPC_WAIT_PER_TIMEOUT` | Wait time for each recent timeout from node. Implemented in [#8292](https://github.com/blockscout/blockscout/pull/8292) | <p>Version: v5.2.3+<br>Default: <code>20s</code><br>Applications: API, Indexer</p> |
| `ETHEREUM_JSONRPC_ETH_CALL_URL` | JSON RPC url for `eth_call` method. Implemented in [#9112](https://github.com/blockscout/blockscout/pull/9112) | <p>Version: v6.0.0+<br>Default: (empty)<br>Applications: API, Indexer</p> |
| `ETHEREUM_JSONRPC_ETH_CALL_URLS` | Analogue of `ETHEREUM_JSONRPC_ETH_CALL_URL` for multiple values. Implemented in [#10934](https://github.com/blockscout/blockscout/pull/10934) | <p>Version: master<br>Default: (empty)<br>Applications: API, Indexer</p> |
| `NETWORK` | Environment variable for the main EVM network such as Ethereum or POA. | <p>Version: All<br>Default: <code>POA</code><br>Applications: API</p> |
| `SUBNETWORK` | Environment variable for the subnetwork such as Core or Sokol Network. This will be displayed as selected in the chains list dropdown. | <p>Version: All<br>Default: <code>POA Sokol</code><br>Applications: API</p> |
| `IPC_PATH` | Path to the IPC file of the running node if IPC transport is chosen. | <p>Version: v2.1.1+<br>Default: (empty)<br>Applications: API, Indexer</p> |
Expand Down