Skip to content

TOKEN_TOTAL_SUPPLY_ON_DEMAND_* management envs #195

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
vbaranov wants to merge 1 commit into
base: main
Choose a base branch
from
Open

TOKEN_TOTAL_SUPPLY_ON_DEMAND_* management envs #195

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions setup/env-variables/backend-env-variables.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,7 @@
| `HACKNEY_DEFAULT_POOL_SIZE` | Size of `default` hackney pool. Implemented in [#12406](https://github.com/blockscout/blockscout/pull/12406). | Version: v8.1.0\+ <br />Default: `1000` <br />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\+ <br />Default: `https://raw.githubusercontent.com/blockscout/backend-configs/refs/heads/main/universal-proxy-config.json` <br />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\+ <br />Default: (empty) <br />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. Implemented in [#13080](https://github.com/blockscout/blockscout/pull/13080). | Version: v9.2.0\+ <br />Default: (empty) <br />Applications: API, Indexer |

Check warning on line 150 in setup/env-variables/backend-env-variables.mdx

View check run for this annotation

Mintlify / Mintlify Validation (blockscout) - vale-spellcheck

setup/env-variables/backend-env-variables.mdx#L150 

Did you really mean 'clusterization'?
| `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\+ <br />Default: `100` <br />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\+ <br />Default: `block` <br />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\+ <br />Default: `100` <br />Applications: API |
Expand All @@ -158,7 +158,7 @@
| Variable | Description | Parameters |
| ----------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -----------------------------------------------------------------------------------------|
| `DATABASE_URL` | Defines the Postgres Database endpoint. | Required: ✅ <br />Version: All <br />Default: (empty) <br />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\+ <br />Default: `unnamed` <br />Applications: API, Indexer |

Check warning on line 161 in setup/env-variables/backend-env-variables.mdx

View check run for this annotation

Mintlify / Mintlify Validation (blockscout) - vale-spellcheck

setup/env-variables/backend-env-variables.mdx#L161 

Did you really mean 'Postgrex'?

Check warning on line 161 in setup/env-variables/backend-env-variables.mdx

View check run for this annotation

Mintlify / Mintlify Validation (blockscout) - vale-spellcheck

setup/env-variables/backend-env-variables.mdx#L161 

Did you really mean 'pooler'?
| `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\+ <br />Default: value of `DATABASE_PREPARE_MODE` <br />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\+ <br />Default: (empty) <br />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 <br />Default: (empty) <br />Applications: API |
Expand Down Expand Up @@ -200,7 +200,7 @@
| `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\+ <br />Default: (empty) <br />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\+ <br />Default: `20s` <br />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\+ <br />Default: `500` <br />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\+ <br />Default: `true` <br />Applications: API, Indexer |

Check warning on line 203 in setup/env-variables/backend-env-variables.mdx

View check run for this annotation

Mintlify / Mintlify Validation (blockscout) - vale-spellcheck

setup/env-variables/backend-env-variables.mdx#L203 

Did you really mean 'debug_'?

Check warning on line 203 in setup/env-variables/backend-env-variables.mdx

View check run for this annotation

Mintlify / Mintlify Validation (blockscout) - vale-spellcheck

setup/env-variables/backend-env-variables.mdx#L203 

Did you really mean 'trace_'?
| `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\+ <br />Default: `false` <br />Applications: API, Indexer |
| `IPC_PATH` | Path to the IPC file of the running node if IPC transport is chosen. | Version: v2.1.1\+ <br />Default: (empty) <br />Applications: API, Indexer |

Expand Down Expand Up @@ -255,6 +255,7 @@
| `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\+ <br />Default: `false` <br />Applications: Indexer |
| `INDEXER_DISABLE_TOKEN_INSTANCE_RETRY_FETCHER` | If `true`, `retry` token instance fetcher doesn't run. | Version: v5.1.4\+ <br />Default: `false` <br />Applications: Indexer |
| `INDEXER_DISABLE_TOKEN_INSTANCE_SANITIZE_FETCHER` | If `true`, `sanitize` token instance fetcher doesn't run | Version: v5.1.4\+ <br />Default: `false` <br />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: master <br />Default: `false` <br />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\+ <br />Default: `true` <br />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\+ <br />Default: `10` <br />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\+ <br />Default: `4` <br />Applications: Indexer |
Expand All @@ -267,7 +268,7 @@
| `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\+ <br />Default: `2000` <br />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\+ <br />Default: `true`<br />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\+ <br />Default: `2m` <br />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\+ <br />Default: `5m` <br />Applications: Indexer |

Check warning on line 271 in setup/env-variables/backend-env-variables.mdx

View check run for this annotation

Mintlify / Mintlify Validation (blockscout) - vale-spellcheck

setup/env-variables/backend-env-variables.mdx#L271 

Did you really mean 'befor'?
| `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\+ <br />Default: `10` <br />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\+ <br />Default: `5m` <br />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\+ <br />Default: `1000` <br />Applications: Indexer |
Expand Down Expand Up @@ -295,7 +296,7 @@
| `INDEXER_RECEIPTS_BATCH_SIZE` | Batch size for transaction receipts fetcher. Implemented in [#6454](https://github.com/blockscout/blockscout/pull/6454). | Version: v5.0.0\+ <br />Default: `250` <br />Applications: Indexer |
| `INDEXER_RECEIPTS_CONCURRENCY` | Concurrency for transaction receipts fetcher. Implemented in [#6454](https://github.com/blockscout/blockscout/pull/6454). | Version: v5.0.0\+ <br />Default: `10` <br />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\+ <br />Default: `10` <br />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\+ <br />Default: `false` <br />Applications: Indexer |

Check warning on line 299 in setup/env-variables/backend-env-variables.mdx

View check run for this annotation

Mintlify / Mintlify Validation (blockscout) - vale-spellcheck

setup/env-variables/backend-env-variables.mdx#L299 

Did you really mean 'Homomorphic'?
| `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\+ <br />Default: `60` <br />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\+ <br />Default: `100` <br />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\+ <br />Default: `10` <br />Applications: Indexer |
Expand All @@ -306,7 +307,7 @@
| `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\+ <br />Default: `http,https` <br />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\+ <br />Default: (empty) <br />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\+ <br />Default: `true` <br />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\+ <br />Default: `10` <br />Applications: Indexer |

Check warning on line 310 in setup/env-variables/backend-env-variables.mdx

View check run for this annotation

Mintlify / Mintlify Validation (blockscout) - vale-spellcheck

setup/env-variables/backend-env-variables.mdx#L310 

Did you really mean 'backfills'?
| `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\+ <br />Default: `5` <br />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\+ <br />Default: `1` <br />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\+ <br />Default: `10` <br />Applications: Indexer |
Expand Down Expand Up @@ -340,7 +341,7 @@
| `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\+ <br />Default: `false` <br />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\+ <br />Default: `true` <br />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\+ <br />Default: `30` <br />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\+ <br />Default: `5` <br />Applications: API, Indexer |

Check warning on line 344 in setup/env-variables/backend-env-variables.mdx

View check run for this annotation

Mintlify / Mintlify Validation (blockscout) - vale-spellcheck

setup/env-variables/backend-env-variables.mdx#L344 

Did you really mean 'backfillin'?
| `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\+ <br />Default: `500` <br />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\+ <br />Default: `10` <br />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\+ <br />Default: `100` <br />Applications: API, Indexer |
Expand Down Expand Up @@ -509,6 +510,8 @@
| `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\+ <br />Default: `4` <br />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\+ <br />Default: `1s` <br />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\+ <br />Default: `50` <br />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: master <br />Default: `5` <br />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: master <br />Default: `5m` <br />Applications: Indexer |
| `COIN_BALANCE_ON_DEMAND_FETCHER_THRESHOLD` | A threshold to invalidate coin balance cache. | Version: v5.1.2\+ <br />Default: `1h` <br />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\+ <br />Default: `5s` <br />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\+ <br />Default: `2h` <br />Applications: API, Indexer |
Expand Down Expand Up @@ -591,21 +594,21 @@
## CSV Export

<Info>
When `CSV_EXPORT_ASYNC_ENABLED` is `true`, supported CSV export endpoints create a tracked request, enqueue a background job, write the CSV to a temporary file, upload it to Gokapi, and return a `request_id` for polling instead of streaming the CSV directly in the HTTP response.

Check warning on line 597 in setup/env-variables/backend-env-variables.mdx

View check run for this annotation

Mintlify / Mintlify Validation (blockscout) - vale-spellcheck

setup/env-variables/backend-env-variables.mdx#L597 

Did you really mean 'Gokapi'?
</Info>

| Variable | Description | Parameters |
| ------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
| `CSV_EXPORT_LIMIT` | Changes the max number of rows pulled by the CSV export logic. Applies to both sync and async CSV export paths. Implemented in [#10497](https://github.com/blockscout/blockscout/pull/10497) | Version: v6.8.0\+ <br />Default: `10000` <br />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 <br />Default: `false` <br />Applications: API |

Check warning on line 603 in setup/env-variables/backend-env-variables.mdx

View check run for this annotation

Mintlify / Mintlify Validation (blockscout) - vale-spellcheck

setup/env-variables/backend-env-variables.mdx#L603 

Did you really mean 'Oban'?
| `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 <br />Default: `10` <br />Applications: API |

Check warning on line 604 in setup/env-variables/backend-env-variables.mdx

View check run for this annotation

Mintlify / Mintlify Validation (blockscout) - vale-spellcheck

setup/env-variables/backend-env-variables.mdx#L604 

Did you really mean 'Oban'?
| `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 <br />Default: (empty) <br />Applications: API |

Check warning on line 605 in setup/env-variables/backend-env-variables.mdx

View check run for this annotation

Mintlify / Mintlify Validation (blockscout) - vale-spellcheck

setup/env-variables/backend-env-variables.mdx#L605 

Did you really mean 'Gokapi'?
| `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 <br />Default: (empty) <br />Applications: API |

Check warning on line 606 in setup/env-variables/backend-env-variables.mdx

View check run for this annotation

Mintlify / Mintlify Validation (blockscout) - vale-spellcheck

setup/env-variables/backend-env-variables.mdx#L606 

Did you really mean 'Gokapi'?
| `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 <br />Default: `3` <br />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 <br />Default: `47185920` <br />Applications: API |

Check warning on line 608 in setup/env-variables/backend-env-variables.mdx

View check run for this annotation

Mintlify / Mintlify Validation (blockscout) - vale-spellcheck

setup/env-variables/backend-env-variables.mdx#L608 

Did you really mean 'Gokapi'?

Check warning on line 608 in setup/env-variables/backend-env-variables.mdx

View check run for this annotation

Mintlify / Mintlify Validation (blockscout) - vale-spellcheck

setup/env-variables/backend-env-variables.mdx#L608 

Did you really mean 'Gokapi'?
| `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 <br />Default: `1h` if async export is enabled, otherwise `5m` <br />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 <br />Default: `/tmp/csv_export` <br />Applications: API |

Check warning on line 610 in setup/env-variables/backend-env-variables.mdx

View check run for this annotation

Mintlify / Mintlify Validation (blockscout) - vale-spellcheck

setup/env-variables/backend-env-variables.mdx#L610 

Did you really mean 'Gokapi'?
| `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 <br />Default: `60s` <br />Applications: API |

Check warning on line 611 in setup/env-variables/backend-env-variables.mdx

View check run for this annotation

Mintlify / Mintlify Validation (blockscout) - vale-spellcheck

setup/env-variables/backend-env-variables.mdx#L611 

Did you really mean 'Gokapi'?
| `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 <br />Default: `1` <br />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 <br />Default: `1` <br />Applications: API |

Expand Down Expand Up @@ -652,7 +655,7 @@
| `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\+ <br />Default: `(empty)` <br />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\+ <br />Default: `5` <br />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\+ <br />Default: (empty) <br />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\+ <br />Default: (empty) <br />Applications: API |

Check warning on line 658 in setup/env-variables/backend-env-variables.mdx

View check run for this annotation

Mintlify / Mintlify Validation (blockscout) - vale-spellcheck

setup/env-variables/backend-env-variables.mdx#L658 

Did you really mean 'urls'?
| `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\+ <br />Default: (empty) <br />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\+ <br />Default: `2` <br />Applications: API |

Expand All @@ -667,7 +670,7 @@
| `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\+ <br />Default: `1h` <br />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\+ <br />Default: `1h` <br />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\+ <br />Default: (empty) <br />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\+ <br />Default: (empty) <br />Applications: API |

Check warning on line 673 in setup/env-variables/backend-env-variables.mdx

View check run for this annotation

Mintlify / Mintlify Validation (blockscout) - vale-spellcheck

setup/env-variables/backend-env-variables.mdx#L673 

Did you really mean 'urls'?
| `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\+ <br />Default: (empty) <br />Applications: API |

## GraphQL API
Expand Down Expand Up @@ -716,7 +719,7 @@
| `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\+ <br />Default: (empty) <br />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\+ <br />Default: (empty) <br />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\+ <br />Default: (empty) <br />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\+ <br />Default: (empty) <br />Applications: API |

Check warning on line 722 in setup/env-variables/backend-env-variables.mdx

View check run for this annotation

Mintlify / Mintlify Validation (blockscout) - vale-spellcheck

setup/env-variables/backend-env-variables.mdx#L722 

Did you really mean 'urls'?
| `ACCOUNT_REDIS_SENTINEL_MASTER_NAME` | Account Sentinel master name. Implemented in [#13901](https://github.com/blockscout/blockscout/pull/13901). | Version: v12.0.0\+ <br />Default: (empty) <br />Applications: API |

## Specific Smart Contracts
Expand Down Expand Up @@ -744,7 +747,7 @@
| `NFT_MEDIA_HANDLER_REMOTE_DISPATCHER_NODE_MODE_ENABLED` | if `true`, nft media handler is supposed to run separately. | Version: v6.10.0\+ <br />Default: `false` <br />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\+ <br />Default: `false` <br />Applications: Indexer, NFT_MEDIA_HANDLER |
| `NFT_MEDIA_HANDLER_WORKER_CONCURRENCY` | Concurrency of media handling (resizing/uploading) | Version: v6.10.0\+ <br />Default: `10` <br />Applications: NFT_MEDIA_HANDLER |
| `NFT_MEDIA_HANDLER_WORKER_BATCH_SIZE` | Number of urls processed by one async task | Version: v6.10.0\+ <br />Default: `10` <br />Applications: NFT_MEDIA_HANDLER |

Check warning on line 750 in setup/env-variables/backend-env-variables.mdx

View check run for this annotation

Mintlify / Mintlify Validation (blockscout) - vale-spellcheck

setup/env-variables/backend-env-variables.mdx#L750 

Did you really mean 'urls'?
| `NFT_MEDIA_HANDLER_WORKER_SPAWN_TASKS_TIMEOUT` | Timeout before spawning new task | Version: v6.10.0\+ <br />Default: `100ms` <br />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\+ <br />Default: `false` <br />Applications: Indexer |
| `NFT_MEDIA_HANDLER_BACKFILL_QUEUE_SIZE` | Max size of backfill queue | Version: v6.10.0\+ <br />Default: `1000` <br />Applications: Indexer |
Expand Down