Skip to content

Commit

Permalink
Update staking guide (#109)
Browse files Browse the repository at this point in the history
  • Loading branch information
boundless-forest authored Oct 24, 2024
1 parent bc82373 commit 18491f2
Show file tree
Hide file tree
Showing 23 changed files with 23 additions and 132 deletions.
2 changes: 1 addition & 1 deletion docs/community/guide/migration/generate-account.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,6 @@ Please navigate to [staking.darwinia.network](https://staking.darwinia.network/

MetaMask will pop up and ask you to sign in. Once signed in, you will be prompted to select the account to connect to the Dapp and accept permissions.

Upon accepting permissions and changing the network to `Darwinia`, you will be directed to the main dashboard. There, you will find the details of the stake you had on Darwinia 1.0, including Bonded, Unbonding, Unbonded, and Deposits. You can continue to use these to participate in staking on the Darwinia. Please refer to [this tutorial](../staking.md) for instructions on how to stake and earn staking rewards on the Darwinia.
Upon accepting permissions and changing the network to `Darwinia`, you will be directed to the main dashboard. There, you will find the details of the stake you had on Darwinia 1.0, including Bonded, Unbonding, Unbonded, and Deposits. You can continue to use these to participate in staking on the Darwinia. Please refer to [this tutorial](../../../learn/collator-staking.md#staking-design) for instructions on how to stake and earn staking rewards on the Darwinia.

![evm-tutorial-migrate-general-13](../../../images/evm-tutorial-migrate-general-13.png)
95 changes: 0 additions & 95 deletions docs/community/guide/staking.md

This file was deleted.

Binary file removed docs/images/evm-tutorial-collator-node-1.png
Binary file not shown.
Binary file removed docs/images/evm-tutorial-collator-node-2.png
Binary file not shown.
Binary file removed docs/images/evm-tutorial-collator-node-3.png
Binary file not shown.
Binary file removed docs/images/evm-tutorial-collator-node-4.png
Binary file not shown.
Binary file removed docs/images/evm-tutorial-collator-node-5.png
Binary file not shown.
Binary file removed docs/images/evm-tutorial-staking-1.png
Binary file not shown.
Binary file removed docs/images/evm-tutorial-staking-10.png
Binary file not shown.
Binary file removed docs/images/evm-tutorial-staking-11.png
Binary file not shown.
Binary file removed docs/images/evm-tutorial-staking-12.png
Binary file not shown.
Binary file removed docs/images/evm-tutorial-staking-13.png
Binary file not shown.
Binary file removed docs/images/evm-tutorial-staking-2.png
Binary file not shown.
Binary file removed docs/images/evm-tutorial-staking-3.png
Binary file not shown.
Binary file removed docs/images/evm-tutorial-staking-4.png
Binary file not shown.
Binary file removed docs/images/evm-tutorial-staking-5.png
Binary file not shown.
Binary file removed docs/images/evm-tutorial-staking-6.png
Binary file not shown.
Binary file removed docs/images/evm-tutorial-staking-7.png
Binary file not shown.
Binary file removed docs/images/evm-tutorial-staking-8.png
Binary file not shown.
Binary file removed docs/images/evm-tutorial-staking-9.png
Binary file not shown.
17 changes: 9 additions & 8 deletions docs/learn/collator-staking.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# Overview

This section provides an overview of the collator staking system on Darwinia.

## What is Collator?

Expand All @@ -9,18 +10,18 @@ In contrast, for Polkadot parachains, block production and chain security are se

If you're interested in learning more about collators, you can find additional information in the [Collator section of the Polkadot Wiki](https://wiki.polkadot.network/docs/learn-collator).

## Become a Collator

To become a collator, the first step is to stake RING tokens using the [Collator Staking App](https://collator-staking.darwinia.network/). Currently, the Darwinia chains have a fixed number of collators (N), which means only the top N collators are selected to produce blocks for the network. The more RING tokens you stake, the higher your chances of becoming a collator. If you don't have enough RING tokens, you can still participate in staking by nominating (delegating) your RING tokens to other collators and earning a portion of the block production rewards. Follow the [Staking Guide](../community/guide/staking.md) to complete this step.

Once you've finished staking, the next step is to set up and run the chain nodes on your machine. Refer to the [Collator Node Guide](../node-operators/run-collator-node.md) for detailed operation instructions.

## Collator Staking Design
## How to Staking?

!!! note
Following the implementation of DIP-7, the staking system was rewritten as a set of smart contracts, replacing the Substrate pallet. For more information on the reasoning behind this change, please refer to the [DIP-7 specification](https://dips.darwinia.network/DIPs/dip-7.html).

The staking system has two types:

1. Direct RING token staking: This is the most straightforward way to stake, and the reward you receive is based on the amount of tokens you stake.
2. Deposit-based staking: By depositing RING tokens, you can receive a bonus in the form of [KTON](../community/orgs/ktondao.md) tokens. Additionally, the deposited tokens can be considered part of the amount you staked, allowing you to receive more rewards.
2. Deposit-based staking: By depositing RING tokens, you can receive a bonus in the form of [KTON](../community/orgs/ktondao.md) tokens. Additionally, the deposited tokens can be considered part of the amount you staked, allowing you to receive more rewards.

Once you have obtained RING tokens, you can choose to either stake them directly or deposit them to receive KTON tokens following the steps outlined in the [Staking Guide](https://ringdao.notion.site/How-to-stake-and-earn-staking-rewards-fffaad1d671e81409a42c8244bf671bd).

## Become a Collator

Currently, the Darwinia chains have a fixed number of collators (N), which means only the top N collators are selected to produce blocks for the network. The more `RING` tokens you stake, the higher your chances of becoming a collator. If you don't have enough `RING` tokens, you can still participate in staking by nominating (delegating) your `RING` tokens to other collators and earning a portion of the block production rewards. Refer to the [Collator Node Guide](../node-operators/run-collator-node.md) for detailed operation instructions.
26 changes: 5 additions & 21 deletions docs/node-operators/run-collator-node.md
Original file line number Diff line number Diff line change
Expand Up @@ -155,35 +155,19 @@ It's important to note that there is a faster method to expedite the syncing pro
```
## Set Session Key And Commission Rate
## Join The Collators Set
1. Once your node has finished syncing, ensure that it is still running.
2. Open the [staking app](https://staking.darwinia.network/#/?network=darwinia) in your browser and connect it to your wallet account. You have the option to choose between MetaMask or WalletConnect, as both wallets are now supported.
![evm-tutorial-collator-node-1](../images/evm-tutorial-collator-node-1.png)
3. Click on the `Join Collator` button and follow these steps:
1. Enter the session key that was generated earlier and click on `Set Session Key` to prompt the wallet for submitting an Ethereum transaction.
2. Enter the desired commission amount and click on `Set Commission` to prompt the wallet for submitting an Ethereum transaction.
![evm-tutorial-collator-node-2](../images/evm-tutorial-collator-node-2.png)
![evm-tutorial-collator-node-3](../images/evm-tutorial-collator-node-3.png)
1. To verify that your account is in the collator waiting pool, click on the `Select a collator` button.
![evm-tutorial-collator-node-4](../images/evm-tutorial-collator-node-4.png)
![evm-tutorial-collator-node-5](../images/evm-tutorial-collator-node-5.png)
Once your node has finished syncing, ensure that it is still running, then follow the [Join Collators Set Guide](https://ringdao.notion.site/How-to-become-a-collator-fffaad1d671e81c6b5f0ee4e97c29889) to complete the process of becoming a collator.
## To Be A Real Collator
1. Accumulate power by staking or depositing
1. Accumulate `RING` by staking or depositing
At this point, your node is operational and the node session key has been successfully registered and associated with your account. As a candidate collator, you are currently in the waiting pool. However, in order to progress and participate in block production, as well as receive rewards, you must collect sufficient power. To achieve this, you can either stake native `RING` or deposit `KTON`. By doing so, you will accumulate the necessary power to be included in the real collator list. It is important to note that only the top 20 power-owning collators will be selected to form the collator set for the next session.
At this point, your node is operational and the node session key has been successfully registered and associated with your account. As a candidate collator, you are currently in the waiting pool. However, in order to progress and participate in block production, as well as receive rewards, you must collect sufficient `RING`. To achieve this, you can either stake native `RING` or deposit `KTON`. By doing so, you will accumulate the necessary `RING ` to be included in the real collator list. It is important to note that only the top 20 RING-owning collators will be selected to form the collator set for the next session.
2. Wait until the next session
Once you have accumulated enough power and have been selected as a real collator, your node will begin producing blocks once the next session starts. You will be able to observe messages similar to the following in the node log:
Once you have accumulated enough `RING` and have been selected as a real collator, your node will begin producing blocks once the next session starts. You will be able to observe messages similar to the following in the node log:
```bash
2024-09-04 02:29:36 [Parachain] Starting collation. relay_parent=0x6e01f34762d42f007122a3e1ce6c4831dfd83ac5b6785d094ec526c573f332a6 at=0x0daa9a024b7c31241cdaffeebcc60ae778c24a005f42a6989092e7f63860161a
Expand Down
15 changes: 8 additions & 7 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -169,7 +169,7 @@ plugins:
"darwinia-msgport-fa89f501ea1747e285b6169697e2ff77.md": "https://msgport.ringdao.com/docs/index.html"
"darwinia-2-99b0d585271c4d029474c5f123139a4a.md": "build/getting-started/networks/overview.md"
"darwinia-evm-df814f681ec248438cb762df8aaddbd6.md": "build/getting-started/networks/overview.md"
"darwinia-staking-6fecd6a66daa44bb828c760f0499ba73.md": "community/guide/staking.md"
"darwinia-staking-6fecd6a66daa44bb828c760f0499ba73.md": "learn/collator-staking.md"
"darwinia-db787b70edd14545a252122d1c7651d1.md": "index.md"
"darwinia-chain-db787b70edd14545a252122d1c7651d1.md": "build/getting-started/networks/darwinia.md"
"darwinia-chains-df814f681ec248438cb762df8aaddbd6.md": "build/getting-started/networks/darwinia.md"
Expand Down Expand Up @@ -204,8 +204,8 @@ plugins:
"token-and-economic-model-c6c83e06a16840ce99e64c7a88b4132e.md": "community/overview.md"
"commitment-token-41243f797bf4421dbb49db7d88dbfd60.md": "learn/collator-staking.md"
"commitment-token-e17a95fb26664e0d8b39d26370847797.md": "learn/collator-staking.md"
"staking-guide-4306a2a3f25f4ea0b41377e267e1d319.md": "community/guide/staking.md"
"staking-6fecd6a66daa44bb828c760f0499ba73.md": "community/guide/staking.md"
"staking-guide-4306a2a3f25f4ea0b41377e267e1d319.md": "learn/collator-staking.md"
"staking-6fecd6a66daa44bb828c760f0499ba73.md": "learn/collator-staking.md"
"staking-precompile-f301e1fda68f450d8861f3e016c45422.md": "learn/collator-staking.md"
"staking-f301e1fda68f450d8861f3e016c45422.md": "learn/collator-staking.md"
"staking-module-9e8584942325478980a3f487b4e1aa14.md": "learn/collator-staking.md"
Expand All @@ -224,6 +224,7 @@ plugins:
"cross-chain-abstract-account-a0aae327c3d54555818fdab1149d0608.md": "https://msgport.ringdao.com/docs/learn/use-cases/xaccount.html"
"lcmp-(deprecated)-d205c8d8e5794c789065aabdbb5f78c8.md": "https://msgport.ringdao.com/docs/learn/messaging-protocols/lcmp.html"
"lcmp-overview-d205c8d8e5794c789065aabdbb5f78c8.md": "https://msgport.ringdao.com/docs/learn/messaging-protocols/lcmp.html"
"lcmp-overview-3e4aaa724b6b42a2b821fe607ff4568f.md": "https://msgport.ringdao.com/docs/learn/messaging-protocols/lcmp.html"
"lcmp-d205c8d8e5794c789065aabdbb5f78c8.md": "https://msgport.ringdao.com/docs/learn/messaging-protocols/lcmp.html"
"participate-in-democracy-663e7e9388454f1698663d6c8a4ce59c.md": "community/guide/governance.md"
"participate-in-council-c816ba48ccc24f95b3ae6840d01e81e6.md": "community/guide/governance.md"
Expand Down Expand Up @@ -331,10 +332,10 @@ plugins:
"evm/chains/overview.md": "build/getting-started/networks/overview.md"
"evm/chains/darwinia.md": "build/getting-started/networks/darwinia.md"
"evm/chains/pangolin.md": "build/getting-started/networks/pangolin.md"
"evm/chains/crab.md": "build/getting-started/networks/crab.md"
"evm/chains/crab.md": "build/getting-started/networks/crab.md"
"evm/tutorial/usdt.md": "community/guide/assethub-bridge.md"
"evm/tutorial/create-dao.md": "community/guide/create-dao.md"
"evm/tutorial/staking.md": "community/guide/staking.md"
"evm/tutorial/staking.md": "learn/collator-staking.md"
"evm/tutorial/multisig-wallet.md": "community/guide/multisig-wallet.md"
"evm/tutorial/chain/run-dev-node.md": "build/getting-started/networks/dev-node.md"
"evm/tutorial/chain/run-collator-node.md": "node-operators/run-collator-node.md"
Expand Down Expand Up @@ -369,6 +370,7 @@ plugins:
"evm/ethereum-compatibility/precompiles/commitment-token.md": "learn/collator-staking.md"
"evm/ethereum-compatibility/jsonrpc.md": "learn/ethereum-compatibility/jsonrpc.md"
"docs/en/wiki-us-tokens.md": "community/overview.md"
"docs/en/wiki-rfcs.md": "index.md"
"docs/zh-CN/crab-tut-nominator.md": "index.md"
"docs/zh-CN/wiki-tut-wormhole-e2d.md": "index.md"
"docs/en/wiki-tut-governance.md": "learn/governance.md"
Expand Down Expand Up @@ -418,7 +420,7 @@ plugins:
"build/chain/run-dev-node.md": "build/getting-started/networks/dev-node.md"
"build/getting-started/transfer-token.md": "community/guide/transfer-token.md"
"build/getting-started/networks/rollup.md": "build/getting-started/networks/overview.md"
"build/getting-started/staking.md": "community/guide/staking.md"
"build/getting-started/staking.md": "learn/collator-staking.md"
"build/getting-started/governance.md": "community/guide/governance.md"
"build/getting-started/assethub-bridge.md": "community/guide/assethub-bridge.md"
"build/getting-started/multisig-wallet.md": "community/guide/multisig-wallet.md"
Expand Down Expand Up @@ -509,7 +511,6 @@ nav:
- DCDAO: "community//orgs/dcdao.md"
- KtonDAO: "community//orgs/ktondao.md"
- Community Guide:
- How to Stake: "community/guide/staking.md"
- Accounts:
- How to Create a Multisig: "community/guide/multisig-wallet.md"
- Darwinia 1.0 Migration:
Expand Down

0 comments on commit 18491f2

Please sign in to comment.