ENV Variables
Backend ENVs: Integrations
The following ENVs are used for different integrations. Some work with various microservices (when the variable begins with MICROSERVICE) while others are contained within the application.More info on Blockscout Rust MicroServices is available in the blockscout-rs Github Repo.
Time format
Can be set in format1h 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.
Smart-contract verifier / Eth Bytecode DB
Connecting to the smart contract verification service
| Variable | Description | Parameters |
|---|---|---|
MICROSERVICE_SC_VERIFIER_ENABLED | If true, integration with Rust smart-contract verifier is enabled. true is the default value starting from version 6.4.0. Implemented in #5860 | Version: v5.1.3+ Default: true Applications: API |
MICROSERVICE_SC_VERIFIER_URL | URL of Rust smart-contract verifier. Implemented in #5860 | Version: v5.1.3+ Default: https://eth-bytecode-db.services.blockscout.com/ Applications: API |
MICROSERVICE_ETH_BYTECODE_DB_INTERVAL_BETWEEN_LOOKUPS | Minimal time after unsuccessful check of smart contract’s sources in Eth Bytecode DB. Implemented in #7187. | Version: v5.1.3+ Default: 10m Applications: API |
MICROSERVICE_SC_VERIFIER_TYPE | Type of smart contract microservice could be either eth_bytecode_db or sc_verifier. Implemented in #7187 | Version: v5.1.3+ Default: sc_verifier Applications: API |
MICROSERVICE_ETH_BYTECODE_DB_MAX_LOOKUPS_CONCURRENCY | Maximum amount of concurrent requests for fetching smart contract’s sources in Eth Bytecode DB. Implemented in #8472 | Version: v5.3.0+ Default: 10 Applications: API |
MICROSERVICE_SC_VERIFIER_API_KEY | API key for verification that metadata sent to verifier microservice from a trusted source. Implemented in #8750 | Version: v5.3.2+ Default: (empty) Applications: API |
Sol2Uml
Sol2Uml is a visualization tool for Solidity contracts.
Scroll down on the contract page to find the View UML diagram link
Contract visualization example
| Variable | Description | Parameters |
|---|---|---|
MICROSERVICE_VISUALIZE_SOL2UML_ENABLED | If true, integration with Rust sol2uml visualizer is enabled. Implemented in #6401 | Version: v5.1.3+ Default: (empty) Applications: API |
MICROSERVICE_VISUALIZE_SOL2UML_URL | URL of Rust visualizer. Implemented in #6401 | Version: v5.1.3+ Default: (empty) Applications: API |
Sig-provider
The Sig-provider microservice is used by Blockscout to display decoded transaction data on transaction pages and to determine transaction actions
| Variable | Description | Parameters |
|---|---|---|
MICROSERVICE_SIG_PROVIDER_ENABLED | If true, integration with Rust sig-provider service is enabled. Implemented in #6541 | Version: v5.1.3+ Default: (empty) Applications: API |
MICROSERVICE_SIG_PROVIDER_URL | URL of Rust sig-provider service. Implemented in #6541 | Version: v5.1.3+ Default: (empty) Applications: API |
Blockscout ENS
Blockscout ENS provides indexed data of domain name service for blockscout instances. Learn more.
| Variable | Description | Parameters |
|---|---|---|
MICROSERVICE_BENS_ENABLED | If true, integration with Blockscout ENS service is enabled. Implemented in #8972 | Version: v5.4.0+ Default: (empty) Applications: API |
MICROSERVICE_BENS_URL | URL of Blockscout ENS service. Implemented in #8972 | Version: v5.4.0+ Default: (empty) Applications: API |
Blockscout Account Abstraction
Enables the User Ops Indexer, a service designed to index, decode and serve user operations as per the ERC-4337 standard
| Variable | Description | Parameters |
|---|---|---|
MICROSERVICE_ACCOUNT_ABSTRACTION_ENABLED | If true, integration with Blockscout Account Abstraction service is enabled. Implemented in #9145 | Version: v6.1.0+ Default: (empty) Applications: API |
MICROSERVICE_ACCOUNT_ABSTRACTION_URL | URL of Blockscout ENS service. Implemented in #9145 | Version: v6.1.0+ Default: (empty) Applications: API |
Tx Interpreter (Summary) Service
| Variable | Description | Parameters |
|---|---|---|
MICROSERVICE_TRANSACTION_INTERPRETATION_ENABLED | If true, integration with Tx Interpreter Service is enabled. Implemented in #8957 | Version: v5.4.0+ Default: (empty) Applications: API |
MICROSERVICE_TRANSACTION_INTERPRETATION_URL | URL of Tx Interpreter Service. Implemented in #8957 | Version: v5.4.0+ Default: (empty) Applications: API |
Metadata Service
| Variable | Description | Parameters |
|---|---|---|
MICROSERVICE_METADATA_ENABLED | If true, integration with Metadata Service is enabled. Implemented in #9706 | Version: v6.4.0+ Default: (empty) Applications: API |
MICROSERVICE_METADATA_URL | URL of Metadata Service. Implemented in #9706 | Version: v6.4.0+ Default: (empty) Applications: API |
MICROSERVICE_METADATA_PROXY_REQUESTS_TIMEOUT | Timeout for request forwarding from /api/v2/proxy/metadata/. Implemented in #11656 | Version: v7.0.0+ Default: 30s Applications: API |
Multichain Search Service
Multichain Search is the single point of search of the data in the all blockchains.
| Variable | Description | Parameters |
|---|---|---|
MICROSERVICE_MULTICHAIN_SEARCH_URL | Multichain Search Service API URL. Integration is enabled, if this variable value contains valid URL. Implemented in #11139 | Version: v6.10.0+ Default: (empty) Applications: API, Indexer |
MICROSERVICE_MULTICHAIN_SEARCH_API_KEY | Multichain Search Service API key. Implemented in #11139 | Version: v6.10.0+ Default: (empty) Applications: API, Indexer |
MICROSERVICE_MULTICHAIN_SEARCH_ADDRESSES_CHUNK_SIZE | Chunk size of addresses while exporting to Multichain Search DB. Implemented in #12377 | Version: v8.1.0+ Default: 7000 Applications: API, Indexer |
MICROSERVICE_MULTICHAIN_SEARCH_TOKEN_INFO_CHUNK_SIZE | Chunk size of token info while exporting to Multichain Search DB. Implemented in #12867 | Version: v9.0.0+ Default: 1000 Applications: Indexer |
MIGRATION_BACKFILL_MULTICHAIN_SEARCH_BATCH_SIZE | Batch size of backfilling Multichain Search Service DB. Implemented in #11139 | Version: v6.10.0+ Default: 10 Applications: Indexer |
INDEXER_DISABLE_MULTICHAIN_SEARCH_DB_EXPORT_MAIN_QUEUE_FETCHER | If true, multichain DB main (blocks, transactions, addresses) export fetcher doesn’t run. Implemented in #12377. | Version: v9.0.0+ Default: falseApplications: Indexer |
INDEXER_MULTICHAIN_SEARCH_DB_EXPORT_MAIN_QUEUE_BATCH_SIZE | Batch size for multichain DB main (blocks, transactions, addresses) export fetcher. Implemented in #12377. | Version: v9.0.0+ Default: 1000Applications: Indexer |
INDEXER_MULTICHAIN_SEARCH_DB_EXPORT_MAIN_QUEUE_CONCURRENCY | Concurrency for multichain DB main (blocks, transactions, addresses) export fetcher. Implemented in #12377. | Version: v9.0.0+ Default: 10Applications: Indexer |
INDEXER_MULTICHAIN_SEARCH_DB_EXPORT_MAIN_QUEUE_ENQUEUE_BUSY_WAITING_TIMEOUT | Timeout before new attempt to append item to multichain DB main (blocks, transactions, addresses) export queue if it’s full. Time format. Implemented in #12377. | Version: v9.0.0+ Default: 1sApplications: Indexer |
INDEXER_MULTICHAIN_SEARCH_DB_EXPORT_MAIN_QUEUE_MAX_QUEUE_SIZE | Maximum size of multichain DB main (blocks, transactions, addresses) export queue. Implemented in #12377. | Version: v9.0.0+ Default: 1000Applications: Indexer |
INDEXER_MULTICHAIN_SEARCH_DB_EXPORT_MAIN_QUEUE_INIT_QUERY_LIMIT | Limit of the init query for processing the main export queue to the Multichain DB. Implemented in #12822. | Version: v9.0.0+ Default: 1000Applications: Indexer |
INDEXER_DISABLE_MULTICHAIN_SEARCH_DB_EXPORT_BALANCES_QUEUE_FETCHER | If true, multichain DB balances export fetcher doesn’t run. Implemented in #12580. | Version: v9.0.0+ Default: falseApplications: Indexer |
INDEXER_MULTICHAIN_SEARCH_DB_EXPORT_BALANCES_QUEUE_BATCH_SIZE | Batch size for multichain DB balances export fetcher. Implemented in #12580. | Version: v9.0.0+ Default: 1000Applications: Indexer |
INDEXER_MULTICHAIN_SEARCH_DB_EXPORT_BALANCES_QUEUE_CONCURRENCY | Concurrency for multichain DB balances export fetcher. Implemented in #12580. | Version: v9.0.0+ Default: 10Applications: Indexer |
INDEXER_MULTICHAIN_SEARCH_DB_EXPORT_BALANCES_QUEUE_ENQUEUE_BUSY_WAITING_TIMEOUT | Timeout before new attempt to append item to multichain DB balances export queue if it’s full. Time format. Implemented in #12580. | Version: v9.0.0+ Default: 1sApplications: Indexer |
INDEXER_MULTICHAIN_SEARCH_DB_EXPORT_BALANCES_QUEUE_MAX_QUEUE_SIZE | Maximum size of multichain DB balances export queue. Implemented in #12580. | Version: v9.0.0+ Default: 1000Applications: Indexer |
INDEXER_MULTICHAIN_SEARCH_DB_EXPORT_BALANCES_QUEUE_INIT_QUERY_LIMIT | Limit of the init query for processing the balances export queue to the Multichain DB. Implemented in #12822. | Version: v9.0.0+ Default: 1000 Applications: Indexer |
INDEXER_DISABLE_MULTICHAIN_SEARCH_DB_EXPORT_TOKEN_INFO_QUEUE_FETCHER | If true, multichain DB token info export fetcher doesn’t run. Implemented in #12867. | Version: v9.0.0+ Default: falseApplications: Indexer |
INDEXER_MULTICHAIN_SEARCH_DB_EXPORT_TOKEN_INFO_QUEUE_BATCH_SIZE | Batch size for multichain DB token info export fetcher. Implemented in #12867. | Version: v9.0.0+ Default: 1000Applications: Indexer |
INDEXER_MULTICHAIN_SEARCH_DB_EXPORT_TOKEN_INFO_QUEUE_CONCURRENCY | Concurrency for multichain DB token info export fetcher. Implemented in #12867. | Version: v9.0.0+ Default: 10Applications: Indexer |
INDEXER_MULTICHAIN_SEARCH_DB_EXPORT_TOKEN_INFO_QUEUE_ENQUEUE_BUSY_WAITING_TIMEOUT | Timeout before new attempt to append item to multichain DB token info export queue if it’s full. Time format. Implemented in #12867. | Version: v9.0.0+ Default: 1sApplications: Indexer |
INDEXER_MULTICHAIN_SEARCH_DB_EXPORT_TOKEN_INFO_QUEUE_MAX_QUEUE_SIZE | Maximum size of multichain DB token info export queue. Implemented in #12867. | Version: v9.0.0+ Default: 1000Applications: Indexer |
INDEXER_MULTICHAIN_SEARCH_DB_EXPORT_TOKEN_INFO_QUEUE_INIT_QUERY_LIMIT | Limit of the init query for processing the token info export queue to the Multichain DB. Implemented in #12867. | Version: v9.0.0+ Default: 1000 Applications: Indexer |
TAC Operation Lifecycle Service
| Variable | Description | Parameters |
|---|---|---|
MICROSERVICE_TAC_OPERATION_LIFECYCLE_URL | TAC Operation Lifecycle Service API URL. Integration is enabled, if this variable value contains valid URL. Implemented in #12367 | Version: v8.1.0+ Default: (empty) Applications: API |
MICROSERVICE_TAC_OPERATION_LIFECYCLE_ENABLED | If false, TAC Operation Lifecycle Service integration is disabled despite MICROSERVICE_TAC_OPERATION_LIFECYCLE_URL. Implemented in #12367 | Version: v8.1.0+ Default: true Applications: API |
Sourcify
Allows for contract verification via Sourcify
| Variable | Description | Parameters |
|---|---|---|
SOURCIFY_INTEGRATION_ENABLED | Enables or disables verification of contracts through Sourcify. | Version: v5.1.3+ Default: false Applications: API |
SOURCIFY_SERVER_URL | URL to Sourcify backend. | Version: v3.7.0+ Default: https://sourcify.dev/server Applications: API |
SOURCIFY_REPO_URL | URL to Sourcify repository with fully verified contracts. | Version: v3.7.0+ Default: https://repo.sourcify.dev/contracts/ Before v3.7.1: https://repo.sourcify.dev/contracts/full_match/ Applications: API |
Tenderly
| Variable | Description | Parameters |
|---|---|---|
SHOW_TENDERLY_LINK | if true, Open in Tenderly” button is displayed on the transaction page. Implemented in #4656 | Version: v4.0.0+ Default: (empty) Applications: API |
TENDERLY_CHAIN_PATH | Chain path to the transaction in Tenderly. For instance, for transactions in xDai, Tenderly link looks like this https://dashboard.tenderly.co/tx/xdai/0x..., then TENDERLY_CHAIN_PATH =/xdai. Implemented in #4656 | Version: v4.0.0+ Default: (empty) Applications: API |
Datadog
Integration with the Datadog monitoring and analytics tools
| Variable | Description | Parameters |
|---|---|---|
DATADOG_HOST | Host configuration setting for Datadog integration. | Version: all Default: (empty) Applications: API |
DATADOG_PORT | Port configuration setting for Datadog integration. | Version: all Default: (empty) Applications: API |
Spandex
Spandex is a library for tracing Elixir applications
| Variable | Description | Parameters |
|---|---|---|
SPANDEX_BATCH_SIZE | Spandex and Datadog configuration setting. | Version: all Default: (empty) Applications: API |
SPANDEX_SYNC_THRESHOLD | Spandex and Datadog configuration setting. | Version: all Default: (empty) Applications: API |
Analytics
Variables for adding Mixpanel and/or amplitude for visitor analytics.
| Variable | Description | Parameters |
|---|---|---|
MIXPANEL_TOKEN | Mixpanel project token. | Needs Recompile: ☑️ Version: v5.0.0+ Default: (empty) Applications: API |
MIXPANEL_URL | Url to use Mixpanel with proxy (Collection via Proxy). | Needs Recompile: ☑️ Version: v5.0.0+ Default: (empty) Applications: API |
AMPLITUDE_API_KEY | Amplitude API key. | Needs Recompile: ☑️ Version: v5.0.0+ Default: (empty) Applications: API |
AMPLITUDE_URL | Url to use Amplitude with proxy (Use Domain Proxy to Relay Events). | Needs Recompile: ☑️ Version: v5.0.0+ Default: (empty) Applications: API |
Solidityscan
Enables security scoring for smart contracts
| Variable | Description | Parameters |
|---|---|---|
SOLIDITYSCAN_PLATFORM_ID | Internal platform id in Solidityscan. Implemented in #10473 | Version: v6.8.0+ Default: 16 Applications: API |
SOLIDITYSCAN_CHAIN_ID | Internal chain id in Solidityscan. It may not match with actual chain ID. Implemented in #8908 | Version: v5.3.3+ Default: (empty) Applications: API |
SOLIDITYSCAN_API_TOKEN | API token for usage of Solidityscan API. | Version: v5.3.3+ Default: (empty) Applications: API |
Noves.fi
Adds additional transaction details such as summaries and asset flows. More info here.
| Variable | Description | Parameters |
|---|---|---|
NOVES_FI_BASE_API_URL | Noves.fi API base URL. Implemented in #9056. | Version: v6.1.0+ Default: https://blockscout.noves.fi Applications: API |
NOVES_FI_CHAIN_NAME | Noves.fi API chain name. Implemented in #9056. | Version: v6.1.0+ Default: (empty) Applications: API |
NOVES_FI_API_TOKEN | Noves.fi API token. Implemented in #9056. | Version: v6.1.0+ Default: (empty) Applications: API |
MUD framework
The MUD framework provides standardized tools for data retrieval, libraries and more.
| Variable | Description | Parameters |
|---|---|---|
MUD_INDEXER_ENABLED | If true, integration with MUD is enabled. Implemented in #9869 | Version: v6.6.0+ Default: (empty) Applications: API |
MUD_DATABASE_URL | MUD indexer DB connection URL. | Version: v6.6.0+ Default: value from DATABASE_URL Applications: API |
MUD_POOL_SIZE | MUD indexer DB pool_size | Version: v6.6.0+ Default: 50 Applications: API |
Xname app
Enables Xname app integration, which includes humanity score displayment.
| Variable | Description | Parameters |
|---|---|---|
XNAME_BASE_API_URL | Xname API base URL. Implemented in #11010. | Version: v6.9.2+ Default: https://gateway.xname.app Applications: API |
XNAME_API_TOKEN | Xname API token. Implemented in #11010. | Version: v6.9.2+ Default: (empty) Applications: API |
Stylus contract verifier
Connecting to the Stylus smart contract verification service
| Variable | Description | Parameters |
|---|---|---|
MICROSERVICE_STYLUS_VERIFIER_URL | URL of Stylus verifier. If set valid url and CHAIN_TYPE=arbitrum, integration with Stylus verifier is enabled. Implemented in #11183 | Version: v6.10.0+ Default: (empty) Applications: API |