Skip to content

Commit 0f395aa

Browse files
vbaranovvbaranov
committed
Cspell config
1 parent 4aa8f0f commit 0f395aa

File tree

7 files changed

+125
-19
lines changed

7 files changed

+125
-19
lines changed

‎.gitbook/assets/Blockscout-ENV-variables.csv

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,7 @@ Variable,Required,Description,Default,Version,
114114
`INDEXER_DISABLE_TOKEN_INSTANCE_SANITIZE_FETCHER`,,"If `true`, `sanitize` token instance fetcher doesn't run",`false`,v5.1.4+,
115115
`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),1000,v5.1.5+,
116116
`INDEXER_DISABLE_WITHDRAWALS_FETCHER`,,"If `true`, withdrawals fetcher is disabled. Implemented in [#6694](https://github.com/blockscout/blockscout/pull/6694).",`true`,v5.1.5+,
117-
`WITHDRAWALS_FIRST_BLOCK`,,"The block number, where import of withdrawals by catchup fetcher begins from. Should be the block where withdrawals upgrade occured on the chain. Implemented in [#6694](https://github.com/blockscout/blockscout/pull/6694).",(empty),v5.1.5+,
117+
`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).",(empty),v5.1.5+,
118118
`INDEXER_CATCHUP_BLOCK_INTERVAL`,,Interval between blocks catchup fetcher tasks. Implemented in [#7489](https://github.com/blockscout/blockscout/pull/7489).,`5s`,v5.1.5+,
119119
`INDEXER_FETCHER_INIT_QUERY_LIMIT`,,Limit for all fetchers init queries. Implemented in [#7697](https://github.com/blockscout/blockscout/pull/7697).,100,v5.2.0+,
120120
### Exchange rates management,,,,,

‎.github/workflows/config.yml

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
name: Blockscout Docs
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
pull_request:
8+
types: [opened, synchronize, reopened, labeled]
9+
branches:
10+
- main
11+
12+
jobs:
13+
cspell:
14+
name: Check spelling
15+
runs-on: ubuntu-latest
16+
steps:
17+
- uses: actions/checkout@v4
18+
19+
- name: Run cspell
20+
uses: streetsidesoftware/cspell-action@v6
21+
with:
22+
use_cspell_files: true
23+
incremental_files_only: false

‎cspell.json

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
// cSpell Settings
2+
{
3+
"$schema": "https://raw.githubusercontent.com/streetsidesoftware/cspell/main/cspell.schema.json",
4+
// Version of the setting file. Always 0.2
5+
"version": "0.6",
6+
// language - current active spelling language
7+
"language": "en",
8+
// enabled - enable code editor suggestions
9+
"enabled": true,
10+
"files": [
11+
"./setup/env-variables/*.md"
12+
],
13+
// useGitignore - use .gitignore to exclude files from checking
14+
"useGitignore": true,
15+
"ignoreRegExpList": [
16+
// Ignore filecoin f410f-like native addresses
17+
"f410f[a-z2-7]{39}"
18+
],
19+
// words - list of words to be always considered correct
20+
"words": [
21+
"airtable",
22+
"ARBSYS",
23+
"Astar",
24+
"backfiller",
25+
"Beryx",
26+
"Besu",
27+
"blackfort",
28+
"Blockscout",
29+
"blockaid",
30+
"chaintype",
31+
"checksummed",
32+
"Celestia",
33+
"COEFF",
34+
"Graphi",
35+
"CRYPTOCOMPARE",
36+
"Cryptorank",
37+
"defillama",
38+
"Dencun",
39+
"displayment",
40+
"ecto",
41+
"endhint",
42+
"filecoin",
43+
"Filfox",
44+
"Erigon",
45+
"gitbook",
46+
"hardfork",
47+
"ipfs",
48+
"MARKETCAP",
49+
"Mobula",
50+
"Multichain",
51+
"nbvkhadvnbkdfav",
52+
"ndjkfvndfkjv",
53+
"Nethermind",
54+
"Nonfungible",
55+
"Noves",
56+
"poanetwork",
57+
"REINDEX",
58+
"reindexing",
59+
"remasc",
60+
"rollups",
61+
"Safelow",
62+
"Sendgrid",
63+
"SIWE",
64+
"Sokol",
65+
"shibarium",
66+
"Solidityscan",
67+
"Sourcify",
68+
"stablecoins",
69+
"subnetwork",
70+
"superchain",
71+
"txpool",
72+
"Ueberauth",
73+
"unindexed",
74+
"watchlist",
75+
"xdai",
76+
"Xname",
77+
"zetachain",
78+
"zilliqa",
79+
"zkbob",
80+
"zkevm",
81+
"zksync"
82+
]
83+
}

‎setup/env-variables/backend-env-variables.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -172,7 +172,7 @@ _**Note**_**: Before release 5.1.2, all environment variables of time format sup
172172
| `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) | <p>Version: v5.1.5+<br>Default: <code>1000</code><br>Applications: Indexer</p> |
173173
| `INDEXER_REALTIME_FETCHER_POLLING_PERIOD` | Period between polling the `latest` block in realtime fetcher. [Time format](backend-env-variables.md#time-format). Implemented in [#11783](https://github.com/blockscout/blockscout/pull/11783) | <p>Version: v7.0.0+<br>Default: (empty)<br>Applications: Indexer</p> |
174174
| `INDEXER_DISABLE_WITHDRAWALS_FETCHER` | If `true`, withdrawals fetcher is disabled. Implemented in [#6694](https://github.com/blockscout/blockscout/pull/6694). | <p>Version: v5.1.5+<br>Default: <code>true</code><br>Applications: Indexer</p> |
175-
| `WITHDRAWALS_FIRST_BLOCK` | The block number, where import of withdrawals by catchup fetcher begins from. Should be the block where withdrawals upgrade occured on the chain. Implemented in [#6694](https://github.com/blockscout/blockscout/pull/6694). | <p>Version: v5.1.5+<br>Default: (empty)<br>Applications: Indexer</p> |
175+
| `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). | <p>Version: v5.1.5+<br>Default: (empty)<br>Applications: Indexer</p> |
176176
| `INDEXER_CATCHUP_BLOCK_INTERVAL` | Interval between blocks catchup fetcher tasks. Implemented in [#7489](https://github.com/blockscout/blockscout/pull/7489). | <p>Version: v5.1.5+<br>Default: <code>0s</code><br>Applications: Indexer</p> |
177177
| `INDEXER_FETCHER_INIT_QUERY_LIMIT` | Limit for all fetchers init queries. Implemented in [#7697](https://github.com/blockscout/blockscout/pull/7697). | <p>Version: v5.2.0+<br>Default: <code>100</code><br>Applications: Indexer</p> |
178178
| `INDEXER_TOKEN_INSTANCE_RETRY_BATCH_SIZE` | Batch size for `retry` token instance fetcher. Implemented in [#8313](https://github.com/blockscout/blockscout/pull/8313) | <p>Version: v5.2.3+<br>Default: <code>10</code><br>Applications: Indexer</p> |
@@ -194,7 +194,7 @@ _**Note**_**: Before release 5.1.2, all environment variables of time format sup
194194
| `INDEXER_DISABLE_REPLACED_TRANSACTION_FETCHER` | If `true`, `Indexer.Fetcher.ReplacedTransaction` fetcher doesn't run. | <p>Version: v6.8.0+<br>Default: <code>false</code><br>Applications: Indexer</p> |
195195
| `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) | <p>Version: v6.9.0+<br>Default: <code>asc</code><br>Applications: Indexer</p> |
196196

197-
## <mark style="background-color:orange;">DB Migtrations & Sanitizer Management</mark>
197+
## <mark style="background-color:orange;">DB Migrations & Sanitizer Management</mark>
198198

199199
| Variable | Description | Parameters |
200200
| ------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
@@ -316,9 +316,9 @@ See the [Time format](backend-env-variables.md#time-format) section for more inf
316316
| `GAS_PRICE_ORACLE_FAST_PERCENTILE` | Gas price oracle: fast percentile | <p>Version: v4.1.4+<br>Default: <code>90</code><br>Applications: API, Indexer</p> |
317317
| `GAS_PRICE_ORACLE_CACHE_PERIOD` | Gas price oracle: period of gas prices update. | <p>Version: v4.1.4+<br>Default: <code>30s</code><br>Applications: API, Indexer</p> |
318318
| `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). | <p>Version: v6.0.0+<br>Default: <code>21000</code><br>Applications: API, Indexer</p> |
319-
| `GAS_PRICE_ORACLE_SAFELOW_TIME_COEFFICIENT` | Average block time multiplied by this coefficent 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). | <p>Version: v6.3.0+<br>Default: <code>5</code><br>Applications: API, Indexer</p> |
320-
| `GAS_PRICE_ORACLE_AVERAGE_TIME_COEFFICIENT` | Average block time multiplied by this coefficent 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). | <p>Version: v6.3.0+<br>Default: <code>3</code><br>Applications: API, Indexer</p> |
321-
| `GAS_PRICE_ORACLE_FAST_TIME_COEFFICIENT` | Average block time multiplied by this coefficent 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). | <p>Version: v6.3.0+<br>Default: <code>1</code><br>Applications: API, Indexer</p> |
319+
| `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). | <p>Version: v6.3.0+<br>Default: <code>5</code><br>Applications: API, Indexer</p> |
320+
| `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). | <p>Version: v6.3.0+<br>Default: <code>3</code><br>Applications: API, Indexer</p> |
321+
| `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). | <p>Version: v6.3.0+<br>Default: <code>1</code><br>Applications: API, Indexer</p> |
322322

323323
## <mark style="background-color:orange;">Main Page Dashboard</mark>
324324

@@ -508,7 +508,7 @@ This feature was implemented in [#10675](https://github.com/blockscout/blockscou
508508
| `NFT_MEDIA_HANDLER_ENABLED` | if `true`, CDN feature enabled | <p>Version: v6.10.0+<br>Default: <code>false</code><br>Applications: Indexer, NFT_MEDIA_HANDLER</p> |
509509
| `NFT_MEDIA_HANDLER_REMOTE_DISPATCHER_NODE_MODE_ENABLED` | if `true`, nft media handler is supposed to run separately. | <p>Version: v6.10.0+<br>Default: <code>false</code><br>Applications: Indexer, NFT_MEDIA_HANDLER</p> |
510510
| `NFT_MEDIA_HANDLER_IS_WORKER` | if `true`, and `NFT_MEDIA_HANDLER_REMOTE_DISPATCHER_NODE_MODE_ENABLED=true` will be started only nft\_media\_handler app | <p>Version: v6.10.0+<br>Default: <code>false</code><br>Applications: Indexer, NFT_MEDIA_HANDLER</p> |
511-
| `NFT_MEDIA_HANDLER_NODES_MAP` | String in json map format, where key is erland node and value is folder in R2/S3 bucket, example: `"{\"[email protected]\": \"/folder_1\"}"`. If nft\_media\_handler runs in one pod with indexer, map should contain `self` key | <p>Version: v6.10.0+<br>Default: (empty)<br>Applications: NFT_MEDIA_HANDLER</p> |
511+
| `NFT_MEDIA_HANDLER_NODES_MAP` | String in json map format, where key is erlang node and value is folder in R2/S3 bucket, example: `"{\"[email protected]\": \"/folder_1\"}"`. If nft\_media\_handler runs in one pod with indexer, map should contain `self` key | <p>Version: v6.10.0+<br>Default: (empty)<br>Applications: NFT_MEDIA_HANDLER</p> |
512512
| `NFT_MEDIA_HANDLER_WORKER_CONCURRENCY` | Concurrency of media handling (resizing/uploading) | <p>Version: v6.10.0+<br>Default: <code>10</code><br>Applications: NFT_MEDIA_HANDLER</p> |
513513
| `NFT_MEDIA_HANDLER_WORKER_BATCH_SIZE` | Number of url processed by one async task | <p>Version: v6.10.0+<br>Default: <code>10</code><br>Applications: NFT_MEDIA_HANDLER</p> |
514514
| `NFT_MEDIA_HANDLER_WORKER_SPAWN_TASKS_TIMEOUT` | Timeout before spawn new task | <p>Version: v6.10.0+<br>Default: <code>100ms</code><br>Applications: NFT_MEDIA_HANDLER</p> |

0 commit comments

Comments
 (0)