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 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.
Smart-contract verifier / Eth Bytecode DB
Connecting to the smart contract verification service
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: eth_bytecode_db
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 visualisation tool for Solidity contracts.
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
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.
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
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
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
Sourcify
Allows for contract verification via Sourcify
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
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
Integratio with the Datadog monitoring and analytics tools
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
Analytics
Variables for adding Mixpanel and/or amplitude for visitor analytics.
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
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.
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
Zerion
Enables Zerion integration, which includes multichain net worth view.
ZERION_BASE_API_URL
Zerion API base URL. Implemented in #9896.
Version: v6.5.0+
Default: https://api.zerion.io/v1
Applications: API
ZERION_API_TOKEN
Zerion API token. Implemented in #9896.
Version: v6.5.0+ Default: (empty) Applications: API
MUD framework
The MUD framework provides standardized tools for data retrieval, libraries and more.
MUD_INDEXER_ENABLED
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.
Stylus contract verifier
Connecting to the Stylus smart contract verification service
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: master Default: (empty) Applications: API
Last updated
