Skip to content

Commit 93959cc

Browse files
docs: Revisions to /concepts/tokenomics pages (#24438)
## Description Describe the changes or additions included in this PR. ## Test plan How did you test the new or updated feature? --- ## Release notes Check each box that your changes affect. If none of the boxes relate to your changes, release notes aren't required. For each box you select, include information after the relevant heading that describes the impact of your changes that a user might notice and any actions they must take to implement updates. - [ ] Protocol: - [ ] Nodes (Validators and Full nodes): - [ ] gRPC: - [ ] JSON-RPC: - [ ] GraphQL: - [ ] CLI: - [ ] Rust SDK: - [ ] Indexing Framework: --------- Co-authored-by: ronny-mysten <[email protected]>
1 parent 63f36a8 commit 93959cc

File tree

10 files changed

+254
-195
lines changed

10 files changed

+254
-195
lines changed

docs/content/concepts.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ Sui introduces innovative approaches to blockchain architecture and development.
3535
<Card title="Staking and Unstaking" href="/concepts/tokenomics/staking-unstaking"/>
3636
<Card title="Gas Fees" href="/concepts/tokenomics/gas-in-sui"/>
3737
<Card title="SUI Bridging" href="/concepts/tokenomics/sui-bridging"/>
38-
<Card title="Vesting Strategies" href="/concepts/tokenomics/vesting-strategies"/>
38+
<Card title="Vesting Strategies" href="/guides/developer/coin/vesting-strategies"/>
3939
</Cards>
4040

4141
## Object Model

docs/content/concepts/gaming.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -213,7 +213,7 @@ Ongoing distribution refers to staking and vesting of GameFi tokens. Not all gam
213213
- Rewards active participants in the ecosystem.
214214
- Rewards team members over the course of their involvement.
215215

216-
To learn more about token vesting strategies, see [Token Vesting Strategies](./tokenomics/vesting-strategies.mdx).
216+
To learn more about token vesting strategies, see [Token Vesting Strategies](/guides/developer/coin/vesting-strategies.mdx).
217217

218218
When deciding how best to launch your tokens, it's important to consider some key points:
219219

docs/content/concepts/tokenomics.mdx

Lines changed: 80 additions & 66 deletions
Large diffs are not rendered by default.

docs/content/concepts/tokenomics/gas-in-sui.mdx

Lines changed: 76 additions & 67 deletions
Large diffs are not rendered by default.

docs/content/concepts/tokenomics/staking-unstaking.mdx

Lines changed: 15 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,23 +4,30 @@ description: Staking and unstaking SUI with validators earns a percentage of rew
44
keywords: [ token staking, token unstaking, SUI staking, SUI unstaking, unstake SUI, stake SUI, validator staking, validator unstaking ]
55
---
66

7-
Sui uses a Delegated-Proof-of-Stake (DPoS) system to secure and operate the network, meaning that the voting power of a validator in the network is determined by the amount of stake delegated to them by SUI token holders. The more stake delegated to a validator, the more voting power they have. In exchange for processing transactions and performing consensus, validators earn rewards based on the amount of gas fees collected. These rewards are then shared among stakers as staking rewards.
7+
Sui uses a delegated proof of stake (DPoS) [consensus mechanism](/concepts/sui-architecture/consensus.mdx) to secure and operate the network, meaning that the voting power of a [validator](/guides/operator/validator-index.mdx) in the network is determined by the amount of stake delegated to them by SUI token holders. The more stake delegated to a validator, the more voting power they have. In exchange for processing transactions and providing resources to the network, validators earn rewards based on the amount of gas fees collected. These rewards are then shared among stakers as [staking rewards](/guides/operator/validator/validator-rewards.mdx).
88

99
## Staking
1010

11-
You stake your SUI tokens by sending a transaction to the network that calls the staking function implemented as part of the system Move package. This transaction wraps the SUI tokens in a self-custodial stake object. This stake object contains information including the validator staking pool ID and the activation epoch of the stake. With the introduction of [SIP-6](https://blog.sui.io/liquid-staking-coming-sui/), you can participate in liquid staking protocols using your staked objects.
11+
Stake SUI tokens by sending a transaction to the network that calls the <a href="/references/framework/sui_sui_system/staking_pool#sui_system_staking_pool_request_add_stake" data-noBrokenLinkCheck='true'>staking function</a> implemented as part of the <a href="/references/framework/sui_sui_system/staking_pool" data-noBrokenLinkCheck='true'>system Move package</a>. This transaction wraps the SUI tokens in a self-custodial stake [object](/concepts/object-model.mdx). This stake object contains information including the validator staking pool ID and the activation [epoch](/concepts/sui-architecture/epochs.mdx) of the stake. With the introduction of [SIP-6](https://blog.sui.io/liquid-staking-coming-sui/), you can participate in liquid staking protocols using your staked objects.
1212

13-
Sui-compatible crypto wallets typically have functionality to initiate staking and unstaking from your Sui address. See the respective documentation for these tools to begin staking your SUI.
13+
[Sui-compatible crypto wallets](https://slush.app/) typically have functionality to initiate staking and unstaking from your Sui address. See the respective documentation for these tools to begin staking your SUI.
1414

1515
## Unstaking
1616

17-
Similar to staking, a user withdraws stake from a validator by sending a transaction that calls the unstaking function in the system Move package. This transaction unwraps the stake object, and sends both the principal and the accumulated rewards to the user as SUI tokens. You accrue rewards only during epochs where the stake is active for the entire epoch. The rewards withdrawn from the validator's rewards pool are calculated based on the activation epoch and unstaking epoch of the stake.
17+
Similar to staking, a user withdraws stake from a validator by sending a transaction that calls the <a href="/references/framework/sui_sui_system/staking_pool#sui_system_staking_pool_request_withdraw_stake" data-noBrokenLinkCheck='true'>unstaking function</a> in the <a href="/references/framework/sui_sui_system/staking_pool" data-noBrokenLinkCheck='true'>system Move package</a>. This transaction unwraps the stake object, and sends both the principal and the accumulated rewards to the user as SUI tokens. You accrue rewards only during epochs where the stake is active for the entire epoch. The rewards withdrawn from the validator's rewards pool are calculated based on the activation epoch and unstaking epoch of the stake.
1818

1919
## Choosing a validator for staking
2020

21-
When you stake on Sui, you have to choose a specific validator you would like to stake with. The choice of validator can potentially impact the amount of staking rewards you receive. The factors determining this amount include, but are not limited to:
21+
You must choose a specific validator you would like to stake your SUI in. The choice of validator can potentially impact the amount of staking rewards you receive. The factors determining this amount include, but are not limited to:
2222

23-
- Validator commission rate: a validator can choose to set a non-zero commission rate specifying the percentage of staking rewards they are taking from the stakers. For example, if a validator has a commission rate of 10%, then 10% of every staker's staking rewards is given to the validator. Understand that a validator can choose its commission at a future moment in time without prior notice.
24-
- Validator performance: a validator with bad performance might be punished according to the [tallying rule](./gas-in-sui.mdx#tallying-rule). Punished validators do not receive any staking rewards for the epoch during which they are punished, and you also do not receive that epoch's rewards when you withdraw your stake from that validator.
23+
- **Validator commission rate**: A validator can choose to set a non-zero commission rate specifying the percentage of staking rewards they are taking from the stakers. For example, if a validator has a commission rate of 10%, then 10% of every staker's staking rewards is given to the validator.
2524

26-
Sui-compatible crypto wallets and explorers typically provide validator information such as commission and APY. See the respective documentation for these tools for information on how to retrieve this data.
25+
:::caution
26+
27+
A validator can choose its commission at a future moment in time without prior notice.
28+
29+
:::
30+
31+
- **Validator performance**: A validator with bad performance might be punished according to the [tallying rule](/concepts/tokenomics/gas-in-sui.mdx#tallying-rule). Punished validators do not receive any staking rewards for the epoch during which they are punished, and you also do not receive that epoch's rewards when you withdraw your stake from that validator.
32+
33+
Sui-compatible crypto wallets and [explorers](https://suiscan.xyz/mainnet/home) typically provide validator information such as commission and APY. See the respective documentation for these tools for information on how to retrieve this data.

0 commit comments

Comments
 (0)