diff --git a/docs/concepts/stake-burn.md b/docs/concepts/stake-burn.md new file mode 100644 index 000000000..6db7f24e8 --- /dev/null +++ b/docs/concepts/stake-burn.md @@ -0,0 +1,166 @@ +--- +title: "Subnet stake burn" +--- + +import StakeBurn from '/img/docs/stake-burn.png'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +# Subnet Stake Burn + +This page describes Bittensor's subnet stake burn mechanism. It covers the mechanism’s behavior, how to execute a stake burn, and its effect on a subnet. + +The stake burn mechanism allows subnet owners to permanently remove alpha from circulation. It works as a combination of the [`add_stake`](https://github.com/opentensor/subtensor/blob/main/pallets/subtensor/src/staking/add_stake.rs#:~:text=pub%20fn%20do_add_stake)/[`add_stake_limit`](https://github.com/opentensor/subtensor/blob/main/pallets/subtensor/src/staking/add_stake.rs#:~:text=pub%20fn%20do_add_stake_limit) extrinsics and the `burn_alpha` extrinsic. + +The mechanism acts as a voluntary _subnet buyback_ whereby TAO is sent into the subnet's TAO reserve and Alpha is taken out of circulation. + +## How stake burn works + +The stake burn sequence begins when a subnet owner calls the `add_stake_burn` extrinsic. The extrinsic initially withdraws the specified amount TAO from the subnet owner coldkey and stakes the TAO to a hotkey on the subnet. The TAO stake is then added to the subnet's TAO reserve in its AMM pool. At the same time, the subnet's AMM pool algorithm uses the latest exchange rate to calculate the equivalent amount of alpha for the TAO that was staked. + +The acquired alpha is removed from the pool's alpha reserve, sent to the hotkey, and then immediately burned within the same transaction. As a result, the circulating alpha decreases, the AMM pool reserves adjust, and the alpha price updates according to the new reserve ratio—i.e., more TAO and less alpha in the reserve. + +The `add_stake_burn` extrinsic is rate-limited per subnet. The subnet owner can only call it once per _tempo_ (once every 360 blocks). Attempting a second call within the same tempo for that subnet will return an `AddStakeBurnRateLimitExceeded` error. + + + +Stake burn sequence + +:::warning Slippage and Price Impact +The initial staking on stake-burn operations execute against the subnet’s AMM pool and are subject to price slippage. Large staking amounts or low liquidity can significantly move the alpha price, resulting in fewer alpha acquired than expected. Therefore, always use limit price or slippage tolerance to control execution risk. + +To learn more about slippage during staking operations, see [Understanding slippage](../learn/slippage.md). +::: + +## Execute a stake burn + +Execute a stake burn by calling the `add_stake_burn` extrinsic with the target subnet, hotkey, and TAO amount. The following snippets show how to execute a stake burn using BTCLI and the Bittensor SDK: + + + + +Run the following command to execute a stake burn on BTCLI. Replace `WALLET_NAME` with the name of the subnet owner coldkey wallet and `NETUID` with the netuid of the subnet. + +```sh + btcli sudo stake-burn \ + --wallet-name WALLET_NAME + --netuid NETUID \ + --amount 10 \ + --tolerance 0.05 +``` + +
+ Show sample output + + + +``` +Safe staking: enabled (from config). +Rate tolerance: 0.005 (0.5%) by default. Set this using `btcli config set` or `--tolerance` flag +Enter the hotkey name or hotkey ss58 address (to use for the stake burn) (default): sn-creator +Enter the wallet name (Hint: You can set this with `btcli config set --wallet-name`) (default): sn-creator +Using the specified network local from config +[21:23:36] Warning: Verify your local subtensor is running on port 9944. subtensor_interface.py:91 + + Subnet Buyback: + Wallet: sn-creator, Coldkey ss58: 5GrwvaEF5zXb26Fz9rcQpDWS57CtERHpNehXCPcNoHGKutQY + Network: local + + Netuid ┃ Hotkey ┃ Amount (τ) ┃ Rate (per τ) ┃ Est. Burned ┃ Fee (τ) ┃ Extrinsic Fee (τ) ┃ Rate with tolerance: (0.5%) +━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + 14 │ 5GrwvaEF5zXb26Fz9rcQpDWS57CtERHpNehXCPcNoHGKutQY │ ‎10.0000 τ‎ │ 0.9861482403319707 δ/Τ │ ‎9.7681 δ‎ │ Τ 0.0050 │ ‎0.0001 τ‎ │ 0.9812 δ/Τ +────────┼──────────────────────────────────────────────────┼────────────┼─────────────────────────┼─────────────┼──────────┼───────────────────┼───────────────────────────── + │ │ │ │ │ │ │ +Would you like to continue? [y/n] (n): y +Enter your password: +Decrypting... +✅ Your extrinsic has been included as 6324-6 +✅ Subnet stake burn succeeded on SN14. +``` + + + +
+ + + + +Execute a stake burn using the `subtensor.add_stake_burn` method as shown: + +```py +import bittensor as bt + +subtensor = bt.Subtensor(network="local") +wallet = bt.Wallet(name="WALLET_NAME") + +netuid = NETUID +amount = bt.Balance.from_tao(10.0) +limit_price = bt.Balance.from_tao(LIMIT_PRICE) +hotkey_ss58 = "HOTKEY_SS58" # Hotkey to stake to (and burn the resulting Alpha) + +response = subtensor.add_stake_burn( + wallet=wallet, + netuid=netuid, + hotkey_ss58=hotkey_ss58, + limit_price=limit_price, + amount=amount, + wait_for_inclusion=True, + wait_for_finalization=True, +) + +if response.success: + print(f"Stake burn completed successfully!") +else: + print(f"Failed to execute stake burn: {response.message}") +``` + +Replace `WALLET_NAME` with the name of the subnet owner coldkey wallet, `NETUID` with the netuid of the subnet, and `LIMIT_PRICE` with the maximum Alpha price you are willing to pay for the swap. + + + + +## Troubleshooting + +- `SlippageTooHigh`: The final Alpha price resulting from the swap exceeded the `limit_price` specified in the extrinsic. Increase the transaction's slippage tolerance value or execute with a lower amount of TAO. +- `AddStakeBurnRateLimitExceeded`: The subnet has already processed a stake burn during the current tempo. +- `HotKeyAccountNotExists`: The specified hotkey does not exist on the target subnet. Verify the hotkey is registered on the subnet. diff --git a/docs/errors/subtensor.md b/docs/errors/subtensor.md index 29086627e..e96df4c61 100644 --- a/docs/errors/subtensor.md +++ b/docs/errors/subtensor.md @@ -328,6 +328,10 @@ Childkey take rate limit exceeded. Attempting staking operations too frequently. +### `AddStakeBurnRateLimitExceeded` + +The stake burn operation has exceeded its rate limit. Try again in the next tempo. + ## Registration and Network Management ### `TooManyRegistrationsThisBlock` diff --git a/docs/resources/community-links.md b/docs/resources/community-links.md index a31c4da19..643fe5d9e 100644 --- a/docs/resources/community-links.md +++ b/docs/resources/community-links.md @@ -14,7 +14,6 @@ You can also explore Bittensor's many Subnets and find links to their websites a - **Podcast**: [Novelty Search](https://www.youtube.com/@Opentensor/podcasts) - Official Opentensor Foundation podcast - **Discord**: [Join the Bittensor Discord Server](https://discord.com/invite/bittensor) - Connect with the community, ask questions, and stay updated - ## Block Explorers - **[TAO.app](https://tao.app)**: Recommended, as it is maintained by [Latent](https://latent.to/), the team behind these docs and core contributors to the Bittensor ecosystem. Includes [Savant](https://tao.app/savant), the Bittensor AI assistant capable of querying tokenomic data directly from the blockchain. @@ -23,7 +22,8 @@ You can also explore Bittensor's many Subnets and find links to their websites a ## Wallet Applications -- **[Bittensor Wallet](https://bittensor.com/wallet)** - Recommended (maintained by OTF). +- **[Bittensor Wallet](https://www.tao.com/)** - Recommended (maintained by Tao.com). +- [Crucible wallet](https://cruciblelabs.com/) - **[Other Polkadot Wallets](https://polkadot.com/get-started/wallets/)** - Multi-chain wallets capable of interacting with Bittensor. ## Development Resources @@ -31,5 +31,3 @@ You can also explore Bittensor's many Subnets and find links to their websites a - **[BTCLI](https://github.com/opentensor/btcli)**, the Bittensor CLI - The **[Bittensor SDK](https://github.com/opentensor/bittensor)** - **[Subtensor](https://github.com/opentensor/subtensor)**, Bittensor's substrate blockchain - - diff --git a/sidebars.js b/sidebars.js index d58af6cfc..a9aa95179 100644 --- a/sidebars.js +++ b/sidebars.js @@ -232,6 +232,7 @@ const sidebars = { "concepts/halving", "concepts/mev-shield/index", "concepts/commit-reveal", + "concepts/stake-burn", "concepts/consensus-based-weights", "concepts/bt-logging-levels", "resources/utilities", diff --git a/static/img/docs/stake-burn.png b/static/img/docs/stake-burn.png new file mode 100644 index 000000000..378be51cd Binary files /dev/null and b/static/img/docs/stake-burn.png differ