From 490bf5a8c248542994005ba4e1faa7d0d6abde34 Mon Sep 17 00:00:00 2001 From: Filippo <110459737+filippoweb3@users.noreply.github.com> Date: Thu, 14 Mar 2024 13:56:45 +0000 Subject: [PATCH] Move content nominator guides (#5684) * moved staking dashboard content * migrated all content * minor edit * rm how to nominate guide doc - impl redirects - modified sidebar * fixed broken links * minor edit sidebar --- docs/general/kusama/kusama-getting-started.md | 2 +- docs/general/staking-dashboard.md | 19 ++++- docs/learn/learn-guides-staking.md | 5 +- docs/learn/learn-guides-transfers.md | 4 +- docs/learn/learn-nominator.md | 62 ++++++++++++---- docs/learn/learn-runtime-upgrades.md | 2 +- docs/learn/learn-staking.md | 5 +- .../archive/maintain-guides-democracy.md | 2 +- ...aintain-guides-how-to-nominate-polkadot.md | 71 ------------------- .../maintain-guides-how-to-stop-validating.md | 3 +- docs/maintain/maintain-index.md | 4 +- kusama-guide/docusaurus.config.js | 4 ++ kusama-guide/sidebars.js | 2 +- polkadot-wiki/docusaurus.config.js | 4 ++ polkadot-wiki/sidebars.js | 1 - 15 files changed, 87 insertions(+), 103 deletions(-) delete mode 100644 docs/maintain/maintain-guides-how-to-nominate-polkadot.md diff --git a/docs/general/kusama/kusama-getting-started.md b/docs/general/kusama/kusama-getting-started.md index ad5f7d21513c..3af8e6434a5f 100644 --- a/docs/general/kusama/kusama-getting-started.md +++ b/docs/general/kusama/kusama-getting-started.md @@ -212,5 +212,5 @@ Additional Resources: - [endpoints](maintain-endpoints) - [tokens](https://claim.kusama.network/) - [validator](../../maintain/kusama/maintain-guides-how-to-validate-kusama.md) -- [nominator](../../maintain/maintain-guides-how-to-nominate-polkadot.md) +- [nominator](../../learn/learn-nominator.md) - [polkadot wiki](https://wiki.polkadot.network/) diff --git a/docs/general/staking-dashboard.md b/docs/general/staking-dashboard.md index bbed72eb3d05..0c6adbba69c7 100644 --- a/docs/general/staking-dashboard.md +++ b/docs/general/staking-dashboard.md @@ -9,7 +9,7 @@ slug: ../staking-dashboard import RPC from "./../../components/RPC-Connection"; -:::info Preliminary Notes +## Preliminary Notes The [Polkadot Staking Dashboard](https://staking.polkadot.network/#/overview) supports [**proxy accounts**](../learn/learn-proxies.md) and you can import your @@ -38,7 +38,7 @@ For more information about staking on {{ polkadot: Polkadot :polkadot }}{{ kusam visit the [staking page](../learn/learn-staking.md) and the [advanced staking page](../learn/learn-staking-advanced.md). -::: +## Using the Polkadot Staking Dashboard The [Polkadot Staking Dashboard](https://staking.polkadot.network/#/overview) is a tool only dedicated to [staking](../learn/learn-staking.md) on Polkadot, @@ -67,6 +67,21 @@ The structure of this page follows the sidebar of the staking dashboard. Here yo the main features of the dashboard. If you need more information, see the [Walkthrough Tutorial](https://youtu.be/hvXLc4H7rA4). +:::info Walk-through Video Tutorials + +- [**Nominating**](https://youtu.be/F59N3YKYCRs): Stake your tokens, choose your best validators, + and start your staking journey on {{ polkadot: Polkadot :polkadot }}{{ kusama: Kusama :kusama }}. +- [**Becoming a Pool Member**](https://youtu.be/dDIG7QAApig): Start becoming a part of the Polkadot + movement, keep {{ polkadot: Polkadot :polkadot }}{{ kusama: Kusama :kusama }} secure by staking + minimum 1 DOT and receiving staking rewards. +- [**Dashboard Walkthrough**](https://youtu.be/hvXLc4H7rA4): Become a Pro using the Staking + Dashboard. +- [**After Staking**](https://youtu.be/58pIe8tt2o4): Nominating on + {{ polkadot: Polkadot :polkadot }}{{ kusama: Kusama :kusama }} is not a set-and-forget action, + learn what you can do with the dashboard after you started staking. + +::: + ## Overview :::info Staking Dashboard Walk-through video tutorial diff --git a/docs/learn/learn-guides-staking.md b/docs/learn/learn-guides-staking.md index 22b01c39aec7..c41c39733755 100644 --- a/docs/learn/learn-guides-staking.md +++ b/docs/learn/learn-guides-staking.md @@ -1,7 +1,7 @@ --- id: learn-guides-staking title: Polkadot-JS Guides For Nominators -sidebar_label: Staking Guides +sidebar_label: Nominator Guides description: Polkadot-JS Guides for Nominators. keyword: [nominate, stake, staking, claim, rewards, polkadot-js] slug: ../learn-guides-staking @@ -119,8 +119,7 @@ more details. ### Step 3: Stop nominating At some point, you might decide to stop nominating one or more validators. You can always change who -you're nominating, but you cannot withdraw your tokens unless you unbond them. Detailed instructions -are available [here](../maintain/maintain-guides-how-to-nominate-polkadot.md). +you're nominating, but you cannot withdraw your tokens unless you unbond them. ## Claiming Rewards with Polkadot-JS diff --git a/docs/learn/learn-guides-transfers.md b/docs/learn/learn-guides-transfers.md index 39c9bf10963e..04cb11361490 100644 --- a/docs/learn/learn-guides-transfers.md +++ b/docs/learn/learn-guides-transfers.md @@ -230,8 +230,8 @@ reaped. References may still exist from: If you have tokens that are bonded, you will need to unbond them before you can reap your account. Follow the instructions at -[Unbonding and Rebonding](../maintain/maintain-guides-how-to-nominate-polkadot.md) to check if you -have bonded tokens, stop nominating (if necessary) and unbond your tokens. +[Unbonding and Rebonding](./learn-guides-staking.md#step-1-bond-your-tokens) to check if you have +bonded tokens, stop nominating (if necessary) and unbond your tokens. ### Checking for Locks diff --git a/docs/learn/learn-nominator.md b/docs/learn/learn-nominator.md index 9127306fac1a..dc4c3fe0318f 100644 --- a/docs/learn/learn-nominator.md +++ b/docs/learn/learn-nominator.md @@ -12,9 +12,11 @@ import RPC from "./../../components/RPC-Connection"; :::tip New to Staking? Start your staking journey or explore more information about staking on -[Polkadot's Home Page](https://polkadot.network/staking/). Discover the new -[Staking Dashboard](https://staking.polkadot.network/#/overview) that makes staking much easier and -check this +[Polkadot's Home Page](https://polkadot.network/staking/). You can learn how staking works by +reading [this dedicated page](../learn/learn-staking.md). + +Discover the new [**Staking Dashboard**](https://staking.polkadot.network/#/overview) that makes +staking much easier and check this [extensive article list](https://support.polkadot.network/support/solutions/articles/65000182104) to help you get started. {{ polkadot: You can now [stake natively with just 1 DOT and earn staking rewards](https://polkadot.network/blog/nomination-pools-are-live-stake-natively-with-just-1-dot/). :polkadot }} @@ -47,6 +49,21 @@ The information provided on this page is complementary to that on the [**Staking Page**](./learn-staking.md) and [**Advanced Staking Page**](./learn-staking-advanced.md). Make sure you read those pages as well before nominating. +## Who are Nominators? + +Nominators are one type of participant in the staking subsystem of +{{ polkadot: Polkadot :polkadot }}{{ kusama: Kusama :kusama }}. They appoint their stake to the +validators, the second type of participant. By appointing their stake, they can elect the active set +of validators and share in the rewards that are paid out. + +While the [validators](../maintain/maintain-guides-how-to-validate-polkadot.md) are active +participants in the network that engage in the block production and finality mechanisms, nominators +take a slightly more passive role. Being a nominator does not require running a node of your own or +worrying about online uptime. However, a good nominator performs due diligence on the validators +that they elect. When looking for validators to nominate, a nominator should pay attention to their +own reward percentage for nominating a specific validator - as well as the risk that they bear of +being [slashed](./learn-staking.md#slashing) if the validator gets slashed. + ## Why Nominate? - You become part of the {{ polkadot: Polkadot :polkadot }}{{ kusama: Kusama :kusama }} movement, a @@ -79,9 +96,9 @@ you can share the staking rewards they generate. While your {{ polkadot: DOT :polkadot }}{{ kusama: KSM :kusama }} are staked for nominations, they are 'locked' (bonded). You can -[stop nominating at any time](../maintain/maintain-guides-how-to-nominate-polkadot.md), but remember -that the action is effective in the next era and does not automatically unbond your funds. Unbonding -is a separate action, and it takes effect after the unbonding period, which is +[stop nominating at any time](./learn-guides-staking.md#step-3-stop-nominating), but remember that +the action is effective in the next era and does not automatically unbond your funds. Unbonding is a +separate action, and it takes effect after the unbonding period, which is {{ polkadot: 28-day long on Polkadot :polkadot }}{{ kusama: 7-day long on Kusama :kusama }}. This is calculated by taking the **bonding duration** (in eras), multiplying it by the **length of a single era** (in hours), and dividing by the **hours in a day** (24). Example: @@ -89,7 +106,7 @@ era** (in hours), and dividing by the **hours in a day** (24). Example: staking lock will be visible on the Polkadot-JS UI during the unbonding period, and after it, the staking lock can be unlocked, and the bonded funds become free balance you can transfer. -:::info Fast Unstaking feature is live! +:::info Fast Unstaking If you accidentally bonded your {{ polkadot: DOT :polkadot }}{{ kusama: KSM :kusama }} or your bonded {{ polkadot: DOT :polkadot }}{{ kusama: KSM :kusama }} never backed any active validator, you @@ -108,7 +125,13 @@ qualify. For more information, visit the ### Stash & Staking Proxy -The first thing you need to do before becoming a nominator is to make sure you have a +Nominators are recommended to set up separate stash and staking proxy accounts. Explanation and the +reasoning for generating distinct accounts for this purpose is elaborated in the +[keys section](../learn/learn-cryptography.md#keys). + +You can generate your stash and staking proxy account via any of the recommended methods, which are +detailed on the [account generation](../learn/learn-accounts.md#account-generation) page. The first +thing you need to do before becoming a nominator is to make sure you have a [**stash account**](./learn-staking.md/#stash-account-and-staking-proxy) where you can transfer funds you want to use for staking. For these accounts, it is recommended to use a "cold wallet" solution such as [Ledger](../general/ledger.md) or [Polkadot Vault](../general/polkadot-vault.md). @@ -130,6 +153,12 @@ one of the following options: - to stash: rewards are sent to the stash account as a free balance. - to another account: rewards are sent to a user-defined account (not stash). +Starting with runtime version v23 natively included in the client version +[0.8.23](https://github.com/paritytech/polkadot/releases/tag/v0.8.23), payouts can go to any custom +address. If you'd like to redirect payments to an account that is neither the staking proxy nor the +stash account, set one up. Note that setting an exchange address as the recipient of the staking +rewards is extremely unsafe. + :::info Being a nominator is made simpler by using the @@ -293,8 +322,13 @@ corresponding nominators will be slashed. ## Nominating with the Staking Dashboard -The Staking Dashboard allows to choose pre-selected lists of validators based on user preference, or -to manually select validators similarly as in the Polkadot-JS UI. +If you are a beginner, please watch the video below for detailed instructions. + +[![Staking Tutorial](https://img.youtube.com/vi/F59N3YKYCRs/0.jpg)](https://www.youtube.com/watch?v=F59N3YKYCRs) + +The [Polkadot Staking Dashboard](../general/staking-dashboard.md) allows to choose pre-selected +lists of validators based on user preference, or to manually select validators similarly as in the +Polkadot-JS UI. Pre-selected choices are: @@ -445,7 +479,7 @@ details. When you go to the [Account actions](https://polkadot.js.org/apps/#/staking/actions) under staking page, you should see your bonded accounts and nomination status. If not, you can follow -[this](../maintain/maintain-guides-how-to-nominate-polkadot.md) guide to configure it first. Your +[this](./learn-guides-staking.md#nominate-using-polkadot-js) guide to configure it first. Your nominations will be effective in the next era; eras are roughly {{ polkadot: 24 hours on Polkadot. :polkadot }}{{ kusama: 6 hours on Kusama. :kusama }} @@ -482,7 +516,7 @@ higher, which can be viewed on ## Guides -- [Be a Nominator (Polkadot)](../maintain/maintain-guides-how-to-nominate-polkadot.md) - Guide on +- [Be a Nominator (Polkadot)](./learn-guides-staking.md#step-2-nominate-a-validator) - Guide on nominating on the Kusama canary network. -- [Stop Being a Nominator (all networks)](../maintain/maintain-guides-how-to-nominate-polkadot.md) - - Guide on stopping nominations and withdrawing tokens. +- [Stop Being a Nominator (all networks)](./learn-guides-staking#step-3-stop-nominating) - Guide on + stopping nominations and withdrawing tokens. diff --git a/docs/learn/learn-runtime-upgrades.md b/docs/learn/learn-runtime-upgrades.md index 2c36095bb159..276dc22a5cb6 100644 --- a/docs/learn/learn-runtime-upgrades.md +++ b/docs/learn/learn-runtime-upgrades.md @@ -114,7 +114,7 @@ Transactions constructed for runtime `n` will not work for any other runtime `>n upgrade occurs before broadcasting a previously constructed transaction, you will need to reconstruct it with the appropriate runtime version and corresponding metadata. -### For [Nominators](../maintain/maintain-guides-how-to-nominate-polkadot.md) +### For [Nominators](./learn-nominator.md) Runtime upgrades don't require any actions by a nominator, though it is always encouraged to keep up-to-date and participate with the latest runtime upgrade motions and releases while keeping an eye diff --git a/docs/learn/learn-staking.md b/docs/learn/learn-staking.md index ceed7001607a..35e2ce6a2364 100644 --- a/docs/learn/learn-staking.md +++ b/docs/learn/learn-staking.md @@ -222,9 +222,8 @@ relatively hands-off compared to that of a validator, and even more with [nomination pools](./learn-nomination-pools.md). For more information, you can take a look at the nominator [guide](learn-nominator.md) to understanding your responsibilities as a nominator. -If you want to become a nominator, see -[this](../maintain/maintain-guides-how-to-nominate-polkadot.md) guide. If you are a beginner and -would like to securely stake your tokens using the Polkadot-JS UI, refer to +If you want to become a nominator, see [this](../learn/learn-nominator.md) guide. If you are a +beginner and would like to securely stake your tokens using the Polkadot-JS UI, refer to [this](https://support.polkadot.network/support/solutions/articles/65000168057-how-do-i-stake-nominate-on-polkadot-) support article. {{ kusama: The tutorial presented in the support article is demonstrated on Polkadot, but the procedure is the same for Kusama. :kusama }} diff --git a/docs/maintain/archive/maintain-guides-democracy.md b/docs/maintain/archive/maintain-guides-democracy.md index 0844ed77ce7e..0845df27b8f4 100644 --- a/docs/maintain/archive/maintain-guides-democracy.md +++ b/docs/maintain/archive/maintain-guides-democracy.md @@ -201,7 +201,7 @@ Like [vesting](../../learn/learn-DOT.md#lazy-vesting), the tokens that are locke unlocked lazily. This means that you, the user, must explicitly call an unlock extrinsic to make your funds available again after the lock expires. Unbonding is another term you hear a lot in Polkadot, it means withdrawing your DOT that was used in staking. To know more about it, please see -[here](../maintain-guides-how-to-nominate-polkadot.md). +[here](../../learn/learn-nominator.md). You can do this from the "Accounts" page in [Polkadot-JS Apps](https://polkadot.js.org/apps/#/accounts), unless you use Ledger (see below). diff --git a/docs/maintain/maintain-guides-how-to-nominate-polkadot.md b/docs/maintain/maintain-guides-how-to-nominate-polkadot.md deleted file mode 100644 index 248dc38e3678..000000000000 --- a/docs/maintain/maintain-guides-how-to-nominate-polkadot.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: maintain-guides-how-to-nominate-polkadot -title: Become a Nominator on Polkadot -sidebar_label: Nominator Guides -description: Steps on how to nominate on Polkadot. -keywords: [nominate, how to nominate, nominator, stake] -slug: ../maintain-guides-how-to-nominate-polkadot ---- - -:::tip New to Staking? - -Start your staking journey or explore more information about staking on -[Polkadot's Home Page](https://polkadot.network/staking/). You can learn how staking works by -reading [this dedicated page](../learn/learn-staking.md). - -Discover the new [**Staking Dashboard**](https://staking.polkadot.network/#/overview) that makes -staking much easier and check this -[extensive article list](https://support.polkadot.network/support/solutions/articles/65000182104) to -help you get started. -{{ kusama: All the examples presented on Polkadot also apply to Kusama. :kusama }} - -::: - -Nominators are one type of participant in the staking subsystem of -{{ polkadot: Polkadot :polkadot }}{{ kusama: Kusama :kusama }}. They appoint their stake to the -validators, the second type of participant. By appointing their stake, they can elect the active set -of validators and share in the rewards that are paid out. - -While the [validators](maintain-guides-how-to-validate-polkadot.md) are active participants in the -network that engage in the block production and finality mechanisms, nominators take a slightly more -passive role. Being a nominator does not require running a node of your own or worrying about online -uptime. However, a good nominator performs due diligence on the validators that they elect. When -looking for validators to nominate, a nominator should pay attention to their own reward percentage -for nominating a specific validator - as well as the risk that they bear of being slashed if the -validator gets slashed. - -If you are a beginner, please watch the video below for detailed instructions. - -[![Staking Tutorial](https://img.youtube.com/vi/F59N3YKYCRs/0.jpg)](https://www.youtube.com/watch?v=F59N3YKYCRs) - -## Setting up Stash and Staking Proxy Accounts - -Nominators are recommended to set up separate stash and staking proxy accounts. Explanation and the -reasoning for generating distinct accounts for this purpose is elaborated in the -[keys](../learn/learn-cryptography.md#keys) section of the Wiki. - -You can generate your stash and staking proxy account via any of the recommended methods, which are -detailed on the [account generation](../learn/learn-accounts.md#account-generation) page. - -Starting with runtime version v23 natively included in the client version -[0.8.23](https://github.com/paritytech/polkadot/releases/tag/v0.8.23), payouts can go to any custom -address. If you'd like to redirect payments to an account that is neither the staking proxy nor the -stash account, set one up. Note that setting an exchange address as the recipient of the staking -rewards is extremely unsafe. - -## Using the Polkadot Staking Dashboard - -:::info Walk-through Video Tutorials - -- [**Nominating**](https://youtu.be/F59N3YKYCRs): Stake your tokens, choose your best validators, - and start your staking journey on {{ polkadot: Polkadot :polkadot }}{{ kusama: Kusama :kusama }}. -- [**Becoming a Pool Member**](https://youtu.be/dDIG7QAApig): Start becoming a part of the Polkadot - movement, keep {{ polkadot: Polkadot :polkadot }}{{ kusama: Kusama :kusama }} secure by staking - minimum 1 DOT and receiving staking rewards. -- [**Dashboard Walkthrough**](https://youtu.be/hvXLc4H7rA4): Become a Pro using the Staking - Dashboard. -- [**After Staking**](https://youtu.be/58pIe8tt2o4): Nominating on - {{ polkadot: Polkadot :polkadot }}{{ kusama: Kusama :kusama }} is not a set-and-forget action, - learn what you can do with the dashboard after you started staking. - -::: diff --git a/docs/maintain/maintain-guides-how-to-stop-validating.md b/docs/maintain/maintain-guides-how-to-stop-validating.md index 692d732ea7a1..5ed533064abd 100644 --- a/docs/maintain/maintain-guides-how-to-stop-validating.md +++ b/docs/maintain/maintain-guides-how-to-stop-validating.md @@ -48,7 +48,8 @@ that **cannot** be removed, and as a result that account cannot be reaped. to rebond, purge the session keys, unbond, and wait the unbonding period again before being able to transfer your tokens. -See [Unbonding and Rebonding](maintain-guides-how-to-nominate-polkadot.md) for more details. +See [Unbonding and Rebonding](../learn/learn-guides-staking.md#step-1-bond-your-tokens) for more +details. ::: diff --git a/docs/maintain/maintain-index.md b/docs/maintain/maintain-index.md index 5c41b716c2d7..94a8e50baa2d 100644 --- a/docs/maintain/maintain-index.md +++ b/docs/maintain/maintain-index.md @@ -18,8 +18,8 @@ guides to set up a node and run the network. For more information about being a Kusama maintainer, see the pages below: -- [Nomination Guide](./maintain-guides-how-to-nominate-polkadot.md) - Walkthrough on how to nominate - on the Kusama canary network. +- [Nomination Guide](../learn/learn-nominator.md) - Walkthrough on how to nominate on the Kusama + canary network. - [Validation Guide (Kusama)](kusama/maintain-guides-how-to-validate-kusama.md) - Walkthrough on how to validate on the Kusama canary network. diff --git a/kusama-guide/docusaurus.config.js b/kusama-guide/docusaurus.config.js index 6cc183aad205..17d99cc11f8f 100644 --- a/kusama-guide/docusaurus.config.js +++ b/kusama-guide/docusaurus.config.js @@ -90,6 +90,10 @@ module.exports = { { to: '/docs/learn-guides-assets-ledger', from: ['/docs/kusama-statemine-ledger'] + }, + { + to: '/docs/learn-nominator', + from: ['/docs/maintain-guides-how-to-nominate-polkadot'] } ], createRedirects: function (existingPath) { diff --git a/kusama-guide/sidebars.js b/kusama-guide/sidebars.js index 8d46925da04b..0cca07291a44 100644 --- a/kusama-guide/sidebars.js +++ b/kusama-guide/sidebars.js @@ -224,7 +224,7 @@ module.exports = { }, items: [ "learn/learn-staking", - "maintain/maintain-guides-how-to-nominate-polkadot", + "learn/learn-nominator", "learn/learn-nomination-pools", ], }, diff --git a/polkadot-wiki/docusaurus.config.js b/polkadot-wiki/docusaurus.config.js index 83471b3d20eb..661670bbbdd8 100644 --- a/polkadot-wiki/docusaurus.config.js +++ b/polkadot-wiki/docusaurus.config.js @@ -176,6 +176,10 @@ module.exports = { { to: '/docs/alpha-program', from: ['/docs/builders-program'] + }, + { + to: '/docs/learn-nominator', + from: ['/docs/maintain-guides-how-to-nominate-polkadot'] } ], createRedirects: function (existingPath) { diff --git a/polkadot-wiki/sidebars.js b/polkadot-wiki/sidebars.js index 2105913450ef..1bbefcec80d1 100644 --- a/polkadot-wiki/sidebars.js +++ b/polkadot-wiki/sidebars.js @@ -745,7 +745,6 @@ module.exports = { "maintain/maintain-errors", ], }, - "maintain/maintain-guides-how-to-nominate-polkadot", { type: "category", label: "Collator Guides",