Backend ENV variables

Page In Progress, please see main ENV Variables page for all current vars.

Categories

Time format

Can be set in format 1h for 1 hour, 1m for 1 minute, 1s or 1 for 1 second, 1ms for 1 millisecond

Note: Before release 5.1.2, all environment variables of time format supported only integers in seconds (without dimensions) as values.

General Management

VariableDescriptionParameters

DATABASE_URL

Defines the Postgres Database endpoint.

Required: ✅ Version: All Default: (empty) Applications: API, Indexer

TEST_DATABASE_URL

Defines the endpoint of the Postgres Database that is used during testing. Implemented in #9662.

Version: v6.6.0+ Default: (empty) Applications: API, Indexer

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)

Required: ✅ Version: All Default: ganache Applications: API, Indexer

ETHEREUM_JSONRPC_HTTP_URL

The RPC endpoint used to fetch blocks, transactions, receipts, tokens.

Required: ✅ Version: All Default: localhost:8545 Applications: API, Indexer

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.

Required: ✅ Version: All Default: (empty) Applications: API

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.

Version: v6.6.0+ Default: (empty) Applications: API

DATABASE_QUEUE_TARGET

Management of DB queue target. Implemented in #8991.

Version: v5.4.0+ Default: 50ms Applications: API, Indexer

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.

Version: All Default: localhost:8545 Applications: API, Indexer

ETHEREUM_JSONRPC_WS_URL

The WebSockets RPC endpoint used to subscribe to the newHeads subscription alerting the indexer to fetch new blocks.

Version: All Default: ws://localhost:8546 Applications: Indexer

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.

Version: v3.1.0+ Default: http Applications: API, Indexer

ETHEREUM_JSONRPC_HTTP_INSECURE

If true is set, allows insecure HTTP connections to the archive node. For instance, it allows to bypass expired SSL certificate at the archive node endpoint. Implemented in #6573

Version: v5.0.0+ Default: (empty) Applications: API, Indexer

ETHEREUM_JSONRPC_HTTP_TIMEOUT

Timeout for ethereum json rpc http requests in seconds. Implemented in #7089

Version: v5.1.2+ Default: 60 Applications: API, Indexer

ETHEREUM_JSONRPC_USER

User in basic auth for JSON RPC endpoint. Implemented in #6897

Version: v5.1.2+ Default: (empty) Applications: API, Indexer

ETHEREUM_JSONRPC_PASSWORD

Password in basic auth for JSON RPC endpoint. Implemented in #6897

Version: v5.1.2+ Default: (empty) Applications: API, Indexer

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

Version: v5.2.1+ Default: (empty) Applications: API, Indexer

ETHEREUM_JSONRPC_FALLBACK_HTTP_URL

Fallback JSON RPC HTTP url. Implemented in #7246

Version: v5.1.4+ Default: (empty) Applications: API, Indexer

ETHEREUM_JSONRPC_FALLBACK_TRACE_URL

Fallback JSON RPC trace url. Implemented in #7246

Version: v5.1.4+ Default: (empty) Applications: API, Indexer

ETHEREUM_JSONRPC_FALLBACK_ETH_CALL_URL

Fallback JSON RPC eth_call url. Implemented in #9511

Version: v6.3.0+ Default: (empty) Applications: API, Indexer

ETHEREUM_JSONRPC_WAIT_PER_TIMEOUT

Wait time for each recent timeout from node. Implemented in #8292

Version: v5.2.3+ Default: 20s Applications: API, Indexer

ETHEREUM_JSONRPC_ETH_CALL_URL

JSON RPC url for eth_call method. Implemented in #9112

Version: v6.0.0+ Default: (empty) Applications: API, Indexer

NETWORK

Environment variable for the main EVM network such as Ethereum or POA.

Version: All Default: POA Applications: API

SUBNETWORK

Environment variable for the subnetwork such as Core or Sokol Network. This will be displayed as selected in the chains list dropdown.

Version: All Default: POA Sokol Applications: API

IPC_PATH

Path to the IPC file of the running node if IPC transport is chosen.

Version: v2.1.1+ Default: (empty) Applications: API, Indexer

NETWORK_PATH

Used to set a network path other than what is displayed in the root directory. An example would be to add /eth/mainnet/ to the root directory.

Version: All Default: / Applications: API

BLOCKSCOUT_HOST

Host for API endpoint examples.

Version: v2.1.0+ Default: localhost Applications: API

BLOCKSCOUT_PROTOCOL

Url scheme for blockscout.

Version: v2.1.0+ Default: prod env https, dev env http Applications: API

SECRET_KEY_BASE

The value used to sign cookies. Use mix phx.gen.secret to generate a new Secret Key Base string to protect production assets.

Required: ✅ Version: All Default: (empty) Applications: API

CHECK_ORIGIN

Used to check the origin of requests when the origin header is present. It defaults to false. In case of true, it will check against the host value.

Version: All Default: false Applications: API

PORT

Default port the application runs on is 4000.

Version: All Default: 4000 Applications: API

COIN

Coin is checked via the CoinGecko API to obtain USD prices on graphs and other areas of the UI.

Version: All Default: POA Applications: API, Indexer

COIN_NAME

Displayed name of the coin. Also used for "Add chain to MetaMask" button and for Account functionality as native coin name in the email letters for watch list.

Version: v4.1.2+ Default: (empty) Applications: API

EMISSION_FORMAT

Should be set to POA if you have block emission identical to POA Network. This env var is used only if CHAIN_SPEC_PATH is set.

Version: v2.0.4+ Default: DEFAULT Applications: API, Indexer

CHAIN_SPEC_PATH

Chain specification path (absolute file system path or URL) to import block emission reward ranges and genesis account balances from. Geth- and OpenEthereum-style specs are supported.

Version: v2.0.4+ Default: (empty) Applications: API, Indexer

PRECOMPILED_CONTRACTS_CONFIG_PATH

Precompiled contracts description path (absolute file system path or URL) to import ABI and source code of the precompiled contracts.

Version: v6.5.0+ Default: (empty) or /app/config/assets/precompiles-arbitrum.json for arbitrum chaintype Applications: API, Indexer

SUPPLY_MODULE

Used by RSK in order to tell the application how to calculate the total supply of the chain. Available value is RSK

Version: All Default: (empty) Applications: API, Indexer

POOL_SIZE

Defines the number of database connections allowed excluding read-only API endpoints requests.

Version: All Default: 50 Applications: API, Indexer

POOL_SIZE_API

Defines the number of database connections allowed for read-only API endpoints requests.

Version: v4.1.0+ Default: 50 Applications: API

ECTO_USE_SSL

Production environment variable to use SSL on Ecto queries.

Version: All Default: TRUE Applications: API, Indexer

HEART_BEAT_TIMEOUT

Production environment variable to restart the application in the event of a crash.

Version: All Default: 30 Applications: API, Indexer

HEART_COMMAND

Production environment variable to restart the application in the event of a crash.

Version: All Default: (empty) Applications: API, Indexer

ELIXIR_VERSION

Elixir version to install on the node before Blockscout deploy. It is used in bash script in Terraform / Ansible deployment script

Version: All Default: (empty) Applications: API, Indexer

DISABLE_WEBAPP

If true endpoints to webapp are hidden (compile-time). Also, enabling it makes notifications go through db_notify

Needs Recompile: ☑️ Version: v2.0.3+ Default: false Applications: API, Indexer

API_V1_READ_METHODS_DISABLED

If true, read-only endpoints to API v1 are hidden (compile-time).

Needs Recompile: ☑️ Version: v5.1.5+ Default: false Applications: API

API_V1_WRITE_METHODS_DISABLED

If true, write endpoints to API v1 are hidden (compile-time).

Needs Recompile: ☑️ Version: v5.1.5+ Default: false Applications: API

DISABLE_API

If true, endpoint is not started. Set this if you want to use an indexer-only setup. Implemented in #10032

Version: v6.6.0+ Default: false Applications: API, Indexer

WEBAPP_URL

Link to web application instance, e.g. protocol://host/path

Version: v2.0.3+ Default: (empty) Applications: API

API_URL

Link to API instance, e.g. protocol://host/path

Version: v2.0.3+ Default: (empty) Applications: API

API_V2_ENABLED

Enable API V2. Implemented in #6361 (v5.0.0+), default true since #8802

Version: v5.3.2+ Default: true Applications: API

API_SENSITIVE_ENDPOINTS_KEY

API key to protect some sensitive endpoints. Implemented in #7355

Version: v5.1.5+ Default: (empty) Applications: API

CHECKSUM_ADDRESS_HASHES

If set to true, redirects to checksummed version of address hashes.

Version: v3.1.0+ Default: true Applications: API

CHECKSUM_FUNCTION

Defines checksum address function. 2 available values: rsk, eth

Version: v2.0.1+ Default: eth Applications: API

RESTRICTED_LIST

A comma-separated list of addresses to enable restricted access to them.

Version: v3.3.3+ Default: (empty) Applications: API

RESTRICTED_LIST_KEY

A key to access addresses listed inRESTRICTED_LIST variable. Can be passed via query param to the page's URL: ?key=...

Version: v3.3.3+ Default: (empty) Applications: API

CHAIN_TYPE

Specifies the model of data and enables fetchers specific to the chain. Available values are ethereum, optimism, arbitrum, polygon_zkevm, polygon_edge, rsk, shibarium, stability, suave, zetachain, filecoin, default.

Needs Recompile: ☑️ Version: v5.3.0+ Default: default Applications: API, Indexer

CHAIN_ID

Chain ID of the network. For instance, 100 in the case of xDai chain.

Version: v3.7.0+ Default: (empty) Applications: API, Indexer

JSON_RPC

JSON RPC endpoint of the chain for the WalletConnect integration. Implemented in #4931

Version: v4.1.0+ Default: (empty) Applications: API, Indexer

HEALTHY_BLOCKS_PERIOD

New blocks indexed max delay in /health API endpoint. Time format. Implemented in #2294

Version: v2.0.2+ Default: 5m Applications: API, Indexer

NEW_TAGS

Add public tag labels. More info in #6316

Version: v5.0.0+ Default: (empty) Applications: API

CUSTOM_CONTRACT_ADDRESSES_${tag_name}

Specify addresses for some label. More info in #6316

Version: v5.0.0+ Default: (empty) Applications: API

SESSION_COOKIE_DOMAIN

Value of this env will be added to domain of session cookie. Implemented in #6544

Version: v5.0.0+ Default: (empty) Applications: API

DECODE_NOT_A_CONTRACT_CALLS

Allows decoding of contract calls directed to addresses which are not contracts. Implemented in #6541

Needs Recompile: ☑️ Version: v5.1.0+ Default: false Applications: API

EIP_1559_ELASTICITY_MULTIPLIER

EIP-1559 elasticity multiplier. Implemented in #7253

Version: v5.1.3+ Default: 2 Applications: API

EIP_1559_BASE_FEE_MAX_CHANGE_DENOMINATOR

EIP-1559 base fee max change denominator. Implemented in #9202

Version: v6.2.0+ Default: 8 Applications: API

TOKEN_INSTANCE_OWNER_MIGRATION_CONCURRENCY

Concurrency of new fields backfiller implemented in #8386

Version: v5.3.0+ Default: 5 Applications: API, Indexer

TOKEN_INSTANCE_OWNER_MIGRATION_BATCH_SIZE

Batch size of new fields backfiller implemented in #8386

Version: v5.3.0+ Default: 50 Applications: API, Indexer

TOKEN_INSTANCE_OWNER_MIGRATION_ENABLED

Enable of backfiller from #8386 implemented in #8752

Version: v5.3.2+ Default: false Applications: API, Indexer

TOKEN_ID_MIGRATION_FIRST_BLOCK

Bottom block for token id migration. Implemented in #6391

Version: v5.0.0+ Default: 0 Applications: API, Indexer

TOKEN_ID_MIGRATION_CONCURRENCY

Number of workers performing the token id migration. Implemented in #6391

Version: v5.0.0+ Default: 1 Applications: API, Indexer

TOKEN_ID_MIGRATION_BATCH_SIZE

Interval of token transfer block numbers processed by a token id migration worker at a time. Implemented in #6391

Version: v5.0.0+ Default: 500 Applications: API, Indexer

ADDRESSES_TABS_COUNTERS_TTL

TTL for cached tabs counters (works only for counters which are < 51, if counter >= 51, then ttl == :infinity). Implemented in #8512

Version: v5.3.0+ Default: 10m Applications: API

API_INTERNAL_TRANSACTIONS_INDEXING_FINISHED_THRESHOLD

In the case when the 1st tx in the chain already has internal transactions, If the number of blocks in pending_block_operations is less than the value in this env var, Blockscout will consider that indexing of internal transactions is finished, otherwise, it will consider that indexing is still taking place and the indexing banner will appear at the top. Implemented in #7576.

Version: v5.2.0+ Default: 1000 Applications: API

DATABASE_EVENT_URL

Variable to define the Postgres Database endpoint that will be used by event listener process. Applicable for separate indexer and API setup. More info in related PR. Implemented in #10164.

Version: master Default: (empty) Applications: API

Indexer Management

VariableDescriptionParameters

BLOCK_TRANSFORMER

Transformer for blocks: base or clique.

Version: v.1.3.4+ Default: base Applications: Indexer

DISABLE_INDEXER

If true, indexer application doesn't run.

Version: v2.0.3+ Default: false Applications: API, Indexer

INDEXER_HIDE_INDEXING_PROGRESS_ALERT

If true, indexer progress alert will be disabled even if initial catchup indexing is still in place. Implemented in #7360.

Version: v5.1.5+ Default: false Applications: API

INDEXER_DISABLE_PENDING_TRANSACTIONS_FETCHER

If true, pending transactions fetcher is disabled.

Version: v4.1.2+ Default: false Applications: Indexer

INDEXER_DISABLE_INTERNAL_TRANSACTIONS_FETCHER

If true, internal transactions fetcher is disabled.

Version: v4.1.2+ Default: false Applications: Indexer

INDEXER_DISABLE_BLOCK_REWARD_FETCHER

if true, block rewards fetcher is disabled.

Version: v4.1.3+ Default: false Applications: Indexer

INDEXER_DISABLE_ADDRESS_COIN_BALANCE_FETCHER

If true, coin balances fetcher is disabled.

Version: v4.1.3+ Default: false Applications: Indexer

INDEXER_DISABLE_CATALOGED_TOKEN_UPDATER_FETCHER

If true, cataloged tokens metadata fetcher is disabled.

Version: v4.1.3+ Default: false Applications: Indexer

INDEXER_MEMORY_LIMIT

Memory soft limit for the indexer.

Version: v4.1.3+ Default: 1Gb Applications: API, Indexer

INDEXER_EMPTY_BLOCKS_SANITIZER_BATCH_SIZE

Batch size for empty block sanitizer (re-fetcher).

Version: v4.1.3+ Default: 100 Applications: Indexer

INDEXER_CATCHUP_BLOCKS_BATCH_SIZE

Batch size for blocks catchup fetcher. Implemented in #6196.

Version: v5.0.0+ Default: 10 Applications: Indexer

INDEXER_CATCHUP_BLOCKS_CONCURRENCY

Concurrency for blocks catchup fetcher. Implemented in #6196.

Version: v5.0.0+ Default: 10 Applications: Indexer

INDEXER_DISABLE_EMPTY_BLOCKS_SANITIZER

Empty blocks sanitizer is disabled if true

Version: v5.1.2+ Default: false Applications: Indexer

DISABLE_REALTIME_INDEXER

If true, realtime fetcher doesn't run

Version: v4.1.6+ Default: false Applications: Indexer

FIRST_BLOCK

The block number, where import of blocks by catchup fetcher begins from.

Version: v1.3.8+ Default: 0 Applications: API, Indexer

LAST_BLOCK

The block number, where import of blocks by catchup fetcher stops.

Version: v2.0.3+ Default: (empty) Applications: Indexer

TRACE_FIRST_BLOCK

The block number, where indexing of internal transactions begins from.

Version: v4.1.0+ Default: 0 Applications: API, Indexer

TRACE_LAST_BLOCK

The block number, where indexing of internal transactions stops.

Version: v4.1.0+ Default: (empty) Applications: API, Indexer

BLOCK_RANGES

Block ranges to import by catchup fetcher. Example: BLOCK_RANGES="1..3,123..500,30..50,500..latest". Implemented in #5783

Version: v4.1.7+ Default: (empty) Applications: Indexer

FETCH_REWARDS_WAY

Tells the application how to calculate block rewards, by fetching via json_rpc (trace_block) or manual by block params (manual).

Version: v4.1.4+ Default: trace_block Applications: Indexer

IPFS_GATEWAY_URL

IPFS gateway url for fetching token instance metadata from IPFS including token instance icon.

Version: v5.3.0+ Default: https://ipfs.io/ipfs Applications: Indexer

IPFS_GATEWAY_URL_PARAM_KEY

The key of the parameter to add to IPFS gateway url. Implemented in #9898.

Version: v6.5.0+ Default: (empty) Applications: Indexer

IPFS_GATEWAY_URL_PARAM_VALUE

The value of the parameter to add to IPFS gateway url. Implemented in #9898.

Version: v6.5.0+ Default: (empty) Applications: Indexer

IPFS_GATEWAY_URL_PARAM_LOCATION

Whether to add extra params: to query string or to the headers. Available values: query/header. Implemented in #9898.

Version: v6.5.0+ Default: (empty) Applications: Indexer

ETHEREUM_JSONRPC_DEBUG_TRACE_TRANSACTION_TIMEOUT

Timeout for debug_traceTransaction/debug_traceBlockByNumber JSON RPC method requests in case of geth archive node. Supported time formats: https://pkg.go.dev/time#ParseDuration. Introduced in #5505

Version: v4.1.3+ Default: 5s Applications: Indexer

ETHEREUM_JSONRPC_DISABLE_ARCHIVE_BALANCES

If true, all the requests with the method eth_getBalance with any block as parameter but latest are ignored. Implemented in #6001

Version: v5.0.0+ Default: false Applications: API, Indexer

ETHEREUM_JSONRPC_PENDING_TRANSACTIONS_TYPE

Defines which method will be used for fetching pending transactions: default - default method for fetching internal transactions for current ETHEREUM_JSONRPC_VARIANT, geth - txpool_content method will be used, parity - parity_pendingTransactions will be used. Implemented in #6001

Version: v5.0.0+ Default: default Applications: Indexer

INDEXER_INTERNAL_TRANSACTIONS_BATCH_SIZE

Batch size for internal transactions fetcher. Implemented in #6450.

Version: v5.0.0+ Default: 10 Applications: Indexer

INDEXER_INTERNAL_TRANSACTIONS_CONCURRENCY

Concurrency for internal transactions fetcher. Implemented in #6450.

Version: v5.0.0+ Default: 4 Applications: Indexer

INDEXER_BLOCK_REWARD_BATCH_SIZE

Batch size for block reward fetcher. Implemented in #6952.

Version: v5.1.2+ Default: 10 Applications: Indexer

INDEXER_BLOCK_REWARD_CONCURRENCY

Concurrency for block reward fetcher. Implemented in #6952.

Version: v5.1.2+ Default: 4 Applications: Indexer

INDEXER_RECEIPTS_BATCH_SIZE

Batch size for transaction receipts fetcher. Implemented in #6454.

Version: v5.0.0+ Default: 250 Applications: Indexer

INDEXER_RECEIPTS_CONCURRENCY

Concurrency for transaction receipts fetcher. Implemented in #6454.

Version: v5.0.0+ Default: 10 Applications: Indexer

INDEXER_COIN_BALANCES_BATCH_SIZE

Batch size for coin balances fetcher. Implemented in #6454.

Version: v5.0.0+ Default: 100 Applications: Indexer

INDEXER_COIN_BALANCES_CONCURRENCY

Concurrency for coin balances fetcher. Implemented in #6454.

Version: v5.0.0+ Default: 4 Applications: Indexer

INDEXER_TOKEN_CONCURRENCY

Concurrency for token fetcher. Implemented in #8167.

Version: v5.2.2+ Default: 10 Applications: Indexer

INDEXER_TOKEN_BALANCES_BATCH_SIZE

Batch size for token balances fetcher. Implemented in #7439.

Version: v5.1.5+ Default: 100 Applications: Indexer

INDEXER_TOKEN_BALANCES_CONCURRENCY

Concurrency for token balances fetcher. Implemented in #8167.

Version: v5.2.2+ Default: 10 Applications: Indexer

INDEXER_TX_ACTIONS_ENABLE

If true, transaction action indexer is active. Implemented in #6582.

Version: v5.1.0+ Default: false Applications: Indexer

INDEXER_TX_ACTIONS_MAX_TOKEN_CACHE_SIZE

Maximum number of items in an internal cache of tx actions indexing process (to limit memory consumption). Implemented in #6582.

Version: v5.1.0+ Default: 100000 Applications: Indexer

INDEXER_TX_ACTIONS_REINDEX_FIRST_BLOCK

The first block of a block range for historical indexing or reindexing of tx actions. Implemented in #6582.

Version: v5.1.0+ Default: (empty) Applications: Indexer

INDEXER_TX_ACTIONS_REINDEX_LAST_BLOCK

The last block of a block range for historical indexing or reindexing of tx actions. Implemented in #6582.

Version: v5.1.0+ Default: (empty) Applications: Indexer

INDEXER_TX_ACTIONS_REINDEX_PROTOCOLS

Comma-separated names of protocols which should be indexed or reindexed on historical blocks defined by the range. Example: uniswap_v3,zkbob - only these protocols will be indexed or reindexed for the defined block range. If the value is an empty string (or not defined), all supported protocols will be indexed/reindexed. This option is not applicable to realtime and catchup fetchers (it always indexes all supported protocols). Implemented in #6582.

Version: v5.1.0+ Default: (empty) Applications: Indexer

INDEXER_TX_ACTIONS_AAVE_V3_POOL_CONTRACT

Pool contract address for Aave v3 protocol. If not defined, Aave transaction actions are ignored by the indexer. Implemented in #7185.

Version: v5.1.3+ Default: (empty) Applications: Indexer

INDEXER_TX_ACTIONS_UNISWAP_V3_FACTORY_CONTRACT

UniswapV3Factory contract address. Implemented in #7312.

Version: v5.1.4+ Default: 0x1F98431c8aD98523631AE4a59f267346ea31F984 Applications: Indexer

INDEXER_TX_ACTIONS_UNISWAP_V3_NFT_POSITION_MANAGER_CONTRACT

NonfungiblePositionManager contract address for Uniswap v3. Implemented in #7312.

Version: v5.1.4+ Default: 0xC36442b4a4522E871399CD717aBDD847Ab11FE88 Applications: Indexer

INDEXER_CATCHUP_MISSING_RANGES_BATCH_SIZE

Batch size for missing ranges collector. Implemented in #6583.

Version: v5.0.0+ Default: 100000 Applications: Indexer

MIN_MISSING_BLOCK_NUMBER_BATCH_SIZE

Batch size for min missing block number updater. Implemented in #6583.

Version: v5.0.0+ Default: 100000 Applications: API, Indexer

INDEXER_INTERNAL_TRANSACTIONS_TRACER_TYPE

Tracer type for debug_traceTransaction/debug_traceBlockByNumber requests for geth-like nodes. Possible values are: js to use custom Blockscout js tracer, call_tracer to use built-in callTracer geth tracer, opcode to use built-in Struct/opcode logger geth tracer, polygon_edge to work with Polygon edge nodes. Implemented in #6721, #7513

Version: v5.1.0+ Default: call_tracer Applications: Indexer

INDEXER_TOKEN_INSTANCE_RETRY_MAX_REFETCH_INTERVAL

Maximum interval between attempts to fetch token instance metadata. Time format. Implemented in #10027.

Version: master Default: 168h Applications: Indexer

INDEXER_TOKEN_INSTANCE_RETRY_EXPONENTIAL_TIMEOUT_BASE

Base to calculate exponential timeout. Implemented in #10027.

Version: master Default: 2 Applications: Indexer

INDEXER_TOKEN_INSTANCE_RETRY_EXPONENTIAL_TIMEOUT_COEFF

Coefficient to calculate exponential timeout. Implemented in #10027.

Version: master Default: 100 Applications: Indexer

INDEXER_TOKEN_INSTANCE_RETRY_CONCURRENCY

Concurrency for retry token instance fetcher. Implemented in #7286.

Version: v5.1.4+ Default: 10 Applications: Indexer

INDEXER_TOKEN_INSTANCE_REALTIME_CONCURRENCY

Concurrency for realtime token instance fetcher. Implemented in #7286.

Version: v5.1.4+ Default: 10 Applications: Indexer

INDEXER_TOKEN_INSTANCE_SANITIZE_CONCURRENCY

Concurrency for sanitize token instance fetcher. Implemented in #7286.

Version: v5.1.4+ Default: 10 Applications: Indexer

INDEXER_DISABLE_TOKEN_INSTANCE_RETRY_FETCHER

If true, retry token instance fetcher doesn't run

Version: v5.1.4+ Default: false Applications: Indexer

INDEXER_DISABLE_TOKEN_INSTANCE_REALTIME_FETCHER

If true, realtime token instance fetcher doesn't run

Version: v5.1.4+ Default: false Applications: Indexer

INDEXER_TOKEN_INSTANCE_REALTIME_RETRY_ENABLED

If true, realtime token instance fetcher will retry once on 404 and 500 error. Implemented in #10036.

Version: v6.6.0+ Default: false Applications: Indexer

INDEXER_TOKEN_INSTANCE_REALTIME_RETRY_TIMEOUT

Timeout for retry set by INDEXER_TOKEN_INSTANCE_REALTIME_RETRY_ENABLED. Time format. Implemented in #10036.

Version: v6.6.0+ Default: 5s Applications: Indexer

INDEXER_DISABLE_TOKEN_INSTANCE_SANITIZE_FETCHER

If true, sanitize token instance fetcher doesn't run

Version: v5.1.4+ Default: false Applications: Indexer

INDEXER_TOKEN_INSTANCE_USE_BASE_URI_RETRY

If true, and request to tokenURI(tokenId) failed with VM execution error, Blockscout will make request to baseURI and try to request metadata from baseURI + tokenId

Version: v6.2.0+ Default: false Applications: Indexer

INDEXER_REALTIME_FETCHER_MAX_GAP

Max gap between consecutive latest blocks that will be filled by realtime fetcher. Implemented in #7393

Version: v5.1.5+ Default: 1000 Applications: Indexer

INDEXER_DISABLE_WITHDRAWALS_FETCHER

If true, withdrawals fetcher is disabled. Implemented in #6694.

Version: v5.1.5+ Default: true Applications: Indexer

WITHDRAWALS_FIRST_BLOCK

The block number, where import of withdrawals by catchup fetcher begins from. Should be the block where withdrawals upgrade occured on the chain. Implemented in #6694.

Version: v5.1.5+ Default: (empty) Applications: Indexer

INDEXER_CATCHUP_BLOCK_INTERVAL

Interval between blocks catchup fetcher tasks. Implemented in #7489.

Version: v5.1.5+ Default: 5s Applications: Indexer

INDEXER_FETCHER_INIT_QUERY_LIMIT

Limit for all fetchers init queries. Implemented in #7697.

Version: v5.2.0+ Default: 100 Applications: Indexer

INDEXER_TOKEN_INSTANCE_RETRY_BATCH_SIZE

Batch size for retry token instance fetcher. Implemented in #8313

Version: v5.2.3+ Default: 10 Applications: Indexer

INDEXER_TOKEN_INSTANCE_REALTIME_BATCH_SIZE

Batch size for realtime token instance fetcher. Implemented in #8313.

Version: v5.2.3+ Default: 1 Applications: Indexer

INDEXER_TOKEN_INSTANCE_SANITIZE_BATCH_SIZE

Batch size for sanitize token instance fetcher. Implemented in #8313.

Version: v5.2.3+ Default: 10 Applications: Indexer

INDEXER_TOKEN_BALANCES_FETCHER_INIT_QUERY_LIMIT

Limit for token balance fetcher init queries. Implemented in #8459.

Version: v5.2.3+ Default: 100000 Applications: Indexer

INDEXER_COIN_BALANCES_FETCHER_INIT_QUERY_LIMIT

Limit for coin balance fetcher init queries. Implemented in #7996.

Version: v5.3.0+ Default: 2000 Applications: Indexer

INDEXER_DISABLE_TOKEN_INSTANCE_LEGACY_SANITIZE_FETCHER

If true, legacy sanitize token instance fetcher doesn't run. Appeared in #8386

Version: v5.3.0+ Default: true Applications: Indexer

INDEXER_TOKEN_INSTANCE_LEGACY_SANITIZE_CONCURRENCY

Concurrency for legacy sanitize token instance fetcher doesn't run. Appeared in #8386

Version: v5.4.0+ Default: 2 Applications: Indexer

INDEXER_TOKEN_INSTANCE_LEGACY_SANITIZE_BATCH_SIZE

Batch size for legacy sanitize token instance fetcher doesn't run. Appeared in #8386

Version: v5.3.0+ Default: 10 Applications: Indexer

INDEXER_DISABLE_TOKEN_INSTANCE_ERC_1155_SANITIZE_FETCHER

If true, erc-1155-sanitize token instance fetcher doesn't run. Implemented in #9226.

Version: v6.2.0+ Default: false Applications: Indexer

INDEXER_DISABLE_TOKEN_INSTANCE_ERC_721_SANITIZE_FETCHER

If true, erc-721-sanitize token instance fetcher doesn't run. Implemented in #9226.

Version: v6.2.0+ Default: false Applications: Indexer

INDEXER_TOKEN_INSTANCE_ERC_1155_SANITIZE_CONCURRENCY

Concurrency for erc-1155-sanitize token instance fetcher. Implemented in #9226.

Version: v6.2.0+ Default: 2 Applications: Indexer

INDEXER_TOKEN_INSTANCE_ERC_721_SANITIZE_CONCURRENCY

Concurrency for erc-721-sanitize token instance fetcher. Implemented in #9226.

Version: v6.2.0+ Default: 2 Applications: Indexer

INDEXER_TOKEN_INSTANCE_ERC_1155_SANITIZE_BATCH_SIZE

Batch size for erc-1155-sanitize token instance fetcher. Implemented in #9226.

Version: v6.2.0+ Default: 10 Applications: Indexer

INDEXER_TOKEN_INSTANCE_ERC_721_SANITIZE_BATCH_SIZE

Batch size for erc-721-sanitize token instance fetcher. Implemented in #9226.

Version: v6.2.0+ Default: 10 Applications: Indexer

INDEXER_EMPTY_BLOCKS_SANITIZER_INTERVAL

Interval for empty block sanitizer. Implemented in #8658

Version: v5.3.0+ Default: 5m Applications: Indexer

ETHEREUM_JSONRPC_ARCHIVE_BALANCES_WINDOW

Max block number gap from latest for which balances requests can be processed when ETHEREUM_JSONRPC_DISABLE_ARCHIVE_BALANCES env var is set to true. Implemented in #8673

Version: v5.3.1+ Default: 200 Applications: API, Indexer

DISABLE_CATCHUP_INDEXER

If true, catchup fetcher doesn't run

Version: v5.3.2+ Default: false Applications: Indexer

TRACE_BLOCK_RANGES

Block ranges for traceable blocks. Example: TRACE_BLOCK_RANGES="1..3,123..500,30..50,500..latest". Implemented in #8960

Version: v5.4.0+ Default: (empty) Applications: API, Indexer

ETHEREUM_JSONRPC_GETH_TRACE_BY_BLOCK

Enable tracing by block for geth variant. Implemented in #9072

Version: v6.1.0+ Default: false Applications: Indexer

INDEXER_GRACEFUL_SHUTDOWN_PERIOD

Time that will be given to the block fetchers when stopping the application before they are killed. Implemented in #9729

Version: v6.5.0+ Default: 5m Applications: Indexer

MISSING_BALANCE_OF_TOKENS_WINDOW_SIZE

Minimal blocks count until the next token balance request will be executed for tokens that doesn't implement balanceOf function. Implemented in #10142

Version: master Default: 100 Applications: Indexer

ETHEREUM_JSONRPC_GETH_ALLOW_EMPTY_TRACES

Allow transactions to not have internal transactions. Implemented in #10200

Version: master Default: false Applications: Indexer

Denormalization & Sanitizer Management

VariableDescriptionParameters

DENORMALIZATION_MIGRATION_BATCH_SIZE

Number of transactions to denormalize (add block timestamp and consensus) in the batch.

Version: v.6.0.0-beta Default: 500 Applications: API, Indexer

DENORMALIZATION_MIGRATION_CONCURRENCY

Number of parallel denormalization transaction batches processing.

Version: v.6.0.0-beta Default: 10 Applications: API, Indexer

TOKEN_TRANSFER_TOKEN_TYPE_MIGRATION_BATCH_SIZE

Number of token transfers to denormalize (add token_type) in the batch.

Version: v.6.3.0+ Default: 100 Applications: API, Indexer

TOKEN_TRANSFER_TOKEN_TYPE_MIGRATION_CONCURRENCY

Number of parallel denormalization token transfer batches processing.

Version: v.6.3.0+ Default: 1 Applications: API, Indexer

SANITIZE_INCORRECT_NFT_BATCH_SIZE

Number of token transfers to sanitize in the batch.

Version: v.6.3.0+ Default: 100 Applications: API, Indexer

SANITIZE_INCORRECT_NFT_CONCURRENCY

Number of parallel sanitizing token transfer batches processing.

Version: v.6.3.0+ Default: 1 Applications: API, Indexer

SANITIZE_INCORRECT_WETH_BATCH_SIZE

Number of token transfers to sanitize in the batch. Implemented in #10134

Version: master Default: 100 Applications: API, Indexer

SANITIZE_INCORRECT_WETH_CONCURRENCY

Number of parallel sanitizing token transfer batches processing. Implemented in #10134

Version: master Default: 1 Applications: API, Indexer

Exchange Rates

VariableDescriptionParameters

DISABLE_EXCHANGE_RATES

Disables or enables fetching of coin price from Coingecko API.

Version: v.3.1.2+ Default: false Applications: API, Indexer

EXCHANGE_RATES_MARKET_CAP_SOURCE

Sets the source for market cap fetching. Available values coin_gecko, mobula, coin_market_cap.

Version: v.5.2.3+ Default: coin_gecko Applications: API, Indexer

EXCHANGE_RATES_TVL_SOURCE

Sets the source for TVL fetching. Available value is defillama.

Version: v.5.3.0+ Default: (empty) Applications: API, Indexer

EXCHANGE_RATES_PRICE_SOURCE

Sets the source for price fetching. Available values are also crypto_compare, coin_gecko, mobula and coin_market_cap.

Version: v.5.2.3+ Default: crypto_compare Applications: API, Indexer

EXCHANGE_RATES_MOBULA_COIN_ID

Explicitly set Mobula coin ID.

Version: master Default: (empty) Applications: API, Indexer

EXCHANGE_RATES_MOBULA_SECONDARY_COIN_ID

Explicitly set Mobula coin ID for secondary coin market chart.

Version: master Default: (empty) Applications: API, Indexer

EXCHANGE_RATES_MOBULA_API_KEY

Mobula API key.

Version: master Default: (empty) Applications: API, Indexer

EXCHANGE_RATES_MOBULA_CHAIN_ID

Mobula chain id for which token prices are fetched, see full list in the Documentation.

Version: master Default: (empty) Applications: API, Indexer

EXCHANGE_RATES_COINGECKO_COIN_ID

Explicitly set CoinGecko coin ID.

Version: v4.1.4+ Default: (empty) Applications: API, Indexer

EXCHANGE_RATES_COINGECKO_SECONDARY_COIN_ID

Explicitly set CoinGecko coin ID for secondary coin market chart. Implemented in #9483.

Version: v6.3.0+ Default: (empty) Applications: API, Indexer

EXCHANGE_RATES_COINGECKO_API_KEY

CoinGecko API key.

Version: v4.1.4+ Default: (empty) Applications: API, Indexer

EXCHANGE_RATES_COINMARKETCAP_API_KEY

CoinMarketCap API key. Required, if EXCHANGE_RATES_MARKET_CAP_SOURCE, EXCHANGE_RATES_PRICE_SOURCE is set to coin_market_cap.

Version: v4.1.4+ Default: (empty) Applications: API, Indexer

EXCHANGE_RATES_COINMARKETCAP_COIN_ID

CoinMarketCap coin id.

Version: v5.2.1+ Default: (empty) Applications: API, Indexer

EXCHANGE_RATES_COINMARKETCAP_SECONDARY_COIN_ID

CoinMarketCap coin id for secondary coin market chart. Implemented in #9483.

Version: v6.3.0+ Default: (empty) Applications: API, Indexer

EXCHANGE_RATES_DEFILLAMA_COIN_ID

DefiLlama coin id.

Version: v5.3.0+ Default: (empty) Applications: API, Indexer

EXCHANGE_RATES_FETCH_BTC_VALUE

if true explorer application will fetch btc_value for token exchange rates. Implemented in #5671.

Version: v4.1.5+ Default: (empty) Applications: API, Indexer

EXCHANGE_RATES_COINGECKO_PLATFORM_ID

CoinGecko platform id for which token prices are fetched, see full list in /asset_platforms endpoint. Implemented in #6925.

Version: v5.1.2+ Default: ethereum Applications: API, Indexer

TOKEN_EXCHANGE_RATE_INTERVAL

Interval between batch requests of token prices. Can be decreased in order to fetch prices faster if you have pro rate limit. Time format. Implemented in #6925.

Version: v5.1.2+ Default: 5s Applications: API, Indexer

TOKEN_EXCHANGE_RATE_REFETCH_INTERVAL

Interval between refetching token prices, responsible for the relevance of prices. Time format. Implemented in #6925.

Version: v5.1.2+ Default: 1 hour Applications: API, Indexer

TOKEN_EXCHANGE_RATE_MAX_BATCH_SIZE

Batch size of a single token price request. Implemented in #6925.

Version: v5.1.2+ Default: 150 Applications: API, Indexer

DISABLE_TOKEN_EXCHANGE_RATE

If true disables fetching of token price. Implemented in #6925.

Version: v5.1.2+ Default: true Applications: API, Indexer

EXCHANGE_RATES_CRYPTOCOMPARE_SECONDARY_COIN_SYMBOL

CryptoCompare coin symbol for secondary coin market chart. Implemented in #9483.

Version: v6.3.0+ Default: (empty) Applications: API, Indexer

EXCHANGE_RATES_COINGECKO_BASE_URL

If set, overrides the Coingecko base URL. Implemented in #9679.

Version: v6.4.0+ Default: true Applications: API, Indexer

EXCHANGE_RATES_COINGECKO_BASE_PRO_URL

If set, overrides the Coingecko Pro base URL. Implemented in #9679.

Version: v6.4.0+ Default: true Applications: API, Indexer

EXCHANGE_RATES_COINMARKETCAP_BASE_URL

If set, overrides the CoinMarketCap base URL (Free and Pro). Implemented in #9679.

Version: v6.4.0+ Default: true Applications: API, Indexer

Cache Management

See the Time format section for more information on variable formatting.

VariableDescriptionParameters

CACHE_TXS_COUNT_PERIOD

Time interval to restart the task that calculates the total txs count. Starting from release master, if the value is not set, ttl value gradually increases until the default value with growth of the block numbers.

Version: v.4.1.3+ Default: 2h Applications: API, Indexer

CACHE_ADDRESS_SUM_PERIOD

Time to live of addresses sum (except burn address) cache. Time format. Starting from release master, if the value is not set, ttl value gradually increases until the default value with growth of the block numbers. Introduced in #2862.

Version: v.4.1.3+ Default: 1h Applications: API, Indexer

CACHE_TOTAL_GAS_USAGE_PERIOD

Interval to restart the task which calculates the total gas usage. Starting from release master, if the value is not set, ttl value gradually increases until the default value with growth of the block numbers.

Version: v.4.1.3+ Default: 2h Applications: API, Indexer

CACHE_PBO_COUNT_PERIOD

Time interval to restart the task which calculates the total pending_block_operations count.

Version: v.5.2.0+ Default: 20m Applications: API, Indexer

CACHE_ADDRESS_TRANSACTIONS_GAS_USAGE_COUNTER_PERIOD

Interval to restart the task which calculates gas usage at the address.

Version: v.4.1.3+ Default: 30m Applications: API, Indexer

CACHE_TOKEN_HOLDERS_COUNTER_PERIOD

Interval to restart the task which calculates holders count of the token.

Version: v.4.1.3+ Default: 1h Applications: API, Indexer

CACHE_TOKEN_TRANSFERS_COUNTER_PERIOD

Interval to restart the task which calculates transfers count of the token.

Version: v.4.1.3+ Default: 1h Applications: API, Indexer

CACHE_ADDRESS_WITH_BALANCES_UPDATE_INTERVAL

Interval to restart the task which calculates addresses with balances.

Needs Recompile: ☑️ Version: v4.1.3+ Default: 30m Applications: API, Indexer

TOKEN_METADATA_UPDATE_INTERVAL

Interval to restart the task which updates token metadata.

Version: v.2.0.1+ Default: 48h Applications: API, Indexer

CACHE_AVERAGE_BLOCK_PERIOD

Update of average block period cache.

Version: v.4.1.3+ Default: 30m Applications: API, Indexer

CACHE_MARKET_HISTORY_PERIOD

Update of market history cache.

Version: v.4.1.3+ Default: 6h Applications: API, Indexer

CACHE_ADDRESS_TRANSACTIONS_COUNTER_PERIOD

Time to live of address' transaction counter. Time format. Introduced in #3330.

Version: v.3.4.0+ Default: 41 Applications: API, Indexer

CACHE_ADDRESS_TOKENS_USD_SUM_PERIOD

Managing of cache invalidation period for the sum of USD value of tokens per tokens' holder address.

Version: v.3.5.0+ Default: 1h Applications: API, Indexer

CACHE_EXCHANGE_RATES_PERIOD

Value to tune the time to live of exchange rates. Time format. Implemented in #5671.

Needs Recompile: ☑️ Version: v4.1.5+ Default: 10m Applications: API, Indexer

TOKEN_BALANCE_ON_DEMAND_FETCHER_THRESHOLD

A threshold to invalidate token balance cache.

Version: v.5.1.2+ Default: 1h Applications: API, Indexer

COIN_BALANCE_ON_DEMAND_FETCHER_THRESHOLD

A threshold to invalidate coin balance cache.

Version: v.5.1.2+ Default: 1h Applications: API, Indexer

CONTRACT_CODE_ON_DEMAND_FETCHER_THRESHOLD

An initial threshold (for exponential backoff) to fetch smart-contract bytecode on-demand. Implemented in #9708.

Version: v.6.4.0+ Default: 5s Applications: API, Indexer

CACHE_ADDRESS_TOKEN_TRANSFERS_COUNTER_PERIOD

Interval to restart the task, which calculates the number of token transfers at the address. Implemented in #4699.

Version: v.4.0.0+ Default: 1h Applications: API, Indexer

CACHE_BLOCK_COUNT_PERIOD

Time to live of blocks with consensus count cache. Starting from release master, if the value is not set, ttl value gradually increases until the default value with growth of the block numbers. Introduced in #1876.

Version: v.4.1.3+ Default: 2h Applications: API, Indexer

CACHE_TOTAL_GAS_USAGE_COUNTER_ENABLED

if true, enables cache for total gas usage counter.

Needs Recompile: ☑️ Version: v5.1.3+ Default: false Applications: API, Indexer

MARKET_HISTORY_FETCH_INTERVAL

Interval to update data for the last day in the Market History table. Introduced in #9197.

Version: v.6.1.0+ Default: 1h Applications: API, Indexer

CACHE_TRANSACTIONS_24H_STATS_PERIOD

Interval to update data for the last 24 hours transactions stats. Introduced in #9483.

Version: v.6.3.0+ Default: 1h Applications: API, Indexer

CACHE_FRESH_PENDING_TRANSACTIONS_COUNTER_PERIOD

Interval to update count of pending transactions that appeared less than half an hour ago. Introduced in #9483.

Version: v.6.3.0+ Default: 5m Applications: API, Indexer

CACHE_OPTIMISM_LAST_OUTPUT_ROOT_SIZE_COUNTER_PERIOD

Interval to update data for the last output root size counter. Introduced in #9532.

Version: v.6.3.0+ Default: 5m Applications: API, Indexer

Gas Price Oracle

VariableDescriptionParameters

GAS_PRICE_ORACLE_NUM_OF_BLOCKS

Gas price oracle: number of blocks to calculate average gas price from

Version: v.4.1.4+ Default: 200 Applications: API, Indexer

GAS_PRICE_ORACLE_SAFELOW_PERCENTILE

Gas price oracle: safelow percentile

Version: v.4.1.4+ Default: 35 Applications: API, Indexer

GAS_PRICE_ORACLE_AVERAGE_PERCENTILE

Gas price oracle: average percentile

Version: v.4.1.4+ Default: 60 Applications: API, Indexer

GAS_PRICE_ORACLE_FAST_PERCENTILE

Gas price oracle: fast percentile

Version: v.4.1.4+ Default: 90 Applications: API, Indexer

GAS_PRICE_ORACLE_CACHE_PERIOD

Gas price oracle: period of gas prices update.

Version: v.4.1.4+ Default: 30s Applications: API, Indexer

GAS_PRICE_ORACLE_SIMPLE_TRANSACTION_GAS

Gas price oracle: amount of gas for a simple coin transfer. Introduced in #9044.

Version: v.6.0.0+ Default: 21000 Applications: API, Indexer

GAS_PRICE_ORACLE_SAFELOW_TIME_COEFFICIENT

Average block time multiplied by this coefficent for safelow gas price when time from pending transactions is not available. Floats may be used. Introduced in #9582.

Version: v.6.3.0+ Default: 5 Applications: API, Indexer

GAS_PRICE_ORACLE_AVERAGE_TIME_COEFFICIENT

Average block time multiplied by this coefficent for average gas price when time from pending transactions is not available. Floats may be used. Introduced in #9582.

Version: v.6.3.0+ Default: 3 Applications: API, Indexer

GAS_PRICE_ORACLE_FAST_TIME_COEFFICIENT

Average block time multiplied by this coefficent for fast gas price when time from pending transactions is not available. Floats may be used. Introduced in #9582.

Version: v.6.3.0+ Default: 1 Applications: API, Indexer

Main Page Dashboard

VariableDescriptionParameters

GAS_PRICE

Gas price in Gwei. If the variable is present, gas price displays on the main page.

Version: v.3.3.2+ Default: (empty) Applications: API

TXS_STATS_ENABLED

Disables or enables txs per day stats gathering.

Version: v.5.1.3+ Default: true Applications: API

SHOW_PRICE_CHART

Disables or enables price and market cap of coin charts on the main page.

Version: v.3.1.2+ Default: false Applications: API

SHOW_PRICE_CHART_LEGEND

Showa price and market cap values under the chart even if price chart is not enabled via SHOW_PRICE_CHART env variable.

Version: v.5.1.4+ Default: false Applications: API

SHOW_TXS_CHART

Disables or enables txs count per day chart on the main page.

Version: v.3.1.2+ Default: true Applications: API

TXS_HISTORIAN_INIT_LAG

The initial delay in txs count history fetching in order to display txs count per day history chart on the main page. Time format.

Version: v.3.1.2+ Default: 0 Applications: API

TXS_STATS_DAYS_TO_COMPILE_AT_INIT

Number of days for fetching of history of txs count per day in order to display it in txs count per day history chart on the main page.

Version: v.3.1.2+ Default: 40 Applications: API

Last updated

Logo

Copyright © Blockscout Limited 2023-2024