Merge branch 'main' into node-overview-feedback

Author: aigerimu

.cspell.jsonc

@@ -7,14 +7,21 @@
   "language": "en-US",
   "dictionaryDefinitions": [
     {
+      // Allowed words
       "name": "main-list",
       "path": "resources/dictionaries/custom.txt",
       "addWords": true,
     },
     {
+      // Banned words with no clear or correct replacements
+      // For a few words with those, see the flagWords property later in this file
       "name": "deny-list",
       "path": "resources/dictionaries/ban.txt"
     },
+    {
+      "name": "2lw-deny-list",
+      "path": "resources/dictionaries/two-letter-words-ban.txt"
+    },
     {
       "name": "tvm-instructions",
       "path": "resources/dictionaries/tvm-instructions.txt"
@@ -23,43 +30,80 @@
   "dictionaries": [
     "main-list",
     "deny-list",
+    "2lw-deny-list",
     "tvm-instructions",
   ],
   "useGitignore": true,
   "files": [
     "**/*.{md,mdx}",
-    "**/*.{js,jsx}",
+    "**/*.{js,jsx,mjs}",
   ],
   "minWordLength": 3,
   "overrides": [
     // Enable case sensitivity for Markdown and MDX files only
     {
       "filename": "**/*.{md,mdx}",
-      "caseSensitive": true
+      "caseSensitive": true,
+      // Known incorrect spellings and correct suggestions
+      "flagWords": [
+        "AccountChain->accountchain",
+        "BaseChain->basechain",
+        "boc->BoC",
+        "BOC->BoC",
+        "Github->GitHub",
+        "MasterChain->masterchain",
+        "ShardChain->shardchain",
+        "Toncenter->TON Center",
+        "toncoins->Toncoin",
+        "Toncoins->Toncoin",
+        "WorkChain->workchain",
+      ],
     },
-    // Do not check for banned words (denylist) in certain files
+    // Do not check for banned words (denylists or flagWords) in certain files
     {
       "filename": "contribute/style-guide*.mdx",
       "ignoreWords": [
         "tos",
         "DOI",
+        "boc",
         "BOC",
       ],
+      "ignoreRegExpList": [
+        "\\b[tT]on[a-zA-Z]+\\b", // ton or Ton-prefixed words
+        "\\b[a-zA-Z]+Chain\\b", // Chain-suffixed words
+      ],
       "dictionaries": [
-        "!deny-list"
+        "!deny-list", // turns off the dictionary
+        "!2lw-deny-list", // turns off the dictionary
       ]
     },
     {
-      "filename": "**/api/**/v*",
+      "filename": "**/api/**/*.{json,yml,yaml}",
+      "ignoreWords": [
+        "smc",
+      ],
       "dictionaries": [
-        "!deny-list"
+        "!deny-list", // turns off the dictionary
+        "!2lw-deny-list", // turns off the dictionary
       ]
     },
+    {
+      "filename": "**/*.{js,jsx,mjs}",
+      "ignoreWords": [
+        "Dests",
+      ],
+      "dictionaries": [
+        "!deny-list", // turns off the dictionary
+        "!2lw-deny-list", // turns off the dictionary
+      ]
+    }
   ],
   "ignorePaths": [
     // Some whitepapers
     "foundations/whitepapers/tblkch.mdx",
     "foundations/whitepapers/ton.mdx",
+    "foundations/whitepapers/tvm.mdx",
+    "languages/fift/whitepaper.mdx",
     // Generated files
     "tvm/instructions.mdx",
     // Binaries
@@ -80,6 +124,7 @@
     "**/*.svg",
     "**/*.txt",
     "CODEOWNERS",
+    "LICENSE-*",
     "snippets/tvm-instruction-table.jsx",
   ],
   "ignoreRegExpList": [
@@ -110,11 +155,11 @@
     "=\\s*\".*?\"", // ="..."
     "(?<!\\\\)\\$(?:\\\\.|[^$\\\\])*?\\$", // inline math
     "/(?<!\\\\)\\$\\$[\\s\\S]*?\\$\\$/g", // block math
+    "(?<!\\\\)``.*?``", // inline code with double backticks
     "(?<!\\\\)`.*?`", // inline code
     "/^([ \\t]*```).*([\\s\\S]*?)^\\1$/gmx", // block code
     "^import[ \\t].+$", // import ...
     "/^export[ \\t].+?(?=\\r?\\n\\r?\\n)/gms", // export ...
     "(?<!\\\\)\\{(?:[^{}]|\\{(?:[^{}]|\\{[^{}]*\\})*\\})*\\}", // jsx expressions in {}
-    "/\\bton-?[a-z]+/gi", // ton-prefixed product names
   ],
 }

.github/workflows/linter.yml

@@ -88,8 +88,8 @@ jobs:
     steps:
       - name: Checkout repository
         uses: actions/checkout@v4
-        with:
-          fetch-depth: 0
+        # The fetch-depth is not set to 0 to prevent the cspell-action
+        # from misfiring on files that are in main but not on this PR branch
 
       - name: Setup Node.js
         uses: actions/setup-node@v4
@@ -108,6 +108,7 @@ jobs:
         with:
           check_dot_files: explicit
           suggestions: true
+          config: ".cspell.jsonc"
 
   redirects-check:
     name: "Redirects"

.remarkignore

@@ -16,3 +16,4 @@ node_modules/
 /tvm/instructions.mdx
 /ecosystem/api/toncenter/v2/
 /ecosystem/api/toncenter/v3/
+/ecosystem/api/toncenter/smc-index/

README.md

@@ -45,6 +45,8 @@ The dictionaries (or vocabularies) for custom words are placed under `resources/
 
 The primary dictionary is `resources/dictionaries/custom.txt` — extend it in case a word exists but was flagged by CSpell as invalid, or in cases where the word does not exist and shall be prohibited. For the latter, use the `!` prefix when adding words.
 
+If an existing two-letter word was flagged as forbidden, remove it from the `resources/dictionaries/two-letter-words-ban.txt` file.
+
 See more: [CSpell docs on custom dictionaries](https://cspell.org/docs/dictionaries/custom-dictionaries).
 
 ### Format checks

contract-dev/blueprint/api.mdx

@@ -240,7 +240,7 @@ Waits for a contract to be deployed by polling the address until the contract ap
 export async function run(provider: NetworkProvider) {
   // Send deployment transaction
   await contract.sendDeploy(provider.sender(), { value: toNano('0.01') });
-  
+
   // Wait for deployment to complete
   await provider.waitForDeploy(contract.address);
   console.log('Contract deployed successfully');
@@ -490,14 +490,14 @@ Presents a list of choices to the user and returns the selected option.
 ```typescript
 export async function run(provider: NetworkProvider) {
   const ui = provider.ui();
-  
+
   const networks = ['mainnet', 'testnet'];
   const selectedNetwork = await ui.choose(
     'Select deployment network:',
     networks,
     (network) => network.toUpperCase()
   );
-  
+
   ui.write(`Selected network: ${selectedNetwork}`);
 }
 ```
@@ -520,10 +520,10 @@ Sets a persistent action prompt that remains visible during operations.
 export async function run(provider: NetworkProvider) {
   const ui = provider.ui();
   ui.setActionPrompt('⏳ Waiting for transaction confirmation...');
-  
+
   await contract.send(provider.sender(), { value: toNano('0.01') }, 'increment');
   await provider.waitForLastTransaction();
-  
+
   ui.clearActionPrompt();
   ui.write('✅ Transaction confirmed');
 }
@@ -543,10 +543,10 @@ Clears the current action prompt, removing it from display.
 export async function run(provider: NetworkProvider) {
   const ui = provider.ui();
   ui.setActionPrompt('🔄 Processing...');
-  
+
   // Perform some operation
   await someAsyncOperation();
-  
+
   ui.clearActionPrompt();
   ui.write('Operation completed');
 }
@@ -789,10 +789,10 @@ type Explorer = 'tonscan' | 'tonviewer' | 'toncx' | 'dton';
 
 **Supported explorers:**
 
-- `'tonscan'` — TONScan explorer
+- `'tonscan'` — Tonscan explorer
 - `'tonviewer'` — Tonviewer explorer (default)
 - `'toncx'` — TON.cx explorer
-- `'dton'` — dton.io explorer
+- `'dton'` — dTON.io explorer
 
 ## Configuration
 

contract-dev/blueprint/cli.mdx

@@ -159,8 +159,8 @@ npx blueprint run <SCRIPT> <ARGS...>
 
 - `--tonscan` — use Tonscan explorer
 - `--tonviewer` — use Tonviewer explorer (default)
-- `--toncx` — use Toncx explorer
-- `--dton` — use Dton explorer
+- `--toncx` — use TON.cx explorer
+- `--dton` — use dTON explorer
 
 **Usage examples:**
 

contract-dev/blueprint/overview.mdx

@@ -50,7 +50,7 @@ npm create ton@latest
 - `scripts/` — deployment scripts for Mainnet and Testnet, as well as scripts for interacting with live contracts.
 - `tests/` — TypeScript test suite for all contracts, using [Sandbox](https://github.com/ton-org/sandbox) for in-process execution.
 - `wrappers/` — TypeScript interface classes for all contracts **except Tact**.
-  - Each wrapper implements the `Contract` interface from [@ton/core](https://www.npmjs.com/package/@ton/core).
+  - Each wrapper implements the `Contract` interface from [`@ton/core`](https://www.npmjs.com/package/@ton/core).
     - Provides message serialization and deserialization, getter wrappers, and compilation helpers.
     - Used in both the test suite and client code to interact with contracts from TypeScript.
 - `build/` — compilation artifacts generated by the build command.

contract-dev/debug.mdx

@@ -5,7 +5,7 @@ title: "Debugging smart contracts"
 import {Aside} from "/snippets/aside.jsx";
 
 <Aside>
-  All examples from this article are available on [Github](https://github.com/ton-org/docs-examples/tree/main/guidebook/debug).
+  All examples from this article are available on [GitHub](https://github.com/ton-org/docs-examples/tree/main/guidebook/debug).
 </Aside>
 
 Errors in smart contracts can produce an [exit code](/tvm/exit-codes), often indicating a bug in the contract. Use debugging methods to locate and fix the issue.

contract-dev/signing.mdx

@@ -33,7 +33,7 @@ TVM exposes additional cryptographic primitives beyond Ed25519. These are useful
 | [BLS12-381](https://en.wikipedia.org/wiki/BLS_digital_signature)                              | Pairing-based operations for signature aggregation and zero-knowledge proofs |
 | [Ristretto255](https://en.wikipedia.org/wiki/Curve25519#Ristretto)                            | Prime-order group over Curve25519 for advanced cryptographic constructions   |
 
-For details, see crypto instructions in [TVM instructions](/tvm/instructions), [TVM changelog](/tvm/changelog), or [GlobalVersions.md](https://github.com/ton-blockchain/ton/blob/5c0349110bb03dd3a241689f2ab334ae1a554ffb/doc/GlobalVersions.md).
+For details, see crypto instructions in [TVM instructions](/tvm/instructions), [TVM changelog](/tvm/changelog), or [`GlobalVersions.md`](https://github.com/ton-blockchain/ton/blob/5c0349110bb03dd3a241689f2ab334ae1a554ffb/doc/GlobalVersions.md).
 
 This guide focuses on Ed25519, usually used for TON.
 
@@ -167,7 +167,7 @@ graph
     C ~~~ D
     D ~~~ E
     E ~~~ F
-    
+
 ```
 
 Verification in FunC:
@@ -215,14 +215,14 @@ graph LR
         A[**signature**]
         B((msg_inner))
     end
-    
+
     subgraph Ref["Signed data (next cell)"]
         direction LR
         C[valid_until]
         D[seqno]
         E((actions))
     end
-    
+
     A ~~~ B
     B -.-> Ref
     C ~~~ D
@@ -276,7 +276,7 @@ Gas comparison:
 Conclusion:\
 With builder hashing optimization, both approaches are gas-efficient. New contracts can choose based on code simplicity and forward fee considerations.
 
-Reference: [GlobalVersions.md — TVM improvements](https://github.com/ton-blockchain/ton/blob/5c0349110bb03dd3a241689f2ab334ae1a554ffb/doc/GlobalVersions.md#new-tvm-instructions-4)
+Reference: [`GlobalVersions.md` — TVM improvements](https://github.com/ton-blockchain/ton/blob/5c0349110bb03dd3a241689f2ab334ae1a554ffb/doc/GlobalVersions.md#new-tvm-instructions-4)
 
 ## How to sign messages in TypeScript
 

contract-dev/using-onchain-libraries.mdx

@@ -43,7 +43,7 @@ code:(just
 ...
 ```
 
-While it is not crucial to understand the exact representation shown on [https://explorer.toncoin.org/](https://explorer.toncoin.org/) ([more about explorers](/ecosystem/explorers/overview)), the key point is that there is only one cell in the contract code, tagged as `SPECIAL` (indicating it is an exotic cell). Following this is the hexadecimal representation of the library cell's internals. The first byte equals 2, indicating that it is a library cell, and the remaining bytes contain the hash of the referenced cell.
+While it is not crucial to understand the exact representation shown on the [TON Explorer](https://explorer.toncoin.org/) ([more about explorers](/ecosystem/explorers/overview)), the key point is that there is only one cell in the contract code, tagged as `SPECIAL`, indicating it is an exotic cell. Following this is the hexadecimal representation of the library cell's internals. The first byte equals 2, indicating that it is a library cell, and the remaining bytes contain the hash of the referenced cell.
 
 Here you can see that the entire contract code consists of the 8‑bit tag equal to 2 and a 256‑bit representation hash of the referenced cell.