Backend ENVs: Common
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
Variable | Description | Parameters |
---|---|---|
| Defines the Postgres Database endpoint. | Required: ✅ Version: All Default: (empty) Applications: API, Indexer |
| Defines the endpoint of the Postgres Database that is used during testing. Implemented in #9662. | Version: v6.6.0+ Default: (empty) Applications: API, Indexer |
| Tells the application which RPC Client the node is using (i.e. | Required: ✅
Version: All
Default: |
| The RPC endpoint used to fetch blocks, transactions, receipts, tokens. | Required: ✅
Version: All
Default: |
| 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 |
| 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 |
| Management of DB queue target. Implemented in #8991. | Version: v5.4.0+
Default: |
| The RPC endpoint specifically for the Erigon/Geth/Nethermind/Besu client used by | Version: All
Default: |
| The WebSockets RPC endpoint used to subscribe to the | Version: All
Default: |
| Specifies the transport for Blockscout to connect to the Ethereum Node. Available transports are | Version: v3.1.0+
Default: |
| If | Version: v5.0.0+ Default: (empty) Applications: API, Indexer |
| Timeout for ethereum json rpc http requests in seconds. Implemented in #7089 | Version: v5.1.2+
Default: |
| User in basic auth for JSON RPC endpoint. Implemented in #6897 | Version: v5.1.2+ Default: (empty) Applications: API, Indexer |
| Password in basic auth for JSON RPC endpoint. Implemented in #6897 | Version: v5.1.2+ Default: (empty) Applications: API, Indexer |
| Custom headers for JSON RPC endpoint in form of json object, example: | Version: v5.2.1+ Default: (empty) Applications: API, Indexer |
| Fallback JSON RPC HTTP url. Implemented in #7246 | Version: v5.1.4+ Default: (empty) Applications: API, Indexer |
| Fallback JSON RPC trace url. Implemented in #7246 | Version: v5.1.4+ Default: (empty) Applications: API, Indexer |
| Fallback JSON RPC | Version: v6.3.0+ Default: (empty) Applications: API, Indexer |
| Wait time for each recent timeout from node. Implemented in #8292 | Version: v5.2.3+
Default: |
| JSON RPC url for | Version: v6.0.0+ Default: (empty) Applications: API, Indexer |
| Environment variable for the main EVM network such as Ethereum or POA. | Version: All
Default: |
| 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: |
| Path to the IPC file of the running node if IPC transport is chosen. | Version: v2.1.1+ Default: (empty) Applications: API, Indexer |
| Used to set a network path other than what is displayed in the root directory. An example would be to add | Version: All
Default: |
| Host for API endpoint examples. | Version: v2.1.0+
Default: |
| Url scheme for blockscout. | Version: v2.1.0+
Default: prod env |
| 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 |
| Used to check the origin of requests when the origin header is present. It defaults to | Version: All
Default: |
| Default port the application runs on is 4000. | Version: All
Default: |
| Coin is checked via the CoinGecko API to obtain USD prices on graphs and other areas of the UI. | Version: All
Default: |
| 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 |
| Should be set to | Version: v2.0.4+
Default: |
| 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 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 |
| Used by RSK in order to tell the application how to calculate the total supply of the chain. Available value is | Version: All Default: (empty) Applications: API, Indexer |
| Defines the number of database connections allowed excluding read-only API endpoints requests. | Version: All
Default: |
| Defines the number of database connections allowed for read-only API endpoints requests. | Version: v4.1.0+
Default: |
| Production environment variable to use SSL on Ecto queries. | Version: All
Default: |
| Production environment variable to restart the application in the event of a crash. | Version: All
Default: |
| Production environment variable to restart the application in the event of a crash. | Version: All Default: (empty) Applications: API, Indexer |
| 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 |
| If | Needs Recompile: ☑️
Version: v2.0.3+
Default: |
| If | Needs Recompile: ☑️
Version: v5.1.5+
Default: |
| If | Needs Recompile: ☑️
Version: v5.1.5+
Default: |
| If | Version: v6.6.0+
Default: |
| Link to web application instance, e.g. | Version: v2.0.3+ Default: (empty) Applications: API |
| Link to API instance, e.g. | Version: v2.0.3+ Default: (empty) Applications: API |
| Version: v5.3.2+
Default: | |
| API key to protect some sensitive endpoints. Implemented in #7355 | Version: v5.1.5+ Default: (empty) Applications: API |
| If set to | Version: v3.1.0+
Default: |
| Defines checksum address function. 2 available values: | Version: v2.0.1+
Default: |
| A comma-separated list of addresses to enable restricted access to them. | Version: v3.3.3+ Default: (empty) Applications: API |
| A key to access addresses listed in | Version: v3.3.3+ Default: (empty) Applications: API |
| Specifies the model of data and enables fetchers specific to the chain. Available values are | Needs Recompile: ☑️
Version: v5.3.0+
Default: |
| 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 endpoint of the chain for the WalletConnect integration. Implemented in #4931 | Version: v4.1.0+ Default: (empty) Applications: API, Indexer |
| New blocks indexed max delay in /health API endpoint. Time format. Implemented in #2294 | Version: v2.0.2+
Default: |
| Add public tag labels. More info in #6316 | Version: v5.0.0+ Default: (empty) Applications: API |
| Specify addresses for some label. More info in #6316 | Version: v5.0.0+ Default: (empty) Applications: API |
| Value of this env will be added to domain of session cookie. Implemented in #6544 | Version: v5.0.0+ Default: (empty) Applications: API |
| Allows decoding of contract calls directed to addresses which are not contracts. Implemented in #6541 | Needs Recompile: ☑️
Version: v5.1.0+
Default: |
| EIP-1559 elasticity multiplier. Implemented in #7253 | Version: v5.1.3+
Default: |
| EIP-1559 base fee max change denominator. Implemented in #9202 | Version: v6.2.0+
Default: |
| Concurrency of new fields backfiller implemented in #8386 | Version: v5.3.0+
Default: |
| Batch size of new fields backfiller implemented in #8386 | Version: v5.3.0+
Default: |
| Version: v5.3.2+
Default: | |
| Bottom block for token id migration. Implemented in #6391 | Version: v5.0.0+
Default: |
| Number of workers performing the token id migration. Implemented in #6391 | Version: v5.0.0+
Default: |
| Interval of token transfer block numbers processed by a token id migration worker at a time. Implemented in #6391 | Version: v5.0.0+
Default: |
| 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: |
| In the case when the 1st tx in the chain already has internal transactions, If the number of blocks in | Version: v5.2.0+
Default: |
| 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 |
| Variable to enable running queries at /public-metrics endpoint. Implemented in #10469. | Version: master Default: false Applications: API |
| Public metrics update period in hours at /public-metrics endpoint. Implemented in #10469. | Version: master Default: 24 Applications: API |
Indexer Management
Variable | Description | Parameters |
---|---|---|
| Transformer for blocks: base or clique. | Version: v.1.3.4+
Default: |
| If | Version: v2.0.3+
Default: |
| If | Version: v5.1.5+
Default: |
| If | Version: v4.1.2+
Default: |
| If | Version: v4.1.2+
Default: |
| if | Version: v4.1.3+
Default: |
| If | Version: v4.1.3+
Default: |
| If | Version: v4.1.3+
Default: |
| Memory soft limit for the indexer. | Version: v4.1.3+
Default: |
| Batch size for empty block sanitizer (re-fetcher). | Version: v4.1.3+
Default: |
| Batch size for blocks catchup fetcher. Implemented in #6196. | Version: v5.0.0+
Default: |
| Concurrency for blocks catchup fetcher. Implemented in #6196. | Version: v5.0.0+
Default: |
| Empty blocks sanitizer is disabled if | Version: v5.1.2+
Default: |
| If | Version: v4.1.6+
Default: |
| The block number, where import of blocks by catchup fetcher begins from. | Version: v1.3.8+
Default: |
| The block number, where import of blocks by catchup fetcher stops. | Version: v2.0.3+ Default: (empty) Applications: Indexer |
| The block number, where indexing of internal transactions begins from. | Version: v4.1.0+
Default: |
| The block number, where indexing of internal transactions stops. | Version: v4.1.0+ Default: (empty) Applications: API, Indexer |
| Block ranges to import by catchup fetcher. Example: | Version: v4.1.7+ Default: (empty) Applications: Indexer |
| Tells the application how to calculate block rewards, by fetching via json_rpc ( | Version: v4.1.4+
Default: |
| IPFS gateway url for fetching token instance metadata from IPFS including token instance icon. | Version: v5.3.0+
Default: |
| The key of the parameter to add to IPFS gateway url. Implemented in #9898. | Version: v6.5.0+ Default: (empty) Applications: Indexer |
| The value of the parameter to add to IPFS gateway url. Implemented in #9898. | Version: v6.5.0+ Default: (empty) Applications: Indexer |
| 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 |
| Timeout for | Version: v4.1.3+
Default: |
| If | Version: v5.0.0+
Default: |
| Defines which method will be used for fetching pending transactions: | Version: v5.0.0+
Default: |
| Batch size for internal transactions fetcher. Implemented in #6450. | Version: v5.0.0+
Default: |
| Concurrency for internal transactions fetcher. Implemented in #6450. | Version: v5.0.0+
Default: |
| Batch size for block reward fetcher. Implemented in #6952. | Version: v5.1.2+
Default: |
| Concurrency for block reward fetcher. Implemented in #6952. | Version: v5.1.2+
Default: |
| Batch size for transaction receipts fetcher. Implemented in #6454. | Version: v5.0.0+
Default: |
| Concurrency for transaction receipts fetcher. Implemented in #6454. | Version: v5.0.0+
Default: |
| Batch size for coin balances fetcher. Implemented in #6454. | Version: v5.0.0+
Default: |
| Concurrency for coin balances fetcher. Implemented in #6454. | Version: v5.0.0+
Default: |
| Concurrency for token fetcher. Implemented in #8167. | Version: v5.2.2+
Default: |
| Batch size for token balances fetcher. Implemented in #7439. | Version: v5.1.5+
Default: |
| Concurrency for token balances fetcher. Implemented in #8167. | Version: v5.2.2+
Default: |
| If | Version: v5.1.0+
Default: |
| 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: |
| 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 |
| 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 |
| Comma-separated names of protocols which should be indexed or reindexed on historical blocks defined by the range. Example: | Version: v5.1.0+ Default: (empty) Applications: Indexer |
| 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 |
| UniswapV3Factory contract address. Implemented in #7312. | Version: v5.1.4+
Default: |
| NonfungiblePositionManager contract address for Uniswap v3. Implemented in #7312. | Version: v5.1.4+
Default: |
| Batch size for missing ranges collector. Implemented in #6583. | Version: v5.0.0+
Default: |
| Batch size for min missing block number updater. Implemented in #6583. | Version: v5.0.0+
Default: |
| Tracer type for | Version: v5.1.0+
Default: |
| Maximum interval between attempts to fetch token instance metadata. Time format. Implemented in #10027. | Version: master
Default: |
| Base to calculate exponential timeout. Implemented in #10027. | Version: master
Default: |
| Coefficient to calculate exponential timeout. Implemented in #10027. | Version: master
Default: |
| Concurrency for | Version: v5.1.4+
Default: |
| Concurrency for | Version: v5.1.4+
Default: |
| Concurrency for | Version: v5.1.4+
Default: |
| If | Version: v5.1.4+
Default: |
| If | Version: v5.1.4+
Default: |
| If | Version: v6.6.0+
Default: |
| Timeout for retry set by | Version: v6.6.0+
Default: |
| If | Version: v5.1.4+
Default: |
| If | Version: v6.2.0+
Default: |
| Max gap between consecutive | Version: v5.1.5+
Default: |
| If | Version: v5.1.5+
Default: |
| 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 |
| Interval between blocks catchup fetcher tasks. Implemented in #7489. | Version: v5.1.5+
Default: |
| Limit for all fetchers init queries. Implemented in #7697. | Version: v5.2.0+
Default: |
| Batch size for | Version: v5.2.3+
Default: |
| Batch size for | Version: v5.2.3+
Default: |
| Batch size for | Version: v5.2.3+
Default: |
| Limit for token balance fetcher init queries. Implemented in #8459. | Version: v5.2.3+
Default: |
| Limit for coin balance fetcher init queries. Implemented in #7996. | Version: v5.3.0+
Default: |
| If | Version: v5.3.0+
Default: |
| Concurrency for legacy | Version: v5.4.0+
Default: |
| Batch size for legacy | Version: v5.3.0+
Default: |
| If | Version: v6.2.0+
Default: |
| If | Version: v6.2.0+
Default: |
| Concurrency for | Version: v6.2.0+
Default: |
| Concurrency for | Version: v6.2.0+
Default: |
| Batch size for | Version: v6.2.0+
Default: |
| Batch size for | Version: v6.2.0+
Default: |
| Interval for empty block sanitizer. Implemented in #8658 | Version: v5.3.0+
Default: |
| Max block number gap from latest for which balances requests can be processed when | Version: v5.3.1+
Default: |
| If | Version: v5.3.2+
Default: |
| Block ranges for traceable blocks. Example: | Version: v5.4.0+ Default: (empty) Applications: API, Indexer |
| Enable tracing by block for geth variant. Implemented in #9072 | Version: v6.1.0+
Default: |
| 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: |
| Minimal blocks count until the next token balance request will be executed for tokens that doesn't implement | Version: master
Default: |
| Allow transactions to not have internal transactions. Implemented in #10200 | Version: master
Default: |
| If | Version: master
Default: |
Denormalization & Sanitizer Management
Variable | Description | Parameters |
---|---|---|
| Number of transactions to denormalize (add block timestamp and consensus) in the batch. | Version: v.6.0.0-beta
Default: |
| Number of parallel denormalization transaction batches processing. | Version: v.6.0.0-beta
Default: |
| Number of token transfers to denormalize (add token_type) in the batch. | Version: v.6.3.0+
Default: |
| Number of parallel denormalization token transfer batches processing. | Version: v.6.3.0+
Default: |
| Number of token transfers to sanitize in the batch. | Version: v.6.3.0+
Default: |
| Number of parallel sanitizing token transfer batches processing. | Version: v.6.3.0+
Default: |
| Number of token transfers to sanitize in the batch. Implemented in #10134 | Version: master
Default: |
| Number of parallel sanitizing token transfer batches processing. Implemented in #10134 | Version: master
Default: |
Exchange Rates
Variable | Description | Parameters |
---|---|---|
| Disables or enables fetching of coin price from Coingecko API. | Version: v.3.1.2+
Default: |
| Sets the source for market cap fetching. Available values | Version: v.5.2.3+
Default: |
| Sets the source for TVL fetching. Available value is | Version: v.5.3.0+ Default: (empty) Applications: API, Indexer |
| Sets the source for price fetching. Available values are also | Version: v.5.2.3+
Default: |
| Explicitly set Mobula coin ID. | Version: master Default: (empty) Applications: API, Indexer |
| Explicitly set Mobula coin ID for secondary coin market chart. | Version: master Default: (empty) Applications: API, Indexer |
| Mobula API key. | Version: master Default: (empty) Applications: API, Indexer |
| Mobula chain id for which token prices are fetched, see full list in the | Version: master Default: (empty) Applications: API, Indexer |
| Explicitly set CoinGecko coin ID. | Version: v4.1.4+ Default: (empty) Applications: API, Indexer |
| Explicitly set CoinGecko coin ID for secondary coin market chart. Implemented in #9483. | Version: v6.3.0+ Default: (empty) Applications: API, Indexer |
| CoinGecko API key. | Version: v4.1.4+ Default: (empty) Applications: API, Indexer |
| CoinMarketCap API key. Required, if | Version: v4.1.4+ Default: (empty) Applications: API, Indexer |
| CoinMarketCap coin id. | Version: v5.2.1+ Default: (empty) Applications: API, Indexer |
| CoinMarketCap coin id for secondary coin market chart. Implemented in #9483. | Version: v6.3.0+ Default: (empty) Applications: API, Indexer |
| DefiLlama coin id. | Version: v5.3.0+ Default: (empty) Applications: API, Indexer |
| if | Version: v4.1.5+ Default: (empty) Applications: API, Indexer |
| CoinGecko platform id for which token prices are fetched, see full list in | Version: v5.1.2+
Default: |
| 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: |
| Interval between refetching token prices, responsible for the relevance of prices. Time format. Implemented in #6925. | Version: v5.1.2+
Default: |
| Batch size of a single token price request. Implemented in #6925. | Version: v5.1.2+
Default: |
| If | Version: v5.1.2+
Default: |
| CryptoCompare coin symbol for secondary coin market chart. Implemented in #9483. | Version: v6.3.0+ Default: (empty) Applications: API, Indexer |
| If set, overrides the Coingecko base URL. Implemented in #9679. | Version: v6.4.0+
Default: |
| If set, overrides the Coingecko Pro base URL. Implemented in #9679. | Version: v6.4.0+
Default: |
| If set, overrides the CoinMarketCap base URL (Free and Pro). Implemented in #9679. | Version: v6.4.0+
Default: |
Cache Management
See the Time format section for more information on variable formatting.
Variable | Description | Parameters |
---|---|---|
| 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: |
| 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: |
| 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: |
| Time interval to restart the task which calculates the total pending_block_operations count. | Version: v.5.2.0+
Default: |
| Interval to restart the task which calculates gas usage at the address. | Version: v.4.1.3+
Default: |
| Interval to restart the task which calculates holders count of the token. | Version: v.4.1.3+
Default: |
| Interval to restart the task which calculates transfers count of the token. | Version: v.4.1.3+
Default: |
| Interval to restart the task which calculates addresses with balances. | Needs Recompile: ☑️
Version: v4.1.3+
Default: |
| Interval to restart the task which updates token metadata. | Version: v.2.0.1+
Default: |
| Update of average block period cache. | Version: v.4.1.3+
Default: |
| Update of market history cache. | Version: v.4.1.3+
Default: |
| Time to live of address' transaction counter. Time format. Introduced in #3330. | Version: v.3.4.0+
Default: |
| Managing of cache invalidation period for the sum of USD value of tokens per tokens' holder address. | Version: v.3.5.0+
Default: |
| Value to tune the time to live of exchange rates. Time format. Implemented in #5671. | Needs Recompile: ☑️
Version: v4.1.5+
Default: |
| A threshold to invalidate token balance cache. | Version: v.5.1.2+
Default: |
| A threshold to invalidate coin balance cache. | Version: v.5.1.2+
Default: |
| An initial threshold (for exponential backoff) to fetch smart-contract bytecode on-demand. Implemented in #9708. | Version: v.6.4.0+
Default: |
| Interval to restart the task, which calculates the number of token transfers at the address. Implemented in #4699. | Version: v.4.0.0+
Default: |
| 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: |
| if | Needs Recompile: ☑️
Version: v5.1.3+
Default: |
| Interval to update data for the last day in the Market History table. Introduced in #9197. | Version: v.6.1.0+
Default: |
| Interval to update data for the last 24 hours transactions stats. Introduced in #9483. | Version: v.6.3.0+
Default: |
| Interval to update count of pending transactions that appeared less than half an hour ago. Introduced in #9483. | Version: v.6.3.0+
Default: |
| Interval to update data for the last output root size counter. Introduced in #9532. | Version: v.6.3.0+
Default: |
Gas Price Oracle
Variable | Description | Parameters |
---|---|---|
| Gas price oracle: number of blocks to calculate average gas price from | Version: v.4.1.4+
Default: |
| Gas price oracle: safelow percentile | Version: v.4.1.4+
Default: |
| Gas price oracle: average percentile | Version: v.4.1.4+
Default: |
| Gas price oracle: fast percentile | Version: v.4.1.4+
Default: |
| Gas price oracle: period of gas prices update. | Version: v.4.1.4+
Default: |
| Gas price oracle: amount of gas for a simple coin transfer. Introduced in #9044. | Version: v.6.0.0+
Default: |
| 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: |
| 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: |
| 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: |
Main Page Dashboard
Variable | Description | Parameters |
---|---|---|
| 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 |
| Disables or enables txs per day stats gathering. | Version: v.5.1.3+
Default: |
| Disables or enables price and market cap of coin charts on the main page. | Version: v.3.1.2+
Default: |
| Showa price and market cap values under the chart even if price chart is not enabled via | Version: v.5.1.4+
Default: |
| Disables or enables txs count per day chart on the main page. | Version: v.3.1.2+
Default: |
| 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: |
| 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: |
Header and Footer
Header
Variable | Description | Parameters |
---|---|---|
| Environment variable for the header logo image location. The logo files names for different chains can be found here. | Version: all
Default: |
| Enables testnet label right after logo in the navigation panel. Implemented in #5732 | Version: v.4.1.6+ Default: (empty) Applications: API |
| The text inside the test label. Implemented in #5732 | Version: v.4.1.6+
Default: |
| An array of supported chains displayed in the chains dropdown. This var was introduced in this PR #1900 and looks like an array of JSON objects. | Version: v.2.0.0+
Default: |
| true/false. If true, the Apps navigation menu item appears. | Version: v.3.3.1+
Default: |
| Version: v.5.0.0+ Default: (empty) Applications: API |
Footer
Variable | Description | Parameters |
---|---|---|
| Environment variable for the footer logo image location. The logo files names for different chains can be found here. | Version: all
Default: |
| The link to Blockscout release notes in the footer. | Version: v.1.3.5+
Default: |
| Added to the footer to signify the current BlockScout version. | Version: v.1.3.4+ Default: (empty) Applications: API |
| Link to Chat menu item in the footer. Implemented in #5719. | Version: v.4.1.6+
Default: |
| Enable forum menu item in the footer. | Version: v.5.1.3+
Default: |
| Link in Forum menu item in the footer. Implemented in #5719 | Version: v.4.1.6+
Default: |
| Enable Telegram menu item in the footer. Implemented in #7345. | Version: v.5.1.4+
Default: |
| Link in Telegram menu item in the footer. Implemented in #7345. | Version: v.5.1.4+ Default: (empty) Applications: API |
| Github repository. Implemented in #5719. | Version: v.4.1.6+
Default: |
| true/false. If true, links to other explorers are added in the footer. | Version: v.5.1.3+ Default: (empty) Applications: API |
| The list of alternative explorers. | Version: v.5.1.3+ Default: (empty) Applications: API |
Contract Management
Variable | Description | Parameters |
---|---|---|
| Version: v.5.2.0+
Default: | |
| Comma-separated list of allowed EVM versions for Vyper contract verification. This var was introduced in #7614. | Version: v.5.2.0+
Default: |
| Max amount of libraries to consider in smart-contract verification from flat/multi-part file(s). Implemented in #6204. | Version: v.5.0.0+ Default: (empty) Applications: API |
| Hide long contract method data. For more details: #4667 | Version: v.4.0.0+
Default: |
| If | Version: v.5.1.2+ Default: (empty) Applications: API |
| If | Version: v.6.1.0+
Default: |
| URL of Airtable to store audit reports from users. Implemented in #9120 | Version: v.6.1.0+ Default: (empty) Applications: API |
| Access token for | Version: v.6.1.0+ Default: (empty) Applications: API |
| Comma-separated list of smart-contract address hashes, to which "certified" flag should be applied. Implemented in #9910" | Version: v.6.5.0+ Default: (empty) Applications: API |
| Comma-separated list of smart-contract address hashes of WETH-like tokens which deposit and withdrawal events you'd like to index. Implemented in #10134 | Version: master Default: (empty) Applications: API, Indexer |
| Version: v.6.1.0+
Default: |
Bridged Tokens
Variable | Description | Parameters |
---|---|---|
| Variable to enable bridged tokens functionality. Introduced in #9169 | Needs Recompile: ☑️ Version: v6.1.0+ Default: (empty) Applications: API, Indexer |
| OMNI bridge mediator for ETH tokens. Introduced in #9169 | Version: v6.1.0+ Default: (empty) Applications: API, Indexer |
| OMNI bridge mediator for BSC tokens. Introduced in #9169 | Version: v6.1.0+ Default: (empty) Applications: API, Indexer |
| OMNI bridge mediator for POA tokens. Introduced in #9169 | Version: v6.1.0+ Default: (empty) Applications: API, Indexer |
| AMB bridge mediator. Introduced in #9169 | Version: v6.1.0+ Default: (empty) Applications: API, Indexer |
| Ethereum mainnet JSON RPC. Introduced in #9169 | Version: v6.1.0+ Default: (empty) Applications: API, Indexer |
Miscellaneous UI
Variable | Description | Parameters |
---|---|---|
| Configures market cap percentage column on the top accounts page. | Version: v.2.1.1+
Default: |
| Disables/enables announcement at the top of the explorer. | Version: v.3.6.0+
Default: |
| Message text of the announcement at the top of the explorer. | Version: v.3.6.0+ Default: (empty) Applications: API |
| Hides miner/validator/sequencer on block page and tiles if the value is | Version: v.4.0.0+ Default: (empty) Applications: API |
| Displays token icons from Trust Wallet assets repository if | Version: v.4.0.0+ Default: (empty) Applications: API |
| Include or exclude non-consensus blocks in avg block time calculation. Exclude if | Version: v.2.0.1+
Default: |
| Number of days to consider for coin balance history chart. | Version: v.3.1.3+
Default: |
| if | Needs Recompile: ☑️ Version: v4.1.2+ Default: (empty) Applications: API |
| If | Version: v.5.1.0+ Default: (empty) Applications: API |
| If | Version: v.5.1.0+ Default: (empty) Applications: API |
| If | Version: v.5.1.0+ Default: (empty) Applications: API |
CSV Export
reCAPTCHA v2 and v3 keys for CSV export page. Do not use both v2/v3 keys. Only one version of reCAPTCHA should be used.
Variable | Description | Parameters |
---|---|---|
| Google reCAPTCHA v2 secret key. Used by advanced CSV export. Implemented in #4747 | Version: v.4.0.0+ Default: (empty) Applications: API |
| Google reCAPTCHA v2 client key. Used by advanced CSV export. Implemented in #4747 | Version: v.4.0.0+ Default: (empty) Applications: API |
| Google reCAPTCHA v3 secret key. Used by advanced CSV export. Implemented in #7273 | Version: v.5.1.4+ Default: (empty) Applications: API |
| Google reCAPTCHA v3 client key. Used by advanced CSV export. Implemented in #7273 | Version: v.5.1.4+ Default: (empty) Applications: API |
| Disable reCAPTCHA. Implemented in #7416 | Version: v.5.1.5+
Default: |
API Rate Limits
Variable | Description | Parameters |
---|---|---|
| A global API rate limit: number or requests per second for all users. Implemented in #5030 | Version: v.4.1.1+
Default: |
| A dedicated API rate limit per key for every type of API key (static or generated from Account module). Implemented in #5080 | Version: v.4.1.1+
Default: |
| Comma-separated whitelisted IPs list with dedicated rate limit. Implemented in #5090 | Version: v.4.1.1+ Default: (empty) Applications: API |
| Static API key with dedicated API rate limit. Implemented in #5080 | Version: v.4.1.1+ Default: (empty) Applications: API |
| If | Version: v.5.1.0+ Default: (empty) Applications: API |
| Version: v.5.1.3+
Default: | |
| A dedicated API rate limit for whitelisted IPs. Implemented in #5090 | Version: v.5.1.3+
Default: |
| Global rate limit for an IP address for API v2 requests sent from UI. #7148 | Version: v.5.1.3+
Default: |
| Redis DB URL for Hammer rate limit library. Implemented in #7148 | Needs Recompile: ☑️ Version: v5.1.3+ Default: (empty) Applications: API |
| Rate limit after submitting correct CAPTCHA. Implemented in #7148 | Version: v.5.1.3+
Default: |
| Time interval of rate limit. Implemented in #7148 | Version: v.5.1.3+
Default: |
| Time interval of rate limit set by | Version: v.5.1.3+
Default: |
| TTL for token issued after submitting correct CAPTCHA for an API v2 requests from UI. In seconds. Implemented in #7148 | Version: v.5.1.3+
Default: |
| Max batch size for Eth JSON RPC requests. Implemented in #9409 | Version: v.6.3.0+
Default: |
GraphQL API
Variable | Description | Parameters |
---|---|---|
| Enabling/disabling of GraphQL API. Implemented in #9751 | Version: v.6.4.0+
Default: |
| Query/schema max_complexity of GraphQL API. Implemented in #9751 | Needs Recompile: ☑️
Version: v6.4.0+
Default: |
| Query token_limit of Absinthe. Implemented in #9751 | Needs Recompile: ☑️
Version: v6.4.0+
Default: |
| Default transaction hash in a sample query to GraphiQL. Implemented in #9751. | Needs Recompile: ☑️
Version: v6.4.0+
Default: |
| A global GraphQL API rate limit: number or requests per second for all users. Implemented in #9771 | Version: v.6.4.0+
Default: |
| A dedicated GraphQL API rate limit per static key. If this limit is less than stated in API plan, then | Version: v.6.4.0+
Default: |
| Static GraphQL API key with dedicated GraphQL API rate limit. Implemented in #9771 | Version: v.6.4.0+ Default: (empty) Applications: API |
| If | Version: v.6.4.0+ Default: (empty) Applications: API |
| Global rate limit for an IP address for GraphQL API requests. #9771 | Version: v.6.4.0+
Default: |
| Time interval of rate limit. Time format. Implemented in #9771 | Version: v.6.4.0+
Default: |
| Time interval of rate limit set by | Version: v.6.4.0+
Default: |
Account Related
Variable | Description | Parameters |
---|---|---|
| Turn on/off account functionality. If value is | Version: v5.0.0+ Default: (empty) Applications: API |
| Account DB connection string | Version: v.5.0.0+
Default: value from |
| Account Redis connection string (for session storing configuration) | Version: v5.0.0+ Default: (empty) Applications: API |
| Account DB | Version: v.5.0.0+
Default: |
| Domain for Ueberauth Auth0 | Version: v5.0.0+ Default: (empty) Applications: API |
| Auth0 client ID Ueberauth Auth0 | Version: v5.0.0+ Default: (empty) Applications: API |
| Auth0 client secret Ueberauth Auth0 | Version: v5.0.0+ Default: (empty) Applications: API |
| Airtable URL for public tag requests functionality | Version: v5.0.0+ Default: (empty) Applications: API |
| Airtable API key for public tag requests functionality | Version: v5.0.0+ Default: (empty) Applications: API |
| Sendgrid API key for watchlist notifications functionality | Version: v5.0.0+ Default: (empty) Applications: API |
| Sendgrid sender email for watchlist notifications functionality | Version: v5.0.0+ Default: (empty) Applications: API |
| Sendgrid email template for watchlist notifications functionality | Version: v5.0.0+ Default: (empty) Applications: API |
| Account DB encryption key. Instruction how to generate | Version: v5.0.0+ Default: (empty) Applications: API |
| Time before resending confirmation email. Implemented in #7298. | Version: v.5.1.5+
Default: |
| Limit for address & transaction tags. Implemented in #8528. | Version: v.5.3.1+
Default: |
| Limit for watch list addresses. Implemented in #8528. | Version: v.5.3.1+
Default: |
| Per account limit for watch list notifications sent for the last 30 days. Implemented in #8966. | Version: v.5.3.3+
Default: |
Specific Smart Contracts
Variable | Description | Parameters |
---|---|---|
| Used by POA Network to obtain Validators information to display in the UI. | Version: all Default: (empty) Applications: API, Indexer |
| Used by POA Network to obtain the list of current validators. | Version: all Default: (empty) Applications: API, Indexer |
| Used by POA Network to set KeysManager proxy contract in order to obtain payout key by mining key. This needs to identify distributed reward to the validator. | Version: v3.1.2+ Default: (empty) Applications: API, Indexer |
| Emission rewards contract address. This env var is used only if | Version: v.2.0.4+
Default: |
| Token bridge proxy contract. For `TokenBridge` supply module. | Version: v.1.3.2+
Default: |
Last updated