π΅ **Behavior** = same request, different answer. ## Overview Additional details are included for each item below the table. | # | Surface | Change | Severity | | - | - | - | - | | 1 | REST API | `items_count` is now a page-size request param and is no longer echoed in `next_page_params`; `key`, `sort`, `order`, `state_filter` are no longer echoed either | **π΄ Breaking** | | 2 | REST API | State-changes cursor `state_changes` + `items_count` replaced by `state_changes_count` | **π΄ Breaking** | | 3 | REST API | `limit` query param removed from `/internal-transactions` and `/token-transfers` (422); ignored on `/tokens` | **π΄ Breaking** | | 4 | REST API | `token` object removed from items of `/tokens/{hash}/instances` | **π΄ Breaking** | | 5 | REST API | All `/api/v2/mud/*` endpoints removed | **π΄ Breaking** | | 6 | REST API | Stability validators and zkSync batches endpoints now validate params (422 on unknown/invalid; `state_filter` case-sensitive) | **π΄ Breaking** | | 7 | REST API | `?recaptcha_response=` on NFT `refetch-metadata` now returns 422; send reCAPTCHA via headers | **π΄ Breaking** | | 8 | REST, JSON RPC, GraphQL APIs | Constructor arguments now `0x`-prefixed | **π΄ Breaking** | | 9 | REST API | Search may return `ens_domain` results for bare names; `check-redirect` may redirect on them | π΅ **Behavior** | | 10 | REST API | `tabs-counters` omits chain-specific counters on other chains; token counters honour scam-token toggle | π΅ **Behavior** | | 11 | REST API | `/transactions/{hash}/summary` can return 503 under DB lock contention | π΅ **Behavior** | | 12 | JSON RPC API | `getsourcecode` `ConstructorArguments` gets `0x`; `gettxinfo` `next_page_params` loses `items_count` | **π΄ Breaking** | | 13 | JSON RPC API | Sourcify verification uses Sourcify API v2: `metadata.json` required, blocking poll up to \~60 s, new error strings, different `AdditionalSources[].Filename` | π΅ **Behavior** | | 14 | ETH RPC API | `error` is now a JSON-RPC object `{code, message}` instead of a string; messages reworded | **π΄ Breaking** | | 15 | ETH RPC API | `eth_getLogs` rejects non-`0x` block numbers (-32602) | **π΄ Breaking** | | 16 | ETH RPC API | Operators may disable core proxy methods (`eth_call`, `eth_getCode`, β¦) β -32601 | π΅ **Behavior** (config) | | 17 | ETH RPC API | `GET /api/legacy/logs/get-logs` and `GET /api/legacy/block/eth-block-number` removed; `POST /api/legacy/eth/*` added | **π΄ Breaking** | | 18 | GraphQL API | `token_transfers` hide scam tokens when `HIDE_SCAM_ADDRESSES=true`; opt out with `show-scam-tokens` header or `show_scam_tokens` cookie | π΅ **Behavior** | *** ## REST API ### 1. π΄ Pagination: `items_count` changed meaning, several params no longer echoed * `items_count` was a cursor counter echoed back inside `next_page_params`. It is now a **request parameter that sets the page size** (1 to `MAX_ITEMS_PER_PAGE`, default 100; default page size stays 50). It is **no longer included in `next_page_params`**. * A value above `MAX_ITEMS_PER_PAGE` is **silently clamped** to the maximum; it does not return 422. Only values below 1 are rejected. * `next_page_params` also no longer contains `key` (the API key, to stop leaking secrets) or the atom-keyed `sort`, `order`, `state_filter` values on spec'd endpoints. **Impact** * Clients that follow `next_page_params` verbatim keep working with the default page size, **but only for lists requested without `sort`/`order`**. Sorted lists (address transactions, addresses list, tokens, smart-contracts, validators) must re-send `sort` and `order` on every page, otherwise the next page comes back in the default order and the cursor no longer matches. * Clients that want a custom page size must add `items_count=N` to **every** request, including follow-up pages. * Clients that read `items_count` from `next_page_params` (for progress display, etc.) must stop; use the page length instead. ### 2. π΄ State changes cursor `GET /api/v2/transactions/{hash}/state-changes` `next_page_params` changed from `{"state_changes": null, "items_count": N}` to `{"state_changes_count": N}`. A stored old cursor containing `state_changes` now returns 422. ### 3. π΄`limit` query parameter removed | Endpoint | v11 | v12 | | - | - | - | | `GET /api/v2/internal-transactions?limit=` | clamped page size | **422 Unexpected field** | | `GET /api/v2/token-transfers?limit=` | clamped page size | **422 Unexpected field** | | `GET /api/v2/tokens?limit=` | applied | accepted but ignored | Use `items_count` instead. ### 4. π΄ `token` removed from NFT instance list items Items in `GET /api/v2/tokens/{hash}/instances` (with or without `holder_address_hash`) no longer include the nested `token` object; the token is identified by the URL. The single-instance endpoint `GET /api/v2/tokens/{hash}/instances/{id}` still includes `token`. New fields `image_media_type` and `animation_media_type` were added to instances. ### 5. π΄ MUD endpoints removed All `/api/v2/mud/worldsβ¦` endpoints and the `mud` OpenAPI spec are gone. `MUD_INDEXER_ENABLED`, `MUD_DATABASE_URL`, `MUD_POOL_SIZE` are deprecated. ### 6. π΄ Endpoints newly validated by OpenAPI spec These endpoints now reject unknown or malformed query parameters with **422** instead of ignoring them: * `/api/v2/validators/stability`, `/api/v2/validators/stability/counters` * `state_filter` must match `active|probation|inactive` (comma-separated). It is now **case-sensitive**; `ACTIVE` used to work and now returns 422. * `sort` β `state|address_hash|blocks_validated`, `order` β `asc|desc`. * `/api/v2/zksync/batches`, `/batches/count`, `/batches/{number}`, `/main-page/zksync/batches/confirmed`, `/latest-number`. ### 7. π΄ `recaptcha_response` query parameter removed from NFT metadata refetch `PATCH /api/v2/tokens/{hash}/instances/{id}/refetch-metadata` no longer declares `recaptcha_response` as a query parameter, so `?recaptcha_response=β¦` now returns **422 Unexpected field**. Pass the reCAPTCHA token in the `recaptcha-v2-response` or `recaptcha-v3-response` header instead (both already worked in v11), or use the `recaptcha-bypass-token` header / `scoped_recaptcha_bypass_token` query parameter for trusted clients. ### 8. π΄ Constructor arguments are `0x`-prefixed `constructor_args` in `GET /api/v2/smart-contracts/{hash}` (also `ConstructorArguments` in `?module=contract&action=getsourcecode`, GraphQL `smart_contract.constructor_arguments`, and `/api/v1/verified_smart_contracts`) now returns `0xβ¦` instead of bare hex. Stored values that were not valid hex are cleared to `null` by the migration. On verification input, non-hex constructor arguments are now rejected. ### 9. π΅ Search returns ENS results for bare names BENS lookup used to require a dotted name (`name.eth`). It now runs for any query of 3+ characters, so `/api/v2/search`, `/search/quick` can return `ens_domain` items for `vitalik`, and `/search/check-redirect?q=vitalik` may return `redirect: true` with `type: "ens_domain"` (new enum value). When a query matches both an address and an ENS name, the address still takes priority in `check-redirect`. ### 10. π΅ `tabs-counters` For unknown addresses, `celo_election_rewards_count` and `beacon_deposits_count` are emitted only on Celo / Ethereum chain types respectively (previously on all chains as `0`). Token-related counters now exclude scam tokens unless the `show-scam-tokens` header or the `show_scam_tokens` cookie is set. ### 11. π΅ Transaction summary may return 503 - Behavior `GET /api/v2/transactions/{hash}/summary` returns `503 {"error": "Transaction data is temporarily unavailable"}` when the logs table lock cannot be acquired within `API_OPTIONAL_QUERIES_LOCK_TIMEOUT` (default 100 ms). Retry with backoff. *** ## JSON RPC API (`/api?module=β¦`) ### 12. π΄`getsourcecode` and `gettxinfo` * `ConstructorArguments` is `0x`-prefixed (see item 8). * `gettxinfo` `next_page_params` no longer contains `items_count` (see item 1). ### 13. π΅ Sourcify verification via Sourcify API v2 `?module=contract&action=verify_via_sourcify` and `POST /api/v2/smart-contracts/{hash}/verification/via/sourcify`: * Request parameters and success responses are unchanged. * The uploaded file set **must include a file named `metadata.json`**, otherwise the request fails with `Sourcify did not return metadata`. * Blockscout submits the job and polls Sourcify (`SOURCIFY_POLL_INTERVAL` 3 s Γ `SOURCIFY_POLL_MAX_ATTEMPTS` 20). A synchronous call may block for a minute or more and can end with `Sourcify verification timed out` or `Contract is not verified`. * Upstream error text now comes from Sourcify v2 `message` fields. * `AdditionalSources[].Filename` for contracts verified after the upgrade are relative paths prefixed with `/` rather than absolute repository paths. *** ## ETH RPC API (`/api/eth-rpc`) ### 14. π΄ Error responses follow JSON-RPC 2.0 Before: `{"jsonrpc":"2.0","id":1,"error":"invalid block number"}` After: `{"jsonrpc":"2.0","id":1,"error":{"code":-32602,"message":"Invalid block number"}}` Codes: `-32600` invalid request, `-32601` method not found, `-32602` invalid params, `-32603` internal/upstream error. | Old message | New message | | - | - | | `Action not found.` | `Method not found.` | | `Incorrect number of params.` | `Incorrect number of params` | | `id is a required field` | `Id is a required field` | | `Invalid Block Hash` | `Invalid block hash` | | `invalid block number` | `Invalid block number` | | `Something went wrong.` | `Something went wrong` | A request with `params` but without `jsonrpc` now returns -32600 `Method, and jsonrpc are required parameters.` In batched requests, a JSON-RPC error object returned by the node for an individual proxied request is now passed through as-is (including its optional `data` field) instead of being reported as an internal error. ### 15. π΄`eth_getLogs` block parameters must be hex quantities or tags `"fromBlock": "100"` used to be silently parsed as hex (block 256). It now returns -32602 `Invalid block number`. Use `"0x64"`, `"latest"`, `"earliest"`, `"pending"`. ### 16. π΅ Core proxy methods can be disabled by the operator With `API_ETH_RPC_DISABLE_CORE_PROXY_METHODS=true`, `eth_call`, `eth_getCode`, `eth_getStorageAt`, `eth_sendRawTransaction`, `eth_getBlockByNumber/Hash`, `eth_estimateGas`, `eth_getTransactionCount` return -32601. Default is `false`. `API_ETH_RPC_EXTENDED_PROXY_METHODS_ENABLED=true` (default `false`) adds `net_*`, `web3_*`, `eth_feeHistory`, `eth_getProof`, `eth_getBlockReceipts` and others. ### 17. π΄ `/api/legacy` GET routes removed, dedicated POST routes added | Removed | Replacement | | - | - | | `GET /api/legacy/logs/get-logs` (Etherscan-style `{status, message, result}` envelope) | `POST /api/legacy/eth/eth-get-logs` with a JSON-RPC body; returns a JSON-RPC envelope | | `GET /api/legacy/block/eth-block-number` | `POST /api/legacy/eth/eth-block-number` with a JSON-RPC body | `GET /api/legacy/block/get-block-number-by-time` is unchanged. Also added: `POST /api/legacy/eth/eth-call`, `/eth-get-balance`, `/eth-get-storage-at`, `/eth-send-raw-transaction`. Each of them is a single-method entry point equivalent to the same method on `/api/eth-rpc`, and follows the same availability rules (item 16). *** ## GraphQL API ### 18. π΅ Scam-token filtering `token_transfers` (by token and by address) exclude scam-flagged tokens when the instance runs with `HIDE_SCAM_ADDRESSES=true`. Send the `show-scam-tokens` header or the `show_scam_tokens` cookie to include them. No schema fields were removed or renamed. `constructor_arguments` is `0x`-prefixed (item 8). *** ## π’ Additive changes (no action needed) * `meta: {status: 1|2, message}` on every internal-transactions list response (`status: 2` = some internal transactions still pending). * `include_zero_value` (default `true`) on internal-transactions endpoints. * `decoded.abi` (the matching event ABI item) on log items. * `image_media_type`, `animation_media_type` on token instances; `GET /api/v2/tokens/{hash}/instances/{id}/media-type`. * `POST /api/v2/tokens/batch`; `GET /api/v2/tokens/{hash}/transfers/csv`. * CSV endpoints accept `Accept: text/csv` without a 406; `from_period`/`to_period` optional for address CSV exports. * ENS names and metadata on `from`/`to` in advanced filters and on NFT owners. * `bzz://` metadata URLs resolved via Swarm gateway. * WebSocket `coin_balance` events now carry `transaction_hash` (was always `null`). # API for AI Agents Source: https://docs.blockscout.com/devs/api-for-ai-agents Give AI agents structured onchain data across 100+ EVM chains with Blockscout PRO API and MCP server for decoded transactions and metadata. # Onchain Data via Blockscout PRO API & MCP Give your AI agents access to structured blockchain data across 100+ EVM chains. No custom integration required. ## Why AI Agents Need Blockscout AI agents operating onchain need reliable, structured data β not raw RPC responses they have to parse and interpret. Blockscout PRO API provides decoded transaction data, token metadata, contract context, and enriched address information in a format agents can work with immediately. The Blockscout MCP (Model Context Protocol) server takes this further by providing a standardized interface that LLM-based agents can use natively, with multichain support built in. ## Two Integration Paths ### Path 1: MCP Server (for LLM agents) The Blockscout MCP server gives AI assistants and coding agents direct access to onchain data through a standardized tool interface. [β Blockscout MCP Info](/devs/mcp-server) **Supported platforms:** * Claude Desktop * Claude Code * OpenAI Codex * Google Gemini * Any MCP-compatible agent framework **Setup is copy-paste.** Visit the [Blockscout AI Skills Portal](https://www.blockscout.com/agents) for platform-specific instructions. **Capabilities include:** * Query address balances and transaction history across chains * Inspect smart contract source code and ABIs * Look up token metadata and transfers * Analyze transaction details with decoded input data * Retrieve block information and chain statistics Multichain support is automatic: agents specify a `chain_id` parameter and the MCP server routes to the correct Blockscout instance. ### Path 2: REST API (for custom agent backends) For agents with custom backends or automation pipelines, the PRO API provides direct HTTP access to the same data. One key, one base URL, and a `chain_id` parameter to move between chains: ```python theme={null} import requests API_KEY = "your_blockscout_pro_key" BASE = "https://api.blockscout.com/v2/api" CHAIN_ID = "1" # Ethereum mainnet β swap for any supported chain, e.g. "8453" for Base def get_address_activity(address, chain_id=CHAIN_ID): """Get recent transactions for an address β useful for agent monitoring.""" resp = requests.get(BASE, params={ "chain_id": chain_id, "module": "account", "action": "txlist", "address": address, "sort": "desc", "apikey": API_KEY }) return resp.json()["result"] def get_contract_abi(contract_address, chain_id=CHAIN_ID): """Retrieve ABI for a verified contract β lets agents interact with contracts.""" resp = requests.get(BASE, params={ "chain_id": chain_id, "module": "contract", "action": "getabi", "address": contract_address, "apikey": API_KEY }) return resp.json()["result"] ``` ## Agent Use Cases **Monitoring & Alerting** β Agents that watch wallet activity, contract events, or token flows and trigger actions based on onchain conditions. **Portfolio & Wallet Agents** β Conversational agents that report balances, transaction history, and token holdings across multiple chains. **Contract Analysis** β Agents that inspect verified source code, read contract state, and explain contract behavior to users. **Onchain Research** β Agents that investigate addresses, trace transaction flows, and compile cross-chain activity reports. **DeFi Automation** β Agents that monitor liquidity positions, track gas costs, and execute strategies based on real-time chain data. ## Pricing for Agent Workloads Agents tend to make high-frequency API calls. Blockscout's credit-based pricing is designed for this pattern β you pay for actual usage, not a fixed call count. | Tier | RPS | Monthly Credits | Best For | | - | - | - | - | | Free | 5 | 100K/day | Development & testing | | Builder (\$49/mo) | 15 | 100M | Single-agent production | | Pro (\$199/mo) | 30 | 500M | Multi-agent or high-frequency | | Enterprise | Custom | Custom | Fleet deployments | ## Get Started 1. **For MCP agents:** Visit [blockscout.com/agents](https://www.blockscout.com/agents) and copy the setup instructions for your platform 2. **For custom agents:** Get a free API key at [dev.blockscout.com](https://dev.blockscout.com) 3. **Need help?** Join the [Blockscout Discord](https://discord.gg/blockscout) β the dev team is active and responsive **β [AI Skills Portal](https://www.blockscout.com/agents)** Β· **β [PRO API Portal](https://dev.blockscout.com)** Β· **β [MCP Documentation](/devs/mcp-server)** # Blockscout APIs Source: https://docs.blockscout.com/devs/apis Overview of Blockscout APIs, including the multichain PRO API, REST, JSON-RPC, ETH-compatible RPC, and GraphQL endpoints for EVM chain data. ## Blockscout API Usage
Note: Your old MyAccount API keys and prior routes will not work with the new PRO API. [Get a new key](https://dev.blockscout.com/) and [update your routes](/devs/pro-api).
`{"id": 2, "result": "already_subscribed"}` | | `worker_unavailable` | Upstream connection to this chain is not ready | ### Unsubscribe errors | Error | Description | | - | - | | `not_subscribed` | Not currently subscribed to this topic and chain combination | # Blockscout Software Licence Source: https://docs.blockscout.com/devs/blockscout-license Overview of the source-available licence adopted in Blockscout v11.0.0, covering permitted use for self-hosted explorers, chains, and resellers. Beginning with the [v11.0.0 release](https://github.com/blockscout/blockscout/releases/tag/v11.0.0) Blockscout has adopted a new [source-available licence](https://github.com/blockscout/blockscout/blob/master/LICENSE). The licence continues to allow standalone projects and chains to download, run, and modify Blockscout for free, and self-hosted explorers are unaffected.\ \ **The update only impacts Blockscout resellers who want to resell Blockscout as a paid service** (hosted explorers, managed offerings, RaaS platforms, anything where customers pay another provider for functionality powered by Blockscout). **These projects now need a Commercial Licence**. Any interface built on Blockscout also must show a clear "Powered by Blockscout" credit linking to [blockscout.com](http://blockscout.com). # **Frequently Asked Questions** *Last Updated: April 2026* *Applies to: Blockscout Software Licence v1.0 (April 22 2026)* ## **General Questions** ### **Can I still self-host Blockscout for my own chain?** Yes. The licence grants you the right to download, deploy, use, copy, modify, and create Derivative Works of the Software. If you are running Blockscout as a block explorer for your own chain and not charging others to access it, you do not need a Commercial Licence. ### **Do I need a Commercial Licence if I donβt charge anyone to use the explorer?** No. The Commercial Licence requirement is triggered when you sell, license, monetise, or otherwise make the Software available to a third party in exchange for a fee or other consideration. If you are running Blockscout as a free, public-facing explorer for your own project or chain, the licence covers your use. ### **Can I modify the Blockscout UI or add custom features for my own chain?** Yes. You are free to create Derivative Works (modifications, custom modules, UI changes, etc.) and deploy them on your own chain. The restriction on Derivative Works applies to *distribution* β you may not distribute, sublicense, or offer your modifications to other parties for a fee without a Commercial Licence. Using your modified version on your own chain is permitted. ### **If I modify the Software, do I still need to display the Blockscout attribution?** Yes. Regardless of any modifications you make, the licence requires that any user interface powered by the Software includes clear and prominent attribution to Blockscout. This must include the βBlockscoutβ brand name (e.g., βPowered by Blockscoutβ), a link to [blockscout.com](http://blockscout.com), and any branding or notices provided by Blockscout, matching the format displayed in the footer of [eth.blockscout.com](http://eth.blockscout.com). ### **Can I fork Blockscout and distribute it under a different name?** No. The licence prohibits distributing the Software or Derivative Works under any name or branding that is identical or confusingly similar to Blockscoutβs marks, or that could cause confusion about origin or endorsement. Additionally, distribution of Derivative Works to third parties requires a Commercial Licence, regardless of branding. ### **Does this licence apply to older versions of Blockscout I already have deployed?** No. The licence applies solely to the version of the Software distributed under it. Prior versions (βPrior Softwareβ) released before **April 22, 2026 and** distributed under GPL v3.0 are not affected by this licence. However, any new version you download after the Effective Date will be governed by this licence. ### **What versions are covered under the new licence?** All versions moving forward, starting from backend v11.0+ and frontend v2.8. These versions are effective from April 22, 2026. Versions up to v10.2.0 and frontend v2.7.1 were released under GPL v3.0 and are not affected by this licence.Β ## **Commercial Licence** ### **When do I need a Commercial Licence?** A Commercial Licence is required if you intend to sell, license, monetise, or commercially make the Software available to any third party in exchange for fees or consideration. This includes, but is not limited to: * Hosting Blockscout for third parties as a paid service * Offering the Software on a SaaS, RaaS, or managed-service basis * Bundling Blockscout into a commercial product or platform * Charging for support, consulting, implementation, customisation, or maintenance services that depend on the Software * Distributing Derivative Works to third parties ### **How do I obtain a Commercial Licence?** Contact Blockscout directly at [eaas.blockscout.com/#contact](https://eaas.blockscout.com/?utm_source=multichain-search\&utm_medium=header#contact) to discuss pricing and terms. Any commercial use is unauthorised until a Commercial Licence has been expressly agreed in writing. Blockscout is not obligated to grant a Commercial Licence.Β ## **RaaS Providers** ### **Iβm a RaaS provider and bundle Blockscout as the default explorer for chains I deploy. Do I need a Commercial Licence?** Yes, for backend versions v11.0+ and frontend version v2.8.0+. The licence explicitly covers offerings made on a βhosted, as-a-service, or managed basis.β Providing Blockscout as part of a Rollup-as-a-Service or chain deployment offering requires a Commercial Licence, regardless of whether the explorer is itemised separately or bundled into a broader platform fee. ### **What if I donβt charge separately for the explorer?** A Commercial Licence is still required. The restriction covers direct and indirect monetisation. If the explorer is included as part of a paid chain deployment or platform service, the Software is being made available in exchange for consideration, even if there is no separate line item for the explorer. ### **What if Blockscout is just one component of a larger platform I offer?** A Commercial Licence is still required. The licence applies wherever your product or service βincorporates, uses, depends on, or is materially enabled by the Software.β If Blockscout is a component of your commercial offering, the restriction applies. ### **Can I offer Blockscout to my customers under my own brand?** No. You must maintain the required Blockscout attribution on all user interfaces, and you may not distribute the Software or Derivative Works under branding that is confusingly similar to Blockscoutβs or that could suggest endorsement or affiliation. Your customersβ explorers must display the βPowered by Blockscoutβ attribution. ### **What if my customer self-hosts Blockscout and I only help configure it?** Consulting, implementation, and customisation services that depend on the Software are explicitly listed as uses requiring a Commercial Licence when provided in exchange for fees. If you are being paid to configure, deploy, or maintain Blockscout for a customer, contact us to discuss a Commercial Licence. ### **If I already have chains running Blockscout under the old GPL licence, are those grandfathered?** Prior versions of the Software distributed under the GPL v3.0 are governed by their original licence terms. However, any new version (backend v11.0+ and frontend v2.8.0+) you download or deploy will be subject to this licence. If you update your deployments to a version covered by this licence, the new terms will apply. ### **Why should I upgrade to the new licence if older instances are running well in my RaaS environment?** New Blockscout versions will include new and upgraded features, updated EIP support, and optimisations for speed and storage. Blockscout also provides technical support for newer versions (there is no technical support available for older versions). Blockscout offers no guarantees that previous versions of the software will continue to run properly. ## **Derivative Works** ### **What qualifies as a Derivative Work?** A Derivative Work is any work based on or derived from the Software in which modifications (revisions, additions, deletions, annotations, etc.) constitute an original work of authorship. Works that remain separable from or merely link to the Software are not considered Derivative Works. ### **Can I create and deploy Derivative Works?** Yes, for your own use. You may create Derivative Works and deploy them on your own chain or for your own internal purposes. You do not need a Commercial Licence to run a modified version of Blockscout on your own chain. ### **Can I distribute my Derivative Works to others?** No β not without a Commercial Licence. You may not distribute, sublicense, sell, or make available any Derivative Works to third parties without first obtaining a Commercial Licence from Blockscout. ### **Does Blockscout have rights to my Derivative Works?** Yes. By creating Derivative Works, you grant Blockscout a perpetual, irrevocable, worldwide, royalty-free licence to use, reproduce, modify, incorporate, and otherwise exploit your Derivative Works for any purpose, including to develop, improve, or distribute the Software. ## **Termination and Breach** ### **What happens if I breach the licence?** The licence terminates automatically and immediately upon any breach. There is no cure period. Upon termination, you must cease all use of the Software, delete all copies, and stop distributing any Derivative Works. ### **If my Commercial Licence is terminated, what happens to chains Iβve already deployed?** Upon termination, all rights under both the base licence and any Commercial Licence cease immediately. You must stop using the Software, uninstall it from all systems under your control, and destroy all copies β including copies held by your contractors or service providers. There is no grace period or wind-down provision in the base licence. If continuity is important to your business, we recommend addressing this in your Commercial Licence terms. ## **Legal and Disputes** ### **What law governs this licence?** The licence is governed by the laws of England and Wales. ### **How are disputes resolved?** Parties must first attempt to resolve disputes informally by contacting [community@blockscout.com](mailto:community@blockscout.com). If unresolved after 30 days, disputes are referred to binding arbitration under LCIA Rules in London. Claims may only be brought individually, class or collective actions are not permitted. ### **What is the liability cap?** To the maximum extent permitted by law, Blockscoutβs total liability is capped at the amount you paid under the licence in the 12 months preceding the claim, or USD \$100 if no payments were made. ## **Transition from GPL** ### **Blockscout was previously licensed under the GPL. What changed?** The Blockscout Software Licence replaces the GPL for all new versions of the Software distributed from April 26 onward. The key differences are: * **Commercial use:** The GPL permitted unrestricted commercial use including SaaS and RaaS. The new licence requires a Commercial Licence for commercial or monetised use. * **Distribution of modifications:** Under the GPL, you could distribute modified versions provided you shared the source under the GPL. Under the new licence, distribution of Derivative Works to third parties requires a Commercial Licence. * **Copyleft:** The GPL required derivative works to be licensed under the GPL. The new licence does not impose copyleft, instead, it prohibits third-party distribution entirely without a Commercial Licence. * **Licensor rights:** Under the GPL, the project had no special rights to your modifications. Under the new licence, you grant Blockscout a perpetual, irrevocable licence to use your Derivative Works. * **Attribution:** The GPL required preserving copyright notices. The new licence adds a mandatory, prominent UI attribution requirement (βPowered by Blockscoutβ). * **Termination:** GPL v3 includes a 30-day cure period for breach. The new licence terminates automatically on breach. The Licensor can also terminate at any time at its sole discretion. * **SaaS / RaaS:** The GPL did not restrict RaaS and SaaS resellers. The new licence explicitly closes this by requiring a Commercial Licence for any managed or as-a-service offering. * **Licence updates:** Under the GPL, you could choose which version of the GPL to comply with. Under the new licence, continued use of the Software after a licence update constitutes acceptance of the new terms. ## **Contact** For questions about the licence, Commercial Licence enquiries, or compliance: **Commercial Licence:** [eaas.blockscout.com/#contact](https://eaas.blockscout.com/?utm_source=multichain-search\&utm_medium=header#contact) **General enquiries:** [community@blockscout.com](mailto:community@blockscout.com) # Blockscout SDK Source: https://docs.blockscout.com/devs/blockscout-sdk React SDK for integrating Blockscout transaction notifications and history into dApps with real-time updates and mobile-responsive design.
`action=dailyavgblocksize` | β | β Β (PRO) | Get Daily Average Block Size | | `action=dailyblkcount` | β | β Β (PRO) | Get Daily Block Count and Rewards | | `action=dailyblockrewards` | β | β Β (PRO) | Get Daily Block Rewards | | `action=dailyavgblocktime` | β | β Β (PRO) | Get Daily Average Time for A Block to be Included in the chain | | `action=dailyuncleblkcount` | β | β Β (PRO) | Get Daily Uncle Block Count and Rewards | ### **5. Token Endpoints** ### `module=token` Note other endpoints contain token specific information including `module=stats` and `module=account`. | | Blockscout | Etherscan | Purpose | | :- | :- | :- | :- | | action=getToken | β | β | Get Token Information | | action=getTokenHolders | β | β | Get Token Holders | | action=bridgedtokenlist | β | β | Get Bridged Tokens | | action=tokenholderlist | β | β Β (PRO) | Get Token Holders | | action=tokenholdercount | β | β Β (PRO) | Number of ERC20 token holders | | action=tokeninfo | β | β Β (PRO) | Token project info | ### **6. Logs/Events Endpoints** ### `module=logs` Both Etherscan and Blockscout use the getLogs endpoint which includes enhanced filtering capabilities. * β `action=getLogs` - Get Event Logs by Address/Topics/Block Range ### **7. Proxy/ETH RPC Endpoints** Etherscan uses the Proxy module `module=proxy` to retrieve standard Ethereum JSON-RPC methods. For Blockscout, send post requests to\ **api.blockscout.com/\{chain\_id}/json-rpc** The following methods are supported: * eth\_blockNumber * eth\_getBalance * eth\_getLogs * eth\_gasPrice * eth\_getTransactionByHash * eth\_getTransactionReceipt * eth\_chainId * eth\_maxPriorityFeePerGas * eth\_getTransactionCount * eth\_getCode * eth\_getStorageAt * eth\_estimateGas * eth\_getBlockByNumber * eth\_getBlockByHash * eth\_sendRawTransaction * eth\_call ### **8. Stats/Network Information** ### `module=stats` In addition to these stats, Blockscout provides general chain stats via the [REST API](/devs/apis/rest). | | Blockscout | Etherscan | Purpose | | :- | :- | :- | :- | | tokensupply | β | β | Get Token Information | | ethsupplyexchange | β | β | total supply in Wei from exchange | | ethsupply | β | β | Get total supply in Wei from DB | | ethsupply2 | β | β | Get amount of Ether in circulation, ETH2 Staking rewards, EIP1559 burnt fees, and total withdrawn ETH from the beacon chain | | coinsupply | β | β | Get total coin supply from DB minus burnt number | | ethprice | β | β | Get latest price of native coin in USD and BTC | | coinprice | β | β | Get latest price of native coin in USD and BTC in more general format | | totalfees | β | β | Get total transaction fees in Wei paid by users to validators per day | | chainsize | β | β | Get the size of the Ethereum blockchain, in bytes, over a date range. | | nodecount | β | β (PRO) | Get total number of discoverable Ethereum nodes | | dailytxnfee | β | β (PRO) | Get Daily Network Transaction Fee | | dailynewaddress | β | β (PRO) | Get Daily New Address Count | | dailynetutilization | β | β (PRO) | Get Daily Network Utilization | | dailyavghashrate | β | β (PRO) | Get Daily Average Network Hash Rate | | dailytx | β | β (PRO) | Get Daily Transaction Count | | dailyavgnetdifficulty | β | β (PRO) | Get Daily Average Network Difficulty | | ethdailyprice | β | β (PRO) | Get Ether Historical Price | ### **9. Gas Tracking** **Etherscan Gas Tracker** (`module=gastracker`) * β `action=gasoracle` - Get Gas Oracle * β `action=gasestimate` - Get Gas Estimate **Blockscout** * β Gas information integrated into transaction and block data
Agents visit [https://agents.blockscout.com/](https://agents.blockscout.com/) to access optimized instructions
to
[**https://api.blockscout.com/v2/api?chain\_id=X**](https://api.blockscout.com/v2/api?chain_id=X) * [API Docs](/devs/apis) * [Microservice and related swagger definitions](https://blockscout.github.io/swaggers/) * A **GraphQL** playground is built into the explorer. Explore queries and schemas from the interface by visiting [**https://your-instance-here/graphiql**](https://your-instance-here/graphiql)
`action=dailyavgblocksize` | β | β Β (PRO) | Get Daily Average Block Size | | `action=dailyblkcount` | β | β Β (PRO) | Get Daily Block Count and Rewards | | `action=dailyblockrewards` | β | β Β (PRO) | Get Daily Block Rewards | | `action=dailyavgblocktime` | β | β Β (PRO) | Get Daily Average Time for A Block to be Included in the chain | | `action=dailyuncleblkcount` | β | β Β (PRO) | Get Daily Uncle Block Count and Rewards | ### **5. Token Endpoints** ### `module=token` Note other endpoints contain token specific information including `module=stats` and `module=account`. | | Blockscout | Etherscan | Purpose | | :- | :- | :- | :- | | action=getToken | β | β | Get Token Information | | action=getTokenHolders | β | β | Get Token Holders | | action=bridgedtokenlist | β | β | Get Bridged Tokens | | action=tokenholderlist | β | β Β (PRO) | Get Token Holders | | action=tokenholdercount | β | β Β (PRO) | Number of ERC20 token holders | | action=tokeninfo | β | β Β (PRO) | Token project info | ### **6. Logs/Events Endpoints** ### `module=logs` Both Etherscan and Blockscout use the getLogs endpoint which includes enhanced filtering capabilities. * β `action=getLogs` - Get Event Logs by Address/Topics/Block Range ### **7. Proxy/ETH RPC Endpoints** Etherscan uses the Proxy module `module=proxy` to retrieve standard Ethereum JSON-RPC methods. For Blockscout, send post requests to
**api.blockscout.com/****/json-rpc** The following methods are supported: * eth\_blockNumber * eth\_getBalance * eth\_getLogs * eth\_gasPrice * eth\_getTransactionByHash * eth\_getTransactionReceipt * eth\_chainId * eth\_maxPriorityFeePerGas * eth\_getTransactionCount * eth\_getCode * eth\_getStorageAt * eth\_estimateGas * eth\_getBlockByNumber * eth\_getBlockByHash * eth\_sendRawTransaction * eth\_call ### **8. Stats/Network Information** ### `module=stats` In addition to these stats, Blockscout provides general chain stats via the [REST API](/devs/apis/rest). | | Blockscout | Etherscan | Purpose | | :- | :- | :- | :- | | tokensupply | β | β | Get Token Information | | ethsupplyexchange | β | β | total supply in Wei from exchange | | ethsupply | β | β | Get total supply in Wei from DB | | ethsupply2 | β | β | Get amount of Ether in circulation, ETH2 Staking rewards, EIP1559 burnt fees, and total withdrawn ETH from the beacon chain | | coinsupply | β | β | Get total coin supply from DB minus burnt number | | ethprice | β | β | Get latest price of native coin in USD and BTC | | coinprice | β | β | Get latest price of native coin in USD and BTC in more general format | | totalfees | β | β | Get total transaction fees in Wei paid by users to validators per day | | chainsize | β | β | Get the size of the Ethereum blockchain, in bytes, over a date range. | | nodecount | β | β (PRO) | Get total number of discoverable Ethereum nodes | | dailytxnfee | β | β (PRO) | Get Daily Network Transaction Fee | | dailynewaddress | β | β (PRO) | Get Daily New Address Count | | dailynetutilization | β | β (PRO) | Get Daily Network Utilization | | dailyavghashrate | β | β (PRO) | Get Daily Average Network Hash Rate | | dailytx | β | β (PRO) | Get Daily Transaction Count | | dailyavgnetdifficulty | β | β (PRO) | Get Daily Average Network Difficulty | | ethdailyprice | β | β (PRO) | Get Ether Historical Price | ### **9. Gas Tracking** **Etherscan Gas Tracker** (`module=gastracker`) * β `action=gasoracle` - Get Gas Oracle * β `action=gasestimate` - Get Gas Estimate **Blockscout** * β Gas information integrated into transaction and block data
**Explorer:** [optimism.blockscout.com](https://optimism.blockscout.com)
**PRO API Base:** `https://api.blockscout.com` (use `chain_id=10`)
**API Docs:** [optimism.blockscout.com/api-docs](https://optimism.blockscout.com/api-docs) ## Quick Start ```bash theme={null} # Get ETH balance for an address on Optimism via PRO API curl "https://api.blockscout.com/v2/api?chain_id=10&module=account&action=balance&address=0xYOUR_ADDRESS&apikey=proapi_YOUR_KEY" ``` Get a free API key at [dev.blockscout.com](https://dev.blockscout.com) β required for all PRO API tiers, including free. ## PRO API Routes for Optimism All routes use OP Mainnet's chain ID (`10`): **JSON RPC v2 (Etherscan-compatible):** ```text theme={null} https://api.blockscout.com/v2/api?chain_id=10&module=account&action=txlist&address=0x...&apikey=proapi_xxx ``` **JSON RPC:** ```text theme={null} https://api.blockscout.com/10/api?module=account&action=txlist&address=0x...&apikey=proapi_xxx ``` **REST API:** ```text theme={null} https://api.blockscout.com/10/api/v2/addresses/0x.../transactions?apikey=proapi_xxx ``` **ETH RPC (POST):** ```bash theme={null} curl -H "content-type: application/json" \ -H "authorization: Bearer proapi_xxx" \ -X POST \ --data '{"id":0,"jsonrpc":"2.0","method":"eth_blockNumber","params":[]}' \ https://api.blockscout.com/10/json-rpc ``` ## Available Endpoints ### Etherscan-Compatible Modules All standard modules work identically to Etherscan's interface: * **Account** β Balances, transaction lists, token transfers, internal transactions, ERC-20/721/1155 activity (plus Blockscout extras: `eth_get_balance`, `pendingtxlist`, `tokenbalance`, `tokenlist`) * **Contract** β ABI, source code, verification (plus: `listcontracts`, `getcontractcreation`, Vyper & Sourcify verification) * **Transaction** β Status checks (plus: `gettxinfo`) * **Logs** β Event logs with filtering by address, topics, block range * **Token** β Token metadata, holders * **Stats** β Supply, chain statistics, coin price * **Block** β Block rewards, countdown, block number by time * **Gas Tracker** β Gas oracle, gas estimates ### REST API Blockscout's native REST API provides enriched metadata, decoded transaction data, NFT details, smart contract read/write, and chain health monitoring. **β [Full REST API Reference](https://optimism.blockscout.com/api-docs)** ## Optimism API Pricing | Tier | Rate Limit | Credits | Price | | - | - | - | - | | Free | 5 RPS | 100K/day | \$0 | | Builder | 15 RPS | 100M/mo | \$49/mo | | Pro | 30 RPS | 500M/mo | \$199/mo | | Business | 50 RPS | 3B/mo | \$999/mo | | Enterprise | Custom | Custom | Contact us | One API key covers every Blockscout-supported chain. Build on Optimism today, expand to Base, Arbitrum, Scroll, and 100+ more networks by changing a `chain_id` parameter β no additional setup. ## Migrating from Etherscan's Optimism API? Etherscan requires a paid plan for OP Mainnet API access. Blockscout offers it free. Since both APIs now use a unified multichain format, switching is a base URL and key swap: ```python theme={null} # Before (Etherscan V2 β OP Mainnet requires paid tier) resp = requests.get("https://api.etherscan.io/v2/api", params={ "chainid": 10, "module": "account", "action": "txlist", "address": addr, "apikey": os.environ["ETHERSCAN_KEY"] }) # After (Blockscout PRO API β free tier available) resp = requests.get("https://api.blockscout.com/v2/api", params={ "chain_id": 10, "module": "account", "action": "txlist", "address": addr, "apikey": os.environ["BLOCKSCOUT_KEY"] }) ``` Same structure: `chainid` β `chain_id`, swap the base URL and key. **β [Full Migration Guide](https://docs.blockscout.com/devs/migrate-from-etherscan)** ## What Developers Build on Optimism with Blockscout's API **Superchain Applications** β Optimism's interoperability vision means apps increasingly span multiple OP Stack chains. Blockscout's multichain PRO API is purpose-built for this β one key and a `chain_id` swap queries OP Mainnet, Base, Zora, Ink, Soneium, and every other Superchain network. **Governance & Public Goods Tools** β Optimism's RetroPGF and governance ecosystem generates significant onchain activity. Developers build dashboards, voting tools, and funding trackers that rely on transaction and contract data from the explorer API. **DeFi & Yield Infrastructure** β OP Mainnet hosts major DeFi protocols. API access to contract state, event logs, and token transfers powers analytics dashboards, position monitoring, and automated strategies. **Cross-Chain Debugging** β Blockscout surfaces L1βL2 deposits, withdrawals, and message passing natively, and the PRO API includes OP-specific endpoints (`optimism` module) for rollup-specific data. ## Optimism on Blockscout Blockscout runs alongside Etherscan on OP Mainnet, but with key advantages: free API access on all tiers, plus unique features like Blockscout's DAppscout marketplace, public tagging across chains, and Vera bytecode verification. As the Superchain grows, Blockscout's unified multichain API gives developers a consistent interface across every OP Stack chain. Blockscout also supports native Interop features for the OP Stack, including cross-chain message tracking, relay status, and interop contract data. ## Get Started 1. Get a free API key at [**dev.blockscout.com**](https://dev.blockscout.com) 2. Use `chain_id=10` in your PRO API requests 3. Explore endpoints at [**optimism.blockscout.com/api-docs**](https://optimism.blockscout.com/api-docs) **β [Start Building on Optimism](https://dev.blockscout.com)** Β· **β [PRO API Routes Reference](https://docs.blockscout.com/devs/pro-api-responses-and-routes)** # API Rate Limits Source: https://docs.blockscout.com/rate-limits Rate limits, credit allowances, and per-endpoint credit costs for each Blockscout PRO API plan tier.
**Explorer:** [robinhoodchain.blockscout.com](https://robinhoodchain.blockscout.com)
**PRO API Base:** `https://api.blockscout.com` (use `chainid=4663`)
**API Docs:** [robinhoodchain.blockscout.com/api-docs](https://robinhoodchain.blockscout.com/api-docs) ## Quick Start ```bash theme={null} # Get ETH balance for an address on Robinhood Chain via PRO API curl "https://api.blockscout.com/v2/api?chainid=4663&module=account&action=balance&address=0xYOUR_ADDRESS&apikey=proapi_YOUR_KEY" ``` Get a free API key at [dev.blockscout.com](https://dev.blockscout.com) β required for all PRO API tiers, including free. ### Get the current gas price There is no Robinhood-specific gas endpoint. Use the standard Blockscout gas routes with `chainid=4663`: ```bash theme={null} # Etherscan-compatible gas oracle (module=gastracker) curl "https://api.blockscout.com/v2/api?chainid=4663&module=gastracker&action=gasoracle&apikey=proapi_YOUR_KEY" # REST API network stats β the response includes current gas_prices in Gwei curl "https://api.blockscout.com/4663/api/v2/stats?apikey=proapi_YOUR_KEY" ``` For raw node data, call the ETH RPC endpoint with the `eth_gasPrice` method (see the POST example below). ## PRO API Routes for Robinhood Chain All routes use Robinhood Chain's chain ID (`4663`): **JSON RPC v2 (Etherscan-compatible):** ```text theme={null} https://api.blockscout.com/v2/api?chainid=4663&module=account&action=txlist&address=0x...&apikey=proapi_xxx ``` **JSON RPC:** ```text theme={null} https://api.blockscout.com/4663/api?module=account&action=txlist&address=0x...&apikey=proapi_xxx ``` **REST API:** ```text theme={null} https://api.blockscout.com/4663/api/v2/addresses/0x.../transactions?apikey=proapi_xxx ``` **ETH RPC (POST):** ```bash theme={null} curl -H "content-type: application/json" \ -H "authorization: Bearer proapi_xxx" \ -X POST \ --data '{"id":0,"jsonrpc":"2.0","method":"eth_blockNumber","params":[]}' \ https://api.blockscout.com/4663/json-rpc ``` ## Available Endpoints ### Etherscan-Compatible Modules All standard modules work identically to Etherscan's interface: * **Account** β Balances, transaction lists, token transfers, internal transactions, ERC-20/721/1155 activity (plus Blockscout extras: `eth_get_balance`, `pendingtxlist`, `tokenbalance`, `tokenlist`) * **Contract** β ABI, source code, verification (plus: `listcontracts`, `getcontractcreation`, Vyper & Sourcify verification) * **Transaction** β Status checks (plus: `gettxinfo`) * **Logs** β Event logs with filtering by address, topics, block range * **Token** β Token metadata, holders * **Stats** β Supply, chain statistics, coin price * **Block** β Block rewards, countdown, block number by time * **Gas Tracker** β Gas oracle, gas estimates ### REST API Blockscout's native REST API provides enriched metadata, decoded transaction data, NFT details, smart contract read/write, and chain health monitoring. This is explorer-enriched data, not raw RPC β token metadata, internal transactions, and decoded logs come out of the same endpoints with no extra indexing work on your side. **β [Full REST API Reference](https://robinhoodchain.blockscout.com/api-docs)**
`STATS__FORCE_UPDATE_ON_START=true` env variable once indexing is finished to perform a full update of all charts. ## How to run Options including docker, docker-compose or building from source. -> [https://github.com/blockscout/blockscout-rs/tree/main/stats#build](https://github.com/blockscout/blockscout-rs/tree/main/stats#build) ## Configs * Env variables [https://github.com/blockscout/blockscout-rs/tree/main/stats#env](https://github.com/blockscout/blockscout-rs/tree/main/stats#env) * .env example: [https://github.com/blockscout/blockscout/blob/master/docker-compose/envs/common-stats.env](https://github.com/blockscout/blockscout/blob/master/docker-compose/envs/common-stats.env) ## Chart Types Two types of charts are available for the Charts and Stats Section, `Line` charts and `Counter` charts. ### Line Charts Example line chart where the X axis is date, and the Y axis is some data.
(`org=eth`, `netname=mainnet`) * **Ethereum Classic mainnet:** `https://blockscout.com/etc/mainnet`
(`org=etc`, `netname=mainnet`) * **Kovan testnet:** `https://blockscout.com/eth/kovan`
(`org=eth`, `netname=kovan`) ### 1. Add a new `org` for your blockscout instance's url 1\) Add a new `acl` under the #**Check for network type** section in the cfg file. ```bash theme={null} #Check for network type ... acl is_myorg path_beg -i /myorg ``` 2\) Add a corresponding exception `!is_myorg` to the **#default redirect** section ```swift theme={null} # default redirect redirect prefix /poa/xdai if !is_websocket !is_poa !is_etc !is_eth !is_lukso !is_rsk !is_myorg !is_cookie ``` 3\) add `!is_myorg` to **every line** in the **#redirect for networks** section ```swift theme={null} #redirect for networks redirect prefix /poa/core if !is_websocket !is_poa !is_etc !is_eth !is_lukso !is_rsk !is_myorg is_cookie_core redirect prefix /poa/sokol if !is_websocket !is_poa !is_etc !is_eth !is_lukso !is_rsk !is_myorg is_cookie_sokol # do this for every line ... ``` ### 2. Add a new acl with your netname In the **#Check for network name** section add a new `acl` with your `netname` similar to existing ones ```bash theme={null} #Check for network name ... acl is_mynet path_beg -i /myorg/mynet ``` ### 3. Set the cookie and name of rpc/websockets servers ```csharp theme={null} #Check for cookies ... acl is_cookie_mynet hdr_sub(cookie) network=mynet #Default backends ... use_backend mynet if is_mynet #WebSocket backends ... use_backend mynet_ws if is_cookie_mynet is_websocket ``` ### 4. Add new backend sections to the end of the file Add new `backend_mynet` and `backend_mynet_ws` sections to the end of the file and provide dns names of your BlockScout instances. **For example:** ```php theme={null} backend mynet #Proxy mode mode http #Backend queries should not have network prefix, so we delete it acl is_mynet path_beg /myorg/mynet reqirep ^([^\ ].*)myorg/mynet[/]?(.*) \1\2 if is_mynet #Setting headers to mask our query http-request set-header X-Forwarded-Host %[req.hdr(Host)] http-request set-header X-Client-IP %[src] http-request set-header Host my-blockscout-instance.com #Specifying cookie to insert cookie network insert #Server list. Format: #server
`sudo systemctl stop blockscout.service` 2. Navigate to `blockscout/apps/block_scout_web/assets/css/theme`. 3. Edit `_poa_variables.scss` with appropriate theme colors. 4. Rebuild the static assets: `sudo npm run-script deploy` (from blockscout/apps/block\_scout\_web/assets directory). 5. Restart the BlockScout service:
`sudo systemctl start blockscout.service` The BlockScout application will now be running with the designated theme changes. # Install Blockscout from AWS Marketplace Listing Source: https://docs.blockscout.com/setup/deployment/ansible-deployment/aws-marketplace/install-from-aws-marketplace Step-by-step guide to launching Blockscout from the AWS Marketplace using CloudFormation, including stack parameters, Cognito login, and DNS setup.
`git clone https://github.com/poanetwork/blockscout` 2. Zip the folder 3. Copy the zip archive to the same root application folder where the current instance resides (this should be standard based on marketplace installation) 4. Access the command line and stop the BlockScout service
`sudo systemctl stop blockscout.service` 5. Follow the [manual deployment instructions](/setup/deployment/manual-old-ui) starting with step 2. 6. If required, migrate the previous database following the [AWS RDS migration](https://console.aws.amazon.com/dms/) instructions. # AWS Permissions and Settings for Blockscout Deploy Source: https://docs.blockscout.com/setup/deployment/ansible-deployment/aws-permissions AWS permissions, IAM keys, and resources created for Blockscout Terraform and Ansible deployments, including VPC, ALB, ASG, and CodeDeploy setup. During deployment you will provide credentials to your AWS account. Given the large number of services involved, and the unpredictability of which specific API calls will be needed during provisioning, it is recommended you provide a user account with full access. You do not need to keep this user around (or enabled) except during the initial provisioning, and for any subsequent runs to update the infrastructure. You may need to reference these items during deployment: * [Creating a Secret Key Pair in AWS](/setup/deployment/ansible-deployment/aws-permissions/creating-a-secret-key-pair) * [Logging in with AWS CLI](/setup/deployment/ansible-deployment/aws-permissions/login-with-aws-cli) * [Creating an SSL certificate](/setup/deployment/ansible-deployment/aws-permissions/creating-an-aws-certificate-for-ssl) * [Manually clean resources (if deployment fails or you need to remove items)](/setup/deployment/ansible-deployment/aws-permissions/manually-cleaning-terraform-related-instances) ### Resources Created During Deployment If you do want to restrict the permissions, the following list of resources is created during the deployment process: * An S3 bucket to keep Terraform state files; * DynamoDB table to manage Terraform state files leases; * An SSH keypair (or you can choose to use one which was already created), this is used with any EC2 hosts; * A VPC containing all of the resources provisioned; * A public subnet for the app servers, and a private subnet for the database (and Redis for now); * An internet gateway to provide internet access for the VPC; * An ALB which exposes the app server HTTPS endpoints to the world; * A security group to lock down ingress to the app servers to 80/443 + SSH; * A security group to allow the ALB to talk to the app servers; * A security group to allow the app servers access to the database; * An internal DNS zone; * A DNS record for the database; * An autoscaling group and launch configuration for each chain; * A CodeDeploy application and deployment group targeting the corresponding autoscaling groups. Each configured chain receives its own ASG (autoscaling group) and deployment group. When application updates are pushed to CodeDeploy, all autoscaling groups will deploy the new version using a blue/green strategy. Currently, there is only one EC2 host to run, and the ASG is configured to allow scaling up, but no triggers are set up to actually perform the scaling yet. This is something that may come in the future. When deployment begins, Ansible creates the S3 bucket and DynamoDB table required for Terraform state management. This ensures that the Terraform state is stored in a centralized location, allowing multiple people to use Terraform on the same infra without interfering with one another. Terraform prevents interference by holding locks (via DynamoDB) against the state data (stored in S3).
Example:
Real resource: tf-poa
`prefix` variable: tf
`chain_db_id` variable: poa 3. Make sure MultiAZ is disabled on your database. 4. Make sure that all the variables at `group_vars/all.yml` are exactly the same as your existing DB. ## Using AWS CodeDeploy to Monitor and manage a BlockScout deployment BlockScout deployment can be managed through the AWS console. [A brief tutorial is available on our forum](https://forum.poa.network/t/monitor-and-manage-a-blockscout-deployment-using-codedeploy-in-your-aws-console/2499). # Ansible Deployment Common Errors and FAQ Source: https://docs.blockscout.com/setup/deployment/ansible-deployment/common-errors-and-questions Troubleshoot common Ansible and Terraform deployment errors for Blockscout including S3 403 errors, plan diffs, and other provisioning issues. ## S3: 403 error during provisioning This usually appears if the S3 bucket already exists. Remember, the S3 bucket has a unique global name. Login to your AWS console and create an S3 bucket with the same name you specified in the `bucket` variable to ensure they match. ## Error Applying Plan (diffs didn't match) If you see something similar to the following: ```swift theme={null} Error: Error applying plan: 1 error(s) occurred: * module.stack.aws_autoscaling_group.explorer: aws_autoscaling_group.explorer: diffs didn't match during apply. This is a bug with Terraform and should be reported as a GitHub Issue. Please include the following information in your report: Terraform Version: 0.11.11 Resource ID: aws_autoscaling_group.explorer Mismatch reason: attribute mismatch: availability_zones.1252502072 ``` This is due to a bug in Terraform, the fix is to run `ansible-playbook deploy_infra.yml` again, and Terraform will pick up where it left off. This does not always happen, but this is the current workaround if needed. ## Server doesn't start during deployment Even if the server is configured correctly, sometimes it may not bind the appropriate 4000 port for unknown reasons. If so, simply go to the appropriate nested blockscout folder, kill and rerun the server. For example, you can use the following command: `pkill beam.smp && pkill node && sleep 10 && mix phx.server`. # Deploy Blockscout Application with Ansible Source: https://docs.blockscout.com/setup/deployment/ansible-deployment/deploying-blockscout Step-by-step Ansible playbook instructions for deploying the Blockscout application to AWS after provisioning the infrastructure with Terraform.
`automake \`
`libtool inotify-tools \`
`libgmp-dev \`
`libgmp10 \`
`build-essential \`
`cmake -y` ### 2. Install ASDF 1. Clone ASDF Plugin > git clone [https://github.com/asdf-vm/asdf.git](https://github.com/asdf-vm/asdf.git) \~/.asdf 2. Edit your ubuntu profile > nano .profile 3. add this line in end break > . \$HOME/.asdf/asdf.sh and ctrl + x (or Save) 4. Refresh your profile after the update > source \~/.profile 5. Test active asdf after refresh > asdf version > > v0.13.1-fad23bc
**Note**: Response following successful install 6. Add asdf plugin for erlang, elixir, and nodejs > asdf plugin add erlang > > asdf plugin add elixir > > asdf plugin add nodejs 7. install additional prerequisites > sudo apt-get -y install build-essential autoconf m4 libncurses5-dev libwxgtk3.0-gtk3-dev libwxgtk-webview3.0-gtk3-dev libgl1-mesa-dev libglu1-mesa-dev libpng-dev libssh-dev unixodbc-dev xsltproc fop libxml2-utils libncurses-dev openjdk-11-jdk ### 3. Install PostgreSQL-14 1. `curl -fsSL https://www.postgresql.org/media/keys/ACCC4CF8.asc|sudo gpg --dearmor -o /etc/apt/trusted.gpg.d/postgresql.gpg` 2. `sudo sh -c 'echo "deb http://apt.postgresql.org/pub/repos/apt $(lsb_release -cs)-pgdg main" > /etc/apt/sources.list.d/pgdg.list'` 3. `sudo apt update` 4. `sudo apt install postgresql-14` 5. `sudo systemctl status postgresql` ### 4. Add user and database in postgres-14 1. Create user on localpc or server > adduser dbusername
**Note:** Replace dbusername with your username. 2. You will be prompted to create a new profile, just follow the flow. 3. After Adduser now connect to postgres-14 > su - postgres (for Root) or sudo -i -u postgres (for user) 4. Display when entering postgres user section looks like this in terminal > postgres\@ubuntu:\~\$ 5. Create user > createuser --interactive dbusername 6. Create database > createdb blockscout 7. connect to psql > psql 8. Create Password database in dbusername Note > ALTER USER dbusername WITH PASSWORD 'dbuserpassword';
**Note**: Replace dbusername and dbuserpassword that you created 9. Create Privileges on dbusername to database > GRANT ALL PRIVILEGES ON DATABASE blockscout TO dbusername; > > **Note:** Replace dbusername 10. exit psql > \q 11. Exit to profile postgresql > postgres\@ubuntu:\~\$ exit 12. Restart postgresql > sudo systemctl restart postgresql 13. Check new profile that you created at start of adduser replacing dbusername with your username. > su - dbusername (for Root) or sudo su - dbusername (for user)
**Note**: Replace your dbusername 14. Run this command > psql -d blockscout 15. If everything is correct, you will see this response > blockscout=# 16. Quit psql > \q 17. Exit for Database Account page > dbusername\@ubuntu:\~\$ exit ### 5. Install Rustup / Cargo After Setup Database, You can Install Rust before installing Blockscout ```sh theme={null} curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh ``` ### 6. After installing everything, clone the Blockscout repository and install .tool-version from the repository 1. Clone Repository Blockscout > git clone [https://github.com/blockscout/blockscout](https://github.com/blockscout/blockscout) blockscout-backend 2. Enter to folder clone blockscout > cd blockscout-backend 3. Install plugin requirements Erlang, Elixir, and Nodejs before install blockscout backend > asdf install
`export SECRET_KEY_BASE=VTIB3uHDNbvrY0+60ZWgUoUBKDn9ppLR8MI4CpRz4/qLyEFs54ktJfaNT6Z221No`
Version: All
Default: `geth`
Applications: API, Indexer | | `ETHEREUM_JSONRPC_HTTP_URL` | The RPC endpoint used to fetch blocks, transactions, receipts, tokens. | Required: β
Version: All
Default: `localhost:8545`
Applications: API, Indexer | | `DATABASE_URL` | Defines the Postgres Database endpoint. | Required: β
Version: All
Default: (empty)
Applications: API, Indexer | | `SECRET_KEY_BASE` | The value used to [sign cookies](https://hexdocs.pm/plug/Plug.Session.COOKIE.html). Use mix phx.gen.secret to generate a new Secret Key Base string to protect production assets. | Required: β
Version: All
Default: (empty)
Applications: API | ## General Management | Variable | Description | Parameters | | - | - | - | | `APPLICATION_MODE` | Defines the current application mode. Available values are: `all`, `indexer`, `api`. Implemented in [#10631](https://github.com/blockscout/blockscout/pull/10631). | Version: v6.8.0+
Default: `all`
Applications: API, Indexer | | `DISABLE_FILE_LOGGING` | Disables file-based logging when set to `true`. When enabled, application logs will only be written to stdout/stderr. | Version: v9.1.0+
Default: `false`
Applications: API, Indexer | | `SECRET_KEY_BASE` | The value used to [sign cookies](https://hexdocs.pm/plug/Plug.Session.COOKIE.html). Use mix phx.gen.secret to generate a new Secret Key Base string to protect production assets. | Required: β
Version: All
Default: (empty)
Applications: API | | `NETWORK_PATH` | Used to set a network path other than what is displayed in the root directory. An example would be to add `/eth/mainnet/` to the root directory. | Version: All
Default: `/`
Applications: API | | `BLOCKSCOUT_HOST` | Host for API endpoint examples. | Version: v2.1.0+
Default: `localhost`
Applications: API | | `BLOCKSCOUT_PROTOCOL` | Url scheme for blockscout. | Version: v2.1.0+
Default: prod env `https`, dev env `http`
Applications: API | | `CHECK_ORIGIN` | Used to check the origin of requests when the origin header is present. It defaults to `false`. In case of true, it will check against the host value. | Version: All
Default: `false`
Applications: API | | `PORT` | Default port the application runs on is 4000. | Version: All
Default: `4000`
Applications: API | | `COIN` | Coin is checked via the CoinGecko API to obtain USD prices on graphs and other areas of the UI. | Version: All
Default: `POA`
Applications: API, Indexer | | `COIN_NAME` | Displayed name of the coin. Also used for "Add chain to MetaMask" button and for Account functionality as native coin name in the email letters for watch list. | Version: v4.1.2+
Default: (empty)
Applications: API | | `EMISSION_FORMAT` | Should be set to `POA` if you have block emission identical to POA Network. This env var is used only if `CHAIN_SPEC_PATH` is set. | Version: v2.0.4+
Default: `DEFAULT`
Applications: API, Indexer | | `CHAIN_SPEC_PATH` | Chain specification path (absolute file system path or URL) to import block emission reward ranges and genesis account balances from. Geth- and OpenEthereum-style specs are supported. | Version: v2.0.4+
Default: (empty)
Applications: API, Indexer | | `CHAIN_SPEC_PROCESSING_DELAY` | Chain specification path processing delay. [Time format](/setup/env-variables/backend-env-variables#time-format). Implemented in [#11874](https://github.com/blockscout/blockscout/pull/11874). | Version: v7.0.0+
Default: 15s
Applications: API, Indexer | | `PRECOMPILED_CONTRACTS_CONFIG_PATH` | Precompiled contracts description path (absolute file system path or URL) to import ABI and source code of the precompiled contracts. | Version: v6.5.0+
Default: (empty) or `/app/config/assets/precompiles-arbitrum.json` for `arbitrum` chaintype
Applications: API, Indexer | | `SUPPLY_MODULE` | Used by RSK in order to tell the application how to calculate the total supply of the chain. Available value is `RSK` | Version: All
Default: (empty)
Applications: API, Indexer | | `HEART_BEAT_TIMEOUT` | Production environment variable to restart the application in the event of a crash. | Version: All
Default: `30`
Applications: API, Indexer | | `HEART_COMMAND` | Production environment variable to restart the application in the event of a crash. | Version: All
Default: (empty)
Applications: API, Indexer | | `ELIXIR_VERSION` | Elixir version to install on the node before Blockscout deploy. It is used in bash script in Terraform / Ansible deployment script | Version: All
Default: (empty)
Applications: API, Indexer | | `DISABLE_WEBAPP` | If `true` endpoints to webapp are hidden. Also, enabling it makes notifications go through `db_notify` | Needs Recompile: βοΈ Version: v2.0.3+
Default: `false`
Applications: API, Indexer | | `DISABLE_BLOCK_BROADCAST_ENRICHMENT` | If `true`, disables ENS and metadata enrichment for `new_block` WebSocket broadcasts. Implemented in [#12074](https://github.com/blockscout/blockscout/pull/12074). | Version: v11.0.0+
Default: (empty)
Applications: API | | `API_V1_READ_METHODS_DISABLED` | If `true`, read-only endpoints to API v1 are hidden. | Needs Recompile: βοΈ Version: v5.1.5+
Default: `false`
Applications: API | | `API_V1_WRITE_METHODS_DISABLED` | If `true`, write endpoints to API v1 are hidden. | Needs Recompile: βοΈ Version: v5.1.5+
Default: `false`
Applications: API | | `DISABLE_API` | If `true`, endpoint is not started. Set this if you want to use an indexer-only setup. Implemented in [#10032](https://github.com/blockscout/blockscout/pull/10032) | Version: v6.6.0+
Default: `false`
Applications: API, Indexer | | `WEBAPP_URL` | Link to web application instance, e.g. `protocol://host/path` | Version: v2.0.3+
Default: (empty)
Applications: API | | `API_URL` | Link to API instance, e.g. `protocol://host/path` | Version: v2.0.3+
Default: (empty)
Applications: API | | `API_V2_ENABLED` | Enable API V2. Implemented in [#6361](https://github.com/blockscout/blockscout/pull/6361) (v5.0.0+), default `true` since [#8802](https://github.com/blockscout/blockscout/pull/8802) | Version: v5.3.2+
Default: `true`
Applications: API | | `API_ETH_RPC_EXTENDED_PROXY_METHODS_ENABLED` | Enables extended proxy method support for API ETH RPC. Added for the `v12.0.0` release and disabled by default for backward compatibility. | Version: v12.0.0+
Default: `false`
Applications: API | | `API_ETH_RPC_DISABLE_CORE_PROXY_METHODS` | If `true`, disables core proxy methods (e.g. `eth_getCode`, `eth_getTransactionCount`, `eth_call`, etc.) in the API ETH RPC JSON-RPC method set. Extended proxy methods controlled by `API_ETH_RPC_EXTENDED_PROXY_METHODS_ENABLED` are unaffected. Implemented in [#14495](https://github.com/blockscout/blockscout/pull/14495). | Version: v12.0.0+
Default: `false`
Applications: API | | `API_SENSITIVE_ENDPOINTS_KEY` | API key to protect some sensitive endpoints. Implemented in [#7355](https://github.com/blockscout/blockscout/pull/7355) | Version: v5.1.5+
Default: (empty)
Applications: API | | `CHECKSUM_ADDRESS_HASHES` | If set to `true`, redirects to checksummed version of address hashes. | Version: v3.1.0+
Default: `true`
Applications: API | | `CHECKSUM_FUNCTION` | Defines checksum address function. 2 available values: `rsk`, `eth` | Version: v2.0.1+
Default: `eth`
Applications: API | | `CHAIN_TYPE` | Specifies the blockchain architecture and enables chain-specific data models and fetchers. | Runtime configurable (v8.0.0+): `neon`, `stability`, `blackfort`, `shibarium`, `arc`
Needs recompilation: `ethereum`, `optimism`, `arbitrum`, `optimism-celo` (formerly `celo` before v9.3.0), `rsk`, `suave`, `zetachain`, `filecoin`, `zilliqa`, `eden`, and other values prior to v8.0.0
Version: v5.3.0+
Default: `default`
Applications: API, Indexer | | `CHAIN_ID` | Chain ID of the network. For instance, 100 in the case of Gnosis chain. | Version: v3.7.0+
Default: (empty)
Applications: API, Indexer | | `HEALTH_MONITOR_CHECK_INTERVAL` | Interval between health stats collection. [Time format](/setup/env-variables/backend-env-variables#time-format). Implemented in [#11888](https://github.com/blockscout/blockscout/pull/11888/) | Version: v8.0.0+
Default: `1m`
Applications: API, Indexer | | `HEALTH_MONITOR_BLOCKS_PERIOD` | New blocks indexed max delay in /health API endpoint. [Time format](/setup/env-variables/backend-env-variables#time-format). Implemented in [#11888](https://github.com/blockscout/blockscout/pull/11888/) | Version: v8.0.0+
Default: `5m`
Applications: API, Indexer | | `HEALTH_MONITOR_BATCHES_PERIOD` | New batches indexed max delay in /health API endpoint. [Time format](/setup/env-variables/backend-env-variables#time-format). Implemented in [#11888](https://github.com/blockscout/blockscout/pull/11888/) | Version: v8.0.0+
Default: `4h`
Applications: API, Indexer | | `HEALTH_MONITOR_DEPOSITS_PERIOD` | New deposits indexed max delay in /health API endpoint. [Time format](/setup/env-variables/backend-env-variables#time-format). Implemented in [#14632](https://github.com/blockscout/blockscout/pull/14632). | Version: v11.2.4+
Default: `4h`
Applications: API, Indexer | | `HEALTH_MONITOR_WITHDRAWALS_PERIOD` | New withdrawals indexed max delay in /health API endpoint. [Time format](/setup/env-variables/backend-env-variables#time-format). Implemented in [#14632](https://github.com/blockscout/blockscout/pull/14632). | Version: v11.2.4+
Default: `4h`
Applications: API, Indexer | | `NEW_TAGS` | Add public tag labels. More info in [#6316](https://github.com/blockscout/blockscout/pull/6316) | Version: v5.0.0+
Default: (empty)
Applications: API | | `CUSTOM_CONTRACT_ADDRESSES_${tag_name}` | Specify addresses for some label. More info in [#6316](https://github.com/blockscout/blockscout/pull/6316) | Version: v5.0.0+
Default: (empty)
Applications: API | | `SESSION_COOKIE_DOMAIN` | Value of this env will be added to domain of session cookie. Implemented in [#6544](https://github.com/blockscout/blockscout/pull/6544) | Needs Recompile: βοΈ
Version: v5.0.0+
Default: (empty)
Applications: API | | `DECODE_NOT_A_CONTRACT_CALLS` | Allows decoding of contract calls directed to addresses which are not contracts. Implemented in [#6541](https://github.com/blockscout/blockscout/pull/6541) | Needs Recompile: βοΈ
Version: v5.1.0+
Default: `false`
Applications: API | | `EIP_1559_ELASTICITY_MULTIPLIER` | EIP-1559 elasticity multiplier. See also `INDEXER_OPTIMISM_L2_HOLOCENE_TIMESTAMP`. Implemented in [#7253](https://github.com/blockscout/blockscout/pull/7253) | Version: v5.1.3+
Default: `2`
Applications: API | | `EIP_1559_BASE_FEE_MAX_CHANGE_DENOMINATOR` | EIP-1559 base fee max change denominator. See also `INDEXER_OPTIMISM_L2_HOLOCENE_TIMESTAMP`. Implemented in [#9202](https://github.com/blockscout/blockscout/pull/9202) | Version: v6.2.0+
Default: `8`
Applications: API | | `EIP_1559_BASE_FEE_LOWER_BOUND_WEI` | Minimum boundary for base fee calculation in `wei`. Implemented in [#12370](https://github.com/blockscout/blockscout/pull/12370). | Version: v8.1.0+
Default: `0`
Applications: API | | `BLOCK_MINER_GETS_BURNT_FEES` | If `true`, the Burnt fees are added to block miner profit and displayed in UI as zero. Implemented in [#13894](https://github.com/blockscout/blockscout/pull/13894). | Version: v10.0.0+
Default: `false`
Applications: API | | `ADDRESSES_TABS_COUNTERS_TTL` | TTL for cached tabs counters (works only for counters which are \< 51, if counter >= 51, then ttl == :infinity). Implemented in [#8512](https://github.com/blockscout/blockscout/pull/8512) | Version: v5.3.0+
Default: `10m`
Applications: API | | `API_INTERNAL_TRANSACTIONS_INDEXING_FINISHED_THRESHOLD` | In the case when the 1st tx in the chain already has internal transactions, if the number of blocks in `pending_block_operations` is less than the value in this env var, Blockscout will consider that indexing of internal transactions is finished, otherwise, it will consider that indexing is still taking place and the indexing banner will appear at the top. Implemented in [#7576](https://github.com/blockscout/blockscout/pull/7576). | Version: v5.2.0+
Default: `1000`
Applications: API | | `API_INTERNAL_TRANSACTIONS_PENDING_HEAD_TOLERANCE` | Number of most recent blocks whose internal transactions may still be pending without API endpoints returning internal transactions marking the response as pending (`status: "2"`), for requests whose range reaches the chain head (no `endblock`, or `endblock` at or above the latest block). Requests with `endblock` below the head, empty results, and requests by `txhash` keep the strict check. Set to `0` to disable the tolerance. Implemented in [#14866](https://github.com/blockscout/blockscout/pull/14866). | Version: v11.3.3+
Default: `200`
Applications: API | | `API_OPTIONAL_QUERIES_LOCK_TIMEOUT` | Maximum time optional API queries wait for a PostgreSQL table lock before failing fast and returning a degraded response. Implemented in [#14848](https://github.com/blockscout/blockscout/pull/14848). | Version: v12.0.0+
Default: `100ms`
Applications: API | | `API_DISABLE_CONTRACT_CREATION_INTERNAL_TRANSACTION_ASSOCIATION` | Disables association of internal transaction for finding contract creation transaction. Implemented in [#14090](https://github.com/blockscout/blockscout/pull/14090). | Version: v10.0.3+, v9.3.7+
Default: (empty)
Applications: API | | `SHRINK_INTERNAL_TRANSACTIONS_ENABLED` | Variable to enable internal transactions shrinking logic. Implemented in [#10567](https://github.com/blockscout/blockscout/pull/10567). | Version: v6.8.0+
Default: `false`
Applications: API, Indexer | | `HACKNEY_DEFAULT_POOL_SIZE` | Size of `default` hackney pool. Implemented in [#12406](https://github.com/blockscout/blockscout/pull/12406). | Version: v8.1.0+
Default: `1000`
Applications: API, Indexer | | `UNIVERSAL_PROXY_CONFIG_URL` | Config URL for universal proxy. Implemented in [#12442](https://github.com/blockscout/blockscout/pull/12442). | Version: v8.1.0+
Default: `https://raw.githubusercontent.com/blockscout/backend-configs/refs/heads/main/universal-proxy-config.json`
Applications: API | | `UNIVERSAL_PROXY_CONFIG` | JSON-encoded configuration string used to define settings for the universal proxy. Implemented in [#13787](https://github.com/blockscout/blockscout/pull/13787). | Version: v10.0.0+
Default: (empty)
Applications: API | | `K8S_SERVICE` | Kubernetes service name for Elixir nodes clusterization, more info on how to configure it can be found here [https://hexdocs.pm/libcluster/Cluster.Strategy.Kubernetes.DNS.html](https://hexdocs.pm/libcluster/Cluster.Strategy.Kubernetes.DNS.html). Implemented in [#13080](https://github.com/blockscout/blockscout/pull/13080). | Version: v9.2.0+
Default: (empty)
Applications: API, Indexer | | `MAX_ITEMS_PER_PAGE` | Maximum size of the page returned by the API, in other words, the maximum allowed value for `items_count` query param. Implemented in [#14244](https://github.com/blockscout/blockscout/pull/14244). | Version: v12.0.0+
Default: `100`
Applications: API | | `BLOCK_BROADCAST_TYPE` | Type of data sent in new block socket events. May be `block` for full block data or `count` for new blocks count. Implemented in [#14571](https://github.com/blockscout/blockscout/pull/14571). | Version: v11.2.3+
Default: `block`
Applications: API | | `DB_EVENTS_LISTENER_BATCH_SIZE` | Max events in one batch to be processed by DB events listener. Implemented in [#14625](https://github.com/blockscout/blockscout/pull/14625). | Version: v11.2.4+
Default: `100`
Applications: API | | `REALTIME_EVENT_HANDLERS_BATCH_SIZE` | Max events in one batch to be processed by each realtime event handler. Implemented in [#14625](https://github.com/blockscout/blockscout/pull/14625). | Version: v11.2.4+
Default: `100`
Applications: API | ## Database Management | Variable | Description | Parameters | | - | - | - | | `DATABASE_URL` | Defines the Postgres Database endpoint. | Required: β
Version: All
Default: (empty)
Applications: API, Indexer | | `DATABASE_PREPARE_MODE` | Postgrex prepared statements mode for the main database connection. `named` uses one round trip per query and caches parsed statements per connection; `unnamed` is required behind a transaction-mode pooler without prepared statements support. | Version: v11.3.0+
Default: `unnamed`
Applications: API, Indexer | | `DATABASE_API_PREPARE_MODE` | Same as `DATABASE_PREPARE_MODE`, but for the API read-only database connection (`DATABASE_READ_ONLY_API_URL`). | Version: v11.3.0+
Default: value of `DATABASE_PREPARE_MODE`
Applications: API | | `TEST_DATABASE_URL` | Defines the endpoint of the Postgres Database that is used during testing. Implemented in [#9662](https://github.com/blockscout/blockscout/pull/9662). | Version: v6.6.0+
Default: (empty)
Applications: API, Indexer | | `DATABASE_READ_ONLY_API_URL` | Defines the Postgres Database read-only replica endpoint. If provided, most of the read queries from API v2 and UI go through this endpoint. | Version: All
Default: (empty)
Applications: API | | `TEST_DATABASE_READ_ONLY_API_URL` | Defines the endpoint of the Postgres Database read-only replica used during testing. If provided, most read queries from API v2 and UI go through this endpoint. Implemented in [#9662](https://github.com/blockscout/blockscout/pull/9662). | Version: v6.6.0+
Default: (empty)
Applications: API | | `DATABASE_EVENT_URL` | Variable to define the Postgres Database endpoint that will be used by event listener process. Applicable for separate indexer and API setup. More info in related PR. Implemented in [#10164](https://github.com/blockscout/blockscout/pull/10164). | Version: v6.8.0+
Default: (empty)
Applications: API | | `DATABASE_EVENT_POOL_SIZE` | Variable to define the pool size for DB repo `DATABASE_EVENT_URL`. Applicable for separate indexer and API setup. Implemented in [#13064](https://github.com/blockscout/blockscout/pull/13064). | Version: v9.1.0+
Default: 10
Applications: API, Indexer | | `REPLICA_MAX_LAG` | Defines the max lag for read-only replica. If the actual lag is higher than this, replica is considered unavailable and all requests to it are redirected to main DB. Implemented in [#11020](https://github.com/blockscout/blockscout/pull/11020) | Version: v6.10.0+
Default: 5m
Applications: API | | `DATABASE_QUEUE_TARGET` | Management of [DB queue target](https://hexdocs.pm/db_connection/DBConnection.html#start_link/2-queue-config). Implemented in [#8991](https://github.com/blockscout/blockscout/pull/8991). | Version: v5.4.0+
Default: `50ms`
Applications: API, Indexer | | `POOL_SIZE` | Defines the number of database connections allowed excluding read-only API endpoints requests. | Version: All
Default: `50`
Applications: API, Indexer | | `POOL_SIZE_API` | Defines the number of database connections allowed for read-only API endpoints requests. | Version: v4.1.0+
Default: `50`
Applications: API | | `ECTO_SSL_MODE` | SSL mode for Ecto DB connections. Supported values: `disable`, `allow`, `prefer`, `require`, `verify-ca`, `verify-full`. Resolution order: `ECTO_SSL_MODE` has highest priority, then `sslmode` in `DATABASE_URL`, otherwise defaults to `require`. | Version: v11.1.0+
Default: `require`
Applications: API, Indexer | ## JSON RPC Node Management | Variable | Description | Parameters | | - | - | - | | `ETHEREUM_JSONRPC_VARIANT` | Tells the application which RPC Client the node is using (i.e. `erigon`, `geth`, `nethermind`, `besu`, `filecoin`, or `anvil`) (See Client Settings for more info) | Required: β
Version: All
Default: `geth`
Applications: API, Indexer | | `ETHEREUM_JSONRPC_HTTP_URL` | The RPC endpoint used to fetch blocks, transactions, receipts, tokens. | Required: β
Version: All
Default: `localhost:8545`
Applications: API, Indexer | | `ETHEREUM_JSONRPC_FALLBACK_HTTP_URL` | Fallback JSON RPC HTTP url. Implemented in [#7246](https://github.com/blockscout/blockscout/pull/7246) | Version: v5.1.4+
Default: (empty)
Applications: API, Indexer | | `ETHEREUM_JSONRPC_HTTP_URLS` | Analogue of `ETHEREUM_JSONRPC_HTTP_URL` for multiple values. Implemented in [#10934](https://github.com/blockscout/blockscout/pull/10934) | Version: v6.10.0+
Default: (empty)
Applications: API, Indexer | | `ETHEREUM_JSONRPC_FALLBACK_HTTP_URLS` | Analogue of `ETHEREUM_JSONRPC_FALLBACK_HTTP_URL` for multiple values. Implemented in [#10934](https://github.com/blockscout/blockscout/pull/10934) | Version: v6.10.0+
Default: (empty)
Applications: API, Indexer | | `ETHEREUM_JSONRPC_TRACE_URL` | The RPC endpoint specifically for the Erigon/Geth/Nethermind/Besu client used by `trace_block` and `trace_replayTransaction`. This can be used to designate a tracing node. | Version: All
Default: `localhost:8545`
Applications: API, Indexer | | `ETHEREUM_JSONRPC_FALLBACK_TRACE_URL` | Fallback JSON RPC trace url. Implemented in [#7246](https://github.com/blockscout/blockscout/pull/7246) | Version: v5.1.4+
Default: (empty)
Applications: API, Indexer | | `ETHEREUM_JSONRPC_TRACE_URLS` | Analogue of `ETHEREUM_JSONRPC_TRACE_URL` for multiple values. Implemented in [#10934](https://github.com/blockscout/blockscout/pull/10934) | Version: v6.10.0+
Default: (empty)
Applications: API, Indexer | | `ETHEREUM_JSONRPC_FALLBACK_TRACE_URLS` | Analogue of `ETHEREUM_JSONRPC_FALLBACK_TRACE_URL` for multiple values. Implemented in [#10934](https://github.com/blockscout/blockscout/pull/10934) | Version: v6.10.0+
Default: (empty)
Applications: API, Indexer | | `ETHEREUM_JSONRPC_ETH_CALL_URL` | JSON RPC url for `eth_call` method. Implemented in [#9112](https://github.com/blockscout/blockscout/pull/9112) | Version: v6.0.0+
Default: (empty)
Applications: API, Indexer | | `ETHEREUM_JSONRPC_FALLBACK_ETH_CALL_URL` | Fallback JSON RPC `eth_call` url. Implemented in [#9511](https://github.com/blockscout/blockscout/pull/9511) | Version: v6.3.0+
Default: (empty)
Applications: API, Indexer | | `ETHEREUM_JSONRPC_ETH_CALL_URLS` | Analogue of `ETHEREUM_JSONRPC_ETH_CALL_URL` for multiple values. Implemented in [#10934](https://github.com/blockscout/blockscout/pull/10934) | Version: v6.10.0+
Default: (empty)
Applications: API, Indexer | | `ETHEREUM_JSONRPC_FALLBACK_ETH_CALL_URLS` | Analogue of `ETHEREUM_JSONRPC_FALLBACK_ETH_CALL_URL` for multiple values. Implemented in [#10934](https://github.com/blockscout/blockscout/pull/10934) | Version: v6.10.0+
Default: (empty)
Applications: API, Indexer | | `ETHEREUM_JSONRPC_WS_URL` | The WebSockets RPC endpoint used to subscribe to the `newHeads` subscription alerting the indexer to fetch new blocks. | Version: All
Default: `ws://localhost:8546`
Applications: Indexer | | `ETHEREUM_JSONRPC_FALLBACK_WS_URL` | The fallback WebSockets RPC endpoint used to subscribe to the `newHeads` subscription alerting the indexer to fetch new blocks. Implemented in [#10407](https://github.com/blockscout/blockscout/pull/10407). | Version: v6.8.0+
Default: (empty)
Applications: Indexer | | `ETHEREUM_JSONRPC_WS_RETRY_INTERVAL` | The interval between retries of connecting to WebSocket RPC endpoint after the previous attempt fails. Implemented in [#10407](https://github.com/blockscout/blockscout/pull/10407). | Version: v6.8.0+
Default: 1m
Applications: Indexer | | `ETHEREUM_JSONRPC_TRANSPORT` | Specifies the transport for Blockscout to connect to the Ethereum Node. Available transports are `http` and `ipc`. If `ipc` is selected, also set `IPC_PATH` variable. | Version: v3.1.0+
Default: `http`
Applications: API, Indexer | | `ETHEREUM_JSONRPC_HTTP_INSECURE` | If `true` is set, allows insecure HTTP connections to the archive node. For instance, it allows to bypass expired SSL certificate at the archive node endpoint. Implemented in [#6573](https://github.com/blockscout/blockscout/pull/6573) | Version: v5.0.0+
Default: (empty)
Applications: API, Indexer | | `ETHEREUM_JSONRPC_HTTP_TIMEOUT` | Timeout for ethereum json rpc http requests in seconds. Implemented in [#7089](https://github.com/blockscout/blockscout/pull/7089) | Version: v5.1.2+
Default: `60`
Applications: API, Indexer | | `ETHEREUM_JSONRPC_USER` | User in basic auth for JSON RPC endpoint. Implemented in [#6897](https://github.com/blockscout/blockscout/pull/6897) | Version: v5.1.2+
Default: (empty)
Applications: API, Indexer | | `ETHEREUM_JSONRPC_PASSWORD` | Password in basic auth for JSON RPC endpoint. Implemented in [#6897](https://github.com/blockscout/blockscout/pull/6897) | Version: v5.1.2+
Default: (empty)
Applications: API, Indexer | | `ETHEREUM_JSONRPC_HTTP_HEADERS` | Custom headers for JSON RPC endpoint in form of json object, example: `{"x-api-key": "nbvkhadvnbkdfav", "x-id": "ndjkfvndfkjv"}`. Implemented in [#7898](https://github.com/blockscout/blockscout/pull/7898) | Version: v5.2.1+
Default: (empty)
Applications: API, Indexer | | `ETHEREUM_JSONRPC_WAIT_PER_TIMEOUT` | Wait time for each recent timeout from node. Implemented in [#8292](https://github.com/blockscout/blockscout/pull/8292) | Version: v5.2.3+
Default: `20s`
Applications: API, Indexer | | `ETHEREUM_JSONRPC_HTTP_BATCH_SIZE` | Max http requests count in one batch. Implemented in [#14319](https://github.com/blockscout/blockscout/pull/14319). | Version: v11.2.0+
Default: `500`
Applications: API, Indexer | | `ETHEREUM_JSONRPC_HTTP_REQUEST_COMPRESSION_HEAVY_METHODS_ENABLED` | Controls whether compression is applied when calling high-volume JSON-RPC endpoints (such as debug\_*, trace\_*, and eth\_getBlockReceipts). Implemented in [#14303](https://github.com/blockscout/blockscout/pull/14303). | Version: v12.0.0+
Default: `true`
Applications: API, Indexer | | `ETHEREUM_JSONRPC_HTTP_REQUEST_COMPRESSION_ALL_METHODS_ENABLED` | Controls whether compression is applied when calling all JSON RPC endpoints. Implemented in [#14303](https://github.com/blockscout/blockscout/pull/14303). | Version: v12.0.0+
Default: `false`
Applications: API, Indexer | | `IPC_PATH` | Path to the IPC file of the running node if IPC transport is chosen. | Version: v2.1.1+
Default: (empty)
Applications: API, Indexer | ## Indexer Management | Variable | Description | Parameters | | - | - | - | | `BLOCK_TRANSFORMER` | Transformer for blocks: base or clique. | Version: v1.3.4+
Default: `base`
Applications: Indexer | | `DISABLE_INDEXER` | If `true`, indexer application doesn't run. | Version: v2.0.3+
Default: `false`
Applications: API, Indexer | | `DISABLE_REALTIME_INDEXER` | If `true`, realtime fetcher doesn't run. | Version: v4.1.6+
Default: `false`
Applications: Indexer | | `FIRST_BLOCK` | The block number, where import of blocks by catchup fetcher begins from. | Version: v1.3.8+
Default: `0`
Applications: API, Indexer | | `LAST_BLOCK` | The block number, where import of blocks by catchup fetcher stops. | Version: v2.0.3+
Default: (empty)
Applications: Indexer | | `TRACE_FIRST_BLOCK` | The block number, where indexing of internal transactions begins from. | Version: v4.1.0+
Default: `0`
Applications: API, Indexer | | `TRACE_LAST_BLOCK` | The block number, where indexing of internal transactions stops. | Version: v4.1.0+
Default: (empty)
Applications: API, Indexer | | `BLOCK_RANGES` | Block ranges to import by catchup fetcher. Example: `BLOCK_RANGES="1..3,123..500,30..50,500..latest"`. Implemented in [#5783](https://github.com/blockscout/blockscout/pull/5783) | Version: v4.1.7+
Default: (empty)
Applications: Indexer | | `FETCH_REWARDS_WAY` | Tells the application how to calculate block rewards, by fetching via json\_rpc (`trace_block`) or manual by block params (`manual`). | Version: v4.1.4+
Default: `trace_block`
Applications: Indexer | | `IPFS_GATEWAY_URL` | IPFS gateway url for fetching token instance metadata from IPFS including token instance icon. | Version: v5.3.0+
Default: `https://ipfs.io/ipfs`
Applications: Indexer | | `IPFS_GATEWAY_URL_PARAM_KEY` | The key of the parameter to add to IPFS gateway url. Implemented in [#9898](https://github.com/blockscout/blockscout/pull/9898). | Version: v6.5.0+
Default: (empty)
Applications: Indexer | | `IPFS_GATEWAY_URL_PARAM_VALUE` | The value of the parameter to add to IPFS gateway url. Implemented in [#9898](https://github.com/blockscout/blockscout/pull/9898). | Version: v6.5.0+
Default: (empty)
Applications: Indexer | | `IPFS_GATEWAY_URL_PARAM_LOCATION` | Whether to add extra params: to query string or to the headers. Available values: query/header. Implemented in [#9898](https://github.com/blockscout/blockscout/pull/9898). | Version: v6.5.0+
Default: (empty)
Applications: Indexer | | `IPFS_PUBLIC_GATEWAY_URL` | IPFS public gateway url which is used by frontend to display IPFS resources such as token instance image. | Version: v6.8.0+
Default: `https://ipfs.io/ipfs`
Applications: API | | `ETHEREUM_JSONRPC_DEBUG_TRACE_TRANSACTION_TIMEOUT` | Timeout for `debug_traceTransaction`/`debug_traceBlockByNumber` JSON RPC method requests in case of `geth` archive node. Supported time formats: [https://pkg.go.dev/time#ParseDuration](https://pkg.go.dev/time#ParseDuration). Introduced in [#5505](https://github.com/blockscout/blockscout/pull/5505) | Version: v4.1.3+
Default: `5s`
Applications: Indexer | | `ETHEREUM_JSONRPC_DISABLE_ARCHIVE_BALANCES` | If `true`, all the requests with the method `eth_getBalance` with any block as parameter but `latest` (or block number is in the range `latest` - value from `ETHEREUM_JSONRPC_DISABLE_ARCHIVE_BALANCES`) are ignored. Implemented in [#6001](https://github.com/blockscout/blockscout/pull/6001) | Version: v5.0.0+
Default: `false`
Applications: API, Indexer | | `ETHEREUM_JSONRPC_PENDING_TRANSACTIONS_TYPE` | Defines which method will be used for fetching pending transactions: `default` - default method for fetching internal transactions for current `ETHEREUM_JSONRPC_VARIANT`, `geth` - `txpool_content` method will be used, `parity` - `parity_pendingTransactions` will be used. Implemented in [#6155](https://github.com/blockscout/blockscout/pull/6155) | Version: v5.0.0+
Default: `default`
Applications: Indexer | | `MIN_MISSING_BLOCK_NUMBER_BATCH_SIZE` | Batch size for min missing block number updater. Implemented in [#6583](https://github.com/blockscout/blockscout/pull/6583). | Version: v5.0.0+
Default: `100000`
Applications: API, Indexer | | `WITHDRAWALS_FIRST_BLOCK` | The block number, where import of withdrawals by catchup fetcher begins from. Should be the block where withdrawals upgrade occurred on the chain. Implemented in [#6694](https://github.com/blockscout/blockscout/pull/6694). | Version: v5.1.5+
Default: (empty)
Applications: Indexer | | `ETHEREUM_JSONRPC_ARCHIVE_BALANCES_WINDOW` | Max block number gap from latest for which balances requests can be processed when `ETHEREUM_JSONRPC_DISABLE_ARCHIVE_BALANCES` env var is set to `true`. Implemented in [#8673](https://github.com/blockscout/blockscout/pull/8673) | Version: v5.3.1+
Default: `200`
Applications: API, Indexer | | `ETHEREUM_JSONRPC_RECEIPTS_BY_BLOCK` | If `true`, block fetchers will fetch transaction receipts by block instead of per transaction. Implemented in [#14046](https://github.com/blockscout/blockscout/pull/14046) | Version: v10.2.0+
Default: `false`
Applications: API, Indexer | | `ETHEREUM_JSONRPC_MAX_RECEIPTS_BY_BLOCK` | Max number of transactions in block for which receipts will be fetched by block. If block has more transactions, receipts will be fetched per transaction in purpose of reducing response body size. Implemented in [#14046](https://github.com/blockscout/blockscout/pull/14046) | Version: v10.2.0+
Default: `1000`
Applications: API, Indexer | | `DISABLE_CATCHUP_INDEXER` | If `true`, catchup fetcher doesn't run. | Version: v5.3.2+
Default: `false`
Applications: Indexer | | `TRACE_BLOCK_RANGES` | Block ranges for traceable blocks. Example: `TRACE_BLOCK_RANGES="1..3,123..500,30..50,500..latest"`. Implemented in [#8960](https://github.com/blockscout/blockscout/pull/8960) | Version: v5.4.0+
Default: (empty)
Applications: API, Indexer | | `ETHEREUM_JSONRPC_GETH_TRACE_BY_BLOCK` | Enable tracing by block for geth variant. Implemented in [#9072](https://github.com/blockscout/blockscout/pull/9072) | Version: v6.1.0+
Default: `false`
Applications: Indexer | | `MISSING_BALANCE_OF_TOKENS_WINDOW_SIZE` | Minimal blocks count until the next token balance request will be executed for tokens that don't implement `balanceOf` function. Implemented in [#10142](https://github.com/blockscout/blockscout/pull/10142) | Version: v6.8.0+
Default: `100`
Applications: Indexer | | `ETHEREUM_JSONRPC_GETH_ALLOW_EMPTY_TRACES` | Allow transactions to not have internal transactions. Implemented in [#10200](https://github.com/blockscout/blockscout/pull/10200) | Version: v6.8.0+
Default: `false`
Applications: Indexer | | `PENDING_OPERATIONS_HELPER_TRANSACTIONS_BATCH_SIZE` | Batch size for transactions when processing pending operations. Implemented in [#14273](https://github.com/blockscout/blockscout/pull/14273). | Version: v11.0.1+
Default: `1000`
Applications: Indexer | | `PENDING_OPERATIONS_HELPER_BLOCKS_BATCH_SIZE` | Batch size for blocks when processing pending operations. Implemented in [#14273](https://github.com/blockscout/blockscout/pull/14273). | Version: v11.0.1+
Default: `10`
Applications: Indexer | | `INDEXER_DISABLE_ADDRESS_COIN_BALANCE_FETCHER` | If `true`, coin balances fetcher is disabled. | Version: v4.1.3+
Default: `false`
Applications: Indexer | | `INDEXER_DISABLE_ARCHIVAL_TOKEN_BALANCES_FETCHER` | If `true`, archival token balances fetcher is disabled. Implemented in [#13954](https://github.com/blockscout/blockscout/pull/13954). | Version: v10.0.0+
Default: `false`
Applications: Indexer | | `INDEXER_DISABLE_BLOCK_REWARD_FETCHER` | If `true`, block rewards fetcher is disabled. | Version: v4.1.3+
Default: `false`
Applications: Indexer | | `INDEXER_DISABLE_CATALOGED_TOKEN_UPDATER_FETCHER` | If `true`, cataloged tokens metadata fetcher is disabled. | Version: v4.1.3+
Default: `false`
Applications: Indexer | | `INDEXER_DISABLE_EMPTY_BLOCKS_SANITIZER` | Empty blocks sanitizer is disabled if `true` | Version: v5.1.2+
Default: `false`
Applications: Indexer | | `INDEXER_DISABLE_HOT_SMART_CONTRACTS_FETCHER` | If `true`, `Indexer.Fetcher.Stats.HotSmartContracts` won't be started. Implemented in [#13471](https://github.com/blockscout/blockscout/pull/13471). | Version: v9.3.0+
Default: `false`
Applications: Indexer | | `INDEXER_DISABLE_INTERNAL_TRANSACTIONS_FETCHER` | If `true`, internal transactions fetcher is disabled. | Version: v4.1.2+
Default: `false`
Applications: Indexer | | `INDEXER_DISABLE_PENDING_TRANSACTIONS_FETCHER` | If `true`, pending transactions fetcher is disabled. | Version: v4.1.2+
Default: `false`
Applications: Indexer | | `INDEXER_DISABLE_REPLACED_TRANSACTION_FETCHER` | If `true`, `Indexer.Fetcher.ReplacedTransaction` fetcher doesn't run. | Version: v6.8.0+
Default: `false`
Applications: Indexer | | `INDEXER_DISABLE_TOKEN_BALANCE_ON_DEMAND_FETCHER` | If `true`, `Indexer.Fetcher.OnDemand.TokenBalance` fetcher is disabled at runtime. | Version: v11.2.5+
Default: `false`
Applications: Indexer | | `INDEXER_DISABLE_TOKEN_INSTANCE_ERC_1155_SANITIZE_FETCHER` | If `true`, `erc-1155-sanitize` token instance fetcher doesn't run. Implemented in [#9226](https://github.com/blockscout/blockscout/pull/9226). | Version: v6.2.0+
Default: `false`
Applications: Indexer | | `INDEXER_DISABLE_TOKEN_INSTANCE_ERC_721_SANITIZE_FETCHER` | If `true`, `erc-721-sanitize` token instance fetcher doesn't run. Implemented in [#9226](https://github.com/blockscout/blockscout/pull/9226). | Version: v6.2.0+
Default: `false`
Applications: Indexer | | `INDEXER_DISABLE_TOKEN_INSTANCE_MEDIA_TYPE_FETCHER` | If `true`, token instance media type backfill fetcher is disabled. When disabled, `image_type` and `animation_type` fields will not be populated for existing token instances. Implemented in [#14365](https://github.com/blockscout/blockscout/pull/14365). | Version: v12.0.0+
Default: `false`
Applications: Indexer | | `INDEXER_DISABLE_TOKEN_INSTANCE_REALTIME_FETCHER` | If `true`, `realtime` token instance fetcher doesn't run. | Version: v5.1.4+
Default: `false`
Applications: Indexer | | `INDEXER_DISABLE_TOKEN_INSTANCE_REFETCH_FETCHER` | If `true`, the Token instance fetcher, which re-fetches NFT collections marked to refetch, doesn't run. Implemented in [#10263](https://github.com/blockscout/blockscout/pull/10263). | Version: v7.0.0+
Default: `false`
Applications: Indexer | | `INDEXER_DISABLE_TOKEN_INSTANCE_RETRY_FETCHER` | If `true`, `retry` token instance fetcher doesn't run. | Version: v5.1.4+
Default: `false`
Applications: Indexer | | `INDEXER_DISABLE_TOKEN_INSTANCE_SANITIZE_FETCHER` | If `true`, `sanitize` token instance fetcher doesn't run | Version: v5.1.4+
Default: `false`
Applications: Indexer | | `INDEXER_DISABLE_TOKEN_TOTAL_SUPPLY_ON_DEMAND_FETCHER` | If `true`, `Indexer.Fetcher.OnDemand.TokenTotalSupply` fetcher is disabled at runtime. Implemented in [#14811](https://github.com/blockscout/blockscout/pull/14811). | Version: v11.3.1+
Default: `false`
Applications: Indexer | | `INDEXER_DISABLE_WITHDRAWALS_FETCHER` | If `true`, withdrawals fetcher is disabled. Implemented in [#6694](https://github.com/blockscout/blockscout/pull/6694). | Version: v5.1.5+
Default: `true`
Applications: Indexer | | `INDEXER_BLOCK_REWARD_BATCH_SIZE` | Batch size for block reward fetcher. Implemented in [#6952](https://github.com/blockscout/blockscout/pull/6952). | Version: v5.1.2+
Default: `10`
Applications: Indexer | | `INDEXER_BLOCK_REWARD_CONCURRENCY` | Concurrency for block reward fetcher. Implemented in [#6952](https://github.com/blockscout/blockscout/pull/6952). | Version: v5.1.2+
Default: `4`
Applications: Indexer | | `INDEXER_CATCHUP_BLOCKS_BATCH_SIZE` | Batch size for blocks catchup fetcher. Implemented in [#6196](https://github.com/blockscout/blockscout/pull/6196). | Version: v5.0.0+
Default: `10`
Applications: Indexer | | `INDEXER_CATCHUP_BLOCKS_CONCURRENCY` | Concurrency for blocks catchup fetcher. Implemented in [#6196](https://github.com/blockscout/blockscout/pull/6196). | Version: v5.0.0+
Default: `10`
Applications: Indexer | | `INDEXER_CATCHUP_BLOCK_INTERVAL` | Interval between blocks catchup fetcher tasks. Implemented in [#7489](https://github.com/blockscout/blockscout/pull/7489). | Version: v5.1.5+
Default: `0s`
Applications: Indexer | | `INDEXER_CATCHUP_MISSING_RANGES_BATCH_SIZE` | Batch size for missing ranges collector. Implemented in [#6583](https://github.com/blockscout/blockscout/pull/6583). | Version: v5.0.0+
Default: `100000`
Applications: Indexer | | `INDEXER_COIN_BALANCES_BATCH_SIZE` | Batch size for coin balances fetcher. Implemented in [#6454](https://github.com/blockscout/blockscout/pull/6454). | Version: v5.0.0+
Default: `100`
Applications: Indexer | | `INDEXER_COIN_BALANCES_CONCURRENCY` | Concurrency for coin balances fetcher. Implemented in [#6454](https://github.com/blockscout/blockscout/pull/6454). | Version: v5.0.0+
Default: `4`
Applications: Indexer | | `INDEXER_COIN_BALANCES_FETCHER_INIT_QUERY_LIMIT` | Limit for coin balance fetcher init queries. Implemented in [#7996](https://github.com/blockscout/blockscout/pull/7996). | Version: v5.3.0+
Default: `2000`
Applications: Indexer | | `INDEXER_DB_EVENT_NOTIFICATIONS_CLEANUP_ENABLED` | If `true`, `Indexer.Utils.EventNotificationsCleaner` process starts. Implemented in [#12738](https://github.com/blockscout/blockscout/pull/12738) | Version: v9.0.0+
Default: `true`
Applications: Indexer | | `INDEXER_DB_EVENT_NOTIFICATIONS_CLEANUP_INTERVAL` | Interval between DB event notifications cleanup. [Time format](/setup/env-variables/backend-env-variables#time-format). Implemented in [#12738](https://github.com/blockscout/blockscout/pull/12738) | Version: v9.0.0+
Default: `2m`
Applications: Indexer | | `INDEXER_DB_EVENT_NOTIFICATIONS_CLEANUP_MAX_AGE` | Max age of DB event notifications before they are cleaned up. [Time format](/setup/env-variables/backend-env-variables#time-format). Implemented in [#12738](https://github.com/blockscout/blockscout/pull/12738) | Version: v9.0.0+
Default: `5m`
Applications: Indexer | | `INDEXER_EMPTY_BLOCKS_SANITIZER_BATCH_SIZE` | Batch size for empty block sanitizer (re-fetcher). Default value changed from 100 to 10 in the release `v6.10.1` ([#11555](https://github.com/blockscout/blockscout/pull/11555)) | Version: v4.1.3+
Default: `10`
Applications: Indexer | | `INDEXER_EMPTY_BLOCKS_SANITIZER_INTERVAL` | Interval for empty block sanitizer. Implemented in [#8658](https://github.com/blockscout/blockscout/pull/8658) | Version: v5.3.0+
Default: `5m`
Applications: Indexer | | `INDEXER_EMPTY_BLOCKS_SANITIZER_HEAD_OFFSET` | Minimal age for block to be processed by empty block sanitizer. Implemented in [#13132](https://github.com/blockscout/blockscout/pull/13132) | Version: v9.2.0+
Default: `1000`
Applications: Indexer | | `INDEXER_FETCHER_INIT_QUERY_LIMIT` | Limit for all fetchers init queries. Implemented in [#7697](https://github.com/blockscout/blockscout/pull/7697). | Version: v5.2.0+
Default: `100`
Applications: Indexer | | `INDEXER_FETCHER_INIT_DELAY` | Delay between async fetchers init tasks. Implemented in [#14018](https://github.com/blockscout/blockscout/pull/14018). | Version: v10.0.0+
Default: `10m`
Applications: Indexer | | `INDEXER_MASSIVE_BLOCK_THRESHOLD` | Max transactions count in a single block after which the block is treated as massive. Implemented in [#13994](https://github.com/blockscout/blockscout/pull/13994). | Version: v11.0.0+
Default: `1000`
Applications: Indexer | | `INDEXER_GRACEFUL_SHUTDOWN_PERIOD` | Time that will be given to the block fetchers when stopping the application before they are killed. Implemented in [#9729](https://github.com/blockscout/blockscout/pull/9729) | Version: v6.5.0+
Default: `5m`
Applications: Indexer | | `INDEXER_HIDE_INDEXING_PROGRESS_ALERT` | If `true`, indexer progress alert will be disabled even if initial catchup indexing is still in place. Implemented in [#7360](https://github.com/blockscout/blockscout/pull/7360). | Version: v5.1.5+
Default: `false`
Applications: API | | `INDEXER_INTERNAL_TRANSACTIONS_BATCH_SIZE` | Batch size for internal transactions fetcher. Implemented in [#6450](https://github.com/blockscout/blockscout/pull/6450). | Version: v5.0.0+
Default: `10`
Applications: Indexer | | `INDEXER_INTERNAL_TRANSACTIONS_CONCURRENCY` | Concurrency for internal transactions fetcher. Implemented in [#6450](https://github.com/blockscout/blockscout/pull/6450). | Version: v5.0.0+
Default: `4`
Applications: Indexer | | `INDEXER_INTERNAL_TRANSACTIONS_IMPORT_TIMEOUT` | DB transaction timeout for internal transactions import. [Time format](/setup/env-variables/backend-env-variables#time-format). Set `0` to disable the timeout. Implemented in [#14864](https://github.com/blockscout/blockscout/pull/14864). | Version: v11.3.3+
Default: `4m`
Applications: Indexer | | `INDEXER_ON_DEMAND_INTERNAL_TRANSACTIONS_BLOCKS_BATCH_SIZE` | Batch size for block trace requests in the on-demand internal transactions fetcher. The minimum value is `1`. Implemented in [#14724](https://github.com/blockscout/blockscout/pull/14724). | Version: v11.2.8+
Default: `2`
Applications: Indexer | | `INDEXER_ON_DEMAND_INTERNAL_TRANSACTIONS_TRANSACTIONS_BATCH_SIZE` | Batch size for transaction trace requests in the on-demand internal transactions fetcher. The minimum value is `1`. Implemented in [#14724](https://github.com/blockscout/blockscout/pull/14724). | Version: v11.2.8+
Default: `20`
Applications: Indexer | | `INDEXER_REPLACED_TRANSACTIONS_BATCH_SIZE` | Batch size for replaced transactions fetcher. Implemented in [#14576](https://github.com/blockscout/blockscout/pull/14576). | Version: v11.2.3+
Default: `10`
Applications: Indexer | | `INDEXER_REPLACED_TRANSACTIONS_CONCURRENCY` | Concurrency for replaced transactions fetcher. Implemented in [#14576](https://github.com/blockscout/blockscout/pull/14576). | Version: v11.2.3+
Default: `4`
Applications: Indexer | | `INDEXER_INTERNAL_TRANSACTIONS_FETCH_ORDER` | Order of fetching internal transactions from node. Possible values: `asc`, `desc`. Implemented in [#10912](https://github.com/blockscout/blockscout/pull/10912) | Version: v6.9.0+
Default: `asc`
Applications: Indexer | | `INDEXER_INTERNAL_TRANSACTIONS_TRACER_TYPE` | Tracer type for `debug_traceTransaction`/`debug_traceBlockByNumber` requests for geth-like nodes. Possible values are: `js` to use custom Blockscout js tracer, `call_tracer` to use built-in `callTracer` geth tracer, `opcode` to use built-in `Struct/opcode logger` geth tracer, `polygon_edge` to work with Polygon edge nodes. Implemented in [#6721](https://github.com/blockscout/blockscout/pull/6721), [#7513](https://github.com/blockscout/blockscout/pull/7513) | Version: v5.1.0+
Default: `call_tracer`
Applications: Indexer | | `INDEXER_INTERNAL_TRANSACTIONS_DELETE_QUEUE_BATCH_SIZE` | Batch size for internal transactions delete queue handler. Implemented in [#13121](https://github.com/blockscout/blockscout/pull/13121). | Version: v9.2.0+
Default: `100`
Applications: Indexer | | `INDEXER_INTERNAL_TRANSACTIONS_DELETE_QUEUE_CONCURRENCY` | Concurrency for internal transactions delete queue handler. Implemented in [#13121](https://github.com/blockscout/blockscout/pull/13121). | Version: v9.2.0+
Default: `1`
Applications: Indexer | | `INDEXER_INTERNAL_TRANSACTIONS_DELETE_QUEUE_THRESHOLD` | Threshold for internal transactions delete queue handler. Implemented in [#13121](https://github.com/blockscout/blockscout/pull/13121). | Version: v9.2.0+
Default: `0s`
Applications: Indexer | | `INDEXER_MEMORY_LIMIT` | Memory soft limit for the indexer. | Version: v4.1.3+
Default: `1Gb`
Applications: Indexer | | `INDEXER_PENDING_TRANSACTIONS_SANITIZER_INTERVAL` | Interval between pending transactions sanitizing. Implemented in [#11601](https://github.com/blockscout/blockscout/pull/11601). | Version: v6.10.1+
Default: `1h`
Applications: Indexer | | `INDEXER_PENDING_TRANSACTIONS_WINDOW_SIZE` | Time offset for pending transactions sanitizer. Implemented in [#14292](https://github.com/blockscout/blockscout/pull/14292). | Version: v11.0.1+
Default: `1d`
Applications: Indexer | | `INDEXER_REALTIME_FETCHER_MAX_GAP` | Max gap between consecutive `latest` blocks that will be filled by realtime fetcher. Implemented in [#7393](https://github.com/blockscout/blockscout/pull/7393) | Version: v5.1.5+
Default: `1000`
Applications: Indexer | | `INDEXER_REALTIME_FETCHER_POLLING_PERIOD` | Period between polling the `latest` block in realtime fetcher. [Time format](/setup/env-variables/backend-env-variables#time-format). Implemented in [#11783](https://github.com/blockscout/blockscout/pull/11783) | Version: v7.0.0+
Default: (empty)
Applications: Indexer | | `INDEXER_RECEIPTS_BATCH_SIZE` | Batch size for transaction receipts fetcher. Implemented in [#6454](https://github.com/blockscout/blockscout/pull/6454). | Version: v5.0.0+
Default: `250`
Applications: Indexer | | `INDEXER_RECEIPTS_CONCURRENCY` | Concurrency for transaction receipts fetcher. Implemented in [#6454](https://github.com/blockscout/blockscout/pull/6454). | Version: v5.0.0+
Default: `10`
Applications: Indexer | | `INDEXER_SIGNED_AUTHORIZATION_STATUS_BATCH_SIZE` | Batch size (number of blocks) for EIP7702 authorizations status fetcher. Implemented in [#12451](https://github.com/blockscout/blockscout/pull/12451). | Version: v9.0.0+
Default: `10`
Applications: Indexer | | `INDEXER_FHE_OPERATIONS_ENABLED` | Flag to enable parsing of Fully Homomorphic Encryption (FHE) operations from transactions. Implemented in [#13742](https://github.com/blockscout/blockscout/pull/13742). | Version: v11.0.0+
Default: `false`
Applications: Indexer | | `INDEXER_SYSTEM_MEMORY_PERCENTAGE` | Percentage of total memory available to the VM that an application can use if `INDEXER_MEMORY_LIMIT` is not set. Implemented in [#10697](https://github.com/blockscout/blockscout/pull/10697). | Version: v6.9.0+
Default: `60`
Applications: Indexer | | `INDEXER_ARCHIVAL_TOKEN_BALANCES_BATCH_SIZE` | Batch size for archival token balances fetcher. Implemented in [#7439](https://github.com/blockscout/blockscout/pull/7439). | Version: v10.0.0+
Default: `100`
Applications: Indexer | | `INDEXER_ARCHIVAL_TOKEN_BALANCES_CONCURRENCY` | Concurrency for archival token balances fetcher. Implemented in [#8167](https://github.com/blockscout/blockscout/pull/8167). | Version: v10.0.0+
Default: `10`
Applications: Indexer | | `INDEXER_ARCHIVAL_TOKEN_BALANCES_EXPONENTIAL_TIMEOUT_COEFF` | Coefficient to calculate exponential timeout. Implemented in [#10694](https://github.com/blockscout/blockscout/pull/10694). | Version: v10.0.0+
Default: `100`
Applications: Indexer | | `INDEXER_TOKEN_BALANCES_FETCHER_INIT_QUERY_LIMIT` | Limit for token balance fetcher init queries. Implemented in [#8459](https://github.com/blockscout/blockscout/pull/8459). | Version: v5.2.3+
Default: `100000`
Applications: Indexer | | `INDEXER_ARCHIVAL_TOKEN_BALANCES_MAX_REFETCH_INTERVAL` | Maximum interval between attempts to fetch address token balance. [Time format](/setup/env-variables/backend-env-variables#time-format). Implemented in [#10694](https://github.com/blockscout/blockscout/pull/10694). | Version: v10.0.0+
Default: `168h`
Applications: Indexer | | `INDEXER_TOKEN_CONCURRENCY` | Concurrency for token fetcher. Implemented in [#8167](https://github.com/blockscout/blockscout/pull/8167). | Version: v5.2.2+
Default: `10`
Applications: Indexer | | `INDEXER_TOKEN_INSTANCE_ALLOWED_URI_PROTOCOLS` | List of allowed URI protocols (schemes) for requests when fetching token instance metadata. Implemented in [#12102](https://github.com/blockscout/blockscout/pull/12102). | Version: v8.0.0+
Default: `http,https`
Applications: Indexer | | `INDEXER_TOKEN_INSTANCE_CIDR_BLACKLIST` | List of IP addresses in CIDR format to block when fetching token instance metadata. Example: `"0.0.0.0/32,192.168.0.0/16"`. Implemented in [#12102](https://github.com/blockscout/blockscout/pull/12102). | Version: v8.0.0+
Default: (empty)
Applications: Indexer | | `INDEXER_TOKEN_INSTANCE_HOST_FILTERING_ENABLED` | If `false`, the URL from which metadata is fetched will not be resolved to an IP address, and the IP address will not be checked against the blacklist. Implemented in [#12102](https://github.com/blockscout/blockscout/pull/12102). | Version: v8.0.0+
Default: `true`
Applications: Indexer | | `INDEXER_TOKEN_INSTANCE_MEDIA_TYPE_BATCH_SIZE` | Number of token instances processed per batch by the media type fetcher, which backfills MIME types (`image_type`, `animation_type`) for NFT instances via HTTP HEAD requests to image/animation URLs from metadata. Implemented in [#14365](https://github.com/blockscout/blockscout/pull/14365). | Version: v12.0.0+
Default: `10`
Applications: Indexer | | `INDEXER_TOKEN_INSTANCE_MEDIA_TYPE_CONCURRENCY` | Max number of concurrent workers resolving media types for token instances. Implemented in [#14365](https://github.com/blockscout/blockscout/pull/14365). | Version: v12.0.0+
Default: `5`
Applications: Indexer | | `INDEXER_TOKEN_INSTANCE_REALTIME_BATCH_SIZE` | Batch size for `realtime` token instance fetcher. Implemented in [#8313](https://github.com/blockscout/blockscout/pull/8313). | Version: v5.2.3+
Default: `1`
Applications: Indexer | | `INDEXER_TOKEN_INSTANCE_REALTIME_CONCURRENCY` | Concurrency for `realtime` token instance fetcher. Implemented in [#7286](https://github.com/blockscout/blockscout/pull/7286). | Version: v5.1.4+
Default: `10`
Applications: Indexer | | `INDEXER_TOKEN_INSTANCE_REALTIME_RETRY_ENABLED` | If `true`, `realtime` token instance fetcher will retry once on 404 and 500 error. Implemented in [#10036](https://github.com/blockscout/blockscout/pull/10036). | Version: v6.6.0+
Default: `false`
Applications: Indexer | | `INDEXER_TOKEN_INSTANCE_REALTIME_RETRY_TIMEOUT` | Timeout for retry set by `INDEXER_TOKEN_INSTANCE_REALTIME_RETRY_ENABLED`. [Time format](/setup/env-variables/backend-env-variables#time-format). Implemented in [#10036](https://github.com/blockscout/blockscout/pull/10036). | Version: v6.6.0+
Default: `5s`
Applications: Indexer | | `INDEXER_TOKEN_INSTANCE_REFETCH_BATCH_SIZE` | Batch size for the Token instance fetcher, which re-fetches NFT collections marked to refetch. Implemented in [#8313](https://github.com/blockscout/blockscout/pull/8313). | Version: v5.2.3+
Default: `10`
Applications: Indexer | | `INDEXER_TOKEN_INSTANCE_REFETCH_CONCURRENCY` | Concurrency for the Token instance fetcher, which re-fetches NFT collections marked to refetch. Implemented in [#10263](https://github.com/blockscout/blockscout/pull/10263). | Version: v5.1.4+
Default: `10`
Applications: Indexer | | `INDEXER_TOKEN_INSTANCE_RETRY_BATCH_SIZE` | Batch size for `retry` token instance fetcher. Implemented in [#8313](https://github.com/blockscout/blockscout/pull/8313) | Version: v5.2.3+
Default: `10`
Applications: Indexer | | `INDEXER_TOKEN_INSTANCE_RETRY_CONCURRENCY` | Concurrency for `retry` token instance fetcher. Implemented in [#7286](https://github.com/blockscout/blockscout/pull/7286). | Version: v5.1.4+
Default: `10`
Applications: Indexer | | `INDEXER_TOKEN_INSTANCE_RETRY_EXPONENTIAL_TIMEOUT_BASE` | Base to calculate exponential timeout. Implemented in [#10027](https://github.com/blockscout/blockscout/pull/10027). | Version: v6.8.0+
Default: `2`
Applications: Indexer | | `INDEXER_TOKEN_INSTANCE_RETRY_EXPONENTIAL_TIMEOUT_COEFF` | Coefficient to calculate exponential timeout. Implemented in [#10027](https://github.com/blockscout/blockscout/pull/10027). | Version: v6.8.0+
Default: `100`
Applications: Indexer | | `INDEXER_TOKEN_INSTANCE_RETRY_MAX_REFETCH_INTERVAL` | Maximum interval between attempts to fetch token instance metadata. [Time format](/setup/env-variables/backend-env-variables#time-format). Implemented in [#10027](https://github.com/blockscout/blockscout/pull/10027). | Version: v6.8.0+
Default: `168h`
Applications: Indexer | | `INDEXER_TOKEN_INSTANCE_SANITIZE_BATCH_SIZE` | Batch size for `sanitize` token instance fetcher. Implemented in [#8313](https://github.com/blockscout/blockscout/pull/8313). | Version: v5.2.3+
Default: `10`
Applications: Indexer | | `INDEXER_TOKEN_INSTANCE_SANITIZE_CONCURRENCY` | Concurrency for `sanitize` token instance fetcher. Implemented in [#7286](https://github.com/blockscout/blockscout/pull/7286). | Version: v5.1.4+
Default: `10`
Applications: Indexer | | `INDEXER_TOKEN_INSTANCE_USE_BASE_URI_RETRY` | If `true`, and request to `tokenURI(tokenId)` failed with `VM execution error`, Blockscout will make request to `baseURI` and try to request metadata from baseURI + tokenId | Version: v6.2.0+
Default: `false`
Applications: Indexer | | `INDEXER_TOKEN_TRANSFER_BLOCK_CONSENSUS_SANITIZER_INTERVAL` | Interval for token transfer block consensus sanitizer. [Time format](/setup/env-variables/backend-env-variables#time-format). Implemented in [#14144](https://github.com/blockscout/blockscout/pull/14144). | Version: v10.2.2+
Default: `20m`
Applications: Indexer | | `INDEXER_CURRENT_TOKEN_BALANCES_BATCH_SIZE` | Batch size for current token balances fetcher. Implemented in [#13923](https://github.com/blockscout/blockscout/pull/13923). | Version: v10.0.0+
Default: `100`
Applications: Indexer | | `INDEXER_CURRENT_TOKEN_BALANCES_CONCURRENCY` | Concurrency for current token balances fetcher. Implemented in [#13923](https://github.com/blockscout/blockscout/pull/13923). | Version: v10.0.0+
Default: `10`
Applications: Indexer | | `INDEXER_CURRENT_TOKEN_BALANCES_IMPORT_CHUNK_SIZE` | Number of CurrentTokenBalances items processed per chunk in token balances import. Default is 50; effective minimum is 1. Implemented in [#14250](https://github.com/blockscout/blockscout/pull/14250). | Version: v11.0.0+
Default: `50`
Applications: Indexer | | `INDEXER_ENABLE_PARTIAL_ASYNC_IMPORT` | If `true`, addresses, current token balances, tokens and token instances are imported asynchronously. Implemented in [#14277](https://github.com/blockscout/blockscout/pull/14277). | Version: v11.1.0+
Default: `false`
Applications: Indexer | | `INDEXER_HANDLE_PARTIALLY_IMPORTED_BLOCK_INTERVAL` | Interval between retrying to set `refetch_needed=true` for blocks whose import failed on some stage in cases when setting `refetch_needed` fails itself. Implemented in [#14597](https://github.com/blockscout/blockscout/pull/14597). | Version: v11.2.3+
Default: `1s`
Applications: Indexer | ## DB Migrations & Sanitizer Management | Variable | Description | Parameters | | - | - | - | | `MIGRATION_SHRINK_INTERNAL_TRANSACTIONS_BATCH_SIZE` | Batch size of the shrink internal transactions migration. *Note*: before release "v6.8.0", the default value was 1000. Implemented in [#10567](https://github.com/blockscout/blockscout/pull/10567), changed default value in [#10689](https://github.com/blockscout/blockscout/pull/10689). Renamed in [#11798](https://github.com/blockscout/blockscout/pull/11798). | Version: v7.0.0+
Default: 100
Applications: API, Indexer | | `MIGRATION_SHRINK_INTERNAL_TRANSACTIONS_CONCURRENCY` | Concurrency of the shrink internal transactions migration. Implemented in [#10567](https://github.com/blockscout/blockscout/pull/10567). Renamed in [#11798](https://github.com/blockscout/blockscout/pull/11798). | Version: v7.0.0+
Default: 10
Applications: API, Indexer | | `MIGRATION_TOKEN_INSTANCE_OWNER_CONCURRENCY` | Concurrency of new fields backfiller implemented in [#8386](https://github.com/blockscout/blockscout/pull/8386). Renamed in [#11798](https://github.com/blockscout/blockscout/pull/11798). | Version: v7.0.0+
Default: `5`
Applications: API, Indexer | | `MIGRATION_TOKEN_INSTANCE_OWNER_BATCH_SIZE` | Batch size of new fields backfiller implemented in [#8386](https://github.com/blockscout/blockscout/pull/8386). Renamed in [#11798](https://github.com/blockscout/blockscout/pull/11798). | Version: v7.0.0+
Default: `50`
Applications: API, Indexer | | `MIGRATION_TOKEN_INSTANCE_OWNER_ENABLED` | Enables backfiller from [#8386](https://github.com/blockscout/blockscout/pull/8386) implemented in [#8752](https://github.com/blockscout/blockscout/pull/8752). Renamed in [#11798](https://github.com/blockscout/blockscout/pull/11798). | Version: v7.0.0+
Default: `false`
Applications: API, Indexer | | `MIGRATION_TRANSACTION_HAS_TOKEN_TRANSFERS_ENABLED` | Enable background migration to backfill `has_token_transfers` for existing transactions. Implemented in [#13428](https://github.com/blockscout/blockscout/pull/13428). | Version: v12.0.0+
Default: `true`
Applications: API, Indexer | | `MIGRATION_TRANSACTION_HAS_TOKEN_TRANSFERS_BATCH_SIZE` | Number of transactions to backfill `has_token_transfers` in the batch. Implemented in [#13428](https://github.com/blockscout/blockscout/pull/13428). | Version: v12.0.0+
Default: `30`
Applications: API, Indexer | | `MIGRATION_TRANSACTION_HAS_TOKEN_TRANSFERS_CONCURRENCY` | Number of parallel backfilling transaction batches processing. Implemented in [#13428](https://github.com/blockscout/blockscout/pull/13428). | Version: v12.0.0+
Default: `5`
Applications: API, Indexer | | `MIGRATION_TRANSACTIONS_TABLE_DENORMALIZATION_BATCH_SIZE` | Number of transactions to denormalize (add block timestamp and consensus) in the batch. Renamed in [#11798](https://github.com/blockscout/blockscout/pull/11798). | Version: v7.0.0+
Default: `500`
Applications: API, Indexer | | `MIGRATION_TRANSACTIONS_TABLE_DENORMALIZATION_CONCURRENCY` | Number of parallel denormalization transaction batches processing. Renamed in [#11798](https://github.com/blockscout/blockscout/pull/11798). | Version: v7.0.0+
Default: `10`
Applications: API, Indexer | | `MIGRATION_TOKEN_TRANSFER_TOKEN_TYPE_BATCH_SIZE` | Number of token transfers to denormalize (add token\_type) in the batch. Renamed in [#11798](https://github.com/blockscout/blockscout/pull/11798). | Version: v7.0.0+
Default: `100`
Applications: API, Indexer | | `MIGRATION_TOKEN_TRANSFER_TOKEN_TYPE_CONCURRENCY` | Number of parallel denormalization token transfer batches processing. Renamed in [#11798](https://github.com/blockscout/blockscout/pull/11798). | Version: v7.0.0+
Default: `1`
Applications: API, Indexer | | `MIGRATION_SANITIZE_INCORRECT_NFT_BATCH_SIZE` | Number of token transfers to sanitize in the batch. Renamed in [#11798](https://github.com/blockscout/blockscout/pull/11798). | Version: v7.0.0+
Default: `100`
Applications: API, Indexer | | `MIGRATION_SANITIZE_INCORRECT_NFT_CONCURRENCY` | Number of parallel sanitizing token transfer batches processing. Renamed in [#11798](https://github.com/blockscout/blockscout/pull/11798). | Version: v7.0.0+
Default: `1`
Applications: API, Indexer | | `MIGRATION_SANITIZE_INCORRECT_NFT_TIMEOUT` | Timeout between sanitizing token transfer batches processing. Implemented in [#11358](https://github.com/blockscout/blockscout/pull/11358). Renamed in [#11798](https://github.com/blockscout/blockscout/pull/11798). | Version: v7.0.0+
Default: `0`
Applications: API, Indexer | | `MIGRATION_SANITIZE_INCORRECT_WETH_BATCH_SIZE` | Number of token transfers to sanitize in the batch. Implemented in [#10134](https://github.com/blockscout/blockscout/pull/10134). Renamed in [#11798](https://github.com/blockscout/blockscout/pull/11798). | Version: v7.0.0+
Default: `100`
Applications: API, Indexer | | `MIGRATION_SANITIZE_INCORRECT_WETH_CONCURRENCY` | Number of parallel sanitizing token transfer batches processing. Implemented in [#10134](https://github.com/blockscout/blockscout/pull/10134). Renamed in [#11798](https://github.com/blockscout/blockscout/pull/11798). | Version: v7.0.0+
Default: `1`
Applications: API, Indexer | | `MIGRATION_SANITIZE_INCORRECT_WETH_TIMEOUT` | Timeout between sanitizing token transfer batches processing. Implemented in [#11358](https://github.com/blockscout/blockscout/pull/11358). Renamed in [#11798](https://github.com/blockscout/blockscout/pull/11798). | Version: v7.0.0+
Default: `0`
Applications: API, Indexer | | `MIGRATION_REINDEX_INTERNAL_TRANSACTIONS_STATUS_BATCH_SIZE` | Number of internal transactions to reindex in the batch. Implemented in [#11358](https://github.com/blockscout/blockscout/pull/11358). Renamed in [#11798](https://github.com/blockscout/blockscout/pull/11798). | Version: v7.0.0+
Default: `100`
Applications: API, Indexer | | `MIGRATION_REINDEX_INTERNAL_TRANSACTIONS_STATUS_CONCURRENCY` | Number of parallel reindexing internal transaction batches processing. Implemented in [#11358](https://github.com/blockscout/blockscout/pull/11358). Renamed in [#11798](https://github.com/blockscout/blockscout/pull/11798). | Version: v7.0.0+
Default: `1`
Applications: API, Indexer | | `MIGRATION_REINDEX_INTERNAL_TRANSACTIONS_STATUS_TIMEOUT` | Timeout between reindexing internal transaction batches processing. Implemented in [#11358](https://github.com/blockscout/blockscout/pull/11358). Renamed in [#11798](https://github.com/blockscout/blockscout/pull/11798). | Version: v7.0.0+
Default: `0`
Applications: API, Indexer | | `MIGRATION_REINDEX_BLOCKS_WITH_MISSING_TRANSACTIONS_BATCH_SIZE` | Number of blocks to reindex in the batch. Implemented in [#12559](https://github.com/blockscout/blockscout/pull/12559). | Version: v9.0.0+
Default: `10`
Applications: Indexer | | `MIGRATION_REINDEX_BLOCKS_WITH_MISSING_TRANSACTIONS_CONCURRENCY` | Number of parallel reindexing block batches processing. Implemented in [#12559](https://github.com/blockscout/blockscout/pull/12559). | Version: v9.0.0+
Default: `1`
Applications: Indexer | | `MIGRATION_REINDEX_BLOCKS_WITH_MISSING_TRANSACTIONS_TIMEOUT` | Timeout between reindexing block batches processing. Implemented in [#12559](https://github.com/blockscout/blockscout/pull/12559). | Version: v9.0.0+
Default: `0`
Applications: Indexer | | `MIGRATION_REINDEX_BLOCKS_WITH_MISSING_TRANSACTIONS_ENABLED` | Enable reindex blocks with missing transactions migration. Implemented in [#12559](https://github.com/blockscout/blockscout/pull/12559). | Version: v9.0.0+
Default: `false`
Applications: Indexer | | `MIGRATION_RESTORE_OMITTED_WETH_TOKEN_TRANSFERS_BATCH_SIZE` | Number of logs to process in the batch. Implemented in [#10466](https://github.com/blockscout/blockscout/pull/10466) | Version: v6.8.0+
Default: `50`
Applications: API, Indexer | | `MIGRATION_RESTORE_OMITTED_WETH_TOKEN_TRANSFERS_CONCURRENCY` | Number of parallel logs batches processing. Implemented in [#10466](https://github.com/blockscout/blockscout/pull/10466) | Version: v6.8.0+
Default: `5`
Applications: API, Indexer | | `MIGRATION_RESTORE_OMITTED_WETH_TOKEN_TRANSFERS_TIMEOUT` | Time interval between checks if queue is not empty. The same timeout multiplied by 2 is used between checks if queue is not full. Implemented in [#10466](https://github.com/blockscout/blockscout/pull/10466) | Version: v6.8.0+
Default: `250ms`
Applications: API, Indexer | | `MIGRATION_SANITIZE_DUPLICATED_LOG_INDEX_LOGS_BATCH_SIZE` | Number of logs to process in the batch. Implemented in [#11055](https://github.com/blockscout/blockscout/pull/11055) | Version: v6.9.0+
Default: `500`
Applications: API, Indexer | | `MIGRATION_SANITIZE_DUPLICATED_LOG_INDEX_LOGS_CONCURRENCY` | Number of parallel logs batches processing. Implemented in [#11055](https://github.com/blockscout/blockscout/pull/11055) | Version: v6.9.0+
Default: `10`
Applications: API, Indexer | | `MIGRATION_REFETCH_CONTRACT_CODES_BATCH_SIZE` | Number of addresses to process in the batch. Implemented in [#11055](https://github.com/blockscout/blockscout/pull/11055) | Version: v6.9.0+
Default: `100`
Applications: API, Indexer | | `MIGRATION_REFETCH_CONTRACT_CODES_CONCURRENCY` | Number of parallel addresses batches processing. Implemented in [#11055](https://github.com/blockscout/blockscout/pull/11055) | Version: v6.9.0+
Default: `5`
Applications: API, Indexer | | `MIGRATION_SANITIZE_VERIFIED_ADDRESSES_DISABLED` | Controls whether the migration that sanitizes verified addresses is disabled. If set to `true`, the migration will not run; if set to `false`, the migration will proceed. Implemented in [#11727](https://github.com/blockscout/blockscout/pull/11727). | Version: v7.0.0+
Default: `false`
Applications: API, Indexer | | `MIGRATION_SANITIZE_VERIFIED_ADDRESSES_BATCH_SIZE` | Specifies the number of addresses to process in each batch during the sanitize verified addresses migration. Implemented in [#11727](https://github.com/blockscout/blockscout/pull/11727). | Version: v7.0.0+
Default: `500`
Applications: API, Indexer | | `MIGRATION_SANITIZE_VERIFIED_ADDRESSES_CONCURRENCY` | Determines how many concurrent processes will be used during the sanitize verified addresses migration. Implemented in [#11727](https://github.com/blockscout/blockscout/pull/11727). | Version: v7.0.0+
Default: `1`
Applications: API, Indexer | | `MIGRATION_SANITIZE_VERIFIED_ADDRESSES_TIMEOUT` | Defines the timeout before processing each batch in the sanitize verified addresses migration. Follows the [time format](/setup/env-variables/backend-env-variables#time-format). Implemented in [#11727](https://github.com/blockscout/blockscout/pull/11727). | Version: v7.0.0+
Default: `0s`
Applications: API, Indexer | | `MIGRATION_HEAVY_INDEX_OPERATIONS_CHECK_INTERVAL` | Interval between status checks of heavy db operation like index creation or dropping. [Time format](/setup/env-variables/backend-env-variables#time-format). Implemented in [#11604](https://github.com/blockscout/blockscout/pull/11604) | Version: v7.0.0+
Default: `10m`
Applications: API, Indexer | | `MIGRATION_TOKEN_INSTANCE_ERC_1155_SANITIZE_CONCURRENCY` | Concurrency for `erc-1155-sanitize` token instance fetcher. Implemented in [#9226](https://github.com/blockscout/blockscout/pull/9226). Default value and name changed in [#11543](https://github.com/blockscout/blockscout/pull/11543) | Version: v7.0.0+
Default: `1`
Applications: Indexer | | `MIGRATION_TOKEN_INSTANCE_ERC_721_SANITIZE_CONCURRENCY` | Concurrency for `erc-721-sanitize` token instance fetcher. Implemented in [#9226](https://github.com/blockscout/blockscout/pull/9226). Name changed in [#11543](https://github.com/blockscout/blockscout/pull/11543) | Version: v7.0.0+
Default: `2`
Applications: Indexer | | `MIGRATION_TOKEN_INSTANCE_ERC_1155_SANITIZE_BATCH_SIZE` | Batch size for `erc-1155-sanitize` token instance fetcher. Implemented in [#9226](https://github.com/blockscout/blockscout/pull/9226). Default value and name changed in [#11543](https://github.com/blockscout/blockscout/pull/11543) | Version: v7.0.0+
Default: `500`
Applications: Indexer | | `MIGRATION_TOKEN_INSTANCE_ERC_721_SANITIZE_BATCH_SIZE` | Batch size for `erc-721-sanitize` token instance fetcher. Implemented in [#9226](https://github.com/blockscout/blockscout/pull/9226). Default value and name changed in [#11543](https://github.com/blockscout/blockscout/pull/11543) | Version: v7.0.0+
Default: `50`
Applications: Indexer | | `MIGRATION_TOKEN_INSTANCE_ERC_721_SANITIZE_TOKENS_BATCH_SIZE` | Tokens batch size for `erc-721-sanitize` token instance fetcher. Implemented in [#9226](https://github.com/blockscout/blockscout/pull/9226). Name changed in [#11543](https://github.com/blockscout/blockscout/pull/11543) | Version: v7.0.0+
Default: `100`
Applications: Indexer | | `MIGRATION_BACKFILL_METADATA_URL_DISABLED` | If set to `true`, the backfiller of `metadata_url` field in the `token_instances` table will not start. If set to `false`, the migration proceeds as normal. Implemented in [#12102](https://github.com/blockscout/blockscout/pull/12102). | Version: v8.0.0+
Default: `false`
Applications: Indexer | | `MIGRATION_BACKFILL_METADATA_URL_BATCH_SIZE` | Defines the number of records to be processed in each batch when backfilling the `metadata_url` field in the `token_instances` table. Implemented in [#12102](https://github.com/blockscout/blockscout/pull/12102). | Version: v8.0.0+
Default: `100`
Applications: Indexer | | `MIGRATION_BACKFILL_METADATA_URL_CONCURRENCY` | Specifies how many concurrent processes can handle the `metadata_url` field backfilling. Implemented in [#12102](https://github.com/blockscout/blockscout/pull/12102). | Version: v8.0.0+
Default: `5`
Applications: Indexer | | `MIGRATION_RECOVERY_WETH_TOKEN_TRANSFERS_CONCURRENCY` | Specifies how many concurrent processes can handle the recovery WETH token transfers migration. Implemented in [#12065](https://github.com/blockscout/blockscout/pull/12065). | Version: v8.0.0+
Default: `5`
Applications: Indexer | | `MIGRATION_RECOVERY_WETH_TOKEN_TRANSFERS_BATCH_SIZE` | Defines the number of records to be processed in each batch when recovering WETH token transfers. Implemented in [#12065](https://github.com/blockscout/blockscout/pull/12065). | Version: v8.0.0+
Default: `50`
Applications: Indexer | | `MIGRATION_RECOVERY_WETH_TOKEN_TRANSFERS_TIMEOUT` | Defines the timeout between processing each batch (`batch_size` \* `concurrency`) in the recovery WETH token transfers migration. Follows the [time format](/setup/env-variables/backend-env-variables#time-format). Implemented in [#12065](https://github.com/blockscout/blockscout/pull/12065). | Version: v8.0.0+
Default: `0s`
Applications: Indexer | | `MIGRATION_RECOVERY_WETH_TOKEN_TRANSFERS_BLOCKS_BATCH_SIZE` | Specifies the block range size selected for the recovery of WETH token transfer migration. Implemented in [#12065](https://github.com/blockscout/blockscout/pull/12065). | Version: v8.0.0+
Default: `100000`
Applications: Indexer | | `MIGRATION_RECOVERY_WETH_TOKEN_TRANSFERS_HIGH_VERBOSITY` | If set to `true`, enables high verbosity logging (logs each transaction hash, where missed transfers were restored) during the recovery of WETH token transfer migration. Implemented in [#12065](https://github.com/blockscout/blockscout/pull/12065). | Version: v8.0.0+
Default: `true`
Applications: Indexer | | `MIGRATION_MERGE_ADJACENT_MISSING_BLOCK_RANGES_BATCH_SIZE` | Specifies the missing block range batch size selected for the merge migration. Implemented in [#12778](https://github.com/blockscout/blockscout/pull/12778). | Version: v9.0.0+
Default: `100`
Applications: Indexer | | `MIGRATION_DELETE_ZERO_VALUE_INTERNAL_TRANSACTIONS_ENABLED` | Enables delete zero-value calls migration. Implemented in [#13305](https://github.com/blockscout/blockscout/pull/13305). | Version: v9.3.0+
Default: `false`
Applications: Indexer | | `MIGRATION_DELETE_ZERO_VALUE_INTERNAL_TRANSACTIONS_BATCH_SIZE` | Specifies the block batch size selected for the delete zero-value calls migration. Implemented in [#13305](https://github.com/blockscout/blockscout/pull/13305). | Version: v9.3.0+
Default: `100`
Applications: Indexer | | `MIGRATION_DELETE_ZERO_VALUE_INTERNAL_TRANSACTIONS_STORAGE_PERIOD` | Specifies the period for which recent zero-value calls won't be deleted in delete zero-value calls migration. Implemented in [#13932](https://github.com/blockscout/blockscout/pull/13932). | Version: v9.3.3+
Default: `30d`
Applications: Indexer | | `MIGRATION_DELETE_ZERO_VALUE_INTERNAL_TRANSACTIONS_CHECK_INTERVAL` | Specifies the interval between checking of new zero-value calls to be deleted in delete zero-value calls migration. Implemented in [#13305](https://github.com/blockscout/blockscout/pull/13305). | Version: v9.3.0+
Default: `1m`
Applications: Indexer | | `MIGRATION_EMPTY_INTERNAL_TRANSACTIONS_DATA_BATCH_SIZE` | Number of internal transactions to clear their data in the batch. Implemented in [#13893](https://github.com/blockscout/blockscout/pull/13893). | Version: v10.0.0+
Default: `1000`
Applications: Indexer | | `MIGRATION_EMPTY_INTERNAL_TRANSACTIONS_DATA_CONCURRENCY` | Number of parallel clearing internal transaction data batches processing. Implemented in [#13893](https://github.com/blockscout/blockscout/pull/13893). | Version: v10.0.0+
Default: `1`
Applications: Indexer | | `MIGRATION_EMPTY_INTERNAL_TRANSACTIONS_DATA_TIMEOUT` | Timeout between clearing internal transaction data batches processing. Implemented in [#13893](https://github.com/blockscout/blockscout/pull/13893). | Version: v10.0.0+
Default: `0`
Applications: Indexer | | `MIGRATION_FILL_INTERNAL_TRANSACTIONS_ADDRESS_IDS_BATCH_SIZE` | Number of internal transactions to fill their address ids in the batch. Implemented in [#14204](https://github.com/blockscout/blockscout/pull/14204). | Version: v11.0.0+
Default: `30`
Applications: Indexer | | `MIGRATION_FILL_INTERNAL_TRANSACTIONS_ADDRESS_IDS_CONCURRENCY` | Number of parallel processes filling internal transactions address ids. Implemented in [#14390](https://github.com/blockscout/blockscout/pull/14390). | Version: v11.1.0+
Default: `10`
Applications: Indexer | | `MIGRATION_FILL_INTERNAL_TRANSACTIONS_ADDRESS_IDS_TIMEOUT` | Timeout between filling internal transactions address ids batches processing. Implemented in [#14208](https://github.com/blockscout/blockscout/pull/14208). | Version: v11.0.0+
Default: `5s`
Applications: Indexer | | `MIGRATION_FILL_LOGS_OPTIMIZED_FIELDS_BATCH_SIZE` | Number of logs to fill their address ids, first topic ids, transaction indexes and trimmed topics in the batch. Implemented in [#14494](https://github.com/blockscout/blockscout/pull/14494). | Version: v12.0.0+
Default: `30`
Applications: Indexer | | `MIGRATION_FILL_LOGS_OPTIMIZED_FIELDS_CONCURRENCY` | Number of parallel processes filling logs address ids, first topic ids, transaction indexes and trimmed topics. Implemented in [#14494](https://github.com/blockscout/blockscout/pull/14494). | Version: v12.0.0+
Default: `5`
Applications: Indexer | | `MIGRATION_FILL_LOGS_OPTIMIZED_FIELDS_TIMEOUT` | Timeout between filling logs address ids, first topic ids, transaction indexes and trimmed topics batches processing. Implemented in [#14494](https://github.com/blockscout/blockscout/pull/14494). | Version: v12.0.0+
Default: `5s`
Applications: Indexer | | `MIGRATION_FILL_LOGS_COMPRESSED_DATA_BATCH_SIZE` | Number of logs to fill their compressed data in the batch. Implemented in [#14526](https://github.com/blockscout/blockscout/pull/14526). | Version: v12.0.0+
Default: `5000`
Applications: Indexer | | `MIGRATION_FILL_LOGS_COMPRESSED_DATA_CONCURRENCY` | Number of parallel processes filling logs compressed data. Implemented in [#14526](https://github.com/blockscout/blockscout/pull/14526). | Version: v12.0.0+
Default: `10`
Applications: Indexer | | `MIGRATION_FILL_LOGS_COMPRESSED_DATA_TIMEOUT` | Timeout between filling logs compressed data batches processing. Implemented in [#14526](https://github.com/blockscout/blockscout/pull/14526). | Version: v12.0.0+
Default: `1s`
Applications: Indexer | | `MIGRATION_BACKFILL_ADDRESS_COUNTERS_DISABLED` | If `true`, the backfill migration that recomputes address counters from scratch is disabled. Implemented in [#14759](https://github.com/blockscout/blockscout/pull/14759). | Version: v11.3.0+
Default: `false`
Applications: Indexer | | `MIGRATION_BACKFILL_ADDRESS_COUNTERS_BATCH_SIZE` | Number of addresses to process in each batch during address counters backfill migration. Implemented in [#14759](https://github.com/blockscout/blockscout/pull/14759). | Version: v11.3.0+
Default: `10`
Applications: Indexer | | `MIGRATION_BACKFILL_ADDRESS_COUNTERS_CONCURRENCY` | Number of parallel processes for address counters backfill migration. Implemented in [#14759](https://github.com/blockscout/blockscout/pull/14759). | Version: v11.3.0+
Default: `2`
Applications: Indexer | | `MIGRATION_BACKFILL_ADDRESS_COUNTERS_TIMEOUT` | Timeout between address counters backfill batches processing. Implemented in [#14759](https://github.com/blockscout/blockscout/pull/14759). | Version: v11.3.0+
Default: `0s`
Applications: Indexer | | `MIGRATION_BACKFILL_TOKEN_COUNTERS_DISABLED` | If `true`, the backfill migration that recalculates token counters from scratch is disabled. Implemented in [#14773](https://github.com/blockscout/blockscout/pull/14773). | Version: v11.3.0+
Default: `false`
Applications: Indexer | | `MIGRATION_BACKFILL_TOKEN_COUNTERS_BATCH_SIZE` | Number of tokens to process in each batch during token counters backfill migration. Implemented in [#14773](https://github.com/blockscout/blockscout/pull/14773). | Version: v11.3.0+
Default: `50`
Applications: Indexer | | `MIGRATION_BACKFILL_TOKEN_COUNTERS_CONCURRENCY` | Number of parallel processes for token counters backfill migration. Implemented in [#14773](https://github.com/blockscout/blockscout/pull/14773). | Version: v11.3.0+
Default: `4`
Applications: Indexer | | `MIGRATION_BACKFILL_TOKEN_COUNTERS_TIMEOUT` | Timeout between token counters backfill batches processing. Implemented in [#14773](https://github.com/blockscout/blockscout/pull/14773). | Version: v11.3.0+
Default: `0s`
Applications: Indexer | | `MIGRATION_REINDEX_BLOCKS_WITH_UNCATALOGED_TOKEN_TRANSFERS_BATCH_SIZE` | Number of blocks to reindex in the batch. Implemented in [#14774](https://github.com/blockscout/blockscout/pull/14774). | Version: v11.3.0+
Default: `1000`
Applications: Indexer | | `MIGRATION_REINDEX_BLOCKS_WITH_UNCATALOGED_TOKEN_TRANSFERS_CONCURRENCY` | Number of parallel reindexing block batches processing. Implemented in [#14774](https://github.com/blockscout/blockscout/pull/14774). | Version: v11.3.0+
Default: `1`
Applications: Indexer | | `MIGRATION_REINDEX_BLOCKS_WITH_UNCATALOGED_TOKEN_TRANSFERS_TIMEOUT` | Timeout between reindexing block batches processing. Implemented in [#14774](https://github.com/blockscout/blockscout/pull/14774). | Version: v11.3.0+
Default: `0s`
Applications: Indexer | | `MIGRATION_BACKFILL_SCALED_UI_AMOUNT_TOKENS_BATCH_SIZE` | ERC-8056-related. Number of logs to backfill scaled UI amount from in the batch. Implemented in [#14731](https://github.com/blockscout/blockscout/pull/14731). | Version: v12.0.0+
Default: `100`
Applications: Indexer | | `MIGRATION_BACKFILL_SCALED_UI_AMOUNT_TOKENS_CONCURRENCY` | ERC-8056-related. Number of parallel processes backfilling scaled UI amount from logs. Implemented in [#14731](https://github.com/blockscout/blockscout/pull/14731). | Version: v12.0.0+
Default: `1`
Applications: Indexer | | `MIGRATION_SANITIZE_SCALED_UI_AMOUNT_TOKEN_TRANSFER_TYPES_BATCH_SIZE` | ERC-8056-related. Number of token transfers to sanitize their token type in batch. Implemented in [#14731](https://github.com/blockscout/blockscout/pull/14731). | Version: v12.0.0+
Default: `100`
Applications: Indexer | | `MIGRATION_SANITIZE_SCALED_UI_AMOUNT_TOKEN_TRANSFER_TYPES_CONCURRENCY` | ERC-8056-related. Number of parallel processes sanitizing token types. Implemented in [#14731](https://github.com/blockscout/blockscout/pull/14731). | Version: v12.0.0+
Default: `1`
Applications: Indexer | | `MIGRATION_REINDEX_BLOCKS_WITH_STALE_INTERNAL_TRANSACTIONS_BATCH_SIZE` | Number of blocks to reindex in the batch. Implemented in [#14884](https://github.com/blockscout/blockscout/pull/14884). | Version: v11.3.3+
Default: `1000`
Applications: Indexer | | `MIGRATION_REINDEX_BLOCKS_WITH_STALE_INTERNAL_TRANSACTIONS_CONCURRENCY` | Number of parallel reindexing block batches processing. Implemented in [#14884](https://github.com/blockscout/blockscout/pull/14884). | Version: v11.3.3+
Default: `1`
Applications: Indexer | | `MIGRATION_REINDEX_BLOCKS_WITH_STALE_INTERNAL_TRANSACTIONS_TIMEOUT` | Timeout between reindexing block batches processing. Implemented in [#14884](https://github.com/blockscout/blockscout/pull/14884). | Version: v11.3.3+
Default: `0s`
Applications: Indexer | | `MIGRATION_DELETE_NON_CONSENSUS_LOGS_BATCH_SIZE` | Number of blocks to delete non-consensus logs from in the batch. Implemented in [#14927](https://github.com/blockscout/blockscout/pull/14927). | Version: v12.0.1+
Default: `100`
Applications: Indexer | | `MIGRATION_DELETE_NON_CONSENSUS_LOGS_CONCURRENCY` | Number of parallel deleting log batches processing. Implemented in [#14927](https://github.com/blockscout/blockscout/pull/14927). | Version: v12.0.1+
Default: `10`
Applications: Indexer | | `MIGRATION_DELETE_NON_CONSENSUS_LOGS_TIMEOUT` | Timeout between deleting log batches processing. Implemented in [#14927](https://github.com/blockscout/blockscout/pull/14927). | Version: v12.0.1+
Default: `0s`
Applications: Indexer | ## Market | Variable | Description | Parameters | | - | - | - | | `DISABLE_MARKET` | Disables all fetchers and any market data displaying. Setting this to `true` will disable all market-related functionality. Implemented in [#11844](https://github.com/blockscout/blockscout/pull/11844). | Version: v8.0.0+
Default: `false`
Applications: API, Indexer | | `MARKET_NATIVE_COIN_SOURCE` | Source for realtime native coin price fetching. Possible values are: `coin_gecko`, `coin_market_cap`, `crypto_rank`, `mobula` and `dia`. Useful when multiple coin IDs are configured and you want to explicitly select the source. Implemented in [#11844](https://github.com/blockscout/blockscout/pull/11844). | Version: v8.0.0+
Default: `coin_gecko`
Applications: API | | `MARKET_SECONDARY_COIN_SOURCE` | Source for realtime secondary coin fetching. Possible values are: `coin_gecko`, `coin_market_cap`, `crypto_rank`, `mobula` and `dia`. Useful when multiple secondary coin IDs are configured. Implemented in [#11844](https://github.com/blockscout/blockscout/pull/11844). | Version: v8.0.0+
Default: `coin_gecko`
Applications: API | | `MARKET_TOKENS_SOURCE` | Sets the source for tokens price fetching. Available values are `coin_gecko`, `crypto_rank`, `mobula`, `dia`. Implemented in [#11844](https://github.com/blockscout/blockscout/pull/11844). | Version: v8.0.0+
Default: `coin_gecko`
Applications: Indexer | | `MARKET_NATIVE_COIN_HISTORY_SOURCE` | Sets the source for native coin price history fetching. Available values are `crypto_compare`, `coin_gecko`, `mobula`, `coin_market_cap`, `crypto_rank` and `dia`. When unset, the source is auto-detected; CoinGecko is preferred when `MARKET_COINGECKO_COIN_ID` is configured, and CryptoCompare remains the fallback when no CoinGecko or CoinMarketCap coin ID is configured. Set to `crypto_compare` to keep using CryptoCompare. Behavior changed in v12.0.1. Implemented in [#14928](https://github.com/blockscout/blockscout/pull/14928). | Version: v8.0.0+
Default: auto-detected
Applications: Indexer | | `MARKET_SECONDARY_COIN_HISTORY_SOURCE` | Sets the source for secondary coin price history fetching. Available values are `crypto_compare`, `coin_gecko`, `mobula`, `coin_market_cap`, `crypto_rank` and `dia`. When unset, the source is auto-detected; CoinGecko is preferred when `MARKET_COINGECKO_SECONDARY_COIN_ID` is configured, and CryptoCompare remains the fallback when no CoinGecko or CoinMarketCap coin ID is configured. Set to `crypto_compare` to keep using CryptoCompare. Behavior changed in v12.0.1. Implemented in [#14928](https://github.com/blockscout/blockscout/pull/14928). | Version: v8.0.0+
Default: auto-detected
Applications: Indexer | | `MARKET_MARKET_CAP_HISTORY_SOURCE` | Sets the source for market cap history fetching. Available values are `coin_gecko` and `coin_market_cap`. Implemented in [#11844](https://github.com/blockscout/blockscout/pull/11844). | Version: v8.0.0+
Default: `coin_gecko`
Applications: Indexer | | `MARKET_TVL_HISTORY_SOURCE` | Sets the source for TVL history fetching. Available value is `defillama`. Implemented in [#11844](https://github.com/blockscout/blockscout/pull/11844). | Version: v8.0.0+
Default: `defillama`
Applications: Indexer | | `MARKET_COINGECKO_PLATFORM_ID` | [CoinGecko](https://www.coingecko.com/) platform id for which token prices are fetched, see full list in [`/asset_platforms`](https://api.coingecko.com/api/v3/asset_platforms) endpoint. Examples: "ethereum", "optimistic-ethereum". Implemented in [#11844](https://github.com/blockscout/blockscout/pull/11844). | Version: v8.0.0+
Default: `ethereum`
Applications: Indexer | | `MARKET_COINGECKO_BASE_URL` | If set, overrides the Coingecko base URL. Implemented in [#11844](https://github.com/blockscout/blockscout/pull/11844). | Version: v8.0.0+
Default: `https://api.coingecko.com/api/v3`
Applications: API, Indexer | | `MARKET_COINGECKO_BASE_PRO_URL` | If set, overrides the Coingecko Pro base URL. Implemented in [#11844](https://github.com/blockscout/blockscout/pull/11844). | Version: v8.0.0+
Default: `https://pro-api.coingecko.com/api/v3`
Applications: API, Indexer | | `MARKET_COINGECKO_API_KEY` | CoinGecko API key. Implemented in [#11844](https://github.com/blockscout/blockscout/pull/11844). | Version: v8.0.0+
Default: (empty)
Applications: API, Indexer | | `MARKET_COINGECKO_COIN_ID` | Sets CoinGecko coin ID. Implemented in [#11844](https://github.com/blockscout/blockscout/pull/11844). | Version: v8.0.0+
Default: (empty)
Applications: API, Indexer | | `MARKET_COINGECKO_SECONDARY_COIN_ID` | Sets CoinGecko coin ID for secondary coin market chart. Implemented in [#11844](https://github.com/blockscout/blockscout/pull/11844). | Version: v8.0.0+
Default: (empty)
Applications: API, Indexer | | `MARKET_COINMARKETCAP_BASE_URL` | If set, overrides the CoinMarketCap base URL (Free and Pro). Implemented in [#11844](https://github.com/blockscout/blockscout/pull/11844). | Version: v8.0.0+
Default: `https://pro-api.coinmarketcap.com/v2`
Applications: API, Indexer | | `MARKET_COINMARKETCAP_API_KEY` | CoinMarketCap API key. Implemented in [#11844](https://github.com/blockscout/blockscout/pull/11844). | Version: v8.0.0+
Default: (empty)
Applications: API, Indexer | | `MARKET_COINMARKETCAP_COIN_ID` | CoinMarketCap coin id. Implemented in [#11844](https://github.com/blockscout/blockscout/pull/11844). | Version: v8.0.0+
Default: (empty)
Applications: API, Indexer | | `MARKET_COINMARKETCAP_SECONDARY_COIN_ID` | CoinMarketCap coin id for secondary coin. Implemented in [#11844](https://github.com/blockscout/blockscout/pull/11844). | Version: v8.0.0+
Default: (empty)
Applications: API, Indexer | | `MARKET_CRYPTOCOMPARE_BASE_URL` | If set, overrides the CryptoCompare base URL. Implemented in [#11844](https://github.com/blockscout/blockscout/pull/11844). | Version: v8.0.0+
Default: `https://min-api.cryptocompare.com`
Applications: API, Indexer | | `MARKET_CRYPTOCOMPARE_API_KEY` | CryptoCompare API key. If set to a non-empty value, it is sent in the `Authorization: Apikey {key}` request header. If unset or empty, no authorization header is added. Implemented in [#14746](https://github.com/blockscout/blockscout/pull/14746). | Version: v11.3.0+
Default: (empty)
Applications: API, Indexer | | `MARKET_CRYPTOCOMPARE_COIN_SYMBOL` | CryptoCompare coin symbol for native coin (e.g., "OP" for Optimism). CryptoCompare uses symbols instead of IDs. Implemented in [#11844](https://github.com/blockscout/blockscout/pull/11844). | Version: v8.0.0+
Default: (empty)
Applications: Indexer | | `MARKET_CRYPTOCOMPARE_SECONDARY_COIN_SYMBOL` | CryptoCompare coin symbol for secondary coin market chart. Implemented in [#11844](https://github.com/blockscout/blockscout/pull/11844). | Version: v8.0.0+
Default: (empty)
Applications: Indexer | | `MARKET_CRYPTORANK_PLATFORM_ID` | Sets Cryptorank platform ID. Implemented in [#11844](https://github.com/blockscout/blockscout/pull/11844). | Version: v8.0.0+
Default: (empty)
Applications: Indexer | | `MARKET_CRYPTORANK_BASE_URL` | If set, overrides the Cryptorank API url. Implemented in [#11844](https://github.com/blockscout/blockscout/pull/11844). | Version: v8.0.0+
Default: `https://api.cryptorank.io/v1/`
Applications: API, Indexer | | `MARKET_CRYPTORANK_API_KEY` | Cryptorank API key. Implemented in [#11844](https://github.com/blockscout/blockscout/pull/11844). | Version: v8.0.0+
Default: (empty)
Applications: API, Indexer | | `MARKET_CRYPTORANK_COIN_ID` | Sets Cryptorank coin ID. Implemented in [#11844](https://github.com/blockscout/blockscout/pull/11844). | Version: v8.0.0+
Default: (empty)
Applications: API, Indexer | | `MARKET_CRYPTORANK_SECONDARY_COIN_ID` | Sets Cryptorank coin ID for secondary coin. Implemented in [#11844](https://github.com/blockscout/blockscout/pull/11844). | Version: v8.0.0+
Default: (empty)
Applications: API, Indexer | | `MARKET_DEFILLAMA_COIN_ID` | DefiLlama coin id. Use the `name` field from the `/v2/chains` endpoint response (e.g., "OP Mainnet" for Optimism). Implemented in [#11844](https://github.com/blockscout/blockscout/pull/11844). | Version: v8.0.0+
Default: (empty)
Applications: Indexer | | `MARKET_MOBULA_PLATFORM_ID` | Mobula platform ID. Implemented in [#11844](https://github.com/blockscout/blockscout/pull/11844). | Version: v8.0.0+
Default: (empty)
Applications: Indexer | | `MARKET_MOBULA_BASE_URL` | If set, overrides the Mobula API base URL. Implemented in [#11844](https://github.com/blockscout/blockscout/pull/11844). | Version: v8.0.0+
Default: `https://api.mobula.io/api/1`
Applications: API, Indexer | | `MARKET_MOBULA_API_KEY` | Mobula API key. Implemented in [#11844](https://github.com/blockscout/blockscout/pull/11844). | Version: v8.0.0+
Default: (empty)
Applications: API, Indexer | | `MARKET_MOBULA_COIN_ID` | Set Mobula coin ID. Implemented in [#11844](https://github.com/blockscout/blockscout/pull/11844). | Version: v8.0.0+
Default: (empty)
Applications: API, Indexer | | `MARKET_MOBULA_SECONDARY_COIN_ID` | Set Mobula coin ID for secondary coin. Implemented in [#11844](https://github.com/blockscout/blockscout/pull/11844). | Version: v8.0.0+
Default: (empty)
Applications: API, Indexer | | `MARKET_COIN_FETCHER_ENABLED` | If `false` disables fetching of realtime native coin price. Implemented in [#11844](https://github.com/blockscout/blockscout/pull/11844). | Version: v8.0.0+
Default: `true`
Applications: API | | `MARKET_COIN_CACHE_PERIOD` | Cache period for coin exchange rates. Implemented in [#11844](https://github.com/blockscout/blockscout/pull/11844). | Version: v8.0.0+
Default: `10m`
Applications: API | | `MARKET_TOKENS_FETCHER_ENABLED` | If `false` disables fetching of token prices. Implemented in [#11844](https://github.com/blockscout/blockscout/pull/11844). | Version: v8.0.0+
Default: `true`
Applications: Indexer | | `MARKET_TOKENS_INTERVAL` | Interval between batch requests of token prices. Can be decreased in order to fetch prices faster if you have pro rate limit. [Time format](/setup/env-variables/backend-env-variables#time-format). Implemented in [#11844](https://github.com/blockscout/blockscout/pull/11844). | Version: v8.0.0+
Default: `10s`
Applications: Indexer | | `MARKET_TOKENS_REFETCH_INTERVAL` | Interval between refetching token prices, responsible for the relevance of prices. [Time format](/setup/env-variables/backend-env-variables#time-format). Implemented in [#11844](https://github.com/blockscout/blockscout/pull/11844). | Version: v8.0.0+
Default: `1h`
Applications: Indexer | | `MARKET_TOKENS_MAX_BATCH_SIZE` | Batch size of a single token price request. Implemented in [#11844](https://github.com/blockscout/blockscout/pull/11844). | Version: v8.0.0+
Default: `500`
Applications: Indexer | | `MARKET_HISTORY_FETCHER_ENABLED` | If `false` disables fetching of market data history. Implemented in [#11844](https://github.com/blockscout/blockscout/pull/11844). | Version: v8.0.0+
Default: `true`
Applications: Indexer | | `MARKET_HISTORY_FETCH_INTERVAL` | Interval to update data for the last day in the market history table. Introduced in [#9197](https://github.com/blockscout/blockscout/pull/9197). | Version: v6.1.0+
Default: `1h`
Applications: API, Indexer | | `MARKET_HISTORY_FIRST_FETCH_DAY_COUNT` | Initial number of days to fetch for market history. Implemented in [#11844](https://github.com/blockscout/blockscout/pull/11844). | Version: v8.0.0+
Default: `365`
Applications: Indexer | | `MARKET_DIA_BLOCKCHAIN` | Sets DIA platform from [https://www.diadata.org/docs/reference/apis/token-prices/api-endpoints/blockchains](https://www.diadata.org/docs/reference/apis/token-prices/api-endpoints/blockchains). Implemented in [#12678](https://github.com/blockscout/blockscout/pull/12678). | Version: v9.3.0+
Default: (empty)
Applications: Indexer | | `MARKET_DIA_BASE_URL` | If set, overrides the DIA API url. Implemented in [#12678](https://github.com/blockscout/blockscout/pull/12678). | Version: v9.3.0+
Default: `https://api.diadata.org/v1`
Applications: API, Indexer | | `MARKET_DIA_COIN_ADDRESS_HASH` | Sets address hash for native coin in DIA. Implemented in [#12678](https://github.com/blockscout/blockscout/pull/12678). | Version: v9.3.0+
Default: (empty)
Applications: API | | `MARKET_DIA_SECONDARY_COIN_ADDRESS_HASH` | Sets address hash for secondary coin in DIA. Implemented in [#12678](https://github.com/blockscout/blockscout/pull/12678). | Version: v9.3.0+
Default: (empty)
Applications: API | | `TOKEN_LIST_URL` | URL for token list standard [https://tokenlists.org/](https://tokenlists.org/). Implemented in [#14206](https://github.com/blockscout/blockscout/pull/14206). | Version: v11.1.0+
Default: (empty)
Applications: Indexer | | `TOKEN_LIST_REFETCH_INTERVAL` | Interval to update data from token list. Implemented in [#14206](https://github.com/blockscout/blockscout/pull/14206). | Version: v11.1.0+
Default: (empty)
Applications: Indexer | ## Cache Management
Default: `100ms`
Applications: API, Indexer | | `CACHE_PROPAGATION_SEND_TIMEOUT` | Maximum time allowed for a cache propagation batch to be sent to remote nodes before the sender is stopped and the batch is dropped. Implemented in [#14778](https://github.com/blockscout/blockscout/pull/14778). | Version: v11.3.0+
Default: `30s`
Applications: API, Indexer | | `CACHE_COUNTERS_CONSOLIDATION_SAFE_BLOCK_LAG` | Number of blocks behind the chain head to use as safe block for consolidation (prevents corrupting ranges during reorgs). Used by both address and token consolidators. Implemented in [#14759](https://github.com/blockscout/blockscout/pull/14759), extended in [#14773](https://github.com/blockscout/blockscout/pull/14773). | Version: v11.3.0+
Default: `10`
Applications: API, Indexer | | `CACHE_ADDRESS_COUNT_PERIOD` | Interval for restarting the task that calculates the total number of addresses. | Version: v8.0.0+
Default: `30m`
Applications: API, Indexer | | `CACHE_ADDRESS_SUM_PERIOD` | Time to live of addresses sum (except burn address) cache. [Time format](/setup/env-variables/backend-env-variables#time-format). Starting from release v6.8.0+, if the value is not set, ttl value gradually increases until the default value with growth of the block numbers. Introduced in [#2862](https://github.com/poanetwork/blockscout/pull/2862). | Version: v4.1.3+
Default: `1h`
Applications: API, Indexer | | `CACHE_ADDRESS_TOKENS_USD_SUM_PERIOD` | Managing of cache invalidation period for the sum of USD value of tokens per tokens' holder address. | Version: v3.5.0+
Default: `1h`
Applications: API, Indexer | | `CACHE_ADDRESS_COUNTERS_TTL` | Time to live of address counters cache (transactions count, token transfers count, gas used). [Time format](/setup/env-variables/backend-env-variables#time-format). Implemented in [#14759](https://github.com/blockscout/blockscout/pull/14759). | Version: v11.3.0+
Default: `1h`
Applications: API | | `CACHE_ADDRESS_COUNTERS_MAX_DIRTY_MARKERS` | Maximum number of dirty address markers to accumulate before forcing a consolidation cycle. Implemented in [#14759](https://github.com/blockscout/blockscout/pull/14759). | Version: v11.3.0+
Default: `10000`
Applications: API, Indexer | | `CACHE_ADDRESS_COUNTERS_CONSOLIDATION_DISABLED` | If `true`, disables background consolidation of address counters. Useful during rolling deploys when old and new API pods are running together. Implemented in [#14759](https://github.com/blockscout/blockscout/pull/14759). | Version: v11.3.0+
Default: `false`
Applications: API, Indexer | | `CACHE_ADDRESS_COUNTERS_CONSOLIDATION_INTERVAL` | Interval between address counters consolidation cycles. [Time format](/setup/env-variables/backend-env-variables#time-format). Implemented in [#14759](https://github.com/blockscout/blockscout/pull/14759). | Version: v11.3.0+
Default: `10s`
Applications: API, Indexer | | `CACHE_ADDRESS_COUNTERS_CONSOLIDATION_BATCH_SIZE` | Number of addresses to consolidate counters for in a single batch. Implemented in [#14759](https://github.com/blockscout/blockscout/pull/14759). | Version: v11.3.0+
Default: `100`
Applications: API, Indexer | | `CACHE_ADDRESS_COUNTERS_CONSOLIDATION_CONCURRENCY` | Number of parallel consolidation workers. Implemented in [#14759](https://github.com/blockscout/blockscout/pull/14759). | Version: v11.3.0+
Default: `4`
Applications: API, Indexer | | `CACHE_ADDRESS_COUNTERS_CONSOLIDATION_QUERY_TIMEOUT` | Query timeout for address counters consolidation. [Time format](/setup/env-variables/backend-env-variables#time-format). Implemented in [#14759](https://github.com/blockscout/blockscout/pull/14759). | Version: v11.3.0+
Default: `30s`
Applications: API, Indexer | | `CACHE_TOKEN_COUNTERS_TTL` | Time to live of token counters cache (transfer count and holder count). [Time format](/setup/env-variables/backend-env-variables#time-format). Implemented in [#14773](https://github.com/blockscout/blockscout/pull/14773). | Version: v11.3.0+
Default: `1h`
Applications: API | | `CACHE_TOKEN_COUNTERS_MAX_DIRTY_MARKERS` | Maximum number of dirty token markers to accumulate before forcing a consolidation cycle. Implemented in [#14773](https://github.com/blockscout/blockscout/pull/14773). | Version: v11.3.0+
Default: `10000`
Applications: API, Indexer | | `CACHE_TOKEN_COUNTERS_CONSOLIDATION_DISABLED` | If `true`, disables background consolidation of token counters. Useful during rolling deploys when old and new API pods are running together. Implemented in [#14773](https://github.com/blockscout/blockscout/pull/14773). | Version: v11.3.0+
Default: `false`
Applications: API, Indexer | | `CACHE_TOKEN_COUNTERS_CONSOLIDATION_INTERVAL` | Interval between token counters consolidation cycles. [Time format](/setup/env-variables/backend-env-variables#time-format). Implemented in [#14773](https://github.com/blockscout/blockscout/pull/14773). | Version: v11.3.0+
Default: `10s`
Applications: API, Indexer | | `CACHE_TOKEN_COUNTERS_CONSOLIDATION_BATCH_SIZE` | Number of tokens to consolidate counters for in a single batch. Implemented in [#14773](https://github.com/blockscout/blockscout/pull/14773). | Version: v11.3.0+
Default: `50`
Applications: API, Indexer | | `CACHE_TOKEN_COUNTERS_CONSOLIDATION_CONCURRENCY` | Number of parallel token consolidation workers. Implemented in [#14773](https://github.com/blockscout/blockscout/pull/14773). | Version: v11.3.0+
Default: `4`
Applications: API, Indexer | | `CACHE_TOKEN_COUNTERS_CONSOLIDATION_QUERY_TIMEOUT` | Query timeout for token counters consolidation. [Time format](/setup/env-variables/backend-env-variables#time-format). Implemented in [#14773](https://github.com/blockscout/blockscout/pull/14773). | Version: v11.3.0+
Default: `30s`
Applications: API, Indexer | | `CACHE_TOP_ADDRESSES_TTL` | TTL of the top addresses cache (`/api/v2/addresses` first page) on API nodes (`APPLICATION_MODE=api` or `DISABLE_INDEXER=true`). The background refresher renews it on every refill, so the cache only expires when refills have been failing for the whole TTL. [Time format](/setup/env-variables/backend-env-variables#time-format). | Version: v11.3.2+
Default: `5m`
Applications: API | | `CACHE_TOP_ADDRESSES_UPDATE_INTERVAL` | Interval at which `Explorer.Chain.Cache.Accounts.Refresher` refills the top addresses cache from the database. Should be lower than `CACHE_TOP_ADDRESSES_TTL`. [Time format](/setup/env-variables/backend-env-variables#time-format). | Version: v11.3.2+
Default: `1m`
Applications: API | | `TOKEN_METADATA_UPDATE_INTERVAL` | Interval to restart the task which updates token metadata. | Version: v2.0.1+
Default: `48h`
Applications: API, Indexer | | `TOKEN_COUNTERS_UPDATE_INTERVAL` | Interval to restart the task which updates token counters (transfers count and holders count). | Version: v9.0.0+
Default: `3h`
Applications: Indexer | | `CACHE_AVERAGE_BLOCK_PERIOD` | Time to initiate first calculation and caching of average block period after start/re-start of the application. | Version: v4.1.3+
Default: `30m`
Applications: API, Indexer | | `CACHE_AVERAGE_BLOCK_TIME_WINDOW` | The number of blocks to be taken into account in the calculations. Introduced in [#13470](https://github.com/blockscout/blockscout/pull/13470). | Version: v9.2.0+
Default: `100`
Applications: API, Indexer | | `CACHE_MARKET_HISTORY_PERIOD` | Update of market history cache. | Version: v4.1.3+
Default: `1h`
Applications: API, Indexer | | `TOKEN_BALANCE_ON_DEMAND_FETCHER_THRESHOLD` | A threshold to invalidate token balance cache. | Version: v5.1.2+
Default: `1h`
Applications: API, Indexer | | `TOKEN_BALANCE_ON_DEMAND_FETCHER_BATCH_SIZE` | Batch size for Indexer.Fetcher.OnDemand.TokenBalance. Introduced in [#14265](https://github.com/blockscout/blockscout/pull/14265) | Version: v11.0.1+
Default: `500`
Applications: API, Indexer | | `TOKEN_BALANCE_ON_DEMAND_FETCHER_CONCURRENCY` | Concurrency for Indexer.Fetcher.OnDemand.TokenBalance. Introduced in [#14265](https://github.com/blockscout/blockscout/pull/14265) | Version: v11.0.1+
Default: `4`
Applications: API, Indexer | | `TOKEN_BALANCE_ON_DEMAND_FETCHER_ADDRESS_QUEUE_FLUSH_INTERVAL` | How often the on-demand token balance address queue is flushed to processing. Use a shorter interval for lower latency, or a longer interval to accumulate larger batches and reduce query frequency. Introduced in [#14265](https://github.com/blockscout/blockscout/pull/14265) | Version: v11.0.1+
Default: `1s`
Applications: API, Indexer | | `TOKEN_BALANCE_ON_DEMAND_FETCHER_ADDRESS_QUEUE_BATCH_SIZE` | Batch size for on-demand token balance address queue. Introduced in [#14265](https://github.com/blockscout/blockscout/pull/14265) | Version: v11.0.1+
Default: `50`
Applications: API, Indexer | | `TOKEN_TOTAL_SUPPLY_ON_DEMAND_FETCHER_CONCURRENCY` | Concurrency for `Indexer.Fetcher.OnDemand.TokenTotalSupply`. Implemented in [#14811](https://github.com/blockscout/blockscout/pull/14811). | Version: v11.3.1+
Default: `5`
Applications: Indexer | | `TOKEN_TOTAL_SUPPLY_ON_DEMAND_FETCHER_THRESHOLD` | Backoff threshold after a failed token total supply fetch. [Time format](/setup/env-variables/backend-env-variables#time-format). Implemented in [#14811](https://github.com/blockscout/blockscout/pull/14811). | Version: v11.3.1+
Default: `5m`
Applications: Indexer | | `COIN_BALANCE_ON_DEMAND_FETCHER_THRESHOLD` | A threshold to invalidate coin balance cache. | Version: v5.1.2+
Default: `1h`
Applications: API, Indexer | | `CONTRACT_CODE_ON_DEMAND_FETCHER_THRESHOLD` | An initial threshold (for exponential backoff) to fetch smart-contract bytecode on-demand. Implemented in [#9708](https://github.com/blockscout/blockscout/pull/9708). | Version: v6.4.0+
Default: `5s`
Applications: API, Indexer | | `CACHE_BLOCK_COUNT_PERIOD` | Time to live of blocks with consensus count cache. Starting from release v6.8.0+, if the value is not set, ttl value gradually increases until the default value with growth of the block numbers. Introduced in [#1876](https://github.com/poanetwork/blockscout/pull/1876). | Version: v4.1.3+
Default: `2h`
Applications: API, Indexer | | `CACHE_TXS_COUNT_PERIOD` | Time interval to restart the task that calculates the total txs count. Starting from release v6.8.0+, if the value is not set, ttl value gradually increases until the default value with growth of the block numbers. | Version: v4.1.3+
Default: `2h`
Applications: API, Indexer | | `CACHE_TXS_COUNT_CONSOLIDATION_DISABLED` | If `true`, disables exact total transaction count consolidation and uses the PostgreSQL `pg_class` estimate directly. Implemented in [#14877](https://github.com/blockscout/blockscout/pull/14877). | Version: v11.3.3+
Default: `false`
Applications: API | | `CACHE_TRANSACTIONS_24H_STATS_PERIOD` | Interval to update data for the last 24 hours transactions stats. Introduced in [#9483](https://github.com/blockscout/blockscout/pull/9483). | Version: v6.3.0+
Default: `1h`
Applications: API, Indexer | | `CACHE_FRESH_PENDING_TRANSACTIONS_COUNTER_PERIOD` | Interval to update count of pending transactions that appeared less than half an hour ago. Introduced in [#9483](https://github.com/blockscout/blockscout/pull/9483). | Version: v6.3.0+
Default: `5m`
Applications: API, Indexer | | `CACHE_OPTIMISM_LAST_OUTPUT_ROOT_SIZE_COUNTER_PERIOD` | Interval to update data for the last output root size counter. Introduced in [#9532](https://github.com/blockscout/blockscout/pull/9532). | Version: v6.3.0+
Default: `5m`
Applications: API, Indexer | | `CACHE_OPTIMISM_DEPOSITS_COUNTER_PERIOD` | Interval to update the Optimism deposits count. Introduced in [#14733](https://github.com/blockscout/blockscout/pull/14733). | Version: v12.0.0+
Default: `1h`
Applications: API, Indexer | | `CACHE_PENDING_OPERATIONS_COUNT_PERIOD` | Time interval to restart the task which calculates the total pending operations count. Introduced in [#12474](https://github.com/blockscout/blockscout/pull/12474). | Version: v10.0.0+
Default: `5m`
Applications: API, Indexer | | `CACHE_HOT_SMART_CONTRACTS_5M_PERIOD` | TTL for ConCache entries serving `GET /api/v2/stats/hot-smart-contracts` with `scale=5m`. Controls how long paginated rankings over the last 5 minutes of contract activity are reused before recomputing from the database. [Time format](/setup/env-variables/backend-env-variables#time-format). Shorter TTL = fresher data, more DB load. Longer TTL = less load, staler rankings. | Version: v11.2.0+
Default: `30s`
Applications: API | | `CACHE_HOT_SMART_CONTRACTS_1H_PERIOD` | TTL for ConCache entries serving `GET /api/v2/stats/hot-smart-contracts` with `scale=1h`. Controls how long paginated rankings over the last 1 hour of contract activity are reused before recomputing from the database. [Time format](/setup/env-variables/backend-env-variables#time-format). | Version: v11.2.0+
Default: `6m`
Applications: API | | `CACHE_HOT_SMART_CONTRACTS_3H_PERIOD` | TTL for ConCache entries serving `GET /api/v2/stats/hot-smart-contracts` with `scale=3h`. Controls how long paginated rankings over the last 3 hours of contract activity are reused before recomputing from the database. [Time format](/setup/env-variables/backend-env-variables#time-format). | Version: v11.2.0+
Default: `18m`
Applications: API | | `CACHE_SCAM_ADDRESSES_UPDATE_INTERVAL` | Interval between updating scam addresses cache. Implemented in [#14781](https://github.com/blockscout/blockscout/pull/14781). | Version: v11.3.0+
Default: `5m`
Applications: API | | `CACHE_SCAM_ADDRESSES_MAX_SIZE` | Max number of records in `scam_address_badge_mappings` table after which cache will be turned off. Implemented in [#14781](https://github.com/blockscout/blockscout/pull/14781). | Version: v11.3.0+
Default: `200000`
Applications: API | ## Gas Price Oracle | Variable | Description | Parameters | | - | - | - | | `GAS_PRICE_ORACLE_NUM_OF_BLOCKS` | Gas price oracle: number of blocks to calculate average gas price from | Version: v4.1.4+
Default: `200`
Applications: API, Indexer | | `GAS_PRICE_ORACLE_SAFELOW_PERCENTILE` | Gas price oracle: safelow percentile | Version: v4.1.4+
Default: `35`
Applications: API, Indexer | | `GAS_PRICE_ORACLE_AVERAGE_PERCENTILE` | Gas price oracle: average percentile | Version: v4.1.4+
Default: `60`
Applications: API, Indexer | | `GAS_PRICE_ORACLE_FAST_PERCENTILE` | Gas price oracle: fast percentile | Version: v4.1.4+
Default: `90`
Applications: API, Indexer | | `GAS_PRICE_ORACLE_CACHE_PERIOD` | Gas price oracle: period of gas prices update. | Version: v4.1.4+
Default: `30s`
Applications: API, Indexer | | `GAS_PRICE_ORACLE_SIMPLE_TRANSACTION_GAS` | Gas price oracle: amount of gas for a simple coin transfer. Introduced in [#9044](https://github.com/blockscout/blockscout/pull/9044). | Version: v6.0.0+
Default: `21000`
Applications: API, Indexer | | `GAS_PRICE_ORACLE_SAFELOW_TIME_COEFFICIENT` | Average block time multiplied by this coefficient for safelow gas price when time from pending transactions is not available. Floats may be used. Introduced in [#9582](https://github.com/blockscout/blockscout/pull/9582). | Version: v6.3.0+
Default: `5`
Applications: API, Indexer | | `GAS_PRICE_ORACLE_AVERAGE_TIME_COEFFICIENT` | Average block time multiplied by this coefficient for average gas price when time from pending transactions is not available. Floats may be used. Introduced in [#9582](https://github.com/blockscout/blockscout/pull/9582). | Version: v6.3.0+
Default: `3`
Applications: API, Indexer | | `GAS_PRICE_ORACLE_FAST_TIME_COEFFICIENT` | Average block time multiplied by this coefficient for fast gas price when time from pending transactions is not available. Floats may be used. Introduced in [#9582](https://github.com/blockscout/blockscout/pull/9582). | Version: v6.3.0+
Default: `1`
Applications: API, Indexer | ## Main Page Dashboard | Variable | Description | Parameters | | - | - | - | | `GAS_PRICE` | Gas price in Gwei. If the variable is present, gas price displays on the main page. | Version: v3.3.2+
Default: (empty)
Applications: API | | `TXS_STATS_ENABLED` | Disables or enables txs per day stats gathering. | Version: v5.1.3+
Default: `true`
Applications: API | | `SHOW_PRICE_CHART` | Disables or enables price and market cap of coin charts on the main page. | Version: v3.1.2+
Default: `false`
Applications: API | | `SHOW_PRICE_CHART_LEGEND` | Shows price and market cap values under the chart even if price chart is not enabled via `SHOW_PRICE_CHART` env variable. | Version: v5.1.4+
Default: `false`
Applications: API | | `SHOW_TXS_CHART` | Disables or enables txs count per day chart on the main page. | Version: v3.1.2+
Default: `true`
Applications: API | | `TXS_HISTORIAN_INIT_LAG` | The initial delay in txs count history fetching in order to display txs count per day history chart on the main page. [Time format](/setup/env-variables/backend-env-variables#time-format). | Version: v3.1.2+
Default: `0`
Applications: API | | `TXS_STATS_DAYS_TO_COMPILE_AT_INIT` | Number of days for fetching of history of txs count per day in order to display it in txs count per day history chart on the main page. | Version: v3.1.2+
Default: `40`
Applications: API | ## Contract Management | Variable | Description | Parameters | | - | - | - | | `CONTRACT_VERIFICATION_ALLOWED_SOLIDITY_EVM_VERSIONS` | Comma-separated list of allowed EVM versions for Solidity contract verification. This var was introduced in [#1964](https://github.com/poanetwork/blockscout/pull/1964), updated in [#7614](https://github.com/blockscout/blockscout/pull/7614). | Version: v5.2.0+
Default: `homestead,tangerineWhistle,spuriousDragon,byzantium,constantinople,petersburg,istanbul,berlin,london,paris,shanghai,cancun,prague,osaka,default`
Applications: API | | `CONTRACT_VERIFICATION_ALLOWED_VYPER_EVM_VERSIONS` | Comma-separated list of allowed EVM versions for Vyper contract verification. This var was introduced in [#7614](https://github.com/blockscout/blockscout/pull/7614). | Version: v5.2.0+
Default: `byzantium,constantinople,petersburg,istanbul,berlin,paris,shanghai,cancun,osaka,default`
Applications: API | | `CONTRACT_VERIFICATION_MAX_LIBRARIES` | Max amount of libraries to consider in smart-contract verification from flat/multi-part file(s). Implemented in [#6204](https://github.com/blockscout/blockscout/pull/6204). | Version: v5.0.0+
Default: (empty)
Applications: API | | `CONTRACT_MAX_STRING_LENGTH_WITHOUT_TRIMMING` | Hide long contract method data. For more details: [#4667](https://github.com/blockscout/blockscout/pull/4667) | Version: v4.0.0+
Default: `2040`
Applications: API | | `CONTRACT_DISABLE_INTERACTION` | If `true`, contract interactions via "Write contract" or "Write proxy contract" tabs are disabled. Introduced in [#7088](https://github.com/blockscout/blockscout/pull/7088). | Version: v5.1.2+
Default: (empty)
Applications: API | | `CONTRACT_PROXY_IMPLEMENTATION_TTL_VIA_AVG_BLOCK_TIME` | If `false`, proxy contract implementation will be re-fetched immediately once someone opens proxy page bypassing average block time calculation. Implemented in [#9155](https://github.com/blockscout/blockscout/pull/9155). | Version: v6.1.0+
Default: `true`
Applications: API | | `CONTRACT_PROXY_EMPTY_IMPLEMENTATION_DATA_CACHE_TTL` | Empty probe results ("not a proxy") of smart-contracts verified on the address itself are refreshed with a dedicated, much longer TTL. Unverified contracts, bytecode twins, and real proxies keep the existing TTL behavior. [Time format](/setup/env-variables/backend-env-variables#time-format). Implemented in [#14689](https://github.com/blockscout/blockscout/pull/14689). | Version: v11.2.7+
Default: `1d`
Applications: API | | `CONTRACT_AUDIT_REPORTS_AIRTABLE_URL` | URL of Airtable to store audit reports from users. Implemented in [#9120](https://github.com/blockscout/blockscout/pull/9120) | Version: v6.1.0+
Default: (empty)
Applications: API | | `CONTRACT_AUDIT_REPORTS_AIRTABLE_API_KEY` | Access token for `CONTRACT_AUDIT_REPORTS_AIRTABLE_URL`. Implemented in [#9120](https://github.com/blockscout/blockscout/pull/9120) | Version: v6.1.0+
Default: (empty)
Applications: API | | `CONTRACT_CERTIFIED_LIST` | Comma-separated list of smart-contract address hashes, to which "certified" flag should be applied. Implemented in [#9910](https://github.com/blockscout/blockscout/pull/9910) | Version: v6.5.0+
Default: (empty)
Applications: API | | `WHITELISTED_WETH_CONTRACTS` | Comma-separated list of smart-contract address hashes of WETH-like tokens whose deposit and withdrawal events you'd like to index. Implemented in [#10134](https://github.com/blockscout/blockscout/pull/10134) | Version: v6.8.0+
Default: (empty)
Applications: API, Indexer | | `WETH_TOKEN_TRANSFERS_FILTERING_ENABLED` | Toggle for WETH token transfers filtering which was introduced in [#10134](https://github.com/blockscout/blockscout/pull/10134). Implemented in [#10208](https://github.com/blockscout/blockscout/pull/10208) | Version: v6.1.0+
Default: `false`
Applications: API, Indexer | | `CONTRACT_ENABLE_PARTIAL_REVERIFICATION` | Toggle for enabling re-verification from partial to partial match. Implemented in [#11737](https://github.com/blockscout/blockscout/pull/11737) | Version: v7.0.0+
Default: `false`
Applications: API | ## Bridged Tokens | Variable | Description | Parameters | | - | - | - | | `BRIDGED_TOKENS_ENABLED` | Variable to enable bridged tokens functionality. Introduced in [#9169](https://github.com/blockscout/blockscout/pull/9169) | Needs Recompile: βοΈ Version: v6.1.0+
Default: (empty)
Applications: API, Indexer | | `BRIDGED_TOKENS_ETH_OMNI_BRIDGE_MEDIATOR` | OMNI bridge mediator for ETH tokens. Introduced in [#9169](https://github.com/blockscout/blockscout/pull/9169) | Version: v6.1.0+
Default: (empty)
Applications: API, Indexer | | `BRIDGED_TOKENS_BSC_OMNI_BRIDGE_MEDIATOR` | OMNI bridge mediator for BSC tokens. Introduced in [#9169](https://github.com/blockscout/blockscout/pull/9169) | Version: v6.1.0+
Default: (empty)
Applications: API, Indexer | | `BRIDGED_TOKENS_POA_OMNI_BRIDGE_MEDIATOR` | OMNI bridge mediator for POA tokens. Introduced in [#9169](https://github.com/blockscout/blockscout/pull/9169) | Version: v6.1.0+
Default: (empty)
Applications: API, Indexer | | `BRIDGED_TOKENS_AMB_BRIDGE_MEDIATORS` | AMB bridge mediator. Introduced in [#9169](https://github.com/blockscout/blockscout/pull/9169) | Version: v6.1.0+
Default: (empty)
Applications: API, Indexer | | `BRIDGED_TOKENS_FOREIGN_JSON_RPC` | Ethereum mainnet JSON RPC. Introduced in [#9169](https://github.com/blockscout/blockscout/pull/9169) | Version: v6.1.0+
Default: (empty)
Applications: API, Indexer | ## Miscellaneous UI | Variable | Description | Parameters | | - | - | - | | `HIDE_SCAM_ADDRESSES` | Hides address of EOA/smart-contract/token from search results if the value is `true` and "scam" badge is assigned to that address. Implemented in [#10763](https://github.com/blockscout/blockscout/pull/10763) | Version: v6.9.0+
Default: (empty)
Applications: API | | `UNCLES_IN_AVERAGE_BLOCK_TIME` | Include or exclude non-consensus blocks in avg block time calculation. Exclude if `false`. | Version: v2.0.1+
Default: `false`
Applications: API | | `COIN_BALANCE_HISTORY_DAYS` | Number of days to consider for coin balance history chart. | Version: v3.1.3+
Default: `10`
Applications: API | ## CSV Export
Default: `10000`
Applications: API | | `CSV_EXPORT_ASYNC_ENABLED` | Enables async CSV export for supported endpoints. When enabled, the API returns `202 Accepted` with a `request_id` and processes exports through Oban instead of streaming them directly. Implemented in [#14028](https://github.com/blockscout/blockscout/pull/14028) | Version: v11.0.0+ Required: No
Default: `false`
Applications: API | | `CSV_EXPORT_ASYNC_OBAN_CONCURRENCY` | Sets Oban concurrency for the `csv_export` queue used by async CSV exports. Implemented in [#14028](https://github.com/blockscout/blockscout/pull/14028) | Version: v11.0.0+ Required: No
Default: `10`
Applications: API | | `CSV_EXPORT_ASYNC_GOKAPI_URL` | Base URL of the Gokapi instance used to store completed async CSV exports. Trailing slash is stripped during validation. Implemented in [#14028](https://github.com/blockscout/blockscout/pull/14028) | Version: v11.0.0+ Required: Yes, if async export is enabled
Default: (empty)
Applications: API | | `CSV_EXPORT_ASYNC_GOKAPI_API_KEY` | API key sent to Gokapi in the `apikey` header for async CSV export uploads. Implemented in [#14028](https://github.com/blockscout/blockscout/pull/14028) | Version: v11.0.0+ Required: Yes, if async export is enabled
Default: (empty)
Applications: API | | `CSV_EXPORT_ASYNC_MAX_PENDING_TASKS_PER_IP` | Maximum number of pending async CSV export requests allowed per client IP at once. Implemented in [#14028](https://github.com/blockscout/blockscout/pull/14028) | Version: v11.0.0+ Required: No
Default: `3`
Applications: API | | `CSV_EXPORT_ASYNC_UPLOAD_CHUNK_SIZE` | Chunk size in bytes for reading the generated CSV file and uploading it to Gokapi. Should be synchronized with Gokapi settings. Implemented in [#14028](https://github.com/blockscout/blockscout/pull/14028) | Version: v11.0.0+ Required: No
Default: `47185920`
Applications: API | | `CSV_EXPORT_DB_TIMEOUT` | Timeout for CSV export database work. Follows the [time format](/setup/env-variables/backend-env-variables#time-format). Implemented in [#14028](https://github.com/blockscout/blockscout/pull/14028) | Version: v11.0.0+ Required: No
Default: `1h` if async export is enabled, otherwise `5m`
Applications: API | | `CSV_EXPORT_ASYNC_TMP_DIR` | Directory used for in-progress async CSV export files before they are uploaded to Gokapi. Implemented in [#14028](https://github.com/blockscout/blockscout/pull/14028) | Version: v11.0.0+ Required: No
Default: `/tmp/csv_export`
Applications: API | | `CSV_EXPORT_ASYNC_GOKAPI_TIMEOUT` | HTTP timeout and `recv_timeout` used for Gokapi requests during async CSV export. Follows the [time format](/setup/env-variables/backend-env-variables#time-format). Implemented in [#14028](https://github.com/blockscout/blockscout/pull/14028) | Version: v11.0.0+ Required: No
Default: `60s`
Applications: API | | `CSV_EXPORT_ASYNC_GOKAPI_UPLOAD_EXPIRY_DAYS` | Sets Gokapi `expiryDays` for completed async CSV export uploads. Implemented in [#14028](https://github.com/blockscout/blockscout/pull/14028) | Version: v11.0.0+ Required: No
Default: `1`
Applications: API | | `CSV_EXPORT_ASYNC_GOKAPI_UPLOAD_ALLOWED_DOWNLOADS` | Sets Gokapi `allowedDownloads` for completed async CSV export uploads. Implemented in [#14028](https://github.com/blockscout/blockscout/pull/14028) | Version: v11.0.0+ Required: No
Default: `1`
Applications: API | ## reCAPTCHA
Default: (empty)
Applications: API | | `RE_CAPTCHA_CLIENT_KEY` | Google reCAPTCHA v2 client key. Used by advanced CSV export in the embedded old UI. You don't need to set it for [the new UI](https://github.com/blockscout/frontend). Implemented in [#4747](https://github.com/blockscout/blockscout/pull/4747) | Version: v4.0.0+
Default: (empty)
Applications: API | | `RE_CAPTCHA_V3_SECRET_KEY` | **Only compatible with frontend version v1.36.x. For later versions, use Invisible reCAPTCHA v2.** Google reCAPTCHA v3 secret key. Used by advanced CSV export. Implemented in [#7273](https://github.com/blockscout/blockscout/pull/7273) | Version: v5.1.4+
Default: (empty)
Applications: API | | `RE_CAPTCHA_V3_CLIENT_KEY` | **Only compatible with frontend version v1.36.x. For later versions, use Invisible reCAPTCHA v2.** Google reCAPTCHA v3 client key. Used by advanced CSV export. Implemented in [#7273](https://github.com/blockscout/blockscout/pull/7273) | Version: v5.1.4+
Default: (empty)
Applications: API | | `RE_CAPTCHA_DISABLED` | Disable reCAPTCHA. Implemented in [#7416](https://github.com/blockscout/blockscout/pull/7416) | Version: v5.1.5+
Default: `false`
Applications: API | | `RE_CAPTCHA_CHECK_HOSTNAME` | Disable reCAPTCHA hostname check. More details on [reCaptcha docs](https://developers.google.com/recaptcha/docs/domain_validation). Implemented in [#10706](https://github.com/blockscout/blockscout/pull/10706) | Version: v6.9.0+
Default: `true`
Applications: API | | `RE_CAPTCHA_SCORE_THRESHOLD` | Changes reCAPTCHA score threshold. Implemented in [#11182](https://github.com/blockscout/blockscout/pull/11182) | Version: v6.9.1+
Default: `0.5`
Applications: API | | `RE_CAPTCHA_BYPASS_TOKEN` | Bypass token that allows to skip reCAPTCHA check. Implemented in [#11682](https://github.com/blockscout/blockscout/pull/11682) | Version: v6.10.2+
Default: (empty)
Applications: API | | `RE_CAPTCHA_TOKEN_INSTANCE_REFETCH_METADATA_SCOPED_BYPASS_TOKEN` | API key that allows to skip reCAPTCHA check for requests to `/api/v2/tokens/{token_hash}/instances/{token_id}/refetch-metadata` endpoint. Implemented in [#12147](https://github.com/blockscout/blockscout/pull/12147) | Version: v8.0.0+
Default: (empty)
Applications: API | ## API Rate Limits | Variable | Description | Parameters | | - | - | - | | `API_RATE_LIMIT_BY_IP` | Global rate limit for an IP address for API v2 requests sent from UI. [#7148](https://github.com/blockscout/blockscout/pull/7148) | Version: v5.1.3+
Default: `300`
Applications: API | | `API_RATE_LIMIT_BY_IP_TIME_INTERVAL` | Time interval of rate limit set by `API_RATE_LIMIT_BY_IP`. Implemented in [#7148](https://github.com/blockscout/blockscout/pull/7148) | Version: v5.1.3+
Default: `1m`
Applications: API | | `API_RATE_LIMIT_BY_WHITELISTED_IP` | A dedicated API rate limit for whitelisted IPs. Implemented in [#5090](https://github.com/blockscout/blockscout/pull/5090) | Version: v5.1.3+
Default: `25 req/sec`
Applications: API | | `API_RATE_LIMIT_BY_WHITELISTED_IP_TIME_INTERVAL` | Time interval for API rate limit by whitelisted IP. [Time format](/setup/env-variables/backend-env-variables#time-format). Implemented in [#12386](https://github.com/blockscout/blockscout/pull/12386) | Version: v9.0.0+
Default: `1s`
Applications: API | | `API_RATE_LIMIT_BY_KEY_TIME_INTERVAL` | Time interval for API rate limit by key. [Time format](/setup/env-variables/backend-env-variables#time-format). Implemented in [#12386](https://github.com/blockscout/blockscout/pull/12386) | Version: v9.0.0+
Default: `1s`
Applications: API | | `API_RATE_LIMIT_BY_ACCOUNT_API_KEY_TIME_INTERVAL` | Time interval for API rate limit by account API key. [Time format](/setup/env-variables/backend-env-variables#time-format). Implemented in [#12386](https://github.com/blockscout/blockscout/pull/12386) | Version: v9.0.0+
Default: `1s`
Applications: API | | `API_RATE_LIMIT_BY_KEY` | A dedicated API rate limit per key for every type of API key (static or generated from Account module). Implemented in [#5080](https://github.com/blockscout/blockscout/pull/5080) | Version: v4.1.1+
Default: `10 req/sec`
Applications: API | | `API_RATE_LIMIT_UI_V2_WITH_TOKEN` | Rate limit after submitting correct CAPTCHA. Implemented in [#7148](https://github.com/blockscout/blockscout/pull/7148) | Version: v5.1.3+
Default: `5`
Applications: API | | `API_RATE_LIMIT_UI_V2_WITH_TOKEN_TIME_INTERVAL` | Time interval for API rate limit for UI v2 with token. [Time format](/setup/env-variables/backend-env-variables#time-format). Implemented in [#12386](https://github.com/blockscout/blockscout/pull/12386) | Version: v9.0.0+
Default: `1s`
Applications: API | | `API_RATE_LIMIT_WHITELISTED_IPS` | Comma-separated whitelisted IPs list with dedicated rate limit. Implemented in [#5090](https://github.com/blockscout/blockscout/pull/5090) | Version: v4.1.1+
Default: (empty)
Applications: API | | `API_RATE_LIMIT_STATIC_API_KEY` | Static API key with dedicated API rate limit. Implemented in [#5080](https://github.com/blockscout/blockscout/pull/5080) | Version: v4.1.1+
Default: (empty)
Applications: API | | `API_NO_RATE_LIMIT_API_KEY` | API key with no rate limit. Implemented in [#10515](https://github.com/blockscout/blockscout/pull/10515) | Version: v6.8.0+
Default: (empty)
Applications: API | | `API_RATE_LIMIT_DISABLED` | If `true`, any type of rate limit is ignored. Implemented in [#6908](https://github.com/blockscout/blockscout/pull/6908) | Version: v5.1.0+
Default: `false`
Applications: API | | `API_RATE_LIMIT_IS_BLOCKSCOUT_BEHIND_PROXY` | If `true`, then IP address of a client will be derived from proxy's headers (like `X-Forwarded-For`) using [RemoteIp](https://hexdocs.pm/remote_ip/RemoteIp.html) library. Implemented in [#7148](https://github.com/blockscout/blockscout/pull/7148) | Version: v5.1.3+
Default: `false`
Applications: API | | `API_RATE_LIMIT_UI_V2_TOKEN_TTL` | TTL for token issued after submitting correct CAPTCHA for API v2 requests from UI. [Time format](/setup/env-variables/backend-env-variables#time-format). Implemented in [#12386](https://github.com/blockscout/blockscout/pull/12386) | Version: v9.0.0+
Default: `30m`
Applications: API | | `API_RATE_LIMIT_CONFIG_URL` | URL to fetch API rate limit configuration from external source. Implemented in [#12386](https://github.com/blockscout/blockscout/pull/12386) | Version: v9.0.0+
Default: (empty)
Applications: API | | `API_RATE_LIMIT_HAMMER_REDIS_URL` | Redis DB URL for Hammer rate limit library. Implemented in [#7148](https://github.com/blockscout/blockscout/pull/7148) | Needs Recompile: βοΈ Version: v5.1.3+
Default: (empty)
Applications: API | | `API_RATE_LIMIT_REMOTE_IP_HEADERS` | Comma separated list of HTTP headers to extract the real client IP address when Blockscout is behind a proxy for rate limiting purposes. Implemented in [#13082](https://github.com/blockscout/blockscout/pull/13082) | Version: v9.1.0+
Default: `x-forwarded-for`
Applications: API | | `API_RATE_LIMIT_REMOTE_IP_KNOWN_PROXIES` | Comma separated list of trusted proxy IP addresses or CIDR ranges that are allowed to set the client IP headers for rate limiting. Implemented in [#13082](https://github.com/blockscout/blockscout/pull/13082) | Version: v9.1.0+
Default: `(empty)`
Applications: API | | `ETH_JSON_RPC_MAX_BATCH_SIZE` | Max batch size for Eth JSON RPC requests. Implemented in [#9409](https://github.com/blockscout/blockscout/pull/9409) | Version: v6.3.0+
Default: `5`
Applications: API | | `API_RATE_LIMIT_HAMMER_REDIS_SSL_ENABLED` | If `true` Blockscout will use SSL to connect to Redis DB for Hammer rate limit library. Implemented in [#13901](https://github.com/blockscout/blockscout/pull/13901) | Version: v12.0.0+
Default: (empty)
Applications: API | | `API_RATE_LIMIT_HAMMER_REDIS_SENTINEL_URLS` | List of Redis sentinel urls for Hammer rate limit library. Implemented in [#13901](https://github.com/blockscout/blockscout/pull/13901) | Version: v12.0.0+
Default: (empty)
Applications: API | | `API_RATE_LIMIT_HAMMER_REDIS_SENTINEL_MASTER_NAME` | Sentinel master name for Hammer rate limit library. Implemented in [#13901](https://github.com/blockscout/blockscout/pull/13901) | Version: v12.0.0+
Default: (empty)
Applications: API | | `API_RATE_LIMIT_RECAPTCHA_DISABLED_LIMIT_MULTIPLIER` | Integer multiplier applied to rate limits on endpoints that use `recaptcha_to_bypass_429` or `temporary_token` when reCAPTCHA is disabled (`RE_CAPTCHA_DISABLED=true`). When reCAPTCHA is disabled, neither bypass mechanism is available, so this multiplier compensates by raising the base limit for all users. Implemented in [#14379](https://github.com/blockscout/blockscout/pull/14379) | Version: v12.0.0+
Default: `2`
Applications: API | ## General Application Rate Limits | Variable | Description | Parameters | | - | - | - | | `RATE_LIMITER_REDIS_URL` | Redis DB URL for rate limiter. Implemented in [#12218](https://github.com/blockscout/blockscout/pull/12218) | Version: v8.0.0+
Default: (empty)
Applications: API | | `RATE_LIMITER_ON_DEMAND_TIME_INTERVAL` | Time interval of rate limit for on-demand fetchers. Implemented in [#12218](https://github.com/blockscout/blockscout/pull/12218) | Version: v8.0.0+
Default: `5s`
Applications: API | | `RATE_LIMITER_ON_DEMAND_LIMIT_BY_IP` | Rate limit for an IP address for on-demand fetcher call. Implemented in [#12218](https://github.com/blockscout/blockscout/pull/12218) | Version: v8.0.0+
Default: `100`
Applications: API | | `RATE_LIMITER_ON_DEMAND_EXPONENTIAL_TIMEOUT_COEFF` | Coefficient to calculate exponential timeout for on-demand rate limit. Implemented in [#12218](https://github.com/blockscout/blockscout/pull/12218) | Version: v8.0.0+
Default: `100`
Applications: API | | `RATE_LIMITER_ON_DEMAND_MAX_BAN_INTERVAL` | Max time an IP address can be banned from on-demand fetcher calls. Implemented in [#12218](https://github.com/blockscout/blockscout/pull/12218) | Version: v8.0.0+
Default: `1h`
Applications: API | | `RATE_LIMITER_ON_DEMAND_LIMITATION_PERIOD` | Time after which the number of bans for the IP address will be reset. Implemented in [#12218](https://github.com/blockscout/blockscout/pull/12218) | Version: v8.0.0+
Default: `1h`
Applications: API | | `RATE_LIMITER_REDIS_SSL_ENABLED` | If `true` Blockscout will use SSL to connect to Redis DB for rate limiter. Implemented in [#13901](https://github.com/blockscout/blockscout/pull/13901) | Version: v12.0.0+
Default: (empty)
Applications: API | | `RATE_LIMITER_REDIS_SENTINEL_URLS` | List of Redis sentinel urls for rate limiter. Implemented in [#13901](https://github.com/blockscout/blockscout/pull/13901) | Version: v12.0.0+
Default: (empty)
Applications: API | | `RATE_LIMITER_REDIS_SENTINEL_MASTER_NAME` | Sentinel master name for rate limiter. Implemented in [#13901](https://github.com/blockscout/blockscout/pull/13901) | Version: v12.0.0+
Default: (empty)
Applications: API | ## GraphQL API | Variable | Description | Parameters | | - | - | - | | `API_GRAPHQL_ENABLED` | Enabling/disabling of GraphQL API. Implemented in [#9751](https://github.com/blockscout/blockscout/pull/9751) | Version: v6.4.0+
Default: `true`
Applications: API | | `API_GRAPHQL_MAX_COMPLEXITY` | Limits the cost of GraphQL API queries. For more details, see the [`max_complexity`](https://hexdocs.pm/absinthe/complexity-analysis.html#complexity-analysis) documentation. Implemented in [#9751](https://github.com/blockscout/blockscout/pull/9751), updated in [#11843](https://github.com/blockscout/blockscout/pull/11843) | Needs Recompile: βοΈ Version: v6.4.0+
Default: `100`
Applications: API | | `API_GRAPHQL_TOKEN_LIMIT` | Query [token\_limit](https://hexdocs.pm/absinthe/complexity-analysis.html#token-limits) of Absinthe. Implemented in [#9751](https://github.com/blockscout/blockscout/pull/9751) | Needs Recompile: βοΈ
Version: v6.4.0+
Default: `1000`
Applications: API | | `API_GRAPHQL_DEFAULT_TRANSACTION_HASH` | Default transaction hash in a sample query to GraphiQL. Implemented in [#9751](https://github.com/blockscout/blockscout/pull/9751). | Needs Recompile: βοΈ
Version: v6.4.0+
Default: `0x69e3923eef50eada197c3336d546936d0c994211492c9f947a24c02827568f9f`
Applications: API | | `API_GRAPHQL_RATE_LIMIT` | A global GraphQL API rate limit: number of requests per second for all users. Implemented in [#9771](https://github.com/blockscout/blockscout/pull/9771) | Version: v6.4.0+
Default: `10 req/sec`
Applications: API | | `API_GRAPHQL_RATE_LIMIT_BY_KEY` | A dedicated GraphQL API rate limit per static key. If this limit is less than stated in API plan, then `API_GRAPHQL_RATE_LIMIT_BY_KEY` is used for key generated from Account module. Implemented in [#9771](https://github.com/blockscout/blockscout/pull/9771) | Version: v6.4.0+
Default: `10 req/sec`
Applications: API | | `API_GRAPHQL_RATE_LIMIT_STATIC_API_KEY` | Static GraphQL API key with dedicated GraphQL API rate limit. Implemented in [#9771](https://github.com/blockscout/blockscout/pull/9771) | Version: v6.4.0+
Default: (empty)
Applications: API | | `API_GRAPHQL_RATE_LIMIT_DISABLED` | If `true`, any type of rate limit is ignored. Implemented in [#9771](https://github.com/blockscout/blockscout/pull/9771) | Version: v6.4.0+
Default: (empty)
Applications: API | | `API_GRAPHQL_RATE_LIMIT_BY_IP` | Global rate limit for an IP address for GraphQL API requests. [#9771](https://github.com/blockscout/blockscout/pull/9771) | Version: v6.4.0+
Default: `500`
Applications: API | | `API_GRAPHQL_RATE_LIMIT_TIME_INTERVAL` | Time interval of rate limit. [Time format](/setup/env-variables/backend-env-variables#time-format). Implemented in [#9771](https://github.com/blockscout/blockscout/pull/9771) | Version: v6.4.0+
Default: `1s`
Applications: API | | `API_GRAPHQL_RATE_LIMIT_BY_IP_TIME_INTERVAL` | Time interval of rate limit set by `API_GRAPHQL_RATE_LIMIT_BY_IP`. [Time format](/setup/env-variables/backend-env-variables#time-format). Implemented in [#9771](https://github.com/blockscout/blockscout/pull/9771) | Version: v6.4.0+
Default: `1h`
Applications: API | ## Account Related | Variable | Description | Parameters | | - | - | - | | `ACCOUNT_ENABLED` | Turn on/off account functionality. If value is `true`, account functionality is enabled. | Version: v5.0.0+
Default: (empty)
Applications: API | | `ACCOUNT_DATABASE_URL` | Account DB connection string | Version: v5.0.0+
Default: value from `DATABASE_URL`
Applications: API | | `ACCOUNT_REDIS_URL` | Account Redis connection string (for session storing configuration) | Version: v5.0.0+
Default: (empty)
Applications: API | | `ACCOUNT_POOL_SIZE` | Account DB `pool_size` | Version: v5.0.0+
Default: `50`
Applications: API | | `ACCOUNT_AUTH0_DOMAIN` | Domain for [Ueberauth Auth0](https://hexdocs.pm/ueberauth_auth0/readme.html) | Version: v5.0.0+
Default: (empty)
Applications: API | | `ACCOUNT_AUTH0_CLIENT_ID` | Auth0 client ID [Ueberauth Auth0](https://hexdocs.pm/ueberauth_auth0/readme.html) | Version: v5.0.0+
Default: (empty)
Applications: API | | `ACCOUNT_AUTH0_CLIENT_SECRET` | Auth0 client secret [Ueberauth Auth0](https://hexdocs.pm/ueberauth_auth0/readme.html) | Version: v5.0.0+
Default: (empty)
Applications: API | | `ACCOUNT_AUTH0_APPLICATION_ID` | Specifies the identifier for the application within Auth0. It's used to namespace user metadata in migrated Auth0 tenants. Implemented in [#12109](https://github.com/blockscout/blockscout/pull/12109). | Version: v8.0.0+
Default: (empty)
Applications: API | | `ACCOUNT_SENDGRID_API_KEY` | Sendgrid API key for watchlist notifications functionality | Version: v5.0.0+
Default: (empty)
Applications: API | | `ACCOUNT_SENDGRID_SENDER` | Sendgrid sender email for watchlist notifications functionality | Version: v5.0.0+
Default: (empty)
Applications: API | | `ACCOUNT_SENDGRID_TEMPLATE` | Sendgrid email template for watchlist notifications functionality | Version: v5.0.0+
Default: (empty)
Applications: API | | `ACCOUNT_CLOAK_KEY` | Account DB encryption key. [Instruction how to generate](https://hexdocs.pm/cloak_ecto/generate_keys.html#content) | Version: v5.0.0+
Default: (empty)
Applications: API | | `ACCOUNT_VERIFICATION_EMAIL_RESEND_INTERVAL` | Time before resending confirmation email. Implemented in [#7298](https://github.com/blockscout/blockscout/pull/7298). | Version: v5.1.5+
Default: `5m`
Applications: API | | `ACCOUNT_PRIVATE_TAGS_LIMIT` | Limit for address & transaction tags. Implemented in [#8528](https://github.com/blockscout/blockscout/pull/8528). | Version: v5.3.1+
Default: `2000`
Applications: API | | `ACCOUNT_WATCHLIST_ADDRESSES_LIMIT` | Limit for watch list addresses. Implemented in [#8528](https://github.com/blockscout/blockscout/pull/8528). | Version: v5.3.1+
Default: `15`
Applications: API | | `ACCOUNT_WATCHLIST_NOTIFICATIONS_LIMIT_FOR_30_DAYS` | Per account limit for watch list notifications sent for the last 30 days. Implemented in [#8966](https://github.com/blockscout/blockscout/pull/8966). | Version: v5.3.3+
Default: `1000`
Applications: API | | `ACCOUNT_OTP_RESEND_INTERVAL` | Time before resending otp email. Implemented in [#10706](https://github.com/blockscout/blockscout/pull/10706). | Version: v6.9.0+
Default: `1m`
Applications: API | | `ACCOUNT_SIWE_MESSAGE` | Message for Sign In With Ethereum authentication. Implemented in [#11178](https://github.com/blockscout/blockscout/pull/11178). | Version: v6.9.1+
Default: `Sign in to Blockscout Account V2`
Applications: API | | `ACCOUNT_DYNAMIC_ENV_ID` | Dynamic Environment ID, can be found here [https://app.dynamic.xyz/dashboard/developer/api](https://app.dynamic.xyz/dashboard/developer/api). Implemented in [#13786](https://github.com/blockscout/blockscout/pull/13786). | Version: v10.0.0+
Default: (empty)
Applications: API | | `ACCOUNT_SENDGRID_OTP_TEMPLATE` | Sendgrid email OTP template for login with email functionality. Implemented in [#14068](https://github.com/blockscout/blockscout/pull/14068). | Version: v10.1.0+, v9.4.0+
Default: (empty)
Applications: API | | `ACCOUNT_KEYCLOAK_DOMAIN` | Domain for [Keycloak](https://www.keycloak.org/). Implemented in [#14068](https://github.com/blockscout/blockscout/pull/14068). | Version: v10.1.0+, v9.4.0+
Default: (empty)
Applications: API | | `ACCOUNT_KEYCLOAK_REALM` | Realm for [Keycloak](https://www.keycloak.org/). Implemented in [#14068](https://github.com/blockscout/blockscout/pull/14068). | Version: v10.1.0+, v9.4.0+
Default: (empty)
Applications: API | | `ACCOUNT_KEYCLOAK_CLIENT_ID` | [Keycloak](https://www.keycloak.org/) client ID. Implemented in [#14068](https://github.com/blockscout/blockscout/pull/14068). | Version: v10.1.0+, v9.4.0+
Default: (empty)
Applications: API | | `ACCOUNT_KEYCLOAK_CLIENT_SECRET` | [Keycloak](https://www.keycloak.org/) client secret. Implemented in [#14068](https://github.com/blockscout/blockscout/pull/14068). | Version: v10.1.0+, v9.4.0+
Default: (empty)
Applications: API | | `ACCOUNT_KEYCLOAK_EMAIL_WEBHOOK_URL` | URL address where new email users are reported. Implemented in [#14068](https://github.com/blockscout/blockscout/pull/14068). | Version: v10.1.0+, v9.4.0+
Default: (empty)
Applications: API | | `ACCOUNT_REDIS_SSL_ENABLED` | If `true` Blockscout will use SSL to connect to Account Redis DB. Implemented in [#13901](https://github.com/blockscout/blockscout/pull/13901). | Version: v12.0.0+
Default: (empty)
Applications: API | | `ACCOUNT_REDIS_SENTINEL_URLS` | List of Account Redis sentinel urls. Implemented in [#13901](https://github.com/blockscout/blockscout/pull/13901). | Version: v12.0.0+
Default: (empty)
Applications: API | | `ACCOUNT_REDIS_SENTINEL_MASTER_NAME` | Account Sentinel master name. Implemented in [#13901](https://github.com/blockscout/blockscout/pull/13901). | Version: v12.0.0+
Default: (empty)
Applications: API | ## Specific Smart Contracts | Variable | Description | Parameters | | - | - | - | | `METADATA_CONTRACT` | Used by POA Network to obtain Validators information to display in the UI. | Version: all
Default: (empty)
Applications: API, Indexer | | `VALIDATORS_CONTRACT` | Used by POA Network to obtain the list of current validators. | Version: all
Default: (empty)
Applications: API, Indexer | | `KEYS_MANAGER_CONTRACT` | 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 | | `REWARDS_CONTRACT` | Emission rewards contract address. This env var is used only if `EMISSION_FORMAT` is set to `POA` | Version: v2.0.4+
Default: `0xeca443e8e1ab29971a45a9c57a6a9875701698a5`
Applications: API, Indexer | | `TOKEN_BRIDGE_CONTRACT` | Token bridge proxy contract. For `TokenBridge` supply module. | Version: v1.3.2+
Default: `0x7301CFA0e1756B71869E93d4e4Dca5c7d0eb0AA6`
Applications: API, Indexer | ## CDN This feature was implemented in [#10675](https://github.com/blockscout/blockscout/pull/10675). | Variable | Description | Parameters | | - | - | - | | `NFT_MEDIA_HANDLER_AWS_ACCESS_KEY_ID` | S3 API Access Key ID | Version: v6.10.0+
Default: (empty)
Applications: NFT\_MEDIA\_HANDLER | | `NFT_MEDIA_HANDLER_AWS_SECRET_ACCESS_KEY` | S3 API Secret Access Key | Version: v6.10.0+
Default: (empty)
Applications: NFT\_MEDIA\_HANDLER | | `NFT_MEDIA_HANDLER_AWS_BUCKET_HOST` | S3 API URL | Version: v6.10.0+
Default: (empty)
Applications: NFT\_MEDIA\_HANDLER | | `NFT_MEDIA_HANDLER_AWS_BUCKET_NAME` | S3 bucket name | Version: v6.10.0+
Default: (empty)
Applications: NFT\_MEDIA\_HANDLER | | `NFT_MEDIA_HANDLER_AWS_PUBLIC_BUCKET_URL` | Public S3 bucket URL | Version: v6.10.0+
Default: (empty)
Applications: API | | `NFT_MEDIA_HANDLER_ENABLED` | if `true`, CDN feature enabled | Version: v6.10.0+
Default: `false`
Applications: Indexer, NFT\_MEDIA\_HANDLER | | `NFT_MEDIA_HANDLER_REMOTE_DISPATCHER_NODE_MODE_ENABLED` | if `true`, nft media handler is supposed to run separately. | Version: v6.10.0+
Default: `false`
Applications: Indexer, NFT\_MEDIA\_HANDLER | | `NFT_MEDIA_HANDLER_IS_WORKER` | if `true`, and `NFT_MEDIA_HANDLER_REMOTE_DISPATCHER_NODE_MODE_ENABLED=true` only nft\_media\_handler app will be started | Version: v6.10.0+
Default: `false`
Applications: Indexer, NFT\_MEDIA\_HANDLER | | `NFT_MEDIA_HANDLER_WORKER_CONCURRENCY` | Concurrency of media handling (resizing/uploading) | Version: v6.10.0+
Default: `10`
Applications: NFT\_MEDIA\_HANDLER | | `NFT_MEDIA_HANDLER_WORKER_BATCH_SIZE` | Number of urls processed by one async task | Version: v6.10.0+
Default: `10`
Applications: NFT\_MEDIA\_HANDLER | | `NFT_MEDIA_HANDLER_WORKER_SPAWN_TASKS_TIMEOUT` | Timeout before spawning new task | Version: v6.10.0+
Default: `100ms`
Applications: NFT\_MEDIA\_HANDLER | | `NFT_MEDIA_HANDLER_BACKFILL_ENABLED` | If `true`, unprocessed token instances from DB are processed via nft\_media\_handler | Version: v6.10.0+
Default: `false`
Applications: Indexer | | `NFT_MEDIA_HANDLER_BACKFILL_QUEUE_SIZE` | Max size of backfill queue | Version: v6.10.0+
Default: `1000`
Applications: Indexer | | `NFT_MEDIA_HANDLER_BACKFILL_ENQUEUE_BUSY_WAITING_TIMEOUT` | Timeout before new attempt to append item to backfill queue if it's full | Version: v6.10.0+
Default: `1s`
Applications: Indexer | | `NFT_MEDIA_HANDLER_CACHE_UNIQUENESS_MAX_SIZE` | Max size of cache, where stored already uploaded token instances media | Version: v6.10.0+
Default: `100_000`
Applications: Indexer | | `NFT_MEDIA_HANDLER_BUCKET_FOLDER` | Folder in R2/S3 bucket, where media files are stored | Version: v9.2.0+
Default: (empty)
Applications: Indexer | ## Addresses Blacklist Management Section created as a result of [#11417](https://github.com/blockscout/blockscout/pull/11417). | Variable | Description | Parameters | | - | - | - | | `ADDRESSES_BLACKLIST` | A comma-separated list of addresses to enable restricted access to them. | Version: v6.10.0+
Default: (empty)
Applications: API | | `ADDRESSES_BLACKLIST_KEY` | A key to access blacklisted addresses (either by `ADDRESSES_BLACKLIST` or by blacklist provider). Can be passed via query param to the page's URL: `?key=...` | Version: v6.10.0+
Default: (empty)
Applications: API | | `ADDRESSES_BLACKLIST_PROVIDER` | Blacklist provider type, available options: `blockaid` | Version: v6.10.0+
Default: `blockaid`
Applications: API | | `ADDRESSES_BLACKLIST_URL` | URL to fetch blacklist from | Version: v6.10.0+
Default: (empty)
Applications: API | | `ADDRESSES_BLACKLIST_UPDATE_INTERVAL` | Interval between scheduled updates of blacklist | Version: v6.10.0+
Default: `15m`
Applications: API | | `ADDRESSES_BLACKLIST_RETRY_INTERVAL` | Time to wait before new attempt of blacklist fetching, after abnormal termination of fetching task | Version: v6.10.0+
Default: `5s`
Applications: API | ## Prometheus Metrics Management | Variable | Description | Parameters | | - | - | - | | `PUBLIC_METRICS_ENABLED` | Enables the `/public-metrics` endpoint. Implemented in [#10469](https://github.com/blockscout/blockscout/pull/10469). | Version: v6.8.0+
Default: `false`
Applications: API | | `PUBLIC_METRICS_UPDATE_PERIOD_HOURS` | Update frequency (in hours) for refreshing data at the `/public-metrics` endpoint. Implemented in [#10469](https://github.com/blockscout/blockscout/pull/10469). | Version: v6.8.0+
Default: 24
Applications: API | | `INDEXER_METRICS_ENABLED` | Flag to enable base indexer metrics. Implemented in [#13539](https://github.com/blockscout/blockscout/pull/13539). | Version: v9.3.0+
Default: true
Applications: Indexer | | `INDEXER_METRICS_ENABLED_TOKEN_INSTANCES_NOT_UPLOADED_TO_CDN_COUNT` | Flag to enable indexer metric: the count of token instances not uploaded to CDN. Implemented in [#13539](https://github.com/blockscout/blockscout/pull/13539). | Version: v9.3.0+
Default: false
Applications: Indexer | | `INDEXER_METRICS_ENABLED_FAILED_TOKEN_INSTANCES_METADATA_COUNT` | Flag to enable indexer metric: the count of token instances with failed metadata fetches. Implemented in [#13539](https://github.com/blockscout/blockscout/pull/13539). | Version: v9.3.0+
Default: true
Applications: Indexer | | `INDEXER_METRICS_ENABLED_UNFETCHED_TOKEN_INSTANCES_COUNT` | Flag to enable indexer metric: the count of token instances pending to fetch. Implemented in [#13539](https://github.com/blockscout/blockscout/pull/13539). | Version: v9.3.0+
Default: true
Applications: Indexer | | `INDEXER_METRICS_ENABLED_MISSING_CURRENT_TOKEN_BALANCES_COUNT` | Flag to enable indexer metric: the count of current token balances with missing values. Implemented in [#13539](https://github.com/blockscout/blockscout/pull/13539). | Version: v9.3.0+
Default: true
Applications: Indexer | | `INDEXER_METRICS_ENABLED_MISSING_ADDRESS_NATIVE_COIN_BALANCES_COUNT` | Flag to enable indexer metric: the count of address native coin balances with missing values. Implemented in [#14729](https://github.com/blockscout/blockscout/pull/14729). | Version: v11.2.8+
Default: true
Applications: Indexer | | `INDEXER_METRICS_ENABLED_MISSING_ARCHIVAL_TOKEN_BALANCES_COUNT` | Flag to enable indexer metric: the count of archival token balances with missing values. Implemented in [#13539](https://github.com/blockscout/blockscout/pull/13539). | Version: v9.3.0+
Default: true
Applications: Indexer | ## Old UI Management | Variable | Description | Parameters | | - | - | - | | `NETWORK` | Environment variable for the main EVM network such as Ethereum or POA. | Version: All
Default: `POA`
Applications: API | | `SUBNETWORK` | Environment variable for the subnetwork such as Core or Sokol Network. This will be displayed as selected in the chains list dropdown. | Version: All
Default: `POA Sokol`
Applications: API | | `JSON_RPC` | JSON RPC endpoint of the chain for the WalletConnect integration. Implemented in [#4931](https://github.com/blockscout/blockscout/pull/4931) | Version: v4.1.0+
Default: (empty)
Applications: API, Indexer | | `SHOW_MAINTENANCE_ALERT` | Disables/enables announcement at the top of the explorer. | Version: v3.6.0+
Default: `false`
Applications: API | | `MAINTENANCE_ALERT_MESSAGE` | Message text of the announcement at the top of the explorer. | Version: v3.6.0+
Default: (empty)
Applications: API | | `SHOW_ADDRESS_MARKETCAP_PERCENTAGE` | Configures market cap percentage column on the top accounts page. | Version: v2.1.1+
Default: `true`
Applications: API | | `HIDE_BLOCK_MINER` | Hides miner/validator/sequencer on block page and tiles if the value is `true`. Implemented in [#4611](https://github.com/blockscout/blockscout/pull/4611) | Version: v4.0.0+
Default: (empty)
Applications: API | | `DISPLAY_TOKEN_ICONS` | Displays token icons from Trust Wallet assets repository if `true`. Implemented in [#4596](https://github.com/blockscout/blockscout/pull/4596) | Version: v4.0.0+
Default: (empty)
Applications: API | | `DISABLE_ADD_TO_MM_BUTTON` | If `true`, "Add chain to MM" button doesn't appear. Implemented in [#6843](https://github.com/blockscout/blockscout/pull/6843) | Version: v5.1.0+
Default: (empty)
Applications: API | | `PERMANENT_DARK_MODE_ENABLED` | If `true`, permanent dark mode is enabled. Dark mode switcher is hidden in this case. Implemented in [#6763](https://github.com/blockscout/blockscout/pull/6763) | Version: v5.1.0+
Default: (empty)
Applications: API | | `PERMANENT_LIGHT_MODE_ENABLED` | If `true`, permanent light mode is enabled. Dark mode switcher is hidden. Implemented in [#6838](https://github.com/blockscout/blockscout/pull/6838) | Version: v5.1.0+
Default: (empty)
Applications: API | | `ADMIN_PANEL_ENABLED` | if `true` admin/\* routes are available. Implemented in [#5208](https://github.com/blockscout/blockscout/pull/5208). **NOTE: Only Available for Hosted Clients.** | Needs Recompile: βοΈ Version: v4.1.2+
Default: (empty)
Applications: API | ## Header and Footer ### Header | Variable | Description | Parameters | | - | - | - | | `LOGO` | Environment variable for the header logo image location. The logo files names for different chains can be found [here](https://github.com/poanetwork/blockscout/tree/master/apps/block_scout_web/assets/static/images). | Version: all
Default: `/images/blockscout_logo.svg`
Applications: API | | `SHOW_TESTNET_LABEL` | Enables testnet label right after logo in the navigation panel. Implemented in [#5732](https://github.com/blockscout/blockscout/pull/5732) | Version: v4.1.6+
Default: (empty)
Applications: API | | `TESTNET_LABEL_TEXT` | The text inside the test label. Implemented in [#5732](https://github.com/blockscout/blockscout/pull/5732) | Version: v4.1.6+
Default: `Testnet`
Applications: API | | `SUPPORTED_CHAINS` | An array of supported chains displayed in the chains dropdown. This var was introduced in this PR [#1900](https://github.com/poanetwork/blockscout/pull/1900) and looks like an array of JSON objects. | Version: v2.0.0+
Default: `[ { title: "POA", url: "https://blockscout.com/poa/core" }, { title: "Sokol", url: "https://blockscout.com/poa/sokol", test_net?: true }, { title: "Gnosis Chain", url: "https://gnosis.blockscout.com/" }, { title: "Ethereum Classic", url: "https://etc.blockscout.com", other?: true }, { title: "RSK", url: "https://rootstock.blockscout.com", other?: true } ]`
Applications: API | | `APPS_MENU` | true/false. If true, the Apps navigation menu item appears. | Version: v3.3.1+
Default: `false`
Applications: API | | `APPS` | An array of embedded/external apps to display in Apps menu item. This var was introduced in this PR [#3184](https://github.com/poanetwork/blockscout/pull/3184) and looks like an array of JSON objects. An example of an embedded link is described here [#6397](https://github.com/blockscout/blockscout/pull/6397) | Version: v5.0.0+
Default: (empty)
Applications: API | ### Footer | Variable | Description | Parameters | | - | - | - | | `FOOTER_LOGO` | Environment variable for the footer logo image location. The logo files names for different chains can be found [here](https://github.com/poanetwork/blockscout/tree/master/apps/block_scout_web/assets/static/images). | Version: all
Default: `/images/blockscout_logo.svg`
Applications: API | | `RELEASE_LINK` | The link to Blockscout release notes in the footer. | Version: v1.3.5+
Default: `https://github.com/poanetwork/blockscout/releases/tag/${BLOCKSCOUT_VERSION}`
Applications: API | | `BLOCKSCOUT_VERSION` | Added to the footer to signify the current Blockscout version. | Version: v1.3.4+
Default: (empty)
Applications: API | | `FOOTER_CHAT_LINK` | Link to Chat menu item in the footer. Implemented in [#5719](https://github.com/blockscout/blockscout/pull/5719). | Version: v4.1.6+
Default: `https://discord.gg/3CtNAqVMRV`
Applications: API | | `FOOTER_FORUM_LINK_ENABLED` | Enable forum menu item in the footer. | Version: v5.1.3+
Default: `false`
Applications: API | | `FOOTER_FORUM_LINK` | Link in Forum menu item in the footer. Implemented in [#5719](https://github.com/blockscout/blockscout/pull/5719) | Version: v4.1.6+
Default: `https://forum.poa.network/c/blockscout`
Applications: API | | `FOOTER_TELEGRAM_LINK_ENABLED` | Enable Telegram menu item in the footer. Implemented in [#7345](https://github.com/blockscout/blockscout/pull/7345). | Version: v5.1.4+
Default: `false`
Applications: API | | `FOOTER_TELEGRAM_LINK` | Link in Telegram menu item in the footer. Implemented in [#7345](https://github.com/blockscout/blockscout/pull/7345). | Version: v5.1.4+
Default: (empty)
Applications: API | | `FOOTER_GITHUB_LINK` | GitHub repository. Implemented in [#5719](https://github.com/blockscout/blockscout/pull/5719). | Version: v4.1.6+
Default: `https://github.com/blockscout/blockscout`
Applications: API | | `FOOTER_LINK_TO_OTHER_EXPLORERS` | true/false. If true, links to other explorers are added in the footer. | Version: v5.1.3+
Default: (empty)
Applications: API | | `FOOTER_OTHER_EXPLORERS` | The list of alternative explorers. | Version: v5.1.3+
Default: (empty)
Applications: API | # Backend ENVs for Chain-Specific Configuration Source: https://docs.blockscout.com/setup/env-variables/backend-envs-chain-specific Backend environment variables for configuring Blockscout per chain type, including CHAIN_TYPE settings for Ethereum, Polygon, rollups, and other networks. ## Chain Specific ENVs The following ENVs are specific to different types of chains and rollups. To use these specific variables you will also need to set the `CHAIN_TYPE` variable to the appropriate value. | Variable | Description | Parameters | | - | - | - | | CHAIN\_TYPE | Specifies the model of data and enables fetchers specific to the chain. | Version: v5.3.0+
Default: `default`
Applications: API, Indexer | ### Runtime vs Compile-time Chain Types
Default: `http://localhost:5052`
Applications: Indexer | | `INDEXER_DISABLE_BEACON_BLOB_FETCHER` | If `true` the Beacon data blobs fetcher won't be started, new transaction and block fields will still be extracted. Implemented in [#9168](https://github.com/blockscout/blockscout/pull/9168). | Version: v6.2.0+
Default: `false`
Applications: Indexer | | `INDEXER_BEACON_BLOB_FETCHER_SLOT_DURATION` | Slot duration in the Beacon Chain in seconds. Implemented in [#9168](https://github.com/blockscout/blockscout/pull/9168). Required if `INDEXER_OPTIMISM_L1_BATCH_BLOCKSCOUT_BLOBS_API_URL` is not empty and L1 is neither Mainnet, Sepolia, Holesky. | Version: v6.2.0+
Default: `12`
Applications: Indexer | | `INDEXER_BEACON_BLOB_FETCHER_REFERENCE_SLOT` | Any past finalized Beacon Chain slot number. Used as reference for blob inclusion slot calculations. Implemented in [#9168](https://github.com/blockscout/blockscout/pull/9168). Required if `INDEXER_OPTIMISM_L1_BATCH_BLOCKSCOUT_BLOBS_API_URL` is not empty and L1 is neither Mainnet, Sepolia, Holesky. | Version: v6.2.0+
Default: `8000000`
Applications: Indexer | | `INDEXER_BEACON_BLOB_FETCHER_REFERENCE_TIMESTAMP` | UTC timestamp of the Beacon Chain slot specified in `INDEXER_BEACON_BLOB_FETCHER_REFERENCE_SLOT`. Used as reference for blob inclusion slot calculations. Implemented in [#9168](https://github.com/blockscout/blockscout/pull/9168). Required if `INDEXER_OPTIMISM_L1_BATCH_BLOCKSCOUT_BLOBS_API_URL` is not empty and L1 is neither Mainnet, Sepolia, Holesky. | Version: v6.2.0+
Default: `1702824023`
Applications: Indexer | | `INDEXER_BEACON_BLOB_FETCHER_START_BLOCK` | Beacon Chain blob fetcher start block. On start-up, indexer will only look for missed blobs beyond this block number. It's recommended to set this block to the first block after the Dencun hardfork. Implemented in [#9168](https://github.com/blockscout/blockscout/pull/9168). | Version: v6.2.0+
Default: `19200000`
Applications: Indexer | | `INDEXER_BEACON_BLOB_FETCHER_END_BLOCK` | Beacon Chain blob fetcher end block. On start-up, indexer will only look for missed blobs before this block number. If set to `0`, then all recent till `latest` will be traversed. Implemented in [#9168](https://github.com/blockscout/blockscout/pull/9168). | Version: v6.2.0+
Default: `0`
Applications: Indexer | | `INDEXER_DISABLE_BEACON_DEPOSIT_FETCHER` | If `true`, the Beacon deposit fetcher won't be started. Implemented in [#12985](https://github.com/blockscout/blockscout/pull/12985). | Version: v9.1.0+
Default: `false`
Applications: Indexer | | `INDEXER_BEACON_DEPOSIT_FETCHER_INTERVAL` | The interval indicating how often deposit events should be queried. [Time format](/setup/env-variables/backend-envs-chain-specific#time-format). Implemented in [#12985](https://github.com/blockscout/blockscout/pull/12985). | Version: v9.1.0+
Default: `6s`
Applications: Indexer | | `INDEXER_BEACON_DEPOSIT_FETCHER_BATCH_SIZE` | The batch size specifies how many events are retrieved in a single database query. Implemented in [#12985](https://github.com/blockscout/blockscout/pull/12985). | Version: v9.1.0+
Default: `1000`
Applications: Indexer | | `INDEXER_DISABLE_BEACON_DEPOSIT_STATUS_FETCHER` | If `true`, the Beacon deposit status fetcher won't be started. Implemented in [#12985](https://github.com/blockscout/blockscout/pull/12985). | Version: v9.1.0+
Default: `false`
Applications: Indexer | | `INDEXER_BEACON_DEPOSIT_STATUS_FETCHER_EPOCH_DURATION` | Epoch duration in the Beacon chain in seconds. Implemented in [#12985](https://github.com/blockscout/blockscout/pull/12985). | Version: v9.1.0+
Default: `384`
Applications: Indexer | | `INDEXER_BEACON_DEPOSIT_STATUS_FETCHER_REFERENCE_TIMESTAMP` | Any past finalized Beacon Chain epoch UTC timestamp. Used as reference for status fetcher scheduling. Implemented in [#12985](https://github.com/blockscout/blockscout/pull/12985). | Version: v9.1.0+
Default: `1722024023`
Applications: Indexer | ## Rootstock Management | Variable | Description | Parameters | | - | - | - | | `ROOTSTOCK_REMASC_ADDRESS` | The address hash of remasc address on Rootstock chain. Implemented in [#8542](https://github.com/blockscout/blockscout/pull/8542). | Version: v5.3.0+
Default: (empty)
Applications: API | | `ROOTSTOCK_BRIDGE_ADDRESS` | The address hash of bridge address on Rootstock chain. Implemented in [#8542](https://github.com/blockscout/blockscout/pull/8542). | Version: v5.3.0+
Default: (empty)
Applications: API | | `INDEXER_DISABLE_ROOTSTOCK_DATA_FETCHER` | If `true` the fetcher of Rootstock specific fields for blocks that are already in the database won't be started, fields from new blocks will be extracted. Implemented in [#8742](https://github.com/blockscout/blockscout/pull/8742). | Version: v5.3.2+
Default: (empty)
Applications: Indexer | | `INDEXER_ROOTSTOCK_DATA_FETCHER_INTERVAL` | The interval between fetching the next `INDEXER_ROOTSTOCK_DATA_FETCHER_DB_BATCH_SIZE` blocks from the database and the node, used to configure the load on the database and JSON-RPC node. Implemented in [#8742](https://github.com/blockscout/blockscout/pull/8742). | Version: v5.3.2+
Default: (empty)
Applications: Indexer | | `INDEXER_ROOTSTOCK_DATA_FETCHER_BATCH_SIZE` | The number of requests in one JSON-RPC batch request, used to configure the load or RPS on JSON-RPC node. Implemented in [#8742](https://github.com/blockscout/blockscout/pull/8742). | Version: v5.3.2+
Default: (empty)
Applications: Indexer | | `INDEXER_ROOTSTOCK_DATA_FETCHER_CONCURRENCY` | The number of simultaneous requests to the JSON-RPC node, used to configure the load or RPS on JSON-RPC node. Implemented in [#8742](https://github.com/blockscout/blockscout/pull/8742). | Version: v5.3.2+
Default: (empty)
Applications: Indexer | | `INDEXER_ROOTSTOCK_DATA_FETCHER_DB_BATCH_SIZE` | The number of blocks fetched from the database in one database query. Implemented in [#8742](https://github.com/blockscout/blockscout/pull/8742). | Version: v5.3.2+
Default: (empty)
Applications: Indexer | | `INDEXER_TOKEN_TRANSFER_BLOCK_CONSENSUS_SANITIZER_INTERVAL` | Interval between token transfer block\_consensus sanitizing. Implemented in [#14144](https://github.com/blockscout/blockscout/pull/14144). | Version: v10.2.2+
Default: `20m`
Applications: Indexer | ## Scroll management | Variable | Description | Parameters | | - | - | - | | `INDEXER_SCROLL_L1_RPC` | The RPC endpoint for L1 used to fetch Deposit and Withdrawal messages. Implemented in [#10484](https://github.com/blockscout/blockscout/pull/10484). | Version: v6.9.0+
Default: (empty)
Applications: Indexer | | `INDEXER_SCROLL_L1_CHAIN_CONTRACT` | The address of ScrollChain contract on L1. Used to fetch batch and bundle events. Implemented in [#10819](https://github.com/blockscout/blockscout/pull/10819). | Version: v6.9.0+
Default: (empty)
Applications: Indexer | | `INDEXER_SCROLL_L1_BATCH_START_BLOCK` | The number of a start block on L1 to index L1 batches and bundles. If the table of batches is not empty, the process will continue indexing from the last indexed batch. Implemented in [#10819](https://github.com/blockscout/blockscout/pull/10819). | Version: v6.9.0+
Default: (empty)
Applications: Indexer | | `INDEXER_SCROLL_L1_BATCH_BLOCKSCOUT_BLOBS_API_URL` | Defines a URL to Blockscout Blobs API to retrieve L1 blobs from that. Example for Sepolia: `https://eth-sepolia.blockscout.com/api/v2/blobs`. Implemented in [#12294](https://github.com/blockscout/blockscout/pull/12294). | Version: v8.1.0+
Default: (empty)
Applications: Indexer | | `INDEXER_SCROLL_L1_MESSENGER_CONTRACT` | The address of L1 Scroll Messenger contract on L1 used to fetch Deposit and Withdrawal messages. Implemented in [#10484](https://github.com/blockscout/blockscout/pull/10484). | Version: v6.9.0+
Default: (empty)
Applications: Indexer | | `INDEXER_SCROLL_L1_MESSENGER_START_BLOCK` | The number of a start block on L1 to index L1 bridge messages. If the table of bridge operations is not empty, the process will continue indexing from the last indexed L1 message. Implemented in [#10484](https://github.com/blockscout/blockscout/pull/10484). | Version: v6.9.0+
Default: (empty)
Applications: Indexer | | `INDEXER_SCROLL_L2_MESSENGER_CONTRACT` | The address of L2 Scroll Messenger contract on L2 used to fetch Deposit and Withdrawal messages. Implemented in [#10484](https://github.com/blockscout/blockscout/pull/10484). | Version: v6.9.0+
Default: (empty)
Applications: Indexer | | `INDEXER_SCROLL_L2_MESSENGER_START_BLOCK` | The number of a start block on L2 to index L2 bridge messages. If the table of bridge operations is not empty, the process will continue indexing from the last indexed L2 message. Implemented in [#10484](https://github.com/blockscout/blockscout/pull/10484). | Version: v6.9.0+
Default: `FIRST_BLOCK`
Applications: Indexer | | `INDEXER_SCROLL_L2_GAS_ORACLE_CONTRACT` | The address of L1 Gas Oracle contract on L2. Implemented in [#10484](https://github.com/blockscout/blockscout/pull/10484). | Version: v6.9.0+
Default: (empty)
Applications: Indexer | | `INDEXER_SCROLL_L1_ETH_GET_LOGS_RANGE_SIZE` | Block range size for eth\_getLogs request in Scroll indexer modules for Layer 1. Implemented in [#10484](https://github.com/blockscout/blockscout/pull/10484). | Version: v6.9.0+
Default: `250`
Applications: Indexer | | `INDEXER_SCROLL_L2_ETH_GET_LOGS_RANGE_SIZE` | Block range size for eth\_getLogs request in Scroll indexer modules for Layer 2. Implemented in [#10484](https://github.com/blockscout/blockscout/pull/10484). | Version: v6.9.0+
Default: `1000`
Applications: Indexer | | `SCROLL_L2_CURIE_UPGRADE_BLOCK` | L2 block number of the Curie upgrade. Implemented in [#10484](https://github.com/blockscout/blockscout/pull/10484). | Version: v6.9.0+
Default: `0`
Applications: API | | `SCROLL_L1_SCALAR_INIT` | Initial value for `scalar` parameter. Implemented in [#10484](https://github.com/blockscout/blockscout/pull/10484). | Version: v6.9.0+
Default: `0`
Applications: API | | `SCROLL_L1_OVERHEAD_INIT` | Initial value for `overhead` parameter. Implemented in [#10484](https://github.com/blockscout/blockscout/pull/10484). | Version: v6.9.0+
Default: `0`
Applications: API | | `SCROLL_L1_COMMIT_SCALAR_INIT` | Initial value for `commit_scalar` parameter. Implemented in [#10484](https://github.com/blockscout/blockscout/pull/10484). | Version: v6.9.0+
Default: `0`
Applications: API | | `SCROLL_L1_BLOB_SCALAR_INIT` | Initial value for `blob_scalar` parameter. Implemented in [#10484](https://github.com/blockscout/blockscout/pull/10484). | Version: v6.9.0+
Default: `0`
Applications: API | | `SCROLL_L1_BASE_FEE_INIT` | Initial value for `l1_base_fee` parameter. Implemented in [#10484](https://github.com/blockscout/blockscout/pull/10484). | Version: v6.9.0+
Default: `0`
Applications: API | | `SCROLL_L1_BLOB_BASE_FEE_INIT` | Initial value for `l1_blob_base_fee` parameter. Implemented in [#10484](https://github.com/blockscout/blockscout/pull/10484). | Version: v6.9.0+
Default: `0`
Applications: API | ## Shibarium Management | Variable | Description | Parameters | | - | - | - | | `INDEXER_SHIBARIUM_L1_RPC` | The RPC endpoint for L1 used to fetch deposit or withdrawal events. Implemented in [#8929](https://github.com/blockscout/blockscout/pull/8929). | Version: v6.1.0+
Default: (empty)
Applications: Indexer | | `INDEXER_SHIBARIUM_L1_START_BLOCK` | The number of start block on L1 to index L1 events. If the table of bridge operations is not empty, the process will continue indexing from the last indexed L1 event. If empty or not defined, the L1 events are not handled. Implemented in [#8929](https://github.com/blockscout/blockscout/pull/8929). | Version: v6.1.0+
Default: (empty)
Applications: Indexer | | `INDEXER_SHIBARIUM_L1_DEPOSIT_MANAGER_CONTRACT` | The address of DepositManagerProxy contract on L1 used to fetch BONE token deposits. Required for L1 events indexing. Implemented in [#8929](https://github.com/blockscout/blockscout/pull/8929). | Version: v6.1.0+
Default: (empty)
Applications: Indexer | | `INDEXER_SHIBARIUM_L1_ETHER_PREDICATE_CONTRACT` | The address of EtherPredicateProxy contract on L1 used to fetch ETH deposits and withdrawals. Required for L1 events indexing. Implemented in [#8929](https://github.com/blockscout/blockscout/pull/8929). | Version: v6.1.0+
Default: (empty)
Applications: Indexer | | `INDEXER_SHIBARIUM_L1_ERC20_PREDICATE_CONTRACT` | The address of ERC20PredicateProxy contract on L1 used to fetch ERC20 token deposits and withdrawals. Required for L1 events indexing. Implemented in [#8929](https://github.com/blockscout/blockscout/pull/8929). | Version: v6.1.0+
Default: (empty)
Applications: Indexer | | `INDEXER_SHIBARIUM_L1_ERC721_PREDICATE_CONTRACT` | The address of ERC721PredicateProxy contract on L1 used to fetch ERC721 token deposits and withdrawals. Optional for L1 events indexing. Implemented in [#8929](https://github.com/blockscout/blockscout/pull/8929). | Version: v6.1.0+
Default: (empty)
Applications: Indexer | | `INDEXER_SHIBARIUM_L1_ERC1155_PREDICATE_CONTRACT` | The address of ERC1155PredicateProxy contract on L1 used to fetch ERC1155 token deposits and withdrawals. Optional for L1 events indexing. Implemented in [#8929](https://github.com/blockscout/blockscout/pull/8929). | Version: v6.1.0+
Default: (empty)
Applications: Indexer | | `INDEXER_SHIBARIUM_L1_WITHDRAW_MANAGER_CONTRACT` | The address of WithdrawManagerProxy contract on L1 used to fetch BONE token withdrawals. Required for L1 events indexing. Implemented in [#8929](https://github.com/blockscout/blockscout/pull/8929). | Version: v6.1.0+
Default: (empty)
Applications: Indexer | | `INDEXER_SHIBARIUM_L2_START_BLOCK` | The number of start block on L2 to index L2 events. If the table of bridge operations is not empty, the process will continue indexing from the last indexed L2 event. If empty or not defined, the L2 events are not handled. Implemented in [#8929](https://github.com/blockscout/blockscout/pull/8929). | Version: v6.1.0+
Default: (empty)
Applications: Indexer | | `INDEXER_SHIBARIUM_L2_CHILD_CHAIN_CONTRACT` | The address of ChildChain contract on L2 used to fetch BONE token deposits. Required for L2 events indexing. Implemented in [#8929](https://github.com/blockscout/blockscout/pull/8929). | Version: v6.1.0+
Default: (empty)
Applications: Indexer | | `INDEXER_SHIBARIUM_L2_WETH_CONTRACT` | The address of WETH contract on L2 used to fetch ETH deposits and withdrawals. Required for L2 events indexing. Implemented in [#8929](https://github.com/blockscout/blockscout/pull/8929). | Version: v6.1.0+
Default: (empty)
Applications: Indexer | | `INDEXER_SHIBARIUM_L2_BONE_WITHDRAW_CONTRACT` | The address of a contract which emits `Withdraw` event on L2. Used to fetch BONE token withdrawals. Required for L2 events indexing. Implemented in [#8929](https://github.com/blockscout/blockscout/pull/8929). | Version: v6.1.0+
Default: (empty)
Applications: Indexer | ## Optimism Rollup Management
Default: (empty)
Applications: Indexer | | `INDEXER_OPTIMISM_SUPERCHAIN_CONFIG_FILE_PATH` | Points to a Superchain TOML source (local file path or http(s) URL, including GitHub blob URLs) used to auto-load Optimism network parameters at startup and persist them into constants; empty/blank values are treated as unset. When provided, TOML values take priority and legacy envs are used only as per-field fallback; if neither TOML nor fallback provides a valid value, the stored constant is cleared to avoid stale config. This single variable can replace manual setup of: `INDEXER_OPTIMISM_L2_HOLOCENE_TIMESTAMP`, `INDEXER_OPTIMISM_L2_ISTHMUS_TIMESTAMP`, `INDEXER_OPTIMISM_L2_JOVIAN_TIMESTAMP`, `EIP_1559_BASE_FEE_MAX_CHANGE_DENOMINATOR`, `EIP_1559_ELASTICITY_MULTIPLIER`, `INDEXER_OPTIMISM_L1_SYSTEM_CONFIG_CONTRACT`, `INDEXER_OPTIMISM_L1_PORTAL_CONTRACT`, `INDEXER_OPTIMISM_L1_BATCH_SUBMITTER`, `INDEXER_OPTIMISM_L1_BATCH_INBOX`, `INDEXER_OPTIMISM_L1_START_BLOCK`, and `INDEXER_OPTIMISM_L2_BATCH_GENESIS_BLOCK_NUMBER`. | Version: v12.0.0+
Default: (empty)
Applications: Indexer | | `INDEXER_OPTIMISM_L1_SYSTEM_CONFIG_CONTRACT` | The address of `SystemConfig` contract on L1 required for almost all Optimism fetchers. Implemented in [#10199](https://github.com/blockscout/blockscout/pull/10199). | Version: v6.8.0+
Default: (empty)
Applications: Indexer | | `INDEXER_OPTIMISM_L1_BATCH_BLOCKSCOUT_BLOBS_API_URL` | Defines a URL to Blockscout Blobs API to retrieve L1 blobs from that. Example for Sepolia: `https://eth-sepolia.blockscout.com/api/v2/blobs`. Implemented in [#9571](https://github.com/blockscout/blockscout/pull/9571). | Version: v6.3.0+
Default: (empty)
Applications: Indexer | | `INDEXER_OPTIMISM_L1_BATCH_CELESTIA_BLOBS_API_URL` | Defines a URL to Celestia blobs indexer to retrieve L1 blobs from that. Example: `http://example.com/api/v1/celestia/blob`. Implemented in [#10199](https://github.com/blockscout/blockscout/pull/10199). | Version: v6.8.0+
Default: (empty)
Applications: Indexer | | `INDEXER_OPTIMISM_L1_BATCH_EIGENDA_BLOBS_API_URL` | Defines a URL to DA indexer supporting EigenDA layer to retrieve L1 blobs from that. Example: `https://da-indexer-dev.k8s-prod-3.blockscout.com/api/v1/eigenda/v2/blobs`. Implemented in [#13709](https://github.com/blockscout/blockscout/pull/13709). | Version: v10.0.0+
Default: (empty)
Applications: Indexer | | `INDEXER_OPTIMISM_L1_BATCH_EIGENDA_PROXY_BASE_URL` | Defines a URL to EigenDA proxy node which is used by the DA indexer (planned to be optional in the future). Example for MegaETH: `http://megaeth-eigenda-proxy.node.blockscout.com:3100`. Implemented in [#13709](https://github.com/blockscout/blockscout/pull/13709). | Version: v10.0.0+
Default: (empty)
Applications: Indexer | | `INDEXER_OPTIMISM_L1_BATCH_ALT_DA_SERVER_URL` | Defines a URL to Alt-DA server to retrieve L1 data from that. Example for Redstone: `https://da.redstonechain.com/get`. Implemented in [#13179](https://github.com/blockscout/blockscout/pull/13179). | Version: v9.2.0+
Default: (empty)
Applications: Indexer | | `INDEXER_OPTIMISM_L1_BATCH_BLOCKS_CHUNK_SIZE` | Blocks chunk size to send batch RPC requests. Implemented in [#6980](https://github.com/blockscout/blockscout/pull/6980). | Version: v6.3.0+
Default: `4`
Applications: Indexer | | `INDEXER_OPTIMISM_L2_BATCH_GENESIS_BLOCK_NUMBER` | L2 genesis block number. This is the first block of Optimism BedRock upgrade. Equals to 0 if the new chain starts being already upgraded. The block number can be found at [superchain registry](https://github.com/ethereum-optimism/superchain-registry/tree/main/superchain/configs). [Example](https://github.com/ethereum-optimism/superchain-registry/blob/main/superchain/configs/mainnet/op.yaml). Implemented in [#9260](https://github.com/blockscout/blockscout/pull/9260). | Version: v6.3.0+
Default: (empty)
Applications: Indexer | | `INDEXER_OPTIMISM_L1_OUTPUT_ORACLE_CONTRACT` | The address of `L2OutputOracle` contract on L1 used to fetch output roots. Required for output roots indexing. Implemented in [#6980](https://github.com/blockscout/blockscout/pull/6980). | Version: v6.3.0+
Default: (empty)
Applications: Indexer | | `INDEXER_OPTIMISM_L1_DEPOSITS_TRANSACTION_TYPE` | Defines OP Deposit transaction type (numeric value) which is needed for correct L2 transaction hash calculation by the Deposits indexing module. Implemented in [#10674](https://github.com/blockscout/blockscout/pull/10674). | Version: v6.9.0+
Default: `126`
Applications: Indexer | | `INDEXER_OPTIMISM_L2_WITHDRAWALS_START_BLOCK` | The number of start block on L2 to index withdrawals. If the table of withdrawals is not empty, the process will continue indexing from the last indexed withdrawal. Implemented in [#6980](https://github.com/blockscout/blockscout/pull/6980). | Version: v6.3.0+
Default: `1`
Applications: Indexer | | `INDEXER_OPTIMISM_L2_MESSAGE_PASSER_CONTRACT` | The address of `L2ToL1MessagePasser` contract on L2 to index withdrawals. Implemented in [#6980](https://github.com/blockscout/blockscout/pull/6980). | Version: v6.3.0+
Default: `0x4200000000000000000000000000000000000016`
Applications: Indexer | | `INDEXER_OPTIMISM_L1_ETH_GET_LOGS_RANGE_SIZE` | Block range size for eth\_getLogs request in OP indexer modules for Layer 1. Implemented in [#11073](https://github.com/blockscout/blockscout/pull/11073). | Version: v6.10.0+
Default: `250`
Applications: Indexer | | `INDEXER_OPTIMISM_L2_ETH_GET_LOGS_RANGE_SIZE` | Block range size for eth\_getLogs request in OP indexer modules for Layer 2. Implemented in [#11073](https://github.com/blockscout/blockscout/pull/11073). | Version: v6.10.0+
Default: `250`
Applications: Indexer | | `INDEXER_OPTIMISM_BLOCK_DURATION` | Block time in seconds for the OP chain. Used by the indexer modules. Implemented in [#11073](https://github.com/blockscout/blockscout/pull/11073). | Version: v6.10.0+
Default: `2`
Applications: Indexer | | `INDEXER_OPTIMISM_L1_PORTAL_CONTRACT` | Optional. The address of `OptimismPortal` contract on L1 used to fetch deposit and withdrawal events. Used as a fallback address (when it cannot be read from the `SystemConfig` contract) for deposit and withdrawal events indexing. Implemented in [#11073](https://github.com/blockscout/blockscout/pull/11073). | Version: v6.10.0+
Default: (empty)
Applications: Indexer | | `INDEXER_OPTIMISM_L1_START_BLOCK` | Optional. The number of L1 block from which the logs (events) scanning should start by the indexer. Used as a fallback number (when it cannot be read from the `SystemConfig` contract). Implemented in [#11073](https://github.com/blockscout/blockscout/pull/11073). | Version: v6.10.0+
Default: (empty)
Applications: Indexer | | `INDEXER_OPTIMISM_L1_BATCH_INBOX` | Optional. The inbox address to index transaction batches on L1. Used as a fallback address (when it cannot be read from the `SystemConfig` contract). Implemented in [#11073](https://github.com/blockscout/blockscout/pull/11073). | Version: v6.10.0+
Default: (empty)
Applications: Indexer | | `INDEXER_OPTIMISM_L1_BATCH_SUBMITTER` | Optional. The batch submitter address to index transaction batches on L1. Used as a fallback address (when it cannot be read from the `SystemConfig` contract). Implemented in [#11073](https://github.com/blockscout/blockscout/pull/11073). | Version: v6.10.0+
Default: (empty)
Applications: Indexer | | `INDEXER_OPTIMISM_L2_HOLOCENE_TIMESTAMP` | Holocene upgrade L2 block timestamp. If not defined, EIP-1559's denominator and multiplier are taken from `EIP_1559_BASE_FEE_MAX_CHANGE_DENOMINATOR` and `EIP_1559_ELASTICITY_MULTIPLIER` envs correspondingly. Implemented in [#11355](https://github.com/blockscout/blockscout/pull/11355). | Version: v6.10.1+
Default: (empty)
Applications: Indexer | | `INDEXER_OPTIMISM_L2_HOLOCENE_BLOCKS_CHUNK_SIZE` | Max number of blocks in `eth_getBlockByNumber` batch request. Implemented in [#11355](https://github.com/blockscout/blockscout/pull/11355). | Version: v6.10.1+
Default: `25`
Applications: Indexer | | `INDEXER_OPTIMISM_L2_ISTHMUS_TIMESTAMP` | Isthmus upgrade L2 block timestamp. Needed for operator fee determining. If set to `0`, the Isthmus is assumed to be active from genesis block. Implemented in [#13139](https://github.com/blockscout/blockscout/pull/13139). | Version: v9.2.0+
Default: (empty)
Applications: API, Indexer | | `INDEXER_OPTIMISM_L2_JOVIAN_TIMESTAMP` | Jovian upgrade L2 block timestamp. If set to `0`, the Jovian is assumed to be active from genesis block. Implemented in [#13538](https://github.com/blockscout/blockscout/pull/13538). | Version: v9.3.0+
Default: (empty)
Applications: API, Indexer | | `INDEXER_OPTIMISM_L2_INTEROP_START_BLOCK` | Defines a start block number for indexing interop messages (usually `0`). If not defined, the indexing is turned off. Implemented in [#11903](https://github.com/blockscout/blockscout/pull/11903). | Version: v8.0.0+
Default: (empty)
Applications: Indexer | | `INDEXER_OPTIMISM_L2_INTEROP_BLOCKS_CHUNK_SIZE` | Adjusts blocks chunk size when indexing failed relay transactions. Implemented in [#11903](https://github.com/blockscout/blockscout/pull/11903). | Version: v8.0.0+
Default: `4`
Applications: Indexer | | `INDEXER_OPTIMISM_INTEROP_PRIVATE_KEY` | 32-byte private key in form of `0x...` string. Required and used to `secp256k1` sign data being sent to `/api/v2/import/optimism/interop/` remote API endpoint. Implemented in [#11903](https://github.com/blockscout/blockscout/pull/11903). | Version: v8.0.0+
Default: (empty)
Applications: API, Indexer | | `INDEXER_OPTIMISM_INTEROP_CONNECT_TIMEOUT` | Timeout in seconds for establishing HTTP connection to `/api/v2/import/optimism/interop/` and `/api/v2/optimism/interop/public-key` remote API endpoints. Implemented in [#11903](https://github.com/blockscout/blockscout/pull/11903). | Version: v8.0.0+
Default: `8`
Applications: API, Indexer | | `INDEXER_OPTIMISM_INTEROP_RECV_TIMEOUT` | Timeout in seconds for receiving HTTP response from `/api/v2/import/optimism/interop/` or `/api/v2/optimism/interop/public-key` API endpoint. Implemented in [#11903](https://github.com/blockscout/blockscout/pull/11903). | Version: v8.0.0+
Default: `10`
Applications: API, Indexer | | `INDEXER_OPTIMISM_INTEROP_EXPORT_EXPIRATION_DAYS` | Limits the number of incomplete messages being sent through API to remote instances. The source or relay transactions older than this number of days (starting from the latest block) won't be considered by the handler of incomplete messages. Implemented in [#11903](https://github.com/blockscout/blockscout/pull/11903). | Version: v8.0.0+
Default: `10`
Applications: Indexer | | `INDEXER_OPTIMISM_CHAINSCOUT_API_URL` | URL to Chainscout API to get instance info by chain ID. Must be omitted for local development. For production must be `https://chains.blockscout.com/api/chains/`. Implemented in [#11903](https://github.com/blockscout/blockscout/pull/11903). | Version: v8.0.0+
Default: (empty)
Applications: API, Indexer | | `INDEXER_OPTIMISM_CHAINSCOUT_FALLBACK_MAP` | Defines `chain_id -> instance_url` map, for example: `{"10": "https://optimism.blockscout.com/", "8453": "https://base.blockscout.com/"}`. Supports extended format like `{"123": {"api": "https://test.blockscout.com:4000/", "ui": "https://test.blockscout.com:3000/"}}` (when backend and frontend have different URLs). Quotes usually are escaped when defining in config file, e.g.: `INDEXER_OPTIMISM_CHAINSCOUT_FALLBACK_MAP="{\"420120000\":\"http://host.docker.internal:4100/\"}"`. Implemented in [#11903](https://github.com/blockscout/blockscout/pull/11903). | Version: v8.0.0+
Default: (empty)
Applications: API, Indexer | | `INDEXER_OPTIMISM_MULTICHAIN_BATCH_SIZE` | Max number of items sent to the Multichain service in one batch. Implemented in [#12387](https://github.com/blockscout/blockscout/pull/12387). | Version: v9.0.0+
Default: `100`
Applications: Indexer | | `INDEXER_DISABLE_OPTIMISM_INTEROP_MULTICHAIN_EXPORT` | Disables exporting of interop messages to Multichain service. Implemented in [#13051](https://github.com/blockscout/blockscout/pull/13051). | Version: v9.1.0+
Default: `true`
Applications: Indexer | | `INDEXER_OPTIMISM_OPERATOR_FEE_QUEUE_BATCH_SIZE` | Batch size for OP operator fee fetcher. Defines max number of transactions handled per batch. Implemented in [#13139](https://github.com/blockscout/blockscout/pull/13139). | Version: v9.2.0+
Default: `100`
Applications: Indexer | | `INDEXER_OPTIMISM_OPERATOR_FEE_QUEUE_CONCURRENCY` | Concurrency for OP operator fee fetcher. Implemented in [#13139](https://github.com/blockscout/blockscout/pull/13139). | Version: v9.2.0+
Default: `3`
Applications: Indexer | | `INDEXER_OPTIMISM_OPERATOR_FEE_QUEUE_ENQUEUE_BUSY_WAITING_TIMEOUT` | Timeout before new attempt to append item to OP operator fee fetcher queue if it's full. [Time format](/setup/env-variables/backend-env-variables#time-format). Implemented in [#13139](https://github.com/blockscout/blockscout/pull/13139). | Version: v9.2.0+
Default: `1s`
Applications: Indexer | | `INDEXER_OPTIMISM_OPERATOR_FEE_QUEUE_MAX_QUEUE_SIZE` | Maximum size of OP operator fee fetcher queue. Implemented in [#13139](https://github.com/blockscout/blockscout/pull/13139). | Version: v9.2.0+
Default: `1000`
Applications: Indexer | | `INDEXER_OPTIMISM_OPERATOR_FEE_QUEUE_INIT_QUERY_LIMIT` | Limit of the init query for processing the OP operator fee fetcher queue. Implemented in [#13139](https://github.com/blockscout/blockscout/pull/13139). | Version: v9.2.0+
Default: `1000`
Applications: Indexer | ## zkSync Rollup Management
Default: `false`
Applications: Indexer | | `INDEXER_ZKSYNC_BATCHES_CHUNK_SIZE` | The number of RPC calls in one request when reading data from RPC. Implemented in [#9080](https://github.com/blockscout/blockscout/pull/9080). | Version: v6.3.0+
Default: `50`
Applications: Indexer | | `INDEXER_ZKSYNC_NEW_BATCHES_MAX_RANGE` | Maximum amount of batches requested if Blockscout does not have all batches synced. Implemented in [#9080](https://github.com/blockscout/blockscout/pull/9080). | Version: v6.3.0+
Default: `50`
Applications: Indexer | | `INDEXER_ZKSYNC_NEW_BATCHES_RECHECK_INTERVAL` | The latest batch rechecking interval, seconds. Implemented in [#9080](https://github.com/blockscout/blockscout/pull/9080). | Version: v6.3.0+
Default: `60`
Applications: Indexer | | `INDEXER_ZKSYNC_L1_RPC` | The RPC endpoint for L1 used to fetch status of batches. Implemented in [#9080](https://github.com/blockscout/blockscout/pull/9080). | Version: v6.3.0+
Default: (empty)
Applications: Indexer | | `INDEXER_ZKSYNC_BATCHES_STATUS_RECHECK_INTERVAL` | The batches status rechecking interval, seconds. Implemented in [#9080](https://github.com/blockscout/blockscout/pull/9080). | Version: v6.3.0+
Default: `50`
Applications: Indexer | ## Arbitrum Management
Default: `0x0000000000000000000000000000000000000064`
Applications: Indexer | | `INDEXER_ARBITRUM_NODE_INTERFACE_CONTRACT` | The address of NodeInterface contract on the rollup. Implemented in [#9312](https://github.com/blockscout/blockscout/pull/9312). | Version: v6.8.0+
Default: `0x00000000000000000000000000000000000000C8`
Applications: Indexer | | `INDEXER_ARBITRUM_L1_RPC` | The RPC endpoint for L1 used to fetch transaction batches, block confirmations, and cross-chain messages. Implemented in [#9312](https://github.com/blockscout/blockscout/pull/9312). | Version: v6.7.0+
Default: empty
Applications: Indexer | | `INDEXER_ARBITRUM_L1_RPC_CHUNK_SIZE` | The number of RPC calls in one request when reading data from RPC. Implemented in [#9312](https://github.com/blockscout/blockscout/pull/9312). | Version: v6.7.0+
Default: `20`
Applications: Indexer | | `INDEXER_ARBITRUM_L1_RPC_HISTORICAL_BLOCKS_RANGE` | The block range size for the eth\_getLogs request. Implemented in [#9312](https://github.com/blockscout/blockscout/pull/9312). | Version: v6.7.0+
Default: `1000`
Applications: Indexer | | `INDEXER_ARBITRUM_L1_ROLLUP_CONTRACT` | The Arbitrum Rollup contract address on L1. Implemented in [#9312](https://github.com/blockscout/blockscout/pull/9312). | Version: v6.7.0+
Default: empty
Applications: Indexer | | `INDEXER_ARBITRUM_L1_ROLLUP_INIT_BLOCK` | The block number where the Arbitrum rollup contract has been deployed. Implemented in [#9312](https://github.com/blockscout/blockscout/pull/9312). | Version: v6.7.0+
Default: `1`
Applications: Indexer | | `INDEXER_ARBITRUM_L1_COMMON_START_BLOCK` | The block number at which synchronization will commence. It will proceed in both directions: discovering new batches up to the chain head, and historical batches until `INDEXER_ARBITRUM_L1_ROLLUP_INIT_BLOCK`. If omitted, the synchronization starts from the latest block. Implemented in [#9312](https://github.com/blockscout/blockscout/pull/9312). | Version: v6.7.0+
Default: `latest block`
Applications: Indexer | | `INDEXER_ARBITRUM_L1_FINALIZATION_THRESHOLD` | The number of blocks below the blockchain head that are considered not yet finalized in environments where the settlement layer is another rollup, or when the L1 node does not support safe block retrieval. Implemented in [#10482](https://github.com/blockscout/blockscout/pull/10482). | Version: v6.8.0+
Default: `1000`
Applications: Indexer | | `INDEXER_ARBITRUM_ROLLUP_CHUNK_SIZE` | The number of RPC calls in one request when reading data from RPC. Implemented in [#9312](https://github.com/blockscout/blockscout/pull/9312). | Version: v6.7.0+
Default: `20`
Applications: Indexer | | `INDEXER_ARBITRUM_BRIDGE_MESSAGES_TRACKING_ENABLED` | Enables monitoring on L1 of cross-chain messages directed to L2 and catchup on L2 of historical cross-chain messages. Implemented in [#9312](https://github.com/blockscout/blockscout/pull/9312). | Version: v6.7.0+
Default: (empty)
Applications: Indexer | | `INDEXER_ARBITRUM_MISSED_MESSAGES_RECHECK_INTERVAL` | Interval to re-check on the rollup historical messages directed to and from the rollup, in seconds. Implemented in [#9312](https://github.com/blockscout/blockscout/pull/9312). | Version: v6.7.0+
Default: `3600`
Applications: Indexer | | `INDEXER_ARBITRUM_MISSED_MESSAGES_BLOCKS_DEPTH` | Amount of L2 blocks to revisit to identify historical cross-chain messages in the messages catchup task. Implemented in [#10374](https://github.com/blockscout/blockscout/pull/10374). | Version: v6.8.0+
Default: `10000`
Applications: Indexer | | `INDEXER_ARBITRUM_TRACKING_MESSAGES_ON_L1_RECHECK_INTERVAL` | Interval to re-check on L1 new messages directed to the rollup, in seconds. Implemented in [#9312](https://github.com/blockscout/blockscout/pull/9312). | Version: v6.7.0+
Default: `20`
Applications: Indexer | | `INDEXER_ARBITRUM_MESSAGES_TRACKING_FAILURE_THRESHOLD` | The time threshold for L1 message tracking tasks. If a task has not run successfully within this threshold, it is marked as failed and enters a cooldown period before retrying. Implemented in [#13792](https://github.com/blockscout/blockscout/pull/13792). | Version: v10.0.0+
Default: `10m`
Applications: Indexer | | `INDEXER_ARBITRUM_MISSED_MESSAGE_IDS_RANGE` | Size of each message ID range inspected when discovering L1-to-L2 messages with missing L1 origination information. Implemented in [#13792](https://github.com/blockscout/blockscout/pull/13792). | Version: v10.0.0+
Default: `10000`
Applications: Indexer | | `INDEXER_ARBITRUM_BATCHES_TRACKING_ENABLED` | Enables monitoring of transaction batches, block confirmations, and L2-to-L1 messages executions. Implemented in [#9312](https://github.com/blockscout/blockscout/pull/9312). | Version: v6.7.0+
Default: (empty)
Applications: Indexer | | `INDEXER_ARBITRUM_BATCHES_TRACKING_RECHECK_INTERVAL` | Interval to re-check on L1 new and historical batches, confirmations, and executions, in seconds. Implemented in [#9312](https://github.com/blockscout/blockscout/pull/9312). | Version: v6.7.0+
Default: `20`
Applications: Indexer | | `INDEXER_ARBITRUM_BATCHES_TRACKING_L1_FINALIZATION_CHECK_ENABLED` | Whether L1 transactions related to batches, confirmations, and executions need to be monitored for finalization or not. Implemented in [#9312](https://github.com/blockscout/blockscout/pull/9312). | Version: v6.7.0+
Default: `false`
Applications: Indexer | | `INDEXER_ARBITRUM_BATCHES_TRACKING_MESSAGES_TO_BLOCKS_SHIFT` | Difference between the message count and actual rollup block numbers in the SequencerBatchDelivered event on L1. Applicable for ArbitrumOne only. Implemented in [#9312](https://github.com/blockscout/blockscout/pull/9312). | Version: v6.7.0+
Default: `0`
Applications: Indexer | | `INDEXER_ARBITRUM_BATCHES_TRACKING_FAILURE_THRESHOLD` | The time threshold for transaction batch monitoring tasks. If a task has not run successfully within this threshold, it is marked as failed and enters a cooldown period before retrying. Implemented in [#12192](https://github.com/blockscout/blockscout/pull/12192). | Version: v8.0.0+
Default: `10m`
Applications: Indexer | | `INDEXER_ARBITRUM_MISSING_BATCHES_RANGE` | Size of each batch range which will be inspected for the missing batches. Since it is not expected that batches are missed often, it is OK to have this value relatively large. Implemented in [#10466](https://github.com/blockscout/blockscout/pull/10446). | Version: v6.8.0+
Default: `10000`
Applications: Indexer | | `INDEXER_ARBITRUM_CONFIRMATIONS_TRACKING_FINALIZED` | Whether to choose `safe` (true) or `latest` (false) block to discover new confirmations. This setting is required to reduce latency between the actual confirmation transaction and its discovery. Recommended to have true on rollups which use Ethereum Mainnet as L1. Determines how fast new confirmations will be discovered. Implemented in [#9312](https://github.com/blockscout/blockscout/pull/9312). | Version: v6.7.0+
Default: `true`
Applications: Indexer | | `INDEXER_ARBITRUM_NEW_BATCHES_LIMIT` | The number of batches to be handled and imported at once. This is applicable for cases when dozens of batches are found in one discovery iteration, and it is necessary to import them in chunks to avoid the entire process being aborted if any errors occur. Implemented in [#9312](https://github.com/blockscout/blockscout/pull/9312). | Version: v6.7.0+
Default: `10`
Applications: Indexer | | `INDEXER_ARBITRUM_DATA_BACKFILL_ENABLED` | Enables a process to backfill the blocks and transaction with Arbitrum specific data. This should only be enabled for Arbitrum chains where blocks were indexed before upgrading to a version that includes Arbitrum-specific data indexing features. Implemented in [#11163](https://github.com/blockscout/blockscout/pull/11163). | Version: v7.0.0+
Default: `false`
Applications: Indexer | | `INDEXER_ARBITRUM_DATA_BACKFILL_UNINDEXED_BLOCKS_RECHECK_INTERVAL` | The number of L2 blocks to look back in one iteration of the backfill process. Implemented in [#11163](https://github.com/blockscout/blockscout/pull/11163). | Version: v7.0.0+
Default: `120s`
Applications: Indexer | | `INDEXER_ARBITRUM_DATA_BACKFILL_BLOCKS_DEPTH` | Interval to retry the backfill task for unindexed blocks. Implemented in [#11163](https://github.com/blockscout/blockscout/pull/11163). | Version: v7.0.0+
Default: `500`
Applications: Indexer | | `MIGRATION_ARBITRUM_DA_RECORDS_NORMALIZATION_BATCH_SIZE` | Specifies the number of address records processed per batch during normalization of batch-to-blob associations by moving them from arbitrum\_da\_multi\_purpose to a dedicated arbitrum\_batches\_to\_da\_blobs table. Implemented in [#11798](https://github.com/blockscout/blockscout/pull/11798). | Version: v7.0.0+
Default: `500`
Applications: Indexer | | `MIGRATION_ARBITRUM_DA_RECORDS_NORMALIZATION_CONCURRENCY` | Specifies the number of concurrent processes used during normalization of batch-to-blob associations by moving them from arbitrum\_da\_multi\_purpose to a dedicated arbitrum\_batches\_to\_da\_blobs table. Implemented in [#11798](https://github.com/blockscout/blockscout/pull/11798). | Version: v7.0.0+
Default: `1`
Applications: Indexer | ## Celo Management
Default: (empty)
Applications: API, Indexer | | `CELO_L2_MIGRATION_BLOCK` | Specifies the block number at which Celo transitioned from L1 to L2, disabling legacy L1 mechanisms (e.g., L1 epochs, old precompiles) once the migration block is indexed. Implemented in [#11949](https://github.com/blockscout/blockscout/pull/11949). | Version: v8.0.0+
Applications: API, Indexer | | `INDEXER_DISABLE_CELO_EPOCH_FETCHER` | If set to `true`, the epoch rewards fetcher will not be started. However, epoch blocks pending to fetch will still be imported into the database. Implemented in [#9944](https://github.com/blockscout/blockscout/pull/9944). | Version: v6.8.0+
Default: `false`
Applications: Indexer | | `INDEXER_DISABLE_CELO_VALIDATOR_GROUP_VOTES_FETCHER` | If set to `true`, the validator group votes fetcher will not be started. Implemented in [#10673](https://github.com/blockscout/blockscout/pull/10673). | Version: v6.9.0+
Default: `false`
Applications: Indexer | | `INDEXER_CELO_VALIDATOR_GROUP_VOTES_BATCH_SIZE` | Specifies the block range size for the `eth_getLogs` request, determining the number of blocks included between `toBlock` and `fromBlock`. Implemented in [#9944](https://github.com/blockscout/blockscout/pull/9944). | Version: v6.8.0+
Default: `200000`
Applications: Indexer | | `CELO_UNRELEASED_TREASURY_CONTRACT` | The address of the `CeloUnreleasedTreasury` core contract. Implemented in [#12373](https://github.com/blockscout/blockscout/pull/12373). | Version: v9.0.0+
Default: (empty)
Applications: Indexer | | `CELO_VALIDATORS_CONTRACT` | The address of the `Validators` core contract. Implemented in [#12373](https://github.com/blockscout/blockscout/pull/12373). | Version: v9.0.0+
Default: (empty)
Applications: Indexer | | `CELO_EPOCH_MANAGER_CONTRACT` | The address of the `EpochManager` core contract. Implemented in [#12373](https://github.com/blockscout/blockscout/pull/12373). | Version: v9.0.0+
Default: (empty)
Applications: Indexer | | `CELO_LOCKED_GOLD_CONTRACT` | The address of the `LockedGold` core contract. Implemented in [#12893](https://github.com/blockscout/blockscout/pull/12893). | Version: v9.2.0+
Default: (empty)
Applications: Indexer | | `CELO_ACCOUNTS_CONTRACT` | The address of the `Accounts` core contract. Implemented in [#12893](https://github.com/blockscout/blockscout/pull/12893). | Version: v9.2.0+
Default: (empty)
Applications: Indexer | | `INDEXER_CELO_ACCOUNTS_CONCURRENCY` | Sets the maximum number of concurrent requests for fetching Celo accounts. | Version: v9.2.0+
Default: `1`
Applications: Indexer | | `INDEXER_CELO_ACCOUNTS_BATCH_SIZE` | Specifies the number of account addresses processed per batch during fetching. | Version: v9.2.0+
Default: `100`
Applications: Indexer | ### Required Optimism ENVs for Celo Since Celo runs on the OP Stack, you must also configure all applicable Optimism environment variables from the [Optimism Rollup Management](#optimism-rollup-management) section above.
Default: `f`
Applications: API, Indexer | | `BERYX_API_TOKEN` | [Beryx API](https://docs.zondax.ch/beryx-api) token, used for retrieving Filecoin native addressing information. Implemented in [#10468](https://github.com/blockscout/blockscout/pull/10468). | Required: β Version: v6.9.0+
Default: (empty)
Applications: Indexer | | `BERYX_API_BASE_URL` | [Beryx API](https://docs.zondax.ch/beryx-api) base URL. Implemented in [#10468](https://github.com/blockscout/blockscout/pull/10468). | Version: v6.9.0+
Default: `https://api.zondax.ch/fil/data/v3/mainnet`
Applications: Indexer | | `FILFOX_API_BASE_URL` | [Filfox API](https://filfox.info/api/v1/docs/static/index.html) base URL. Implemented in [#11412](https://github.com/blockscout/blockscout/pull/11412). | Version: v7.0.0+
Default: `https://filfox.info/api/v1`
Applications: Indexer | | `INDEXER_DISABLE_FILECOIN_ADDRESS_INFO_FETCHER` | When set to `true`, Filecoin native addressing information will not be fetched, but addresses pending fetch will still be recorded in the database. Implemented in [#10468](https://github.com/blockscout/blockscout/pull/10468). | Version: v6.9.0+
Default: `false`
Applications: Indexer | | `INDEXER_FILECOIN_ADDRESS_INFO_CONCURRENCY` | Sets the maximum number of concurrent requests made to fetch Filecoin native addressing information. Implemented in [#10468](https://github.com/blockscout/blockscout/pull/10468). | Version: v6.9.0+
Default: `1`
Applications: Indexer | | `MIGRATION_FILECOIN_PENDING_ADDRESS_OPERATIONS_BATCH_SIZE` | Specifies the number of address records processed per batch during the backfill of pending address fetch operations. Implemented in [#11798](https://github.com/blockscout/blockscout/pull/11798). | Version: v7.0.0+
Default: `100`
Applications: Indexer | | `MIGRATION_FILECOIN_PENDING_ADDRESS_OPERATIONS_CONCURRENCY` | Specifies the number of concurrent processes used during the backfill of pending address fetch operations. Implemented in [#11798](https://github.com/blockscout/blockscout/pull/11798). | Version: v7.0.0+
Default: `1`
Applications: Indexer | ## Blackfort Management
Default: (empty)
Applications: API, Indexer | ## Arc Management
Default: `6`
Applications: Indexer | | `INDEXER_ARC_NATIVE_TOKEN_CONTRACT` | Arc chain native token contract address. Implemented in [#13452](https://github.com/blockscout/blockscout/pull/13452). | Version: v9.3.0+
Default: `0x3600000000000000000000000000000000000000`
Applications: Indexer | | `INDEXER_ARC_NATIVE_TOKEN_SYSTEM_CONTRACT` | Arc chain system contract address emitting `NativeCoinTransferred` event. Implemented in [#13452](https://github.com/blockscout/blockscout/pull/13452). | Version: v9.3.0+
Default: `0x1800000000000000000000000000000000000000`
Applications: Indexer | # Backend ENVs for Blockscout Integrations Source: https://docs.blockscout.com/setup/env-variables/backend-envs-integrations Environment variables for configuring Blockscout backend integrations with Rust microservices, external APIs, and third-party services via MICROSERVICE ENVs.
Default: `1000`
Applications: API | | `MICROSERVICE_HTTP_POOL_COUNT` | Number of individual connection pools to split `MICROSERVICE_HTTP_POOL_SIZE` across. Pool splitting allows traffic to spread across multiple processes, reducing contention. Each pool size is calculated as `MICROSERVICE_HTTP_POOL_SIZE / MICROSERVICE_HTTP_POOL_COUNT`. Implemented in [#14707](https://github.com/blockscout/blockscout/pull/14707) | Version: v11.2.7+
Default: `4`
Applications: API, Indexer | ## Smart-contract verifier / Eth Bytecode DB
Default: `true`
Applications: API | | `MICROSERVICE_SC_VERIFIER_URL` | URL of Rust smart-contract verifier. Implemented in [#5860](https://github.com/blockscout/blockscout/pull/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](https://github.com/blockscout/blockscout/pull/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](https://github.com/blockscout/blockscout/pull/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](https://github.com/blockscout/blockscout/pull/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](https://github.com/blockscout/blockscout/pull/8750) | Version: v5.3.2+
Default: (empty)
Applications: API | ## Sol2Uml
Default: (empty)
Applications: API | | `MICROSERVICE_VISUALIZE_SOL2UML_URL` | URL of Rust visualizer. Implemented in [#6401](https://github.com/blockscout/blockscout/pull/6401) | Version: v5.1.3+
Default: (empty)
Applications: API | ## Sig-provider
Default: (empty)
Applications: API | | `MICROSERVICE_SIG_PROVIDER_URL` | URL of Rust sig-provider service. Implemented in [#6541](https://github.com/blockscout/blockscout/pull/6541) | Version: v5.1.3+
Default: (empty)
Applications: API | ## Blockscout ENS
Default: (empty)
Applications: API | | `MICROSERVICE_BENS_URL` | URL of Blockscout ENS service. Implemented in [#8972](https://github.com/blockscout/blockscout/pull/8972) | Version: v5.4.0+
Default: (empty)
Applications: API | | `MICROSERVICE_BENS_PROTOCOLS` | Comma-separated list of ENS protocols. Implemented in [#13992](https://github.com/blockscout/blockscout/pull/13992) | Version: v10.0.0+
Default: (empty)
Applications: API | | `DISABLE_BLOCKS_BENS_PRELOAD` | If `true`, skips ENS name preloading in responses for block list endpoints: `/api/v2/blocks`, `/api/v2/main-page/blocks`, `/api/v2/blocks/optimism-batch/:batch_number`, `/api/v2/blocks/scroll-batch/:batch_number`. | Version: v11.0.0+
Default: `false`
Applications: API | | `DISABLE_TRANSACTIONS_BENS_PRELOAD` | If `true`, skips ENS name preloading in responses for transaction list endpoints: `/api/v2/transactions`, `/api/v2/transactions/watchlist`, `/api/v2/main-page/transactions`, `/api/v2/main-page/transactions/watchlist`, `/api/v2/addresses/:hash/transactions`, `/api/v2/blocks/:hash/transactions`. | Version: v11.0.0+
Default: `false`
Applications: API | | `DISABLE_TOKEN_TRANSFERS_BENS_PRELOAD` | If `true`, skips ENS name preloading in responses for token transfer list endpoints: `/api/v2/token-transfers`, `/api/v2/addresses/:hash/token-transfers`, `/api/v2/tokens/:address_hash_param/transfers`. | Version: v11.0.0+
Default: `false`
Applications: API | ## Blockscout Account Abstraction
Default: (empty)
Applications: API | | `MICROSERVICE_ACCOUNT_ABSTRACTION_URL` | URL of Blockscout ENS service. Implemented in [#9145](https://github.com/blockscout/blockscout/pull/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](https://github.com/blockscout/blockscout/pull/8957) | Version: v5.4.0+
Default: (empty)
Applications: API | | `MICROSERVICE_TRANSACTION_INTERPRETATION_URL` | URL of Tx Interpreter Service. Implemented in [#8957](https://github.com/blockscout/blockscout/pull/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](https://github.com/blockscout/blockscout/pull/9706) | Version: v6.4.0+
Default: (empty)
Applications: API | | `MICROSERVICE_METADATA_URL` | URL of Metadata Service. Implemented in [#9706](https://github.com/blockscout/blockscout/pull/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](https://github.com/blockscout/blockscout/pull/11656) | Version: v7.0.0+
Default: `30s`
Applications: API | ## Multichain Search Service
Default: (empty)
Applications: API, Indexer | | `MICROSERVICE_MULTICHAIN_SEARCH_API_KEY` | Multichain Search Service API key. Implemented in [#11139](https://github.com/blockscout/blockscout/pull/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](https://github.com/blockscout/blockscout/pull/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](https://github.com/blockscout/blockscout/pull/12867) | Version: v9.0.0+
Default: 1000
Applications: Indexer | | `MICROSERVICE_MULTICHAIN_SEARCH_COUNTERS_CHUNK_SIZE` | Chunk size of counters while exporting to Multichain Search DB. Implemented in [#13007](https://github.com/blockscout/blockscout/pull/13007). | Version: v9.1.0+
Default: `1000`
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](https://github.com/blockscout/blockscout/pull/12377). | Version: v9.0.0+
Default: `false`
Applications: Indexer | | `INDEXER_MULTICHAIN_SEARCH_DB_EXPORT_MAIN_QUEUE_BATCH_SIZE` | Batch size for multichain DB main (blocks, transactions, addresses) export fetcher. Implemented in [#12377](https://github.com/blockscout/blockscout/pull/12377). | Version: v9.0.0+
Default: `1000`
Applications: Indexer | | `INDEXER_MULTICHAIN_SEARCH_DB_EXPORT_MAIN_QUEUE_CONCURRENCY` | Concurrency for multichain DB main (blocks, transactions, addresses) export fetcher. Implemented in [#12377](https://github.com/blockscout/blockscout/pull/12377). | Version: v9.0.0+
Default: `10`
Applications: 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](/setup/env-variables/backend-env-variables#time-format). Implemented in [#12377](https://github.com/blockscout/blockscout/pull/12377). | Version: v9.0.0+
Default: `1s`
Applications: 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](https://github.com/blockscout/blockscout/pull/12377). | Version: v9.0.0+
Default: `1000`
Applications: 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](https://github.com/blockscout/blockscout/pull/12822). | Version: v9.0.0+
Default: `1000`
Applications: Indexer | | `INDEXER_DISABLE_MULTICHAIN_SEARCH_DB_EXPORT_BALANCES_QUEUE_FETCHER` | If `true`, multichain DB balances export fetcher doesn't run. Implemented in [#12580](https://github.com/blockscout/blockscout/pull/12580). | Version: v9.0.0+
Default: `false`
Applications: Indexer | | `INDEXER_MULTICHAIN_SEARCH_DB_EXPORT_BALANCES_QUEUE_BATCH_SIZE` | Batch size for multichain DB balances export fetcher. Implemented in [#12580](https://github.com/blockscout/blockscout/pull/12580). | Version: v9.0.0+
Default: `1000`
Applications: Indexer | | `INDEXER_MULTICHAIN_SEARCH_DB_EXPORT_BALANCES_QUEUE_CONCURRENCY` | Concurrency for multichain DB balances export fetcher. Implemented in [#12580](https://github.com/blockscout/blockscout/pull/12580). | Version: v9.0.0+
Default: `10`
Applications: 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](/setup/env-variables/backend-env-variables#time-format). Implemented in [#12580](https://github.com/blockscout/blockscout/pull/12580). | Version: v9.0.0+
Default: `1s`
Applications: Indexer | | `INDEXER_MULTICHAIN_SEARCH_DB_EXPORT_BALANCES_QUEUE_MAX_QUEUE_SIZE` | Maximum size of multichain DB balances export queue. Implemented in [#12580](https://github.com/blockscout/blockscout/pull/12580). | Version: v9.0.0+
Default: `1000`
Applications: 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](https://github.com/blockscout/blockscout/pull/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](https://github.com/blockscout/blockscout/pull/12867). | Version: v9.0.0+
Default: `false`
Applications: Indexer | | `INDEXER_MULTICHAIN_SEARCH_DB_EXPORT_TOKEN_INFO_QUEUE_BATCH_SIZE` | Batch size for multichain DB token info export fetcher. Implemented in [#12867](https://github.com/blockscout/blockscout/pull/12867). | Version: v9.0.0+
Default: `1000`
Applications: Indexer | | `INDEXER_MULTICHAIN_SEARCH_DB_EXPORT_TOKEN_INFO_QUEUE_CONCURRENCY` | Concurrency for multichain DB token info export fetcher. Implemented in [#12867](https://github.com/blockscout/blockscout/pull/12867). | Version: v9.0.0+
Default: `10`
Applications: 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](/setup/env-variables/backend-env-variables#time-format). Implemented in [#12867](https://github.com/blockscout/blockscout/pull/12867). | Version: v9.0.0+
Default: `1s`
Applications: Indexer | | `INDEXER_MULTICHAIN_SEARCH_DB_EXPORT_TOKEN_INFO_QUEUE_MAX_QUEUE_SIZE` | Maximum size of multichain DB token info export queue. Implemented in [#12867](https://github.com/blockscout/blockscout/pull/12867). | Version: v9.0.0+
Default: `1000`
Applications: 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](https://github.com/blockscout/blockscout/pull/12867). | Version: v9.0.0+
Default: `1000`
Applications: Indexer | | `INDEXER_DISABLE_MULTICHAIN_SEARCH_DB_EXPORT_COUNTERS_QUEUE_FETCHER` | If `true`, multichain DB counters export fetcher doesn't run. Implemented in [#13007](https://github.com/blockscout/blockscout/pull/13007). | Version: v9.1.0+
Default: `false`
Applications: Indexer | | `INDEXER_MULTICHAIN_SEARCH_DB_EXPORT_COUNTERS_QUEUE_BATCH_SIZE` | Batch size for multichain DB counters export fetcher. Implemented in [#13007](https://github.com/blockscout/blockscout/pull/13007). | Version: v9.1.0+
Default: `1000`
Applications: Indexer | | `INDEXER_MULTICHAIN_SEARCH_DB_EXPORT_COUNTERS_QUEUE_CONCURRENCY` | Concurrency for multichain DB counters export fetcher. Implemented in [#13007](https://github.com/blockscout/blockscout/pull/13007). | Version: v9.1.0+
Default: `10`
Applications: Indexer | | `INDEXER_MULTICHAIN_SEARCH_DB_EXPORT_COUNTERS_QUEUE_ENQUEUE_BUSY_WAITING_TIMEOUT` | Timeout before new attempt to append item to multichain DB counters export queue if it's full. [Time format](/setup/env-variables/backend-env-variables#time-format). Implemented in [#13007](https://github.com/blockscout/blockscout/pull/13007). | Version: v9.1.0+
Default: `1s`
Applications: Indexer | | `INDEXER_MULTICHAIN_SEARCH_DB_EXPORT_COUNTERS_QUEUE_MAX_QUEUE_SIZE` | Maximum size of multichain DB counters export queue. Implemented in [#13007](https://github.com/blockscout/blockscout/pull/13007). | Version: v9.1.0+
Default: `1000`
Applications: Indexer | | `INDEXER_MULTICHAIN_SEARCH_DB_EXPORT_COUNTERS_QUEUE_INIT_QUERY_LIMIT` | Limit of the init query for processing the counters export queue to the Multichain DB. Implemented in [#13007](https://github.com/blockscout/blockscout/pull/13007). | Version: v9.1.0+
Default: `1000`
Applications: Indexer | | `MIGRATION_BACKFILL_MULTICHAIN_SEARCH_BATCH_SIZE` | Batch size of backfilling Multichain Search Service DB. Implemented in [#11139](https://github.com/blockscout/blockscout/pull/11139) | Version: v6.10.0+
Default: 10
Applications: Indexer | | `MIGRATION_BACKFILL_MULTICHAIN_SEARCH_CURRENT_TOKEN_BALANCES_DISABLED` | If `true`, the backfill migration that exports current token balances from Blockscout to Multichain Search DB does not run. The migration is also disabled when `MICROSERVICE_MULTICHAIN_SEARCH_URL` is unset or `MIGRATION_BACKFILL_MULTICHAIN_SEARCH_CURRENT_TOKEN_BALANCES_LAST_BLOCK_NUMBER` is unset. Implemented in [#14304](https://github.com/blockscout/blockscout/pull/14304). | Version: v12.0.0+
Default: `false`
Applications: Indexer | | `MIGRATION_BACKFILL_MULTICHAIN_SEARCH_CURRENT_TOKEN_BALANCES_LAST_BLOCK_NUMBER` | Upper block number bound for the current token balances backfill. Only records from `address_current_token_balances` with `block_number` less than or equal to this value are exported. Required for the migration to start. When `TRACE_BLOCK_RANGES` is configured, only balances within those ranges are exported. Implemented in [#14304](https://github.com/blockscout/blockscout/pull/14304). | Version: v12.0.0+
Default: (empty)
Applications: Indexer | | `MIGRATION_BACKFILL_MULTICHAIN_SEARCH_CURRENT_TOKEN_BALANCES_BATCH_SIZE` | Number of current token balances to export in each batch during the Multichain Search DB backfill. Implemented in [#14304](https://github.com/blockscout/blockscout/pull/14304). | Version: v12.0.0+
Default: `100`
Applications: Indexer | | `MIGRATION_BACKFILL_MULTICHAIN_SEARCH_CURRENT_TOKEN_BALANCES_CONCURRENCY` | Number of parallel batches processing during the current token balances Multichain Search DB backfill. Implemented in [#14304](https://github.com/blockscout/blockscout/pull/14304). | Version: v12.0.0+
Default: `4`
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](https://github.com/blockscout/blockscout/pull/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](https://github.com/blockscout/blockscout/pull/12367) | Version: v8.1.0+
Default: `true`
Applications: API | ## Sourcify
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. Override the env var if a custom repository URL is set. | Version: v3.7.0+
Default: `https://repo.sourcify.dev/`
Applications: API | | `SOURCIFY_POLL_INTERVAL` | Interval between async verification polling requests. [Time format](/setup/env-variables/backend-env-variables#time-format). Implemented in [#14584](https://github.com/blockscout/blockscout/pull/14584). | Version: latest
Default: `3s`
Applications: API | | `SOURCIFY_POLL_MAX_ATTEMPTS` | Maximum number of attempts for async verification polling. Implemented in [#14584](https://github.com/blockscout/blockscout/pull/14584) | Version: latest
Default: `20`
Applications: API | ## Tenderly | Variable | Description | Parameters | | - | - | - | | `SHOW_TENDERLY_LINK` | if `true`, "Open in Tenderly" button is displayed on the transaction page. Implemented in [#4656](https://github.com/blockscout/blockscout/pull/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](https://github.com/blockscout/blockscout/pull/4656) | Version: v4.0.0+
Default: (empty)
Applications: API | ## Datadog
Default: (empty)
Applications: API | | `DATADOG_PORT` | Port configuration setting for [Datadog integration](https://docs.datadoghq.com/integrations/). | Version: all
Default: (empty)
Applications: API | ## Spandex
Default: (empty)
Applications: API | | `SPANDEX_SYNC_THRESHOLD` | [Spandex](https://github.com/spandex-project/spandex) and Datadog configuration setting. | Version: all
Default: (empty)
Applications: API | ## Analytics
Default: (empty)
Applications: API | | `MIXPANEL_URL` | Url to use Mixpanel with proxy ([Collection via Proxy](https://developer.mixpanel.com/docs/collection-via-a-proxy)). | Needs Recompile: βοΈ Version: v5.0.0+
Default: (empty)
Applications: API | | `AMPLITUDE_API_KEY` | [Amplitude](https://amplitude.com/) 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](https://www.docs.developers.amplitude.com/analytics/domain-proxy/)). | Needs Recompile: βοΈ Version: v5.0.0+
Default: (empty)
Applications: API | ## Solidityscan
Default: 16
Applications: API | | `SOLIDITYSCAN_CHAIN_ID` | Internal chain id in [Solidityscan](https://apidoc.solidityscan.com/solidityscan-security-api/solidityscan-other-apis/quickscan-api-v1). It may not match with actual chain ID. Implemented in [#8908](https://github.com/blockscout/blockscout/pull/8908) | Version: v5.3.3+
Default: (empty)
Applications: API | | `SOLIDITYSCAN_API_TOKEN` | API token for usage of [Solidityscan API](https://apidoc.solidityscan.com/solidityscan-security-api/solidityscan-other-apis/quickscan-api-v1). | Version: v5.3.3+
Default: (empty)
Applications: API | ## Noves.fi
Default: `https://blockscout.noves.fi`
Applications: API | | `NOVES_FI_CHAIN_NAME` | [Noves.fi API](https://blockscout.noves.fi/swagger/index.html) chain name. Implemented in [#9056](https://github.com/blockscout/blockscout/pull/9056). | Version: v6.1.0+
Default: (empty)
Applications: API | | `NOVES_FI_API_TOKEN` | [Noves.fi API](https://blockscout.noves.fi/swagger/index.html) token. Implemented in [#9056](https://github.com/blockscout/blockscout/pull/9056). | Version: v6.1.0+
Default: (empty)
Applications: API | ## Xname app
Default: `https://gateway.xname.app`
Applications: API | | `XNAME_API_TOKEN` | [Xname API](https://xname.app/) token. Implemented in [#11010](https://github.com/blockscout/blockscout/pull/11010). | Version: v6.9.2+
Default: (empty)
Applications: API | ## Stylus contract verifier
Default: (empty)
Applications: API | # Deprecated Backend ENVs Source: https://docs.blockscout.com/setup/env-variables/deprecated-env-variables Reference table of deprecated Blockscout backend environment variables with defaults, versions introduced, and the release each was removed.
`, ``, etc.) | - | - | `{"name":"Montserrat","url":"https://fonts.googleapis.com/css2?family=Montserrat:wght@400;500;600;700&display=swap"}` | v1.35.0+ |
| NEXT\_PUBLIC\_FONT\_FAMILY\_BODY | `FontFamily`, see full description [below](/setup/env-variables/frontend-common-envs/envs#font-family-configuration-properties) | Main typeface to use in page content elements. | - | - | `{"name":"Raleway","url":"https://fonts.googleapis.com/css2?family=Raleway:wght@400;500;600;700&display=swap"}` | v1.35.0+ |
| NEXT\_PUBLIC\_MAX\_CONTENT\_WIDTH\_ENABLED | `boolean` | Set to `true` to restrict the page content width on extra-large screens. | - | `true` | `false` | v1.34.1+ |
#### Network explorer configuration properties
| Variable | Type | Description | Compulsoriness | Default value | Example value |
| - | - | - | - | - | - |
| logo | `string` | URL to explorer logo file. Should be at least 40x40. | - | - | `https://foo.app/icon.png` |
| title | `string` | Displayed name of the explorer | Required | - | `Anyblock` |
| baseUrl | `string` | Base url of the explorer | Required | - | `https://explorer.anyblock.tools` |
| paths | `RecordβΉ"tx" \| "block" \| "address" \| "token", stringβΊ` | Map of explorer entities and their paths. Path can be a template with `:id` or `:id_lowercase` param, or a string (see note below) | Required | - | `{"tx":"/ethereum/poa/core/tx"}` |
*Note* If a path template contains `:id` or `:id_lowercase`, it will be replaced with the entity-id in its original case or lowercased respectively. If neither parameter is present, the entity-id will be appended to the end of the path in lowercase. For example, with baseUrl `https://explorer.anyblock.tools`:
* Path `{"tx":"/ethereum/poa/core/tx/:id/details"}` and entity-id `0x123...AbC` results in `https://explorer.anyblock.tools/ethereum/poa/core/tx/0x123...AbC/details`
* Path `{"tx":"/ethereum/poa/core/tx/:id_lowercase/details"}` and entity-id `0x123...AbC` results in `https://explorer.anyblock.tools/ethereum/poa/core/tx/0x123...abc/details`
* Path `{"tx":"/ethereum/poa/core/tx"}` and entity-id `0x123...AbC` results in `https://explorer.anyblock.tools/ethereum/poa/core/tx/0x123...abc`
#### Contract code IDE configuration properties
| Variable | Type | Description | Compulsoriness | Default value | Example value |
| - | - | - | - | - | - |
| title | `string` | Displayed name of the IDE | Required | - | `Remix IDE` |
| url | `string` | URL of the IDE with placeholders for contract hash (`{hash}`) and current domain (`{domain}`) | Required | - | `https://remix.blockscout.com/?address={hash}&blockscout={domain}` |
| icon\_url | `string` | URL of the IDE icon | Required | - | `https://example.com/icon.svg` |
#### Font family configuration properties
| Variable | Type | Description | Compulsoriness | Default value | Example value |
| - | - | - | - | - | - |
| name | `string` | Font family name; used to define the `font-family` CSS property. | Required | - | `Montserrat` |
| url | `string` | URL for external font. Ensure the font supports the following weights: 400, 500, 600, and 700. | Required | - | `https://fonts.googleapis.com/css2?family=Montserrat:wght@400;500;600;700&display=swap` |
## 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 entire app context.
### My account
| Variable | Type | Description | Compulsoriness | Default value | Example value | Version |
| - | - | - | - | - | - | - |
| NEXT\_PUBLIC\_IS\_ACCOUNT\_SUPPORTED | `boolean` | Set to true if network has account feature | Required | - | `true` | v1.0.x+ |
| NEXT\_PUBLIC\_RE\_CAPTCHA\_APP\_SITE\_KEY | `boolean` | See [below](https://github.com/blockscout/docs/blob/master/setup/env-variables/frontend-common-envs/ENVS.md#google-recaptcha) | Required | - | `` | v1.0.x+ |
| NEXT\_PUBLIC\_AUTH0\_CLIENT\_ID | `string` | **DEPRECATED** Client id for [Auth0](https://auth0.com/) provider | - | - | `` | v1.0.x+ |
| NEXT\_PUBLIC\_AUTH\_URL | `string` | **DEPRECATED** Account auth base url; it is used for building login URL (`${ NEXT_PUBLIC_AUTH_URL }/auth/auth0`) and logout return URL (`${ NEXT_PUBLIC_AUTH_URL }/auth/logout`); if not provided the base app URL will be used instead | - | - | `https://blockscout.com` | v1.0.x+ |
| NEXT\_PUBLIC\_LOGOUT\_URL | `string` | **DEPRECATED** Account logout url. Required if account is supported for the app instance. | - | - | `https://blockscoutcom.us.auth0.com/v2/logout` | 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 | `boolean` | Set to true to enable "Gas tracker" in the app | Required | `true` | `false` | v1.25.0+ |
| NEXT\_PUBLIC\_GAS\_TRACKER\_UNITS | `ArrayβΉ"usd" \| "gwei"βΊ` | 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. | - | `[ "usd", "gwei" ]` | `[ "gwei" ]` | v1.25.0+ |
### Advanced filter
This feature is **enabled by default**. To switch it off pass `NEXT_PUBLIC_ADVANCED_FILTER_ENABLED=false`.
| Variable | Type | Description | Compulsoriness | Default value | Example value | Version |
| - | - | - | - | - | - | - |
| NEXT\_PUBLIC\_ADVANCED\_FILTER\_ENABLED | `boolean` | Set to true to enable "Advanced filter" page in the app | Required | `true` | `false` | v1.37.0+ |
### Address verification in "My account"
*Note* all ENV variables required for [My account](https://github.com/blockscout/docs/blob/master/setup/env-variables/frontend-common-envs/ENVS.md#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 | `string` | Contract Info API endpoint url | Required | - | `https://contracts-info.services.blockscout.com` | v1.1.0+ |
| NEXT\_PUBLIC\_ADMIN\_SERVICE\_API\_HOST | `string` | Admin Service API endpoint url | Required | - | `https://admin-rs.services.blockscout.com` | v1.1.0+ |
### Blockchain interaction (writing to contract, etc.)
| Variable | Type | Description | Compulsoriness | Default value | Example value | Version |
| - | - | - | - | - | - | - |
| NEXT\_PUBLIC\_WALLET\_CONNECT\_PROJECT\_ID | `string` | Project id for [WalletConnect](https://cloud.walletconnect.com/) integration | Required | - | `` | v1.0.x+ |
| NEXT\_PUBLIC\_NETWORK\_RPC\_URL | `string` | See in [Blockchain parameters](https://github.com/blockscout/docs/blob/master/setup/env-variables/frontend-common-envs/ENVS.md#blockchain-parameters) section | Required | - | `https://core.poa.network` | v1.0.x+ |
| NEXT\_PUBLIC\_NETWORK\_NAME | `string` | See in [Blockchain parameters](https://github.com/blockscout/docs/blob/master/setup/env-variables/frontend-common-envs/ENVS.md#blockchain-parameters) section | Required | - | `Gnosis Chain` | v1.0.x+ |
| NEXT\_PUBLIC\_NETWORK\_ID | `number` | See in [Blockchain parameters](https://github.com/blockscout/docs/blob/master/setup/env-variables/frontend-common-envs/ENVS.md#blockchain-parameters) section | Required | - | `99` | v1.0.x+ |
| NEXT\_PUBLIC\_NETWORK\_CURRENCY\_NAME | `string` | See in [Blockchain parameters](https://github.com/blockscout/docs/blob/master/setup/env-variables/frontend-common-envs/ENVS.md#blockchain-parameters) section | Required | - | `Ether` | v1.0.x+ |
| NEXT\_PUBLIC\_NETWORK\_CURRENCY\_SYMBOL | `string` | See in [Blockchain parameters](https://github.com/blockscout/docs/blob/master/setup/env-variables/frontend-common-envs/ENVS.md#blockchain-parameters) section | Required | - | `ETH` | v1.0.x+ |
| NEXT\_PUBLIC\_NETWORK\_CURRENCY\_DECIMALS | `string` | See in [Blockchain parameters](https://github.com/blockscout/docs/blob/master/setup/env-variables/frontend-common-envs/ENVS.md#blockchain-parameters) section | - | `18` | `6` | v1.0.x+ |
### Banner ads
Ads are enabled by default on all self-hosted instances. If you would like to disable ads, you can disable using the [Autoscout hosted service](/using-blockscout/autoscout).
### Text ads
Ads are enabled by default on all self-hosted instances. If you would like to disable ads, you can disable using the [Autoscout hosted service](/using-blockscout/autoscout).
### Beacon chain
| Variable | Type | Description | Compulsoriness | Default value | Example value | Version |
| - | - | - | - | - | - | - |
| NEXT\_PUBLIC\_HAS\_BEACON\_CHAIN | `boolean` | Set to true for networks with the beacon chain | Required | - | `true` | v1.0.x+ |
| NEXT\_PUBLIC\_BEACON\_CHAIN\_CURRENCY\_SYMBOL | `string` | Beacon network currency symbol | - | `NEXT_PUBLIC_NETWORK_CURRENCY_SYMBOL` | `ETH` | v1.0.x+ |
### User operations (ERC-4337)
| Variable | Type | Description | Compulsoriness | Default value | Example value | Version |
| - | - | - | - | - | - | - |
| NEXT\_PUBLIC\_HAS\_USER\_OPS | `boolean` | Set to true to show user operations related data and pages | - | - | `true` | v1.23.0+ |
### Rollup chain
| Variable | Type | Description | Compulsoriness | Default value | Example value | Version |
| - | - | - | - | - | - | - |
| NEXT\_PUBLIC\_ROLLUP\_TYPE | `"optimistic" \| "arbitrum" \| "shibarium" \| "zkEvm" \| "zkSync" \| "scroll"` | Rollup chain type | Required | - | `"optimistic"` | v1.24.0+ |
| NEXT\_PUBLIC\_ROLLUP\_L1\_BASE\_URL | `string` | Blockscout base URL for L1 network. **DEPRECATED** **`Use NEXT_PUBLIC_ROLLUP_PARENT_CHAIN instead`** | Required | - | `http://eth-goerli.blockscout.com` | v1.24.0+ |
| NEXT\_PUBLIC\_ROLLUP\_L2\_WITHDRAWAL\_URL | `string` | URL for L2 -> L1 withdrawals (Optimistic stack only) | Required for `optimistic` rollups | - | `https://app.optimism.io/bridge/withdraw` | v1.24.0+ |
| NEXT\_PUBLIC\_ROLLUP\_STAGE\_INDEX | `"1" \| "2"` | Reflects the maturity and decentralization level of the chain based on [L2BEAT's framework](https://medium.com/l2beat/introducing-stages-a-framework-to-evaluate-rollups-maturity-d290bb22befe). The label will be added to the sidebar according to the provided stage index. Not applicable for testnets. | - | - | `"1"` | v2.1.0+ |
| NEXT\_PUBLIC\_FAULT\_PROOF\_ENABLED | `boolean` | Set to `true` for chains with fault proof system enabled (Optimistic stack only) | - | - | `true` | v1.31.0+ |
| NEXT\_PUBLIC\_HAS\_MUD\_FRAMEWORK | `boolean` | Set to `true` for instances that use MUD framework (Optimistic stack only) | - | - | `true` | v1.33.0+ |
| NEXT\_PUBLIC\_INTEROP\_ENABLED | `boolean` | Enables "Interop messages" page (Optimistic stack only) | - | `false` | `true` | v1.39.0+ |
| NEXT\_PUBLIC\_ROLLUP\_HOMEPAGE\_SHOW\_LATEST\_BLOCKS | `boolean` | Set to `true` to display "Latest blocks" widget instead of "Latest batches" on the home page | - | - | `true` | v1.36.0+ |
| NEXT\_PUBLIC\_ROLLUP\_OUTPUT\_ROOTS\_ENABLED | `boolean` | Enables "Output roots" page (Optimistic stack only) | - | `false` | `true` | v1.37.0+ |
| NEXT\_PUBLIC\_ROLLUP\_PARENT\_CHAIN\_NAME | `string` | Set to customize L1 transaction status labels in the UI (e.g., "Sent to "). This setting is applicable only for Arbitrum-based chains. **DEPRECATED** **`Use NEXT_PUBLIC_ROLLUP_PARENT_CHAIN instead`** | - | - | `DuckChain` | v1.37.0+ |
| NEXT\_PUBLIC\_ROLLUP\_PARENT\_CHAIN | `ParentChain`, see details [below](/setup/env-variables/frontend-common-envs/envs#parent-chain-configuration-properties) | Configuration parameters for the parent chain. | - | - | `{"baseUrl":"https://explorer.duckchain.io"}` | v1.38.0+ |
| NEXT\_PUBLIC\_ROLLUP\_DA\_CELESTIA\_NAMESPACE | `string` | Hex-string for creating a link to the transaction batch on the Celenium explorer. "0x"-format and 60 symbol length. Available only for Arbitrum roll-ups. | - | - | `0x00000000000000000000000000000000000000ca1de12a9905be97beaf` | v1.38.0+ |
| NEXT\_PUBLIC\_ROLLUP\_DA\_CELESTIA\_CELENIUM\_URL | `string` | URL for the Celenium explorer. It is used to create links to the Data Availability Blobs page. The URL should contain the full path without any search parameters related to the blob, as these will be constructed at runtime for each blob separately. Available only for Optimistic or Arbitrum roll-ups. | - | - | `https://mocha.celenium.io/blob` | v2.0.2+ |
#### Parent chain configuration properties
| Variable | Type | Description | Compulsoriness | Default value | Example value |
| - | - | - | - | - | - |
| id | `number` | Chain id, see [https://chainlist.org](https://chainlist.org) for the reference. | - | - | `42` |
| name | `string` | Displayed name of the chain. Set to customize L1 transaction status labels in the UI (e.g., "Sent to "). Currently, this setting is applicable only for Arbitrum-based chains. | - | - | `DuckChain` |
| baseUrl | `string` | Base url of the chain explorer. | Required | - | `https://explorer.duckchain.io` |
| rpcUrls | `ArrayβΉstringβΊ` | Chain public RPC server urls, see [https://chainlist.org](https://chainlist.org) for the reference. | - | - | `["https://rpc.duckchain.io"]` |
| currency | `{ name: string; symbol: string; decimals: number; }` | Chain currency config. | - | - | `{ name: Quack, symbol: QUA, decimals: 18 }` |
| isTestnet | `boolean` | Set to true if network is testnet. | - | - | `true` |
### Export data to CSV file
| Variable | Type | Description | Compulsoriness | Default value | Example value | Version |
| - | - | - | - | - | - | - |
| NEXT\_PUBLIC\_RE\_CAPTCHA\_APP\_SITE\_KEY | `string` | See [below](https://github.com/blockscout/docs/blob/master/setup/env-variables/frontend-common-envs/ENVS.md#google-recaptcha) | true | - | `` | v1.0.x+ |
### Google analytics
| Variable | Type | Description | Compulsoriness | Default value | Example value | Version |
| - | - | - | - | - | - | - |
| NEXT\_PUBLIC\_GOOGLE\_ANALYTICS\_PROPERTY\_ID | `string` | Property ID for [Google Analytics](https://analytics.google.com/) service | true | - | `UA-XXXXXX-X` | v1.0.x+ |
### Mixpanel analytics
| Variable | Type | Description | Compulsoriness | Default value | Example value | Version |
| - | - | - | - | - | - | - |
| NEXT\_PUBLIC\_MIXPANEL\_PROJECT\_TOKEN | `string` | Project token for [Mixpanel](https://mixpanel.com/) 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 | `string` | Client SDK key for [GrowthBook](https://www.growthbook.io/) 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 | `string` | Txn hash for default query at GraphQl playground page. Pass `none` to disable the feature. | - | - | `0x4a0ed8ddf751a7cb5297f827699117b0f6d21a0b2907594d300dc9fed75c7e62` | 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 | `string` | Spec to be displayed on `/api-docs` page. Pass `none` to disable the feature. | - | `https://raw.githubusercontent.com/blockscout/blockscout-api-v2-swagger/main/swagger.yaml` | `https://raw.githubusercontent.com/blockscout/blockscout-api-v2-swagger/main/swagger.yaml` | v1.0.x+ |
### Marketplace
| Variable | Type | Description | Compulsoriness | Default value | Example value | Version |
| - | - | - | - | - | - | - |
| NEXT\_PUBLIC\_MARKETPLACE\_ENABLED | `boolean` | `true` means that the marketplace page will be enabled | Required | - | `true` | v1.24.1+ |
| NEXT\_PUBLIC\_MARKETPLACE\_CONFIG\_URL | `string` | URL of configuration file (`.json` format only) which contains list of apps that will be shown on the marketplace page. See [below](/setup/env-variables/frontend-common-envs/envs#marketplace-app-configuration-properties) list of available properties for an app. Can be replaced with NEXT\_PUBLIC\_ADMIN\_SERVICE\_API\_HOST | Required | - | `https://example.com/marketplace_config.json` | v1.0.x+ |
| NEXT\_PUBLIC\_ADMIN\_SERVICE\_API\_HOST | `string` | Admin Service API endpoint url. Can be used instead of NEXT\_PUBLIC\_MARKETPLACE\_CONFIG\_URL | - | - | `https://admin-rs.services.blockscout.com` | v1.1.0+ |
| NEXT\_PUBLIC\_MARKETPLACE\_SUBMIT\_FORM | `string` | Link to form where authors can submit their dapps to the marketplace | Required | - | `https://airtable.com/shrqUAcjgGJ4jU88C` | v1.0.x+ |
| NEXT\_PUBLIC\_MARKETPLACE\_SUGGEST\_IDEAS\_FORM | `string` | Link to form where users can suggest ideas for the marketplace | - | - | `https://airtable.com/appiy5yijZpMMSKjT/pag3t82DUCyhGRZZO/form` | v1.24.0+ |
| NEXT\_PUBLIC\_NETWORK\_RPC\_URL | `string` | See in [Blockchain parameters](https://github.com/blockscout/docs/blob/master/setup/env-variables/frontend-common-envs/ENVS.md#blockchain-parameters) section | Required | - | `https://core.poa.network` | v1.0.x+ |
| NEXT\_PUBLIC\_MARKETPLACE\_CATEGORIES\_URL | `string` | URL of configuration file (`.json` format only) which contains the list of categories to be displayed on the marketplace page in the specified order. If no URL is provided, then the list of categories will be compiled based on the `categories` fields from the marketplace (apps) configuration file | - | - | `https://example.com/marketplace_categories.json` | v1.23.0+ |
| NEXT\_PUBLIC\_MARKETPLACE\_SECURITY\_REPORTS\_URL | `string` | URL of configuration file (`.json` format only) which contains app security reports for displaying security scores on the Marketplace page | - | - | `https://example.com/marketplace_security_reports.json` | v1.28.0+ |
| NEXT\_PUBLIC\_MARKETPLACE\_FEATURED\_APP | `string` | ID of the featured application to be displayed on the banner on the Marketplace page | - | - | `uniswap` | v1.29.0+ |
| NEXT\_PUBLIC\_MARKETPLACE\_BANNER\_CONTENT\_URL | `string` | URL of the banner HTML content | - | - | `https://example.com/banner` | v1.29.0+ |
| NEXT\_PUBLIC\_MARKETPLACE\_BANNER\_LINK\_URL | `string` | URL of the page the banner leads to | - | - | `https://example.com` | v1.29.0+ |
| NEXT\_PUBLIC\_MARKETPLACE\_RATING\_AIRTABLE\_API\_KEY | `string` | Airtable API key | - | - | - | v1.33.0+ |
| NEXT\_PUBLIC\_MARKETPLACE\_RATING\_AIRTABLE\_BASE\_ID | `string` | Airtable base ID with dapp ratings | - | - | - | v1.33.0+ |
| NEXT\_PUBLIC\_MARKETPLACE\_GRAPH\_LINKS\_URL | `string` | URL of the file (`.json` format only) which contains the list of The Graph links to be displayed on the Marketplace page | - | - | `https://example.com/graph_links.json` | v1.36.0+ |
#### Marketplace app configuration properties
| Property | Type | Description | Compulsoriness | Example value |
| - | - | - | - | - |
| id | `string` | Used as slug for the app. Must be unique in the app list. | Required | `app` |
| external | `boolean` | `true` means that the application opens in a new window, but not in an iframe. | - | `true` |
| title | `string` | Displayed title of the app. | Required | `The App` |
| logo | `string` | URL to logo file. Should be at least 288x288. | Required | `https://foo.app/icon.png` |
| shortDescription | `string` | Displayed only in the app list. | Required | `Awesome app` |
| categories | `ArrayβΉstringβΊ` | Displayed category. | Required | `[Security, Tools]` |
| author | `string` | Displayed author of the app | Required | `Bob` |
| url | `string` | URL of the app which will be launched in the iframe. | Required | `https://foo.app/launch` |
| description | `string` | Displayed only in the modal dialog with additional info about the app. | Required | `The best app` |
| site | `string` | Displayed site link | - | `https://blockscout.com` |
| twitter | `string` | Displayed twitter link | - | `https://twitter.com/blockscoutcom` |
| telegram | `string` | Displayed telegram link | - | `https://t.me/poa_network` |
| github | `string` | Displayed github link | - | `https://github.com/blockscout` |
| internalWallet | `boolean` | `true` means that the application can automatically connect to the Blockscout wallet. | - | `true` |
| priority | `number` | The higher the priority, the higher the app will appear in the list on the Marketplace page. | - | `7` |
### Solidity to UML diagrams
| Variable | Type | Description | Compulsoriness | Default value | Example value | Version |
| - | - | - | - | - | - | - |
| NEXT\_PUBLIC\_VISUALIZE\_API\_HOST | `string` | Visualize API endpoint url | Required | - | `https://visualizer.services.blockscout.com` | v1.0.x+ |
| NEXT\_PUBLIC\_VISUALIZE\_API\_BASE\_PATH | `string` | Base path for Visualize API endpoint url | - | - | `/poa/core` | v1.29.0+ |
### Blockchain statistics
| Variable | Type | Description | Compulsoriness | Default value | Example value | Version |
| - | - | - | - | - | - | - |
| NEXT\_PUBLIC\_STATS\_API\_HOST | `string` | Stats API endpoint url | Required | - | `https://stats.services.blockscout.com` | v1.0.x+ |
| NEXT\_PUBLIC\_STATS\_API\_BASE\_PATH | `string` | Base path for Stats API endpoint url | - | - | `/poa/core` | 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βΉ"metamask" \| "coinbase" \| "token_pocket"βΊ` | 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. | - | `[ "metamask" ]` | `[ "coinbase" ]` | v1.10.0+ |
| NEXT\_PUBLIC\_WEB3\_DISABLE\_ADD\_TOKEN\_TO\_WALLET | `boolean` | Set to `true` to hide icon "Add to your wallet" next to token addresses | - | - | `true` | v1.0.x+ |
### Transaction interpretation
| Variable | Type | Description | Compulsoriness | Default value | Example value | Version |
| - | - | - | - | - | - | - |
| NEXT\_PUBLIC\_TRANSACTION\_INTERPRETATION\_PROVIDER | `"blockscout" \| "noves" \| "none"` | Transaction interpretation provider that displays human readable transaction description | - | `none` | `blockscout` | v1.21.0+ |
### External transactions
| Variable | Type | Description | Compulsoriness | Default value | Example value | Version |
| - | - | - | - | - | - | - |
| NEXT\_PUBLIC\_TX\_EXTERNAL\_TRANSACTIONS\_CONFIG | `{ chain_name: string; chain_logo_url: string; explorer_url_template: string; }` | Configuration of the external transactions links that should be added to the transaction details. | - | - | `{ "chain_name": "ethereum", "chain_logo_url": "https://example.com/logo.png", "explorer_url_template": "https://explorer.com/tx/{hash}" }` | v1.38.0+ |
### Verified tokens info
| Variable | Type | Description | Compulsoriness | Default value | Example value | Version |
| - | - | - | - | - | - | - |
| NEXT\_PUBLIC\_CONTRACT\_INFO\_API\_HOST | `string` | Contract Info API endpoint url | Required | - | `https://contracts-info.services.blockscout.com` | 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 | `string` | Name Service API endpoint url | Required | - | `https://bens.services.blockscout.com` | 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 | `string` | Metadata Service API endpoint url | Required | - | `https://metadata.services.blockscout.com` | 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 | `string` | Metadata Service API endpoint url | Required | - | `https://metadata.services.blockscout.com` | v1.30.0+ |
| NEXT\_PUBLIC\_ADMIN\_SERVICE\_API\_HOST | `string` | Admin Service API endpoint url | Required | - | `https://admin-rs.services.blockscout.com` | v1.1.0+ |
| NEXT\_PUBLIC\_RE\_CAPTCHA\_APP\_SITE\_KEY | `string` | See [below](https://github.com/blockscout/docs/blob/master/setup/env-variables/frontend-common-envs/ENVS.md#google-recaptcha) | true | - | `` | v1.0.x+ |
### 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 | `boolean` | Set to true to enable blob transactions views. | Required | - | `true` | 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 the original token will be displayed on the token page.
| Variable | Type | Description | Compulsoriness | Default value | Example value | Version |
| - | - | - | - | - | - | - |
| NEXT\_PUBLIC\_BRIDGED\_TOKENS\_CHAINS | `ArrayβΉBridgedTokenChainβΊ` where `BridgedTokenChain` can have following [properties](/setup/env-variables/frontend-common-envs/envs#bridged-token-chain-configuration-properties) | Used for displaying filter by the chain from which tokens were bridged. Also, used for creating links to original tokens in other explorers. | Required | - | `[{"id":"1","title":"Ethereum","short_title":"ETH","base_url":"https://eth.blockscout.com/token"}]` | v1.14.0+ |
| NEXT\_PUBLIC\_BRIDGED\_TOKENS\_BRIDGES | `ArrayβΉTokenBridgeβΊ` where `TokenBridge` can have following [properties](/setup/env-variables/frontend-common-envs/envs#token-bridge-configuration-properties) | Used for displaying text about bridges types on the tokens page. | Required | - | `[{"type":"omni","title":"OmniBridge","short_title":"OMNI"}]` | v1.14.0+ |
#### Bridged token chain configuration properties
| Variable | Type | Description | Compulsoriness | Default value | Example value |
| - | - | - | - | - | - |
| id | `string` | Base chain id, see [https://chainlist.org](https://chainlist.org) for the reference | Required | - | `1` |
| title | `string` | Displayed name of the chain | Required | - | `Ethereum` |
| short\_title | `string` | Used for displaying chain name in the list view as tag | Required | - | `ETH` |
| base\_url | `string` | Base url to original token in base chain explorer | Required | - | `https://eth.blockscout.com/token` |
*Note* The url to the original token will be constructed as `/`, e.g. `https://eth.blockscout.com/token/`
#### Token bridge configuration properties
| Variable | Type | Description | Compulsoriness | Default value | Example value |
| - | - | - | - | - | - |
| type | `string` | Bridge type; should be matched to `bridge_type` field in API response | Required | - | `omni` |
| title | `string` | Bridge title | Required | - | `OmniBridge` |
| short\_title | `string` | Bridge short title for displaying in the tags | Required | - | `OMNI` |
### SafeCore address tags
For the smart contract addresses which are [Safe accounts](https://safe.global/) public tag "Multisig: Safe" will be displayed in the address page header alongside the Safe logo.
| Variable | Type | Description | Compulsoriness | Default value | Example value | Version |
| - | - | - | - | - | - | - |
| NEXT\_PUBLIC\_SAFE\_TX\_SERVICE\_URL | `string` | The Safe transaction service URL. See full list of supported networks [here](https://docs.safe.global/api-supported-networks). | - | - | `uniswap` | 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 | `{api_url: string; tag_link_template: string; tag_icon: string; tag_bg_color: string; tag_text_color: string}` | Address profile API tag configuration properties. See [below](/setup/env-variables/frontend-common-envs/envs#user-profile-api-configuration-properties). | - | - | `uniswap` | v1.35.0+ |
#### Address profile API configuration properties
| Variable | Type | Description | Compulsoriness | Default value | Example value |
| - | - | - | - | - | - |
| api\_url\_template | `string` | User profile API URL. Should be a template with `{address}` variable | Required | - | `https://example-api.com/{address}` |
| tag\_link\_template | `string` | External link to the profile. Should be a template with `{username}` variable | - | - | `https://example.com/{address}` |
| tag\_icon | `string` | Public tag icon (.svg) url | - | - | `https://example.com/icon.svg` |
| tag\_bg\_color | `string` | Public tag background color (escape "#" symbol if you use HEX color codes or use rgba-value instead) | - | - | `\\#000000` |
| tag\_text\_color | `string` | Public tag text color (escape "#" symbol if you use HEX color codes or use rgba-value instead) | - | - | `\\#FFFFFF` |
### 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 | `string` | XStar XHS score documentation URL for the address tag. Enables the XStar score feature. | - | - | `https://docs.xname.app/the-solution-adaptive-proof-of-humanity-on-blockchain/xhs-scoring-algorithm` | 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 | `boolean` | Set to true for blockchains with [SUAVE architecture](https://writings.flashbots.net/mevm-suave-centauri-and-beyond) | Required | - | `true` | v1.14.0+ |
### Celo chain
For blockchains that use the Celo platform. *Note*, that once the Celo mainnet becomes an L2 chain, these variables will be migrated to the Rollup configuration section.
| Variable | Type | Description | Compulsoriness | Default value | Example value | Version |
| - | - | - | - | - | - | - |
| NEXT\_PUBLIC\_CELO\_ENABLED | `boolean` | Indicates that it is a Celo-based chain. | - | - | `true` | v1.37.0+ |
| NEXT\_PUBLIC\_CELO\_L2\_UPGRADE\_BLOCK | `number` | Indicates the block number when the Celo-type chain transitioned to L2. This is used to display links to the Epoch block page from a regular block page. | - | - | `26369280` | v1.37.0+ |
### Ton Application Chain (TAC)
For Ton Application Chains, this feature enables additional views, such as a list of cross-chain operations and a detailed page for a specific cross-chain operation, as well as extra fields on the transaction page.
| Variable | Type | Description | Compulsoriness | Default value | Example value | Version |
| - | - | - | - | - | - | - |
| NEXT\_PUBLIC\_TAC\_OPERATION\_LIFECYCLE\_API\_HOST | `string` | URL for the TAC Operation Lifecycle service. | Required | - | `https://tac-operation-lifecycle.blockscout.com` | v2.1.0+ |
| NEXT\_PUBLIC\_TAC\_TON\_EXPLORER\_URL | `string` | URL of the Ton chain explorer. This is used to build links to transactions and addresses on the Ton chain. | Required | - | `https://tonscan.org` | v2.1.0+ |
### MetaSuites extension
Enables [MetaSuites browser extension](https://github.com/blocksecteam/metasuites) to integrate with the app views.
| Variable | Type | Description | Compulsoriness | Default value | Example value | Version |
| - | - | - | - | - | - | - |
| NEXT\_PUBLIC\_METASUITES\_ENABLED | `boolean` | Set to true to enable integration | Required | - | `true` | 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 | `"stability" \| "blackfort" \| "zilliqa"` | Chain type | Required | - | `"stability"` | v1.25.0+ |
### Sentry error monitoring
*Note* This feature is **deprecated**. All ENV variables will be removed in the future releases.
| Variable | Type | Description | Compulsoriness | Default value | Example value | Version |
| - | - | - | - | - | - | - |
| NEXT\_PUBLIC\_SENTRY\_DSN | `string` | Client key for your Sentry.io app | Required | - | `` | v1.0.x+ |
| SENTRY\_CSP\_REPORT\_URI | `string` | URL for sending CSP-reports to your Sentry.io app | - | - | `` | v1.0.x+ |
| NEXT\_PUBLIC\_SENTRY\_ENABLE\_TRACING | `boolean` | Enables tracing and performance monitoring in Sentry.io | - | `false` | `true` | v1.17.0+ |
### Rollbar error monitoring
| Variable | Type | Description | Compulsoriness | Default value | Example value | Version |
| - | - | - | - | - | - | - |
| NEXT\_PUBLIC\_ROLLBAR\_CLIENT\_TOKEN | `string` | Client token for your Rollbar project | Required | - | `` | v1.37.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](https://opentelemetry.io/docs/specs/otel/protocol/exporter/#configuration-options). 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 | `boolean` | Run-time flag to enable the feature | Required | `false` | `true` | 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 | `[{ text: string; icon: string; dappId?: string, url?: string }]` | An array of dropdown items containing the button text, icon name and dappId in DAppscout or an external url | - | - | `[{"text":"Swap","icon":"swap","dappId":"uniswap"},{"text":"Payment link","icon":"payment_link","dappId":"peanut-protocol"}]` | 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 | `[{ name: string; url_template: string; dapp_id?: string; logo: string }]` | Multichain portfolio application config See [below](/setup/env-variables/frontend-common-envs/envs#multichain-button-configuration-properties) | - | - | `[{ "name": "zerion", "url_template": "https://app.zerion.io/{address}/overview", "logo": "https://example.com/icon.svg"}]` | v1.31.0+ |
#### Multichain button configuration properties
| Variable | Type | Description | Compulsoriness | Default value | Example value |
| - | - | - | - | - | - |
| name | `string` | Multichain portfolio application name | Required | - | `zerion` |
| url\_template | `string` | Url template to the portfolio. Should be a template with `{address}` variable | Required | - | `https://app.zerion.io/{address}/overview` |
| dapp\_id | `string` | Set to open a Blockscout dapp page with the portfolio instead of opening external app page | - | - | `zerion` |
| logo | `string` | Multichain portfolio application logo (.svg) url | - | - | `https://example.com/icon.svg` |
### 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 | `{ name: string; url_template: string; dapp_id?: string; logo?: string }` | Get gas button config. See [below](/setup/env-variables/frontend-common-envs/envs#get-gas-button-configuration-properties) | - | - | `{ "name": "Need gas?", "dapp_id": "smol-refuel", "url_template": "https://smolrefuel.com/?outboundChain={chainId}", "logo": "https://example.com/icon.png" }` | v1.33.0+ |
#### Get gas button configuration properties
| Variable | Type | Description | Compulsoriness | Default value | Example value |
| - | - | - | - | - | - |
| name | `string` | Text on the button | Required | - | `Need gas?` |
| url\_template | `string` | Url template, may contain `{chainId}` variable | Required | - | `https://smolrefuel.com/?outboundChain={chainId}` |
| dapp\_id | `string` | Set to open a Blockscout dapp page instead of opening external app page | - | - | `smol-refuel` |
| logo | `string` | Gas refuel application logo url | - | - | `https://example.com/icon.png` |
### 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 | `boolean` | Set to "true" to enable the feature | - | - | `true` | v1.35.0+ |
### Rewards service API
This feature enables the Blockscout Merits program. It requires that the [My account](https://github.com/blockscout/docs/blob/master/setup/env-variables/frontend-common-envs/ENVS.md#my-account) and [Blockchain interaction](https://github.com/blockscout/docs/blob/master/setup/env-variables/frontend-common-envs/ENVS.md#blockchain-interaction-writing-to-contract-etc) features are also enabled.
| Variable | Type | Description | Compulsoriness | Default value | Example value | Version |
| - | - | - | - | - | - | - |
| NEXT\_PUBLIC\_REWARDS\_SERVICE\_API\_HOST | `string` | API URL | - | - | `https://example.com` | v1.36.0+ |
### DEX pools
| Variable | Type | Description | Compulsoriness | Default value | Example value | Version |
| - | - | - | - | - | - | - |
| NEXT\_PUBLIC\_DEX\_POOLS\_ENABLED | `boolean` | Set to true to enable the feature | Required | - | `true` | v1.37.0+ |
| NEXT\_PUBLIC\_CONTRACT\_INFO\_API\_HOST | `string` | Contract Info API endpoint url | Required | - | `https://contracts-info.services.blockscout.com` | v1.0.x+ |
### Badge claim link
| Variable | Type | Description | Compulsoriness | Default value | Example value | Version |
| - | - | - | - | - | - | - |
| NEXT\_PUBLIC\_GAME\_BADGE\_CLAIM\_LINK | `string` | Provide to enable the easter egg badge feature | - | - | `https://example.com` | v1.37.0+ |
## External services configuration
### Google ReCaptcha
To obtain the variable values, please refer to the [reCAPTCHA documentation](https://developers.google.com/recaptcha) and check the [Blockscout reCAPTCHA config docs](https://docs.blockscout.com/setup/configuration-options/recaptcha). Please note that we currently support only **reCAPTCHA v2 in invisible mode**, read more [here](https://developers.google.com/recaptcha/docs/versions#recaptcha_v2_invisible_recaptcha_badge).
| Variable | Type | Description | Compulsoriness | Default value | Example value | Version |
| - | - | - | - | - | - | - |
| NEXT\_PUBLIC\_RE\_CAPTCHA\_V3\_APP\_SITE\_KEY | `string` | **DEPRECATED** Google reCAPTCHA v3 site key | - | - | `` | v1.36.x |
| NEXT\_PUBLIC\_RE\_CAPTCHA\_APP\_SITE\_KEY | `string` | Google reCAPTCHA v2 site key | - | - | `` | v1.0.x+ |
# Indexing
Source: https://docs.blockscout.com/setup/indexing
Understand how Blockscout indexes blocks and internal transactions, monitor progress with SQL queries, and troubleshoot indexing issues.
π [Autoscout is now available](/using-blockscout/autoscout), providing a simple one-click explorer deployment with Blockscout's optimized hosting infrastructure. Use it for early testing, modifications, and launching a full production-grade explorer. [**Get Started Now**](/using-blockscout/autoscout) **and have your explorer up-and-running in minutes.**
BlockScout can take some time to fully index a chain. Larger chains require more time. Indexing starts from the head of the chain (the current block) and goes backwards towards the genesis block. The genesis block is the final block indexed during this process.
### Messages during indexing
1. **n% Blocks Indexed - We're indexing this chain right now. Some of the counts may be inaccurate.** This means blocks are still being collected and processed by BlockScout. The message should disappear once the genesis block is indexed.
2. **Blocks With Internal Transactions Indexed - We're indexing this chain right now. Some of the counts may be inaccurate.** This means BlockScout has collected all blocks but is still indexing internal transactions using the archive node tracing api. This message will disappear when `INDEXER_DISABLE_INTERNAL_TRANSACTIONS_FETCHER=true` is provided.
### Monitoring indexing processes
#### Monitoring blocks/transactions indexing
1. Block count should be close to the number of the blocks in the chain. Query using `SELECT COUNT(1) FROM blocks;` \~= num of blocks in the chain.
2. The number of missing blocks in the chain can be monitored with this query:
```sql theme={null}
SELECT COUNT(DISTINCT b1.number)
FROM generate_series(0, (SELECT MAX(number) FROM blocks)) AS b1(number)
WHERE NOT EXISTS (
SELECT 1 FROM blocks b2 WHERE b2.number=b1.number AND b2.consensus
);
```
#### Monitoring internal transactions indexing
Internal transaction fetching can be monitored with this query: `SELECT COUNT(1) FROM pending_block_operations;` It should move towards zero during internal transaction processing.
# How Do I Fix Indexer Timeouts?
Source: https://docs.blockscout.com/setup/indexing/how-do-i-fix-indexer-timeouts
Tune Blockscout indexer fetcher batch size and concurrency to resolve JSON-RPC timeout errors and reduce load on the underlying archive node.
BlockScout utilizes two separate indexers in order to index the network history as well as keep up with new incoming blocks. Due to this process, a node may become overloaded and not respond to BlockScout's RPC requests within the designated timeout period.
The indexer umbrella application can be tweaked to meet your node's size and responsiveness. Outlined below are the locations and adjustments that can be made to each fetcher.
Fetchers are available at [https://github.com/blockscout/blockscout/tree/master/apps/indexer/lib/indexer/fetcher](https://github.com/blockscout/blockscout/tree/master/apps/indexer/lib/indexer/fetcher)
| Fetcher | Description | Batch size | Concurrency |
| - | - | - | - |
| [Catchup Block Fetcher](https://github.com/blockscout/blockscout/blob/1475e3bfd002d9397efd0f0cc29c20f39a70d023/apps/indexer/lib/indexer/block/catchup/fetcher.ex#L24) | This fetcher indexes blocks, transactions and receipts starting from the tip of the chain working backward to the Genesis block. | 10 `INDEXER_CATCHUP_BLOCKS_BATCH_SIZE` | 10 `INDEXER_CATCHUP_BLOCKS_CONCURRENCY` |
| [Transaction Receipts Fetcher](https://github.com/blockscout/blockscout/blob/4b272cf61dc14da76416be63f1f1df044b03a4b9/apps/indexer/lib/indexer/block/fetcher.ex#L85-L86) | Transaction receipts fetcher. | 250 `INDEXER_RECEIPTS_BATCH_SIZE` | 10 `INDEXER_RECEIPTS_CONCURRENCY` |
| [Internal Transaction Fetcher](https://github.com/blockscout/blockscout/blob/1475e3bfd002d9397efd0f0cc29c20f39a70d023/apps/indexer/lib/indexer/internal_transaction/fetcher.ex#L20) | This fetcher indexes internal transactions. For the real-time fetcher this process is done synchronously and for the catchup fetcher, this process is done asynchronously. | 10 `INDEXER_INTERNAL_TRANSACTIONS_BATCH_SIZE` | 4 `INDEXER_INTERNAL_TRANSACTIONS_CONCURRENCY` |
| [Coin Balance Fetcher](https://github.com/blockscout/blockscout/blob/1475e3bfd002d9397efd0f0cc29c20f39a70d023/apps/indexer/lib/indexer/coin_balance/fetcher.ex#L22) | This fetcher indexes each coin balance at the block height the address was interacted with. | 100 `INDEXER_COIN_BALANCES_BATCH_SIZE` | 4 `INDEXER_COIN_BALANCES_CONCURRENCY` |
| [Uncle Block Fetcher](https://github.com/blockscout/blockscout/blob/1475e3bfd002d9397efd0f0cc29c20f39a70d023/apps/indexer/lib/indexer/block/uncle/fetcher.ex#L22) | This fetcher indexes non-consensus blocks, transactions, and receipts. | 10 | 10 |
| [Token Balance Fetcher](https://github.com/blockscout/blockscout/blob/1475e3bfd002d9397efd0f0cc29c20f39a70d023/apps/indexer/lib/indexer/token_balance/fetcher.ex#L29) | This fetcher indexes token balances. Note you may experience some token balances that cannot be fetched due to a malformed smart contract or other functions that do not allow a balance to be fetched. | 100 `INDEXER_TOKEN_BALANCES_BATCH_SIZE` | 10 `INDEXER_TOKEN_BALANCES_CONCURRENCY` |
| [Token Fetcher](https://github.com/blockscout/blockscout/blob/1475e3bfd002d9397efd0f0cc29c20f39a70d023/apps/indexer/lib/indexer/token/fetcher.ex#L18) | This indexer fetches the metadata for a token contract | 1 | 10 |
| [Block Reward Fetcher](https://github.com/blockscout/blockscout/blob/4b272cf61dc14da76416be63f1f1df044b03a4b9/apps/indexer/lib/indexer/fetcher/block_reward.ex#L28-L29) | Block reward fetcher. | 10 `INDEXER_BLOCK_REWARD_BATCH_SIZE` | 10 `INDEXER_BLOCK_REWARD_CONCURRENCY` |
| [Token Instance Realtime Fetcher](https://github.com/blockscout/blockscout/blob/4b272cf61dc14da76416be63f1f1df044b03a4b9/apps/indexer/lib/indexer/fetcher/token_instance/realtime.ex#L16-L17) | Token instance realtime fetcher. | 1 `INDEXER_TOKEN_INSTANCE_REALTIME_BATCH_SIZE` | 10 `INDEXER_TOKEN_INSTANCE_REALTIME_CONCURRENCY` |
| [Token Instance Retry Fetcher](https://github.com/blockscout/blockscout/blob/4b272cf61dc14da76416be63f1f1df044b03a4b9/apps/indexer/lib/indexer/fetcher/token_instance/retry.ex#L16-L17) | Token instance retry fetcher. | 10 `INDEXER_TOKEN_INSTANCE_RETRY_CONCURRENCY` | 10 `INDEXER_TOKEN_INSTANCE_RETRY_BATCH_SIZE` |
| [Token Instance Sanitize Fetcher](https://github.com/blockscout/blockscout/blob/4b272cf61dc14da76416be63f1f1df044b03a4b9/apps/indexer/lib/indexer/fetcher/token_instance/sanitize.ex#L16-L17) | Token instance sanitize fetcher. | 10 `INDEXER_TOKEN_INSTANCE_SANITIZE_BATCH_SIZE` | 10 `INDEXER_TOKEN_INSTANCE_SANITIZE_CONCURRENCY` |
## Understanding Errors and Timeouts
`application=indexer fetcher=coin_balance count=500 error_count=500 [error] failed to fetch: :timeout`
In the error provided above, we can tell that the **indexer** application failed to fetch **500** **coin balances** due to a **timeout** error. Usually, when an indexer starts to receive timeouts, many more timeouts from other fetchers will occur as well.
### Resolving Timeout Issues
The best action to take when fetchers start to receive timeouts is to lower the batch size and concurrency of a few fetchers which will put less pressure on the node.
The two indexers that cause the most strain to the node are the block fetcher and the internal transactions fetcher. It would be advised to cut these fetchers' values in half and restart the application. A restart of the node may also be required.
### Other Actions
BlockScout comes equipped with functionality to automatically stop sending requests for `n` seconds if timeouts are detected. You may adjust these settings by setting a different value for `wait_per_timeout`.
[https://github.com/poanetwork/blockscout/blob/1475e3bfd002d9397efd0f0cc29c20f39a70d023/apps/ethereum\_jsonrpc/config/config.exs#L3-L9](https://github.com/poanetwork/blockscout/blob/1475e3bfd002d9397efd0f0cc29c20f39a70d023/apps/ethereum_jsonrpc/config/config.exs#L3-L9)
Content moved from [https://forum.poa.network/t/faq-how-do-i-fix-indexer-timeouts/1829](https://forum.poa.network/t/faq-how-do-i-fix-indexer-timeouts/1829)
# Fix indexer memory errors by adjusting memory usage
Source: https://docs.blockscout.com/setup/indexing/how-do-i-update-memory-consumption-to-fix-indexer-memory-errors
Configure INDEXER_MEMORY_LIMIT and understand how the Blockscout indexer memory monitor shrinks work queues to prevent BEAM memory errors.
During the indexing phase, many fetching processes are run asynchronously due to the load placed on trying to fetch all of the block content at once. These processes are stored in memory to be fetched at set intervals defined in each asynchronous fetcher.
`Indexer.Memory.Monitor` checks if the BEAM memory usage exceeds a set limit (defaults to 1 GiB) and if it does, it asks the process with the most memory that is registered as shrinkable to shrink.
Memory usage is checked once per minute. If the soft-limit is reached, the shrinkable work queues will shed half their load. The shed load will be restored from the database, the same as when a restart of the server occurs, so rebuilding the work queue will be slower, but use less memory.
If all queues are at their minimum size, then no more memory can be reclaimed and an error will be logged.
### Future Work
As mentioned above, future work is entered into memory to be processed later. These same processes are imported into the database to be checked on a server restart and reentered into memory to be processed.
### Updating Memory Consumption
The default Memory limit is 1 GiB and can be edited by setting `INDEXER_MEMORY_LIMIT` environment variable. See [Memory Usage](/setup/configuration-options/memory-usage) for more info.
### Left Bitshift Conversion Table
To perform a left bitshift conversion yourself open the interactive shell.
1\. `iex`
2\. `import Bitwise`
3\. `1 <<< 30` //1073741824
| | | | |
| - | - | - | - |
| `INDEXER_MEMORY_LIMIT` environment variable value | Left Bitshift | Bytes | GiB |
| `1` or `1gb` or `1g` regardless of the case of the letters | `1 <<< 30` | 1073741824 | 1 |
| `5` or `5gb` or `5g` | `5 <<< 30` | 5368709120 | 5.3 |
| `10` or `10gb` or `10g` | `10 <<< 30` | 10737418240 | 10.7 |
| `15` or `15gb` or `15g` | `15 <<< 30` | 16106127360 | 16.1 |
| `20` or `20gb` or `20g` | `20 <<< 30` | 21474836480 | 21.4 |
| `25` or `25gb` or `25g` | `25 <<< 30` | 26843545600 | 26.8 |
| `30` or `30gb` or `30g` | `30 <<< 30` | 32212254720 | 32.2 |
| `35` or `35gb` or `35g` | `35 <<< 30` | 37580963840 | 37.6 |
| `40` or `40gb` or `40g` | `40 <<< 30` | 42949672960 | 43 |
| `45` or `45gb` or `45g` | `45 <<< 30` | 48318382080 | 48.3 |
| `50` or `50gb` or `50g` | `50 <<< 30` | 53687091200 | 53.7 |
| `100mb` or `100m` regardless of the case of the letters | `100 <<< 20` | 104857600 | 0.105 |
| `500mb` or `500m` | `500 <<< 20` | 524288000 | 0.52 |
| `1500mb` or `1500m` | `1500 <<< 20` | 1572864000 | 1.57 |
| `9536mb` or `9536m` | `9536 <<< 20` | 9999220736 | \~10 |
| `28610mb` or `28610m` | `28610 <<< 20` | 29999759360 | \~30 |
# Blockscout architecture overview
Source: https://docs.blockscout.com/setup/information-and-settings
Explore Blockscout architecture and organization including indexer, web app, API modes, umbrella project layout, ShareLock, and EVM versions.
π [Autoscout is now available](/using-blockscout/autoscout), providing a simple one-click explorer deployment with Blockscout's optimized hosting infrastructure. Use it for early testing, modifications, and launching a full production-grade explorer. [**Get Started Now**](/using-blockscout/autoscout) **and have your explorer up-and-running in minutes.**
The following pages detail Blockscout architecture and organization:
* [Indexer, Web App, API](/setup/information-and-settings/separate-indexer-web-app-and-api)
* [Umbrella Project Organization](/setup/information-and-settings/umbrella-project)
* [Indexer Architecture Overview](/setup/information-and-settings/indexer-architecture-overview)
* [ShareLock](/setup/information-and-settings/sharelock)
* [EVM Version Information](/setup/information-and-settings/evm-version-information)
# EVM Version Information
Source: https://docs.blockscout.com/setup/information-and-settings/evm-version-information
Reference table of EVM hard forks (Prague, Cancun, Shanghai, London, Berlin, and more) with mainnet blocks, opcode changes, and EIPs.
You are asked to provide the EVM version the contract uses during the verification process. If the bytecode does not match the version, we try to verify using the latest EVM version.
For more information, see the [Solidity docs on specifying the EVM version when compiling a contract](https://docs.soliditylang.org/en/v0.8.25/using-the-compiler.html#target-options). Note that backward compatibility is not guaranteed between each version.
| | | | | |
| - | - | - | - | - |
| Name | Date | Mainnet Block # | Relevant changes / opcode specs | EIP details |
| Prague (Pectra) | 07 May 2025 | Block [22,431,084](https://eth.blockscout.com/block/22431084)
Epoch [364032](https://beaconcha.in/epoch/364032) | EIP-7702 enables externally owned accounts (EOAs) to temporarily execute smart contract code, allowing transaction batching, gas sponsorship, and alternative authentication methods. EIP-7251 raises maximum validator balance from 32 ETH to 2048 ETH for reward compounding. EIP-7691 doubles blob throughput (target: 3β6, max: 6β9 blobs per block) to enhance Layer 2 scaling. EIP-2537 adds BLS12-381 curve operations for efficient cryptographic verification. EIP-7002 enables execution layer triggerable validator exits. EIP-6110 reduces validator deposit processing delay from \~9 hours to \~13 minutes. | β’ [EIP-2537](https://eips.ethereum.org/EIPS/eip-2537)
β’ [EIP-2935](https://eips.ethereum.org/EIPS/eip-2935)
β’ [EIP-6110](https://eips.ethereum.org/EIPS/eip-6110)
β’ [EIP-7002](https://eips.ethereum.org/EIPS/eip-7002)
β’ [EIP-7251](https://eips.ethereum.org/EIPS/eip-7251)
β’ [EIP-7549](https://eips.ethereum.org/EIPS/eip-7549)
β’ [EIP-7623](https://eips.ethereum.org/EIPS/eip-7623)
β’ [EIP-7685](https://eips.ethereum.org/EIPS/eip-7685)
β’ [EIP-7691](https://eips.ethereum.org/EIPS/eip-7691)
β’ [EIP-7702](https://eips.ethereum.org/EIPS/eip-7702)
β’ [EIP-7840](https://eips.ethereum.org/EIPS/eip-7840) |
| Cancun | 13 Mar 2024 | [19,426,587](https://eth.blockscout.com/block/19426587) | The block's blob base fee ([EIP-7516](https://eips.ethereum.org/EIPS/eip-7516) and [EIP-4844](https://eips.ethereum.org/EIPS/eip-4844)) can be accessed via the global `block.blobbasefee` or `blobbasefee()` in inline assembly. Introduces `blobhash()` in inline assembly and a corresponding global function to retrieve versioned hashes of blobs associated with the transaction (see [EIP-4844](https://eips.ethereum.org/EIPS/eip-4844)). Opcode `mcopy` is available in assembly (see [EIP-5656](https://eips.ethereum.org/EIPS/eip-5656)). Opcodes `tstore` and `tload` are available in assembly (see [EIP-1153](https://eips.ethereum.org/EIPS/eip-1153)). | β’ [EIP-1153](https://eips.ethereum.org/EIPS/eip-1153)
β’ [EIP-4788](https://eips.ethereum.org/EIPS/eip-4788)
β’ [EIP-4844](https://eips.ethereum.org/EIPS/eip-4844)
β’ [EIP-5656](https://eips.ethereum.org/EIPS/eip-5656)
β’ [EIP-6780](https://eips.ethereum.org/EIPS/eip-6780)
β’ [EIP-7516](https://eips.ethereum.org/EIPS/eip-7516) |
| Shanghai | 12 Apr 2023 | [17,034,870](https://eth.blockscout.com/block/17034870) | Smaller code size and gas savings due to the introduction of `push0` (see [EIP-3855](https://eips.ethereum.org/EIPS/eip-3855)). | β’ [EIP-3651](https://eips.ethereum.org/EIPS/eip-3651)
β’ [EIP-3855](https://eips.ethereum.org/EIPS/eip-3855)
β’ [EIP-3860](https://eips.ethereum.org/EIPS/eip-3860)
β’ [EIP-4895](https://eips.ethereum.org/EIPS/eip-4895)
β’ [EIP-6049](https://eips.ethereum.org/EIPS/eip-6049) |
| Paris (The Merge) | 15 Sep 2022 | [15,537,394](https://eth.blockscout.com/block/15537394) | Introduces `prevrandao()` and `block.prevrandao`, and changes the semantics of the now deprecated `block.difficulty`, disallowing `difficulty()` in inline assembly (see [EIP-4399](https://eips.ethereum.org/EIPS/eip-4399)). | β’ [EIP-3675](https://eips.ethereum.org/EIPS/eip-3675)
β’ [EIP-4399](https://eips.ethereum.org/EIPS/eip-4399) |
| *Gray Glacier\** | 30 June 2022 | [15,050,000](https://eth.blockscout.com/block/15050000) | Delays the difficulty bomb by an additional 3 months to September 2022. | [https://eips.ethereum.org/EIPS/eip-5133](https://eips.ethereum.org/EIPS/eip-5133) |
| *Arrow Glacier\** | 09 Aug 2021 | [13,773,000](https://eth.blockscout.com/block/13773000) | Delays the difficulty bomb until June 2022. | [https://eips.ethereum.org/EIPS/eip-4345](https://eips.ethereum.org/EIPS/eip-4345) |
| London | 05 Aug 2021 | [12,965,000](https://eth.blockscout.com/block/12965000) | The block's base fee ([EIP-3198](https://eips.ethereum.org/EIPS/eip-3198) and [EIP-1559](https://eips.ethereum.org/EIPS/eip-1559)) can be accessed via the global `block.basefee` or `basefee()` in inline assembly. | β’ [EIP-1559](https://eips.ethereum.org/EIPS/eip-1559)
β’ [EIP-3198](https://eips.ethereum.org/EIPS/eip-3198)
β’ [EIP-3529](https://eips.ethereum.org/EIPS/eip-3529)
β’ [EIP-3541](https://eips.ethereum.org/EIPS/eip-3541)
β’ [EIP-3554](https://eips.ethereum.org/EIPS/eip-3554) |
| Berlin | 14 Apr 2021 | [12,244,000](https://eth.blockscout.com/block/12244000) | Gas costs for `SLOAD`, `*CALL`, `BALANCE`, `EXT*` and `SELFDESTRUCT` increased. The compiler assumes cold gas costs for such operations. This is relevant for gas estimation and the optimizer. | [https://eips.ethereum.org/EIPS/eip-2070](https://eips.ethereum.org/EIPS/eip-2070) |
| Istanbul | 08 Dec 2019 | [9,069,000](https://eth.blockscout.com/block/9069000) | Opcodes `chainid` and `selfbalance` are available in assembly. | [https://eips.ethereum.org/EIPS/eip-1679](https://eips.ethereum.org/EIPS/eip-1679) |
| Constantinople / Petersburg | 28 Feb 2019 | [7,280,000](https://eth.blockscout.com/block/7280000) | Opcodes `create2`, `extcodehash`, `shl`, `shr` and `sar` are available in assembly. Bitwise shifting operators use shifting opcodes (`shl`,`shr`,`sar`), requiring less gas. | [http://eips.ethereum.org/EIPS/eip-1013](http://eips.ethereum.org/EIPS/eip-1013) |
| Byzantium | 16 Oct 2017 | [4,370,000](https://eth.blockscout.com/block/4370000) | Opcodes `returndatacopy`, `returndatasize` and `staticcall` available in assembly. `staticcall` opcode used when calling non-library view or pure functions, which prevents the functions from modifying state at the EVM level, this even applies to invalid type conversions. Ability to access dynamic data returned from function calls. `revert` opcode introduced, `revert()` will not waste gas. | [http://eips.ethereum.org/EIPS/eip-609](http://eips.ethereum.org/EIPS/eip-609) |
| Spurious Dragon | 22 Nov 2016 | [2,675,000](https://eth.blockscout.com/block/2675000) | Gas cost for the `exp` opcode increased, impacts gas estimation and optimization. | [http://eips.ethereum.org/EIPS/eip-607](http://eips.ethereum.org/EIPS/eip-607) |
| Tangerine Whistle | 18 Oct 2016 | [2,463,000](https://eth.blockscout.com/block/2463000) | Gas cost to access other accounts increased, impacts gas estimation and optimization. All gas sent by default for external calls, previously a certain amount had to be retained. | [http://eips.ethereum.org/EIPS/eip-608](http://eips.ethereum.org/EIPS/eip-608) |
| Homestead | 14 Mar 2016 | [1,150,000](https://eth.blockscout.com/block/1150000) | Oldest version | [http://eips.ethereum.org/EIPS/eip-606](http://eips.ethereum.org/EIPS/eip-606) |
# Indexer Architecture Overview
Source: https://docs.blockscout.com/setup/information-and-settings/indexer-architecture-overview
Overview of Blockscout indexer architecture: realtime and catchup indexers, secondary and on-demand fetchers, and chain-specific integrations.
![]()
## Presentation Highlights
The following presentation describes the past, present and future iterations of Blockscout along with details about how block imports work both synchronously and asynchronously, and a description of the regular and on-demand fetchers.
1MB pdf
## Blockscout indexers
See the pdf β¬οΈ for more details about the Blockscout indexer. The indexing architecture includes all of the following indexers and fetchers
### Primary Indexers
Both indexers utilize synchronous and asynchronous operations.
* Realtime: Imports new block data from the head of the chain.
* Catchup: Imports data down the chain (starting from the head and moving backwards towards the genesis block).
### Secondary fetchers
### Regular
* Internal transactions
* Pending transactions
* Dropped/Replaced transactions
* Contract bytecodes
* Block rewards
* Token catalog
* Token/coin balances
* NFT instances
* Uncles
### On Demand
* Coin/token balances update
* Contract bytecodes fetch/re-check
* Contract source codes lookup
* NFT instance metadata re-fetch
* Token total supply
### Off-chain integrations
* Coin / token price, market cap, tvl sources: CMC, Coingecko, Cryptorank, Defillama
* Smart contract verification: ETH bytecode DB, Sourcify
* Data enrichment: ENS names, public tags, AI interpreters (own, Noves Fi), sc security scanners (Solidityscan), assets portfolio (Zerion)
* Chain initialization data import: pre-mined coins, precompiled smart-contracts
### Chain-specific fetchers
* There are more than a dozen chain-specific data fetchers to account for chain differences including arbitrum, optimism, polygon zkevm, zksync etc.
### Temporary fetchers
* Used once to resolve possible data inconsistencies.
# Separate Indexer, Web App, And API
Source: https://docs.blockscout.com/setup/information-and-settings/separate-indexer-web-app-and-api
Run Blockscout components independently using DISABLE_INDEXER, DISABLE_WEBAPP, and API method env variables to scale services separately.
Blockscout supports several modes which run in a single all-in-one application by default.
**Modes**
* [Indexer](/setup/information-and-settings/separate-indexer-web-app-and-api#indexer-mode)
* [Web UI](/setup/information-and-settings/separate-indexer-web-app-and-api#web-application-mode)
* [API](/setup/information-and-settings/separate-indexer-web-app-and-api#api-mode)
* All-in-one (default)
It is possible to run modes separately or in different combinations. For example, you may want to run the `indexer mode + API` to create an indexed db with programmatic access and no UI, or `indexer mode + UI` to leverage Blockscout as a read-only explorer.
Note that the application is limited to 1 running indexer per 1 Blockscout instance. However, the indexer automatically reruns child processes within the Elixir architecture, making it quite fault-tolerant.
To run these modes separately, adjust ENV variables as follows:
After extending the set of environment variables for the instance, recompile the application (or rebuild the docker image, if this is a Docker version) to enable mode settings.
## Indexer mode
To run Blockscout in indexer mode, disable the web application and API:
```javascript theme={null}
export DISABLE_WEBAPP=true
export API_V1_READ_METHODS_DISABLED=true
export API_V1_WRITE_METHODS_DISABLED=true
```
## Web application mode
To run Blockscout in web application mode only, disable the indexer and API read methods (API write functionality is not disabled to support smart contracts verification in the UI).
```javascript theme={null}
export DISABLE_INDEXER=true
export API_V1_READ_METHODS_DISABLED=true
```
If you have a separate web application and indexer and they are connected to the same database (via DATABASE\_URL), you will see new incoming items on the web UI like in the all-in-one mode. This configuration allows you to scale the web UI separately from indexer.
## API mode
To run in API mode, disable the indexer and webapp.
```javascript theme={null}
export DISABLE_INDEXER=true
export DISABLE_WEBAPP=true
```
In API mode the web UI will show the API docs page at the default path (/). In the default all-in-one mode, it is located on the /api-docs page.
## Web UI + API mode
```javascript theme={null}
export DISABLE_INDEXER=true
```
# ShareLock
Source: https://docs.blockscout.com/setup/information-and-settings/sharelock
Understand PostgreSQL ShareLock behavior in Blockscout and how consistent lock acquisition ordering with Ecto prevents database deadlocks.
### Deadlocks and prevention
When several DB transactions are acting on multiple rows of the same table, it's possible to incur in a deadlock and so into an error. This can be prevented by enforcing the same consistent order of lock acquisition on *all* the transactions performing `INSERT`, `UPDATE` or `DELETE` on a given table.
On top of this, if multiple DB transactions act on multiple tables a deadlock will occur, even if they follow the order on each table described above, if they acquire locks on said tables in a different order. This can also be prevented by using a consistent order of lock acquisition *between* different tables.
### Imposing the lock acquisition order on a table with Ecto
When `INSERT`ing a list of rows Postgres will respect the order in which they appear in the query, so the reordering can happen beforehand.
For example, this will work:
```python theme={null}
entries = [...]
ordered_entries = Enum.sort_by(entries, & &1.id)
Repo.insert_all(__MODULE__, ordered_entries)
```
Performing `UPDATE`s is trickier because there is no `ORDER BY` clause. The solution to this is to `JOIN` on a subquery that `SELECT`s with the option `FOR UPDATE`.
Using Ecto this can be done, for example, like this:
```csharp theme={null}
query =
from(
entry in Entry,
where: not is_nil(entry.value),
order_by: entry.id,
lock: "FOR UPDATE"
)
Repo.update_all(
from(e in Entry, join: s in subquery(query), on: e.id == s.id),
[set: [value: nil]],
timeout: timeout)
```
`DELETE` has the same quirks as `UPDATE` and it too is solved in the same way.
For example:
```csharp theme={null}
query =
from(
entry in Entry,
where: is_nil(entry.value),
order_by: entry.id,
lock: "FOR UPDATE"
)
Repo.delete_all(from(e in Entry, join: s in subquery(query), on: e.id == s.id))
```
### Imposing the lock acquisition order between tables with Ecto
When using an `Ecto.Multi` to perform `INSERT`, `UPDATE` or `DELETE` on multiple tables the order to keep is between different operations. For example, supposing `EntryA` was established to be modified before `EntryB`, this is not correct:
```ruby theme={null}
Multi.new()
|> Multi.run(:update_b, fn repo, _ ->
# operations with ordered locks on `EntryB`
end)
|> Multi.run(:update_a, fn repo, _ ->
# operations with ordered locks on `EntryA`
end)
|> Repo.transaction()
```
When possible, the simple solution is to move `:update_a` to be before `:update_b`. When not possible, for instance if `:update_a` depends on the result of `:update_b`, this can be solved by acquiring the locks in a separate operation.
For example:
```python theme={null}
Multi.new()
|> Multi.run(:acquire_a, fn repo, _ ->
# acquire locks in order on `EntryA`
end)
|> Multi.run(:update_b, fn repo, _ ->
# operations with ordered locks on `EntryB`
end)
|> Multi.run(:update_a, fn repo, %{acquire_a: values} ->
# operations (no need to enforce order again) on `EntryA`
end)
|> Repo.transaction()
```
Note also that for the same reasons multiple operations on the same table in the same transaction are not safe to perform if they each acquire locks in order, because locks are not released until the transaction is committed.
### Order used for Explorer's tables
This is a complete list of the ordering currently in use on each table. It also specifies the order between tables in the same transaction: locks for a table on top need to be acquired before those from a table on the bottom.
Note that this should always be enforced because as long as there is one DB transaction performing in a different order there is the possibility of a deadlock.
| schema module | table name | ordered by |
| - | - | - |
| Explorer.Chain.Address | addresses | \[asc: :hash] |
| Explorer.Chain.Address.Name | address\_names | \[asc: :address\_hash, asc: :name] |
| Explorer.Chain.Address.CoinBalance | address\_coin\_balances | \[asc: :address\_hash, asc: :block\_number] |
| Explorer.Chain.Block | blocks | \[asc: :hash] |
| Explorer.Chain.Block.SecondDegreeRelation | block\_second\_degree\_relations | \[asc: :nephew\_hash, asc: :uncle\_hash] |
| Explorer.Chain.Block.Reward | block\_rewards | \[asc: :address\_hash, asc: :address\_type, asc: :block\_hash] |
| Explorer.Chain.Block.EmissionReward | emission\_rewards | \[asc: :block\_range] |
| Explorer.Chain.Transaction | transactions | \[asc: :hash] |
| Explorer.Chain.Transaction.Fork | transaction\_forks | \[asc: :uncle\_hash, asc: :index] |
| Explorer.Chain.Log | logs | \[asc: :transaction\_hash, asc: :index] |
| Explorer.Chain.InternalTransaction | internal\_transactions | \[asc: :transaction\_hash, asc: :index] |
| Explorer.Chain.Token | tokens | \[asc: :contract\_address\_hash] |
| Explorer.Chain.TokenTransfer | token\_transfers | \[asc: :transaction\_hash, asc: :log\_index] |
| Explorer.Chain.TransactionAction | transaction\_actions | \[asc: :hash, asc: :log\_index] |
| Explorer.Chain.Optimism.OutputRoot | op\_output\_roots | \[asc: :l2\_output\_index] |
| Explorer.Chain.Optimism.TxnBatch | op\_transaction\_batches | \[asc: :l2\_block\_number] |
| Explorer.Chain.Optimism.Deposit | op\_deposits | \[asc: :l2\_transaction\_hash] |
| Explorer.Chain.Optimism.DisputeGame | op\_dispute\_games | \[asc: :index] |
| Explorer.Chain.Optimism.FrameSequence | op\_frame\_sequences | \[asc: :id] |
| Explorer.Chain.Optimism.FrameSequenceBlob | op\_frame\_sequence\_blobs | \[asc: :id] |
| Explorer.Chain.Optimism.WithdrawalEvent | op\_withdrawal\_events | \[asc: :withdrawal\_hash, asc: :l1\_event\_type] |
| Explorer.Chain.Optimism.Withdrawal | op\_withdrawals | \[asc: :msg\_nonce] |
| Explorer.Chain.Optimism.EIP1559ConfigUpdate | op\_eip1559\_config\_updates | \[asc: :l2\_block\_number] |
| Explorer.Chain.Optimism.InteropMessage | op\_interop\_messages | \[asc: :nonce, asc: :init\_chain\_id] |
| Explorer.Chain.Address.TokenBalance | address\_token\_balances | \[asc: :address\_hash, asc: :token\_contract\_address\_hash, asc: :block\_number] |
| Explorer.Chain.Address.CurrentTokenBalance | address\_current\_token\_balances | \[asc: :token\_contract\_address\_hash, asc: :token\_id, asc: :address\_hash] |
| Explorer.Chain.Scroll.Batch | scroll\_batches | \[asc: number] |
| Explorer.Chain.Scroll.BatchBundle | scroll\_batch\_bundles | \[asc: final\_batch\_number] |
| Explorer.Chain.Scroll.Bridge | scroll\_bridge | \[asc: :type, asc: message\_hash] |
| Explorer.Chain.Scroll.L1FeeParam | scroll\_l1\_fee\_params | \[asc: :block\_number, asc: tx\_index, asc: name] |
| Explorer.Chain.Shibarium.Bridge | shibarium\_bridge | \[asc: :operation\_hash, asc: l1\_transaction\_hash, asc: l2\_transaction\_hash] |
| Explorer.Chain.StakingPool | staking\_pools | \[asc: :staking\_address\_hash] |
| Explorer.Chain.StakingPoolsDelegator | staking\_pools\_delegators | \[asc: :delegator\_address\_hash, asc: :pool\_address\_hash] |
| Explorer.Chain.ContractMethod | contract\_methods | \[asc: :identified, asc: :abi] |
| Explorer.Market.MarketHistory | market\_history | \[asc: :date] |
| Explorer.Chain.Withdrawal | withdrawals | \[asc: :index] |
| Explorer.Chain.Zkevm.TransactionBatch | zkevm\_transaction\_batches | \[asc: :number] |
| Explorer.Chain.Zkevm.BatchTransaction | zkevm\_batch\_l2\_transactions | \[asc: :hash] |
| Explorer.Chain.Zkevm.LifecycleTransaction | zkevm\_lifecycle\_l1\_transactions | \[asc: :id] |
| Explorer.Chain.Zkevm.Bridge | zkevm\_bridge | \[asc: :type, asc: :index] |
| Explorer.Chain.Zkevm.BridgeL1Token | zkevm\_bridge\_l1\_tokens | \[asc: :address] |
| Explorer.Chain.ZkSync.TransactionBatch | zksync\_transaction\_batches | \[asc: :number] |
| Explorer.Chain.ZkSync.BatchBlock | zksync\_batch\_blocks | \[asc: :hash] |
| Explorer.Chain.ZkSync.BatchTransaction | zksync\_batch\_transactions | \[asc: :hash] |
| Explorer.Chain.ZkSync.LifecycleTransaction | zksync\_lifecycle\_transactions | \[asc: :id] |
| Explorer.Chain.Celo.PendingAccountOperation | celo\_pending\_account\_operations | \[asc: :address\_hash] |
| Explorer.Chain.Celo.Account | celo\_accounts | \[asc: :address\_hash] |
| Explorer.Chain.Celo.ValidatorGroupVote | celo\_validator\_group\_votes | \[asc: :transaction\_hash, asc: :account\_address\_hash, asc: :group\_address\_hash] |
| Explorer.Chain.Celo.Epoch | celo\_epochs | \[asc: :number] |
| Explorer.Chain.Celo.EpochReward | celo\_epoch\_rewards | \[asc: :epoch\_number] |
| Explorer.Chain.Celo.ElectionReward | celo\_election\_rewards | \[asc: :epoch\_number, asc: type, asc: :account\_address\_hash, asc: :associated\_account\_address\_hash] |
| Explorer.Chain.Zilliqa.QuorumCertificate | zilliqa\_quorum\_certificates | \[asc: :block\_hash] |
| Explorer.Chain.Zilliqa.AggregateQuorumCertificate | zilliqa\_aggregate\_quorum\_certificates | \[asc: :block\_hash] |
| Explorer.Chain.Zilliqa.NestedQuorumCertificate | zilliqa\_nested\_quorum\_certificates | \[asc: :block\_hash, asc: proposed\_by\_validator\_index] |
| Explorer.Chain.Zilliqa.Zrc2.TokenAdapter | zilliqa\_zrc2\_token\_adapters | \[asc: :adapter\_address\_hash] |
| Explorer.Chain.Zilliqa.Zrc2.TokenTransfer | zilliqa\_zrc2\_token\_transfers | \[asc: :transaction\_hash, asc: :block\_hash, asc: :log\_index] |
| Explorer.Chain.Filecoin.PendingAddressOperation | filecoin\_pending\_address\_operations | \[asc: :address\_hash] |
# Umbrella Project Organization
Source: https://docs.blockscout.com/setup/information-and-settings/umbrella-project
How the Blockscout Elixir umbrella project is organized into ethereum_jsonrpc, explorer, block_scout_web, and indexer OTP applications.
BlockScout is an Elixir [umbrella project](https://elixir-lang.org/getting-started/mix-otp/dependencies-and-umbrella-projects.html). Each directory under `apps/` is a separate [Mix](https://hexdocs.pm/mix/Mix.html) project and [OTP application](https://hexdocs.pm/elixir/Application.html), but the projects can use each other as a dependency in their `mix.exs`.
Each OTP application has a restricted domain.
Table is horizontally scrollable.
| | | | |
| - | - | - | - |
| Directory | OTP Application | Namespace | Purpose |
| `apps/ethereum_jsonrpc` | `:ethereum_jsonrpc` | `EthereumJSONRPC` | Ethereum JSONRPC client. It is allowed to know `Explorer`'s param format, but it cannot directly depend on `:explorer` |
| `apps/explorer` | `:explorer` | `Explorer` | Storage for the indexed chain. Can read and write to the backing storage. MUST be able to boot in a read-only mode when run independently from `:indexer`, so cannot depend on `:indexer` as that would start `:indexer` indexing. |
| `apps/block_scout_web` | `:block_scout_web` | `BlockScoutWeb` | Phoenix interface to `:explorer`. The minimum interface to allow web access should go in `:block_scout_web`. Any business rules or interface not tied directly to `Phoenix` or `Plug` should go in `:explorer`. MUST be able to boot in a read-only mode when run independently from `:indexer`, so cannot depend on `:indexer` as that would start `:indexer` indexing. |
| `apps/indexer` | `:indexer` | `Indexer` | Uses `:ethereum_jsonrpc` to index chain and batch import data into `:explorer`. Any process, `Task`, or `GenServer` that automatically reads from the chain and writes to `:explorer` should be in `:indexer`. This restricts automatic writes to `:indexer` and read-only mode can be achieved by not running `:indexer`. |
# Microservices
Source: https://docs.blockscout.com/setup/microservices
Overview of Blockscout Rust microservices including BENS, eth-bytecode-db, sig-provider, smart contract verifier, stats, and visualizer.
π [Autoscout is now available](/using-blockscout/autoscout), providing a simple one-click explorer deployment with Blockscout's optimized hosting infrastructure. Use it for early testing, modifications, and launching a full production-grade explorer. [**Get Started Now**](/using-blockscout/autoscout) **and have your explorer up-and-running in minutes.**
Blockscout microservices are individual components written in Rust designed to provide full functionality to the explorer. This architecture allows for better scalability, easier maintenance, and more flexible deployment options.
Information about Blockscout microservices and how to run them is available here:
Services Include:
1. [blockscout-ens](https://github.com/blockscout/blockscout-rs/blob/main/blockscout-ens) - indexed data of domain name service for blockscout instances.
2. [da-indexer](https://github.com/blockscout/blockscout-rs/blob/main/da-indexer) - collects blobs from different DA solutions (e.g., Celestia)
3. [eth-bytecode-db](https://github.com/blockscout/blockscout-rs/blob/main/eth-bytecode-db) - Ethereum Bytecode Database. Cross-chain smart-contracts database used for automatic contracts verification
4. [proxy-verifier](https://github.com/blockscout/blockscout-rs/blob/main/proxy-verifier) - backend for the standalone multi-chain verification service
5. [sig-provider](https://github.com/blockscout/blockscout-rs/blob/main/sig-provider) - aggregator of ethereum signatures for transactions and events
6. [smart-contract-verifier](https://github.com/blockscout/blockscout-rs/blob/main/smart-contract-verifier) - smart-contracts verification
7. [stats](https://github.com/blockscout/blockscout-rs/blob/main/stats) - service designed to calculate and present statistical information from a Blockscout instance
8. [user-ops-indexer](https://github.com/blockscout/blockscout-rs/blob/main/user-ops-indexer) - service designed to index, decode and serve user operations as per the ERC-4337 standard
9. [visualizer](https://github.com/blockscout/blockscout-rs/blob/main/visualizer) - service for evm visualization such as:
a. Solidity contract visualization using [sol2uml](https://www.npmjs.com/package/sol2uml)
# Blockscout ENS (BENS) Name Service Integration
Source: https://docs.blockscout.com/setup/microservices/blockscout-ens-bens-name-service-integration
Integrate the Blockscout ENS (BENS) microservice to add ENS-style name service lookups, subgraphs, and search to your explorer instance.
Blockscout now supports Name Services for various chains including ENS for Ethereum. Search by name in the search bar or use the dedicated Name Services lookup page accessible from the Blockchain menu.
![]()
On the Name Services page search by name or address and view registration and expiration date for all names.
## Adding Name Service Support
Protocols can add Name Service support for Blockscout instances on various chains. The BENS microservice was first introduced in [Blockscout v5.4](https://github.com/blockscout/blockscout/releases/tag/v5.4.0-beta), and several bugs were fixed in [**Blockscout v6.0**](https://github.com/blockscout/blockscout/releases/tag/v6.0.0-beta)**, which is the recommended minimum version for integration.**
You'll complete the following steps to add Name Service Support to Blockscout:
1. [Use this guide to create a subgraph](https://github.com/blockscout/blockscout-rs/blob/main/blockscout-ens/graph-node/subgraph-writer/README.md#howto-create-subgraph-for-your-domain-name-protocol). Our template uses the ENS subgraph structure, so the closer your project is to the ENS the easier the integration.
a. Subgraph should support [this graphql schema](https://github.com/blockscout/blockscout-rs/blob/main/blockscout-ens/graph-node/subgraphs/ens-subgraph/schema.graphql)
2. [Submit your subgraph](https://github.com/blockscout/blockscout-rs/blob/main/blockscout-ens/graph-node/subgraphs/README.md#deploy-subgraph-to-graph-node) to graph-node.
3. Submit a PR to the [blockscout-rs](https://github.com/blockscout/blockscout-rs/pulls) repository (hosted version) or integrate with your Blockscout fork.
a. [Example PR for BNS](https://github.com/blockscout/blockscout-rs/pull/748) (Base Name Service)
4. Enable BENS service on the instance using the [`MICROSERVICE_BENS_ENABLED`](/setup/env-variables#blockscout-ens) & [`MICROSERVICE_BENS_URL`](/setup/env-variables#blockscout-ens) env variables.
### FAQs
This may be the result of missing information/functions in the subgraph. When a subgraph sees that a domain name has been registered, it only has the `label_hash` of this name. Therefore, the subgraph has to guess the name using a rainbow table (make sure to load ens-rainbow table) OR find this name later in other events, such as `handleNameChanged` or any other event that has a name field.
Try to determine events with a name field, write code that will update domain name using `maybeSaveDomainName()` or other functions you prefer. For example, the ens-subgraph uses the `setNamePreimage` function, which performs the same function for second-level-eth domains only.
**Reverse Records**
It may also be the case that unknown names are reverse records. These are not resolved by design, and users don't typically need to see them.
The easiest way is to use docker.
`docker run --platform linux/x86_64 -p 8050:8050 --rm --name bens --env-file .env `[`ghcr.io/blockscout/bens:latest`](http://ghcr.io/blockscout/bens:latest)
To build locally without docker you should install `protoc` and `protoc-gen-openapiv2`. A complete guide for a local build is not yet available.
The primary name is the first name created which has not yet expired.
![]()
# Smart contract verification microservice
Source: https://docs.blockscout.com/setup/microservices/smart-contract-verification
Deep dive into the Blockscout Rust smart contract verifier microservice supporting Solidity, Vyper, and Sourcify verification over HTTP.
A microservice written in Rust provides fast and efficient contract verification. The application runs as an HTTP server and verification requests are made using a REST API.
* [Basic Info](/setup/microservices/smart-contract-verification#basic-info)
* [Library Initialization](/setup/microservices/smart-contract-verification#library-initialization)
* [Solidity and Vyper Verification](/setup/microservices/smart-contract-verification#solidity-and-vyper-verification)
* [Sourcify Verification](/setup/microservices/smart-contract-verification#sourcify-verification)
* [Verification Algorithm](/setup/microservices/smart-contract-verification#verification-algorithm)
* [Http API](/setup/microservices/smart-contract-verification#verification-http-api)
## Basic Info
### **Location**
* Application: [https://github.com/blockscout/blockscout-rs/tree/main/smart-contract-verifier](https://github.com/blockscout/blockscout-rs/tree/main/smart-contract-verifier)
* Http API: [https://github.com/blockscout/blockscout-rs/blob/main/smart-contract-verifier/smart-contract-verifier-http](https://github.com/blockscout/blockscout-rs/blob/main/smart-contract-verifier/smart-contract-verifier-http/README.md)
* Latest release information and changelogs: [https://github.com/blockscout/blockscout-rs/releases](https://github.com/blockscout/blockscout-rs/releases)
### **Activation**
* Update Blockscout to the 4.1.8+ release
* Add the following ENV variables:
* `MICROSERVICE_SC_VERIFIER_ENABLED=true`
* `MICROSERVICE_SC_VERIFIER_URL=...` (verifier endpoint, see [http configuration](https://github.com/blockscout/blockscout-rs/tree/main/smart-contract-verifier/smart-contract-verifier-http) for more details)
* If running locally, the smart-contract-verifier is integrated with [`docker-compose`](https://github.com/blockscout/blockscout/tree/master/docker-compose)
* Registry of docker images is available via the docker-compose file. For registry information see: [https://github.com/blockscout/blockscout-rs/pkgs/container/smart-contract-verifier](https://github.com/blockscout/blockscout-rs/pkgs/container/smart-contract-verifier)
### Architecture
The service consists of 2 parts, a verification library and a transport layer that serves requests.
* **Verification Library**: Provides verification and a communication interface for verification functions. Includes modules for Solidity, Sourcify, and Vyper.
* **Transport Layer**: Verification requests are sent via HTTP.
### Benefits
We've seen a 10X improvement in verification speed over the previous implementation. Benefits of the new microservice include:
* **Scalability**: Remove CPU intensive tasks from the primary Blockscout instance. Modularity provides the ability to scale quickly.
* **Speed**: Using native compilers greatly increases compilation speed relative to the JS wrapped versions running on Node.js used previously.
* **Improved efficiency**. New algorithm supports contracts that contain several metadata hashes, improving efficiency.
## Library Initialization
On startup, the library must retrieve all available compilers. Compiler information consists of a link to download the compiler and its hashsum \[[example](https://github.com/blockscout/solc-bin/blob/main/list.json)]. A separate thread also starts during initialization to update this list periodically.
Library processes differ based on verification for Solidity/Vyper contracts or verification via Sourcify. Both are detailed below.
## Solidity and Vyper Verification
Verification processes are similar for contracts written in Solidity and Vyper.
For Solidity contracts, verification is available for multiple files or standard json input. Single file verification is also possible - users still verify via the multiple file method and only upload a single file.
For Vyper contracts, only multiple file verification is available.
### Request Values
Each request contains the following values:
* **Deployed bytecode**: bytecode of the contract stored on chain
* **Creation transaction (tx) input**: input data provided in transaction to create the contract
* **Compiler version**: Version of compiler used to compile the contract
* **Content**: Verification method related fields. E.g. for Solidity multiple files those fields are:
* **Sources**: mapping from source files to their contents
* **Evm version**: version of the EVM used to compile sources
* **Optimization runs**: optional parameter that enables optimizations and specifies number of optimization runs
* **Contract libraries**: optional parameter that specifies addresses of the contract libraries used in compiled contracts
### Verification Steps
1. **Download the compiler** using the specified compiler version from the url retrieved on [initialization](/setup/microservices/smart-contract-verification#initialization) (or update).
2. **Compilation**: compile using the provided and slightly modified (see [Verification Algorithm](/setup/microservices/smart-contract-verification#verification-algorithm) section) sources.
3. **Verification**: compare compiler output from step 2 with bytecodes (deployed bytecode and creation tx input) provided by the caller. During verification all contracts obtained through local compilation are checked one by one, and if any corresponds to provided bytecodes, the verification is considered successful. Contract paths and names are already indexed from available contracts, and constructor arguments are extracted.
4. **Return Values**: See below.
### Returned Values
As a result of successful verification the following struct is returned:
* **Compiler input**: Data used as an input for the compiler
* **Compiler version**: version of the compiler used in verification (corresponds to the version provided in request)
* **File path**: path of the file containing verified contract
* **Contract name**: name of the verified contract
* **Abi**: application binary interface of the verified contract ([https://docs.soliditylang.org/en/v0.8.13/abi-spec.html?highlight=abi](https://docs.soliditylang.org/en/v0.8.13/abi-spec.html?highlight=abi))
* **Constructor arguments**: optionally returned constructor arguments used during on chain creation of the contract.
In case of an error, an enum is returned with the corresponding error and its description (e.g. if compilation failed, a Compilation error is returned with the error data obtained from the compiler).
## Sourcify Verification
The request is sent via proxy to the [Sourcify](https://sourcify.dev/) service. It accepts the following arguments:
1. Address of the contract to be verified.
2. Chain id where the contract is deployed.
3. Files required for Sourcify verification.
4. (optionally) Contract index, if the provided files contain multiple metadata files (i.e. multiple contracts).
These arguments are sent to the Sourcify Api, which returns the verification status.
### **Successful Verification**
Either the data provided was valid and the contract was verified by Sourcify, or the contract was previously verified. To obtain the actual data used for verification we send another request to retrieve source files used in verification. We expect data used for verification to be in the `metadata.json` file, so it is parsed and the information retrieved. This includes file and contract names, compiler and evm versions, info about optimizations, contract libraries, abi, and sources.
**Note**: Constructor arguments cannot currently be obtained from the metadata via Sourcify. This requires the input used for contract creation transaction and the bytecode resulting from local compilation, which are not provided.
### Failed Verification
If verification fails we return an error with description obtained from Sourcify response.
## Verification Algorithm
Verification is divided into 2 parts to effectively deal with metadata hash differences in contracts. Often, very similar contracts will have very different metadata hashes based on small changes within the contract (ie an extra space in the source code). To address this, the algorithm:
1. Extracts all metadata hash fields from *creationTxInput*.
2. Compares non-metadata sections of the onchain bytecode with the results of local compilation.
Metadata hashes are extracted by compiling the same contract twice (with a slight modification to the 2nd contract that does not change any other aspect of the resultant bytecode). The resulting *creationTxInputs* are compared and metadata hashes extracted by finding which parts of the inputs differ.
### Example
An additional space in the source code can be used for the modification process. In **Example 1** and **Example 2** the only difference between both contracts is a space in the beginning of **Example 2**. However, this still completely changes the metadata hash (metadata hash differences shown in **bold red**).
**Note**: To update the metadata hash in production we use an additional library passed into the compiler. It does not affect the resultant bytecode, but the compilation input is altered, leading to updated metadata and an updated metadata hash.
#### Example 1
```javascript theme={null}
// pragma solidity ^0.8.7; contract Main {}
```
*creationTxInput:* 6080604052348015600f57600080fd5b50603f80601d6000396000f3fe6080604052600080fdfea264697066735822**12203cc19b771ee83d8cc6995191bd9092a82f3e66b95aacaf1cfc893d3dc27abcd2**64736f6c63430008070033
#### Example 2
```javascript theme={null}
// pragma solidity ^0.8.7; contract Main {}
```
*creationTxInput:* 6080604052348015600f57600080fd5b50603f80601d6000396000f3fe6080604052600080fdfea264697066735822**1220b3902f5797f05bb62858c8d41f09402093c85957c4ae1d773e4eb1cb2000f093**64736f6c63430008070033
### Verification Process
1. Compile the original contracts using data provided by the caller then compile those contracts again while passing in the additional library. The result is two slightly different `CreationTxInputs` if there is any encoded metadata.
2. Separate the `MainPart` and the `MetadataPart`.
a. `MainPart` consists of consecutive bytes which are not related to the metadata hash (all bytes are the same for both local *creationTxInputs*). `MetadataPart` consists of consecutive bytes related to metadata hash (some bytes differ between local *creationTxInputs*).
3. Iterate through the two local contracts byte by byte to find the first byte that differs.
a. If there are no such bytes, then there is no metadata hash and the whole *creationTxInput* consists of just one `MainPart`.
b. If any differences are found, identify it as a hash section of the metadata hash.
c. Iterate back byte by byte to find the beginning of that metadata hash. When we find the beginning we know where that metadata hash starts and ends. All non-categorized bytes before the start are identified as the `MainPart` and bytes between the start and end identified as the `MetadataPart`. Continue until there are no uncategorized bytes.
d. Once the entire local *creationTxInput* is categorized, we compare those parts with the corresponding remote *creationTxInput* bytes. For the `MainPart` remote *creationTxInput* must have exact equivalence. For the `MetadataPart` we compare some parts of the metadata (e.g. that encoded solc versions are the same), but in general we do not require them to be equal.
**Example**
***LocalCreationTxInput1:*** 608060405234801561001057600080fd5b506040518060200161002190610050565b6020820181038252601f19601f820116604052506000908051906020019061004a92919061005c565b5061015f565b605c806101ac83390190565b8280546100689061012e565b90600052602060002090601f01602090048101928261008a57600085556100d1565b82601f106100a357805160ff19168380011785556100d1565b828001600101855582156100d1579182015b828111156100d05782518255916020019190600101906100b5565b5b5090506100de91906100e2565b5090565b5b808211156100fb5760008160009055506001016100e3565b5090565b7f4e487b7100000000000000000000000000000000000000000000000000000000600052602260045260246000fd5b6000600282049050600182168061014657607f821691505b602082108103610159576101586100ff565b5b50919050565b603f8061016d6000396000f3fe6080604052600080fdfea2646970667358221220187a584947e37ebca43172929f7e159fe28696b0edd97bbfad5b0a265f6f886964736f6c634300080e00336080604052348015600f57600080fd5b50603f80601d6000396000f3fe6080604052600080fdfea2646970667358221220805aa9fe4ec055702024afa5ac21c2104f0b14be0ffab086f0d6e9b5701073f864736f6c634300080e0033
**Parts 1:** \`\`\[ MainPart(608060405234801561001057600080fd5b506040518060200161002190610050565b6020820181038252601f19601f820116604052506000908051906020019061004a92919061005c565b5061015f565b605c806101ac83390190565b8280546100689061012e565b90600052602060002090601f01602090048101928261008a57600085556100d1565b82601f106100a357805160ff19168380011785556100d1565b828001600101855582156100d1579182015b828111156100d05782518255916020019190600101906100b5565b5b5090506100de91906100e2565b5090565b5b808211156100fb5760008160009055506001016100e3565b5090565b7f4e487b7100000000000000000000000000000000000000000000000000000000600052602260045260246000fd5b6000600282049050600182168061014657607f821691505b602082108103610159576101586100ff565b5b50919050565b603f8061016d6000396000f3fe6080604052600080fdfe), MetadataPart(a264697066735822**1220187a584947e37ebca43172929f7e159fe28696b0edd97bbfad5b0a265f6f8869**64736f6c634300080e0033), MainPart(6080604052348015600f57600080fd5b50603f80601d6000396000f3fe6080604052600080fdfe), MetadataPart(a264697066735822**1220805aa9fe4ec055702024afa5ac21c2104f0b14be0ffab086f0d6e9b5701073f8**64736f6c634300080e0033) ]
***LocalCreationTxInput2:*** 608060405234801561001057600080fd5b506040518060200161002190610050565b6020820181038252601f19601f820116604052506000908051906020019061004a92919061005c565b5061015f565b605c806101ac83390190565b8280546100689061012e565b90600052602060002090601f01602090048101928261008a57600085556100d1565b82601f106100a357805160ff19168380011785556100d1565b828001600101855582156100d1579182015b828111156100d05782518255916020019190600101906100b5565b5b5090506100de91906100e2565b5090565b5b808211156100fb5760008160009055506001016100e3565b5090565b7f4e487b7100000000000000000000000000000000000000000000000000000000600052602260045260246000fd5b6000600282049050600182168061014657607f821691505b602082108103610159576101586100ff565b5b50919050565b603f8061016d6000396000f3fe6080604052600080fdfea26469706673582212202e82fb6222f966f0e56dc49cd1fb8a6b5eac9bdf74f62b8a5e9d8812901095d664736f6c634300080e00336080604052348015600f57600080fd5b50603f80601d6000396000f3fe6080604052600080fdfea2646970667358221220bd9f7fd5fb164e10dd86ccc9880d27a177e74ba873e6a9b97b6c4d7062b26ff064736f6c634300080e0033
**Parts 2:**
\[ MainPart(608060405234801561001057600080fd5b506040518060200161002190610050565b6020820181038252601f19601f820116604052506000908051906020019061004a92919061005c565b5061015f565b605c806101ac83390190565b8280546100689061012e565b90600052602060002090601f01602090048101928261008a57600085556100d1565b82601f106100a357805160ff19168380011785556100d1565b828001600101855582156100d1579182015b828111156100d05782518255916020019190600101906100b5565b5b5090506100de91906100e2565b5090565b5b808211156100fb5760008160009055506001016100e3565b5090565b7f4e487b7100000000000000000000000000000000000000000000000000000000600052602260045260246000fd5b6000600282049050600182168061014657607f821691505b602082108103610159576101586100ff565b5b50919050565b603f8061016d6000396000f3fe6080604052600080fdfe),
MetadataPart(a264697066735822**12202e82fb6222f966f0e56dc49cd1fb8a6b5eac9bdf74f62b8a5e9d8812901095d6**64736f6c634300080e0033),
MainPart(6080604052348015600f57600080fd5b50603f80601d6000396000f3fe6080604052600080fdfe),
MetadataPart(a264697066735822**1220bd9f7fd5fb164e10dd86ccc9880d27a177e74ba873e6a9b97b6c4d7062b26ff0**64736f6c634300080e0033)
]
#### Constructor arguments
Constructor arguments are extracted at the end of the verification process. Constructor arguments are appended at the end of the *creationTxInput* returned by the compiler. So, to extract these arguments we remove parts presented in local *creationTxInput*, and consider everything else as likely constructor arguments.
After that we attempt to map potential constructor args to the constructor abi of the contract. If successful, extracted args are returned as actual constructor arguments.
## Verification Http Api
Currently, verification requests are sent via HTTP requests. This module runs an HTTP server and provides endpoints through which external services (main Blockscout instance, in our case) send verification requests and receive responses. Endpoints provided by the service and configuration details are described in the [corresponding Readme file](https://github.com/blockscout/blockscout-rs/tree/main/smart-contract-verifier-http).
Currently only synchronous endpoints are available. In the future a new service that handles asynchronous requests on top of the current smart-contract-verifier may be implemented.
# Requirements
Source: https://docs.blockscout.com/setup/requirements
System, hardware, database, node tracing, and JSON-RPC client requirements for running a self-hosted Blockscout explorer instance.
π [Autoscout is now available](/using-blockscout/autoscout), providing a simple one-click explorer deployment with Blockscout's optimized hosting infrastructure. Use it for early testing, modifications, and launching a full production-grade explorer. [**Get Started Now**](/using-blockscout/autoscout) **and have your explorer up-and-running in minutes.**
See the submenu for requirements information
* [General requirements and software dependencies](/setup/requirements/requirements)
* [Hardware and hosting requirements](/setup/requirements/resource-requirements)
* [DB storage requirements](/setup/requirements/database-storage-requirements)
* [Client setting requirements](/setup/requirements/client-settings) (Geth, Erigon, Nethermind etc)
* [Node Tracing Requirements](/setup/requirements/node-tracing-json-rpc-requirements) by Client
# Backend/Frontend Compatibility Matrix
Source: https://docs.blockscout.com/setup/requirements/back-front-compatibility-matrix
Version compatibility matrix mapping Blockscout backend releases to supported frontend versions for self-hosted explorer deployments.
| frontend/backend | v12.0.x | v11.3.x | v11.2.x | v11.1.x | v11.0.x | v10.2.x | v10.1.x | v10.0.x | v9.4.x | v9.3.x | v9.2.x | v9.1.x | v9.0.x | v8.1.x | v8.0.x | v7.0.x | v6.10.x | v6.9.x | v6.8.x | v6.7.x | v6.6.x | v6.5.x | v6.4.x | v6.3.x | v6.2.x | v6.1.x | v6.0.x | v5.4.x | v5.3.x | v5.2.x | v5.1.x | v5.0.x |
| - | :- | :- | :- | :- | :- | :- | :- | :- | :- | :- | :- | :- | :- | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - |
| v2.11.x+ | β
| β
| β
| β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β |
| v2.10.x+ | β | β
| β
| β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β |
| v2.9.x+ | β | β | β
| β
| β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β |
| v2.8.x+ | β | β | β
| β
| β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β |
| v2.7.3+ | β | β | β | β | β
| β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β |
| v2.7.2- | β | β | β | β | β | β
| β
| β
| β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β |
| v2.6.x | β | β | β | β | β | β
| β
| β
| β
| β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β |
| v2.5.x | β | β | β | β | β | β | β | β | β
| β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β |
| v2.4.x | β | β | β | β | β | β | β | β | β | β
| β
| β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β |
| v2.3.1+ | β | β | β | β | β | β | β | β | β | β
| β
| β
| β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β |
| v2.3.0 | β | β | β | β | β | β | β | β | β | β
| β
| β
| β
| β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β |
| v2.2.x | β | β | β | β | β | β | β | β | β | β | β | β | β
| β
| β
| β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β |
| v2.1.x | β | β | β | β | β | β | β | β | β | β | β | β | β
| β
| β
| β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β |
| v2.0.x | β | β | β | β | β | β | β | β | β | β | β | β | β
| β
| β
| β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β |
| v1.38.1+ | β | β | β | β | β | β | β | β | β | β | β | β | β
| β
| β
| β
| β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β |
| v1.37.6+ | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β
| β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β |
| v1.37.5- | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β
| β | β | β | β | β | β | β | β | β | β | β | β | β | β | β |
| v1.36.x | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β
| β | β | β | β | β | β | β | β | β | β | β | β | β | β |
| v1.35.x | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β
| β
| β
| β
| β | β | β | β | β | β | β | β | β | β | β |
| v1.34.x | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β
| β
| β
| β
| β | β | β | β | β | β | β | β | β | β | β |
| v1.33.x | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β
| β
| β
| β
| β | β | β | β | β | β | β | β | β | β | β |
| v1.32.x | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β
| β
| β | β | β | β | β | β | β | β | β | β | β |
| v1.31.x | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β
| β
| β | β | β | β | β | β | β | β | β | β | β |
| v1.30.x | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β
| β
| β | β | β | β | β | β | β | β | β | β | β |
| v1.29.x | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β
| β
| β | β | β | β | β | β | β | β | β |
| v1.28.x | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β
| β | β | β | β | β | β | β | β | β |
| v1.27.x | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β
| β
| β | β | β | β | β | β | β |
| v1.26.x | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β
| β
| β | β | β | β | β | β | β |
| v1.25.x | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β
| β
| β | β | β | β | β | β | β |
| v1.24.x | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β
| β | β | β | β | β | β | β |
| v1.23.x | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β
| β | β | β | β | β | β | β | β |
| v1.22.x | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β
| β | β | β | β | β | β | β |
| v1.21.x | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β
| β | β | β | β | β | β | β |
| v1.20.x | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β
| β | β | β | β | β | β |
| v1.19.x | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β
| β | β | β | β | β |
| v1.18.x | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β
| β | β | β | β | β |
| v1.17.x | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β
| β | β | β | β | β |
| v1.16.x | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β
| β | β | β | β | β |
| v1.15.x | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β
| β | β | β | β |
| v1.14.x | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β
| β | β | β | β |
| v1.13.x | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β
| β | β | β | β |
| v1.12.x | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β
| β | β | β | β |
| v1.11.x | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β
| β | β | β | β |
| v1.10.x | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β
| β | β | β | β |
| v1.9.x | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β
| β | β | β | β |
| v1.8.x | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β
| β | β | β | β |
| v1.7.x | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β
| β | β | β | β |
| v1.6.x | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β
| β | β | β | β |
| v1.5.x | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β
| β | β | β | β |
| v1.4.x | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β
| β | β | β |
| v1.3.x | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β
| β | β | β |
| v1.2.x | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β
| β | β | β |
| v1.1.x | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β
| β | β | β |
| v1.0.x | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β | β
| β
| β
| β
|
# Client Setting Requirements
Source: https://docs.blockscout.com/setup/requirements/client-settings
Configure Blockscout for Geth, Erigon, Nethermind, Besu, Reth, RSKj, Lotus, and Anvil JSON-RPC clients with the right endpoints and flags.
π [Autoscout is now available](/using-blockscout/autoscout), providing a simple one-click explorer deployment with Blockscout's optimized hosting infrastructure. Use it for early testing, modifications, and launching a full production-grade explorer. [**Get Started Now**](/using-blockscout/autoscout) **and have your explorer up-and-running in minutes.**
## Supported JSON RPC Clients
BlockScout currently supports [Geth](https://github.com/ethereum/go-ethereum), [Erigon](https://github.com/erigontech/erigon), [Nethermind](https://github.com/NethermindEth/nethermind), [Reth](https://github.com/paradigmxyz/reth), [Besu](https://github.com/hyperledger/besu), [RSKj](https://github.com/rsksmart/rskj), [Lotus](https://github.com/filecoin-project/lotus), and [Anvil](https://book.getfoundry.sh/anvil/) JSON RPC clients. To define the JSON RPC node variant, it's advised to define the `ETHEREUM_JSONRPC_VARIANT` environment variable\*. Correct values include:
| JSON RPC Client | Value | Note |
| - | - | - |
| Geth | \`geth\` | Default. This value is applicable for both Geth and Reth JSON RPC clients |
| Erigon | \`erigon\` | It is suggested to use `erigon` variant for Reth JSON RPC client. |
| Nethermind | \`nethermind\` | This value is applicable for Reth and deprecated OpenEthereum (aka Parity) JSON RPC clients |
| Besu | \`besu\` | |
| RSKj | \`rsk\` | |
| Lotus | \`filecoin\` | |
| Anvil | \`anvil\` | |
\*If the variable is not set, JSON RPC variant will be chosen based on `CHAIN_TYPE` variable according to the mapping [https://github.com/blockscout/blockscout/blob/a2625803c831fb86e38ffe0e28d94bfd697914ce/apps/ethereum\_jsonrpc/lib/ethereum\_jsonrpc/variant.ex#L114-L120](https://github.com/blockscout/blockscout/blob/a2625803c831fb86e38ffe0e28d94bfd697914ce/apps/ethereum_jsonrpc/lib/ethereum_jsonrpc/variant.ex#L114-L120)
```ruby theme={null}
defp get_default_variant do
case Application.get_env(:explorer, :chain_type) do
:rsk -> "rsk"
:filecoin -> "filecoin"
_ -> "geth"
end
end
```
BlockScout currently requires a full archive node in order to import every state change for every address on the target network.
## Configs
| Application | Environment | Config path |
| - | - | - |
| Explorer | Dev | [https://github.com/blockscout/blockscout/tree/master/apps/explorer/config/dev](https://github.com/blockscout/blockscout/tree/master/apps/explorer/config/dev) |
| | Prod | [https://github.com/blockscout/blockscout/tree/master/apps/explorer/config/prod](https://github.com/blockscout/blockscout/tree/master/apps/explorer/config/prod) |
| Indexer | Dev | [https://github.com/blockscout/blockscout/tree/master/apps/indexer/config/dev](https://github.com/blockscout/blockscout/tree/master/apps/indexer/config/dev) |
| | Prod | [https://github.com/blockscout/blockscout/tree/master/apps/indexer/config/prod](https://github.com/blockscout/blockscout/tree/master/apps/indexer/config/prod) |
## Variables to connect to JSON RPC client
| Name | Environment Variable | Default Value | Description |
| - | - | - | - |
| **HTTP Endpoint** | `ETHEREUM_JSONRPC_HTTP_URL` | http\://localhost:8545 | The HTTP Endpoint is used to fetch `blocks`, `transactions`, `receipts`, `coin/token balances`. |
| **Fallback HTTP Endpoint** | `ETHEREUM_JSONRPC_FALLBACK_HTTP_URL` | (empty) | Fallback JSON RPC HTTP url. |
| **Tracing Endpoint** | `ETHEREUM_JSONRPC_TRACE_URL` | http\://localhost:8545 | The Tracing endpoint is used to fetch `internal transactions` and `block traces`. In most cases this endpoint is identical to the HTTP Endpoint. |
| **Fallback Tracing Endpoint** | `ETHEREUM_JSONRPC_FALLBACK_TRACE_URL` | (empty) | Fallback JSON RPC tracing url. |
| **Eth\_call Requests Endpoint** | `ETHEREUM_JSONRPC_ETH_CALL_URL` | (empty) | JSON RPC url for `eth_call` method requests. |
| **Fallback Eth\_call Requests Endpoint** | `ETHEREUM_JSONRPC_FALLBACK_ETH_CALL_URL` | (empty) | Fallback JSON RPC `eth_call` url. |
| **WebSockets Endpoint** | `ETHEREUM_JSONRPC_WS_URL` | ws\://localhost:8546 | The WebSockets endpoint subscribes to `newHeads` which alerts the indexer to fetch the new block from the subscription. |
## Geth
More information on Geth JSON-RPC [is available here](https://geth.ethereum.org/docs/interacting-with-geth/rpc).
```bash theme={null}
sudo /usr/bin/geth --http --http.addr 0.0.0.0 --port 30303 --http.port 8545 --http.api debug,net,eth,shh,web3,txpool --ws.api "eth,net,web3,network,debug,txpool" --ws --ws.addr 0.0.0.0 --ws.port 8546 --ws.origins "*" --sepolia --datadir=/rinkeby --syncmode "full" --gcmode "archive" --http.vhosts "*"
```
*Tracing and pruning: By default, state for the last 128 blocks is kept in memory. Most states are garbage collected. If you are running a block explorer or other service relying on transaction tracing without an archive node (--gcmode=archive), you need to trace within this window! Alternatively, specify the "reexec" tracer option to allow regenerating historical state; and ideally switch to chain tracing which amortizes overhead across all traced blocks.*
## Erigon
More information on Erigon configuration [is available here](https://erigon.gitbook.io/erigon/advanced-usage/configure-erigon).
## Nethermind
More information on Nethermind configuration [is available here](https://docs.nethermind.io/fundamentals/configuration/).
## Reth
More information on Reth configuration [is available here](https://reth.rs/run/config.html).
## RSKj
More information on RSKj configuration [is available here](https://dev.rootstock.io/rsk/node/configure/reference/).
## Besu
More information on Besu configuration [is available here](https://besu.hyperledger.org/stable/public-networks/how-to/configuration-file).
## Lotus
More information on Lotus configuration [is available here](https://lotus.filecoin.io/lotus/configure/defaults/).
## OpenEthereum
```python theme={null}
--jsonrpc-interface all --jsonrpc-apis web3,eth,net,parity,pubsub,traces --ws-interface all --fat-db=on --pruning=archive --ws-apis all --ws-origins all --ws-hosts all
```
# Database Storage Requirements
Source: https://docs.blockscout.com/setup/requirements/database-storage-requirements
Estimated PostgreSQL storage sizes for indexing Ethereum mainnet, Sepolia, Gnosis, Chiado, and Ethereum Classic in a Blockscout explorer instance.
The configuration variable `db_storage` can be used to define the amount of storage allocated to your RDS instance. The chart below shows an estimated amount of storage that is required to index individual chains. Note these numbers are estimates and are constantly increasing.
The `db_storage` can only be adjusted 1 time in a 24 hour period on AWS.
| Chain | Storage (GiB) |
| - | - |
| Ethereum Mainnet | 21000 |
| Ethereum Sepolia | 5200 |
| Gnosis Chain | 21000 |
| Gnosis Chiado | 470 |
| Ethereum Classic | 555 |
*Note*: as of 23.12.2024
# L2 to L1 JSON-RPC method requests
Source: https://docs.blockscout.com/setup/requirements/l2-greater-than-l1-json-rpc-method-requests
Reference of L1 JSON-RPC methods and polling patterns Blockscout fetchers use for Arbitrum, Optimism, Scroll, Shibarium, zkSync, and Polygon zkEVM.
This page documents the requirements for various rollup types when requesting data from the L1 node.
Layer 2 (L2) chains interact with their Layer 1 (L1) counterparts in different ways depending on the rollup type and information required. Blockscout's chain-specific fetchers interact with the L1 node to gather information crucial for tracking the rollup's state, batches, confirmations, and cross-chain messages.
* [Arbitrum](/setup/requirements/l2-greater-than-l1-json-rpc-method-requests#arbitrum-rollups)
* [Optimism](/setup/requirements/l2-greater-than-l1-json-rpc-method-requests#optimism-rollups)
* [Scroll](/setup/requirements/l2-greater-than-l1-json-rpc-method-requests#scroll-l1-fetchers)
* [Shibarium](/setup/requirements/l2-greater-than-l1-json-rpc-method-requests#shibarium-l1-fetchers)
* [zkSync](/setup/requirements/l2-greater-than-l1-json-rpc-method-requests#zksync-rollups)
* [Polygon zkEVM](/setup/requirements/l2-greater-than-l1-json-rpc-method-requests#polygon-zkevm-l1-fetchers)
The following standard L1 JSON-RPC methods are utilized. Frequency and triggers for these calls are described for each chain below.
| L1 JSON-RPC Method | Purpose |
| - | - |
| `eth_getLogs` | Discover L1 events (Batches, Confirmations, Executions, Messages, Keysets) |
| `eth_getBlockByNumber` | Get L1 Block Timestamps, Chain Head/Safe Block info |
| `eth_getTransactionByHash` | Get L1 Tx Calldata (Batches), Get L1 Tx Originator (L1->L2 Messages) |
| `eth_call` | Get Keyset Creation Block from `SequencerInbox` contract (Used infrequently for Arbitrum chains only) |
***
## Arbitrum Rollups
### L1 JSON-RPC method details
#### Method: `eth_getLogs`
Used periodically to poll for specific L1 events emitted by Arbitrum contracts. The polling intervals are generally configurable (`INDEXER_ARBITRUM_BATCHES_TRACKING_RECHECK_INTERVAL` and `INDEXER_ARBITRUM_TRACKING_MESSAGES_ON_L1_RECHECK_INTERVAL` for new events, faster polling for historical catch-up).
* **Events Polled:**
* `SequencerBatchDelivered` (from `SequencerInbox` contract): To discover new L1 batches containing L2 block data. Polled periodically by the batch tracking worker (`TrackingBatchesStatuses`).
* `SendRootUpdated` (from `Outbox` contract): To discover L2 block confirmations. Polled periodically by the batch tracking worker.
* `OutBoxTransactionExecuted` (from `Outbox` contract): To discover L2-to-L1 message executions on L1. Polled periodically by the batch tracking worker.
* `MessageDelivered` (from `Bridge` contract): To discover L1-to-L2 message initiations on L1. Polled periodically by the L1 message tracking worker (`TrackingMessagesOnL1`).
* `SetValidKeyset` (from `SequencerInbox` contract): To retrieve details about AnyTrust Data Availability Committee keysets. This is triggered **on-demand** when processing an AnyTrust batch that references a keyset hash not yet seen in the database.
***
#### Method: `eth_getBlockByNumber`
* **Fetching Timestamps:**
* Called frequently **in response to processing events** found via `eth_getLogs`. When a relevant event (like batch delivery, confirmation, or message execution) is found in a log, this method is called for the corresponding L1 block number to get its timestamp. This happens in batches triggered by the periodic log polling.
* **Fetching Chain Head/Safe Block:**
* Called periodically (driven by `recheck_interval`) with tags `"latest"` and `"safe"` to determine the current L1 chain head and the safe block for reorg protection and determining finality. Used by batch, confirmation, and execution workers.
* Called once during initialization to determine the starting point if not explicitly configured.
***
#### Method: `eth_getTransactionByHash`
Called **in response to processing events** found via `eth_getLogs`:
* **Fetching Batch Calldata:**
* When a `SequencerBatchDelivered` event is processed, this method is called for the L1 transaction hash associated with the event to retrieve the transaction's `input` data (calldata). This calldata contains essential batch information, especially for non-blob batches.
* **Fetching L1->L2 Message Originator:**
* When a `MessageDelivered` event (for an L1->L2 message) is processed, this method is called for the L1 transaction hash to retrieve the originator (`from`) address.
***
#### Method: `eth_call`
Used less frequently than the other calls.
* **Fetching Keyset Creation Block:**
* When processing an AnyTrust batch referencing a previously unknown keyset hash, an `eth_call` is made to the `SequencerInbox` contract's `getKeysetCreationBlock` function to determine the L1 block where the keyset became active. This is triggered **on-demand** during batch processing.
***
## Optimism Rollups
### Optimism L1 fetchers
Method calls are described for each of the Optimism-based fetchers including Deposit, DisputeGame, OutputRoot, TransactionBatch and WithdrawalEvent.
#### Indexer.Fetcher.Optimism.Deposit
* `eth_getLogs` (driven by `INDEXER_OPTIMISM_L1_ETH_GET_LOGS_RANGE_SIZE` for catchup mode) - one request per block in realtime mode
* `eth_getBlockByNumber` for each block within `eth_getLogs` response to get block timestamp. Batch request is used, so one batch request per one `eth_getLogs` call
#### Indexer.Fetcher.Optimism.DisputeGame
* call to `OptimismPortal`'s `respectedGameType()` public getter (every 60 seconds)
* call to `DisputeGameFactory`'s `gameCount` public getter (every 60 seconds)
* call to `DisputeGameFactory`'s `gameAtIndex` public getter (max 50 items per batch request) and the corresponding batch calls to `extraData`, `resolvedAt`, `status` public getters for each dispute game
* call to `DisputeGameFactory`'s `resolvedAt` public getter (max 50 items per batch request) for max 1000 last unresolved games
* call to `DisputeGameFactory`'s `status` public getter (max 50 items per batch request) for max 1000 last resolved games
#### Indexer.Fetcher.Optimism.OutputRoot
* `eth_getLogs` (driven by `INDEXER_OPTIMISM_L1_ETH_GET_LOGS_RANGE_SIZE` for catchup mode) - one request per block in realtime mode
#### Indexer.Fetcher.Optimism.TransactionBatch
* `eth_getBlockByNumber` (batch RPC calls containing up to `INDEXER_OPTIMISM_L1_BATCH_BLOCKS_CHUNK_SIZE` requests per batch in catchup mode starting from the start block defined in `SystemConfig` contract) - one request per block in realtime mode
#### Indexer.Fetcher.Optimism.WithdrawalEvent
* `eth_getLogs` (driven by `INDEXER_OPTIMISM_L1_ETH_GET_LOGS_RANGE_SIZE` for catchup mode) - one request per block in realtime mode
* `eth_getBlockByNumber` for each block within `eth_getLogs` response to get block timestamp. Batch request is used, so one batch request per one `eth_getLogs` call
***
## zkSync Rollups
### **L1 interaction process**
Blockscout's zkSync-specific fetchers verify zkSync batch status and transitions (Committed, Proven, Executed) recorded on the L1.
### **L1 interaction summary**
L1 calls are infrequent and only triggered to confirm L1 state transitions suggested by the L2 node.
* L1 interaction is driven by the `BatchesStatusTracker`. This tracker performs periodic checks based on the `INDEXER_ZKSYNC_BATCHES_STATUS_RECHECK_INTERVAL` ENV variable setting.
* Each check phase (`:check_committed`, `:check_proven`, `:check_executed`) *first* queries the L2 node via RPC (`zks_getL1BatchDetails`).
* If (*and only if*) the L2 query indicates a new L1 transaction hash associated with a batch's status change (commit, prove, or execute), the corresponding L1 RPC method (`eth_getTransactionReceipt` or `eth_getTransactionByHash`) is called for that *specific* transaction hash.
### L1 JSON-RPC method details
#### Method: `eth_getTransactionReceipt`
**Purpose**: Retrieves the receipt of an L1 transaction suspected of changing a batch's status (commit or execute). The fetcher specifically looks for event logs within the receipt (`BlockCommit` or `BlockExecution` events) to confirm which batches were affected by that single L1 transaction.
**Frequency:**
* Called conditionally by the `BatchesStatusTracker` process.
* This tracker runs in a loop with a configurable `INDEXER_ZKSYNC_BATCHES_STATUS_RECHECK_INTERVAL`.
* Within this loop, it first checks the L2 RPC (`zks_getL1BatchDetails`) for the oldest uncommitted/unexecuted batch.
* If the L2 RPC response indicates a new commit or execute L1 transaction hash associated with that batch, *then* `eth_getTransactionReceipt` is called on the L1 node for that specific transaction hash.
* It does *not* poll L1 constantly; the call is triggered only when a potential status change is detected via L2 RPC data during the periodic check.
***
#### Method: `eth_getTransactionByHash`
**Purpose:** Retrieves the details of an L1 transaction suspected of proving one or more zkSync batches. The fetcher needs the transaction's `input` (calldata) to decode the list of batches proven in that single L1 transaction.
**Frequency**:
* Called conditionally by the `BatchesStatusTracker` process, similar to `eth_getTransactionReceipt`. It also runs within the tracker's periodic `INDEXER_ZKSYNC_BATCHES_STATUS_RECHECK_INTERVAL`.
* The tracker checks the L2 RPC (`zks_getL1BatchDetails`) for the oldest unproven batch. If the L2 RPC response indicates a new prove L1 transaction hash, *then* `eth_getTransactionByHash` is called on the L1 node for that specific transaction hash to retrieve its calldata.
* Like the receipt fetch, this is triggered by potential changes detected via L2 RPC during the periodic check, not through constant L1 polling.
***
## Polygon zkEVM L1 fetchers
Method calls are described for each of the zkEVM-based fetchers including BridgeL1, BridgeL1Tokens, and TransactionBatch.
#### Indexer.Fetcher.PolygonZkevm.BridgeL1
* `eth_getLogs` (max 1000 blocks in a range per request for catchup mode) - one request per block in realtime mode
* `eth_getBlockByNumber` for each block within `eth_getLogs` response to get block timestamp (batch request is used with max 50 items per request)
* `eth_getBlockByNumber` to get latest block (every block time in seconds, divided by 2)
* one batch request (with calls to `symbol()` and `decimals()` getters of token contracts) per one `eth_getLogs` call
#### Indexer.Fetcher.PolygonZkevm.BridgeL1Tokens
* one batch request (with calls to `symbol()` and `decimals()` getters of token contracts) per one set of logs taken in realtime mode from the L2 block
#### Indexer.Fetcher.PolygonZkevm.TransactionBatch
* a batch call of `zkevm_batchNumber`, `zkevm_virtualBatchNumber`, `zkevm_verifiedBatchNumber` requests per `INDEXER_POLYGON_ZKEVM_BATCHES_RECHECK_INTERVAL` seconds
* a batch call of `zkevm_getBatchByNumber` requests per `INDEXER_POLYGON_ZKEVM_BATCHES_CHUNK_SIZE` zkEVM batches
***
## Scroll L1 fetchers
Method calls are described for each of the Scroll-based fetchers including Batch and BridgeL1.
#### Indexer.Fetcher.Scroll.Batch
* `eth_getLogs` (driven by `INDEXER_SCROLL_L1_ETH_GET_LOGS_RANGE_SIZE` for catchup mode) - one request per block in realtime mode
* `eth_getBlockByNumber` for each block within `eth_getLogs` response to get block timestamp (batch request is used with max 50 items per request)
* `eth_getBlockByNumber` to get latest block (every block time in seconds, divided by 2)
#### Indexer.Fetcher.Scroll.BridgeL1
* `eth_getLogs` (driven by `INDEXER_SCROLL_L1_ETH_GET_LOGS_RANGE_SIZE` for catchup mode) - one request per block in realtime mode
* `eth_getBlockByNumber` for each block within `eth_getLogs` response (taking into account `SentMessage` events only) to get block timestamp (batch request is used with max 50 items per request)
* `eth_getBlockByNumber` to get latest block (every block time in seconds, divided by 2)
## Shibarium L1 fetchers
Method calls are described for each of the Shibarium-based fetchers including L1 and RollupL1ReorgMonitor.
#### Indexer.Fetcher.Shibarium.L1
* three `eth_getLogs` requests per chunk for catchup mode (max 1000 blocks in a chunk) - three requests per block in realtime mode
* `eth_getBlockByNumber` for each block within `eth_getLogs` responses (taking into account deposit events only) to get block timestamp (batch request is used with max 50 items per request)
* `eth_getBlockByNumber` to get latest block (every block time in seconds, divided by 2)
#### Indexer.Fetcher.RollupL1ReorgMonitor
* `eth_getBlockByNumber` to get latest block (every block time in seconds, divided by 2)
# Node Tracing / JSON RPC Requirements
Source: https://docs.blockscout.com/setup/requirements/node-tracing-json-rpc-requirements
Archive node JSON-RPC methods, tracing endpoints, pending transaction support, and rate limits Blockscout needs to fully index a chain.
### Standard JSON RPC Requirements
* Archive node with JSON RPC interface should strictly follow input/output interface described in [https://ethereum.github.io/execution-apis/api-documentation/](https://ethereum.github.io/execution-apis/api-documentation/)
* WebSocket interface (optional/highly recommended to enable) is used to subscribe to new block heads. Otherwise, Blockscout will trigger new blocks fetching by periodically polling the JSON RPC `eth_blockNumber` method.
* Support for the following standard Ethereum JSON RPC methods (documented at [https://ethereum.github.io/execution-apis/api-documentation/](https://ethereum.github.io/execution-apis/api-documentation/))
* `eth_blockNumber`
* `eth_call`
* `eth_getBalance`
* `eth_getCode`
* `eth_getBlockByHash`
* `eth_getBlockByNumber`
* `eth_getTransactionByHash`
* `eth_getTransactionByBlockHashAndIndex`
* `eth_getTransactionByBlockNumberAndIndex`
* `eth_getTransactionReceipt`
* `eth_getUncleByBlockHashAndIndex`
* `eth_getLogs`
### **Fetching Pending Transactions**
*Note pending transactions must be supported by the RPC node to enable this functionality with Blockscout*
| Client | Method |
| - | - |
| Nethermind OpenEthereum | `parity_pendingTransactions` |
| Geth Erigon | `txpool_content` |
### Enable Tracing to Fetch Internal Transactions
| Client | Method |
| - | - |
| Erigon Nethermind OpenEthereum | β’ `trace_replayBlockTransactions` (fetching of internal transactions)
β’ `trace_block` (fetching of block rewards) |
| Geth | β’ `debug_traceBlockByNumber`
β’ or `debug_traceTransaction`
`callTracer` is used by default, starting from the Blockscout 5.1.0 release. To switch to a custom JS tracer, the Blockscout maintainer should set the `export INDEXER_INTERNAL_TRANSACTIONS_TRACER_TYPE=js` environment variable. Prior to the 5.1.0 release, js tracer was a default option. |
| RSK | β’ `trace_block` (fetching of internal transactions) |
### JSON RPC Performance Benchmarks
Time measures for response time of crucial JSON RPC methods for indexing in Blockscout. [Ways to improve speed](/faqs/faqs#how-do-i-speed-up-my-self-hosted-instance).
1. `eth_getBlockByNumber` without transaction receipts for a block with 15 transactions: Desired response time is \< 0.5s. For instance, in case of the Gnosis chain archive node, the response time for the block with \~20 transactions is \~0.4s.
2. `eth_getTransactionReceipt` for random transactions desired response time is \< 0.5s. For the Gnosis chain archive node the response time is \~0.3 - 0.4s.
3. Batched `eth_getTransactionReceipt` for 15 transactions acceptable response time is less than 1s. For the Gnosis chain archive node, it is \~0.6 - 0.7s.
### Rate Limit
The desired rate limit for RPC endpoint is 200 req/sec for the indexing phase and 100 req/sec for the indexed chain.
### EVM Requirements & Clients
* All EVM chains must [define these variables](/setup/env-variables#required-env-variables) during configuration.
* BlockScout currently supports Erigon, Geth, Nethermind, Hyperledger Besu, and Anvil clients. Define the node variant using the `ETHEREUM_JSONRPC_VARIANT` environment variable. [More information](/setup/requirements/client-settings)
### L2 -> L1 JSON RPC Methods
* Find information on JSON RPC method use with [different L2 types.](/setup/requirements/l2-greater-than-l1-json-rpc-method-requests)
# General backend requirements and prerequisites
Source: https://docs.blockscout.com/setup/requirements/requirements
Software dependencies (Erlang, Elixir, PostgreSQL, Node.js, GCC, GMP, and more) required to install and run the Blockscout backend.
Install the software below prior to Blockscout installation. For additional requirements see:
* [Database Storage Requirements](/setup/requirements/database-storage-requirements): Storage required for common chains to give a sense of needed storage
* [Node Tracing Requirements](/setup/requirements/node-tracing-json-rpc-requirements): JSON RPC methods
* [Client Setting Requirements](/setup/requirements/client-settings): Settings related to client implementations (ie Geth, OpenEthereum, etc)
* [Hardware/Hosting Requirements](/setup/requirements/resource-requirements): Base requirements for a hosted instance of Blockscout.
| Dependency | Mac | Linux |
| - | - | - |
| [Erlang/OTP 28](https://github.com/erlang/otp) | `brew install erlang` | [Erlang Install Example](https://github.com/poanetwork/blockscout-terraform/blob/33f68e816e36dc2fb055911fa0372531f0e956e7/modules/stack/libexec/init.sh#L134) |
| [Elixir 1.19.x](https://elixir-lang.org/) | `brew install elixir` | [Elixir Install Example](https://github.com/poanetwork/blockscout-terraform/blob/33f68e816e36dc2fb055911fa0372531f0e956e7/modules/stack/libexec/init.sh#L138) |
| [Postgres 14+](https://www.postgresql.org/) | `brew install postgresql` | [Postgres Install Example](https://github.com/poanetwork/blockscout-terraform/blob/33f68e816e36dc2fb055911fa0372531f0e956e7/modules/stack/libexec/init.sh#L187)
*Note*: Application versions earlier than v12 also support PostgreSQL 12 and 13. |
| [Node.js 20.x.x](https://nodejs.org/en/) | `brew install node` | [Node.js Install Example](https://github.com/poanetwork/blockscout-terraform/blob/33f68e816e36dc2fb055911fa0372531f0e956e7/modules/stack/libexec/init.sh#L66) |
| [Automake](https://www.gnu.org/software/automake/) | `brew install automake` | [Automake Install Example](https://github.com/poanetwork/blockscout-terraform/blob/33f68e816e36dc2fb055911fa0372531f0e956e7/modules/stack/libexec/init.sh#L72) |
| [Libtool](https://www.gnu.org/software/libtool/) | `brew install libtool` | [Libtool Install Example](https://github.com/poanetwork/blockscout-terraform/blob/33f68e816e36dc2fb055911fa0372531f0e956e7/modules/stack/libexec/init.sh#L62) |
| [Inotify-tools](https://github.com/rvoicilas/inotify-tools/wiki) | Not Required | Ubuntu - `apt-get install inotify-tools` |
| [GCC Compiler](https://gcc.gnu.org/) | `brew install gcc` | [GCC Compiler Example](https://github.com/poanetwork/blockscout-terraform/blob/33f68e816e36dc2fb055911fa0372531f0e956e7/modules/stack/libexec/init.sh#L70) |
| [GMP](https://gmplib.org/) | `brew install gmp` | [Install GMP Devel](https://github.com/poanetwork/blockscout-terraform/blob/33f68e816e36dc2fb055911fa0372531f0e956e7/modules/stack/libexec/init.sh#L74) |
| [Ffmpeg](https://ffmpeg.org/) | `brew install ffmpeg@7` | `sudo apt install ffmpeg` if Debian |
| Make | - | `sudo apt install make` if Debian |
| G++ Compiler | - | `sudo apt install g++` if Debian |
Additional requirements for Blockscout versions below 5.1.3:
| Dependency | Mac | Linux |
| - | - | - |
| Rust | - | [Install Rust](https://www.rust-lang.org/tools/install) |
| Cargo | - | Ubuntu - `apt-get install cargo` |
# Hardware & Hosting Requirements
Source: https://docs.blockscout.com/setup/requirements/resource-requirements
Recommended CPU, RAM, disk, and AWS EC2/RDS PostgreSQL baseline sizing for hosting a Blockscout explorer with an EVM archive node backend.
Resource requirements may vary based on chain size and other parameters. This mainly impacts [database storage](/setup/requirements/database-storage-requirements) requirements. Basic [prerequisites](/setup/requirements/requirements) and settings can be found throughout the [Information and Settings](/setup/information-and-settings) section for developers.
BlockScout requires a full archive node to import every state change for every address on the target network.
## Recommended Base Hardware
EVM chains can differ in size and requirements, these are the recommendations for optimal performance.
| CPU | 16 core, 32 thread |
| - | - |
| RAM | 128GB |
## Hosting Requirements
Minimums are listed for an AWS Cloud instance and can be inferred to other hosting providers.
| | |
| - | - |
| Application | β’ 1x EC2 m5a.xlarge instance running Linux
β’ 8GB of EBS General Purpose SSD (NVMe) |
| Database | β’ 1x RDS Database running on db.t3.large using PostgreSQL v14+
β’ 500GB of General Purpose SSD (depending on chain size)
β’ See [Database Storage Requirements](/setup/requirements/database-storage-requirements) for chain-relevant baselines. |
| Amazon Elastic Load Balancing | β’ Average 100 new connections/sec per Elastic Load Balancer |
Requirements will vary based on chain. For example, these are the recommended requirements for a Harmony Explorer Node:
**Setup**: AWS i3en.12xlarge or equivalent, with local disk storage **Storage**: \~24TB (4x NVMe SSD) is recommended for Archival Explorer Nodes on Shard 0 **OS**: Latest Ubuntu Linux (LTS Version) **Network**: 100M+ bandwidth
For additional information, see:
* [General Requirements:](/setup/requirements/requirements) Software required for deployment
* [Database Storage Requirements](/setup/requirements/database-storage-requirements): Storage required for common chains to give a sense of needed storage
* [Node Tracing Requirements](/setup/requirements/node-tracing-json-rpc-requirements): JSON RPC methods
* [Client Setting Requirements](/setup/requirements/client-settings): Settings related to client implementations (ie Geth, OpenEthereum, etc)
# Testing
Source: https://docs.blockscout.com/setup/testing
Run the Blockscout Elixir test suites (indexer, explorer, block_scout_web, ethereum_jsonrpc) with chromedriver, Postgres, Geth, and Nethermind.
### Requirements
* Install `chromedriver`. It is required to run tests from `./apps/block_scout_web` of the Umbrella application.
* This set of environment variables is required for each run of the test (`mix test`) suite:
```bash theme={null}
export MIX_ENV=test
export POSTGRES_DB=explorer_test
export POSTGRES_PASSWORD=postgres
export POSTGRES_USER=postgres
export CHAIN_ID=77
```
Since v6.6.0, there are more flexible options for configuring the database used in testing. Refer to the `TEST_DATABASE_URL` and `DATABASE_READ_ONLY_API_URL` environment variables for more details.
```bash theme={null}
export MIX_ENV=test
export TEST_DATABASE_URL=postgresql://postgres:postgres@postgres-host:5432/explorer_test
export CHAIN_ID=77
```
### Running tests
1. Build assets. `cd apps/block_scout_web/assets && npm run build; cd -`
2. Format Elixir code. `mix format`
3. Lint Elixir code. `mix credo --strict`
4. Run the dialyzer. `mix dialyzer --halt-exit-status`
5. Check the Elixir code for vulnerabilities. `cd apps/explorer && mix sobelow --config; cd -` `cd apps/block_scout_web && mix sobelow --config; cd -`
6. Lint JavaScript code. `cd apps/block_scout_web/assets && npm run eslint; cd -`
7. Test JavaScript code. `cd apps/block_scout_web/assets && npm run test; cd -`
8. Run separate test suites for the Umbrella application
- `indexer`
`mix do ecto.create --quiet, ecto.migrate && cd apps/indexer && mix do compile, test --no-start && cd -`
- `explorer`
`mix do ecto.create --quiet, ecto.migrate && cd apps/explorer && mix do compile, test --no-start && cd -`
- `block_scout_web`
`mix do ecto.create --quiet, ecto.migrate && cd apps/block_scout_web && mix do compile, test --no-start && cd -`
- `ethereum_jsonrpc`
`mix do ecto.create --quiet, ecto.migrate && cd apps/ethereum_jsonrpc && mix do compile, test --no-start && cd -`
### **Nethermind**
**Mox**
**This is the default setup.** `mix test --no-start` **will work on its own, but to be explicit, use the following setup**:
```bash theme={null}
ETHEREUM_JSONRPC_CASE=EthereumJSONRPC.Case.Nethermind.Mox \
ETHEREUM_JSONRPC_WEB_SOCKET_CASE=EthereumJSONRPC.WebSocket.Case.Mox \
mix test --no-start --exclude no_nethermind
```
**HTTP / WebSocket**
```bash theme={null}
ETHEREUM_JSONRPC_CASE=EthereumJSONRPC.Case.Nethermind.HTTPWebSocket \
ETHEREUM_JSONRPC_WEB_SOCKET_CASE=EthereumJSONRPC.WebSocket.Case.Nethermind \
mix test --no-start --exclude no_nethermind
```
| Protocol | URL |
| - | - |
| HTTP | `http://localhost:8545` |
| WebSocket | `ws://localhost:8546` |
### **Geth**
**Mox**
```bash theme={null}
ETHEREUM_JSONRPC_CASE=EthereumJSONRPC.Case.Geth.Mox \
ETHEREUM_JSONRPC_WEB_SOCKET_CASE=EthereumJSONRPC.WebSocket.Case.Mox \
mix test --no-start --exclude no_geth
```
**HTTP / WebSocket**
```bash theme={null}
ETHEREUM_JSONRPC_CASE=EthereumJSONRPC.Case.Geth.HTTPWebSocket \
ETHEREUM_JSONRPC_WEB_SOCKET_CASE=EthereumJSONRPC.WebSocket.Case.Geth \
mix test --no-start --exclude no_geth
```
| Protocol | URL |
| - | - |
| HTTP | `https://mainnet.infura.io/8lTvJTKmHPCHazkneJsY` |
| WebSocket | `wss://mainnet.infura.io/ws/8lTvJTKmHPCHazkneJsY` |
# Soneium API
Source: https://docs.blockscout.com/soneium-api
Blockscout is Soneium's primary block explorer. Full API access for Sony's OP Stack Ethereum L2 mainnet and Minato testnet with free and paid tiers.
# Soneium API β Block Explorer API for Sony's Ethereum L2 | Blockscout
> Blockscout is the primary explorer for Soneium. Full API access for mainnet and Minato testnet β free and paid tiers.
## Soneium API Access with Blockscout
Soneium is Sony's Ethereum Layer 2, built on the OP Stack and developed through Sony Block Solutions Labs in partnership with Startale Group. It connects Sony's entertainment and consumer electronics businesses β spanning gaming, music, film, and digital media β with onchain infrastructure.
Since its mainnet launch in January 2025, Soneium has processed over 500 million transactions, onboarded 5.4 million active wallets, and hosts more than 250 decentralized applications focused on fan engagement, digital collectibles, IP licensing, and AI-powered creative tools. Startale closed a \$63M Series A in March 2026 led by Sony Innovation Fund with participation from Samsung Next, UOB Venture Management, and SBI Holdings β signaling serious long-term institutional backing.
Blockscout is Soneium's primary block explorer. Etherscan does not support Soneium. If you're building on Soneium, Blockscout provides your API β on both mainnet and the Minato testnet.
**Soneium Mainnet Chain ID:** `1868` **Soneium Minato Testnet Chain ID:** `1946`
| Network | Explorer | PRO API `chainid` |
| - | - | - |
| Soneium Mainnet | [soneium.blockscout.com](https://soneium.blockscout.com) | `1868` |
| Soneium Minato Testnet | [soneium-minato.blockscout.com](https://soneium-minato.blockscout.com) | `1946` |
**PRO API Base:** `https://api.blockscout.com` (use `chainid=1868` or `chainid=1946`)
## Quick Start
Get your first API response in under 60 seconds:
```bash theme={null}
# Mainnet β get ETH balance for an address
curl "https://api.blockscout.com/v2/api?chainid=1868&module=account&action=balance&address=0xYOUR_ADDRESS&apikey=proapi_YOUR_KEY"
# Minato Testnet β same call, different chainid
curl "https://api.blockscout.com/v2/api?chainid=1946&module=account&action=balance&address=0xYOUR_ADDRESS&apikey=proapi_YOUR_KEY"
```
Get a free API key at [dev.blockscout.com](https://dev.blockscout.com). It is required for all PRO API tiers, including the free tier. The same key works for both mainnet and testnet, and any other chains you want to query.
## PRO API Routes for Soneium
### Mainnet (chainid=1868)
**JSON RPC v2 (Etherscan-compatible):**
```text theme={null}
https://api.blockscout.com/v2/api?chainid=1868&module=account&action=txlist&address=0x...&apikey=proapi_xxx
```
**JSON RPC:**
```text theme={null}
https://api.blockscout.com/1868/api?module=account&action=txlist&address=0x...&apikey=proapi_xxx
```
**REST API:**
```text theme={null}
https://api.blockscout.com/1868/api/v2/addresses/0x.../transactions?apikey=proapi_xxx
```
**ETH RPC (POST):**
```bash theme={null}
curl -H "content-type: application/json" \
-H "authorization: Bearer proapi_xxx" \
-X POST \
--data '{"id":0,"jsonrpc":"2.0","method":"eth_blockNumber","params":[]}' \
https://api.blockscout.com/1868/json-rpc
```
### Minato Testnet (chainid=1946)
Every route works identically β swap `1868` for `1946`:
```text theme={null}
https://api.blockscout.com/v2/api?chainid=1946&module=account&action=txlist&address=0x...&apikey=proapi_xxx
```
```text theme={null}
https://api.blockscout.com/1946/api/v2/addresses/0x.../transactions?apikey=proapi_xxx
```
As an OP Stack chain, the PRO API also includes OP-specific endpoints under the `optimism` module for rollup data like deposits, withdrawals, and batch submissions.
## Available Endpoints
### Etherscan-Compatible Modules
Standard Etherscan-compatible modules work out of the box on both mainnet and testnet:
* **Account** β Balances, transaction lists, token transfers, internal transactions, ERC-20/721/1155 activity (plus Blockscout extras: `eth_get_balance`, `pendingtxlist`, `tokenbalance`, `tokenlist`)
* **Contract** β ABI, source code, verification (plus: `listcontracts`, `getcontractcreation`, Vyper & Sourcify verification)
* **Transaction** β Status checks (plus: `gettxinfo`)
* **Logs** β Event logs with filtering by address, topics, block range
* **Token** β Token metadata, holders
* **Stats** β Supply, chain statistics, coin price
* **Block** β Block rewards, countdown, block number by time
* **Gas Tracker** β Gas oracle, gas estimates
### REST API
Blockscout's REST API extends beyond the Etherscan-compatible interface with enriched metadata, decoded input data, NFT media and attributes, smart contract read/write interaction, and chain indexing status.
**β [Mainnet REST API Reference](https://soneium.blockscout.com/api-docs)** Β· **β [Minato REST API Reference](https://soneium-minato.blockscout.com/api-docs)**
## Soneium API Pricing
| Tier | Rate Limit | Credits | Price |
| - | - | - | - |
| Free | 5 RPS | 100K/day | \$0 |
| Builder | 15 RPS | 100M/mo | \$49/mo |
| Pro | 30 RPS | 500M/mo | \$199/mo |
| Business | 50 RPS | 3B/mo | \$999/mo |
| Enterprise | Custom | Custom | Contact us |
One API key covers Soneium mainnet, Minato testnet, and every other Blockscout-supported chain β 117 networks total. Testnet calls consume credits from the same pool.
## Coming from Other OP Stack Chains?
Soneium uses the same OP Stack infrastructure that powers Base, Optimism, Zora, and Ink. If you've built on any Superchain network with the Blockscout PRO API, querying Soneium is a `chainid` swap:
```javascript theme={null}
// Multichain across the Superchain β one function, one API key
const BLOCKSCOUT_KEY = process.env.BLOCKSCOUT_KEY;
const CHAINS = {
soneium: 1868,
soneium_testnet: 1946,
base: 8453,
optimism: 10,
ink: 57073,
zora: 7777777,
};
async function getTokenTransfers(chainName, address) {
const chainId = CHAINS[chainName];
const resp = await fetch(
`https://api.blockscout.com/v2/api?chainid=${chainId}&module=account&action=tokentx&address=${address}&apikey=${BLOCKSCOUT_KEY}`
);
return resp.json();
}
// Query Soneium mainnet
const mainnetTxns = await getTokenTransfers("soneium", "0x...");
// Test against Minato first β same function, same key
const testnetTxns = await getTokenTransfers("soneium_testnet", "0x...");
```
If you're migrating from Etherscan V2 on another chain, the structure is nearly identical. Etherscan uses `api.etherscan.io/v2/api?chainid=X`, Blockscout uses `api.blockscout.com/v2/api?chainid=X`. But Etherscan doesn't support Soneium at all β Blockscout is your only option.
**β [Full Migration Guide](https://docs.blockscout.com/devs/migrate-from-etherscan)**
## Developing on Soneium Minato Testnet
Minato provides a full sandbox environment that mirrors mainnet conditions. Developers use it to validate contracts, test bridge flows, and iterate on dApps before deploying to production. Blockscout covers the testnet with the same explorer and API infrastructure as mainnet.
**Testnet workflow with the PRO API:**
```python theme={null}
import requests
BLOCKSCOUT_KEY = os.environ["BLOCKSCOUT_KEY"]
def query_soneium(chainid, module, action, **params):
"""Query either Soneium mainnet (1868) or Minato testnet (1946)."""
resp = requests.get("https://api.blockscout.com/v2/api", params={
"chainid": chainid,
"module": module,
"action": action,
"apikey": BLOCKSCOUT_KEY,
**params
})
return resp.json()
# Verify your contract ABI is accessible on testnet before mainnet deploy
testnet_abi = query_soneium(1946, "contract", "getabi", address="0xYOUR_CONTRACT")
# After mainnet deploy, same call with chainid=1868
mainnet_abi = query_soneium(1868, "contract", "getabi", address="0xYOUR_CONTRACT")
```
**Getting testnet ETH:** Soneium Minato uses Sepolia ETH bridged via the [Soneium testnet bridge](https://bridge.soneium.org/testnet). Faucets are also available through [Chainlink](https://faucets.chain.link/soneium-minato) and other providers.
## What Developers Build on Soneium with Blockscout's API
**Entertainment & Fan Engagement** β Soneium's core thesis is onchain entertainment. Developers building fan platforms, digital collectibles, loyalty programs, and creator tools need API access to token data, NFT metadata, and transaction history tied to Sony IP ecosystems. Projects like KAMI (programmable digital IP objects) and IDOL RUNWAY COLLECTION are already live.
**Stablecoin & Payments Infrastructure** β Startale USD (USDSC) is live as Soneium's native settlement layer, and a JPY-denominated stablecoin (JPYSC) is in development for cross-border payments across Asia-Pacific. Developers are building payment flows that query transaction status, token balances, and transfer events through the API.
**Mini Apps & the Startale Super-App** β The Startale App integrates wallet management, dApp access, and asset management in a single interface, with Mini Apps built by third-party developers. These Mini Apps use explorer APIs for wallet data, transaction confirmation, and contract interaction.
**AI & Creator Tools** β Soneium's focus on entertainment IP attracts AI-driven creative applications. Blockscout's PRO API and MCP server provide structured onchain data for agents operating in the creator economy β from automated royalty tracking to AI-generated NFT minting flows.
**Gaming & Digital Twins** β Sony and Startale are testing high-fidelity digital twins and NFT-based ticketing systems natively integrated into Soneium, bridging physical events with digital ownership. Game studios building on Soneium use the API for in-game economy tracking, item transfers, and player wallet queries.
## Soneium on Blockscout
Blockscout is the primary explorer for both Soneium mainnet and Minato testnet. As part of the OP Superchain, Soneium benefits from Blockscout's native support for cross-chain transaction tracking, deposit/withdrawal views, and Superchain interoperability features. The \$63M Series A and backing from Sony, Samsung, UOB, and SBI signal institutional confidence that Soneium is here to stay. For developers building at the intersection of entertainment, IP, and blockchain, Soneium on Blockscout provides the infrastructure to power applications backed by some of the world's largest entertainment and financial companies.
## Get Started
1. Get a free API key at [**dev.blockscout.com**](https://dev.blockscout.com)
2. Use `chainid=1946` (Minato testnet) to develop and test
3. Switch to `chainid=1868` (mainnet) when you're ready to deploy
4. Explore endpoints at [**soneium.blockscout.com/api-docs**](https://soneium.blockscout.com/api-docs)
**β [Start Building on Soneium](https://dev.blockscout.com)** Β· **β [PRO API Routes Reference](https://docs.blockscout.com/devs/pro-api-responses-and-routes)** Β· **β [Soneium Developer Docs](https://docs.soneium.org/docs/builders/overview)**
# Autoscout Explorer Launchpad
Source: https://docs.blockscout.com/using-blockscout/autoscout
Autoscout is Blockscout's self-serve launchpad to deploy a production-ready hosted block explorer for EVM chains and rollups in minutes.
Want to try Autoscout for Free? Request test credits in the [Blockscout Discord](https://discord.gg/blockscout) `#autoscout` channel or email us at [community@blockscout.com](mailto:community@blockscout.com) and we'll top up your account.
Autoscout is a self-service launchpad for chains and rollups looking to deploy an explorer quickly on hosted infrastructure. It is optimized for many chain types including Optimistic and Arbitrum Orbit rollups and zk rollups including Polygon zkEVM and zkSync.
Get Started at [https://deploy.blockscout.com](https://deploy.blockscout.com).
### Get Started with Autoscout
1. **Create an account:** To get started, go to [https://deploy.blockscout.com/](https://deploy.blockscout.com/), create an account, and log in to get started.
2. **Purchase credits:** You will need credits to launch your explorer. Each credit costs \$1.00. Purchase via Stripe with a credit card or via crypto. Credits are deducted in real time, see the pricing table below for costs.
* **You can start with any amount of credits to test your instance. Instances cost between 0.49 - 1.35 credits per hour, depending on the size.**
3. **Add a new instance:** Click the Add instance button to get started.
4. **Add your network info**: See below for info on configuration and parameters.
5. **Deploy your explorer:** Click save and deploy to start the deployment process. In 5-10 minutes your explorer will be live and indexing your chain. Once deployed you can access your explorer link.
6. See [Creating an Instance](/using-blockscout/creating-an-instance) for additional details.
## Autoscout Pricing
Autoscout is a pay-as-you-go service. **Start with any amount of credits** and **increase the balance at any time**.
If your account runs out of credits your instance will be stopped until you top your account back up. If this happens, you will need to relaunch (and reindex) your instance once you add additional credits. Instances will scale based on daily transactions, so be sure to monitor and top up accordingly.
![]()
| Size | Hourly | Daily | Weekly | Monthly |
| - | - | - | - | - |
| Small \<50K tx per day | .485 | 12 | 84 | 349 |
| Medium \<150K tx per day | .972 | 24 | 168 | 699 |
| Large \<1M tx per day | 1.32 | 32 | 224 | 949 |
## HDD Billing
In addition to billing based on tx/day, instances are allotted an amount of free disk space as follows:
Instance Size Free Disk Quotas
* Small - 512 GB
* Medium - 1024 GB (1 TB)
* Large - 2048 GB (2 TB)
The status tab shows current HD consumption.
**Once an instance exceeds the Free GB amount, additional credits are required to cover overages for additional usage. Typically it makes sense for an instance to upgrade to a higher tier once these limits are reached. Overage costs are billed at \$0.00015 per GB hour.**
# Dappscout Apps Marketplace
Source: https://docs.blockscout.com/using-blockscout/blockscout-apps
Dappscout is a curated in-explorer marketplace of embedded dapps letting users connect a wallet once and interact across supported chains.
π‘ Submit your dapp now [with this quick form](https://airtable.com/appiy5yijZpMMSKjT/paggtimMHyz0AsOCC/form)!
Dappscout Apps Marketplace provides a curated list of apps available to on-chain users. Projects can submit their project for review, and once accepted, the project is listed in the marketplace.
![]()
## Direct Interface
Dapps are either embedded into the interface directly (like this [Uniswap example](https://optimism.blockscout.com/apps/uniswap)) or added as 3rd party links. When embedded, a user can connect their web3 wallet once to Blockscout, then use it with all of the supported Dapps. This saves time and makes for a seamless user experience when switching between multiple applications.
![]()
![]()
To enable direct embedding, Dapps need to:
1. Support iframe embedding on 3rd party domains.
2. Integrate the [Safe Apps SDK](https://docs.safe.global/apps-sdk-overview).
[***See Dapp integration for more details.***](/using-blockscout/blockscout-apps/dapp-integration)
## Dapps you can Trust
Dappscout marketplace provides additional security and peace of mind when interacting with various Dapps on a chain. Rather than accessing potentially fake links, scam sites or compromised interfaces, all Dapps in Blockscout are vetted and added by the curation team. Dappscout Dapps are safe and secure for users.
## Dappscout Submissions
There are several ways to submit a DApp. You will fill out a form with basic information to get started.
* Use this form to [submit directly](https://airtable.com/appiy5yijZpMMSKjT/paggtimMHyz0AsOCC/form).
* Use the submit app button within the marketplace.
![]()
## Blockscout Native Dapps
In addition to 3rd party apps, Blockscout is developing native apps for the Marketplace. These include:
* [Swap](/using-blockscout/essential-dapps/swap): Swapping and bridging application.
* Revokescout: Manage and revoke contract approvals.
## Dapp Star Ratings
Users can rate dapps on a 1-5 star basis. A user must connect their wallet to the explorer, and that wallet must have at least 5 transactions on the chain in order to rate a dapp. Dapps can be sorted by rating score and the number of ratings.
A full rundown on the process is available in this blog post:
Blockscout | Multichain Block Explorer For EVM Chains
Please note: The star rating system is currently experimental. This feature was released in beta testing to assess user interest in ratings and reviews. Current results may be affected by rating biases, including automated or mass submissions. We're actively improving the system based on user feedback.
# DApp Integration
Source: https://docs.blockscout.com/using-blockscout/blockscout-apps/dapp-integration
Integrate your dapp with Dappscout using iframe support and the Safe Apps SDK to gain top listing, embed inside Blockscout, and share wallets.
Embedded DApps allow users to connect with a single wallet, providing a seamless user experience that eliminates the need to visit different urls and connect a wallet each time. See the [How to Integrate](/using-blockscout/blockscout-apps/dapp-integration#how-to-integrate) section below to prepare your DApp.
## Integration Levels
There are several levels of integration with DAppscout.
Our goal is to have as many fully integrated apps as possible!
1. **Fully Integrated Apps**
* Apps that are opened in an iFrame on \*.blockscout.com domains and have integrated the Safe Apps SDK
2. **Partially Integrated Apps**
* Apps that are opened in an iFrame on \*.blockscout.com domains, but have not integrated the Safe Apps SDK for various reasons
3. **Non-Integrated Apps**
* Apps that are not opened in an iFrame on \*.blockscout.com domains and have not integrated the Safe Apps SDK for various reasons
Fully integrated DApps list higher within the default view.
## Integration Benefits
Fully integrated apps receive the following benefits
1. **Top Places in the Ranking for Users**
* All fully integrated apps will appear at the top of the list in their categories.
2. **Free Promo Through Ads**
* Protocols will receive free promotion on Blockscout for a limited time.
3. **Co-Marketing with Blockscout**
* In addition to free promotion, weβll prepare a co-marketing campaign on social media and our blog.
4. **A Special Quality Mark**
* All fully integrated DApps have a green βFully-Integratedβ symbol which shows users it is ready for use.
![]()
## How to Integrate
To fully integrate your protocol into DAppscout, you will need to do 3 things.
1. Enable iFrames for the \*.blockscout.com domain
2. Integrate the Safe Apps SDK
3. Submit your DApp via the form
### 1) Enable iFrame support
Both fully and partially integrated apps in the marketplace are embedded using iFrames, and it is necessary to enable iFrame support for our domain - \*.blockscout.com. This can typically be done via the `frame-ancestors` directive of the `Content-Security-Policy` header in your application. For additional examples, please see [https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy/frame-ancestors](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy/frame-ancestors).
Also, check your [CORS](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) settings, these may need to be modified for the \*.blockscout domain.
### 2) Integrate the Safe Apps SDK
DAppscout uses the Safe Apps SDK to automatically connect a wallet linked to Blockscout to any of the apps in our marketplace. This allows a visitor to connect a wallet once and then open any app without needing to connect the wallet again.
To enable this functionality, Safe Apps SDK needs to be integrated for your protocol, and the \*.blockscout.com domain added as an exception.
The [SAFE SDK documentation page](https://docs.safe.global/apps-sdk-get-started) provides resources to help you through the process. You will need to pass \*.[blockscout.com](http://blockscout.com/) as an additional option to the SafeAppsSDK function into the code [here](https://github.com/safe-global/safe-apps-sdk/tree/main/packages/safe-apps-sdk#documentation).
For additional integration options, check the list of other Safe packages for Safe Apps at [https://github.com/safe-global/safe-apps-sdk?tab=readme-ov-file#packages](https://github.com/safe-global/safe-apps-sdk?tab=readme-ov-file#packages)
If you integrate any of these packages, DAppscout can use them to automatically connect a wallet to your app.
After integrating the Safe Apps, make sure you have added the \*.blockscout.com domain as an exception to the SDK. Otherwise, we cannot utilize the Safe Apps SDK on our website.
It is not necessary to have the Safe app/smart contracts on a network where your app is deployed. Itβs only necessary to integrate Safe Apps SDK for your application.
### 3) Submit your DApp
To submit your DApp to a marketplace, simply click on the submit DApp button. You will be taken to a form where you will fill out the needed information including contract addresses, description, logo, and links. Once your DApp is submitted, the DAppscout team will reach out with any questions and add your DApp to the marketplace.
![]()
# Creating an Instance
Source: https://docs.blockscout.com/using-blockscout/creating-an-instance
Step-by-step guide to configuring an Autoscout explorer instance with chain info, RPC, branding, indexer tuning, and rollup settings.
## Create Instance
Get started at [https://deploy.blockscout.com/](https://deploy.blockscout.com/)
* There are several tabs to fill out to launch your instance: Info, Branding, and Rollup config (if needed). Plugins (currently the only live plugin is stats) can be added once your instance is fully indexed.
* Edit parameters at any time, but this typically requires relaunching and reindexing the instance.
* Check out the visual guide on our blog for a basic walkthrough: [https://www.blog.blockscout.com/ship-faster-with-autoscout-deploy-a-block-explorer-with-status-logs-and-advanced-features/](https://www.blog.blockscout.com/ship-faster-with-autoscout-deploy-a-block-explorer-with-status-logs-and-advanced-features/)
Power users can use the [Autoscout API](/devs/apis/autoscout-api) to deploy and manage instances.
### Info
The following parameters are in the Info section. \* parameters are required.
* **Instance size\***: Select based on the number of transactions anticipated for the instance. The costs are currently placeholders, but your credits will be impacted according to chain usage.
* **Chain name**: The chain name will be shown in the top explorer banner.
* **Instance name\***: A label for your instance, it is reflected in the url of the instance ie [https://instance-name.cloud.blockscout.com/](https://instance-name.cloud.blockscout.com/)
* **Chain ID**: If you don't know the chain ID you can get it with the `eth_chainId` JSON-RPC method.
* **Node type:** Choose from the list of clients for the archive node:
* Besu, Erigon, Anvil, Geth, Parity
* **Gas token symbol**: Will show in the interface, for example ETH if your chain uses Ether for gas.
* **Mainnet or Testnet**: Select the type of chain, if Testnet a label will be added to the instance.
* **This chain is a Rollup**: If selected, another field will appear to select **Arbitrum, Optimism, Polygon zkEVM or zkSync**. You will then fill out additional information in the Rollup Config tab.
* **HTTP RPC URL\***: The **archive node** url ([https://your-rpc-url](https://your-rpc-url)) [***Note: archive node is required for internal transactions and token/coin historical balances. Tracing should be enabled for internal transactions.***](/setup/requirements/node-tracing-json-rpc-requirements)
* **WS URL**: The websocket url (wss\://ws.your-websocket-url)
* **Chain spec URL**: URL to chain specification path json (Sepolia example: [chainspec.json](https://github.com/ethpandaops/ethereum-genesis-generator/blob/v4.1.8/apps/el-gen/sepolia/chainspec.json) or [genesis.json](https://github.com/ethpandaops/ethereum-genesis-generator/blob/v4.1.8/apps/el-gen/sepolia/genesis.json)). You will use the raw JSON file; in the Sepolia example this url is [https://raw.githubusercontent.com/ethpandaops/ethereum-genesis-generator/v4.1.8/apps/el-gen/sepolia/chainspec.json](https://raw.githubusercontent.com/ethpandaops/ethereum-genesis-generator/v4.1.8/apps/el-gen/sepolia/chainspec.json)
* **Custom Domain**: You can use a custom domain for your instance but must configure your DNS and add a DNS `CNAME` record pointing to `autoscout.cname.blockscout.com`
* **Domain redirect(s):** Any additional domain names to redirect to the instance, comma separated.
* **Public RPC URL**: Enables 'add to MetaMask button'. Can be the same as the RPC URL if this is a public node.
* **WalletConnect project ID:** Enables the ability for Read and Write functionality with smart contracts. [Learn more about setting one up here](/setup/configuration-options/walletconnect-project-id-for-contract-read-write).
* **Google Analytics property ID**: Add the ID for your GA account if desired.
### Branding
* **Announcement banner:** Add an optional banner to the top of your instance, can include HTML code.
* **Default color theme**: Choose between a light theme and 3 variations of a darker theme.
* **Default address identicon:** Select from 4 different options for default identicons in your instance.
* **Vertical or Horizontal menu**: Select vertical for a side menu or horizontal for a top menu.
* **Full logo URL**: Add a url link to your full logo image in horizontal format. Supported formats: image/jpeg, image/gif, image/png. Add one for light mode and one for dark mode if desired (users can switch modes manually).
* **Logo sign (square) URL**: Add a url link to your square logo image in horizontal format. Supported formats: image/jpeg, image/gif, image/png. Add one for light mode and one for dark mode if desired (users can switch modes manually).
* **Header background gradient and text color**: Choose your desired background color gradients with the selector and choose your preferred text color. You will see a preview in the interface.
* **Favicon and OG image URL**: Add your favicon and [OG image](https://ogp.me/). OG image specs: Minimum image size is 200Γ20 pixels (recommended: 1200Γ600); maximum supported file size is 8 MB; 2:1 aspect ratio; supported formats: image/jpeg, image/gif, image/png
* **OG description**: Add a description for Open Graph Previews
* **Enable enhanced OG tags**: Toggle if you want to render OG tags for API data pages
* **Enable enhanced SEO**: Toggle if you want to rerender page titles for Stats and Tokens pages to enhance SEO
* **API documentation links**: Toggle to show/hide different API links in the navigation menu
* **Other Navigation links**: Add custom navigation links to the other section of the primary navigation menu
* **Footer links**: Add up to 3 columns along with titles and urls for the links you want added to each column.
* **Ads**: Select providers for Ads on your instance
### Indexer
Indexer information uses the following variables under the hood. If no information is filled in, default variables are used.
| Variable | Default |
| :- | :- |
| `INDEXER_RECEIPTS_BATCH_SIZE` | 250 |
| `INDEXER_RECEIPTS_CONCURRENCY` | 10 |
| `INDEXER_INTERNAL_TRANSACTIONS_BATCH_SIZE` | 10 |
| `INDEXER_INTERNAL_TRANSACTIONS_CONCURRENCY` | 4 |
| `INDEXER_CATCHUP_BLOCKS_BATCH_SIZE` | 10 |
| `INDEXER_CATCHUP_BLOCKS_CONCURRENCY` | 10 |
| `INDEXER_COIN_BALANCES_BATCH_SIZE` | 100 |
| `INDEXER_COIN_BALANCES_CONCURRENCY` | 4 |
| `INDEXER_TOKEN_BALANCES_BATCH_SIZE` | 100 |
| `INDEXER_TOKEN_BALANCES_CONCURRENCY` | 10 |
### Disable pending transactions fetcher
Leave this setting alone if your RPC supports pending transactions. However, **if your RPC node does not support pending transactions, please toggle this switch to disable.**
**Check pending TX support** by sending a request for one of the common methods (`eth_getBlockByNumber` with `"pending"` or `txpool_content`) and observe the response. A successful, valid response confirms support.Β
**Block transformer:** Leave as base unless you are using clique.
[Find additional info variables relevant to indexer setup here](https://docs.blockscout.com/setup/env-variables/backend-env-variables#indexer-management)
### Rollup Config
If your chain is a rollup you will select this in the info screen and then fill out the associated Rollup config info.
* Read the [Rollup deployment and config details](https://docs.blockscout.com/setup/deployment/rollup-deployment#arbitrum)
* [Arbitrum](/setup/env-variables/backend-envs-chain-specific#arbitrum-management) ENV variables
* [Optimism](/setup/env-variables/backend-envs-chain-specific#optimism-rollup-management) ENV variables
* [Polygon zkEVM](https://docs.blockscout.com/setup/env-variables/backend-envs-chain-specific#polygon-zkevm-rollup-management) ENV variables
* [zkSync](https://docs.blockscout.com/setup/env-variables/backend-envs-chain-specific#zksync-rollup-management) ENV variables
## FAQ
There could be several reasons for this. Your RPC may not be an archive node and [tracing](/setup/requirements/node-tracing-json-rpc-requirements) may not be turned on for that node. Once you switch to an RPC with tracing enabled internal transactions will still not be indexed until you spin up a new instance. In this case you will need to shut down your instance and create a new one.
Yes, there is but it requires an API key to use. It can be useful if you are spinning up many instances or need to check on many instances at the same time. Contact us in Discord #autoscout channel to request an API key. See the API Swagger Docs for more info: [https://blockscout.github.io/swaggers/services/autoscout/main/index.html](https://blockscout.github.io/swaggers/services/autoscout/main/index.html)
These are the fields you need to fill out in Cloudflare:
* **Type:** CNAME
* **Name:** your-explorer-name (instance name)
* **Content:** autoscout.cname.blockscout.com
* **Proxy status:** DNS only
* **TTL:** Auto
Make sure to set your Custom domain in the Autoscout interface.
You will receive several automated emails when your Autoscout credits/funds are running out. They are sent according to the following schedule:
| **Days before running out of funds** | **Automated email** |
| :- | :- |
| 5 days | Initial email |
| 3 days | Reminder email |
| 1 day | Final reminder |
Updating is easy! Simply **restart** your instance and it is automatically updated to the latest version.
Check out our [Autoscout blog post](https://www.blog.blockscout.com/ship-faster-with-autoscout-deploy-a-block-explorer-with-status-logs-and-advanced-features/) for more info on reading logs and viewing status updates.
# Multisend
Source: https://docs.blockscout.com/using-blockscout/essential-dapps/multisend
Use the Blockscout Multisend Essential Dapp to batch-send ERC-20 tokens to many addresses from a CSV list for airdrops and payroll.
Multisend lets you send ERC20 tokens to multiple addresses at once rather than sending transactions one by one. With just a few clicks, you can create and send bulk transactions automatically, saving significant time and automating the process. Private keys and account information stay secure.
Multisend is useful when distributing tokens to many addresses, for example in an airdrop to a lot of recipients or payroll where you are sending many of the same ERC20 tokens to different addresses.
## Get Started
1. **Connect your wallet** to Blockscout (if needed)
![DAppscout blockchain explorer interface showing login button and essential dApps including token swap and multisend features]()
2. **Find the Multisend app** in the Essential Dapps Menu
![DAppscout tutorial showing how to access Multisend dApp: step 1 click DApps menu, step 2 select Multisend to send tokens to multiple addresses]()
3. Click on the token field and **select the token** you want to send.
![Multisend dApp tutorial step 1: select token address to send tokens to multiple wallet addresses via CSV upload]()
![Token search modal in Multisend dApp showing CV token selection on Optimism network for bulk token transfers]()
4. **Specify a list of addresses and amounts in CSV format** (for example `0x5c36bd76a6c138187c43da92f66f37e23b4017fa,12`) with 1 address and amount per line. You can upload a .csv file and the box will auto-populate. *Click the 'Show Sample CSV' button to see the formatted example.*
.eth names are not currently supported, please use full 0x addresses.
![Multisend dApp CSV upload field for entering multiple recipient wallet addresses to batch send CV tokens]()
![Multisend dApp with CSV recipient list populated showing wallet addresses and token amounts for batch CV token distribution]()
5. **Click Proceed** to go to the next step, Validation.
![Multisend dApp with recipient CSV populated and arrow pointing to Proceed button to validate batch token transfer]()
6. In the **Validation** step you will see the amount approved (0 at the moment), the total tokens to be sent, the total number of tokens in the wallet, and the total amount of ETH in the wallet. You will also see the list of recipients and allocations for each address.
![Multisend validation screen showing transaction summary: 15.4991 CV tokens to be sent to 4 recipients with wallet balances displayed]()
Scroll down to see the approval options. You can either approve the exact token amount for this multisend (recommended) or click unlimited approval. With unlimited you will not need to approve sending for future transactions *(this grants unlimited privileges to the app, which can be a security risk).*
Click **Approve** and confirm in your wallet.
![Multisend validation showing recipient list with arrow pointing to Approve button to authorize batch token transfer]()
7. Once you have approved the app to send tokens, you will see the approval transaction in the app. Click **Continue** to go to the third step where you will complete the transaction(s).
![Multisend validation complete with arrow pointing to Continue button after approving 15.4991 CV token batch transfer to 4 recipients]()
8. **View the total estimate**. You will see an overview along with the cost estimate. You can change the value of gas price with the gear icon, but this can cause issues and is not generally recommended. If everything looks good, click Proceed and sign the transaction(s) in your wallet. There may be multiple transactions to sign depending on the number of recipients.
![Multisend final step showing transaction summary: 15.4991 CV tokens to 4 recipients with gas cost 0.00134026 ETH and arrow pointing to Proceed button]()
That's it! If you'd like to learn more about Multisender, see the video walkthrough below which goes into more details on the standalone application.
### Multisender video walkthrough
# Revoke
Source: https://docs.blockscout.com/using-blockscout/essential-dapps/revoke
Use the Blockscout Revoke Essential Dapp to review and revoke ERC-20 and NFT token approvals across Ethereum, OP Mainnet, Gnosis, Base, and Ink.
Revoke is currently being updated for inclusion in Essential Dapps. It will be released shortly.
Many applications require you to grant approvals so that their contracts can interact with tokens in your wallet. This can be a security issue if you have granted unlimited or high allowances, or have granted approvals and forgotten about them. If an application is hacked or misused in some way, this can result in funds being quickly drained from your wallet.
The Revoke app lets you manage your approvals from a single interface. Easily check, update, and revoke token allowances you may have granted to different applications.
## Access the App
Revoke can be accessed directly via the Essential Dapps menu or as an app via the Dappscout interface in Blockscout on supported chains.
Revoke supports a subset of chains including Ethereum, OP Mainnet, Gnosis, Base and Ink.
![]()
## Check and Revoke
1. Select the chain you want to check.
2. Connect the wallet you want to revoke allowances for.
![]()
3. Review any allowances and click the Revoke button for those you want to revoke.
![]()
4. Confirm the transaction in your web3 wallet. This does not require any gas or transaction fees.
![]()
5. Your permissions will update momentarily.
![]()
![]()
## **FAQ**
This usually happens when the price information in USD is not available for a particular token. In these cases, the token amount is displayed without an associated USD conversion.
Not yet. We're still working on this functionality, and it will be added in future releases.
Yes, you can use any wallet that **WalletConnect** supports.
It's always a good practice to **limit token approvals** when you're not actively using a dapp, especially on **NFT marketplaces**. This reduces the risk of losing funds due to hacks or exploits and helps mitigate the damage caused by phishing scams.
Revoke is designed to provide valuable insights about your tokens and account. Instead of only allowing you to revoke token approvals, we offer a **comprehensive overview** of spender accounts. This way, you can make informed decisions and better understand **who has access** to your tokens.
## **Roadmap**
1. **Public Tags**
We plan to highlight key information about **approved spender contracts**, ensuring users are aware of **who has access** to their tokens. If an approved spender gets hacked or is flagged as a scam, this information will be added to Blockscout, allowing users to react promptly.
2. **Sorting**
To improve user experience, we're introducing sorting options for approvals. Users will be able to sort approvals by **amount, date, and value at risk**.
3. **Bulk Revoke for Multiple Tokens**
We're working on adding a **multi-token revoke feature** in upcoming releases to speed up the process.
# Swap
Source: https://docs.blockscout.com/using-blockscout/essential-dapps/swap
Swap and bridge tokens across 18 EVM chains directly inside Blockscout using the LI.FI-powered Essential Dapp and earn Merits for activity.
Simple swaps and cross-chain bridging transactions are now available via the dedicated Swap app, powered by [LI.FI](http://li.fi/). All swapping and bridging operations are handled by LI.FIβs smart contracts, and their widget provides a flexible and lightweight interface. Blockscout has integrated the LI.FI widget to create a convenient and user-friendly tool specifically for Blockscout users.
Find Swap now under Essential Dapps on your explorer instance. For example, on Ethereum it is located at [https://eth.blockscout.com/essential-dapps/swap](https://eth.blockscout.com/essential-dapps/swap).
![Blockscout Swap Pn]()
## Swap Features
* **Simple interface for swapping and bridging**. Swap is a convenient, easy-to-use tool for your token management and exchange needs. The clean, straightforward interface is designed for fast and intuitive token exchanges.
* **Flexibility with tokens, chains, and addresses**. Swap currently supports operations on 18 blockchains including **Ethereum, Arbitrum, Base, Polygon, Scroll, zkSync, Optimism, Gnosis, Fuse, Lisk, Unichain, Aurora, Immutable, Soneium, Rootstock, Celo, World Chain, and Ink.** \
\
Swap and bridge operations can be initiated by 1 address and sent to the same address or a different address if desired. If the address receiving a token does not have enough gas tokens to cover fees, a portion of the swap can be converted to automatically cover gas costs.
* **Low integrator fees**. Swap offers low fees (.4%). For example, a \$100 swap incurs a \$0.40 fee.
* **Aggregator fetches the best prices**: The application checks across 32 exchanges and 19 bridges to find the best swap and bridge prices, along with options for different routes if you want faster bridging or prefer to use a specific app or bridge.
* **Li.Fi for consistency and security:** Swap uses Li.Fi under the hood to provide swap and bridging functionality. This audited codebase is used throughout the ecosystem and trusted by many projects to provide safe and secure transfers.
* Earn Merits when using Swap. [See this page](/using-blockscout/merits/earn-merits-when-using-swap) to learn more about earning Merits for using your favorite swap and bridge application.
## Swap Operations
### Connect a wallet
Connect your wallet to Blockscout to access Swap functions.
1. Click connect wallet
2. Choose your preferred wallet and connect
### Swap tokens on the same chain
Swap checks up to 32 exchanges and aggregators to find the best routes.
### Swap and bridge tokens from 1 chain to another
Depending on the token and chain there may be several routes. Check routes for pricing and timing that best suits your needs.
### Swap, bridge and send tokens to another wallet
Swap and bridge from one chain to another. To send to a different wallet, click the wallet icon and enter the wallet address where you are sending funds.
![]()
# CSV Exports
Source: https://docs.blockscout.com/using-blockscout/export-to-csv
Download address-level transactions, internal transactions, token transfers, and logs from a Blockscout explorer as CSV files for analysis.
Export to CSV gives users a way to easily download and analyze blockchain data. It is available for tabs on the address page including transactions, internal transactions, tokens, and logs.
Note: simplified CSV exports (transactions and transfers only, with no ability to define time periods) exist in Blockscout releases up to 3.5.1. Enhanced CSV export is available from v3.5.2+
![]()
You will find the *Download CSV* button under the list of entities related to the tab.
![]()
*Note:* under the *Tokens* tab, the list of token transfers will be exported.
After clicking the button you will be forwarded to a */csv-export* page for a given address and given type of export (transactions, internal-transactions, token-transfers, logs).
![]()
It is possible to specify an arbitrary period for the data export. By default, the current period is the previous month. After completing the reCaptcha, the data for the chosen period should be exported.
![]()
*Tip*: In order to prevent hitting a 30 secs loading timeout, choose the smallest time period possible for your data needs.
# Merits
Source: https://docs.blockscout.com/using-blockscout/merits
Blockscout Merits are cross-chain digital rewards earned by using the block explorer. Sign up, connect a wallet, and start collecting Merits.
## What are Merits?
To learn details about the program please see our dedicated [Merits announcement blog post](https://blog.blockscout.com/blockscout-merits-rewarding-block-explorer-skills).
* Merits are digital rewards that are collected by interacting with Blockscout and participating in various relevant activities.
* Merits do not exist on any single blockchain, but rather are connected to an Externally Owned Account (`0x` address) via the Blockscout dashboard and your web3 wallet.
* Merits can be earned on any chain where the program is supported, and Merits accumulate to an account across blockchains and rollups.
* Merits are designed to make block exploration more fun and engaging, rewarding learning and regular usage.
* Merits do not have any material value, but in the future may unlock access to new features, merchandise, discounts, and other exclusive opportunities and benefits.
* You must login to Merits on Blockscout to see your balance and claim additional Merits.
* You can view more information about your Merits, the leaderboard and badges in the dedicated Merits hub at [https://merits.blockscout.com/](https://merits.blockscout.com/)
The following information relates to using the Blockscout Merits interface. See our [FAQs](/using-blockscout/merits/faqs) for common questions.
Merits are available on a limited number of Blockscout instances to start:
* [Ethereum Mainnet](https://eth.blockscout.com/)
* [Ethereum Sepolia](https://eth-sepolia.blockscout.com/)
* [Ethereum Holesky](https://eth-holesky.blockscout.com/)
More chains will be added as the program rolls out.
## Sign up for Merits
Sign up to start collecting Merits and participating in the program. You will receive 100 Merits for signing up or 200 Merits if you use a referral link/code. There are several ways to sign up:
* New account referral signup
* New account signup (no referral)
* Existing account signup
### New account referral signup
We recommend using a referral code to sign up as you will receive an additional 100 Merits for a total of 200 Merits. Ask a friend or Blockscout community member (telegram, discord) if you need a code or link.
#### **1) Enter the link you received**
The link will be the instance name followed by `/?ref=XXXXXX` for example [https://eth.blockscout.com/?ref=9V4NUJ](https://eth.blockscout.com/?ref=9V4NUJ)
*Note: if you only have a code and not a link you will enter the code during step 5 of the sign in flow.*
If starting with a referral link you will be forwarded to this page.
![]()
If using a six digit referral code, you will go to the Blockscout instance and click on the Merits button to get started.
![]()
![]()
#### **2) Connect your wallet (EOA)**
Note that this wallet can be used to collect Merits across chains.
![]()
![]()
![]()
#### 3) **Login to account**
Once you have granted permission to connect your wallet, you can login to your account. When confirming in your web3 wallet be sure to check that the site info and wallet info are correct *(in this example we are using a testnet, so the information will be different depending on the instance you are accessing).*
![]()
![]()
#### 4) **Add email (optional)**
Add your email to enable account watchlist functionality and receive Merit updates.
![]()
![]()
![]()
![]()
#### 5) Join the Merits program
Your code should pre-populate. Click Get started and confirm sign-in via your web3 wallet.
![]()
![]()
#### 6) Congratulations!
You are now enrolled in the Merits program. You can share your referral link on X, or click Open to view the Merits dashboard.
![]()
### New account signup (no referral)
We recommend using a referral code to receive additional Merits, however you can sign up without one if desired. The flow is the same as the referral sign up with a code. The only difference is you do not toggle the I have a referral code button (step 5 above) to proceed.
![]()
### Existing Account Signup
If you already have a Blockscout account, you can still use a referral code to sign up for the Merits program. Login to your Blockscout account and paste in the referral link or press the Merits button to start. Follow the process above starting with step 5.
![]()
## Navigate the Merits dashboard
![]()
1. **Merits balance and claim**: Displays your current balance and claim eligibility. You can claim 10 Merits 1 time per day. This amount resets the following day. The claim button will also send any available referral Merits to your account. Referral Merits are added when someone you refer completes an activity. Referrals are not available for signing up or daily claims.
2. **Referral data**: Shows how many individuals you have referred to the Merits program.
3. **Streak data *\***: Shows how many days in a row you have claimed your daily Merits.
4. **Referral code and link**: Your referral link and code. Share this code with friends and they will receive additional Merits on signup. You will receive a 10% bonus for rewards earned by your referrals for Blockscout activity. More about referrals is in the [FAQ](/using-blockscout/merits/faqs).
5. **Activity tracking *\***: Tracks your activities and earned Merits for these activities.
6. **Contract verification tracking *\***: Tracks your contract verification activity and related Merits rewards.
7. **Badges *\***: Collection of the Blockscout badges you have earned for completing various Blockscout-based campaigns. For more information, see the [Blockscout Badges site](https://badges.blockscout.com/home).
# Activity Pass
Source: https://docs.blockscout.com/using-blockscout/merits/activity-pass
The Blockscout Activity Pass unlocks extra Merits for contract verification, dapp usage, and everyday explorer activity, with weekly ranks.
Read more about the Activity Pass in this [blog post.](https://www.blog.blockscout.com/earn-rewards-for-block-explorer-routine-activity-pass/)
The Activity Pass opens up new opportunities for Blockscout power users! Activity Pass holders can:
* Earn Merits through various activities such as contract verification, contract interaction, using Blockscout apps like [Revoke](/using-blockscout/essential-dapps/revoke) and [Swap](/using-blockscout/essential-dapps/swap), and just using Blockscout for exploring the chain.
* Compete against other Activity Pass holders for Performance Rank status and benefits
* Access exclusive offers available only to Activity Pass holders.
![Activity Pass Pn]()
### How it works
Get an Activity Pass, then regular Blockscout usage earns you extra Merits.
1. Activity passes become available periodically on the [Merits hub](https://merits.blockscout.com/). They are available in the **Spend Merits** tab.
2. Purchase a pass using your Merits.
3. Login to Blockscout with your Merits wallet.
4. Complete various actions on Blockscout. Your Merits will increase weekly based on your activity and other users' activity.
Bonus: Activity Pass holders can mint an exclusive NFT on the [Blockscout Badges site](https://app.gitbook.com/s/-MjSwkv4zokqCUebt-98/).
### Activity Pass Actions
The following actions will earn you additional Merits when you have an Activity Pass. You need to be **logged into Blockscout with your Merits address** and **hold an Activity Pass on that address** to qualify.
1. Regular Blockscout usage. Checking addresses, balances, tokens, etc. All the things you normally do on Blockscout earn you more Merits.
2. Using Blockscout-related apps like [Swap](/using-blockscout/essential-dapps/swap) and [Revoke](/using-blockscout/essential-dapps/revoke).
3. Verifying contracts through the Blockscout UI. [This guide](https://www.blog.blockscout.com/how-to-verify-your-smart-contract-with-the-blockscout-ui/) shows a simple example using hardhat.
4. Interacting with contracts on the Blockscout UI. [Use Read and Write methods directly from Blockscout](https://docs.blockscout.com/devs/verification/interacting-with-smart-contracts) to interact with contracts.
### Amount of Merits Earned
Merit earnings for Activity Pass holders are based on your effort vs other Pass holders! The higher you rank in the activity, the more Merits you receive. Here is the breakdown of **Merits earned per week** for various activities.
* **Blockscout Usage**: Regular usage when logged into Blockscout
* **Contract Verification**: Verifying contracts with the Blockscout UI
* **Interactions**: Swapscout, Revokescout, and Contract Read/Write
| | Blockscout Usage | Contract Verification | Interactions |
| - | - | - | - |
| 90%+ | 200 | 400 | 300 |
| 75%-90% | 160 | 320 | 240 |
| 50%-75% | 120 | 240 | 180 |
| 25%-50% | 80 | 160 | 120 |
| 5%-25% | 40 | 80 | 60 |
| \<5% | 10 | 20 | 15 |
### FAQs
An Activity Pass is an add-on that allows you to earn additional Merits when using Blockscout.
Activity Passes are available in limited batches via the Merits website. Check back regularly and follow [Blockscout on X ](https://x.com/blockscout) to be informed of new Activity Pass drops.
You can find the full list of Blockscout Explorers eligible for earning Merits by clicking the βEarnβ button on an activity card. At the beginning of the program the following instances are supported:
1. Ethereum Sepolia
2. Ethereum mainnet
3. Gnosis Chiado
4. Gnosis mainnet
5. Ink mainnet
6. Soneium mainnet
Click the βEarnβ button to see the list of Blockscout Explorers where you can earn Merits just by using them. You can also check our documentation for details on specific activities that grant Merits.
Activity Pass Merits are automatically distributed to your account on a **weekly basis.**
Every Monday, all earned Merits are automatically distributed. At the start of each new week, Performance Ranks and previously earned Merits are reset. New week, new achievements!
Performance Rank is your position among all users with Activity Passes who are earning Merits. A higher rank means you are among the top users who have earned the most Merits. The higher your Performance Rank, the more Merits you receive.
Different Performance Ranks result in different amounts of Merits received on a weekly basis. Completing different activities will also earn you different Merit amounts.
***Note: The Merits distribution per Performance Rank may change based on program participation, please stay tuned!***
# Badges
Source: https://docs.blockscout.com/using-blockscout/merits/badges
Earn and mint Blockscout Scout Badge NFTs on Base by joining Blockscout campaigns, with Common to Legendary rarity tiers for participants.
![]()
Access the Blockscout badges site at [https://badges.blockscout.com](https://badges.blockscout.com/home)
### What are Blockscout Badges?
Blockscout Badges are digital rewards (NFTs) that you can earn by participating in Blockscout community activities and campaigns.
### What makes each badge special?
Each badge collection has four rarity levels:
* Common
* Rare
* Super Rare
* Legendary
When you mint a badge, you'll randomly receive one of these rarity levels β like opening a mystery box!
### How do I get a badge?
1. Connect your crypto wallet to the Base network
2. Choose the badge collection you want
3. Click 'Mint' if you're eligible
4. Important: Use the same wallet address you used during the campaign, as this proves your eligibility
After minting, you can see your badge by looking up your wallet address on the [Base Blockscout Explorer.](https://base.blockscout.com/)
### Why can't I get a badge?
Each badge is only available to people who participated in specific campaigns during certain time periods. Don't worry though β Blockscout regularly launches new campaigns! Follow our social media to catch the next one.
### Can I trade or sell my badges?
Yes! You can move your badges to different wallets or sell them on NFT marketplaces.
### How many badges can I get?
You can get one badge per campaign you participate in. Collections typically have a limited number of badges available.
### What can I do with my badge?
Right now, your badge shows that you participated in a Blockscout activity. In the future, badges might give you special access to:
* Events
* Exclusive merchandise
* Other special benefits
### Having problems?
Join the [Blockscout badges Discord channel](https://discord.gg/blockscout) for help with any issues.
# Earn Merits when using Swap
Source: https://docs.blockscout.com/using-blockscout/merits/earn-merits-when-using-swap
Earn daily Blockscout Merits by swapping and bridging tokens with Swapscout, distributed automatically based on your fees and daily volume.
### Swap & Merits
Swap allows you to swap assets and bridge assets with a convenient, intuitive interface. In addition, users who are signed up to the [Blockscout Merits program](/using-blockscout/merits) will receive Merits for using Swap. Merits are distributed based on several factors:
1. The total 24-hour volume of Swap transfers.
2. The fees generated based on this volume.
3. The total number of unique Swap users within a 24 hour period.
At the end of each 24 hour period (00:00 UTC to 23:59 UTC each day) the number of transactions and fees generated by each unique address are calculated and Merits are distributed automatically.
### Allocation
A set amount of Merits are marked for distribution each day amongst all qualified users. An address receives a percentage of this amount based on the fees their address generates during that period for swaps and bridge transactions. The more fees an address generates, the higher percentage of Merits they receive from the overall allocation.
### Min/Max
* **Minimum**: The minimum amount of Merits distributed to any address that interacts with Swapscout during a 24 hour period is 1% of the total Merits allocation for the day.
* **Maximum**: The maximum amount of Merits distributed to any one address interacting with Swapscout during a 24 hour period is 10% of the total Merits allocation for the day.
### Distribution
Merits are automatically distributed to each account at the end of each day. You can view your current Merits balance by [logging into Merits](/using-blockscout/merits) on a Blockscout instance where the program is active.
# Merits FAQs
Source: https://docs.blockscout.com/using-blockscout/merits/faqs
Frequently asked questions about Blockscout Merits and Scout Badges, including daily claims, referral rewards, streaks, and supported chains.
We will continue adding frequently asked questions to this list. If you have an issue that needs immediate attention, please ask on the [Blockscout Discord](https://discord.gg/blockscout).
### Merits
The blog announcement includes information about the origins of the program, how you can earn Merits, and future directions. [Merits announcement blog post](https://blog.blockscout.com/blockscout-merits-rewarding-block-explorer-skills).
Merits will be rolled out to many Blockscout supported chains in the future. Right now they are available on:
* [Ethereum Mainnet](https://eth.blockscout.com/)
* [Ethereum Sepolia](https://eth-sepolia.blockscout.com/)
* [Ethereum Holesky](https://eth-holesky.blockscout.com/)
Your Merits account is chain agnostic - you can claim Merits and collect referral bonuses on any supported chain.
The daily claim is worth 10 Merits. You can claim one time per day, and the amount resets to 10 Merits at 0:00 UTC each day. To claim, login to the Dashboard and click the claim button.
In your Merits dashboard you will find a referral code and a referral link you can share with your friends. They can follow the link directly or enter the code when signing up to the program for the first time.
You do not receive referral rewards when someone first signs up using your referral code or claims their daily bonus.
However, you will receive rewards (10% of the Merits they earn) for block explorer usage or activities/campaigns they complete. These rewards will accumulate to your account, and you can claim to your account with the claim button in the dashboard.
Activities which earn referral rewards are still in development, and will be listed once they become available.
Learn more in the [Merits announcement blog post](https://blog.blockscout.com/blockscout-merits-rewarding-block-explorer-skills).
Merits are collectible rewards displayed in your Blockscout dashboard. They show your Blockscout adoption, usage, and mastery and promote learning in a gamified way. Right now you don't use them other than to show off your block explorer skills. In the future Merits may unlock access to new features, merchandise, discounts, and other exclusive opportunities and benefits.
Yes you can! Swap users who are signed up to the Merits program receive Merits based on their own usage, total usage (how many users use [Swap](https://swap.blockscout.com/)) and fees. These Merits are automatically distributed to the account each day at 0:00 UTC. See the [Earn Merits when using Swap](/using-blockscout/merits/earn-merits-when-using-swap) page for more information on this distribution.
Streaks are achieved by claiming Merits on consecutive days within a 24 hour span. You can earn additional Merits for longer streaks. Check the [streak rewards](/using-blockscout/merits/streak-rewards) page for more details.
### Badges
Blockscout Badges is a new initiative by the Blockscout Team, designed to celebrate and recognize our community members for their involvement in key campaigns and contributions.
Most Blockscout Badge collections feature four distinct rarity levels, giving users an exciting opportunity to mint a legendary NFT. The rarity tiers include Common, Rare, Super Rare, and Legendary, with each mint offering a randomized chance at unlocking the most coveted level.
Minting a Blockscout NFT is quick and simple. Just connect your preferred wallet and switch to the Base network. Select the NFT collection, and if you are eligible to mint you will be able to click on the βMintβ button. Use the same wallet address you used in the relevant campaign, as your eligibility is tied to that specific address. Once minted, you can view and verify your new Blockscout NFT on the Blockscout Explorer by searching your wallet address and exploring the tokens stored in your wallet.
Participants for each NFT were gathered during the designated campaign period. But donβt worryβBlockscout will be launching more NFTs in future campaigns! Be sure to follow our social channels to stay updated on the next exciting opportunity.
Yes! All Blockscout Badges are transferable, allowing you to move them to new wallets or sell them on secondary markets.
Most collections are limited, with a maximum of one NFT per participant per campaign.
For now your badge is an NFT that proves you completed a certain Blockscout related activity. Show it off with pride! There may be future applications for Blockscout badges like access to events, badge-limited swag or other goodies. Stay tuned for more details.
Please [join our badges discord channel](https://discord.com/invite/blockscout) and we will help troubleshoot your issues or questions.
If you donated to previous Gitcoin rounds for Blockscout in 2023 and 2024 you are eligible for the Gitty Up badge. This includes the following rounds:
* Ethereum Infrastructure: 25 Apr 2023 to 09 May 2023
* Ethereum Infrastructure: 15 Aug 2023 to 29 Aug 2023
* Ethereum Core Infrastructure, Research and Development: 15 Nov 2023 to 29 Nov 2023
* Developer Tooling and Libraries: 23 Apr 2024 to 07 May 2024
* GG21: 7 August to 22 August 2024
* Octant Community Round: 12 September to 27 September 2024
You can check the list of all eligible addresses. [Join our badges discord channel here](https://discord.com/invite/blockscout).
# Leaderboard
Source: https://docs.blockscout.com/using-blockscout/merits/leaderboard
The Blockscout Merits leaderboard on the Merits hub ranks accounts by earned Merits each season, with address search and shared rankings.
The Merits leaderboard is a part of the standalone Merits hub website available at [https://merits.blockscout.com/](https://merits.blockscout.com/)
The Merits leaderboard displays accounts ordered by the number of Merits each account has earned.
![]()
* The leaderboard reflects the current season of earnings, and resets when a new season launches.
* Search is only available by the full address, but is not case sensitive.
* Ranking is determined by the number of Merits earned. If addresses share the same number of Merits, they all share the same rank. In this example, all accounts have 352 Merits, and are all ranked 12.
![]()
# Streak Rewards
Source: https://docs.blockscout.com/using-blockscout/merits/streak-rewards
Claim Blockscout Merits every day to build a streak and earn bonus rewards every 7 consecutive days, with up to 30 Merits on streak days.
Available at [https://merits.blockscout.com/](https://merits.blockscout.com/) and on the Blockscout Merits dashboard.
![]()
Earn additional Merits by visiting and claiming once per day. A day starts at 00:00 UTC and ends at 23:59 UTC.
To maintain a streak, you must make a claim each calendar day. The timing on the claim doesn't matter, it can occur any time between 00:00 UTC and 23:59 UTC.
* Merits must be claimed once per day to maintain a streak. Every day you make a Merits claim, your streak increases by 1.
* If you fail to make a claim on a calendar day, your streak resets to 0.
* Every 7 days of a streak results in an increased Merit reward. This is a single day award which is claimed each 7th day of your streak (7,14,21,28 etc).
* Currently, the highest reward is 20 Merits, for a total of 30 Merits (10 daily claim Merits + 20 streak reward Merits) available to claim on streak reward days.
*See the table below for more details on streak rewards.*
### Streak rewards for daily claims
| Streak | Daily Claim | Reward | Total Merits Claim |
| - | - | - | - |
| 1-6 | 10 | 0 | 10 |
| 7 | 10 | 10 | 20 |
| 8-13 | 10 | 0 | 10 |
| 14 | 10 | 20 | 30 |
| 15-20 | 10 | 0 | 10 |
| 21 | 10 | 20 | 30 |
| 22-27 | 10 | 0 | 10 |
| 28 | 10 | 20 | 30 |
# My Account
Source: https://docs.blockscout.com/using-blockscout/my-account
Sign in to Blockscout My Account to add watchlists, private tags, custom ABIs, verified addresses, and receive email notifications on activity.
The My Account feature provides the ability to watch addresses (and receive email notifications regarding activity), create private tags, add API keys to an account and more.
It does not contain any private key info or allow you to withdraw funds. It is designed as an organization and personalization tool for the block explorer, giving you additional ways to customize the data you want to receive.
You can sign up for an account using either an email or your Github credentials.
The following options are currently available:
* **Watch list:** Watch specific addresses and receive email notifications for transactions.
* **Private Tags**: Private tags for addresses & transactions
* **Public Tags**: Request a public category tag displayed to all Blockscout users. Requests are processed manually.
* **Custom ABI**: Useful for testing & debugging, can be used with verified or unverified contracts.
* **Verified Addresses**: Verifying ownership of a smart contract address allows you to easily update information in Blockscout
* **Sign Out**: Sign out, info kept in local storage for easy sign-in.
Additional future features include an upcoming redesign and multi-chain rollout.
## Get Started
*The following example is created using the [Optimism Blockscout instance](https://optimism.blockscout.com/).*
#### 1) Click the MyAccount Icon
![]()
![]()
#### 2) Sign in / Create an Account
a. Sign in with your existing email and password
b. Create a new blockscout account with an email/password
c. Sign in with an existing github account
![]()
#### 2a) Email and Password
Enter a valid email and password to setup an account. You will receive a validation notice to your email, be sure to check spam filters as it will come from [*noreply@blockscout.com*](mailto:noreply@blockscout.com).
![]()
![]()
![]()
#### 2b) Github
![]()
#### 3) View Options
Once logged in, you can view options in the My Account Dropdown or on the activated toolbar.
![]()
# API keys
Source: https://docs.blockscout.com/using-blockscout/my-account/api-keys
Blockscout API keys have moved out of My Account. Get a universal Blockscout Pro API key at dev.blockscout.com for your explorer requests.
API Keys are no longer located in the MyAccount section of an individual explorer. You can get a universal API key at [https://dev.blockscout.com/](https://dev.blockscout.com/).
# Custom ABI
Source: https://docs.blockscout.com/using-blockscout/my-account/custom-abi
Add a Custom ABI in Blockscout My Account to debug, test, and use the Write Custom feature on both verified and unverified smart contracts.
The Custom ABI feature is useful for debugging and testing newly deployed smart contracts. This feature can be used with verified or unverified contracts.
Once a custom ABI is added, the user can test methods using the `Write Custom` feature.
## Add Custom ABI
**1) [Login to My Account](/using-blockscout/my-account)** in Blockscout to get started. Once logged in:
1. Go to **Custom ABI** in the My Account menu.
2. Press the **Add Custom ABI** button.
![]()
**2)** **Fill in the fields**.
1. **Smart Contract Address**. Enter the correct `0x` address of the deployed contract.
2. **Project Name**. Create a name for your own reference.
3. **Custom ABI**: Copy and paste in the ABI for the contract from your development environment (truffle, hardhat, remix etc) or if the contract is verified you can copy from Blockscout.
4. Press **Create custom ABI**.
![]()
**3) Custom ABI added** to the home screen. You can edit or remove current custom ABIs or add additional custom ABIs from here.
![]()
## Interact with a Custom ABI
You will need to be logged into My Account to interact with your custom ABIs. Once you've added it, you can visit the contract to interact with the custom ABI.
1. Go to the contract page.
2. You will see a Write custom button.
3. Connect your wallet to interact with the contract.
4. Write to the available methods.
![]()
# My Account setup for chain operators
Source: https://docs.blockscout.com/using-blockscout/my-account/for-developers
Developer notes for enabling the My Account feature on a self-hosted Blockscout instance, including env variables and Airtable integration.
Please see [My Account settings in configurations](/setup/configuration-options/my-account-settings) for notes about setting up the proper variables and linking to your airtable.
# Private tags
Source: https://docs.blockscout.com/using-blockscout/my-account/private-tags
Create private address and transaction tags in Blockscout My Account to label wallets, contracts, and transactions for your view only.
Private tags help customize your Blockscout instance to track addresses and transactions that are important to you. You can track specific addresses, either EOAs (Externally Owned Addresses) or smart contracts, as well as group and organize specific transactions.
Use the private tags feature to add your own **address tags** and **transaction tags**. These will be viewable on your instance of Blockscout only.
When logged in, a small grey tag is added with the selected name to any specified addresses or transactions. You can also add emojis π for easy identification.
Use cases might include tags for specific wallet accounts (EOAs) of interest, Gnosis safe multisig wallets to highlight, tags for specific applications, tags for specific transaction types, tokens, NFTs etc.
*The following example is created using the [Optimism Blockscout instance](https://optimism.blockscout.com/).*
To start with private tags, you must first [login to My Account](/using-blockscout/my-account).
### 1) Create a Private Address Tag
1. Go to Private Tags in the My Account user menu. Address tag will be the default option.
2. Press the **Add address tag** button.
![]()
**2)** **Fill in the fields**.
1. Address. Double check you are entering the correct address for the chain. Search the address in Blockscout to confirm.
2. Name. Create a name for the tag (35 characters or less). Emojis are a nice way to differentiate and add style and color to tags.
3. Press **Add tag**.
![]()
**3) Address tag added** to the Address Tags home screen. You can add additional tags or remove old tags from here.
![]()
**4) View tags in Blockscout**. They will appear in grey next to additional tags that may exist for that address.
Note, you must be logged in to My Account to see your private tags.
![]()
## 2) Create a Private Transaction Tag
* Go to **Private Tags** in the My Account user menu. Select the **Transaction** tab.
* Press the **Add transaction tag** button.
![]()
**2)** **Fill in the fields**.
1. Transaction hash. Double check you are entering the correct tx for the chain. Search the transaction and copy/paste from Blockscout to easily add.
2. Name. Create a name for the tag (35 characters or less). Emojis are a nice way to differentiate and add style and color to tags.
3. Press **Add tag**.
![]()
**3) Transaction tag added** to the transaction tags home screen. You can add additional tags or remove old tags from here.
![]()
**4) View tags in Blockscout**. They will appear in grey next to additional tags that may exist for that address.
Note, you must be logged in to My Account to see your private tags.
![]()
# Public Tags: Request and Report Address Labels
Source: https://docs.blockscout.com/using-blockscout/my-account/public-tags
Request public tags for your project's contracts or report incorrect labels on Blockscout, improving address discoverability and search visibility.
Request a public tag for your project's contracts on the public Blockscout instance. Tags appear in search, help create brand awareness for projects, and make exploration easier.
Once submitted, tags are reviewed and accepted/denied manually by the instance admin. If accepted, the tag is added to the public instance. It is also possible to report incorrect public tags through the public tags section.
*The following example is created using the [Optimism Blockscout instance](https://optimism.blockscout.com/).*
## Request Public Tags
**1) Login to** [**My Account**](/using-blockscout/my-account)
1. Go to **Public tags** in the My Account Menu
2. Press **Request to add public tag**.
![]()
**2)** **Fill in the fields**. Fields with \* are required.
* Your name\*
* E-mail\*
* Company name
* Company website
* Select either:
1. I want to add tags for my project
2. I want to report an incorrect public tag
* Public tags\*: 2 tags max, 35 character max per tag, use the ; as a separator
* Smart contract / Address (0x...)\*: Provide the 0x address of the contract. If you have several, press the "+" to add.
* Reason and Description\*: Add any relevant details and include your color preference for the tags. Include any other helpful or clarifying information here.
![]()
**3) Public tag request added** to the Public tags home screen. You can edit, request additional tags or delete old tags from here. Public tags are reviewed manually and can take some time in the queue. If your tag request appears in the dashboard it has been successfully submitted and will be reviewed in the order in which it was received.
![]()
## View public tags on an address
Approved public tags appear on the address page itself, next to the address name or contract name in the header (see [Address Page](/using-blockscout/overviews/address-page)). If the header shows no tag badge, the address does not have an approved public tag on that instance.
Because a public tag is attached to an address (not to the verified contract name), the two can differ. For example, a verified contract named `DexRouter` may render as `OKX Labs: DexRouter` on transaction and address pages when the underlying address carries an `OKX Labs: DexRouter` public tag. The contract name is unchanged; the tag adds project attribution.
## Query public tags via API
Public tags are exposed in several PRO API responses. Two common patterns:
* **On address and contract responses.** The address details endpoint and the verified smart contracts list both include a `public_tags` array on each address object, with `label`, `display_name`, and `address_hash`. Use these to read the tags already attached to a given address without a separate call. Filtering the verified contracts list *by* public tag is not supported; only the `filter` (language, proxy state) and `q` (search) parameters are available on that endpoint.
* **Via the Metadata service.** `GET /services/metadata/api/v1/public-tag-types` returns the tag types configured on the instance. `GET /services/metadata/api/v1/tags:search` searches tags by `chain_id`, `tag_types` (comma-separated), and `name`, and returns the addresses each tag is attached to. Use the tag-types endpoint first to discover valid `tag_types` values, then search.
See the [PRO API overview](/devs/pro-api) for authentication and base URL details.
# Verified Addresses: Prove Smart Contract Ownership
Source: https://docs.blockscout.com/using-blockscout/my-account/verified-addresses
Verify ownership of a deployed smart contract on Blockscout by signing a message, then manage token info, name tags, and address labels from your account.
Verify ownership of a smart contract address to easily update information in Blockscout. To verify your ownership, a contract must be deployed on the chain and [verified](/devs/verification).
You will sign a single message to verify contract ownership. Once verified, you can update token information, address name tags, and address labels from the Blockscout console.
1\) **Login to My Account in Blockscout** \<[*login instructions*](/using-blockscout/my-account)>.
1. Go to the **Verified addrs** menu item.
2. Click **Add address**.
![]()
More info coming soon
# Copy and Sign Message for Address Verification
Source: https://docs.blockscout.com/using-blockscout/my-account/verified-addresses/copy-and-sign-message
Steps for copying and signing the ownership message required to verify a smart contract address on Blockscout using your deployer wallet.
Instructions coming soon
# Watchlist: Email Alerts for Address Activity
Source: https://docs.blockscout.com/using-blockscout/my-account/watchlist
Add EOAs or contracts to your Blockscout watchlist and receive email notifications for native coin, ERC-20, ERC-721, and ERC-1155 token transfers.
*The following example is created using the [Optimism Blockscout instance](https://optimism.blockscout.com/).*
Sign up for email notifications for different actions related to an EOA or contract address. This can include incoming/outgoing transactions for native tokens, ERC-20 tokens or NFTs like ERC-721 and ERC-1155s.
1\) **Log in to My Account in Blockscout** \<[*login instructions*](/using-blockscout/my-account)>. From the Watchlist menu click Add address.
![]()
2\) **Fill in information** including:
* **Address**: 0x address of the EOA or contract to watch.
* **Private tag**: For your reference, will be displayed as a private tag for your Blockscout instance when you are logged in (emojis accepted π)
* **Notification types**: Select which types of transactions you would like to receive email notifications for. These include native tokens (in this case ETH), ERC-20 tokens, and NFT tokens.
* **Email Notifications**: Select to receive.
* **Add address**: Click button to add to your watchlist.
![]()
3\) A new address along with an info overview will be added to your watchlist dashboard. You can edit info, remove, or add more items.
![]()
4\) Click the address to view in the Blockscout console. Watch list addresses show the private tag when logged into My Account.
![]()
5\) If selected, you will receive emails based on actions completed by this address.
![]()
# Blockscout UI Sections and Page Overviews
Source: https://docs.blockscout.com/using-blockscout/overviews
Navigate Blockscout UI sections including the top menu, blocks, addresses, transactions, and token pages to explore EVM blockchain data effectively.
Blockscout is a full-featured explorer with many uses. A block explorer provides views and insights into various data stored on chain. Depending on the page, section and instance, different types of data are displayed. See below for different views and learn how to navigate blockchain data.
Blockscout offers different informational displays depending on the page, section and instance you are viewing. Learn more about different views and data displays in Blockscout:
* [Top Menu](/using-blockscout/overviews/top-menu)
* [Blocks](/using-blockscout/overviews/blocks)
* [My Account](/using-blockscout/my-account)
# Address Page: EOA Fields, Tabs, and Metrics
Source: https://docs.blockscout.com/using-blockscout/overviews/address-page
Explore the Blockscout address page for EOAs: balance, tokens, transactions, ENS names, tags, watchlist, multichain data, and activity analytics.
# Exploring EOA Addresses on Blockscout
Blockscout provides comprehensive information about Externally Owned Accounts (EOA) on Ethereum and other EVM-compatible blockchains. This guide breaks down the sections of a Blockscout address page using Vitalik Buterin's address (0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045) as an example.
## What is an EOA Address?
An Externally Owned Account (EOA) is a wallet address controlled by a private key, as opposed to a smart contract address. EOAs can initiate transactions, hold ETH and tokens, and interact with smart contracts.
![Address Page Jp]()
## Section A: Address Header & Identification
### Address Information
| Field | Description | Example | Purpose |
| :- | :- | :- | :- |
| **ENS Name (when applicable)** | Ethereum Name Service domain | vitalik.eth | Human-readable address identifier |
| **Address Hash** | 42-character hexadecimal identifier | 0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045 | Unique blockchain address |
| **Copy Button** | Click to copy address | π | Quick clipboard access |
| **QR Code** | Visual representation of address | QR icon | Easy mobile wallet scanning |
| **Star Button** | Add to favorites/watchlist | β | Personal tracking |
| **Public Name Tag** | Community-assigned label | "Vitalik Buterin" | Identity verification |
| **Additional Tags** | Category labels | "EOA", "Gitcoin Grantee" | Classification information |
### Action Buttons
| Button | Description | Function | Use Case |
| :- | :- | :- | :- |
| **40+** | ENS names owned by the address | Open to show other ENS properties | ENS usage |
| **5** | Verify in other environments | Explore address on other explorers | Address credibility & transparency |
| **Tag Menu (β―)** | Add tags | Add public & private tags | Tagging |
## Section B: Navigation Tabs
### Tab Overview
| Tab | Description | Content Type | Purpose |
| :- | :- | :- | :- |
| **Details** | Basic address information | Balance, tokens, statistics | Primary account overview |
| **Transactions 50+** | All blockchain transactions | Incoming/outgoing transfers | Transaction history |
| **Token transfers 50+** | ERC-20/ERC-721 movements | Token-specific activity | Asset tracking |
| **Tokens 50+** | Token holdings | Current token balances | Portfolio overview |
| **Internal txns 50+** | Contract-generated transactions | Smart contract interactions | Advanced activity |
| **Coin balance history** | ETH balance over time | Historical balance data | Balance tracking |
## Section C: Address Details
### Basic Information
| Field | Description | Value Example | Significance |
| :- | :- | :- | :- |
| **Balance** | Current ETH holdings | 4.77725266 ETH (\$16,037.91) | Available funds |
| **Tokens** | Number of different tokens held | >153 (>\$9,680,718.59) | Portfolio diversity |
| **Net worth** | Total portfolio value | >\$9,696,756.50 | Overall wealth |
| **Transactions** | Total transaction count | 73,149 | Activity level |
| **Transfers** | Token transfer count | 282,412 | Token activity |
| **Gas used** | Total gas consumed | 789,854,535 | Network usage |
| **Last balance update** | Most recent activity | Block 22933842 | Freshness indicator |
### Token Holdings Details
| Element | Description | Format | Purpose |
| :- | :- | :- | :- |
| **Token Count** | Number of unique tokens | ">153" | Portfolio size |
| **Total Value** | USD value of all tokens | ">\$9,680,718.59" | Portfolio worth |
| **Dropdown Arrow** | Expand token list | βΌ | View individual tokens |
| **Multichain Badge** | Cross-chain presence | "Multichain" with icons | Multi-network activity |
## Section D: Advanced Features
### Special Indicators
| Feature | Description | Appearance | Meaning |
| :- | :- | :- | :- |
| **ENS Integration** | Domain name display | "vitalik.eth" | Verified identity |
| **Verified Status** | Authentication markers | Checkmarks/badges | Trusted account |
| **Multichain Data** | Cross-network presence | Chain icons | View Multi-blockchain activity |
| **Gas Optimization** | Efficiency suggestions | "Save 32% with GasHawk" | Cost reduction tips |
### Action Capabilities
| Action | Description | Access Method | Result |
| :- | :- | :- | :- |
| **Copy Address** | Copy to clipboard | Copy button | Address in clipboard |
| **View QR Code** | Generate QR code | QR button | Mobile-friendly display |
| **Add to Watchlist** | Personal tracking | Star button | Monitoring setup |
| **Share Address** | Social sharing | Share options | Public distribution |
## Section E: Activity Analysis
### Understanding Address Metrics
| Metric Range | Activity Level | Interpretation | Example |
| :- | :- | :- | :- |
| **0-100 transactions** | Light user | Occasional activity | Personal wallet |
| **100-1,000 transactions** | Regular user | Consistent activity | Active trader |
| **1,000-10,000 transactions** | Heavy user | High activity | Power user |
| **10,000+ transactions** | Power user | Very high activity | Vitalik (73,149) |
### Token Holdings Analysis
| Token Count | Portfolio Type | Risk Level | Example |
| :- | :- | :- | :- |
| **1-10 tokens** | Conservative | Low | Basic portfolio |
| **10-50 tokens** | Moderate | Medium | Diversified investor |
| **50-100 tokens** | Aggressive | High | DeFi enthusiast |
| **100+ tokens** | Experimental | Very High | Vitalik (153+) |
### Net Worth Categories
| Value Range | Wealth Level | Classification | Significance |
| :- | :- | :- | :- |
| **\<\$1,000** | Small holder | Retail investor | Learning/testing |
| **\$1,000-\$10,000** | Medium holder | Active investor | Serious participation |
| **\$10,000-\$100,000** | Large holder | Significant investor | Substantial commitment |
| **\$100,000+** | Whale | Major investor | Market influence |
**Note:** This guide is based on Vitalik Buterin's address (0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045) as viewed on Blockscout. Address information and values are subject to change as blockchain activity continues.
# Beacon Chain Withdrawal Views in Blockscout
Source: https://docs.blockscout.com/using-blockscout/overviews/beacon-chain-withdrawal-views
See how Blockscout displays Ethereum beacon chain validator withdrawals on block and address pages, including index, validator index, amount, and recipient.
Withdrawals are akin to simple transactions (though they are actually 0 gas balance increases) included in the block structure. Coins are transferred from a validator to a preset withdrawal address (either EOA or contract). Each withdrawal also includes a unique integer index starting from 0 and incrementing by 1 with each withdrawal.
The unique `index`, assigned `validatorIndex`, withdrawal receiving `address`, and `amount` are all included in the withdrawals structure and are displayed on Blockscout on the block and addresses pages.
```json theme={null}
"withdrawals": [
{
"index": "0xbd8d0",
"validatorIndex": "0x81e",
"address": "0xe7c180eada8f60d63e9671867b2e0ca2649207a8",
"amount": "0x6dcf0a644000"
},
{
"index": "0xbd8d1",
"validatorIndex": "0x81f",
"address": "0xe7c180eada8f60d63e9671867b2e0ca2649207a8",
"amount": "0x6dcf0a644000"
},
],
```
```json theme={null}
{
"jsonrpc": "2.0",
"id": 1,
"result": {
"baseFeePerGas": "0x7",
"difficulty": "0x0",
"extraData": "0x",
"gasLimit": "0x1c9c380",
"gasUsed": "0x0",
"hash": "0x5262de0c24b0cab3fdc32fadda1904f4698ab0b12d505bf733cf47cb3e60f7f7",
"logsBloom": "0x00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000",
"miner": "0xf97e180c050e5ab072211ad2c213eb5aee4df134",
"mixHash": "0x08471cc3dbac65574f049af479631af782cf31c841710640ed615dc50670b378",
"nonce": "0x0000000000000000",
"number": "0xd62f",
"parentHash": "0xdabf9e7ebfad879ad44270c2a7a5ff8e848e72316def4d5b0305f2a1216089f7",
"receiptsRoot": "0x56e81f171bcc55a6ff8345e692c0f86e5b48e01b996cadc001622fb5e363b421",
"sha3Uncles": "0x1dcc4de8dec75d7aab85b567b6ccd41ad312451b948a7413f0a142fd40d49347",
"size": "0x465",
"stateRoot": "0x9f2a690353b6d8cfa75cb12347104f42d38463471cda1293696a6c3b685aa839",
"timestamp": "0x63af29e4",
"totalDifficulty": "0x1",
"transactions": [],
"transactionsRoot": "0x56e81f171bcc55a6ff8345e692c0f86e5b48e01b996cadc001622fb5e363b421",
"uncles": [],
"withdrawals": [
{
"index": "0xbd8d0",
"validatorIndex": "0x81e",
"address": "0xe7c180eada8f60d63e9671867b2e0ca2649207a8",
"amount": "0x6dcf0a644000"
},
{
"index": "0xbd8d1",
"validatorIndex": "0x81f",
"address": "0xe7c180eada8f60d63e9671867b2e0ca2649207a8",
"amount": "0x6dcf0a644000"
},
{
"index": "0xbd8d2",
"validatorIndex": "0x820",
"address": "0xe7c180eada8f60d63e9671867b2e0ca2649207a8",
"amount": "0x6dcf0a644000"
},
{
"index": "0xbd8d3",
"validatorIndex": "0x821",
"address": "0xe7c180eada8f60d63e9671867b2e0ca2649207a8",
"amount": "0x6dcf0a644000"
},
{
"index": "0xbd8d4",
"validatorIndex": "0x822",
"address": "0xe7c180eada8f60d63e9671867b2e0ca2649207a8",
"amount": "0x6dcf0a644000"
},
{
"index": "0xbd8d5",
"validatorIndex": "0x823",
"address": "0xe7c180eada8f60d63e9671867b2e0ca2649207a8",
"amount": "0x6dcf0a644000"
},
{
"index": "0xbd8d6",
"validatorIndex": "0x824",
"address": "0xe7c180eada8f60d63e9671867b2e0ca2649207a8",
"amount": "0x651c03f6de00"
},
{
"index": "0xbd8d7",
"validatorIndex": "0x825",
"address": "0xe7c180eada8f60d63e9671867b2e0ca2649207a8",
"amount": "0x6dcf0a644000"
},
{
"index": "0xbd8d8",
"validatorIndex": "0x826",
"address": "0xe7c180eada8f60d63e9671867b2e0ca2649207a8",
"amount": "0x6dcf0a644000"
},
{
"index": "0xbd8d9",
"validatorIndex": "0x827",
"address": "0xe7c180eada8f60d63e9671867b2e0ca2649207a8",
"amount": "0x6dcf0a644000"
},
{
"index": "0xbd8da",
"validatorIndex": "0x828",
"address": "0xe7c180eada8f60d63e9671867b2e0ca2649207a8",
"amount": "0x1a2950b4af800"
},
{
"index": "0xbd8db",
"validatorIndex": "0x829",
"address": "0xe7c180eada8f60d63e9671867b2e0ca2649207a8",
"amount": "0x6dcf0a644000"
},
{
"index": "0xbd8dc",
"validatorIndex": "0x82a",
"address": "0xe7c180eada8f60d63e9671867b2e0ca2649207a8",
"amount": "0x6dcf0a644000"
},
{
"index": "0xbd8dd",
"validatorIndex": "0x82b",
"address": "0xe7c180eada8f60d63e9671867b2e0ca2649207a8",
"amount": "0x6dcf0a644000"
},
{
"index": "0xbd8de",
"validatorIndex": "0x82c",
"address": "0xe7c180eada8f60d63e9671867b2e0ca2649207a8",
"amount": "0x6dcf0a644000"
},
{
"index": "0xbd8df",
"validatorIndex": "0x82d",
"address": "0xe7c180eada8f60d63e9671867b2e0ca2649207a8",
"amount": "0x6dcf0a644000"
}
],
"withdrawalsRoot": "0xb28f757020474ee478a03be8ca4a2efaa7ebddbf565129bb08202ce9a8670d44"
}
}
```
## UI display examples
### Block page example
![]()
### Address page example
![]()
# Blocks Page: Block Height, Gas, and Rewards
Source: https://docs.blockscout.com/using-blockscout/overviews/blocks
Understand Blockscout block views including block height, timestamp, gas used, validator rewards, burnt fees, base fee, and included transactions.
Blocks update on the homepage as they are created with basic information including block number (block height), number of transactions in the block, and time since the block was created.
Click on a specific block number for information about that block, or **View All Blocks** for a more detailed overview of recent blocks.
The all blocks page can also be accessed from the top menu.
Blockscout displays are configurable and may show different information depending on the instance and/or consensus method. These examples use a V1 instance of the UI. **V2 views are in process.**
![]()
## View All Blocks
The view all blocks page shows updated details from the most recent blocks. Use the page arrows to navigate.
![]()
#### Details by line
1. Number of transactions in the block / size of block in bytes / time since block was created.
2. Validator appending the block to the chain (fee recipient).
3. Reward to validator (in ETH). Equals the amount of priority fees sent by users to include transactions in the block.
4. Same as (3).
5. Portion of tx fee (in ETH) burned due to EIP-1559. Amount burned = `baseFeePerGas * gasUsed`
6. Block Gas limit. On Ethereum this is 30M gas: 2x the target size of 15M.
7. Amount of gas used in the block (amount and % of block space used). The blue line visualizes the %.
## Individual Block Page
Click on a block number (this number, also referred to as block height, indicates how many blocks have been added to the chain) to view additional details about the block. Scroll down to view individual transactions contained in a block.
Click on the tooltip (i) next to each item to view relevant info.
![]()
1. **Block Height**: Also known as block number, shows the position of the block on the chain.
2. **Timestamp**: Time & date the block was produced.
3. **Transactions**: Number of transactions included in the block.
4. **Fee Recipient**: Address of the validator (block producer) that received priority fees. Copy the address with the blue icon and paste into search to find more details about this validator.
5. **Size**: Size of the data contained in the block in bytes.
6. **Hash**: Cryptographic hash of the block header.
7. **Parent Hash**: Hash of the preceding block.
8. **Difficulty**: *NA for PoS.* Work required to mine a block in PoW.
9. **Total Difficulty**: *NA for PoS.* Total difficulty to mine the chain up until this block.
10. **Gas Used**: Total amount of gas used in the block & % of filled space.
11. **Gas Limit**: Total gas limit for the block. 30M is Ethereum limit, which represents 2x the 15M target.
12. **Nonce**: *N/A for PoS*. Demonstrates work in PoW.
13. **Base Fee per Gas**: Minimum multiplier required for a transaction to be included in a block.
14. **Burnt Fees**: Amount of ETH burned in the block.
15. **Priority Fee/Tip**: Total tips for transactions included in the block.
16. **Miner Reward**: Amount received by fee recipient in PoS. Matches (15).
Scroll below the block details to view transactions contained within the block.
![]()
# Block Explorer Glossary of Terms
Source: https://docs.blockscout.com/using-blockscout/overviews/glossary-of-terms
Definitions of common block explorer terms used in Blockscout including address, block, gas, hash, nonce, validator, token, transaction, and wallet.
Under Construction
## Block Explorer Glossary
**Address**: A unique identifier for a wallet or smart contract on the blockchain.
**Block**: A group of transactions that have been verified and added to the blockchain.
**Block Height**: The number of blocks in the chain between any given block and the first block (genesis block).
**Contract**: Also known as a smart contract, it's a self-executing program stored on the blockchain.
**Gas**: The unit of measure for the computational work required to execute transactions or smart contracts on Ethereum.
**Gas Price**: The amount of cryptocurrency you're willing to pay per unit of gas for a transaction.
**Hash**: A unique fixed-length string of characters that represents data. In blockchain, it's used to identify blocks and transactions.
**Miner/Validator**: Entities that verify and add new transactions to the blockchain.
**Nonce**: A number used once, typically to verify the uniqueness of transactions.
**Pending Transaction**: A transaction that has been broadcast to the network but not yet included in a block.
**Token**: A type of cryptocurrency that represents a tradable asset or utility and is often built on top of an existing blockchain.
**Transaction**: The transfer of cryptocurrency or data between addresses on the blockchain.
**Transaction Fee**: The cost to process a transaction on the blockchain, typically paid to the chain miners or validators.
**Wallet**: A tool that allows users to store, send, and receive cryptocurrency.
*Note: Specific terms may vary slightly depending on the blockchain network and the block explorer being used.*
# Token Info Sources: CoinGecko and Verified Owners
Source: https://docs.blockscout.com/using-blockscout/overviews/token-info
Learn where Blockscout token metadata comes from, how CoinGecko and manual owner submissions work, and how to fix incorrect token details.
Note that 3rd party users submit information for a token to the explorer. Please do your own research and check the contract thoroughly before interaction.
### Where does Blockscout get token info (name, logo, description, links)?
Blockscout pulls token metadata from two sources:
1. **Automated aggregators:** Blockscout queries CoinGecko and CoinMarketCap for exchange rate and market data. Projects submit token info directly to CoinGecko, which requires a Public Verification Post from an account tied to the project's official channels before reviewing listing or update requests. Blockscout displays what CoinGecko returns.
2. **Manual Submission:** A Blockscout account is required to verify contract ownership. An account holder signs a message and can then submit information for a verified token contract (message must be signed by the same wallet that deployed the contract on chain). Token information is reviewed by Blockscout admins before it is added to the explorer page. Once verified, a user can submit additional information or update details. This means information can change later, so it is important to verify project information independently whenever interacting with a token contract.
Additional info on [adding token details and processing is available here.](/using-blockscout/token-info)
### Does Blockscout require contract verification before updating token info?
Yes, Blockscout requires the token's contract source code to be verified before it will accept owner-submitted updates to name, logo, website, or socials. This ensures the code shown publicly matches what's actually deployed, and that only the real contract owner can update the listing.
Blockscout's **Verified Addresses** feature:
1. [Verify the contract's source code](/devs/verification).
2. [Sign in to My Account](/using-blockscout/my-account) and prove ownership of the address, either by signing a message from the contract's owner wallet or via multisig signer verification.
3. Once ownership is verified, the address is listed under Verified Addresses in the account, and the owner can update token info directly without re-verifying each time.
### What should a project do if their token info is wrong on Blockscout?
* **If the token is tracked on CoinGecko: submit the correction directly to CoinGecko.** Blockscout will reflect it automatically once CoinGecko's data updates.
* If the token isn't on CoinGecko, or the fix is logo/description/links: Update through the Blockscout interface.
* To update on Blockscout, log in to your account, go to Update token info, and follow the prompts.
![Screen 1]()
# Main Menu: Network, Blockchain, and API Navigation
Source: https://docs.blockscout.com/using-blockscout/overviews/top-menu
Overview of Blockscout v2 UI top menu items including network switcher, blockchain data (transactions, blocks, batches, L1/L2), and API access.
## V2 UI
*The following views are taken from the* [*Optimism Blockscout instance*](https://optimism.blockscout.com/)*.*
### Network Menu
Shows available Mainnet and Testnets.
![]()
### Blockchain Menu
Access transactions, blocks, batches and L1 \<-> L2 data.
![]()
### API Menu
Access API information including the REST API which serves the v2 UI.
![]()
# Transaction Fields Reference: Hash, Gas, Logs, State
Source: https://docs.blockscout.com/using-blockscout/overviews/transaction-fields
Reference guide to Blockscout transaction page fields including hash, status, gas, nonce, input data, token transfers, event logs, and state changes.
# Blockscout Transaction Fields Reference Guide
Example transaction on Ethereum
![Blockscout Ethereum transaction details page showing 0.0019 ETH transfer from Huobi Deposit Funder 7 to wallet address, with transaction hash, block confirmations, timestamp, and navigation tabs for token transfers, logs, and state changes]()
## Transaction Summary (Header)
| Field | Description | Format/Example | Purpose |
| :- | :- | :- | :- |
| **Transaction Summary** | Quick overview of transaction action | "β‘ Transfer 0.0019 ETH to 0x1e...2988" | Instant understanding of what happened |
| **Transaction Icon** | Visual indicator of transaction type | Lightning bolt (β‘) for transfers | Quick visual identification |
| **Amount Display** | Primary value being transferred | "0.0019 ETH" | Main transaction amount |
| **Recipient Address** | Shortened destination address | "0x1e...2988" with copy button | Quick recipient identification |
| **View Counter** | Number of times transaction was viewed | "π 8" | Shows transaction popularity/interest |
## Transaction Overview Fields
| Field | Description | Format/Example | Purpose |
| :- | :- | :- | :- |
| **Transaction Hash** | Unique identifier for this specific transaction | 66-character hex string starting with "0x" | Transaction's "receipt number" for tracking and reference |
| **Status and Method** | Current state and transaction type | β
Success | Shows whether transaction completed successfully |
| **Block** | Block number and confirmations | 22933572 | Show BlockNumber |
| **Timestamp** | When transaction was mined with confirmation time | π 8m ago | Reflects timestamp: Jul 16 2025 12:33:59 PM (-06:00 UTC) |
| **Sponsored** | Advertisement or sponsored content section | Ad banner with "Advertise to" message | Supports open source block explorer |
| **From** | Sender address with label | "π΄ Huobi: Deposit Funder 7" with copy button | Identified sender (exchange, contract, etc.) |
| **To** | Recipient address | "π‘ 0x1ec7cB3FE99bD07E6faBa7D296857bCC102988" with copy button | Destination address |
## Blockscout-UI Features
| Feature | Description | Location | Purpose |
| :- | :- | :- | :- |
| **Transaction Summary Line** | Quick overview with icon and key details | Top of page | Instant understanding of transaction |
| **View Counter** | Shows transaction popularity | Next to summary | Community interest indicator |
| **Address Labels** | Known entity identification | From/To fields | Better context than raw addresses |
| **Sponsored Content** | Advertisement section | Middle of details | Revenue for block explorer |
| **Copy Buttons** | Quick copy functionality | Next to addresses/hashes | User convenience |
| **Tabbed Navigation** | Organized information sections | Below summary | Easy access to different data types |
| **Color-Coded Status** | Visual status indicators | Status field | Quick success/failure identification |
| **Confirmation Speed** | Time to confirmation | Timestamp field | Network performance insight |
## Navigation Tabs
| Tab | Description | Contents | Purpose |
| :- | :- | :- | :- |
| **Details** | Main transaction information | Hash, status, block, addresses, gas, value | Primary transaction data |
| **Token transfers** | ERC token movements | Token name, amount, from/to addresses | Track token transfers separate from ETH |
| **User operations** | Account abstraction operations | User operation details for AA wallets | Advanced wallet interactions |
| **Internal txns** | Internal transactions | Contract-to-contract calls | See all sub-transactions |
| **Logs** | Event logs from contracts | Contract events and their data | Smart contract activity |
| **State** | State changes | Storage and balance modifications | What changed on the blockchain |
| **Raw trace** | Complete execution trace | Step-by-step execution details | Debug and analysis |
## Visual Elements and Icons
| Element | Description | Meaning | Context |
| :- | :- | :- | :- |
| **β‘ Lightning Icon** | Transaction type indicator | Fast/standard transaction | Used in transaction summary |
| **π΄ Red Circle** | Address label indicator | Exchange or known entity | Huobi exchange identifier |
| **π‘ Yellow Circle** | Address label indicator | Contract or user wallet | Regular address marker |
| **β
Green Checkmark** | Success status | Transaction completed successfully | Status indicator |
| **π Eye Icon** | View counter | Number of page views | Popularity metric |
| **π Copy Button** | Copy to clipboard | Click to copy address/hash | User convenience |
| **π Clock Icon** | Timestamp indicator | Time-related information | Timing reference |
## Transaction Details Fields
| Field | Description | Format/Example | Purpose |
| :- | :- | :- | :- |
| **From Address** | Wallet address that initiated the transaction | Labeled address with copy button | Identifies the sender with context |
| **To Address** | Destination address for the transaction | Labeled address with copy button | Identifies recipient with context |
| **Value** | Amount of native currency (ETH) transferred | ETH amount with USD equivalent | Shows direct ETH transfer (separate from token transfers) |
| **Transaction Fee** | Total cost paid to miners/validators | ETH amount with USD equivalent | Total processing cost |
| **Nonce** | Sequential counter for transactions from sending address | Number (e.g., 1,247) | Prevents replay attacks and ensures ordering |
## Gas Information Fields
| Field | Description | Format/Example | Purpose |
| :- | :- | :- | :- |
| **Gas Limit** | Maximum gas the sender was willing to pay | Number (e.g., 21,000) | Upper bound on computational work |
| **Gas Used** | Actual gas consumed by the transaction | Number with percentage (e.g., 21,000 (100%)) | Actual computational work performed |
| **Gas Price** | Price per unit of gas | Gwei amount (e.g., 20.5 Gwei) | Cost per unit of computation |
| **Max Fee Per Gas** | Maximum fee willing to pay per gas unit (Type 2) | Gwei amount (e.g., 25 Gwei) | EIP-1559 fee mechanism for predictable fees |
| **Max Priority Fee** | Maximum tip willing to pay to miners (Type 2) | Gwei amount (e.g., 2 Gwei) | Incentivizes miners to include transaction quickly |
| **Base Fee Per Gas** | Network's base fee at transaction time (Type 2) | Gwei amount (e.g., 18.5 Gwei) | Burned portion of fee (not given to miners) |
## Transaction Type Fields
| Field | Description | Format/Example | Purpose |
| :- | :- | :- | :- |
| **Transaction Type** | EIP standard used for this transaction | Type 0, Type 1, Type 2 | Indicates fee mechanism and features |
| **Type 0** | Legacy transactions | Standard format | Original transaction format |
| **Type 1** | EIP-2930 (Access List) | With access list | Gas optimization for contract interactions |
| **Type 2** | EIP-1559 (Dynamic Fee) | With base fee and priority fee | More predictable fee mechanism |
| Type 3 | EIP-4844
(Blobs) | Blob carrying transaction | Accommodate batched data |
## Input Data Fields
| Field | Description | Format/Example | Purpose |
| :- | :- | :- | :- |
| **Input Data** | Data payload sent with transaction | Hexadecimal string | Contains function calls and parameters |
| **Method ID** | First 4 bytes identifying contract function | 4-byte hex (e.g., 0xa9059cbb) | Identifies which contract function was called |
| **Input Data (Hex)** | Raw hexadecimal data | 0x followed by hex characters | Raw transaction data |
| **Input Data (UTF-8)** | Human-readable text format | Plain text (when applicable) | Readable version of data |
| **Input Data (Decoded)** | Function calls with parameter names | Function name and parameters | User-friendly view of contract interactions |
## Token Transfer Fields
| Field | Description | Format/Example | Purpose |
| :- | :- | :- | :- |
| **Token Name** | Name of the transferred token | Text (e.g., "USD Coin") | Identifies the token being transferred |
| **Token Symbol** | Token's ticker symbol | Text (e.g., "USDC") | Short identifier for the token |
| **Token Amount** | Quantity of tokens transferred | Number with decimals | Amount being moved |
| **Token Type** | Standard used for the token | ERC-20, ERC-721, ERC-1155 | Indicates token functionality |
| **From Address** | Token sender address | 42-character hex string | Who sent the tokens |
| **To Address** | Token recipient address | 42-character hex string | Who received the tokens |
| **Token Contract** | Address of the token's smart contract | 42-character hex string | Contract managing this token |
## Event Logs Fields
| Field | Description | Format/Example | Purpose |
| :- | :- | :- | :- |
| **Log Index** | Sequential numbering of events | Number (e.g., 0, 1, 2) | Order of events within transaction |
| **Contract Address** | Address that emitted the event | 42-character hex string | Source of the event |
| **Event Name** | Name of the emitted event | Text (e.g., "Transfer") | Type of event that occurred |
| **Topics** | Indexed event parameters | Array of hex strings | Searchable event data |
| **Data** | Non-indexed event data | Hex string | Additional event information |
| **Decoded Logs** | Human-readable event information | Structured data | User-friendly view of events |
## State Changes Fields
| Field | Description | Format/Example | Purpose |
| :- | :- | :- | :- |
| **Address** | Account that changed | 42-character hex string | Which account was modified |
| **Storage Changes** | Before and after values | Hex values | What data changed in storage |
| **Balance Changes** | ETH balance modifications | ETH amounts | How balances changed |
| **Nonce Changes** | Account nonce updates | Number changes | Transaction counter updates |
## Status Indicators
| Status | Visual Indicator | Meaning | Next Steps |
| :- | :- | :- | :- |
| **Success** | Green checkmark | Transaction completed successfully | Transaction is final |
| **Failed** | Red X | Transaction failed during execution | Check revert reason, retry if needed |
| **Pending** | Orange clock | Transaction waiting to be mined | Wait for confirmation or increase gas |
| **Dropped** | Gray indicator | Transaction removed from mempool | Resubmit with higher gas price |
## Additional Information Fields
| Field | Description | Format/Example | Purpose |
| :- | :- | :- | :- |
| **Block Hash** | Unique identifier for the block | 66-character hex string | Reference to containing block |
| **Block Timestamp** | When the block was mined | UTC timestamp | Block creation time |
| **Transaction Receipt** | Proof of transaction processing | JSON data | Technical execution details |
| **Raw Transaction** | Complete transaction data | JSON format | Developer-level transaction info |
| **Revert Reason** | Error message for failed transactions | Text description | Explains why transaction failed |
## Common Transaction Patterns
| Pattern | From Address | To Address | Value | Input Data | Tokens Transferred |
| :- | :- | :- | :- | :- | :- |
| **Simple ETH Transfer** | User wallet | User wallet | > 0 ETH | Empty/minimal | None |
| **Token Transfer** | User wallet | Token contract | 0 ETH | Function call | Token amount |
| **Contract Interaction** | User wallet | Contract | 0 ETH | Function data | Possibly tokens |
| **Contract Creation** | User wallet | null | 0 ETH | Contract bytecode | None |
| **Multi-token Transfer** | User wallet | Contract | 0 ETH | Function call | Multiple tokens |
## Troubleshooting Guide
| Issue | Possible Causes | What to Check |
| :- | :- | :- |
| **Transaction Not Found** | Wrong hash, wrong network, too recent | Verify hash, check network, wait for indexing |
| **Failed Transaction** | Out of gas, revert, invalid input | Check gas limit, read revert reason, verify input |
| **High Gas Fees** | Network congestion, complex operation | Check gas price, simplify transaction, wait for lower fees |
| **Pending Too Long** | Low gas price, network issues | Increase gas price, check network status |
| **Wrong Token Amount** | Decimal confusion, display issue | Check token decimals, verify actual amount |
**Quick Reference:** Use Ctrl+F to search for specific field names in this guide. All fields are organized by the section they appear in on the Blockscout transaction page.
# Transaction Types: Blob, Coin, Contract, and Token
Source: https://docs.blockscout.com/using-blockscout/overviews/transaction-types
How Blockscout categorizes transactions including blob (EIP-4844), coin transfer, contract call, contract creation, token transfer, minting, and burning.
Different types of transactions are categorized in the Blockscout UI to allow for quick identification. Types include:
* **Blob txn:** 4844-type transactions which include large amounts of data
* **Coin transfer**: value transfer, value >= 0, no tx input
* **Contract call**: tx input is present (any value including 0)
* **Contract creation**: creation of a smart-contract
* **Token burning**: recognized token transfer of any of ERC-20, 721, 1155 token instance (single or bulk) to 0x0000... address
* **Token creation**: creation of token instance in ERC-1155
* **Token minting**: token transfer of any of ERC-20, 721, 1155 token instance (single or bulk) from 0x0000... address
* **Token transfer**: token transfer of any of ERC-20, 721, 1155 token instance (single or bulk)
* **Transaction**: A contract call where the contract has not yet been identified by Blockscout.
![]()
![]()
# Adding and Updating Token Info on Blockscout
Source: https://docs.blockscout.com/using-blockscout/token-info
Submit or update token name, logo, description, website, and socials on Blockscout using deployer verification, manual review, or expedited processing.
## Overview
Token pages on Blockscout can display extra information beyond what's on-chain. This can include project description, website, social links, and a verified icon. To add or update this information, you submit a request that goes through a QA review.
**What you'll need (minimum information required):**
| Field | Required? |
| - | - |
| Token name | Required |
| Token contract address | Required |
| Requester name | Required |
| Requester email | Required |
| Project email address (address created with the project's official domain, e.g. `yourusername@yourwebsitedomain.com`, or the official email address shown on the website) | Suggested |
| Project website (working links, clear information) | Suggested |
| Icon URL (48 x 48 SVG or PNG) | Required |
| Project description | Required |
| Social media links | Optional but recommended\* |
| Payment (wallet you are sending funds from and tx hash) | Optional, recommended for expedited processing\*\* |
\*A missing website or social presence won't block approval but does provide relevant context for token info and improves the chances of approval.
\*\*We offer the option to pay for expedited processing of token information. This guarantees we will review and approve or decline the listing within 7 days. If no payment is included we cannot guarantee any timeline for review, as we have 1,000s of tokens in the queue.
## Two ways to submit
Your submission path depends on whether the wallet you're submitting from can be automatically tied to the token.
### Path 1: Submission using the deployer address
If you control the wallet that deployed the token, verification is fast. Automated checks confirm the wallet information and you can go directly to token info submission.
**Steps**:
1. **Log in** to Blockscout using the same address used to deploy the token (you should also have an email address associated with this log in, add if you haven't done so already).
![Login 1]()
2. Go to the token contract. You can access this in several ways.
3. Paste the token contract into search, then click the 3 dots to access **Add Token Info**
![Token 2 1]()
1. Access from the **Verified addrs** item in your account dashboard.
![Verified 1]()
![Add Details]()
4. Enter your token details and **Send request.**
![Details 1]()
![Details 2]()
Your submission will move to review. During review you will be contacted about optional expedited payment processing (see below).
### Path 2: You can't submit from your wallet on the Blockscout UI
![Verify Message 1]()
If the original deployer wallet is not accessible or was never yours (for example after a multisig migration, a treasury wallet change, a team handoff, or a factory contract deployment) you can still submit for verification.
**Steps:**
1. Send an email to [submissions@blockscout.com](mailto:submissions@blockscout.com) with your wallet, token information, and an explanation of your relationship to the project.
2. You will receive a reply with a link to provide additional specific information to the Blockscout team.
3. The team will review the proof and confirm the provided information manually before moving forward.
## Expedited Payment Process
Payment address:
* Ethereum, Optimism, Base: 0x242ba6d68FfEb4a098B591B32d370F973FF882B7
* Robinhood: 0xF3e177A4034cF6e57cCBe80108cAe6f3729C6649
While not required, expedited payment ensures we can review your token info in a timely manner (within 7 days). The payment process varies depending on whether you are following Path 1 or Path 2 submissions.
* Path 1: you will be contacted during the review process if you would like to pay for expedited review.
* Path 2: you will have the option to pay as a part of the manual submission.
To initiate the process, you will send **the requested amount in USDC or USDT** on the chain where your token is listed. Current supported networks include **Ethereum, Optimism, Base, and Robinhood Chain**.
You will then copy the transaction hash from this transaction and include it with your initial token information submission.
Payment does not guarantee your token info will be listed β it only guarantees that the team will review and approve or reject your submission within 7 days. Reasons for rejection are listed in the possible outcomes section below.
## Review Process: what happens after you submit
Path 1 submissions are checked automatically against deployer address.
Path 2 submissions are reviewed manually against the proof you provide.
We search for tokens with matching names, symbols, or branding. Tokens may vary slightly; however, if exact duplicates exist, the token with the strongest liquidity, trading volume, and active trader count is treated as official, and copycat tokens are rejected.
If you include a website or socials, we check for phishing content, suspicious redirects, and impersonation of unrelated projects. This content helps verify correct information, and we recommend you include as much as you can.
Only if your website has a wallet-connect feature. We test it with a QA wallet holding no valuable assets, checking for unusual permission requests or unlimited spending approvals.
Approved, rejected, or sent back requesting more information.
**Expedited reviews are completed in 1 to 7 business days**. Standard requests have no guaranteed timeframe.
## Possible outcomes
**Approved** β your token info is confirmed and published shortly after.
**More information requested** β this typically means we couldn't confirm wallet ownership, or something in your submission was incomplete or inconsistent. You'll get a follow-up describing what's needed.
**Rejected** β a rejected submission must restart the full process, including a new fee if you want expedited processing.
### Common reasons for rejection
* **Payment issues.** The transaction can't be confirmed on-chain, the amount is incorrect, or the transaction hash was already used on another submission.
* **Wallet doesn't qualify.** You couldn't provide sufficient proof of ownership for the token.
* **Token impersonation.** The token exactly copies the name, symbol, and branding of an established token.
* **Phishing behavior.** A linked website contains phishing content or redirects to a suspicious domain.
* **Suspicious wallet permissions.** A linked website's wallet-connect feature requests unlimited spending approvals, unexpected token approvals, or access to unrelated assets.
* **Requests for private keys or seed phrases.** Anywhere in the website or submission flow.
* **Misleading or misrepresented information.** Submitted details are inaccurate or intentionally misleading. Token name, logo, designs, symbol, and other information are fraudulent, infringe copyright, or misrepresent public entities.
Every submission is final once sent for review. Double-check your token name, contract address, and links before submitting to avoid a rejection.
## FAQ
No. The fee is non-refundable regardless of whether your submission is approved, rejected, or requires resubmission.
No. A missing website or social presence doesn't block approval on its own, but is recommended.
Ethereum, Optimism, Base, and Robinhood Chain. Send 99 USDC or USDT to the address in the [Expedited Payment Process](#expedited-payment-process) section.
Expedited reviews typically complete in 1 to 7 business days. Standard requests have no guaranteed timeframe.
Use Path 2. Email our QA team at [submissions@blockscout.com](mailto:submissions@blockscout.com) with proof of your relationship to the project, such as a signed message or a post from the project's verified social account.
No. Duplicate submissions for the same contract address create backlogs and slow down processing. If you have issues with your current request, reply to your original submission thread instead of sending a new one.
Not immediately. Every submission is final once sent for review. However, once approved, token info can be resubmitted if something needs correcting.
We compare liquidity, trading volume, active traders, token age, and transaction count. The token with the strongest legitimate activity is treated as official; a newer duplicate attempting to impersonate it will be rejected.
# Token Standards Supported by Blockscout
Source: https://docs.blockscout.com/using-blockscout/token-support
Blockscout indexes and displays ERC-20, ERC-721, ERC-1155, ERC-777, and ERC-4626 tokens with balances, transfers, and standard-specific views.
Blockscout supports the following token types:
* ERC-20: Fungible tokens
* Standard for interchangeable tokens
* Used for cryptocurrencies, stablecoins, utility tokens
* ERC-721: Non-fungible tokens (NFTs)
* Unique, indivisible tokens
* Often used for digital art, collectibles, game items
* ERC-1155: Multi-token standard
* Combines fungible and non-fungible tokens
* Efficient for gaming and complex ecosystems
* ERC-777: Advanced fungible tokens (basic indexing but no additional views, provides similar info to ERC-20)
* Adds features like operator support and hooks
* Backward compatible with ERC-20.
* ERC-4626: Tokenized Vaults (basic indexing but no additional views, provides similar info to ERC-20)
* Standard for yield-bearing tokens
* Used in DeFi for lending and yield farming
# ERC-1155 Support: Multi-Token Indexing
Source: https://docs.blockscout.com/using-blockscout/token-support/erc-1155-support
How Blockscout recognizes ERC-1155 contracts and indexes fungible and non-fungible balances, parses batched transfers, and tracks minting events.
[ERC-1155](https://eips.ethereum.org/EIPS/eip-1155) contracts are designed to support multiple token types within a single contract. This standard is being adopted rapidly for efficiency and optimization, and is being used to bundle multi-token transactions and approvals while supporting both fungible and non-fungible tokens.
Recognition and labelling for ERC-1155 contracts, indexing instance balances for both fts and nfts, parsing single and batched transactions, and monitoring and displaying minting events are included.
## GnosisChain Example
ERC-1155s are supported for the Gnosis Chain and any new ERC-1155 instances are recognized on deployment. For ERC-1155 contracts created prior to the enhanced support, a new single or batched transfer, mint, or token instance creation triggers contract recognition.
[https://gnosis.blockscout.com/token/0x93d0c9a35c43f6BC999416A06aaDF21E68B29EBA?tab=token\_transfers](https://gnosis.blockscout.com/token/0x93d0c9a35c43f6BC999416A06aaDF21E68B29EBA?tab=token_transfers)
![Unique One ERC1155]()
# Widgets: 3rd-Party Data on Address and Contract Pages
Source: https://docs.blockscout.com/using-blockscout/widgets
Blockscout widgets surface reputation, airdrop, security, audit, and complexity data from partners like Talent Protocol, Webacy, Trustblock, and more.
If your project would like to incorporate a widget into the explorer, please [contact us in Discord](https://discord.gg/blockscout). Learn more -> [Widgets Deck](/images/widgets-deck.pdf)
## Overview
Blockscout Widgets deliver contextual data from third-party protocols directly on address and contract pages. Essential information about onchain identity, activity, security and ecosystem participation provides a broad overview of relevant information.
![Example blockscout Address Widget]()
## Viewing Widgets
1. Navigate to any externally owned account (EOA) address, ENS name (like [vitalik.eth](https://eth.blockscout.com/address/0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045)) or contract (i.e. the [UniV2 factory contract](https://eth.blockscout.com/address/0x5C69bEe701ef814a2B6a3EDD4B1652CB9cc5aA6f)) in your Blockscout explorer.
2. Scroll down to the Widgets section below the address/contract details to view widgets.
3. You can also view via the **Widgets tab** for any address or contract, which will show all available widgets.
![Address Details]()
## Key Features
### Enhanced Address Insights
Widgets display engagement and activity across the Web3 ecosystem, providing a holistic view beyond basic balances and transactions.
### Security & Risk Assessment
For contracts and tokens, widgets surface risk scores, audit information, complexity metrics, and other security analytics.
### Ecosystem Integration
Blockscout integrates with multiple protocols. Additional details are provided in the Available Widgets section.
**Address Pages**
* **Talent Protocol:** Onchain creator score
* **Drops**: Airdrop checker
* **GitPOAP**: Contributor reward badges
* **Blockscout Badges**: Minted Blockscout badges
* **Ethereum Follow Protocol (EFP)**: Onchain social graph
* **EtherScore**: Onchain reputation badges
* **Webacy**: Risk analysis
* **Human Passport**: Humanity verification
* **Humanode**: Onchain biomapper
**Contract Pages**
* **Webacy**: Risk score
* **Trustblock**: Audit info
* **SmartMUV**: Contract Complexity
## Supported Networks
Widgets are available on Blockscout hosted chains including:
* Ethereum Mainnet
* Optimism
* Base
* Arbitrum
* Celo
* Gnosis
* Soneium
* Polygon
## Benefits
### For Users
* Comprehensive onchain identity view
* Quick access to ecosystem participation data
* Security assessment at a glance
* Airdrop eligibility tracking
### For Developers
* Contract complexity analysis
* Audit verification
* Risk assessment tools
* Integration opportunities
### For the Ecosystem
* Enhanced transparency
* Improved security awareness
* Stronger protocol integrations
* Better user experience
## Currently Available Widgets
Widgets show an overview score. Each widget can be clicked on to reveal additional details.
### Address Page Widgets
#### Creator Score
**Source:** Talent Protocol
Measures a content creator's reputation by analyzing data from various platforms. The Creator Score evaluates both quantity and quality of work using verifiable data points, providing comprehensive assessment of a creator's influence and trustworthiness.
**Additional available details:**
* Overall creator score
* Platform-specific scores (Farcaster, Lens, etc.)
* Total earnings
* Content quality metrics
#### Drops
**Source:** Drops (Airdrop Checker)
Automatically identifies unclaimed crypto airdrops by monitoring wallet addresses across multiple networks. Shows eligibility for recent and verified airdrops.
**Additional available details:**
* Eligible airdrops
* Claimable amounts
* Claimed rewards history
* Airdrop status
**Features:**
* Multi-network monitoring
* Telegram alerts for new airdrops
* Real-time eligibility checking
#### GitPOAP
**Source:** GitPOAP
Rewards and permanently records contributions to open-source projects via GitHub using the POAP (Proof of Attendance Protocol) model. Provides public, permissionless, onchain verification of open-source contributions.
**Additional available details:**
* Total GitPOAPs earned
* Project contributions
* Contribution history
* GitHub integration status
#### Blockscout Badges
**Source:** Blockscout Merits
Limited-edition NFT badges celebrating community involvement in Blockscout campaigns and contributions.
**Additional available details:**
* Earned merits
* Referral count
* Activity streaks
* Collectible NFT badges
#### EFP Followers
**Source:** Ethereum Follow Protocol (EFP)
Onchain social graph protocol for Ethereum accounts that complements ENS. Enables users to follow or tag other addresses through NFT lists, creating a decentralized social network.
**Additional available details:**
* Follower count
* Following list
* Recent transactions
* Social connections
#### Onchain Achievement Badges
**Source:** EtherScore
Represents onchain achievements completed across DeFi protocols, NFT platforms, and DAOs. Each badge signifies a specific milestone or activity in Web3.
**Additional available details:**
* Total badge count
* Badge categories
* Achievement progress
* Protocol integrations
#### Address/Contract Risk Score (available for both)
**Source:** Webacy
Numerical assessment evaluating potential security threats, compliance issues, or suspicious activities associated with a wallet address.
**Additional available details:**
* Overall risk rating (Low/Medium/High)
* Suspicious activity flags
* Security warnings
* Risk analysis details
**Purpose:**
* Assess wallet security status
* Identify potential threats
* Provide security insights
#### Humanity Score
**Source:** Gitcoin Passport
Proof-of-personhood system using verifiable credentials ("stamps") from trusted web2 and web3 sources to verify humanity without compromising privacy. Helps distinguish real humans from bots and Sybil attacks.
**Additional available details:**
* Unique Humanity Points
* HUMN Points
* Collected stamps
* Verification status
**Stamp Sources:**
* Government ID
* Biometrics
* ENS domains
* Social profiles
* Other verified credentials
#### Biomapper Score
**Source:** Humanode
Biomapper is an on-chain, private facial recognition tool that provides Sybil resistance by ensuring each verified person can link only one EVM-compatible address to a dApp.
**Additional available details:**
* Humanode biomapper verification status
**Purpose:**
* Shows if a user is verified with biomapper, proving they are a unique human via facial recognition.
### Contract Page Widgets
#### Audits
**Source:** Trustblock
Displays verified smart contract audits recorded onchain through Trustblock, a web3 protocol for audit transparency.
**Requirements:**
* Auditors and audit firms must publish contracts on Trustblock for audits to appear
**Additional available details:**
* Audit status
* Auditor information
* Audit reports
* Verification details
#### Complexity Score
**Source:** SmartMuv Explorer
Evaluates the structural complexity of a smart contract's storage layout. Primarily intended for developers and auditors who need to understand, migrate, or upgrade smart contracts safely.
**Additional available details:**
* Layout summary
* Deep analysis
* Complexity score
* Storage structure breakdown
**Use Cases:**
* Contract migration planning
* Upgrade safety assessment
* Security auditing
* Development review
# WebSocket Use Case: Build a Whale-Watching Alert Bot
Source: https://docs.blockscout.com/whale-watch
Build a whale-watching bot on Robinhood Chain that streams Blockscout WebSocket events and posts Discord alerts when transfers cross your threshold.
Whale-watching is one of the oldest habits in crypto: watch large wallets, get notified the moment they move, and use that as a signal. Whale Alert, the best-known example, tracks transfers in the millions of dollars across major chains and flags whether coins are heading onto an exchange, which often signals selling pressure, or off one, which often signals accumulation. Paid alerting services like Cryptocurrency Alerting go further, letting you monitor an entire network with one rule and pushing matches out over webhooks, Slack, Discord, or Telegram.
This post builds a small version of that yourself: a bot that watches an address on Robinhood Chain and pings a Discord channel the instant a transfer crosses a threshold you set. Robinhood Chain is a good chain to demonstrate this on for a specific reason: Robinhood is bringing tokenized stocks, ETPs, and RWAs onchain, so "whale watching" here isn't only about ETH moving between wallets, it can mean watching large transfers of tokenized equities, which is a genuinely new kind of signal.
Blockscout does have a built-in way to monitor addresses: the [Watchlist feature](/using-blockscout/my-account/watchlist) under My Account. Add an address there and Blockscout emails you whenever it sends or receives a transaction, with per-token-type controls over what triggers a notification. If you'd prefer to be notified by email, this is a good way to go. In this post we add speed and flexibility: since it's a script you own, alerts can go to Discord, Slack, a pager, a database, or anywhere else an HTTP endpoint can receive them.
## Why push, not polling
Another option for checking addresses is creating a script that polls an address's transaction list every few seconds and diffs it against what it saw last time. This can work, but is inefficient and costly for 2 main reasons.
1. **Latency.** The poll interval delays alerts. Poll every 10 seconds and your fastest possible alert is 10 seconds late, on a chain where blocks land every \~0.1 seconds. By the time a whale move is visible on Twitter, informed traders have often already acted on it, so shaving that delay is the entire value proposition of an alert bot.
2. **Wasted requests.** Most polls return nothing new. You're paying for the 99% of checks that find no whale activity, just to catch the 1% that does.
With a push-based approach you subscribe once, and the server sends you an event the moment something happens, with no unnecessary request in between. For a fast chain like Robinhood Chain, this difference is amplified, since more can happen inside a single polling window.
## Blockscout's version: the WebSocket API
Blockscout's Pro API doesn't currently have a hosted "webhooks" feature where you paste a URL into a dashboard and configure filters. However, with the WebSocket API you can open a multiplexed connection, subscribe to topics like a specific address, and the server pushes JSON events to you as they happen.
This provides flexibility but relies on you to turn the WebSocket message into an outbound webhook call. In this tutorial we'll create a webhook from the WebSocket API that posts directly to Discord, driven by Blockscout's real-time feed.
## What you'll build
A \~100-line Node.js script that:
1. Opens a WebSocket connection to the Blockscout Pro API
2. Subscribes to a Robinhood Chain address
3. Watches both native ETH transfers and any token transfer (ERC-20, ERC-721, ERC-1155) involving that address
4. Filters each against a low threshold
5. POSTs a formatted alert to a Discord webhook when a match hits
6. Reconnects automatically, with backoff, if the connection drops
You'll test it by sending yourself a real, tiny transfer on Robinhood Chain mainnet, which costs essentially nothing.
## Step 1: Get a Pro API key
1. Go to [dev.blockscout.com](http://dev.blockscout.com) and create an account.
2. Open the Keys section and click **Create API Key**. Keys start with `proapi_` and are shown once.
```bash theme={null}
export BLOCKSCOUT_API_KEY=proapi_your_key_here
```
Robinhood Chain testnet isn't currently supported by the Pro API, so this tutorial runs on mainnet (chain ID `4663`). That's not a problem here: gas is sub-cent ETH, and trading actions are gas-free for users for Robinhood Chain's first 90 days, so a real test transfer costs you effectively nothing.
## Step 2: Create a Discord webhook to receive alerts
This is the easiest possible receiver to test against, and it takes about a minute:
1. In Discord, go to a server you control (or create one, free, just for this).
2. Server Settings β Integrations β Webhooks β **New Webhook**.
3. Name it (e.g. "Whale Watcher"), pick a channel, and click **Copy Webhook URL**.
```bash theme={null}
export DISCORD_WEBHOOK_URL=https://discord.com/api/webhooks/your/webhook/url
```
That URL accepts a plain POST with a JSON body like `{"content": "your message"}`, which is all this bot needs to send.
## Step 3: Pick an address and thresholds
You need a Robinhood Chain address to watch. For testing, use a wallet you control so you can trigger alerts yourself. For a real deployment, this is where you'd point at a known exchange hot wallet, a bridge contract, or a large holder's address.
```bash theme={null}
export WATCH_ADDRESS=0xYourAddressToWatch
export THRESHOLD_WEI=1000000000000000
export TOKEN_THRESHOLD=0.001
```
`1000000000000000` wei is 0.001 ETH, low enough that almost any test transfer trips it. `TOKEN_THRESHOLD` is in human units (e.g. "0.001" tokens), not raw units, since the relay reads each token's decimals off the event itself and does the conversion for you. These are placeholders you will adjust, real whale thresholds on a live deployment will be far higher, tuned to whatever counts as "large" for the wallets and tokens you're tracking.
## Step 4: Write the relay
Create a project and install the WebSocket client:
```bash theme={null}
mkdir whale-watcher && cd whale-watcher
npm init -y
npm pkg set type=module
npm install ws
```
`npm pkg set type=module` tells Node to treat `.js` files in this project as ES modules, which the `import` syntax below needs. Without it, running the script fails with `Cannot use import statement outside a module`.
Create `watch.js` by pasting this whole block into your terminal, it writes the file for you:
```bash theme={null}
cat > watch.js << 'EOF'
import WebSocket from "ws";
const apiKey = process.env.BLOCKSCOUT_API_KEY;
const watchAddress = process.env.WATCH_ADDRESS.toLowerCase();
const thresholdWei = BigInt(process.env.THRESHOLD_WEI);
const tokenThreshold = Number(process.env.TOKEN_THRESHOLD);
const discordWebhook = process.env.DISCORD_WEBHOOK_URL;
const chainId = "4663"; // Robinhood Chain mainnet
const seen = new Set(); // dedup keys, since delivery is at-least-once
let reconnectDelay = 1000; // starts at 1s, doubles on repeated failures, caps at 30s
async function alert(text) {
console.log(text);
await fetch(discordWebhook, {
method: "POST",
headers: { "content-type": "application/json" },
body: JSON.stringify({ content: text }),
});
}
function connect() {
const url = `wss://api.blockscout.com/ws?${new URLSearchParams({ apikey: apiKey })}`;
const socket = new WebSocket(url);
socket.on("open", () => {
console.log(`Connected. Subscribing to ${watchAddress}...`);
reconnectDelay = 1000; // reset backoff on a successful connection
socket.send(JSON.stringify({
id: 1,
method: "subscribe",
params: {
topic: `addresses:${watchAddress}`,
chain_id: chainId,
},
}));
});
socket.on("message", async (data) => {
const message = JSON.parse(data.toString());
if (message.id === 1) {
if (message.result === "ok" || message.result === "already_subscribed") {
console.log("Subscribed. Waiting for transfers...");
} else {
console.error("Subscribe failed:", message.error);
}
return;
}
if (message.type !== "event") return;
// Native ETH transfers
if (message.data.event === "transaction") {
for (const tx of message.data.payload.transactions) {
const dedupKey = `tx:${tx.hash}`;
if (seen.has(dedupKey)) continue;
seen.add(dedupKey);
const value = BigInt(tx.value);
if (value < thresholdWei) continue;
const eth = Number(value) / 1e18;
const direction = tx.to?.hash?.toLowerCase() === watchAddress ? "IN" : "OUT";
await alert(
`π **Whale move detected** (${direction})\n${eth} ETH\nTx: https://robinhoodchain.blockscout.com/tx/${tx.hash}`
);
}
}
// Any token transfer: ERC-20, ERC-721, ERC-1155
if (message.data.event === "token_transfer") {
for (const transfer of message.data.payload.token_transfers) {
const dedupKey = `token:${transfer.transaction_hash}:${transfer.log_index}`;
if (seen.has(dedupKey)) continue;
seen.add(dedupKey);
const token = transfer.token;
const rawValue = transfer.total?.value;
// NFTs (ERC-721/1155) carry a token_id instead of a decimal value; alert on those unconditionally
if (rawValue === undefined || token?.decimals == null) {
const direction = transfer.to?.hash?.toLowerCase() === watchAddress ? "IN" : "OUT";
await alert(
`π **NFT transfer detected** (${direction})\n${token?.symbol ?? token?.name ?? "Unknown token"}\nTx: https://robinhoodchain.blockscout.com/tx/${transfer.transaction_hash}`
);
continue;
}
const amount = Number(rawValue) / 10 ** Number(token.decimals);
if (amount < tokenThreshold) continue;
const direction = transfer.to?.hash?.toLowerCase() === watchAddress ? "IN" : "OUT";
const symbol = token.symbol ?? token.name ?? "tokens";
await alert(
`π **Whale move detected** (${direction})\n${amount} ${symbol}\nTx: https://robinhoodchain.blockscout.com/tx/${transfer.transaction_hash}`
);
}
}
});
socket.on("error", (err) => console.error("Socket error:", err.message));
socket.on("close", (code, reason) => {
console.log(`Closed: ${code} ${reason.toString()}. Reconnecting in ${reconnectDelay / 1000}s...`);
setTimeout(connect, reconnectDelay);
reconnectDelay = Math.min(reconnectDelay * 2, 30000);
});
}
connect();
EOF
```
The reconnect logic is added to protect against random connection drops. If you're testing with multiple scripts open at once, close old ones before starting new ones, since too many open connections at the same time can itself cause drops.
**Run it:**
```bash theme={null}
node watch.js
```
You should see `Connected` and `Subscribed`, then silence until a matching transaction fires.
## Step 5: Trigger a real alert
**Native ETH transfer.** Open your wallet (MetaMask or similar), make sure it's connected to Robinhood Chain mainnet, and send 0.002 ETH to your watched address from any other wallet you control.
Within a second or two of the transaction confirming, your script logs the match and your Discord channel gets a message:
> π **Whale move detected** (IN) 0.002 ETH Tx: [https://robinhoodchain.blockscout.com/tx/0x](https://robinhoodchain.blockscout.com/tx/0x)...
**Token transfer.** If you hold any ERC-20 token on Robinhood Chain, sending even a fraction of one to your watched address triggers the token path instead. Open the token in your wallet the same way you would for any transfer, enter your watched address as the recipient, and send an amount above your `TOKEN_THRESHOLD`. If your wallet doesn't already show the token, you can add it manually using the token contract's address, findable on [robinhoodchain.blockscout.com](http://robinhoodchain.blockscout.com) under that token's page.
You'll see a matching Discord message naming the token symbol instead of ETH.
Whale watch is triggered by sending or receiving tokens from the identified address.
## Watching 10 wallets on one connection
A single WebSocket connection supports up to 100 subscriptions, so watching a whole list of wallets, say, ten known exchange or bridge addresses, is still only a single connection. Ten `subscribe` calls run on the same socket, and one shared handler figures out which address each incoming event belongs to.
To adjust from the single-address version, use the `topic` field the server echoes back on every event to know which watched address just moved.
Same as before, this creates a separate file, `watch-multi.js`, so paste the whole block into your terminal to write it:
```bash theme={null}
cat > watch-multi.js << 'EOF'
import WebSocket from "ws";
const apiKey = process.env.BLOCKSCOUT_API_KEY;
const discordWebhook = process.env.DISCORD_WEBHOOK_URL;
const chainId = "4663"; // Robinhood Chain mainnet
const thresholdWei = BigInt(process.env.THRESHOLD_WEI);
const tokenThreshold = Number(process.env.TOKEN_THRESHOLD);
// Comma-separated list of the 10 addresses to watch
const watchAddresses = process.env.WATCH_ADDRESSES
.split(",")
.map((a) => a.trim().toLowerCase());
const seen = new Set();
let reconnectDelay = 1000;
async function alert(text) {
console.log(text);
await fetch(discordWebhook, {
method: "POST",
headers: { "content-type": "application/json" },
body: JSON.stringify({ content: text }),
});
}
function connect() {
const url = `wss://api.blockscout.com/ws?${new URLSearchParams({ apikey: apiKey })}`;
const socket = new WebSocket(url);
socket.on("open", () => {
console.log(`Connected. Subscribing to ${watchAddresses.length} addresses...`);
reconnectDelay = 1000;
watchAddresses.forEach((address, i) => {
socket.send(JSON.stringify({
id: i + 1, // one id per subscription, so each confirmation maps back to an address
method: "subscribe",
params: {
topic: `addresses:${address}`,
chain_id: chainId,
},
}));
});
});
socket.on("message", async (data) => {
const message = JSON.parse(data.toString());
// Subscription confirmations: ids 1..N map back to watchAddresses[id - 1]
if (typeof message.id === "number") {
const address = watchAddresses[message.id - 1];
if (message.result === "ok" || message.result === "already_subscribed") {
console.log(`Subscribed: ${address}`);
} else {
console.error(`Subscribe failed for ${address}:`, message.error);
}
return;
}
if (message.type !== "event") return;
// message.topic tells you which of the 10 addresses this event belongs to
const watchedAddress = message.topic.replace("addresses:", "");
if (message.data.event === "transaction") {
for (const tx of message.data.payload.transactions) {
const dedupKey = `tx:${tx.hash}`;
if (seen.has(dedupKey)) continue;
seen.add(dedupKey);
const value = BigInt(tx.value);
if (value < thresholdWei) continue;
const eth = Number(value) / 1e18;
const direction = tx.to?.hash?.toLowerCase() === watchedAddress ? "IN" : "OUT";
await alert(
`π **Whale move detected** (${direction})\nWatched: ${watchedAddress}\n${eth} ETH\nTx: https://robinhoodchain.blockscout.com/tx/${tx.hash}`
);
}
}
if (message.data.event === "token_transfer") {
for (const transfer of message.data.payload.token_transfers) {
const dedupKey = `token:${transfer.transaction_hash}:${transfer.log_index}`;
if (seen.has(dedupKey)) continue;
seen.add(dedupKey);
const token = transfer.token;
const rawValue = transfer.total?.value;
const direction = transfer.to?.hash?.toLowerCase() === watchedAddress ? "IN" : "OUT";
if (rawValue === undefined || token?.decimals == null) {
await alert(
`π **NFT transfer detected** (${direction})\nWatched: ${watchedAddress}\n${token?.symbol ?? token?.name ?? "Unknown token"}\nTx: https://robinhoodchain.blockscout.com/tx/${transfer.transaction_hash}`
);
continue;
}
const amount = Number(rawValue) / 10 ** Number(token.decimals);
if (amount < tokenThreshold) continue;
const symbol = token.symbol ?? token.name ?? "tokens";
await alert(
`π **Whale move detected** (${direction})\nWatched: ${watchedAddress}\n${amount} ${symbol}\nTx: https://robinhoodchain.blockscout.com/tx/${transfer.transaction_hash}`
);
}
}
});
socket.on("error", (err) => console.error("Socket error:", err.message));
socket.on("close", (code, reason) => {
console.log(`Closed: ${code} ${reason.toString()}. Reconnecting in ${reconnectDelay / 1000}s...`);
setTimeout(connect, reconnectDelay);
reconnectDelay = Math.min(reconnectDelay * 2, 30000);
});
}
connect();
EOF
```
**Run it with ten addresses:**
```bash theme={null}
export WATCH_ADDRESSES="0xAddr1,0xAddr2,0xAddr3,0xAddr4,0xAddr5,0xAddr6,0xAddr7,0xAddr8,0xAddr9,0xAddr10"
node watch-multi.js
```
You'll see ten `Subscribed: 0x...` lines on startup, one per address, then a single stream of alerts tagged with whichever address triggered each one. Test it the same way as before, a small ETH or token transfer to any one of the ten addresses shows up in Discord within a second or two, with that address named in the message so you know which wallet moved.
## Taking the script to production
A few more things worth doing before you use this for real trading decisions:
* **Keep the dedup set bounded.** `seen` in this example grows forever; in a long-running process, cap it or expire entries after a few minutes. A `Map` storing when each key was first seen, swept periodically, does this cleanly within the code.
```js theme={null}
const seen = new Map(); // dedupKey -> timestamp
const DEDUP_TTL_MS = 5 * 60 * 1000; // forget entries after 5 minutes
function wasSeen(key) {
if (seen.has(key)) return true;
seen.set(key, Date.now());
return false;
}
setInterval(() => {
const cutoff = Date.now() - DEDUP_TTL_MS;
for (const [key, timestamp] of seen) {
if (timestamp < cutoff) seen.delete(key);
}
}, 60 * 1000);
```
Swap `if (seen.has(dedupKey)) continue; seen.add(dedupKey);` for `if (wasSeen(dedupKey)) continue;` wherever it appears above.
* **Add context to the alert**, with more than just the raw number. Whale Alert's alerts are useful because they name the sending and receiving wallets when known (an exchange, a bridge). Pulling `/api/v2/addresses/{hash}` for a name tag before sending the Discord message turns "0.06 ETH moved" into "0.06 ETH moved from Coinbase hot wallet," which is a meaningfully more useful signal. This code snippet can be added to the above code to provide more context.
```js theme={null}
async function getLabel(address) {
const res = await fetch(
`https://api.blockscout.com/4663/api/v2/addresses/${address}?apikey=${apiKey}`
);
const data = await res.json();
return data.metadata?.tags?.[0]?.name ?? data.ens_domain_name ?? null;
}
// Inside the alert-building code, before sending to Discord:
const label = await getLabel(tx.from.hash);
const fromText = label ? `${tx.from.hash} (${label})` : tx.from.hash;
await alert(
`π **Whale move detected** (${direction})\n${eth} ETH\nFrom: ${fromText}\nTx: https://robinhoodchain.blockscout.com/tx/${tx.hash}`
);
```
Most addresses won't have a known label, in which case `getLabel` just returns `null` and the alert falls back to the plain address, so this only adds detail when there's additional detail to add.
## Start building
* Get a free Pro API key: [dev.blockscout.com](http://dev.blockscout.com)
* Full WebSocket API reference: [https://docs.blockscout.com/devs/apis/websocket-api](https://docs.blockscout.com/devs/apis/websocket-api)
* Explore Robinhood Chain: [robinhoodchain.blockscout.com](http://robinhoodchain.blockscout.com)
Epoch [364032](https://beaconcha.in/epoch/364032) | EIP-7702 enables externally owned accounts (EOAs) to temporarily execute smart contract code, allowing transaction batching, gas sponsorship, and alternative authentication methods. EIP-7251 raises maximum validator balance from 32 ETH to 2048 ETH for reward compounding. EIP-7691 doubles blob throughput (target: 3β6, max: 6β9 blobs per block) to enhance Layer 2 scaling. EIP-2537 adds BLS12-381 curve operations for efficient cryptographic verification. EIP-7002 enables execution layer triggerable validator exits. EIP-6110 reduces validator deposit processing delay from \~9 hours to \~13 minutes. | β’ [EIP-2537](https://eips.ethereum.org/EIPS/eip-2537)
β’ [EIP-2935](https://eips.ethereum.org/EIPS/eip-2935)
β’ [EIP-6110](https://eips.ethereum.org/EIPS/eip-6110)
β’ [EIP-7002](https://eips.ethereum.org/EIPS/eip-7002)
β’ [EIP-7251](https://eips.ethereum.org/EIPS/eip-7251)
β’ [EIP-7549](https://eips.ethereum.org/EIPS/eip-7549)
β’ [EIP-7623](https://eips.ethereum.org/EIPS/eip-7623)
β’ [EIP-7685](https://eips.ethereum.org/EIPS/eip-7685)
β’ [EIP-7691](https://eips.ethereum.org/EIPS/eip-7691)
β’ [EIP-7702](https://eips.ethereum.org/EIPS/eip-7702)
β’ [EIP-7840](https://eips.ethereum.org/EIPS/eip-7840) | | Cancun | 13 Mar 2024 | [19,426,587](https://eth.blockscout.com/block/19426587) | The block's blob base fee ([EIP-7516](https://eips.ethereum.org/EIPS/eip-7516) and [EIP-4844](https://eips.ethereum.org/EIPS/eip-4844)) can be accessed via the global `block.blobbasefee` or `blobbasefee()` in inline assembly. Introduces `blobhash()` in inline assembly and a corresponding global function to retrieve versioned hashes of blobs associated with the transaction (see [EIP-4844](https://eips.ethereum.org/EIPS/eip-4844)). Opcode `mcopy` is available in assembly (see [EIP-5656](https://eips.ethereum.org/EIPS/eip-5656)). Opcodes `tstore` and `tload` are available in assembly (see [EIP-1153](https://eips.ethereum.org/EIPS/eip-1153)). | β’ [EIP-1153](https://eips.ethereum.org/EIPS/eip-1153)
β’ [EIP-4788](https://eips.ethereum.org/EIPS/eip-4788)
β’ [EIP-4844](https://eips.ethereum.org/EIPS/eip-4844)
β’ [EIP-5656](https://eips.ethereum.org/EIPS/eip-5656)
β’ [EIP-6780](https://eips.ethereum.org/EIPS/eip-6780)
β’ [EIP-7516](https://eips.ethereum.org/EIPS/eip-7516) | | Shanghai | 12 Apr 2023 | [17,034,870](https://eth.blockscout.com/block/17034870) | Smaller code size and gas savings due to the introduction of `push0` (see [EIP-3855](https://eips.ethereum.org/EIPS/eip-3855)). | β’ [EIP-3651](https://eips.ethereum.org/EIPS/eip-3651)
β’ [EIP-3855](https://eips.ethereum.org/EIPS/eip-3855)
β’ [EIP-3860](https://eips.ethereum.org/EIPS/eip-3860)
β’ [EIP-4895](https://eips.ethereum.org/EIPS/eip-4895)
β’ [EIP-6049](https://eips.ethereum.org/EIPS/eip-6049) | | Paris (The Merge) | 15 Sep 2022 | [15,537,394](https://eth.blockscout.com/block/15537394) | Introduces `prevrandao()` and `block.prevrandao`, and changes the semantics of the now deprecated `block.difficulty`, disallowing `difficulty()` in inline assembly (see [EIP-4399](https://eips.ethereum.org/EIPS/eip-4399)). | β’ [EIP-3675](https://eips.ethereum.org/EIPS/eip-3675)
β’ [EIP-4399](https://eips.ethereum.org/EIPS/eip-4399) | | *Gray Glacier\** | 30 June 2022 | [15,050,000](https://eth.blockscout.com/block/15050000) | Delays the difficulty bomb by an additional 3 months to September 2022. | [https://eips.ethereum.org/EIPS/eip-5133](https://eips.ethereum.org/EIPS/eip-5133) | | *Arrow Glacier\** | 09 Aug 2021 | [13,773,000](https://eth.blockscout.com/block/13773000) | Delays the difficulty bomb until June 2022. | [https://eips.ethereum.org/EIPS/eip-4345](https://eips.ethereum.org/EIPS/eip-4345) | | London | 05 Aug 2021 | [12,965,000](https://eth.blockscout.com/block/12965000) | The block's base fee ([EIP-3198](https://eips.ethereum.org/EIPS/eip-3198) and [EIP-1559](https://eips.ethereum.org/EIPS/eip-1559)) can be accessed via the global `block.basefee` or `basefee()` in inline assembly. | β’ [EIP-1559](https://eips.ethereum.org/EIPS/eip-1559)
β’ [EIP-3198](https://eips.ethereum.org/EIPS/eip-3198)
β’ [EIP-3529](https://eips.ethereum.org/EIPS/eip-3529)
β’ [EIP-3541](https://eips.ethereum.org/EIPS/eip-3541)
β’ [EIP-3554](https://eips.ethereum.org/EIPS/eip-3554) | | Berlin | 14 Apr 2021 | [12,244,000](https://eth.blockscout.com/block/12244000) | Gas costs for `SLOAD`, `*CALL`, `BALANCE`, `EXT*` and `SELFDESTRUCT` increased. The compiler assumes cold gas costs for such operations. This is relevant for gas estimation and the optimizer. | [https://eips.ethereum.org/EIPS/eip-2070](https://eips.ethereum.org/EIPS/eip-2070) | | Istanbul | 08 Dec 2019 | [9,069,000](https://eth.blockscout.com/block/9069000) | Opcodes `chainid` and `selfbalance` are available in assembly. | [https://eips.ethereum.org/EIPS/eip-1679](https://eips.ethereum.org/EIPS/eip-1679) | | Constantinople / Petersburg | 28 Feb 2019 | [7,280,000](https://eth.blockscout.com/block/7280000) | Opcodes `create2`, `extcodehash`, `shl`, `shr` and `sar` are available in assembly. Bitwise shifting operators use shifting opcodes (`shl`,`shr`,`sar`), requiring less gas. | [http://eips.ethereum.org/EIPS/eip-1013](http://eips.ethereum.org/EIPS/eip-1013) | | Byzantium | 16 Oct 2017 | [4,370,000](https://eth.blockscout.com/block/4370000) | Opcodes `returndatacopy`, `returndatasize` and `staticcall` available in assembly. `staticcall` opcode used when calling non-library view or pure functions, which prevents the functions from modifying state at the EVM level, this even applies to invalid type conversions. Ability to access dynamic data returned from function calls. `revert` opcode introduced, `revert()` will not waste gas. | [http://eips.ethereum.org/EIPS/eip-609](http://eips.ethereum.org/EIPS/eip-609) | | Spurious Dragon | 22 Nov 2016 | [2,675,000](https://eth.blockscout.com/block/2675000) | Gas cost for the `exp` opcode increased, impacts gas estimation and optimization. | [http://eips.ethereum.org/EIPS/eip-607](http://eips.ethereum.org/EIPS/eip-607) | | Tangerine Whistle | 18 Oct 2016 | [2,463,000](https://eth.blockscout.com/block/2463000) | Gas cost to access other accounts increased, impacts gas estimation and optimization. All gas sent by default for external calls, previously a certain amount had to be retained. | [http://eips.ethereum.org/EIPS/eip-608](http://eips.ethereum.org/EIPS/eip-608) | | Homestead | 14 Mar 2016 | [1,150,000](https://eth.blockscout.com/block/1150000) | Oldest version | [http://eips.ethereum.org/EIPS/eip-606](http://eips.ethereum.org/EIPS/eip-606) | # Indexer Architecture Overview Source: https://docs.blockscout.com/setup/information-and-settings/indexer-architecture-overview Overview of Blockscout indexer architecture: realtime and catchup indexers, secondary and on-demand fetchers, and chain-specific integrations.
β’ `trace_block` (fetching of block rewards) | | Geth | β’ `debug_traceBlockByNumber`
β’ or `debug_traceTransaction`
`callTracer` is used by default, starting from the Blockscout 5.1.0 release. To switch to a custom JS tracer, the Blockscout maintainer should set the `export INDEXER_INTERNAL_TRANSACTIONS_TRACER_TYPE=js` environment variable. Prior to the 5.1.0 release, js tracer was a default option. | | RSK | β’ `trace_block` (fetching of internal transactions) | ### JSON RPC Performance Benchmarks Time measures for response time of crucial JSON RPC methods for indexing in Blockscout. [Ways to improve speed](/faqs/faqs#how-do-i-speed-up-my-self-hosted-instance). 1. `eth_getBlockByNumber` without transaction receipts for a block with 15 transactions: Desired response time is \< 0.5s. For instance, in case of the Gnosis chain archive node, the response time for the block with \~20 transactions is \~0.4s. 2. `eth_getTransactionReceipt` for random transactions desired response time is \< 0.5s. For the Gnosis chain archive node the response time is \~0.3 - 0.4s. 3. Batched `eth_getTransactionReceipt` for 15 transactions acceptable response time is less than 1s. For the Gnosis chain archive node, it is \~0.6 - 0.7s. ### Rate Limit The desired rate limit for RPC endpoint is 200 req/sec for the indexing phase and 100 req/sec for the indexed chain. ### EVM Requirements & Clients * All EVM chains must [define these variables](/setup/env-variables#required-env-variables) during configuration. * BlockScout currently supports Erigon, Geth, Nethermind, Hyperledger Besu, and Anvil clients. Define the node variant using the `ETHEREUM_JSONRPC_VARIANT` environment variable. [More information](/setup/requirements/client-settings) ### L2 -> L1 JSON RPC Methods * Find information on JSON RPC method use with [different L2 types.](/setup/requirements/l2-greater-than-l1-json-rpc-method-requests) # General backend requirements and prerequisites Source: https://docs.blockscout.com/setup/requirements/requirements Software dependencies (Erlang, Elixir, PostgreSQL, Node.js, GCC, GMP, and more) required to install and run the Blockscout backend.
*Note*: Application versions earlier than v12 also support PostgreSQL 12 and 13. | | [Node.js 20.x.x](https://nodejs.org/en/) | `brew install node` | [Node.js Install Example](https://github.com/poanetwork/blockscout-terraform/blob/33f68e816e36dc2fb055911fa0372531f0e956e7/modules/stack/libexec/init.sh#L66) | | [Automake](https://www.gnu.org/software/automake/) | `brew install automake` | [Automake Install Example](https://github.com/poanetwork/blockscout-terraform/blob/33f68e816e36dc2fb055911fa0372531f0e956e7/modules/stack/libexec/init.sh#L72) | | [Libtool](https://www.gnu.org/software/libtool/) | `brew install libtool` | [Libtool Install Example](https://github.com/poanetwork/blockscout-terraform/blob/33f68e816e36dc2fb055911fa0372531f0e956e7/modules/stack/libexec/init.sh#L62) | | [Inotify-tools](https://github.com/rvoicilas/inotify-tools/wiki) | Not Required | Ubuntu - `apt-get install inotify-tools` | | [GCC Compiler](https://gcc.gnu.org/) | `brew install gcc` | [GCC Compiler Example](https://github.com/poanetwork/blockscout-terraform/blob/33f68e816e36dc2fb055911fa0372531f0e956e7/modules/stack/libexec/init.sh#L70) | | [GMP](https://gmplib.org/) | `brew install gmp` | [Install GMP Devel](https://github.com/poanetwork/blockscout-terraform/blob/33f68e816e36dc2fb055911fa0372531f0e956e7/modules/stack/libexec/init.sh#L74) | | [Ffmpeg](https://ffmpeg.org/) | `brew install ffmpeg@7` | `sudo apt install ffmpeg` if Debian | | Make | - | `sudo apt install make` if Debian | | G++ Compiler | - | `sudo apt install g++` if Debian | Additional requirements for Blockscout versions below 5.1.3: | Dependency | Mac | Linux | | - | - | - | | Rust | - | [Install Rust](https://www.rust-lang.org/tools/install) | | Cargo | - | Ubuntu - `apt-get install cargo` | # Hardware & Hosting Requirements Source: https://docs.blockscout.com/setup/requirements/resource-requirements Recommended CPU, RAM, disk, and AWS EC2/RDS PostgreSQL baseline sizing for hosting a Blockscout explorer with an EVM archive node backend. Resource requirements may vary based on chain size and other parameters. This mainly impacts [database storage](/setup/requirements/database-storage-requirements) requirements. Basic [prerequisites](/setup/requirements/requirements) and settings can be found throughout the [Information and Settings](/setup/information-and-settings) section for developers. BlockScout requires a full archive node to import every state change for every address on the target network. ## Recommended Base Hardware EVM chains can differ in size and requirements, these are the recommendations for optimal performance. | CPU | 16 core, 32 thread | | - | - | | RAM | 128GB | ## Hosting Requirements Minimums are listed for an AWS Cloud instance and can be inferred to other hosting providers. | | | | - | - | | Application | β’ 1x EC2 m5a.xlarge instance running Linux
β’ 8GB of EBS General Purpose SSD (NVMe) | | Database | β’ 1x RDS Database running on db.t3.large using PostgreSQL v14+
β’ 500GB of General Purpose SSD (depending on chain size)
β’ See [Database Storage Requirements](/setup/requirements/database-storage-requirements) for chain-relevant baselines. | | Amazon Elastic Load Balancing | β’ Average 100 new connections/sec per Elastic Load Balancer |
- `indexer`
`mix do ecto.create --quiet, ecto.migrate && cd apps/indexer && mix do compile, test --no-start && cd -`
- `explorer`
`mix do ecto.create --quiet, ecto.migrate && cd apps/explorer && mix do compile, test --no-start && cd -`
- `block_scout_web`
`mix do ecto.create --quiet, ecto.migrate && cd apps/block_scout_web && mix do compile, test --no-start && cd -`
- `ethereum_jsonrpc`
`mix do ecto.create --quiet, ecto.migrate && cd apps/ethereum_jsonrpc && mix do compile, test --no-start && cd -` ### **Nethermind** **Mox** **This is the default setup.** `mix test --no-start` **will work on its own, but to be explicit, use the following setup**: ```bash theme={null} ETHEREUM_JSONRPC_CASE=EthereumJSONRPC.Case.Nethermind.Mox \ ETHEREUM_JSONRPC_WEB_SOCKET_CASE=EthereumJSONRPC.WebSocket.Case.Mox \ mix test --no-start --exclude no_nethermind ``` **HTTP / WebSocket** ```bash theme={null} ETHEREUM_JSONRPC_CASE=EthereumJSONRPC.Case.Nethermind.HTTPWebSocket \ ETHEREUM_JSONRPC_WEB_SOCKET_CASE=EthereumJSONRPC.WebSocket.Case.Nethermind \ mix test --no-start --exclude no_nethermind ``` | Protocol | URL | | - | - | | HTTP | `http://localhost:8545` | | WebSocket | `ws://localhost:8546` | ### **Geth** **Mox** ```bash theme={null} ETHEREUM_JSONRPC_CASE=EthereumJSONRPC.Case.Geth.Mox \ ETHEREUM_JSONRPC_WEB_SOCKET_CASE=EthereumJSONRPC.WebSocket.Case.Mox \ mix test --no-start --exclude no_geth ``` **HTTP / WebSocket** ```bash theme={null} ETHEREUM_JSONRPC_CASE=EthereumJSONRPC.Case.Geth.HTTPWebSocket \ ETHEREUM_JSONRPC_WEB_SOCKET_CASE=EthereumJSONRPC.WebSocket.Case.Geth \ mix test --no-start --exclude no_geth ``` | Protocol | URL | | - | - | | HTTP | `https://mainnet.infura.io/8lTvJTKmHPCHazkneJsY` | | WebSocket | `wss://mainnet.infura.io/ws/8lTvJTKmHPCHazkneJsY` | # Soneium API Source: https://docs.blockscout.com/soneium-api Blockscout is Soneium's primary block explorer. Full API access for Sony's OP Stack Ethereum L2 mainnet and Minato testnet with free and paid tiers. # Soneium API β Block Explorer API for Sony's Ethereum L2 | Blockscout > Blockscout is the primary explorer for Soneium. Full API access for mainnet and Minato testnet β free and paid tiers. ## Soneium API Access with Blockscout Soneium is Sony's Ethereum Layer 2, built on the OP Stack and developed through Sony Block Solutions Labs in partnership with Startale Group. It connects Sony's entertainment and consumer electronics businesses β spanning gaming, music, film, and digital media β with onchain infrastructure. Since its mainnet launch in January 2025, Soneium has processed over 500 million transactions, onboarded 5.4 million active wallets, and hosts more than 250 decentralized applications focused on fan engagement, digital collectibles, IP licensing, and AI-powered creative tools. Startale closed a \$63M Series A in March 2026 led by Sony Innovation Fund with participation from Samsung Next, UOB Venture Management, and SBI Holdings β signaling serious long-term institutional backing. Blockscout is Soneium's primary block explorer. Etherscan does not support Soneium. If you're building on Soneium, Blockscout provides your API β on both mainnet and the Minato testnet. **Soneium Mainnet Chain ID:** `1868` **Soneium Minato Testnet Chain ID:** `1946` | Network | Explorer | PRO API `chainid` | | - | - | - | | Soneium Mainnet | [soneium.blockscout.com](https://soneium.blockscout.com) | `1868` | | Soneium Minato Testnet | [soneium-minato.blockscout.com](https://soneium-minato.blockscout.com) | `1946` | **PRO API Base:** `https://api.blockscout.com` (use `chainid=1868` or `chainid=1946`) ## Quick Start Get your first API response in under 60 seconds: ```bash theme={null} # Mainnet β get ETH balance for an address curl "https://api.blockscout.com/v2/api?chainid=1868&module=account&action=balance&address=0xYOUR_ADDRESS&apikey=proapi_YOUR_KEY" # Minato Testnet β same call, different chainid curl "https://api.blockscout.com/v2/api?chainid=1946&module=account&action=balance&address=0xYOUR_ADDRESS&apikey=proapi_YOUR_KEY" ``` Get a free API key at [dev.blockscout.com](https://dev.blockscout.com). It is required for all PRO API tiers, including the free tier. The same key works for both mainnet and testnet, and any other chains you want to query. ## PRO API Routes for Soneium ### Mainnet (chainid=1868) **JSON RPC v2 (Etherscan-compatible):** ```text theme={null} https://api.blockscout.com/v2/api?chainid=1868&module=account&action=txlist&address=0x...&apikey=proapi_xxx ``` **JSON RPC:** ```text theme={null} https://api.blockscout.com/1868/api?module=account&action=txlist&address=0x...&apikey=proapi_xxx ``` **REST API:** ```text theme={null} https://api.blockscout.com/1868/api/v2/addresses/0x.../transactions?apikey=proapi_xxx ``` **ETH RPC (POST):** ```bash theme={null} curl -H "content-type: application/json" \ -H "authorization: Bearer proapi_xxx" \ -X POST \ --data '{"id":0,"jsonrpc":"2.0","method":"eth_blockNumber","params":[]}' \ https://api.blockscout.com/1868/json-rpc ``` ### Minato Testnet (chainid=1946) Every route works identically β swap `1868` for `1946`: ```text theme={null} https://api.blockscout.com/v2/api?chainid=1946&module=account&action=txlist&address=0x...&apikey=proapi_xxx ``` ```text theme={null} https://api.blockscout.com/1946/api/v2/addresses/0x.../transactions?apikey=proapi_xxx ``` As an OP Stack chain, the PRO API also includes OP-specific endpoints under the `optimism` module for rollup data like deposits, withdrawals, and batch submissions. ## Available Endpoints ### Etherscan-Compatible Modules Standard Etherscan-compatible modules work out of the box on both mainnet and testnet: * **Account** β Balances, transaction lists, token transfers, internal transactions, ERC-20/721/1155 activity (plus Blockscout extras: `eth_get_balance`, `pendingtxlist`, `tokenbalance`, `tokenlist`) * **Contract** β ABI, source code, verification (plus: `listcontracts`, `getcontractcreation`, Vyper & Sourcify verification) * **Transaction** β Status checks (plus: `gettxinfo`) * **Logs** β Event logs with filtering by address, topics, block range * **Token** β Token metadata, holders * **Stats** β Supply, chain statistics, coin price * **Block** β Block rewards, countdown, block number by time * **Gas Tracker** β Gas oracle, gas estimates ### REST API Blockscout's REST API extends beyond the Etherscan-compatible interface with enriched metadata, decoded input data, NFT media and attributes, smart contract read/write interaction, and chain indexing status. **β [Mainnet REST API Reference](https://soneium.blockscout.com/api-docs)** Β· **β [Minato REST API Reference](https://soneium-minato.blockscout.com/api-docs)** ## Soneium API Pricing | Tier | Rate Limit | Credits | Price | | - | - | - | - | | Free | 5 RPS | 100K/day | \$0 | | Builder | 15 RPS | 100M/mo | \$49/mo | | Pro | 30 RPS | 500M/mo | \$199/mo | | Business | 50 RPS | 3B/mo | \$999/mo | | Enterprise | Custom | Custom | Contact us | One API key covers Soneium mainnet, Minato testnet, and every other Blockscout-supported chain β 117 networks total. Testnet calls consume credits from the same pool. ## Coming from Other OP Stack Chains? Soneium uses the same OP Stack infrastructure that powers Base, Optimism, Zora, and Ink. If you've built on any Superchain network with the Blockscout PRO API, querying Soneium is a `chainid` swap: ```javascript theme={null} // Multichain across the Superchain β one function, one API key const BLOCKSCOUT_KEY = process.env.BLOCKSCOUT_KEY; const CHAINS = { soneium: 1868, soneium_testnet: 1946, base: 8453, optimism: 10, ink: 57073, zora: 7777777, }; async function getTokenTransfers(chainName, address) { const chainId = CHAINS[chainName]; const resp = await fetch( `https://api.blockscout.com/v2/api?chainid=${chainId}&module=account&action=tokentx&address=${address}&apikey=${BLOCKSCOUT_KEY}` ); return resp.json(); } // Query Soneium mainnet const mainnetTxns = await getTokenTransfers("soneium", "0x..."); // Test against Minato first β same function, same key const testnetTxns = await getTokenTransfers("soneium_testnet", "0x..."); ``` If you're migrating from Etherscan V2 on another chain, the structure is nearly identical. Etherscan uses `api.etherscan.io/v2/api?chainid=X`, Blockscout uses `api.blockscout.com/v2/api?chainid=X`. But Etherscan doesn't support Soneium at all β Blockscout is your only option. **β [Full Migration Guide](https://docs.blockscout.com/devs/migrate-from-etherscan)** ## Developing on Soneium Minato Testnet Minato provides a full sandbox environment that mirrors mainnet conditions. Developers use it to validate contracts, test bridge flows, and iterate on dApps before deploying to production. Blockscout covers the testnet with the same explorer and API infrastructure as mainnet. **Testnet workflow with the PRO API:** ```python theme={null} import requests BLOCKSCOUT_KEY = os.environ["BLOCKSCOUT_KEY"] def query_soneium(chainid, module, action, **params): """Query either Soneium mainnet (1868) or Minato testnet (1946).""" resp = requests.get("https://api.blockscout.com/v2/api", params={ "chainid": chainid, "module": module, "action": action, "apikey": BLOCKSCOUT_KEY, **params }) return resp.json() # Verify your contract ABI is accessible on testnet before mainnet deploy testnet_abi = query_soneium(1946, "contract", "getabi", address="0xYOUR_CONTRACT") # After mainnet deploy, same call with chainid=1868 mainnet_abi = query_soneium(1868, "contract", "getabi", address="0xYOUR_CONTRACT") ``` **Getting testnet ETH:** Soneium Minato uses Sepolia ETH bridged via the [Soneium testnet bridge](https://bridge.soneium.org/testnet). Faucets are also available through [Chainlink](https://faucets.chain.link/soneium-minato) and other providers. ## What Developers Build on Soneium with Blockscout's API **Entertainment & Fan Engagement** β Soneium's core thesis is onchain entertainment. Developers building fan platforms, digital collectibles, loyalty programs, and creator tools need API access to token data, NFT metadata, and transaction history tied to Sony IP ecosystems. Projects like KAMI (programmable digital IP objects) and IDOL RUNWAY COLLECTION are already live. **Stablecoin & Payments Infrastructure** β Startale USD (USDSC) is live as Soneium's native settlement layer, and a JPY-denominated stablecoin (JPYSC) is in development for cross-border payments across Asia-Pacific. Developers are building payment flows that query transaction status, token balances, and transfer events through the API. **Mini Apps & the Startale Super-App** β The Startale App integrates wallet management, dApp access, and asset management in a single interface, with Mini Apps built by third-party developers. These Mini Apps use explorer APIs for wallet data, transaction confirmation, and contract interaction. **AI & Creator Tools** β Soneium's focus on entertainment IP attracts AI-driven creative applications. Blockscout's PRO API and MCP server provide structured onchain data for agents operating in the creator economy β from automated royalty tracking to AI-generated NFT minting flows. **Gaming & Digital Twins** β Sony and Startale are testing high-fidelity digital twins and NFT-based ticketing systems natively integrated into Soneium, bridging physical events with digital ownership. Game studios building on Soneium use the API for in-game economy tracking, item transfers, and player wallet queries. ## Soneium on Blockscout Blockscout is the primary explorer for both Soneium mainnet and Minato testnet. As part of the OP Superchain, Soneium benefits from Blockscout's native support for cross-chain transaction tracking, deposit/withdrawal views, and Superchain interoperability features. The \$63M Series A and backing from Sony, Samsung, UOB, and SBI signal institutional confidence that Soneium is here to stay. For developers building at the intersection of entertainment, IP, and blockchain, Soneium on Blockscout provides the infrastructure to power applications backed by some of the world's largest entertainment and financial companies. ## Get Started 1. Get a free API key at [**dev.blockscout.com**](https://dev.blockscout.com) 2. Use `chainid=1946` (Minato testnet) to develop and test 3. Switch to `chainid=1868` (mainnet) when you're ready to deploy 4. Explore endpoints at [**soneium.blockscout.com/api-docs**](https://soneium.blockscout.com/api-docs) **β [Start Building on Soneium](https://dev.blockscout.com)** Β· **β [PRO API Routes Reference](https://docs.blockscout.com/devs/pro-api-responses-and-routes)** Β· **β [Soneium Developer Docs](https://docs.soneium.org/docs/builders/overview)** # Autoscout Explorer Launchpad Source: https://docs.blockscout.com/using-blockscout/autoscout Autoscout is Blockscout's self-serve launchpad to deploy a production-ready hosted block explorer for EVM chains and rollups in minutes.
(Blobs) | Blob carrying transaction | Accommodate batched data | ## Input Data Fields | Field | Description | Format/Example | Purpose | | :- | :- | :- | :- | | **Input Data** | Data payload sent with transaction | Hexadecimal string | Contains function calls and parameters | | **Method ID** | First 4 bytes identifying contract function | 4-byte hex (e.g., 0xa9059cbb) | Identifies which contract function was called | | **Input Data (Hex)** | Raw hexadecimal data | 0x followed by hex characters | Raw transaction data | | **Input Data (UTF-8)** | Human-readable text format | Plain text (when applicable) | Readable version of data | | **Input Data (Decoded)** | Function calls with parameter names | Function name and parameters | User-friendly view of contract interactions | ## Token Transfer Fields | Field | Description | Format/Example | Purpose | | :- | :- | :- | :- | | **Token Name** | Name of the transferred token | Text (e.g., "USD Coin") | Identifies the token being transferred | | **Token Symbol** | Token's ticker symbol | Text (e.g., "USDC") | Short identifier for the token | | **Token Amount** | Quantity of tokens transferred | Number with decimals | Amount being moved | | **Token Type** | Standard used for the token | ERC-20, ERC-721, ERC-1155 | Indicates token functionality | | **From Address** | Token sender address | 42-character hex string | Who sent the tokens | | **To Address** | Token recipient address | 42-character hex string | Who received the tokens | | **Token Contract** | Address of the token's smart contract | 42-character hex string | Contract managing this token | ## Event Logs Fields | Field | Description | Format/Example | Purpose | | :- | :- | :- | :- | | **Log Index** | Sequential numbering of events | Number (e.g., 0, 1, 2) | Order of events within transaction | | **Contract Address** | Address that emitted the event | 42-character hex string | Source of the event | | **Event Name** | Name of the emitted event | Text (e.g., "Transfer") | Type of event that occurred | | **Topics** | Indexed event parameters | Array of hex strings | Searchable event data | | **Data** | Non-indexed event data | Hex string | Additional event information | | **Decoded Logs** | Human-readable event information | Structured data | User-friendly view of events | ## State Changes Fields | Field | Description | Format/Example | Purpose | | :- | :- | :- | :- | | **Address** | Account that changed | 42-character hex string | Which account was modified | | **Storage Changes** | Before and after values | Hex values | What data changed in storage | | **Balance Changes** | ETH balance modifications | ETH amounts | How balances changed | | **Nonce Changes** | Account nonce updates | Number changes | Transaction counter updates | ## Status Indicators | Status | Visual Indicator | Meaning | Next Steps | | :- | :- | :- | :- | | **Success** | Green checkmark | Transaction completed successfully | Transaction is final | | **Failed** | Red X | Transaction failed during execution | Check revert reason, retry if needed | | **Pending** | Orange clock | Transaction waiting to be mined | Wait for confirmation or increase gas | | **Dropped** | Gray indicator | Transaction removed from mempool | Resubmit with higher gas price | ## Additional Information Fields | Field | Description | Format/Example | Purpose | | :- | :- | :- | :- | | **Block Hash** | Unique identifier for the block | 66-character hex string | Reference to containing block | | **Block Timestamp** | When the block was mined | UTC timestamp | Block creation time | | **Transaction Receipt** | Proof of transaction processing | JSON data | Technical execution details | | **Raw Transaction** | Complete transaction data | JSON format | Developer-level transaction info | | **Revert Reason** | Error message for failed transactions | Text description | Explains why transaction failed | ## Common Transaction Patterns | Pattern | From Address | To Address | Value | Input Data | Tokens Transferred | | :- | :- | :- | :- | :- | :- | | **Simple ETH Transfer** | User wallet | User wallet | > 0 ETH | Empty/minimal | None | | **Token Transfer** | User wallet | Token contract | 0 ETH | Function call | Token amount | | **Contract Interaction** | User wallet | Contract | 0 ETH | Function data | Possibly tokens | | **Contract Creation** | User wallet | null | 0 ETH | Contract bytecode | None | | **Multi-token Transfer** | User wallet | Contract | 0 ETH | Function call | Multiple tokens | ## Troubleshooting Guide | Issue | Possible Causes | What to Check | | :- | :- | :- | | **Transaction Not Found** | Wrong hash, wrong network, too recent | Verify hash, check network, wait for indexing | | **Failed Transaction** | Out of gas, revert, invalid input | Check gas limit, read revert reason, verify input | | **High Gas Fees** | Network congestion, complex operation | Check gas price, simplify transaction, wait for lower fees | | **Pending Too Long** | Low gas price, network issues | Increase gas price, check network status | | **Wrong Token Amount** | Decimal confusion, display issue | Check token decimals, verify actual amount | **Quick Reference:** Use Ctrl+F to search for specific field names in this guide. All fields are organized by the section they appear in on the Blockscout transaction page. # Transaction Types: Blob, Coin, Contract, and Token Source: https://docs.blockscout.com/using-blockscout/overviews/transaction-types How Blockscout categorizes transactions including blob (EIP-4844), coin transfer, contract call, contract creation, token transfer, minting, and burning. Different types of transactions are categorized in the Blockscout UI to allow for quick identification. Types include: * **Blob txn:** 4844-type transactions which include large amounts of data * **Coin transfer**: value transfer, value >= 0, no tx input * **Contract call**: tx input is present (any value including 0) * **Contract creation**: creation of a smart-contract * **Token burning**: recognized token transfer of any of ERC-20, 721, 1155 token instance (single or bulk) to 0x0000... address * **Token creation**: creation of token instance in ERC-1155 * **Token minting**: token transfer of any of ERC-20, 721, 1155 token instance (single or bulk) from 0x0000... address * **Token transfer**: token transfer of any of ERC-20, 721, 1155 token instance (single or bulk) * **Transaction**: A contract call where the contract has not yet been identified by Blockscout.
Path 2 submissions are reviewed manually against the proof you provide.