Add how to burn page #609

Karkarmath · 2025-10-07T16:49:19Z

Closes #216

github-actions · 2025-10-07T17:03:01Z

Thanks for the update to the jetton burning how‑to. I reviewed the changes in standard/tokens/jettons/how-to-burning.mdx; a few blocking doc/style fixes are needed before merge.

Findings (5)

High (5)

[HIGH] Missing safety callout for funds and keys

Location: https://github.com/tact-lang/mintlify-ton-docs/blob/70a4115d7690c5d0b574405e89cd6b9197e0c94c/standard/tokens/jettons/how-to-burning.mdx?plain=1#L11-L16

Description:
This guide performs chain‑affecting operations (burning jettons and sending a wallet message) and uses wallet credentials but lacks the required safety callout before the actionable code. Per the style guide, steps that move funds or perform on‑chain operations must include a Warning/Caution covering risk, scope, rollback, and testnet‑first guidance (see https://github.com/tact-lang/mintlify-ton-docs/blob/main/contribute/style-guide-extended.mdx?plain=1#L465-L470 and https://github.com/tact-lang/mintlify-ton-docs/blob/main/contribute/style-guide-extended.mdx?plain=1#L472-L479).

Suggestion:
Add a Warning callout immediately before the code block clarifying risk, scope, rollback, and to use Testnet first.

 It is possible to do it manually via your favorite IDE:
+
+> [!WARNING] Funds and keys at risk — use Testnet first
+> This example moves value on-chain and uses a mnemonic/private key.
+> Risk: irreversible transactions; Rollback: none; Scope: your wallet and jetton wallet.
+> Use TON Testnet first and label environments explicitly. Never paste real mnemonics; use secure storage.
+
 ```typescript

[HIGH] Inlined mnemonic in code (unsafe secret handling)

Location: https://github.com/tact-lang/mintlify-ton-docs/blob/70a4115d7690c5d0b574405e89cd6b9197e0c94c/standard/tokens/jettons/how-to-burning.mdx?plain=1#L45-L49

Description:
The example inlines a mnemonic as a string literal, normalizing unsafe handling of secrets. This risks accidental leaks via source control, logs, or screenshots and violates the rule to never inline secrets in guides (see https://github.com/tact-lang/mintlify-ton-docs/blob/main/contribute/style-guide-extended.mdx?plain=1#L498-L500).

Suggestion:
Replace the inline mnemonic with an environment variable and validate its presence.

-    const your_mnemonic = 'put your mnemonic here, ...';
-    const keyPair = await mnemonicToPrivateKey(your_mnemonic.split(" "));
+    const MNEMONIC = process.env.MNEMONIC;
+    if (!MNEMONIC) throw new Error("Set MNEMONIC env var with a test mnemonic.");
+    const keyPair = await mnemonicToPrivateKey(MNEMONIC.split(" "));

[HIGH] Undefined placeholders in example (copy/paste hazard)

Location: https://github.com/tact-lang/mintlify-ton-docs/blob/70a4115d7690c5d0b574405e89cd6b9197e0c94c/standard/tokens/jettons/how-to-burning.mdx?plain=1#L20-L22

Description:
The snippet uses free‑form text placeholders like “put your … address” that are not defined on first use and do not follow the required placeholder formats. Undefined placeholders increase copy/paste errors and violate the placeholder convention (see https://github.com/tact-lang/mintlify-ton-docs/blob/main/contribute/style-guide-extended.mdx?plain=1#L392-L400).

Suggestion:
Use <ANGLE_CASE> placeholders and define them after the code block.

-    const jettonWalletAddress = Address
-                                .parse('put your Jetton wallet address');
-    const destinationAddress = Address
-                                .parse('put your regular wallet address');
+    const jettonWalletAddress = Address.parse('<JETTON_WALLET_ADDR>');
+    const destinationAddress = Address.parse('<WALLET_ADDR>');

Add after the code block:

Define placeholders (first use):
`<JETTON_WALLET_ADDR>` — your jetton wallet address.
`<WALLET_ADDR>` — your wallet address to receive responses.
`<RPC_URL_TESTNET>` — HTTPS endpoint of your TON testnet RPC provider.
`<MNEMONIC>` — your 24‑word seed phrase (set via `MNEMONIC` environment variable).

[HIGH] UI strings formatted as code instead of quotation marks

Location: https://github.com/tact-lang/mintlify-ton-docs/blob/70a4115d7690c5d0b574405e89cd6b9197e0c94c/standard/tokens/jettons/how-to-burning.mdx?plain=1#L67-L69

Description:
UI labels (“Jetton address”, “Burn”) are wrapped in code backticks instead of double quotation marks. UI strings must appear verbatim in double quotes for accurate copying and translation (see https://github.com/tact-lang/mintlify-ton-docs/blob/main/contribute/style-guide-extended.mdx?plain=1#L262-L266).

Suggestion:
Replace backticks with double quotation marks for UI labels.

-Or via web services as [TON MINTER](https://minter.ton.org/). Connect your wallet via Ton connect.
-Insert the Jetton master contract address in the `Jetton address` field. Next, click the `Burn` button in the balance field of your wallet
+Or via web services as [TON MINTER](https://minter.ton.org/). Connect your wallet via Ton connect.
+Insert the Jetton master contract address in the "Jetton address" field. Next, click the "Burn" button in the balance field of your wallet
 and enter the amount to burn.

[HIGH] Unlabeled non‑runnable snippet

Location: https://github.com/tact-lang/mintlify-ton-docs/blob/70a4115d7690c5d0b574405e89cd6b9197e0c94c/standard/tokens/jettons/how-to-burning.mdx?plain=1#L11-L16

Description:
The code block requires real addresses, a mnemonic, and network setup, and cannot run as shown. Partial snippets must be clearly labeled as “Not runnable” to prevent copy/paste failures (see https://github.com/tact-lang/mintlify-ton-docs/blob/main/contribute/style-guide-extended.mdx?plain=1#L430-L434).

Suggestion:
Label the snippet as not runnable.

 It is possible to do it manually via your favorite IDE:
 
+Not runnable
+
 ```typescript

…n-docs into add-how-to-burning

verytactical · 2025-10-10T08:50:01Z

standard/tokens/jettons/how-to-burning.mdx

+import { Aside } from '/snippets/aside.jsx';
+
+<Aside type="danger" title="Warning — funds at risk">
+Burning can move funds. Scope: your wallet and the target jetton contracts.


Didn't understand this whole paragraph.

I was advice from AI. I think I will just remove it.

verytactical · 2025-10-10T08:51:34Z

standard/tokens/jettons/how-to-burning.mdx

+Jettons burning is primarily intended to get rid of unnecessary jettons (those with low liquidity or a zero price) and
+to influence the market (burning a large number of jettons could increase its liquidity).
+
+It is possible to do it manually via your favorite IDE:


Doesn't really matter if IDE is favorite.

The intent of the sentence should've been "here is the code for that".

verytactical · 2025-10-10T08:52:11Z

standard/tokens/jettons/how-to-burning.mdx

+    const jettonWalletAddress = Address.parse('<JETTON_WALLET_ADDR>');
+    const destinationAddress = Address.parse('<WALLET_ADDR>');
+
+    const messageBody = beginCell()


Don't we have bindings for that?

@ton/ton or @ton-community/assets-sdk should have constructors for all these Jetton messages.

Yes, we have. I added a full construction of message just as illustrative example. I will add after that the code used assets-sdk.

verytactical · 2025-10-10T08:52:52Z

standard/tokens/jettons/how-to-burning.mdx

+
+    // connect to your regular wallet
+    const client = new TonClient({
+    endpoint: 'https://toncenter.com/api/v2/jsonRPC',


Consider using prettier

verytactical · 2025-10-10T08:58:40Z

standard/tokens/jettons/how-to-burning.mdx

+void main();
+```
+
+Or via web services as [TON MINTER](https://minter.ton.org/). Connect your wallet via Ton connect.


Alternative approach should go under separate ##;

Grammar;

Lists should be formatted as - lists, not paragraphs;

Need a screenshot here.

Done. On TON MINTER there is no dark theme, so there will be only one screenshot.

verytactical

.

github-actions · 2025-10-10T11:36:11Z

To fix the formatting issues:

Install necessary dependencies: npm ci
Then, run this command:

npx remark -o --silent --silently-ignore standard/tokens/jettons/how-to-burning.mdx

skywardboundd · 2025-10-10T11:42:42Z

We can burn some asset just send it to null account:
UQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAJKZ

github-actions · 2025-10-13T09:44:23Z

Thanks for the improvements to the jetton burning guide. A couple of high‑impact fixes are needed before merge.

Findings (2)

High (2)

[HIGH] Missing safety callout for funds and keys

Location: https://github.com/tact-lang/mintlify-ton-docs/blob/e5958a92b3ff5224c15b6250b3ee0948bad33966/standard/tokens/jettons/how-to-burning.mdx?plain=1#L53-L59

Description:
This page performs fund‑affecting actions and uses a mnemonic‑derived key to sign transfers without the required Warning/Caution. The risk starts before the first code block and is reinforced where the mnemonic is read and burn/transfer calls are sent (e.g., import/read of process.env.MNEMONIC, sendTransfer, sendBurn). The callout must cover risk, scope, rollback, and testnet‑first guidance.

Suggestion:

--- a/standard/tokens/jettons/how-to-burning.mdx
+++ b/standard/tokens/jettons/how-to-burning.mdx
@@
 Jettons burning is primarily intended to get rid of unnecessary jettons (those with low liquidity or a zero price) and
 to influence the market (burning a large number of jettons could increase its liquidity).
 
+Warning — funds at risk
+Burning jettons transfers assets and requires your private key/mnemonic. Scope: your wallet’s jetton balance. Rollback: none—on‑chain burns are final. Do first (testnet): set `NETWORK="testnet"` (for SDK) and use a testnet RPC endpoint.
+
 Here is the code for that:

[HIGH] Placeholders not defined on first use

Location: https://github.com/tact-lang/mintlify-ton-docs/blob/e5958a92b3ff5224c15b6250b3ee0948bad33966/standard/tokens/jettons/how-to-burning.mdx?plain=1#L20-L21

Description:
Placeholders appear in examples without first‑use definitions, creating copy/paste hazards. In the first snippet, <JETTON_WALLET_ADDR> and <WALLET_ADDR> lack definitions; in the SDK snippet, MY_JETTON_ADDRESS and RECEIVER_ADDRESS are also undefined (see standard/tokens/jettons/how-to-burning.mdx?plain=1#L97-L101).

Suggestion:

--- a/standard/tokens/jettons/how-to-burning.mdx
+++ b/standard/tokens/jettons/how-to-burning.mdx
@@
 void main();

+Define placeholders (first use):
+<JETTON_WALLET_ADDR> — address of your jetton wallet contract (the wallet you will burn from).
+<WALLET_ADDR> — your wallet address to receive responses (same wallet controlling the burn).
@@
void main();


+Define placeholders (first use):
+`MY_JETTON_ADDRESS` — address of the jetton wallet you control on the selected network.
+`RECEIVER_ADDRESS` — address placeholder used in SDK examples (not used by `sendBurn` here; keep consistent with your wallet context).

Kaladin13

All good, please add cross-link

standard/tokens/jettons/how-to-burning.mdx

…n-docs into add-how-to-burning

github-actions · 2025-10-14T14:23:45Z

Thanks for the updates to the jetton burn docs. A few safety and placeholder fixes are needed before merge, focused in the jetton burning guide and its runnable snippet.

Findings (3)

High (3)

[HIGH] Missing safety callout for funds/keys usage

Location: https://github.com/tact-lang/mintlify-ton-docs/blob/d9a57517747b41a0a1dd5f32d6b7cae68aa8a693/standard/tokens/jettons/how-to-burning.mdx?plain=1#L47-L51

Description:
The snippet constructs a wallet and calls sendBurn, which moves assets irreversibly and handles private keys, but there is no required Warning/Caution callout immediately before the code. Safety callouts must communicate risk, scope, mitigation/rollback, and environment labeling per the style guide.

Suggestion:
Add a Warning <Aside> before the code block and import the component.

--- a/standard/tokens/jettons/how-to-burning.mdx
+++ b/standard/tokens/jettons/how-to-burning.mdx
@@
-import { Image } from '/snippets/image.jsx';
+import { Image } from '/snippets/image.jsx';
+import { Aside } from '/snippets/aside.jsx';
@@
-Here is the code for that:
+Here is the code for that:
+
+<Aside type="danger" title="Funds at risk">
+  Burning jettons transfers assets and is irreversible.
+
+  Do first (testnet):
+  - Use a testnet wallet and set all endpoints to testnet.
+  - Verify jetton wallet address and burn amount before sending.
+
+  If you must use mainnet: There is no rollback. On‑chain transfers are final.
+</Aside>

[HIGH] Inline mnemonic encourages secret exposure

Location: https://github.com/tact-lang/mintlify-ton-docs/blob/d9a57517747b41a0a1dd5f32d6b7cae68aa8a693/standard/tokens/jettons/how-to-burning.mdx?plain=1#L28-L29

Description:
The example hardcodes a mnemonic and derives a key directly from it, encouraging unsafe secret handling. Examples must not inline secrets and should instruct readers to use environment variables or keystores.

Suggestion:
Replace the inline string with an environment variable and validate it before use.

--- a/standard/tokens/jettons/how-to-burning.mdx
+++ b/standard/tokens/jettons/how-to-burning.mdx
@@
-    const your_mnemonic = "put your mnemonic here, ...";
-    const keyPair = await mnemonicToPrivateKey(your_mnemonic.split(" "));
+    const MNEMONIC = process.env.MNEMONIC;
+    if (!MNEMONIC) throw new Error("Set MNEMONIC (space-separated words)");
+    const keyPair = await mnemonicToPrivateKey(MNEMONIC.split(" "));

[HIGH] Undefined/non‑standard placeholders in code sample (copy/paste hazard)

Location: https://github.com/tact-lang/mintlify-ton-docs/blob/d9a57517747b41a0a1dd5f32d6b7cae68aa8a693/standard/tokens/jettons/how-to-burning.mdx?plain=1#L47-L51

Description:
The snippet uses narrative strings (“put youe Jetton wallet address”, “put receiver address”) instead of clearly defined placeholders, which is a copy/paste hazard and violates placeholder rules. Placeholders should be explicit, standardized, and defined on first use.

Suggestion:
Replace free‑form text with defined placeholders and define them on first use.

--- a/standard/tokens/jettons/how-to-burning.mdx
+++ b/standard/tokens/jettons/how-to-burning.mdx
@@
-    const JETTON_ADDRESS = Address.parse("put youe Jetton wallet address");
-    const jetton = sdk.openJettonWallet(JETTON_ADDRESS);
-
-    const RECEIVER_ADDRESS = Address.parse("put receiver address");
+    const JETTON_WALLET_ADDR = Address.parse("JETTON_WALLET_ADDR"); // placeholder
+    const jetton = sdk.openJettonWallet(JETTON_WALLET_ADDR);
@@
  void main();

+Define placeholders (first use):
+JETTON_WALLET_ADDR — address of your jetton wallet on the selected NETWORK.

Initial commit

70a4115

Karkarmath requested review from Kaladin13, Shvandre, anton-trunov and verytactical October 7, 2025 16:49

Karkarmath self-assigned this Oct 7, 2025

mintlify bot deployed to staging October 7, 2025 16:50 View deployment

Merge branch 'main' into add-how-to-burning

7b93ea5

mintlify bot deployed to staging October 8, 2025 10:37 View deployment

Karkarmath added 2 commits October 9, 2025 17:52

Fixes

cb9f35e

Merge branch 'add-how-to-burning' of github.com:tact-lang/mintlify-to…

4706a1a

…n-docs into add-how-to-burning

verytactical reviewed Oct 10, 2025

View reviewed changes

verytactical requested changes Oct 10, 2025

View reviewed changes

Karkarmath added 3 commits October 10, 2025 13:15

Tempo

20823ec

Improvements

f5dcbc4

Delete side files

2c378c5

mintlify bot deployed to staging October 10, 2025 11:35 View deployment

Merge branch 'main' into add-how-to-burning

e1cacdd

mintlify bot deployed to staging October 10, 2025 11:36 View deployment

Formater

136dfc6

mintlify bot deployed to staging October 10, 2025 11:37 View deployment

Karkarmath requested a review from verytactical October 10, 2025 11:37

Puka

ad3a2b9

mintlify bot deployed to staging October 10, 2025 11:59 View deployment

Fixes

4774deb

mintlify bot deployed to staging October 10, 2025 12:14 View deployment

verytactical marked this pull request as draft October 10, 2025 15:36

Merge branch 'main' into add-how-to-burning

e5958a9

mintlify bot deployed to staging October 13, 2025 09:26 View deployment

Karkarmath removed request for Kaladin13, Shvandre and anton-trunov October 13, 2025 09:26

Karkarmath marked this pull request as ready for review October 13, 2025 09:29

Merge branch 'main' into add-how-to-burning

58e99dd

mintlify bot deployed to staging October 13, 2025 10:21 View deployment

Kaladin13 requested changes Oct 13, 2025

View reviewed changes

standard/tokens/jettons/how-to-burning.mdx Outdated Show resolved Hide resolved

Karkarmath added 2 commits October 13, 2025 15:09

link

c8f7655

Merge branch 'add-how-to-burning' of github.com:tact-lang/mintlify-to…

f0aac82

…n-docs into add-how-to-burning

Karkarmath requested a review from Kaladin13 October 13, 2025 12:10

mintlify bot deployed to staging October 13, 2025 12:11 View deployment

verytactical marked this pull request as draft October 13, 2025 22:51

Fixes

db1e2fb

mintlify bot deployed to staging October 14, 2025 14:08 View deployment

Merge branch 'main' into add-how-to-burning

d9a5751

Karkarmath marked this pull request as ready for review October 14, 2025 14:09

mintlify bot deployed to staging October 14, 2025 14:09 View deployment

Add how to burn page #609

Are you sure you want to change the base?

Add how to burn page #609

Conversation

Karkarmath commented Oct 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Oct 7, 2025

Findings (5)

High (5)

[HIGH] Missing safety callout for funds and keys

[HIGH] Inlined mnemonic in code (unsafe secret handling)

[HIGH] Undefined placeholders in example (copy/paste hazard)

[HIGH] UI strings formatted as code instead of quotation marks

[HIGH] Unlabeled non‑runnable snippet

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

verytactical left a comment

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Oct 10, 2025

Uh oh!

skywardboundd commented Oct 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Oct 13, 2025

Findings (2)

High (2)

[HIGH] Missing safety callout for funds and keys

[HIGH] Placeholders not defined on first use

Uh oh!

Kaladin13 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

github-actions bot commented Oct 14, 2025

Findings (3)

High (3)

[HIGH] Missing safety callout for funds/keys usage

[HIGH] Inline mnemonic encourages secret exposure

[HIGH] Undefined/non‑standard placeholders in code sample (copy/paste hazard)

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Karkarmath commented Oct 7, 2025 •

edited

Loading

skywardboundd commented Oct 10, 2025 •

edited

Loading