ENVs
The app instance can be customized by passing the following variables to the Node.js environment at runtime. Some of these variables have been deprecated, and their full list can be found in the file.
IMPORTANT NOTE! For production build purposes all json-like values should be single-quoted. If it contains a hash (#
) or a dollar-sign ($
) the whole value should be wrapped in single quotes as well (see dotenv
readme for the reference)
Disclaimer about using variables
Please be aware that all environment variables prefixed with NEXT_PUBLIC_
will be exposed to the browser. So any user can obtain its values. Make sure that for all 3rd-party services keys (e.g., Sentri, Auth0, WalletConnect, etc.) in the services administration panel you have created a whitelist of allowed origins and have added your app domain into it. That will help you prevent using your key by unauthorized app, if someone gets its value.
Table of contents
Address verification in "My account"
Blockchain interaction (writing to contract, etc.)
Web3 wallet integration (add token or network to the wallet)
App configuration
Variable | Type | Description | Compulsoriness | Default value | Example value | Version |
---|---|---|---|---|---|---|
NEXT_PUBLIC_APP_PROTOCOL |
| App url schema | - |
|
| v1.0.x+ |
NEXT_PUBLIC_APP_HOST |
| App host | Required | - |
| v1.0.x+ |
NEXT_PUBLIC_APP_PORT |
| Port where app is running | - |
|
| v1.0.x+ |
NEXT_PUBLIC_USE_NEXT_JS_PROXY |
| Tells the app to proxy all APIs request through the NextJS app. We strongly advise not to use it in the production environment, since it can lead to performance issues of the NodeJS server | - |
|
| v1.8.0+ |
Blockchain parameters
Note! The NEXT_PUBLIC_NETWORK_CURRENCY
variables represent the blockchain's native token used for paying transaction fees. NEXT_PUBLIC_NETWORK_SECONDARY_COIN
variables refer to tokens like protocol-specific tokens (e.g., OP token on Optimism chain) or governance tokens (e.g., GNO on Gnosis chain).
Variable | Type | Description | Compulsoriness | Default value | Example value | Version |
---|---|---|---|---|---|---|
NEXT_PUBLIC_NETWORK_NAME |
| Displayed name of the network | Required | - |
| v1.0.x+ |
NEXT_PUBLIC_NETWORK_SHORT_NAME |
| Used for SEO attributes (e.g, page description) | - | - |
| v1.0.x+ |
NEXT_PUBLIC_NETWORK_ID |
| Chain id, see https://chainlist.org for the reference | Required | - |
| v1.0.x+ |
NEXT_PUBLIC_NETWORK_RPC_URL |
| Chain public RPC server url, see https://chainlist.org for the reference | - | - |
| v1.0.x+ |
NEXT_PUBLIC_NETWORK_CURRENCY_NAME |
| Network currency name | - | - |
| v1.0.x+ |
NEXT_PUBLIC_NETWORK_CURRENCY_WEI_NAME |
| Name of network currency subdenomination | - |
|
| v1.23.0+ |
NEXT_PUBLIC_NETWORK_CURRENCY_SYMBOL |
| Network currency symbol | - | - |
| v1.0.x+ |
NEXT_PUBLIC_NETWORK_CURRENCY_DECIMALS |
| Network currency decimals | - |
|
| v1.0.x+ |
NEXT_PUBLIC_NETWORK_SECONDARY_COIN_SYMBOL |
| Network secondary coin symbol. | - | - |
| v1.29.0+ |
NEXT_PUBLIC_NETWORK_MULTIPLE_GAS_CURRENCIES |
| Set to | - |
|
| v1.33.0+ |
NEXT_PUBLIC_NETWORK_VERIFICATION_TYPE |
| Verification type in the network. Irrelevant for Arbitrum (verification type is always | - |
|
| v1.0.x+ |
NEXT_PUBLIC_NETWORK_TOKEN_STANDARD_NAME |
| Name of the standard for creating tokens | - |
|
| v1.31.0+ |
NEXT_PUBLIC_IS_TESTNET |
| Set to true if network is testnet | - |
|
| v1.0.x+ |
API configuration
Variable | Type | Description | Compulsoriness | Default value | Example value | Version |
---|---|---|---|---|---|---|
NEXT_PUBLIC_API_PROTOCOL |
| Main API protocol | - |
|
| v1.0.x+ |
NEXT_PUBLIC_API_HOST |
| Main API host | Required | - |
| v1.0.x+ |
NEXT_PUBLIC_API_PORT |
| Port where API is running on the host | - | - |
| v1.0.x+ |
NEXT_PUBLIC_API_BASE_PATH |
| Base path for Main API endpoint url | - | - |
| v1.0.x+ |
NEXT_PUBLIC_API_WEBSOCKET_PROTOCOL |
| Main API websocket protocol | - |
|
| v1.0.x+ |
UI configuration
Homepage
Variable | Type | Description | Compulsoriness | Default value | Example value | Version |
---|---|---|---|---|---|---|
NEXT_PUBLIC_HOMEPAGE_CHARTS |
| List of charts displayed on the home page | - | - |
| v1.0.x+ |
NEXT_PUBLIC_HOMEPAGE_STATS |
| List of stats widgets displayed on the home page | - | For zkSync, zkEvm and Arbitrum rollups: |
| v1.35.x+ |
NEXT_PUBLIC_HOMEPAGE_PLATE_TEXT_COLOR |
| Text color of the hero plate on the homepage (escape "#" symbol if you use HEX color codes or use rgba-value instead). DEPRECATED Use | - |
|
| v1.0.x+ |
NEXT_PUBLIC_HOMEPAGE_PLATE_BACKGROUND |
| Background css value for hero plate on the homepage (escape "#" symbol if you use HEX color codes or use rgba-value instead). DEPRECATED Use | - |
|
| v1.1.0+ |
NEXT_PUBLIC_HOMEPAGE_HERO_BANNER_CONFIG |
| Configuration of hero banner appearance. | - | - | See below | v1.35.0+ |
Hero banner configuration properties
Note Here, all values are arrays of up to two strings. The first string represents the value for the light color mode, and the second string represents the value for the dark color mode. If the array contains only one string, it will be used for both color modes.
Variable | Type | Description | Compulsoriness | Default value | Example value |
---|---|---|---|---|---|
background |
| Banner background (could be a solid color, gradient or picture). The string should be a valid | - |
|
|
text_color |
| Banner text background. The string should be a valid | - |
|
|
border |
| Banner border. The string should be a valid | - | - |
|
button |
| The button on the banner. It has three possible states: | - | - |
|
Navigation
Variable | Type | Description | Compulsoriness | Default value | Example value | Version |
---|---|---|---|---|---|---|
NEXT_PUBLIC_NETWORK_LOGO |
| Network logo; if not provided, placeholder will be shown; Note the logo height should be 24px and width less than 120px | - | - |
| v1.0.x+ |
NEXT_PUBLIC_NETWORK_LOGO_DARK |
| Network logo for dark color mode; if not provided, inverted regular logo will be used instead | - | - |
| v1.0.x+ |
NEXT_PUBLIC_NETWORK_ICON |
| Network icon; used as a replacement for regular network logo when nav bar is collapsed; if not provided, placeholder will be shown; Note the icon size should be at least 60px by 60px | - | - |
| v1.0.x+ |
NEXT_PUBLIC_NETWORK_ICON_DARK |
| Network icon for dark color mode; if not provided, inverted regular icon will be used instead | - | - |
| v1.0.x+ |
NEXT_PUBLIC_FEATURED_NETWORKS |
| URL of configuration file ( | - | - |
| v1.0.x+ |
NEXT_PUBLIC_OTHER_LINKS |
| List of links for the "Other" navigation menu | - | - |
| v1.0.x+ |
NEXT_PUBLIC_NAVIGATION_HIDDEN_LINKS |
| List of external links hidden in the navigation. Supported ids are | - | - |
| v1.16.0+ |
NEXT_PUBLIC_NAVIGATION_HIGHLIGHTED_ROUTES |
| List of menu item routes that should have a lightning label | - | - |
| v1.31.0+ |
NEXT_PUBLIC_NAVIGATION_LAYOUT |
| Navigation menu layout type | - |
|
| v1.32.0+ |
Featured network configuration properties
Variable | Type | Description | Compulsoriness | Default value | Example value |
---|---|---|---|---|---|
title |
| Displayed name of the network | Required | - |
|
url |
| Network explorer main page url | Required | - |
|
group |
| Indicates in which tab network appears in the menu | Required | - |
|
icon |
| Network icon; if not provided, the common placeholder will be shown; Note that icon size should be at least 60px by 60px | - | - |
|
isActive |
| Pass | - | - |
|
invertIconInDarkMode |
| Pass | - | - |
|
Footer
Variable | Type | Description | Compulsoriness | Default value | Example value | Version |
---|---|---|---|---|---|---|
NEXT_PUBLIC_FOOTER_LINKS |
| URL of configuration file ( | - | - |
| v1.1.1+ |
The app version shown in the footer is derived from build-time ENV variables NEXT_PUBLIC_GIT_TAG
and NEXT_PUBLIC_GIT_COMMIT_SHA
and cannot be overwritten at run-time.
Footer links configuration properties
Variable | Type | Description | Compulsoriness | Default value | Example value |
---|---|---|---|---|---|
title |
| Title of link group | Required | - |
|
links |
| list of links | Required | - |
|
Favicon
By default, the app has generic favicon. You can override this behavior by providing the following variable. Hence, the favicon assets bundle will be generated at the container start time and will be used instead of default one.
Variable | Type | Description | Compulsoriness | Default value | Example value | Version |
---|---|---|---|---|---|---|
FAVICON_MASTER_URL |
| - | - |
|
| v1.11.0+ |
Meta
Settings for meta tags, OG tags and SEO
Variable | Type | Description | Compulsoriness | Default value | Example value | Version |
---|---|---|---|---|---|---|
NEXT_PUBLIC_PROMOTE_BLOCKSCOUT_IN_TITLE |
| Set to | - |
|
| v1.12.0+ |
NEXT_PUBLIC_OG_DESCRIPTION |
| Custom OG description | - | - |
| v1.12.0+ |
NEXT_PUBLIC_OG_IMAGE_URL |
| OG image url. Minimum image size is 200 x 20 pixels (recommended: 1200 x 600); maximum supported file size is 8 MB; 2:1 aspect ratio; supported formats: image/jpeg, image/gif, image/png | - |
|
| v1.12.0+ |
NEXT_PUBLIC_OG_ENHANCED_DATA_ENABLED |
| Set to | - |
|
| v1.29.0+ |
NEXT_PUBLIC_SEO_ENHANCED_DATA_ENABLED |
| Set to | - |
|
| v1.30.0+ |
Views
Block views
Variable | Type | Description | Compulsoriness | Default value | Example value | Version |
---|---|---|---|---|---|---|
NEXT_PUBLIC_VIEWS_BLOCK_HIDDEN_FIELDS |
| Array of the block fields ids that should be hidden. See below the list of the possible id values. | - | - |
| v1.10.0+ |
Block fields list
Id | Description |
---|---|
| Base fee |
| Burnt fees |
| Total block reward |
| Block nonce |
| Address of block's miner or validator |
| Short interpretation of the batch lifecycle (applicable for Rollup chains) |
| Batch index (applicable for Rollup chains) |
Address views
Variable | Type | Description | Compulsoriness | Default value | Example value | Version |
---|---|---|---|---|---|---|
NEXT_PUBLIC_VIEWS_ADDRESS_IDENTICON_TYPE |
| Default style of address identicon appearance. Choose between GitHub, Metamask Jazzicon, Gradient Avatar and Ethereum Blocky | - |
|
| v1.12.0+ |
NEXT_PUBLIC_VIEWS_ADDRESS_FORMAT |
| Displayed address format, could be either | - |
|
| v1.36.0+ |
NEXT_PUBLIC_VIEWS_ADDRESS_BECH_32_PREFIX |
| Human-readable prefix of | Required, if | - |
| v1.36.0+ |
NEXT_PUBLIC_VIEWS_ADDRESS_HIDDEN_VIEWS |
| Address views that should not be displayed. See below the list of the possible id values. | - | - |
| v1.15.0+ |
NEXT_PUBLIC_VIEWS_CONTRACT_SOLIDITYSCAN_ENABLED |
| Set to | - | - |
| v1.19.0+ |
NEXT_PUBLIC_VIEWS_CONTRACT_EXTRA_VERIFICATION_METHODS |
| Pass an array of additional methods from which users can choose while verifying a smart contract. Both methods are available by default, pass | - | - |
| v1.33.0+ |
Address views list
Id | Description |
---|---|
| Top accounts |
Transaction views
Variable | Type | Description | Compulsoriness | Default value | Example value | Version |
---|---|---|---|---|---|---|
NEXT_PUBLIC_VIEWS_TX_HIDDEN_FIELDS |
| Array of the transaction fields ids that should be hidden. See below the list of the possible id values. | - | - |
| v1.15.0+ |
NEXT_PUBLIC_VIEWS_TX_ADDITIONAL_FIELDS |
| Array of the additional fields ids that should be added to the transaction details. See below the list of the possible id values. | - | - |
| v1.15.0+ |
Transaction fields list
Id | Description |
---|---|
| Sent value |
| Fee currency |
| Price per unit of gas |
| Total transaction fee |
| Gas fees breakdown |
| Amount of native coin burnt for transaction |
| Short interpretation of the batch lifecycle (applicable for Rollup chains) |
| Batch index (applicable for Rollup chains) |
Transaction additional fields list
Id | Description |
---|---|
| Amount of total fee divided by total amount of gas used by transaction |
NFT views
Variable | Type | Description | Compulsoriness | Default value | Example value | Version |
---|---|---|---|---|---|---|
NEXT_PUBLIC_VIEWS_NFT_MARKETPLACES |
| Used to build up links to NFT collections and NFT instances in external marketplaces. | - | - |
| v1.15.0+ |
NFT marketplace properties
Variable | Type | Description | Compulsoriness | Default value | Example value |
---|---|---|---|---|---|
name |
| Displayed name of the marketplace | Required | - |
|
collection_url |
| URL template for NFT collection | Required | - |
|
instance_url |
| URL template for NFT instance | Required | - |
|
logo_url |
| URL of marketplace logo | Required | - |
|
Note URL templates should contain placeholders of NFT hash ({hash}
) and NFT id ({id}
). This placeholders will be substituted with particular values for every collection or instance.
Misc
Variable | Type | Description | Compulsoriness | Default value | Example value | Version |
---|---|---|---|---|---|---|
NEXT_PUBLIC_NETWORK_EXPLORERS |
| Used to build up links to transactions, blocks, addresses in other chain explorers. | - | - |
| v1.0.x+ |
NEXT_PUBLIC_CONTRACT_CODE_IDES |
| Used to build up links to IDEs with contract source code. | - | - |
| v1.23.0+ |
NEXT_PUBLIC_HAS_CONTRACT_AUDIT_REPORTS |
| Set to | - |
|
| v1.25.0+ |
NEXT_PUBLIC_HIDE_INDEXING_ALERT_BLOCKS |
| Set to | - |
|
| v1.17.0+ |
NEXT_PUBLIC_HIDE_INDEXING_ALERT_INT_TXS |
| Set to | - |
|
| v1.17.0+ |
NEXT_PUBLIC_MAINTENANCE_ALERT_MESSAGE |
| Used for displaying custom announcements or alerts in the header of the site. Could be a regular string or a HTML code. | - | - |
| v1.13.0+ |
NEXT_PUBLIC_COLOR_THEME_DEFAULT |
| Preferred color theme of the app | - | - |
| v1.30.0+ |
NEXT_PUBLIC_FONT_FAMILY_HEADING |
| Special typeface to use in page headings ( | - | - |
| v1.35.0+ |
NEXT_PUBLIC_FONT_FAMILY_BODY |
| Main typeface to use in page content elements. | - | - |
| v1.35.0+ |
NEXT_PUBLIC_MAX_CONTENT_WIDTH_ENABLED |
| Set to | - |
|
| v1.34.1+ |
Network explorer configuration properties
Variable | Type | Description | Compulsoriness | Default value | Example value |
---|---|---|---|---|---|
logo |
| URL to explorer logo file. Should be at least 40x40. | - | - |
|
title |
| Displayed name of the explorer | Required | - |
|
baseUrl |
| Base url of the explorer | Required | - |
|
paths |
| Map of explorer entities and their paths | Required | - |
|
Note The url of an entity will be constructed as <baseUrl><paths[<entity-type>]><entity-id>
, e.g https://explorer.anyblock.tools/ethereum/poa/core/tx/<tx-id>
Contract code IDE configuration properties
Variable | Type | Description | Compulsoriness | Default value | Example value |
---|---|---|---|---|---|
title |
| Displayed name of the IDE | Required | - |
|
url |
| URL of the IDE with placeholders for contract hash ( | Required | - |
|
icon_url |
| URL of the IDE icon | Required | - |
|
Font family configuration properties
Variable | Type | Description | Compulsoriness | Default value | Example value |
---|---|---|---|---|---|
name |
| Font family name; used to define the | Required | - |
|
url |
| URL for external font. Ensure the font supports the following weights: 400, 500, 600, and 700. | Required | - |
|
App features
Note The variables which are marked as required should be passed as described in order to enable the particular feature, but they are not required in the whole app context.
My account
Variable | Type | Description | Compulsoriness | Default value | Example value | Version |
---|---|---|---|---|---|---|
NEXT_PUBLIC_IS_ACCOUNT_SUPPORTED |
| Set to true if network has account feature | Required | - |
| v1.0.x+ |
NEXT_PUBLIC_RE_CAPTCHA_V3_APP_SITE_KEY |
| See below | Required | - |
| v1.36.0+ |
NEXT_PUBLIC_AUTH0_CLIENT_ID |
| DEPRECATED Client id for Auth0 provider | - | - |
| v1.0.x+ |
NEXT_PUBLIC_AUTH_URL |
| DEPRECATED Account auth base url; it is used for building login URL ( | - | - |
| v1.0.x+ |
NEXT_PUBLIC_LOGOUT_URL |
| DEPRECATED Account logout url. Required if account is supported for the app instance. | - | - |
| v1.0.x+ |
Gas tracker
This feature is enabled by default. To switch it off pass NEXT_PUBLIC_GAS_TRACKER_ENABLED=false
.
Variable | Type | Description | Compulsoriness | Default value | Example value | Version |
---|---|---|---|---|---|---|
NEXT_PUBLIC_GAS_TRACKER_ENABLED |
| Set to true to enable "Gas tracker" in the app | Required |
|
| v1.25.0+ |
NEXT_PUBLIC_GAS_TRACKER_UNITS | Array< | Array of units for displaying gas prices on the Gas Tracker page, in the stats snippet on the Home page, and in the top bar. The first value in the array will take priority over the second one in all mentioned views. If only one value is provided, gas prices will be displayed only in that unit. | - |
|
| v1.25.0+ |
Address verification in "My account"
Note all ENV variables required for My account feature should be passed alongside the following ones:
Variable | Type | Description | Compulsoriness | Default value | Example value | Version |
---|---|---|---|---|---|---|
NEXT_PUBLIC_CONTRACT_INFO_API_HOST |
| Contract Info API endpoint url | Required | - |
| v1.1.0+ |
NEXT_PUBLIC_ADMIN_SERVICE_API_HOST |
| Admin Service API endpoint url | Required | - |
| v1.1.0+ |
Blockchain interaction (writing to contract, etc.)
Variable | Type | Description | Compulsoriness | Default value | Example value | Version |
---|---|---|---|---|---|---|
NEXT_PUBLIC_WALLET_CONNECT_PROJECT_ID |
| Project id for WalletConnect integration | Required | - |
| v1.0.x+ |
NEXT_PUBLIC_NETWORK_RPC_URL |
| See in Blockchain parameters section | Required | - |
| v1.0.x+ |
NEXT_PUBLIC_NETWORK_NAME |
| See in Blockchain parameters section | Required | - |
| v1.0.x+ |
NEXT_PUBLIC_NETWORK_ID |
| See in Blockchain parameters section | Required | - |
| v1.0.x+ |
NEXT_PUBLIC_NETWORK_CURRENCY_NAME |
| See in Blockchain parameters section | Required | - |
| v1.0.x+ |
NEXT_PUBLIC_NETWORK_CURRENCY_SYMBOL |
| See in Blockchain parameters section | Required | - |
| v1.0.x+ |
NEXT_PUBLIC_NETWORK_CURRENCY_DECIMALS |
| See in Blockchain parameters section | - |
|
| v1.0.x+ |
Banner ads
This feature is enabled by default with the slise
ads provider. To switch it off pass NEXT_PUBLIC_AD_BANNER_PROVIDER=none
. Note that the getit
ad provider is temporary disabled.
Variable | Type | Description | Compulsoriness | Default value | Example value | Version |
---|---|---|---|---|---|---|
NEXT_PUBLIC_AD_BANNER_PROVIDER |
| Ads provider | - |
|
| v1.0.x+ |
NEXT_PUBLIC_AD_BANNER_ADDITIONAL_PROVIDER |
| Additional ads provider to mix with the main one | - | - |
| v1.28.0+ |
NEXT_PUBLIC_AD_ADBUTLER_CONFIG_DESKTOP |
| Placement config for desktop Adbutler banner | - | - |
| v1.3.0+ |
NEXT_PUBLIC_AD_ADBUTLER_CONFIG_MOBILE |
| Placement config for mobile Adbutler banner | - | - |
| v1.3.0+ |
Text ads
This feature is enabled by default with the coinzilla
ads provider. To switch it off pass NEXT_PUBLIC_AD_TEXT_PROVIDER=none
.
Variable | Type | Description | Compulsoriness | Default value | Example value | Version |
---|---|---|---|---|---|---|
NEXT_PUBLIC_AD_TEXT_PROVIDER |
| Ads provider | - |
|
| v1.0.x+ |
Beacon chain
Variable | Type | Description | Compulsoriness | Default value | Example value | Version |
---|---|---|---|---|---|---|
NEXT_PUBLIC_HAS_BEACON_CHAIN |
| Set to true for networks with the beacon chain | Required | - |
| v1.0.x+ |
NEXT_PUBLIC_BEACON_CHAIN_CURRENCY_SYMBOL |
| Beacon network currency symbol | - |
|
| v1.0.x+ |
User operations (ERC-4337)
Variable | Type | Description | Compulsoriness | Default value | Example value | Version |
---|---|---|---|---|---|---|
NEXT_PUBLIC_HAS_USER_OPS |
| Set to true to show user operations related data and pages | - | - |
| v1.23.0+ |
Rollup chain
Variable | Type | Description | Compulsoriness | Default value | Example value | Version |
---|---|---|---|---|---|---|
NEXT_PUBLIC_ROLLUP_TYPE |
| Rollup chain type | Required | - |
| v1.24.0+ |
NEXT_PUBLIC_ROLLUP_L1_BASE_URL |
| Blockscout base URL for L1 network | Required | - |
| v1.24.0+ |
NEXT_PUBLIC_ROLLUP_L2_WITHDRAWAL_URL |
| URL for L2 -> L1 withdrawals (Optimistic stack only) | Required for | - |
| v1.24.0+ |
NEXT_PUBLIC_FAULT_PROOF_ENABLED |
| Set to | - | - |
| v1.31.0+ |
NEXT_PUBLIC_HAS_MUD_FRAMEWORK |
| Set to | - | - |
| v1.33.0+ |
NEXT_PUBLIC_ROLLUP_HOMEPAGE_SHOW_LATEST_BLOCKS |
| Set to | - | - |
| v1.36.0+ |
Export data to CSV file
Variable | Type | Description | Compulsoriness | Default value | Example value | Version |
---|---|---|---|---|---|---|
NEXT_PUBLIC_RE_CAPTCHA_V3_APP_SITE_KEY |
| See below | true | - |
| v1.36.0+ |
Google analytics
Variable | Type | Description | Compulsoriness | Default value | Example value | Version |
---|---|---|---|---|---|---|
NEXT_PUBLIC_GOOGLE_ANALYTICS_PROPERTY_ID |
| Property ID for Google Analytics service | true | - |
| v1.0.x+ |
Mixpanel analytics
Variable | Type | Description | Compulsoriness | Default value | Example value | Version |
---|---|---|---|---|---|---|
NEXT_PUBLIC_MIXPANEL_PROJECT_TOKEN |
| Project token for Mixpanel analytics service | true | - |
| v1.1.0+ |
GrowthBook feature flagging and A/B testing
Variable | Type | Description | Compulsoriness | Default value | Example value | Version |
---|---|---|---|---|---|---|
NEXT_PUBLIC_GROWTH_BOOK_CLIENT_KEY |
| Client SDK key for GrowthBook service | true | - |
| v1.22.0+ |
GraphQL API documentation
This feature is always enabled, but you can disable it by passing none
value to NEXT_PUBLIC_GRAPHIQL_TRANSACTION
variable.
Variable | Type | Description | Compulsoriness | Default value | Example value | Version |
---|---|---|---|---|---|---|
NEXT_PUBLIC_GRAPHIQL_TRANSACTION |
| Txn hash for default query at GraphQl playground page. Pass | - | - |
| v1.0.x+ |
REST API documentation
This feature is always enabled, but you can disable it by passing none
value to NEXT_PUBLIC_API_SPEC_URL
variable.
Variable | Type | Description | Compulsoriness | Default value | Example value | Version |
---|---|---|---|---|---|---|
NEXT_PUBLIC_API_SPEC_URL |
| Spec to be displayed on | - |
|
| v1.0.x+ |
Marketplace
Variable | Type | Description | Compulsoriness | Default value | Example value | Version |
---|---|---|---|---|---|---|
NEXT_PUBLIC_MARKETPLACE_ENABLED |
|
| Required | - |
| v1.24.1+ |
NEXT_PUBLIC_MARKETPLACE_CONFIG_URL |
| URL of configuration file ( | Required | - |
| v1.0.x+ |
NEXT_PUBLIC_ADMIN_SERVICE_API_HOST |
| Admin Service API endpoint url. Can be used instead of NEXT_PUBLIC_MARKETPLACE_CONFIG_URL | - | - |
| v1.1.0+ |
NEXT_PUBLIC_MARKETPLACE_SUBMIT_FORM |
| Link to form where authors can submit their dapps to the marketplace | Required | - |
| v1.0.x+ |
NEXT_PUBLIC_MARKETPLACE_SUGGEST_IDEAS_FORM |
| Link to form where users can suggest ideas for the marketplace | - | - |
| v1.24.0+ |
NEXT_PUBLIC_NETWORK_RPC_URL |
| See in Blockchain parameters section | Required | - |
| v1.0.x+ |
NEXT_PUBLIC_MARKETPLACE_CATEGORIES_URL |
| URL of configuration file ( | - | - |
| v1.23.0+ |
NEXT_PUBLIC_MARKETPLACE_SECURITY_REPORTS_URL |
| URL of configuration file ( | - | - |
| v1.28.0+ |
NEXT_PUBLIC_MARKETPLACE_FEATURED_APP |
| ID of the featured application to be displayed on the banner on the Marketplace page | - | - |
| v1.29.0+ |
NEXT_PUBLIC_MARKETPLACE_BANNER_CONTENT_URL |
| URL of the banner HTML content | - | - |
| v1.29.0+ |
NEXT_PUBLIC_MARKETPLACE_BANNER_LINK_URL |
| URL of the page the banner leads to | - | - |
| v1.29.0+ |
NEXT_PUBLIC_MARKETPLACE_RATING_AIRTABLE_API_KEY |
| Airtable API key | - | - | - | v1.33.0+ |
NEXT_PUBLIC_MARKETPLACE_RATING_AIRTABLE_BASE_ID |
| Airtable base ID with dapp ratings | - | - | - | v1.33.0+ |
NEXT_PUBLIC_MARKETPLACE_GRAPH_LINKS_URL |
| URL of the file ( | - | - |
| v1.36.0+ |
Marketplace app configuration properties
Property | Type | Description | Compulsoriness | Example value |
---|---|---|---|---|
id |
| Used as slug for the app. Must be unique in the app list. | Required |
|
external |
|
| - |
|
title |
| Displayed title of the app. | Required |
|
logo |
| URL to logo file. Should be at least 288x288. | Required |
|
shortDescription |
| Displayed only in the app list. | Required |
|
categories |
| Displayed category. | Required |
|
author |
| Displayed author of the app | Required |
|
url |
| URL of the app which will be launched in the iframe. | Required |
|
description |
| Displayed only in the modal dialog with additional info about the app. | Required |
|
site |
| Displayed site link | - |
|
| Displayed twitter link | - |
| |
telegram |
| Displayed telegram link | - |
|
github |
| Displayed github link | - |
|
internalWallet |
|
| - |
|
priority |
| The higher the priority, the higher the app will appear in the list on the Marketplace page. | - |
|
Solidity to UML diagrams
Variable | Type | Description | Compulsoriness | Default value | Example value | Version |
---|---|---|---|---|---|---|
NEXT_PUBLIC_VISUALIZE_API_HOST |
| Visualize API endpoint url | Required | - |
| v1.0.x+ |
NEXT_PUBLIC_VISUALIZE_API_BASE_PATH |
| Base path for Visualize API endpoint url | - | - |
| v1.29.0+ |
Blockchain statistics
Variable | Type | Description | Compulsoriness | Default value | Example value | Version |
---|---|---|---|---|---|---|
NEXT_PUBLIC_STATS_API_HOST |
| Stats API endpoint url | Required | - |
| v1.0.x+ |
NEXT_PUBLIC_STATS_API_BASE_PATH |
| Base path for Stats API endpoint url | - | - |
| v1.29.0+ |
Web3 wallet integration (add token or network to the wallet)
This feature is enabled by default with the ['metamask']
value. To switch it off pass NEXT_PUBLIC_WEB3_WALLETS=none
.
Variable | Type | Description | Compulsoriness | Default value | Example value | Version |
---|---|---|---|---|---|---|
NEXT_PUBLIC_WEB3_WALLETS |
| Array of Web3 wallets which will be used to add tokens or chain to. The first wallet which is enabled in user's browser will be shown. | - |
|
| v1.10.0+ |
NEXT_PUBLIC_WEB3_DISABLE_ADD_TOKEN_TO_WALLET |
| Set to | - | - |
| v1.0.x+ |
Transaction interpretation
Variable | Type | Description | Compulsoriness | Default value | Example value | Version |
---|---|---|---|---|---|---|
NEXT_PUBLIC_TRANSACTION_INTERPRETATION_PROVIDER |
| Transaction interpretation provider that displays human readable transaction description | - |
|
| v1.21.0+ |
Verified tokens info
Variable | Type | Description | Compulsoriness | Default value | Example value | Version |
---|---|---|---|---|---|---|
NEXT_PUBLIC_CONTRACT_INFO_API_HOST |
| Contract Info API endpoint url | Required | - |
| v1.0.x+ |
Name service integration
This feature allows resolving blockchain addresses using human-readable domain names.
Variable | Type | Description | Compulsoriness | Default value | Example value | Version |
---|---|---|---|---|---|---|
NEXT_PUBLIC_NAME_SERVICE_API_HOST |
| Name Service API endpoint url | Required | - |
| v1.22.0+ |
Metadata service integration
This feature allows name tags and other public tags for addresses.
Variable | Type | Description | Compulsoriness | Default value | Example value | Version |
---|---|---|---|---|---|---|
NEXT_PUBLIC_METADATA_SERVICE_API_HOST |
| Metadata Service API endpoint url | Required | - |
| v1.30.0+ |
Public tag submission
This feature allows you to submit an application with a public address tag.
Variable | Type | Description | Compulsoriness | Default value | Example value | Version |
---|---|---|---|---|---|---|
NEXT_PUBLIC_METADATA_SERVICE_API_HOST |
| Metadata Service API endpoint url | Required | - |
| v1.30.0+ |
NEXT_PUBLIC_ADMIN_SERVICE_API_HOST |
| Admin Service API endpoint url | Required | - |
| v1.1.0+ |
Data Availability
This feature enables views related to blob transactions (EIP-4844), such as the Blob Txns tab on the Transactions page and the Blob details page.
Variable | Type | Description | Compulsoriness | Default value | Example value | Version |
---|---|---|---|---|---|---|
NEXT_PUBLIC_DATA_AVAILABILITY_ENABLED |
| Set to true to enable blob transactions views. | Required | - |
| v1.28.0+ |
Bridged tokens
This feature allows users to view tokens that have been bridged from other EVM chains. Additional tab "Bridged" will be added to the tokens page and the link to original token will be displayed on the token page.
Variable | Type | Description | Compulsoriness | Default value | Example value | Version |
---|---|---|---|---|---|---|
NEXT_PUBLIC_BRIDGED_TOKENS_CHAINS |
| Used for displaying filter by the chain from which token where bridged. Also, used for creating links to original tokens in other explorers. | Required | - |
| v1.14.0+ |
NEXT_PUBLIC_BRIDGED_TOKENS_BRIDGES |
| Used for displaying text about bridges types on the tokens page. | Required | - |
| v1.14.0+ |
Bridged token chain configuration properties
Variable | Type | Description | Compulsoriness | Default value | Example value |
---|---|---|---|---|---|
id |
| Base chain id, see https://chainlist.org for the reference | Required | - |
|
title |
| Displayed name of the chain | Required | - |
|
short_title |
| Used for displaying chain name in the list view as tag | Required | - |
|
base_url |
| Base url to original token in base chain explorer | Required | - |
|
Note The url to original token will be constructed as <base_url>/<token_hash>
, e.g https://eth.blockscout.com/token/<token_hash>
Token bridge configuration properties
Variable | Type | Description | Compulsoriness | Default value | Example value |
---|---|---|---|---|---|
type |
| Bridge type; should be matched to | Required | - |
|
title |
| Bridge title | Required | - |
|
short_title |
| Bridge short title for displaying in the tags | Required | - |
|
Safe{Core} address tags
For the smart contract addresses which are Safe{Core} accounts public tag "Multisig: Safe" will be displayed in the address page header alongside to Safe logo.
Variable | Type | Description | Compulsoriness | Default value | Example value | Version |
---|---|---|---|---|---|---|
NEXT_PUBLIC_SAFE_TX_SERVICE_URL |
| The Safe transaction service URL. See full list of supported networks here. | - | - |
| v1.26.0+ |
Address profile API
This feature allows the integration of an external API to fetch user info for addresses or contracts. When configured, if the API returns a username, a public tag with a custom link will be displayed in the address page header.
Variable | Type | Description | Compulsoriness | Default value | Example value | Version |
---|---|---|---|---|---|---|
NEXT_PUBLIC_ADDRESS_USERNAME_TAG |
| Address profile API tag configuration properties. See below. | - | - |
| v1.35.0+ |
Address profile API configuration properties
Variable | Type | Description | Compulsoriness | Default value | Example value |
---|---|---|---|---|---|
api_url_template |
| User profile API URL. Should be a template with | Required | - |
|
tag_link_template |
| External link to the profile. Should be a template with | - | - |
|
tag_icon |
| Public tag icon (.svg) url | - | - |
|
tag_bg_color |
| Public tag background color (escape "#" symbol if you use HEX color codes or use rgba-value instead) | - | - |
|
tag_text_color |
| Public tag text color (escape "#" symbol if you use HEX color codes or use rgba-value instead) | - | - |
|
Address XStar XHS score
This feature allows the integration of an XStar API to fetch XHS score for addresses. When configured, if the API returns a score, a public tag with that score will be displayed in the address page header.
Variable | Type | Description | Compulsoriness | Default value | Example value | Version |
---|---|---|---|---|---|---|
NEXT_PUBLIC_XSTAR_SCORE_URL |
| XStar XHS score documentation URL for the address tag. Enables the XStar score feature. | - | - |
| v1.36.0+ |
SUAVE chain
For blockchains that implement SUAVE architecture additional fields will be shown on the transaction page ("Allowed peekers", "Kettle"). Users also will be able to see the list of all transactions for a particular Kettle in the separate view.
Variable | Type | Description | Compulsoriness | Default value | Example value | Version |
---|---|---|---|---|---|---|
NEXT_PUBLIC_IS_SUAVE_CHAIN |
| Set to true for blockchains with SUAVE architecture | Required | - |
| v1.14.0+ |
MetaSuites extension
Enables MetaSuites browser extension to integrate with the app views.
Variable | Type | Description | Compulsoriness | Default value | Example value | Version |
---|---|---|---|---|---|---|
NEXT_PUBLIC_METASUITES_ENABLED |
| Set to true to enable integration | Required | - |
| v1.26.0+ |
Validators list
The feature enables the Validators page which provides detailed information about the validators of the PoS chains.
Variable | Type | Description | Compulsoriness | Default value | Example value | Version |
---|---|---|---|---|---|---|
NEXT_PUBLIC_VALIDATORS_CHAIN_TYPE |
| Chain type | Required | - |
| v1.25.0+ |
Sentry error monitoring
Variable | Type | Description | Compulsoriness | Default value | Example value | Version |
---|---|---|---|---|---|---|
NEXT_PUBLIC_SENTRY_DSN |
| Client key for your Sentry.io app | Required | - |
| v1.0.x+ |
SENTRY_CSP_REPORT_URI |
| URL for sending CSP-reports to your Sentry.io app | - | - |
| v1.0.x+ |
NEXT_PUBLIC_SENTRY_ENABLE_TRACING |
| Enables tracing and performance monitoring in Sentry.io | - |
|
| v1.17.0+ |
NEXT_PUBLIC_APP_ENV |
| App env (e.g development, review or production). Passed as | - |
|
| v1.0.x+ |
NEXT_PUBLIC_APP_INSTANCE |
| Name of app instance. Used as custom tag | - | - |
| v1.0.x+ |
OpenTelemetry
OpenTelemetry SDK for Node.js app could be enabled by passing OTEL_SDK_ENABLED=true
variable. Configure the OpenTelemetry Protocol Exporter by using the generic environment variables described in the OT docs. Note that this Next.js feature is currently experimental. The Docker image should be built with the NEXT_OPEN_TELEMETRY_ENABLED=true
argument to enable it.
Variable | Type | Description | Compulsoriness | Default value | Example value | Version |
---|---|---|---|---|---|---|
OTEL_SDK_ENABLED |
| Run-time flag to enable the feature | Required |
|
| v1.18.0+ |
DeFi dropdown
If the feature is enabled, a single button or a dropdown (if more than 1 item is provided) will be displayed at the top of the explorer page, which will take a user to the specified application in the marketplace or to an external site.
Variable | Type | Description | Compulsoriness | Default value | Example value | Version |
---|---|---|---|---|---|---|
NEXT_PUBLIC_DEFI_DROPDOWN_ITEMS |
| An array of dropdown items containing the button text, icon name and dappId in DAppscout or an external url | - | - |
| v1.31.0+ |
Multichain balance button
If the feature is enabled, a Multichain balance button will be displayed on the address page, which will take you to the portfolio application in the marketplace or to an external site.
Variable | Type | Description | Compulsoriness | Default value | Example value | Version |
---|---|---|---|---|---|---|
NEXT_PUBLIC_MULTICHAIN_BALANCE_PROVIDER_CONFIG |
| Multichain portfolio application config See below | - | - |
| v1.31.0+ |
Multichain button configuration properties
Variable | Type | Description | Compulsoriness | Default value | Example value |
---|---|---|---|---|---|
name |
| Multichain portfolio application name | Required | - |
|
url_template |
| Url template to the portfolio. Should be a template with | Required | - |
|
dapp_id |
| Set for open a Blockscout dapp page with the portfolio instead of opening external app page | - | - |
|
logo |
| Multichain portfolio application logo (.svg) url | - | - |
|
Get gas button
If the feature is enabled, a Get gas button will be displayed in the top bar, which will take you to the gas refuel application in the marketplace or to an external site.
Variable | Type | Description | Compulsoriness | Default value | Example value | Version |
---|---|---|---|---|---|---|
NEXT_PUBLIC_GAS_REFUEL_PROVIDER_CONFIG |
| Get gas button config. See below | - | - |
| v1.33.0+ |
Get gas button configuration properties
Variable | Type | Description | Compulsoriness | Default value | Example value |
---|---|---|---|---|---|
name |
| Text on the button | Required | - |
|
url_template |
| Url template, may contain | Required | - |
|
dapp_id |
| Set for open a Blockscout dapp page instead of opening external app page | - | - |
|
logo |
| Gas refuel application logo url | - | - |
|
Save on gas with GasHawk
The feature enables a "Save with GasHawk" button next to the "Gas used" value on the address page.
Variable | Type | Description | Compulsoriness | Default value | Example value | Version |
---|---|---|---|---|---|---|
NEXT_PUBLIC_SAVE_ON_GAS_ENABLED |
| Set to "true" to enable the feature | - | - |
| v1.35.0+ |
Rewards service API
This feature enables Blockscout Merits program. It requires that the My account and Blockchain interaction features are also enabled.
Variable | Type | Description | Compulsoriness | Default value | Example value | Version |
---|---|---|---|---|---|---|
NEXT_PUBLIC_REWARDS_SERVICE_API_HOST |
| API URL | - | - |
| v1.36.0+ |
External services configuration
Google ReCaptcha
For obtaining the variables values please refer to reCAPTCHA documentation.
Variable | Type | Description | Compulsoriness | Default value | Example value | Version |
---|---|---|---|---|---|---|
NEXT_PUBLIC_RE_CAPTCHA_V3_APP_SITE_KEY |
| Google reCAPTCHA v3 site key | - | - |
| v1.36.0+ |
NEXT_PUBLIC_RE_CAPTCHA_APP_SITE_KEY |
| DEPRECATED Google reCAPTCHA v2 site key | - | - |
| v1.0.x+ |
Last updated