Merge branch 'main' into docs/coobook-jetton

tact-lang · Oct 25, 2024 · e065451 · e065451
2 parents 18f44af + 1adf5d5
commit e065451
Show file tree

Hide file tree

Showing 65 changed files with 4,014 additions and 1,197 deletions.
diff --git a/.husky/pre-push b/.husky/pre-push
@@ -1 +1 @@
-yarn lint:all
+yarn lint:all && cd docs && yarn lint:all
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -13,19 +13,24 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - New CSpell dictionaries: TVM instructions and adjusted list of Fift words: PR [#881](https://github.com/tact-lang/tact/pull/881)
 - Docs: the `description` property to the frontmatter of the each page for better SEO: PR [#916](https://github.com/tact-lang/tact/pull/916)
 - Docs: Google Analytics tags per every page: PR [#921](https://github.com/tact-lang/tact/pull/921)
+- Docs: Added NFTs cookbook: PR [#958](https://github.com/tact-lang/tact/pull/958)
 - Ability to specify a compile-time method ID expression for getters: PR [#922](https://github.com/tact-lang/tact/pull/922) and PR [#932](https://github.com/tact-lang/tact/pull/932)
+- Destructuring of structs and messages: PR [#856](https://github.com/tact-lang/tact/pull/856)
 
 ### Changed
 
+- The `parseImports` function now returns AST import nodes instead of raw strings: PR [#966](https://github.com/tact-lang/tact/pull/966)
 - Optional types for `self` argument in `extends mutates` functions are now allowed: PR [#854](https://github.com/tact-lang/tact/pull/854)
-- Docs: Enhanced cookbook/jetton page: PR [#944](https://github.com/tact-lang/tact/pull/944)
+- Docs: complete overhaul of the exit codes page: PR [#978](https://github.com/tact-lang/tact/pull/978)
+- Docs: enhanced Jettons Cookbook page: PR [#944](https://github.com/tact-lang/tact/pull/944)
 
 ### Fixed
 
 - Collisions in getter method ids are now handled and reported properly: PR [#875](https://github.com/tact-lang/tact/pull/875)
 - Docs: layout of tables, syntax highlighting, Chinese translations of sidebar separators: PR [#916](https://github.com/tact-lang/tact/pull/916)
 - Non-null struct fields after null ones are treated correctly in Sandbox tests after updating `@ton/core` to 0.59.0: PR [#933](https://github.com/tact-lang/tact/pull/933)
 - Prevent inline code snippets from changing their background color: PR [#935](https://github.com/tact-lang/tact/pull/935)
+- Docs: correctly handle next and previous page links at the bottom of the pages when there's a separator item in the sidebar: PR [#949](https://github.com/tact-lang/tact/pull/949)
 
 ### Release contributors
 
@@ -64,11 +69,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - The `storeBit` method for `Builder` type and the `loadBit` method for `Slice` type: PR [#699](https://github.com/tact-lang/tact/pull/699), PR [#936](https://github.com/tact-lang/tact/pull/936)
 - The `toSlice` method for structs and messages: PR [#630](https://github.com/tact-lang/tact/pull/630), PR [#936](https://github.com/tact-lang/tact/pull/936)
 - Wider range of serialization options for integers — `uint1` through `uint256` and `int1` through `int257`: PR [#558](https://github.com/tact-lang/tact/pull/558), PR [#937](https://github.com/tact-lang/tact/pull/937)
-- The `deepEquals` method for the `Map` type: PR [#637](https://github.com/tact-lang/tact/pull/637)
+- The `deepEquals` method for the `Map` type: PR [#637](https://github.com/tact-lang/tact/pull/637), PR [#939](https://github.com/tact-lang/tact/pull/939)
 - `asm` bodies for module-level functions: PR [#769](https://github.com/tact-lang/tact/pull/769), PR [#825](https://github.com/tact-lang/tact/pull/825)
 - Corresponding stdlib functions for new TVM instructions from 2023.07 and 2024.04 upgrades: PR [#331](https://github.com/tact-lang/tact/pull/331). Added the `storeBuilder` extension function and `gasConsumed`, `getComputeFee`, `getStorageFee`, `getForwardFee`, `getSimpleComputeFee`, `getSimpleForwardFee`, `getOriginalFwdFee`, `myStorageDue` functions.
 - `slice`, `rawSlice`, `ascii` and `crc32` built-in functions: PR [#787](https://github.com/tact-lang/tact/pull/787), PR [#799](https://github.com/tact-lang/tact/pull/799)
-- `Builder.storeMaybeRef`, `parseStdAddress` and `parseVarAddress` stdlib functions: PR [#793](https://github.com/tact-lang/tact/pull/793)
+- `Builder.storeMaybeRef`, `parseStdAddress` and `parseVarAddress` stdlib functions: PR [#793](https://github.com/tact-lang/tact/pull/793), PR [#950](https://github.com/tact-lang/tact/pull/950)
 - The compiler development guide: PR [#833](https://github.com/tact-lang/tact/pull/833)
 - Constant evaluator now uses an interpreter: PR [#664](https://github.com/tact-lang/tact/pull/664). This allows calls to user-defined functions and references to declared global constants.
 

diff --git a/cspell-fift-words-adjusted.txt b/cspell-fift-words-adjusted.txt
@@ -29,6 +29,7 @@ Pos
 Split
 abort
 abs
+addop
 allot
 and
 anon

diff --git a/cspell.json b/cspell.json
@@ -106,6 +106,8 @@
     "Tarjan",
     "testdata",
     "Topup",
+    "Toncoin",
+    "Toncoins",
     "Trunov",
     "typechecker",
     "uintptr",

diff --git a/docs/README.md b/docs/README.md
@@ -101,6 +101,10 @@ All commands are run from the root of the project, from a terminal:
 | `yarn astro ...`          | Run CLI commands like `astro add`, `astro check`, etc.
 | `yarn astro -- --help`    | Get help using the Astro CLI.
 
+### ⚠️ Gotchas
+
+- When updating TextMate grammars in `grammars/` (for example, `grammar-tact.json`), make sure that the value for the `"name"` property is written all lowercase, otherwise highlighting will break.
+
 ### 👀 Want to learn more about the framework behind Tact docs?
 
 Check out [Starlight’s docs](https://starlight.astro.build/), read [the Astro documentation](https://docs.astro.build), or jump into the [Astro Discord server](https://astro.build/chat).

diff --git a/docs/astro.config.mjs b/docs/astro.config.mjs
@@ -33,7 +33,8 @@ export default defineConfig({
 				behavior: "append",
 				properties: {
 					class: "autolink-header",
-					ariaHidden: true,
+					ariaHidden: "true",
+					ariaLabel: "Link to this header",
 					tabIndex: -1,
 				},
 			}],
@@ -137,7 +138,8 @@ export default defineConfig({
 						{
 							label: 'Fundamentals of Tact',
 							translations: { 'zh-CN': 'Tact 语言基础' },
-							link: '#', attrs: { class: 'sidebar-separator' }
+							attrs: { class: 'sidebar-separator' },
+							link: 'book/types#',
 						},
 						{ slug: 'book/types' },
 						{ slug: 'book/integers' },
@@ -150,7 +152,8 @@ export default defineConfig({
 						{
 							label: 'Expressiveness',
 							translations: { 'zh-CN': '表现力' },
-							link: '#', attrs: { class: 'sidebar-separator' }
+							attrs: { class: 'sidebar-separator' },
+							link: 'book/operators#',
 						},
 						{ slug: 'book/operators' },
 						{ slug: 'book/expressions' },
@@ -160,7 +163,8 @@ export default defineConfig({
 						{
 							label: 'Communication',
 							translations: { 'zh-CN': '交流' },
-							link: '#', attrs: { class: 'sidebar-separator' }
+							attrs: { class: 'sidebar-separator' },
+							link: 'book/receive#',
 						},
 						{ slug: 'book/receive' },
 						{ slug: 'book/bounced' },
@@ -171,7 +175,8 @@ export default defineConfig({
 						{
 							label: 'Going places',
 							translations: { 'zh-CN': '前往各地' },
-							link: '#', attrs: { class: 'sidebar-separator' }
+							attrs: { class: 'sidebar-separator' },
+							link: 'book/deploy#',
 						},
 						{ slug: 'book/deploy' },
 						{ slug: 'book/debug' },
@@ -193,7 +198,8 @@ export default defineConfig({
 						{
 							label: 'Single contract',
 							translations: { 'zh-CN': '单一合同' },
-							link: '#', attrs: { class: 'sidebar-separator' }
+							attrs: { class: 'sidebar-separator' },
+							link: 'cookbook/single-communication#',
 						},
 						{ slug: 'cookbook/single-communication' },
 						{ slug: 'cookbook/type-conversion' },
@@ -206,7 +212,8 @@ export default defineConfig({
 						{
 							label: 'Multiple contracts',
 							translations: { 'zh-CN': '多重合同' },
-							link: '#', attrs: { class: 'sidebar-separator' }
+							attrs: { class: 'sidebar-separator' },
+							link: 'cookbook/multi-communication#',
 						},
 						{ slug: 'cookbook/multi-communication' },
 						{ slug: 'cookbook/jettons' },
@@ -240,7 +247,8 @@ export default defineConfig({
 						{
 							label: 'Core library',
 							translations: { 'zh-CN': '核心图书馆' },
-							link: '#', attrs: { class: 'sidebar-separator' }
+							attrs: { class: 'sidebar-separator' },
+							link: 'ref/core-base#',
 						},
 						{ slug: 'ref/core-base' },
 						{ slug: 'ref/core-common' },
@@ -254,7 +262,8 @@ export default defineConfig({
 						{
 							label: 'Standard libraries',
 							translations: { 'zh-CN': '标准图书馆' },
-							link: '#', attrs: { class: 'sidebar-separator' }
+							attrs: { class: 'sidebar-separator' },
+							link: 'ref/standard-libraries#',
 						},
 						{ slug: 'ref/standard-libraries' },
 						{ slug: 'ref/stdlib-config' },
@@ -275,7 +284,8 @@ export default defineConfig({
 						{
 							label: 'Tools',
 							translations: { 'zh-CN': '工具' },
-							link: '#', attrs: { class: 'sidebar-separator' }
+							attrs: { class: 'sidebar-separator' },
+							link: 'ecosystem/typescript#',
 						},
 						{ slug: 'ecosystem/typescript' },
 						{ slug: 'ecosystem/vscode' },

diff --git a/docs/cspell.json b/docs/cspell.json
@@ -2,55 +2,39 @@
   "$schema": "https://raw.githubusercontent.com/streetsidesoftware/cspell/main/cspell.schema.json",
   "version": "0.2",
   "language": "en",
+  "dictionaryDefinitions": [
+    {
+      "name": "fift-words",
+      "path": "../cspell-fift-words-adjusted.txt"
+    },
+    {
+      "name": "tvm-instructions",
+      "path": "../cspell-tvm-instructions.txt"
+    }
+  ],
+  "dictionaries": ["fift-words", "tvm-instructions"],
   "words": [
     "ADDRAND",
     "BBITS",
     "BREFS",
     "Brujin",
-    "CHKSIGNS",
-    "CHKSIGNU",
-    "CONFIGOPTPARAM",
-    "CTOS",
     "Cheatsheet",
     "Cheatsheets",
     "Comptime",
-    "DEBUGSTR",
-    "DUEPAYMENT",
     "Daniil",
     "Decompilation",
     "Decompiled",
     "Descr",
     "Domínguez",
-    "ENDC",
     "Epva",
-    "Fift",
-    "Fift",
-    "GASCONSUMED",
-    "GETFORWARDFEE",
-    "GETFORWARDFEESIMPLE",
-    "GETGASFEE",
-    "GETGASFEESIMPLE",
-    "GETORIGINALFWDFEE",
-    "GETSTORAGEFEE",
     "Georgiy",
-    "HASHCU",
-    "HASHEXT",
-    "HASHSU",
     "Héctor",
     "IPFS",
     "Jesús",
     "Jetton",
     "Jettons",
-    "KECCAK",
     "Komarov",
     "Korshakov",
-    "LDDICT",
-    "LDIX",
-    "LDREF",
-    "LDSLICEX",
-    "LDUX",
-    "LDVARUINT",
-    "LTIME",
     "Laika",
     "MYADDR",
     "Masterchain",

diff --git a/docs/package.json b/docs/package.json
@@ -7,16 +7,17 @@
     "clean": "rm -rf dist/ out/ .astro/",
     "deps": "yarn install --frozen-lockfile",
     "dev": "astro dev",
-    "build": "yarn clean && yarn spell && astro check && astro build",
+    "build": "yarn clean && yarn lint:all && astro check && astro build",
     "preview": "astro preview",
     "astro": "astro",
-    "spell": "cspell --no-progress src/content/docs"
+    "spell": "cspell --no-progress src/content/docs",
+    "lint:all": "yarn spell"
   },
   "dependencies": {
     "@astrojs/check": "^0.9.3",
     "@astrojs/markdown-remark": "^5.2.0",
     "@astrojs/starlight": "^0.28.2",
-    "astro": "^4.15.3",
+    "astro": "^4.16.1",
     "cspell": "^8.14.4",
     "hast-util-to-string": "^3.0.0",
     "rehype-autolink-headings": "7.1.0",

diff --git a/docs/src/content/docs/book/deploy.mdx b/docs/src/content/docs/book/deploy.mdx
@@ -1,6 +1,9 @@
 ---
 title: Deployment
 description: "Common ways to deploy Tact contracts to testnet or mainnet of TON Blockchain"
+prev:
+  link: /book/message-mode
+  label: Message mode
 ---
 
 Tact Deployer is a small library that integrates with [TON Verifier](https://verifier.ton.org) that allows you to deploy your contracts safely using your favorite wallet without needing to manage keys or deploy contracts manually. Tact Deployer also automatically verifies your contract's source code and you can be sure that your compiler is not compromised.