diff --git a/docs/community/guide/migration/generate-account.md b/docs/community/guide/migration/generate-account.md index b7e3181..13f0dde 100644 --- a/docs/community/guide/migration/generate-account.md +++ b/docs/community/guide/migration/generate-account.md @@ -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) \ No newline at end of file diff --git a/docs/community/guide/staking.md b/docs/community/guide/staking.md deleted file mode 100644 index 09779d2..0000000 --- a/docs/community/guide/staking.md +++ /dev/null @@ -1,95 +0,0 @@ -# Staking Guide - -This tutorial will guide you through the process of staking tokens (RING & KTON & Deposit) on Darwinia using the staking Dapp built by the Darwinia Dev Team. The staking Dapp is compatible with the Crab network. Be sure to select Crab network if you want to stake Crab tokens (CRAB & CKTON & Deposit), this tutorial also works; just switch to the appropriate network. - -## Get Started With The Dashboard - -To get started with the dashboard, navigate to [staking.darwinia.network](https://staking.darwinia.network/#/?network=Darwinia). You’ll be prompted to connect to [MetaMask](https://metamask.io/). - -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 redirected to the main dashboard where you’ll find details about the staking data. - -## How to Stake - -Token holders can delegate a collator candidate by staking tokens and adding to the collator's stake. In return, the collator will share the rewards received from producing blocks amongst all of their delegators. For more information on reward distribution, check out our documentation on [staking reward distribution](https://medium.com/darwinianetwork/faqs-for-darwinia-2-0-staking-mechanism-adjustments-f330b549f168). - - -To obtain the `Deposit`, you need to lock your `RING` for a certain period of time. - -![evm-tutorial-staking-1](../../images/evm-tutorial-staking-1.png) - -To stake your tokens, you need to complete two steps. First, you must delegate a collator, and then you need to stake your tokens with them. After these two steps are done, your stake will be in effect. - -## Example - -For the purpose of staking operations, we will use the following account as an example: - -`0x807b496Bd5fa96dC9E22A43577942b2D90Dd7Ccc` - -If you click on the `Select a collator` button, the collator menu will open up and you will be able to see data for each of the collators in the active and waiting pools. - -![evm-tutorial-staking-2](../../images/evm-tutorial-staking-2.png) -![evm-tutorial-staking-3](../../images/evm-tutorial-staking-3.png) - -You can switch between two tabs in the staking interface: `Active Pool` and `Waiting Pool`. The `Active Pool` tab displays collators who are currently producing blocks and earning rewards, while the `Waiting Pool` tab displays collators who are not yet producing blocks or earning rewards. - -To begin staking, select a collator by clicking on them. Then, follow these steps: - -1. Double-check that you have selected the correct collator and that the address is accurate. -2. Input the amount of tokens you wish to stake. For example, in this scenario, you will be staking 10`RING`, 0.0005`KTON`, and 1`Deposit`. -3. Click the `Stake` button. - -When you click `Stake`, a MetaMask pop-up will appear, and you will be asked to sign a transaction. - -![evm-tutorial-staking-4](../../images/evm-tutorial-staking-4.png) - -Once the transaction has been confirmed and you receive the transaction confirmed notification, the dashboard will update to include the delegation. - -![evm-tutorial-staking-5](../../images/evm-tutorial-staking-5.png) - -If you check your MetaMask account, you will see that your balance has decreased by the amount of tokens staked (plus gas fees). Please note that it could take a couple of minutes for MetaMask to reflect any changes to the free balance. And you will be able to see the tokens your staked(bonded) tokens on the dashboard. - -![evm-tutorial-staking-6](../../images/evm-tutorial-staking-6.png) - -## Make Changes To The Delegation - -### How to Bond More Funds - -1. Click the `+` icon next to the token you want to modify. -2. Specify the amount you would like to increase your delegation by. In this case, we are increasing our bond by 5`RING`. -3. Click `Bond`. - -![evm-tutorial-staking-7](../../images/evm-tutorial-staking-7.png) -![evm-tutorial-staking-8](../../images/evm-tutorial-staking-8.png) - -### How to Reduce Funds - -1. Click on the `–` icon next to the token you want to modify. -2. Enter the amount you would like to reduce your bond by. In this case, we are reducing our bond by 0.0001`KTON`. -3. Press `Unbond`. - -![evm-tutorial-staking-9](../../images/evm-tutorial-staking-9.png) -![evm-tutorial-staking-10](../../images/evm-tutorial-staking-10.png) - -You will be prompted to sign a transaction in MetaMask. - -Once the transaction has been confirmed and you receive the Transaction confirmed notification, the dashboard will update, and if you hover over the token, it can show you a message that when will the unbonding tokens can be released. At this time, you have the option to cancel this unbonding request or wait 14 days to release the tokens manually. - -![evm-tutorial-staking-11](../../images/evm-tutorial-staking-11.png) - -Once the 14 days unbonding period has passed, you can return to this staking dashboard and release the unbonded tokens, after which you will see the unbonded funds in your free balance on MetaMask. - -### How to Undelegate - -Undelegating usually involves two steps: undelegating of the collator and unbonding the tokens that were previously bonded in the stake. -To undelegate, click the `Undelegate` button. This action will take effect immediately. Then, press the `Unbond all` button to unbond the tokens. This will initiate the 14-day unbonding period. After the period is over, you will need to manually release the tokens before they can be transferred. - -![evm-tutorial-staking-12](../../images/evm-tutorial-staking-12.png) -![evm-tutorial-staking-13](../../images/evm-tutorial-staking-13.png) - -That’s it! Now you’ve successfully delegated a collator, updated the delegation amount, and then removed the delegation. You have all the tools necessary to get started with staking on `Darwinia`! - -## Support - -If you experience any difficulties with staking, please use the [links](https://t.me/DarwiniaNetwork) below to get in touch with us. \ No newline at end of file diff --git a/docs/images/evm-tutorial-collator-node-1.png b/docs/images/evm-tutorial-collator-node-1.png deleted file mode 100644 index 58caa8a..0000000 Binary files a/docs/images/evm-tutorial-collator-node-1.png and /dev/null differ diff --git a/docs/images/evm-tutorial-collator-node-2.png b/docs/images/evm-tutorial-collator-node-2.png deleted file mode 100644 index 2f4de0a..0000000 Binary files a/docs/images/evm-tutorial-collator-node-2.png and /dev/null differ diff --git a/docs/images/evm-tutorial-collator-node-3.png b/docs/images/evm-tutorial-collator-node-3.png deleted file mode 100644 index 9730d5d..0000000 Binary files a/docs/images/evm-tutorial-collator-node-3.png and /dev/null differ diff --git a/docs/images/evm-tutorial-collator-node-4.png b/docs/images/evm-tutorial-collator-node-4.png deleted file mode 100644 index 4e045cf..0000000 Binary files a/docs/images/evm-tutorial-collator-node-4.png and /dev/null differ diff --git a/docs/images/evm-tutorial-collator-node-5.png b/docs/images/evm-tutorial-collator-node-5.png deleted file mode 100644 index 3654e9d..0000000 Binary files a/docs/images/evm-tutorial-collator-node-5.png and /dev/null differ diff --git a/docs/images/evm-tutorial-staking-1.png b/docs/images/evm-tutorial-staking-1.png deleted file mode 100644 index 665ce9b..0000000 Binary files a/docs/images/evm-tutorial-staking-1.png and /dev/null differ diff --git a/docs/images/evm-tutorial-staking-10.png b/docs/images/evm-tutorial-staking-10.png deleted file mode 100644 index 0c9e998..0000000 Binary files a/docs/images/evm-tutorial-staking-10.png and /dev/null differ diff --git a/docs/images/evm-tutorial-staking-11.png b/docs/images/evm-tutorial-staking-11.png deleted file mode 100644 index fad0c19..0000000 Binary files a/docs/images/evm-tutorial-staking-11.png and /dev/null differ diff --git a/docs/images/evm-tutorial-staking-12.png b/docs/images/evm-tutorial-staking-12.png deleted file mode 100644 index fa61a4a..0000000 Binary files a/docs/images/evm-tutorial-staking-12.png and /dev/null differ diff --git a/docs/images/evm-tutorial-staking-13.png b/docs/images/evm-tutorial-staking-13.png deleted file mode 100644 index 465d124..0000000 Binary files a/docs/images/evm-tutorial-staking-13.png and /dev/null differ diff --git a/docs/images/evm-tutorial-staking-2.png b/docs/images/evm-tutorial-staking-2.png deleted file mode 100644 index 89d753b..0000000 Binary files a/docs/images/evm-tutorial-staking-2.png and /dev/null differ diff --git a/docs/images/evm-tutorial-staking-3.png b/docs/images/evm-tutorial-staking-3.png deleted file mode 100644 index 3c6adff..0000000 Binary files a/docs/images/evm-tutorial-staking-3.png and /dev/null differ diff --git a/docs/images/evm-tutorial-staking-4.png b/docs/images/evm-tutorial-staking-4.png deleted file mode 100644 index c15661f..0000000 Binary files a/docs/images/evm-tutorial-staking-4.png and /dev/null differ diff --git a/docs/images/evm-tutorial-staking-5.png b/docs/images/evm-tutorial-staking-5.png deleted file mode 100644 index 86455f7..0000000 Binary files a/docs/images/evm-tutorial-staking-5.png and /dev/null differ diff --git a/docs/images/evm-tutorial-staking-6.png b/docs/images/evm-tutorial-staking-6.png deleted file mode 100644 index 81eb3a0..0000000 Binary files a/docs/images/evm-tutorial-staking-6.png and /dev/null differ diff --git a/docs/images/evm-tutorial-staking-7.png b/docs/images/evm-tutorial-staking-7.png deleted file mode 100644 index 91a4ae6..0000000 Binary files a/docs/images/evm-tutorial-staking-7.png and /dev/null differ diff --git a/docs/images/evm-tutorial-staking-8.png b/docs/images/evm-tutorial-staking-8.png deleted file mode 100644 index 893d775..0000000 Binary files a/docs/images/evm-tutorial-staking-8.png and /dev/null differ diff --git a/docs/images/evm-tutorial-staking-9.png b/docs/images/evm-tutorial-staking-9.png deleted file mode 100644 index e20203e..0000000 Binary files a/docs/images/evm-tutorial-staking-9.png and /dev/null differ diff --git a/docs/learn/collator-staking.md b/docs/learn/collator-staking.md index 484b22c..9faa4c1 100644 --- a/docs/learn/collator-staking.md +++ b/docs/learn/collator-staking.md @@ -1,5 +1,6 @@ # Overview +This section provides an overview of the collator staking system on Darwinia. ## What is Collator? @@ -9,13 +10,7 @@ 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). @@ -23,4 +18,10 @@ Once you've finished staking, the next step is to set up and run the chain nodes 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. \ No newline at end of file +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. \ No newline at end of file diff --git a/docs/node-operators/run-collator-node.md b/docs/node-operators/run-collator-node.md index ebe4679..2f88139 100644 --- a/docs/node-operators/run-collator-node.md +++ b/docs/node-operators/run-collator-node.md @@ -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 diff --git a/mkdocs.yml b/mkdocs.yml index 1fae131..b58960a 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -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" @@ -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" @@ -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" @@ -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" @@ -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" @@ -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" @@ -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: