feat: add recommendations for all staking solutions #1664
Conversation
novusnota
changed the title
novusnota
changed the title
This comment has been minimized.
This comment has been minimized.
|
/review |
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
| ## Nominator instructions | ||
|
|
||
| - To deposit, send an empty message with TON to the single nominator pool contract. | ||
| - To withdraw, send a message with 1 TON and the text comment "w" (withdraw) to the contract. | ||
|
|
There was a problem hiding this comment.
[HIGH] Missing safety callout for single nominator deposits and withdrawals
The “Nominator instructions” section describes concrete steps to deposit and withdraw TON via the single nominator pool contract, including sending 1 TON with a "w" comment to trigger withdrawal. These steps clearly move funds and change withdrawal behavior, but the page does not include any <Aside> safety callout covering risk, scope, mitigation, and testnet vs mainnet context. The style guide requires a Caution or Warning callout for any page or step that moves funds or affects fees/withdrawals (see https://github.com/ton-org/docs/blob/main/contribute/style-guide-extended.mdx?plain=1#L634-L660). Without a visible callout, readers may execute mainnet transactions and lose funds or get stuck withdrawals without being warned.
Please leave a reaction 👍/👎 to this suggestion to improve future reviews for everyone!
| ## How to stake | ||
|
|
||
| 1. Choose a pool on [TON Nominators](https://tonvalidators.org/) and review its parameters, commission, and minimum stake. | ||
| 1. Send a message to the nominator pool contract with: | ||
| - The desired TON amount. | ||
| - The text comment "d" for deposit. | ||
| 1. The sent amount must be at least `min_nominator_stake + 1 TON`, while 1 TON is deducted as the deposit fee. | ||
| 1. If the pool is not currently validating, the deposit is credited immediately; otherwise, it is added to pending deposits. | ||
|
|
||
| ## How to withdraw | ||
|
|
||
| 1. Send a message to the nominator pool contract with: | ||
| - The text comment "w" for withdraw. | ||
| - Approximately 1 TON for network fees. | ||
| 1. If the pool has sufficient balance, the withdrawal is processed immediately. | ||
| 1. If not, a withdrawal request is created and processed later. | ||
| 1. Only full withdrawal is supported. |
There was a problem hiding this comment.
[HIGH] Missing safety callout for nominator pool staking and withdrawals
The “How to stake” and “How to withdraw” sections instruct sending TON with specific comments ("d" for deposit and "w" for withdraw), including fee amounts and behavior when pool liquidity is insufficient. These instructions move funds and directly affect withdrawal behavior, yet the page does not include any <Aside> safety callout summarizing risks, penalties, and testnet vs mainnet usage. The style guide mandates a Caution or Warning callout for such fund-moving and withdrawal-changing steps with clear risk, scope, mitigation, and environment details (https://github.com/ton-org/docs/blob/main/contribute/style-guide-extended.mdx?plain=1#L634-L660). Without this, nominators may deposit or attempt withdrawals on mainnet and face penalties or delayed/blocked withdrawals without adequate warning.
Please leave a reaction 👍/👎 to this suggestion to improve future reviews for everyone!
| ## How to stake | ||
|
|
||
| 1. Use the [TON Whales staking website](https://tonwhales.com/staking) to find a suitable pool and stake. | ||
| 1. Alternatively, send a message with TON and the case-sensitive text comment "Stake" to a [Whales-type nominator pool contract](https://github.com/tonwhales/ton-nominators). | ||
| 1. The transferred amount must be equal to `stake_amount + deposit_fee`; refer to the pool details for the current fee. | ||
|
|
||
| ## How to withdraw | ||
|
|
||
| 1. Send a message with the case-sensitive text comment "Withdraw" and include the required `withdraw_fee`. | ||
| 1. Withdrawals follow a two-step process: request first, then finalize after the funds are received. | ||
|
|
||
| In some cases, withdrawals may be processed immediately if the pool has sufficient available balance. |
There was a problem hiding this comment.
[HIGH] Missing safety callout for TON Whales staking and withdrawals
The TON Whales staking guide tells users to stake and withdraw by sending TON with specific case-sensitive comments (“Stake” and “Withdraw”) and describes deposit and withdrawal fees plus a two-step withdrawal process. These instructions move funds and change how and when withdrawals complete, but there is no <Aside> safety callout explaining risk, scope, mitigation, and testnet vs mainnet usage. Under the safety-critical content rules, such fund-moving and withdrawal-affecting steps require a Caution or Warning callout (https://github.com/ton-org/docs/blob/main/contribute/style-guide-extended.mdx?plain=1#L634-L660). Without it, users may perform large mainnet operations with insufficient warning about irreversible loss, fees, or delayed withdrawals.
Please leave a reaction 👍/👎 to this suggestion to improve future reviews for everyone!
Resolves #1629