Skip to content

Commit 3c30902

Browse files
authored
fix(internal-infra): enable case-sensitive spell checking, decrease the min threshold to 3 characters, add prohibited variations (#1121)
1 parent e4a62cb commit 3c30902

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

42 files changed

+381
-288
lines changed

.cspell.jsonc

Lines changed: 34 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,20 +11,51 @@
1111
"path": "resources/dictionaries/custom.txt",
1212
"addWords": true,
1313
},
14+
{
15+
"name": "deny-list",
16+
"path": "resources/dictionaries/ban.txt"
17+
},
1418
{
1519
"name": "tvm-instructions",
1620
"path": "resources/dictionaries/tvm-instructions.txt"
1721
}
1822
],
1923
"dictionaries": [
2024
"main-list",
21-
"tvm-instructions"
25+
"deny-list",
26+
"tvm-instructions",
2227
],
2328
"useGitignore": true,
2429
"files": [
2530
"**/*.{md,mdx}",
2631
"**/*.{js,jsx}",
2732
],
33+
"minWordLength": 3,
34+
"overrides": [
35+
// Enable case sensitivity for Markdown and MDX files only
36+
{
37+
"filename": "**/*.{md,mdx}",
38+
"caseSensitive": true
39+
},
40+
// Do not check for banned words (denylist) in certain files
41+
{
42+
"filename": "contribute/style-guide*.mdx",
43+
"ignoreWords": [
44+
"tos",
45+
"DOI",
46+
"BOC",
47+
],
48+
"dictionaries": [
49+
"!deny-list"
50+
]
51+
},
52+
{
53+
"filename": "**/api/**/v*",
54+
"dictionaries": [
55+
"!deny-list"
56+
]
57+
},
58+
],
2859
"ignorePaths": [
2960
// Some whitepapers
3061
"foundations/whitepapers/tblkch.mdx",
@@ -49,7 +80,7 @@
4980
"**/*.svg",
5081
"**/*.txt",
5182
"CODEOWNERS",
52-
"**/*http-api*",
83+
"snippets/tvm-instruction-table.jsx",
5384
],
5485
"ignoreRegExpList": [
5586
//
@@ -78,7 +109,7 @@
78109
//
79110
"=\\s*\".*?\"", // ="..."
80111
"(?<!\\\\)\\$(?:\\\\.|[^$\\\\])*?\\$", // inline math
81-
"/(?<!\\\\)\\$\\$\\r?\\n.*?(?<=\\n)\\$\\$/gms", // block math
112+
"/(?<!\\\\)\\$\\$[\\s\\S]*?\\$\\$/g", // block math
82113
"(?<!\\\\)`.*?`", // inline code
83114
"/^([ \\t]*```).*([\\s\\S]*?)^\\1$/gmx", // block code
84115
"^import[ \\t].+$", // import ...

ecosystem/analytics.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ Dune analytics allows projects to build bespoke data marts for each protocol —
5050

5151
#### Decoding raw data
5252

53-
Since TON handles complex [data structures](/foundations/serialization/cells/) and doesn't have ABIs, a [special decoding framework](https://github.com/duneanalytics/spellbook/blob/main/dbt_subprojects/daily_spellbook/macros/project/ton/README.md) was created. It works on top of the [Spellbook](https://github.com/duneanalytics/spellbook) — a powerful tool for building custom tables with [dbt](https://github.com/dbt-labs/dbt-core) and Jinja macros. It helps decode important information from raw protocol message payloads.
53+
Since TON handles complex [data structures](/foundations/serialization/cells/) and doesn't have ABIs, a [special decoding framework](https://github.com/duneanalytics/spellbook/blob/main/dbt_subprojects/daily_spellbook/macros/project/ton/README.md) was created. It works on top of the [Spellbook](https://github.com/duneanalytics/spellbook) — a powerful tool for building custom tables with [`dbt`](https://github.com/dbt-labs/dbt-core) and Jinja macros. It helps decode important information from raw protocol message payloads.
5454

5555
The following protocols are decoded using this framework and serve as examples:
5656

ecosystem/api/toncenter/v2.json

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2099,8 +2099,8 @@
20992099
"tags": [
21002100
"Messages and transactions"
21012101
],
2102-
"summary": "Send external message (BOC)",
2103-
"description": "Send serialized boc file: fully packed and serialized external message to blockchain.",
2102+
"summary": "Send external message (BoC)",
2103+
"description": "Send serialized BoC file: fully packed and serialized external message to blockchain.",
21042104
"operationId": "send_boc_sendBoc_post",
21052105
"requestBody": {
21062106
"content": {
@@ -2139,7 +2139,7 @@
21392139
"Messages and transactions"
21402140
],
21412141
"summary": "Send external message and return hash",
2142-
"description": "Send serialized boc file: fully packed and serialized external message to blockchain. The method returns message hash.",
2142+
"description": "Send serialized BoC file: fully packed and serialized external message to blockchain. The method returns message hash.",
21432143
"operationId": "send_boc_return_hash_sendBocReturnHash_post",
21442144
"requestBody": {
21452145
"content": {
@@ -2178,7 +2178,7 @@
21782178
"Messages and transactions"
21792179
],
21802180
"summary": "Send unpacked external query",
2181-
"description": "Send query - unpacked external message. This method takes address, body and init-params (if any), packs it to external message and sends to network. All params should be boc-serialized.",
2181+
"description": "Send query - unpacked external message. This method takes address, body and init-params (if any), packs it to external message and sends to network. All params should be BoC-serialized.",
21822182
"operationId": "send_query_sendQuery_post",
21832183
"requestBody": {
21842184
"content": {
@@ -2449,18 +2449,18 @@
24492449
"body": {
24502450
"type": "string",
24512451
"title": "Body",
2452-
"description": "b64-encoded boc-serialized cell with message body"
2452+
"description": "b64-encoded BoC-serialized cell with message body"
24532453
},
24542454
"init_code": {
24552455
"type": "string",
24562456
"title": "Init Code",
2457-
"description": "b64-encoded boc-serialized cell with init-code",
2457+
"description": "b64-encoded BoC-serialized cell with init-code",
24582458
"default": ""
24592459
},
24602460
"init_data": {
24612461
"type": "string",
24622462
"title": "Init Data",
2463-
"description": "b64-encoded boc-serialized cell with init-data",
2463+
"description": "b64-encoded BoC-serialized cell with init-data",
24642464
"default": ""
24652465
}
24662466
},
@@ -3656,7 +3656,7 @@
36563656
},
36573657
"bytes": {
36583658
"type": "string",
3659-
"description": "Base64-encoded BOC bytes."
3659+
"description": "Base64-encoded BoC bytes."
36603660
}
36613661
},
36623662
"required": [
@@ -3769,4 +3769,4 @@
37693769
"description": "JSON-RPC endpoint."
37703770
}
37713771
]
3772-
}
3772+
}

ecosystem/api/toncenter/v3.yaml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ paths:
2424
type: array
2525
items:
2626
type: string
27-
- description: 'Include code and data BOCs. Default: true'
27+
- description: 'Include code and data BoCs. Default: true'
2828
name: include_boc
2929
in: query
3030
schema:
@@ -961,14 +961,14 @@ paths:
961961
description: Send an external message to the TON network.
962962
tags:
963963
- Legacy (v2-compatible)
964-
summary: Send external message (BOC)
964+
summary: Send external message (BoC)
965965
operationId: api_v3_post_v2_message
966966
requestBody:
967967
content:
968968
application/json:
969969
schema:
970970
$ref: '#/components/schemas/V2SendMessageRequest'
971-
description: Message in boc base64 format.
971+
description: Message in BoC base64 format.
972972
required: true
973973
responses:
974974
'200':
@@ -1496,15 +1496,15 @@ paths:
14961496
14971497
"type": "cell",
14981498
1499-
"value": "te6..." // base64 encoded boc with cell
1499+
"value": "te6..." // base64 encoded BoC with cell
15001500
15011501
},
15021502
15031503
{
15041504
15051505
"type": "slice",
15061506
1507-
"value": "te6..." // base64 encoded boc with slice
1507+
"value": "te6..." // base64 encoded BoC with slice
15081508
15091509
}
15101510

ecosystem/explorers/overview.mdx

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,28 +5,30 @@ title: "Overview"
55
Explorers are web tools for reading blockchain data. They let you look up accounts, transactions, blocks, and smart contracts, making it easy to verify activity and debug issues.
66

77
### Explorer
8+
89
A blockchain explorer is a website that indexes on‑chain data and presents it in a searchable user interface (UI). In TON, explorers commonly show account balances, recent transactions, jettons and non‑fungible tokens (NFTs), contract code and state, and links to related blocks and messages.
910

1011
### What explorers show
12+
1113
- Balances and assets: TON, jettons, and NFTs held by an address
1214
- Transactions and messages: history, fees, phases, and traces
13-
- Blocks and validators: block contents, MasterChain and ShardChain details
15+
- Blocks and validators: block contents, masterchain and shardchain details
1416
- Smart contracts: code, state, disassembly, and known contract type
1517
- Analytics: top entities, volumes, gas, fees, and network health
1618

1719
### Indexers
20+
1821
Indexers continuously read blocks from nodes, parse messages and transactions, and store them in a database optimized for queries. Explorers rely on these indexers to provide fast search, traces, higher‑level events, and historical views beyond what a single node exposes by default.
1922

2023
### Explorers comparison
2124

22-
| Explorer | Type | Mainnet | Testnet | Official |
23-
| --- | --- | --- | --- | --- |
24-
| Tonviewer | General‑purpose | [tonviewer.com](https://tonviewer.com/) | [Testnet](https://testnet.tonviewer.com/) | No |
25-
| Tonscan.org | General‑purpose | [tonscan.org](https://tonscan.org/) | [Testnet](https://testnet.tonscan.org/) | No |
26-
| Tonscan.com | General‑purpose | [tonscan.com](https://tonscan.com/) | - | No |
27-
| TON Explorer | Low‑level/core | [explorer.toncoin.org](https://explorer.toncoin.org/) | [Testnet](https://test-explorer.toncoin.org) | Yes |
25+
| Explorer | Type | Mainnet | Testnet | Official |
26+
| ------------ | --------------- | ----------------------------------------------------- | -------------------------------------------- | -------- |
27+
| Tonviewer | General‑purpose | [tonviewer.com](https://tonviewer.com/) | [Testnet](https://testnet.tonviewer.com/) | No |
28+
| Tonscan.org | General‑purpose | [tonscan.org](https://tonscan.org/) | [Testnet](https://testnet.tonscan.org/) | No |
29+
| Tonscan.com | General‑purpose | [tonscan.com](https://tonscan.com/) | - | No |
30+
| TON Explorer | Low‑level/core | [explorer.toncoin.org](https://explorer.toncoin.org/) | [Testnet](https://test-explorer.toncoin.org) | Yes |
2831

2932
> Official: maintained by the TON Foundation or an affiliated team
3033
3134
The [verifier tool](https://verifier.ton.org/) powers contract code verification.
32-

ecosystem/node/mytonctrl/btc_teleport.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ description: "The BTC Teleport module manages the optional Bitcoin bridge (Telep
99
- Voting attaches 1.5 TON from the validator wallet. Ensure the wallet has sufficient balance before sending votes.
1010
- The module caches proposals it has voted on (`saveOffersBtcTeleport`) to avoid duplicate submissions.
1111

12-
## print\_offers\_btc\_teleport\_list
12+
## `print_offers_btc_teleport_list`
1313

1414
**Purpose:** Show the current Teleport governance proposals and voting status.
1515

@@ -32,7 +32,7 @@ print_offers_btc_teleport_list --json
3232
print_offers_btc_teleport_list hash
3333
```
3434

35-
## vote\_offer\_btc\_teleport
35+
## `vote_offer_btc_teleport`
3636

3737
**Purpose:** Vote on one or more Teleport proposals using the validator wallet.
3838

@@ -56,7 +56,7 @@ vote_offer_btc_teleport <offer-hash> [additional_offer_hashes...]
5656
vote_offer_btc_teleport 0xabc123... 0xdef456...
5757
```
5858

59-
## remove\_btc\_teleport
59+
## `remove_btc_teleport`
6060

6161
**Purpose:** Uninstall the Teleport binaries, keystore, and system service.
6262

ecosystem/node/mytonctrl/core.mdx

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -22,16 +22,16 @@ about <mode_name>
2222

2323
**Available modes**
2424

25-
| Mode | Description |
26-
| ------------------ | ---------------------------------------------------------------------------------------------------------------------------------------- |
25+
| Mode | Description |
26+
| ------------------ | ---------------------------------------------------------------------- |
2727
| `validator` | Validator functions. Activates participating in elections and staking. |
28-
| `nominator-pool` | Standard nominator pools. |
29-
| `single-nominator` | Orbs' single nominator pools. |
30-
| `liquid-staking` | Liquid staking controllers. |
31-
| `liteserver` | For liteserver usage only without validator. |
32-
| `collator` | Blocks collator-only module. |
33-
| `alert-bot` | Telegram bot alerts |
34-
| `prometheus` | Prometheus format data exporter |
28+
| `nominator-pool` | Standard nominator pools. |
29+
| `single-nominator` | Orbs' single nominator pools. |
30+
| `liquid-staking` | Liquid staking controllers. |
31+
| `liteserver` | For liteserver usage only without validator. |
32+
| `collator` | Blocks collator-only module. |
33+
| `alert-bot` | Telegram bot alerts |
34+
| `prometheus` | Prometheus format data exporter |
3535

3636
**Example**
3737

@@ -51,7 +51,7 @@ benchmark
5151

5252
**Behavior**
5353

54-
- Runs a bundled benchmark script with elevated privileges. The script executes two FIO scenarios (random 4K with queue depths 64 and 1) and a RocksDB stress test.
54+
- Runs a bundled benchmark script with elevated privileges. The script executes two I/O scenarios (random 4K with queue depths 64 and 1) and a RocksDB stress test.
5555
- The run takes up to \~200 seconds; the console blocks until completion.
5656
- Results are printed as a table with read/write throughput, IOPS, and RocksDB random operations. On failure, the command prints the captured error log.
5757

@@ -218,7 +218,7 @@ installer enable THA
218218

219219
## rollback
220220

221-
**Purpose:** Revert MyTonCtrl to the legacy MTC1 configuration format.
221+
**Purpose:** Revert MyTonCtrl to the legacy `MTC1` configuration format.
222222

223223
**Syntax**
224224

@@ -247,7 +247,7 @@ status fast
247247

248248
- Without arguments, the command aggregates live data from the validator, lite-client, system metrics, and Git repositories. It prints:
249249
- Network overview: network name, validator participation counts, shard count, outstanding offers/complaints, current election status.
250-
- Local node metrics: validator index and efficiency, ADNL addresses, wallet balances, CPU/memory/swap/disk utilization, network throughput, service uptimes (mytoncore, validator, btc\_teleport when applicable), virtualization detection, version information for MyTonCtrl, TON binaries, and optional BTC Teleport.
250+
- Local node metrics: validator index and efficiency, ADNL addresses, wallet balances, CPU/memory/swap/disk utilization, network throughput, service uptimes (mytoncore, validator, `btc_teleport` when applicable), virtualization detection, version information for MyTonCtrl, TON binaries, and optional BTC Teleport.
251251
- Additional election metadata for validator nodes, including config parameters and the expected validation/election timeline.
252252
- `status fast` skips remote calls that enumerate validators and offers, which is useful on constrained connections or when you only need the local section.
253253
- If the node is out of sync, the report focuses on local health and prints warnings instead of global network data.

ecosystem/node/mytonctrl/liquid_staking.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ create_controllers
2525
**Behavior**
2626

2727
- Compares the controller addresses returned by the pool (`GetControllers`) with the addresses stored in the local database.
28-
- If they differ, downloads the jetton pool deployment scripts (on first run), signs the deployment BOCs with the validator wallet, and sends them to the liquid pool with a small attach value.
28+
- If they differ, downloads the jetton pool deployment scripts (on first run), signs the deployment BoCs with the validator wallet, and sends them to the liquid pool with a small attach value.
2929
- Stores the newly active controllers under `using_controllers` so subsequent staking and voting commands target the fresh contracts.
3030

3131
### `update_controllers`

ecosystem/node/mytonctrl/pools.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ delete_pool <pool-name>
5555

5656
**Behavior**
5757

58-
- Deletes the BOC/address files created for `<pool-name>` from the pools directory; on-chain contracts remain untouched.
58+
- Deletes the BoC/address files created for `<pool-name>` from the pools directory; on-chain contracts remain untouched.
5959
- Useful when you migrate a pool to another host or retire a test deployment.
6060

6161
**Example**
@@ -105,7 +105,7 @@ activate_pool <pool-name>
105105

106106
- Loads `<pool-name>-query.boc` and ensures the validator wallet is active.
107107
- If the pool account is still empty, it signs and broadcasts the deployment message; if it is already active, it logs a warning and exits without changes.
108-
- Leaves the deployment BOC in place so you can retry if the transaction fails.
108+
- Leaves the deployment BoC in place so you can retry if the transaction fails.
109109

110110
**Example**
111111

@@ -218,7 +218,7 @@ activate_single_pool <pool-name>
218218

219219
- Checks that `<pool-name>-query.boc` still exists (indicating the pool is not already active).
220220
- Signs the deploy message with the validator wallet and posts it to the network.
221-
- Warns and exits without changes if the BOC is missing because the pool was already activated.
221+
- Warns and exits without changes if the BoC is missing because the pool was already activated.
222222

223223
**Example**
224224

ecosystem/tma/analytics/analytics.mdx

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,14 +14,13 @@ This library does not collect or store any private user data. It tracks app laun
1414
- Server-side Rendering
1515
- [All known](https://telegram.org/apps) Telegram clients
1616

17-
1817
| <Icon icon="/resources/images/tma-browsers-icons/edge_48x48.png" /> Edge | <Icon icon="/resources/images/tma-browsers-icons/firefox_48x48.png" /> Firefox | <Icon icon="/resources/images/tma-browsers-icons/chrome_48x48.png" /> Chrome | <Icon icon="/resources/images/tma-browsers-icons/safari_48x48.png" /> Safari | <Icon icon="/resources/images/tma-browsers-icons/safari_48x48.png" /> iOS |
19-
|--------------------------------------------------------------------------|--------------------------------------------------------------------------------|------------------------------------------------------------------------------|------------------------------------------------------------------------------|---------------------------------------------------------------------------|
20-
| \>= 79 | \>= 78 | \>= 73 | \>= 12.0 | \>= 12.0 |
18+
| ------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
19+
| >= 79 | >= 78 | >= 73 | >= 12.0 | >= 12.0 |
2120

2221
## Resources
2322

24-
- **Example Mini App:** Typescript version — [dapp](https://github.com/Dimitreee/demo-dapp-with-analytics).
23+
- **Example Mini App:** Typescript version — [dApp](https://github.com/Dimitreee/demo-dapp-with-analytics).
2524
- **Docs:** Access latest docs at [gitbook](https://docs.tganalytics.xyz/).
2625

2726
## Installation

0 commit comments

Comments
 (0)