diff --git a/docs/learn/archive/learn-controller.md b/docs/learn/archive/learn-controller.md index 9dee90f9aa1a..30d368050ccb 100644 --- a/docs/learn/archive/learn-controller.md +++ b/docs/learn/archive/learn-controller.md @@ -7,7 +7,7 @@ keywords: [nominated proof of stake, staking, controller] slug: ../learn-controller --- -
+

The content on this page is archived. Controller accounts are deprecated. For more information, see diff --git a/docs/learn/archive/learn-governance.md b/docs/learn/archive/learn-governance.md index 34b0c4c4194d..676dc8dece45 100644 --- a/docs/learn/archive/learn-governance.md +++ b/docs/learn/archive/learn-governance.md @@ -7,7 +7,7 @@ keywords: [governance, referenda, proposal, voting, endorse] slug: ../learn-governance --- -
+

The content on this page is archived. For up-to-date information about governance, see the diff --git a/docs/learn/archive/learn-launch.md b/docs/learn/archive/learn-launch.md index 5bb143fc6d2e..75535e5867af 100644 --- a/docs/learn/archive/learn-launch.md +++ b/docs/learn/archive/learn-launch.md @@ -7,7 +7,7 @@ keyword: [launch, phases, polkadot, DOT, claim, token sale, redenomination] slug: ../learn-launch --- -
+

The content on this page is archived. diff --git a/docs/learn/archive/learn-redenomination.md b/docs/learn/archive/learn-redenomination.md index aecf3785641d..c6a043629e40 100644 --- a/docs/learn/archive/learn-redenomination.md +++ b/docs/learn/archive/learn-redenomination.md @@ -7,7 +7,7 @@ keywords: [DOT, redenomination] slug: ../learn-redenomination --- -
+

The content on this page is archived. diff --git a/docs/learn/archive/learn-treasury.md b/docs/learn/archive/learn-treasury.md index 606ca9fe4f52..a40738b13e1e 100644 --- a/docs/learn/archive/learn-treasury.md +++ b/docs/learn/archive/learn-treasury.md @@ -7,7 +7,7 @@ keywords: [treasury, funds, funding, tips, tipping] slug: ../learn-treasury --- -
+

The content on this page is archived. For up-to-date information about treasury, see the diff --git a/docs/learn/learn-archive.md b/docs/learn/learn-archive.md index d8b44d8017f4..3007b3fc4161 100644 --- a/docs/learn/learn-archive.md +++ b/docs/learn/learn-archive.md @@ -9,7 +9,7 @@ slug: ../learn-archive import DocCardList from '@theme/DocCardList'; -
+

This section contains archived pages. The content in them no longer applies to Polkadot but can diff --git a/docs/learn/learn-guides-accounts-multisig.md b/docs/learn/learn-guides-accounts-multisig.md index ed145e3ebb28..bcdd800508fe 100644 --- a/docs/learn/learn-guides-accounts-multisig.md +++ b/docs/learn/learn-guides-accounts-multisig.md @@ -9,6 +9,15 @@ slug: ../learn-guides-accounts-multisig import RPC from "./../../components/RPC-Connection"; +
+
+ +[Polkadot-JS](../general/polkadotjs-ui.md) is for developers and power users only. For more +user-friendly tools see the [wallets](./wallets-index), [apps](./apps-index) and +[dashboard](./dashboards-index) pages. + +
+ ## Creating a Multisig Account Check the "How to create a multisig account" section on diff --git a/docs/learn/learn-guides-accounts-proxy-pure.md b/docs/learn/learn-guides-accounts-proxy-pure.md index c14dc961c060..d825475720d5 100644 --- a/docs/learn/learn-guides-accounts-proxy-pure.md +++ b/docs/learn/learn-guides-accounts-proxy-pure.md @@ -9,6 +9,15 @@ slug: ../learn-guides-accounts-proxy-pure import RPC from "./../../components/RPC-Connection"; +
+
+ +[Polkadot-JS](../general/polkadotjs-ui.md) is for developers and power users only. For more +user-friendly tools see the [wallets](./wallets-index), [apps](./apps-index) and +[dashboard](./dashboards-index) pages. + +
+ :::caution The Account Tab in the Polkadot-JS UI cannot handle complex proxy setups The Accounts Tab in the Polkadot-JS UI cannot handle complex proxy setups (e.g. a proxy -> multisig diff --git a/docs/learn/learn-guides-accounts-proxy.md b/docs/learn/learn-guides-accounts-proxy.md index db3eae4f98c2..0dcfb344f4a0 100644 --- a/docs/learn/learn-guides-accounts-proxy.md +++ b/docs/learn/learn-guides-accounts-proxy.md @@ -9,6 +9,15 @@ slug: ../learn-guides-accounts-proxy import RPC from "./../../components/RPC-Connection"; +
+
+ +[Polkadot-JS](../general/polkadotjs-ui.md) is for developers and power users only. For more +user-friendly tools see the [wallets](./wallets-index), [apps](./apps-index) and +[dashboard](./dashboards-index) pages. + +
+ Proxies allow users to use an account (it can be in cold storage or a hot wallet) less frequently but actively participate in the network with the weight of the tokens in that account. Proxies are allowed to perform a limited amount of actions related to specific diff --git a/docs/learn/learn-guides-accounts.md b/docs/learn/learn-guides-accounts.md index 7727abd2bc9d..bef13c30caa2 100644 --- a/docs/learn/learn-guides-accounts.md +++ b/docs/learn/learn-guides-accounts.md @@ -10,6 +10,15 @@ slug: ../learn-guides-accounts import RPC from "./../../components/RPC-Connection"; import Tabs from "@theme/Tabs"; import TabItem from "@theme/TabItem"; import DocCardList from '@theme/DocCardList'; +
+
+ +[Polkadot-JS](../general/polkadotjs-ui.md) is for developers and power users only. For more +user-friendly tools see the [wallets](./wallets-index), [apps](./apps-index) and +[dashboard](./dashboards-index) pages. + +
+ ## Account Address Format diff --git a/docs/learn/learn-guides-assets-create.md b/docs/learn/learn-guides-assets-create.md index 18e8edfd8bfc..f2df57b50c9b 100644 --- a/docs/learn/learn-guides-assets-create.md +++ b/docs/learn/learn-guides-assets-create.md @@ -1,7 +1,7 @@ --- id: learn-guides-assets-create title: Polkadot-JS Guides about Creating Assets -sidebar_label: Asset Guides +sidebar_label: Create Asset Guides description: Polkadot-JS Guides about Creating Assets. keywords: [asset hub, assets, statemine, statemint, polkadot-js] slug: ../learn-guides-assets-create @@ -9,6 +9,15 @@ slug: ../learn-guides-assets-create import RPC from "./../../components/RPC-Connection"; +
+
+ +[Polkadot-JS](../general/polkadotjs-ui.md) is for developers and power users only. For more +user-friendly tools see the [wallets](./wallets-index), [apps](./apps-index) and +[dashboard](./dashboards-index) pages. + +
+ The Asset Hub is a generic assets system parachain which provides functionality for deploying and transferring assets — both Fungible and Non-Fungible Tokens (NFTs). The native token of the Asset hub is {{ polkadot: DOT :polkadot }}{{ kusama: KSM :kusama }}. The Existential Deposit (ED), diff --git a/docs/learn/learn-guides-assets-ledger.md b/docs/learn/learn-guides-assets-ledger.md index f89ee05b0f8a..c1c6b19a1cad 100644 --- a/docs/learn/learn-guides-assets-ledger.md +++ b/docs/learn/learn-guides-assets-ledger.md @@ -7,6 +7,15 @@ keywords: [asset hub, ledger, assets, statemine, statemint, polkadot-js] slug: ../learn-guides-assets-ledger --- +
+
+ +[Polkadot-JS](../general/polkadotjs-ui.md) is for developers and power users only. For more +user-friendly tools see the [wallets](./wallets-index), [apps](./apps-index) and +[dashboard](./dashboards-index) pages. + +
+ :::info Because of required WebUSB support, Ledger wallets currently only work on Chromium-based browsers diff --git a/docs/learn/learn-guides-assets.md b/docs/learn/learn-guides-assets.md new file mode 100644 index 000000000000..ae9baebd2faf --- /dev/null +++ b/docs/learn/learn-guides-assets.md @@ -0,0 +1,21 @@ +--- +id: learn-guides-assets +title: Polkadot-JS Guides about Asset Hub +sidebar_label: Asset Hub Guides +description: Polkadot-JS Guides about Asset Hub. +keywords: [asset hub, assets, statemine, statemint, polkadot-js] +slug: ../learn-guides-assets +--- + +import DocCardList from '@theme/DocCardList'; + +
+
+ +[Polkadot-JS](../general/polkadotjs-ui.md) is for developers and power users only. For more +user-friendly tools see the [wallets](./wallets-index), [apps](./apps-index) and +[dashboard](./dashboards-index) pages. + +
+ + diff --git a/docs/learn/learn-guides-bounties.md b/docs/learn/learn-guides-bounties.md index f1f784038a3a..1331d343d199 100644 --- a/docs/learn/learn-guides-bounties.md +++ b/docs/learn/learn-guides-bounties.md @@ -9,6 +9,15 @@ slug: ../learn-guides-bounties import RPC from "./../../components/RPC-Connection"; +
+
+ +[Polkadot-JS](../general/polkadotjs-ui.md) is for developers and power users only. For more +user-friendly tools see the [wallets](./wallets-index), [apps](./apps-index) and +[dashboard](./dashboards-index) pages. + +
+ See [this page](./learn-polkadot-opengov-treasury.md#bounties) to learn about Bounties. :::info Notify the Polkadot Direction Channel diff --git a/docs/learn/learn-guides-identity.md b/docs/learn/learn-guides-identity.md index 827075e7e6e9..3a1d9c4758b3 100644 --- a/docs/learn/learn-guides-identity.md +++ b/docs/learn/learn-guides-identity.md @@ -9,6 +9,15 @@ slug: ../learn-guides-identity import RPC from "./../../components/RPC-Connection"; +
+
+ +[Polkadot-JS](../general/polkadotjs-ui.md) is for developers and power users only. For more +user-friendly tools see the [wallets](./wallets-index), [apps](./apps-index) and +[dashboard](./dashboards-index) pages. + +
+ This is an advanced guide that is relevant for entities that would like to become registrars or would like to set sub-identities to an existing account with an identity. See [this page](./learn-identity.md) to learn about how to set an identity and have it verified. diff --git a/docs/learn/learn-guides-ledger.md b/docs/learn/learn-guides-ledger.md index c07964e19dda..c884d076ec03 100644 --- a/docs/learn/learn-guides-ledger.md +++ b/docs/learn/learn-guides-ledger.md @@ -7,6 +7,15 @@ keywords: [ledger, polkadot-js] slug: ../learn-guides-ledger --- +
+
+ +[Polkadot-JS](../general/polkadotjs-ui.md) is for developers and power users only. For more +user-friendly tools see the [wallets](./wallets-index), [apps](./apps-index) and +[dashboard](./dashboards-index) pages. + +
+ ## Loading Your Account :::info diff --git a/docs/learn/learn-guides-nominator.md b/docs/learn/learn-guides-nominator.md new file mode 100644 index 000000000000..a43d9c2e42e0 --- /dev/null +++ b/docs/learn/learn-guides-nominator.md @@ -0,0 +1,259 @@ +--- +id: learn-guides-nominator +title: Polkadot-JS Guides For Nominators +sidebar_label: Nominator Guides +description: Polkadot-JS Guides for Nominators. +keyword: [nominate, stake, staking, claim, rewards, polkadot-js] +slug: ../learn-guides-nominator +--- + +import RPC from "./../../components/RPC-Connection"; + +
+
+ +[Polkadot-JS](../general/polkadotjs-ui.md) is for developers and power users only. For more +user-friendly tools see the [wallets](./wallets-index), [apps](./apps-index) and +[dashboard](./dashboards-index) pages. + +
+ +See [this page](./learn-staking.md) to learn about staking. + +## Nominate Using Polkadot-JS + +:::info Video Tutorials + +- [How to Nominate/Stake](https://youtu.be/FCXC0CDhyS4?t=219) +- [Staking with a Ledger device and Polkadot-JS](https://youtu.be/7VlTncHCGPc) +- [Staking with a Ledger device and Ledger Live](https://www.youtube.com/watch?v=jL-N_IWiYVA) + +::: + +### Bond your tokens + +:::info Support Article + +Read the support article about +[How to Bond Tokens and Nominate](https://support.polkadot.network/support/solutions/articles/65000168057-polkadot-js-ui-how-do-i-stake-nominate-on-polkadot-). + +::: + +On the [Polkadot-JS UI](https://polkadot.js.org/apps) navigate to the "Staking" tab (within the +"Network" menu). + +The "Staking Overview" subsection will show you all the active validators and their information - +their identities, the amount of KSM that are staking for them, amount that is their own provided +stake, how much they charge in commission, the era points they've earned in the current era, and the +last block number that they produced. If you click on the chart button it will take you to the +"Validator Stats" page for that validator that shows you more detailed and historical information +about the validator's stake, rewards and slashes. + +The "Account actions" subsection ([link](https://polkadot.js.org/apps/#/staking/actions)) allows you +to stake and nominate. + +The "Payouts" subsection ([link](https://polkadot.js.org/apps/#/staking/payouts)) allows you to +claim rewards from staking. + +The "Targets" subsection ([link](https://polkadot.js.org/apps/#/staking/targets)) will help you +estimate your earnings and this is where it's good to start picking favorites. + +The "Waiting" subsection ([link](https://polkadot.js.org/apps/#/staking/waiting)) lists all pending +validators that are awaiting more nominations to enter the active validator set. Validators will +stay in the waiting queue until they have enough KSM backing them (as allocated through the +[Phragmén election mechanism](./learn-phragmen.md)). It is possible validator can remain in the +queue for a very long time if they never get enough backing. + +The "Validator Stats" subsection ([link](https://polkadot.js.org/apps/#/staking/query)) allows you +to query a validator's stash address and see historical charts on era points, elected stake, +rewards, and slashes. + +Pick "Account actions" underneath "Network" > "Staking", then click the "+ Nominator" button. + +You will see a modal window that looks like the below: + +![nominator-update-1](../assets/kusama/kusama_nominator_popup.png) + +Select a "value bonded" that is **less** than the total amount of KSM you have, so you have some +left over to pay transaction fees. Transaction fees are currently at least 0.01 KSM, but they are +dynamic based on a variety of factors including the load of recent blocks. + +Also be mindful of the reaping threshold - the amount that must remain in an account lest it be +burned. That amount is 0.01 in Kusama, so it's recommended to keep at least 0.1 KSM in your account +to be on the safe side. + +Choose whatever payment destination that makes sense to you. If you're unsure, you can choose "Stash +account (increase amount at stake)" to simply accrue the rewards into the amount you're staking and +earn compound interest. + +![Payout account selection dropdown with the custom account option highlighted](../assets/payout/01.png) + +### Nominate a validator + +:::info Support Article + +Read the support article about +[How to Select Validators](https://support.polkadot.network/support/solutions/articles/65000150130-how-do-i-know-which-validators-to-choose-). + +::: + +You are now bonded. Being bonded means your tokens are locked and could be +[slashed](./learn-staking.md#slashing) if the validators you nominate misbehave. All bonded funds +can now be distributed to up to {{ polkadot: 16 :polkadot }} {{ kusama: 24 :kusama }} validators. Be +careful about the validators you choose since you will be slashed if your validator commits an +offence. + +Click on "Nominate" on an account you've bonded and you will be presented with another popup asking +you to select some validators. + +![Nominating validators](../assets/kusama/kusama_nominator_selection.png) + +Select them, confirm the transaction, and you're done - you are now nominating. Your nominations +will become active in the next era. Eras last six hours on Kusama - depending on when you do this, +your nominations may become active almost immediately, or you may have to wait almost the entire six +hours before your nominations are active. You can check how far along Kusama is in the current era +on the [Staking page](https://polkadot.js.org/apps/#/staking). + +Assuming at least one of your nominations ends up in the active validator set, you will start to get +rewards allocated to you. In order to claim them (i.e., add them to your account), you must manually +claim them. To initiate a claim, you can do it yourself or have the validator that you staked for +initiate a claim. This is to help optimize the effectiveness and storage of payouts on Kusama. See +the [Claiming Rewards](./learn-staking.md#claiming-rewards) section of the Staking wiki page for +more details. + +### Stop nominating + +:::info Support Article + +Read the support article about +[How to Stop Nominating & Unbond Tokens](https://support.polkadot.network/support/solutions/articles/65000167902-how-can-i-unstake-my-tokens-again-). +See also the support article about +[How to Rebond Tokens](https://support.polkadot.network/support/solutions/articles/65000170241-polkadot-js-ui-how-to-rebond-tokens-during-the-unbonding-period). + +::: + +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. + +## Claiming Rewards with Polkadot-JS + +Anyone can trigger a payout for any validator, as long as they are willing to pay the transaction +fee. Someone must submit a transaction with a validator ID and an era index. +{{ polkadot: Polkadot :polkadot }}{{ kusama: Kusama :kusama }} will automatically calculate that +validator's reward, find the top +{{ polkadot: :polkadot }} +{{ kusama: :kusama }} +nominators for that era, and distribute the rewards pro rata. + +:::note + +The Staking system only applies the highest +{{ polkadot: :polkadot }} +{{ kusama: :kusama }} +nominations to each validator to reduce the complexity of the staking set. + +::: + +These details are handled for you automatically if you use the +[Polkadot-JS UI](https://polkadot.js.org/apps/#/staking/payout), which also allows you to submit +batches of eras at once. + +To claim rewards on Polkadot-JS UI, you will need to be in the "Payouts" tab underneath "Staking", +which will list all the pending payouts for your stashes. + +![pending-payouts](../assets/polkadotjs_payout_page.png) + +To then claim your reward, select the "Payout all" button. This will prompt you to select your stash +accounts for payout. + +![select-payouts](../assets/polkadotjs_payout_popup.png) + +Once you are done with payout, another screen will appear asking for you to sign and submit the +transaction. + +![transaction-payouts](../assets/polkadotjs_payout_complete.png) + +## Using Command-Line Interface (CLI) + +Apart from using the Polkadot-JS UI to participate in the staking, you can do all these things in +CLI instead. The CLI approach allows you to interact with the +{{ polkadot: Polkadot :polkadot }}{{ kusama: Kusama :kusama }} network without using Polkadot-JS. + +### Step 1: Install @polkadot/api-cli + +We assume you have installed [NodeJS with npm](https://nodejs.org). Run the following command to +install the `@polkadot/api-cli` globally: + +```bash +npm install -g @polkadot/api-cli +``` + +### Step 2: Bond Tokens + +:::info Controller accounts are deprecated + +Controller accounts are deprecated. For more information, see +[this discussion](https://forum.polkadot.network/t/staking-controller-deprecation-plan-staking-ui-leads-comms/2748). + +::: + +Executing the following command: + +```bash +polkadot-js-api --seed "MNEMONIC_PHRASE" tx.staking.bond CONTROLLER_ADDRESS NUMBER_OF_TOKENS REWARD_DESTINATION --ws WEBSOCKET_ENDPOINT +``` + +`CONTROLLER_ADDRESS`: An address you would like to bond to the stash account. (Controller accounts +are now deprecated. Refer to +[this discussion](https://forum.polkadot.network/t/staking-controller-deprecation-plan-staking-ui-leads-comms/2748) +for additional context) + +`NUMBER_OF_TOKENS`: The number of {{ polkadot: DOT :polkadot }}{{ kusama: KSM :kusama }} you would +like to stake to the network. +{{ polkadot: DOT has ten decimal places and is always represented as an integer with zeroes at the end. So 1 DOT = 10_000_000_000 Plancks. :polkadot }}{{ kusama: KSM has twelve decimal places and is always represented as an integer with zeroes at the end. So 1 KSM = +1_000_000_000_000 Plancks. :kusama }} For more information, see [this page](../learn/learn-DOT.md). + +`REWARD_DESTINATION`: + +- `Staked` - Pay into the stash account, increasing the amount at stake accordingly. +- `Stash` - Pay into the stash account, not increasing the amount at stake. +- `Account` - Pay into a custom account, like so: + {{ polkadot: `Account 1n8msHozaNxHicWFnRnNXzvqkYPWczkzUUkHhKw6o2BLBdo` :polkadot }}{{ kusama: `Account DMTHrNcmA8QbqRS4rBq8LXn8ipyczFoNMb1X4cY2WD9tdBX` :kusama }}. +- `Controller` - Pay into the controller account. + +Example for Kusama: + +```bash +polkadot-js-api --seed "xxxx xxxxx xxxx xxxxx" tx.staking.bond DMTHrNcmA8QbqRS4rBq8LXn8ipyczFoNMb1X4cY2WD9tdBX 1000000000000 Staked --ws wss://kusama-rpc.polkadot.io +``` + +For wss endpoints see [this page](../maintain/maintain-endpoints.md). + +Result: + +```bash +... +... + "status": { + "InBlock": "0x0ed1ec0ba69564e8f98958d69f826adef895b5617366a32a3aa384290e98514e" + } +``` + +You can check the transaction status by using the value of the `InBlock` in +[Subscan](https://www.subscan.io/). Also, you can verify the bonding state under the +[Staking](https://polkadot.js.org/apps/#/staking/actions) page on the Polkadot-JS UI. + +### Step 3: Nominate a validator + +To nominate a validator, you can execute the following command: + +```bash +polkadot-js-api --seed "MNEMONIC_PHRASE" tx.staking.nominate '["VALIDATOR_ADDRESS"]' --ws WS_ENDPOINT +``` + +```bash +polkadot-js-api --seed "xxxx xxxxx xxxx xxxxx" tx.staking.nominate '["CmD9vaMYoiKe7HiFnfkftwvhKbxN9bhyjcDrfFRGbifJEG8","E457XaKbj2yTB2URy8N4UuzmyuFRkcdxYs67UvSgVr7HyFb"]' --ws wss://kusama-rpc.polkadot.io +``` + +After a few seconds, you should see the hash of the transaction, and if you would like to verify the +nomination status, you can check that on the Polkadot-JS UI as well. diff --git a/docs/learn/learn-guides-polkadot-opengov.md b/docs/learn/learn-guides-polkadot-opengov.md index 1a2116751b8f..b02fab2e2993 100644 --- a/docs/learn/learn-guides-polkadot-opengov.md +++ b/docs/learn/learn-guides-polkadot-opengov.md @@ -9,6 +9,15 @@ slug: ../learn-guides-polkadot-opengov import RPC from "./../../components/RPC-Connection"; +
+
+ +[Polkadot-JS](../general/polkadotjs-ui.md) is for developers and power users only. For more +user-friendly tools see the [wallets](./wallets-index), [apps](./apps-index) and +[dashboard](./dashboards-index) pages. + +
+ See [this page](./learn-polkadot-opengov.md) to learn about Polkadot OpenGov. This guide will instruct token holders how to propose and vote on public referenda using the diff --git a/docs/learn/learn-guides-staking-pools.md b/docs/learn/learn-guides-staking-pools.md index 613d88f05ef6..30cea9dfcf03 100644 --- a/docs/learn/learn-guides-staking-pools.md +++ b/docs/learn/learn-guides-staking-pools.md @@ -9,6 +9,15 @@ slug: ../learn-guides-staking-pools import RPC from "./../../components/RPC-Connection"; +
+
+ +[Polkadot-JS](../general/polkadotjs-ui.md) is for developers and power users only. For more +user-friendly tools see the [wallets](./wallets-index), [apps](./apps-index) and +[dashboard](./dashboards-index) pages. + +
+ See [this page](./learn-nomination-pools.md) to learn about nomination pools. ## Pool Creation with Polkadot-JS diff --git a/docs/learn/learn-guides-staking.md b/docs/learn/learn-guides-staking.md index 7a244d95ca20..f58b35c74170 100644 --- a/docs/learn/learn-guides-staking.md +++ b/docs/learn/learn-guides-staking.md @@ -1,250 +1,21 @@ --- id: learn-guides-staking -title: Polkadot-JS Guides For Nominators -sidebar_label: Nominator Guides -description: Polkadot-JS Guides for Nominators. -keyword: [nominate, stake, staking, claim, rewards, polkadot-js] +title: Polkadot-JS Guides about Staking +sidebar_label: Staking Guides +description: Polkadot-JS Guides about Staking. +keyword: [nominate, stake, staking, claim, rewards, polkadot-js, pools] slug: ../learn-guides-staking --- -import RPC from "./../../components/RPC-Connection"; +import DocCardList from '@theme/DocCardList'; -See [this page](./learn-staking.md) to learn about staking. +
+
-## Nominate Using Polkadot-JS +[Polkadot-JS](../general/polkadotjs-ui.md) is for developers and power users only. For more +user-friendly tools see the [wallets](./wallets-index), [apps](./apps-index) and +[dashboard](./dashboards-index) pages. -:::info Video Tutorials +
-- [How to Nominate/Stake](https://youtu.be/FCXC0CDhyS4?t=219) -- [Staking with a Ledger device and Polkadot-JS](https://youtu.be/7VlTncHCGPc) -- [Staking with a Ledger device and Ledger Live](https://www.youtube.com/watch?v=jL-N_IWiYVA) - -::: - -### Bond your tokens - -:::info Support Article - -Read the support article about -[How to Bond Tokens and Nominate](https://support.polkadot.network/support/solutions/articles/65000168057-polkadot-js-ui-how-do-i-stake-nominate-on-polkadot-). - -::: - -On the [Polkadot-JS UI](https://polkadot.js.org/apps) navigate to the "Staking" tab (within the -"Network" menu). - -The "Staking Overview" subsection will show you all the active validators and their information - -their identities, the amount of KSM that are staking for them, amount that is their own provided -stake, how much they charge in commission, the era points they've earned in the current era, and the -last block number that they produced. If you click on the chart button it will take you to the -"Validator Stats" page for that validator that shows you more detailed and historical information -about the validator's stake, rewards and slashes. - -The "Account actions" subsection ([link](https://polkadot.js.org/apps/#/staking/actions)) allows you -to stake and nominate. - -The "Payouts" subsection ([link](https://polkadot.js.org/apps/#/staking/payouts)) allows you to -claim rewards from staking. - -The "Targets" subsection ([link](https://polkadot.js.org/apps/#/staking/targets)) will help you -estimate your earnings and this is where it's good to start picking favorites. - -The "Waiting" subsection ([link](https://polkadot.js.org/apps/#/staking/waiting)) lists all pending -validators that are awaiting more nominations to enter the active validator set. Validators will -stay in the waiting queue until they have enough KSM backing them (as allocated through the -[Phragmén election mechanism](./learn-phragmen.md)). It is possible validator can remain in the -queue for a very long time if they never get enough backing. - -The "Validator Stats" subsection ([link](https://polkadot.js.org/apps/#/staking/query)) allows you -to query a validator's stash address and see historical charts on era points, elected stake, -rewards, and slashes. - -Pick "Account actions" underneath "Network" > "Staking", then click the "+ Nominator" button. - -You will see a modal window that looks like the below: - -![nominator-update-1](../assets/kusama/kusama_nominator_popup.png) - -Select a "value bonded" that is **less** than the total amount of KSM you have, so you have some -left over to pay transaction fees. Transaction fees are currently at least 0.01 KSM, but they are -dynamic based on a variety of factors including the load of recent blocks. - -Also be mindful of the reaping threshold - the amount that must remain in an account lest it be -burned. That amount is 0.01 in Kusama, so it's recommended to keep at least 0.1 KSM in your account -to be on the safe side. - -Choose whatever payment destination that makes sense to you. If you're unsure, you can choose "Stash -account (increase amount at stake)" to simply accrue the rewards into the amount you're staking and -earn compound interest. - -![Payout account selection dropdown with the custom account option highlighted](../assets/payout/01.png) - -### Nominate a validator - -:::info Support Article - -Read the support article about -[How to Select Validators](https://support.polkadot.network/support/solutions/articles/65000150130-how-do-i-know-which-validators-to-choose-). - -::: - -You are now bonded. Being bonded means your tokens are locked and could be -[slashed](./learn-staking.md#slashing) if the validators you nominate misbehave. All bonded funds -can now be distributed to up to {{ polkadot: 16 :polkadot }} {{ kusama: 24 :kusama }} validators. Be -careful about the validators you choose since you will be slashed if your validator commits an -offence. - -Click on "Nominate" on an account you've bonded and you will be presented with another popup asking -you to select some validators. - -![Nominating validators](../assets/kusama/kusama_nominator_selection.png) - -Select them, confirm the transaction, and you're done - you are now nominating. Your nominations -will become active in the next era. Eras last six hours on Kusama - depending on when you do this, -your nominations may become active almost immediately, or you may have to wait almost the entire six -hours before your nominations are active. You can check how far along Kusama is in the current era -on the [Staking page](https://polkadot.js.org/apps/#/staking). - -Assuming at least one of your nominations ends up in the active validator set, you will start to get -rewards allocated to you. In order to claim them (i.e., add them to your account), you must manually -claim them. To initiate a claim, you can do it yourself or have the validator that you staked for -initiate a claim. This is to help optimize the effectiveness and storage of payouts on Kusama. See -the [Claiming Rewards](./learn-staking.md#claiming-rewards) section of the Staking wiki page for -more details. - -### Stop nominating - -:::info Support Article - -Read the support article about -[How to Stop Nominating & Unbond Tokens](https://support.polkadot.network/support/solutions/articles/65000167902-how-can-i-unstake-my-tokens-again-). -See also the support article about -[How to Rebond Tokens](https://support.polkadot.network/support/solutions/articles/65000170241-polkadot-js-ui-how-to-rebond-tokens-during-the-unbonding-period). - -::: - -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. - -## Claiming Rewards with Polkadot-JS - -Anyone can trigger a payout for any validator, as long as they are willing to pay the transaction -fee. Someone must submit a transaction with a validator ID and an era index. -{{ polkadot: Polkadot :polkadot }}{{ kusama: Kusama :kusama }} will automatically calculate that -validator's reward, find the top -{{ polkadot: :polkadot }} -{{ kusama: :kusama }} -nominators for that era, and distribute the rewards pro rata. - -:::note - -The Staking system only applies the highest -{{ polkadot: :polkadot }} -{{ kusama: :kusama }} -nominations to each validator to reduce the complexity of the staking set. - -::: - -These details are handled for you automatically if you use the -[Polkadot-JS UI](https://polkadot.js.org/apps/#/staking/payout), which also allows you to submit -batches of eras at once. - -To claim rewards on Polkadot-JS UI, you will need to be in the "Payouts" tab underneath "Staking", -which will list all the pending payouts for your stashes. - -![pending-payouts](../assets/polkadotjs_payout_page.png) - -To then claim your reward, select the "Payout all" button. This will prompt you to select your stash -accounts for payout. - -![select-payouts](../assets/polkadotjs_payout_popup.png) - -Once you are done with payout, another screen will appear asking for you to sign and submit the -transaction. - -![transaction-payouts](../assets/polkadotjs_payout_complete.png) - -## Using Command-Line Interface (CLI) - -Apart from using the Polkadot-JS UI to participate in the staking, you can do all these things in -CLI instead. The CLI approach allows you to interact with the -{{ polkadot: Polkadot :polkadot }}{{ kusama: Kusama :kusama }} network without using Polkadot-JS. - -### Step 1: Install @polkadot/api-cli - -We assume you have installed [NodeJS with npm](https://nodejs.org). Run the following command to -install the `@polkadot/api-cli` globally: - -```bash -npm install -g @polkadot/api-cli -``` - -### Step 2: Bond Tokens - -:::info Controller accounts are deprecated - -Controller accounts are deprecated. For more information, see -[this discussion](https://forum.polkadot.network/t/staking-controller-deprecation-plan-staking-ui-leads-comms/2748). - -::: - -Executing the following command: - -```bash -polkadot-js-api --seed "MNEMONIC_PHRASE" tx.staking.bond CONTROLLER_ADDRESS NUMBER_OF_TOKENS REWARD_DESTINATION --ws WEBSOCKET_ENDPOINT -``` - -`CONTROLLER_ADDRESS`: An address you would like to bond to the stash account. (Controller accounts -are now deprecated. Refer to -[this discussion](https://forum.polkadot.network/t/staking-controller-deprecation-plan-staking-ui-leads-comms/2748) -for additional context) - -`NUMBER_OF_TOKENS`: The number of {{ polkadot: DOT :polkadot }}{{ kusama: KSM :kusama }} you would -like to stake to the network. -{{ polkadot: DOT has ten decimal places and is always represented as an integer with zeroes at the end. So 1 DOT = 10_000_000_000 Plancks. :polkadot }}{{ kusama: KSM has twelve decimal places and is always represented as an integer with zeroes at the end. So 1 KSM = -1_000_000_000_000 Plancks. :kusama }} For more information, see [this page](../learn/learn-DOT.md). - -`REWARD_DESTINATION`: - -- `Staked` - Pay into the stash account, increasing the amount at stake accordingly. -- `Stash` - Pay into the stash account, not increasing the amount at stake. -- `Account` - Pay into a custom account, like so: - {{ polkadot: `Account 1n8msHozaNxHicWFnRnNXzvqkYPWczkzUUkHhKw6o2BLBdo` :polkadot }}{{ kusama: `Account DMTHrNcmA8QbqRS4rBq8LXn8ipyczFoNMb1X4cY2WD9tdBX` :kusama }}. -- `Controller` - Pay into the controller account. - -Example for Kusama: - -```bash -polkadot-js-api --seed "xxxx xxxxx xxxx xxxxx" tx.staking.bond DMTHrNcmA8QbqRS4rBq8LXn8ipyczFoNMb1X4cY2WD9tdBX 1000000000000 Staked --ws wss://kusama-rpc.polkadot.io -``` - -For wss endpoints see [this page](../maintain/maintain-endpoints.md). - -Result: - -```bash -... -... - "status": { - "InBlock": "0x0ed1ec0ba69564e8f98958d69f826adef895b5617366a32a3aa384290e98514e" - } -``` - -You can check the transaction status by using the value of the `InBlock` in -[Subscan](https://www.subscan.io/). Also, you can verify the bonding state under the -[Staking](https://polkadot.js.org/apps/#/staking/actions) page on the Polkadot-JS UI. - -### Step 3: Nominate a validator - -To nominate a validator, you can execute the following command: - -```bash -polkadot-js-api --seed "MNEMONIC_PHRASE" tx.staking.nominate '["VALIDATOR_ADDRESS"]' --ws WS_ENDPOINT -``` - -```bash -polkadot-js-api --seed "xxxx xxxxx xxxx xxxxx" tx.staking.nominate '["CmD9vaMYoiKe7HiFnfkftwvhKbxN9bhyjcDrfFRGbifJEG8","E457XaKbj2yTB2URy8N4UuzmyuFRkcdxYs67UvSgVr7HyFb"]' --ws wss://kusama-rpc.polkadot.io -``` - -After a few seconds, you should see the hash of the transaction, and if you would like to verify the -nomination status, you can check that on the Polkadot-JS UI as well. + diff --git a/docs/learn/learn-guides-transfers.md b/docs/learn/learn-guides-transfers.md index b77abd0fe012..035ed8d0fc8d 100644 --- a/docs/learn/learn-guides-transfers.md +++ b/docs/learn/learn-guides-transfers.md @@ -10,6 +10,15 @@ slug: ../learn-guides-transfers import RPC from "./../../components/RPC-Connection"; import Tabs from "@theme/Tabs"; import TabItem from "@theme/TabItem"; import DocCardList from '@theme/DocCardList'; +
+
+ +[Polkadot-JS](../general/polkadotjs-ui.md) is for developers and power users only. For more +user-friendly tools see the [wallets](./wallets-index), [apps](./apps-index) and +[dashboard](./dashboards-index) pages. + +
+ ## Metadata Updates with the Polkadot-JS Browser Extension Before signing extrinsics with the Polkadot-JS Browser Extension, always check for metadata updates. @@ -229,8 +238,8 @@ reaped. References may still exist from: ### Bonded Tokens 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](./learn-guides-staking.md#bond-your-tokens) to -check if you have bonded tokens, stop nominating (if necessary) and unbond your tokens. +Follow the instructions at [Unbonding and Rebonding](./learn-guides-nominator.md#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-guides-treasury.md b/docs/learn/learn-guides-treasury.md index 904bf229b0cd..6b7db815e4c8 100644 --- a/docs/learn/learn-guides-treasury.md +++ b/docs/learn/learn-guides-treasury.md @@ -9,6 +9,15 @@ slug: ../learn-guides-treasury import RPC from "./../../components/RPC-Connection"; +
+
+ +[Polkadot-JS](../general/polkadotjs-ui.md) is for developers and power users only. For more +user-friendly tools see the [wallets](./wallets-index), [apps](./apps-index) and +[dashboard](./dashboards-index) pages. + +
+ See [this page](./learn-polkadot-opengov-treasury.md) to learn about the Polkadot Treasury. ## Creating a Treasury Proposal diff --git a/docs/learn/learn-guides-vault.md b/docs/learn/learn-guides-vault.md index 2aef641b6dce..a44282a2b221 100644 --- a/docs/learn/learn-guides-vault.md +++ b/docs/learn/learn-guides-vault.md @@ -7,6 +7,15 @@ keywords: [parity signer, signer, polkadot vault, polkadot-js] slug: ../learn-guides-vault --- +
+
+ +[Polkadot-JS](../general/polkadotjs-ui.md) is for developers and power users only. For more +user-friendly tools see the [wallets](./wallets-index), [apps](./apps-index) and +[dashboard](./dashboards-index) pages. + +
+ :::info These guides apply to both Parity Signer and Polkadot Vault apps. diff --git a/docs/learn/learn-nominator.md b/docs/learn/learn-nominator.md index 9391c91594b1..37921d479eba 100644 --- a/docs/learn/learn-nominator.md +++ b/docs/learn/learn-nominator.md @@ -96,7 +96,7 @@ 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](./learn-guides-staking.md#stop-nominating), but remember that the +[stop nominating at any time](./learn-guides-nominator.md#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 @@ -479,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](./learn-guides-staking.md#nominate-using-polkadot-js) guide to configure it first. Your +[this](./learn-guides-nominator.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 }} @@ -516,7 +516,7 @@ higher, which can be viewed on ## Guides -- [Be a Nominator (Polkadot)](./learn-guides-staking.md#nominate-a-validator) - Guide on nominating - on the Kusama canary network. -- [Stop Being a Nominator (all networks)](./learn-guides-staking#stop-nominating) - Guide on +- [Be a Nominator (Polkadot)](./learn-guides-nominator.md#nominate-a-validator) - Guide on + nominating on the Kusama canary network. +- [Stop Being a Nominator (all networks)](./learn-guides-nominator.md#stop-nominating) - Guide on stopping nominations and withdrawing tokens. diff --git a/docs/learn/learn-staking-advanced.md b/docs/learn/learn-staking-advanced.md index dea8224d2d87..05859ab5c35a 100644 --- a/docs/learn/learn-staking-advanced.md +++ b/docs/learn/learn-staking-advanced.md @@ -443,8 +443,8 @@ reward would no longer be claimable. In order to be absolutely sure that staking rewards can be claimed, users should trigger a payout before 28 eras have passed. See -[this page](./learn-guides-staking.md#claiming-rewards-with-the-polkadot-js-ui) for more information -about how to claim rewards using the Polkadot-JS UI. +[this page](./learn-guides-nominator.md#claiming-rewards-with-the-polkadot-js-ui) for more +information about how to claim rewards using the Polkadot-JS UI. ::: diff --git a/docs/learn/learn-staking.md b/docs/learn/learn-staking.md index 35e2ce6a2364..99da5133e73d 100644 --- a/docs/learn/learn-staking.md +++ b/docs/learn/learn-staking.md @@ -665,7 +665,6 @@ for the FAQs about staking. :::info Polkadot-JS Guides -If you are an advanced user, see the -[Polkadot-JS guides about staking](./learn-guides-staking-index). +If you are an advanced user, see the [Polkadot-JS guides about staking](./learn-guides-staking). ::: diff --git a/docs/maintain/archive/maintain-guides-democracy.md b/docs/maintain/archive/maintain-guides-democracy.md index 2f9fd1fdb0eb..228d2d3ed799 100644 --- a/docs/maintain/archive/maintain-guides-democracy.md +++ b/docs/maintain/archive/maintain-guides-democracy.md @@ -7,7 +7,7 @@ keywords: [democracy, council, action, proposal] slug: ../maintain-guides-democracy --- -
+

The content on this page is archived. For up-to-date information about governance, see the diff --git a/docs/maintain/archive/maintain-guides-how-to-join-council.md b/docs/maintain/archive/maintain-guides-how-to-join-council.md index a5f8a873d6dd..2f26755dad3c 100644 --- a/docs/maintain/archive/maintain-guides-how-to-join-council.md +++ b/docs/maintain/archive/maintain-guides-how-to-join-council.md @@ -7,7 +7,7 @@ keywords: [council, how to join council, governance, candidate] slug: ../maintain-guides-how-to-join-council --- -
+

The content on this page is archived. For up-to-date information about governance, see the diff --git a/docs/maintain/archive/maintain-guides-how-to-vote-councillor.md b/docs/maintain/archive/maintain-guides-how-to-vote-councillor.md index 8f948230ff00..1d0698296d81 100644 --- a/docs/maintain/archive/maintain-guides-how-to-vote-councillor.md +++ b/docs/maintain/archive/maintain-guides-how-to-vote-councillor.md @@ -7,7 +7,7 @@ keywords: [council, vote, councillors] slug: ../maintain-guides-how-to-vote-councillor --- -
+

The content on this page is archived. For up-to-date information about governance, see the diff --git a/docs/maintain/maintain-archive.md b/docs/maintain/maintain-archive.md index 18fed1fc6f2f..0997ecf0a7cc 100644 --- a/docs/maintain/maintain-archive.md +++ b/docs/maintain/maintain-archive.md @@ -9,7 +9,7 @@ slug: ../maintain-archive import DocCardList from '@theme/DocCardList'; -
+

This section contains archived pages. The content in them no longer applies to Polkadot but can diff --git a/docs/maintain/maintain-guides-how-to-stop-validating.md b/docs/maintain/maintain-guides-how-to-stop-validating.md index 07e3280cffb5..e6a4cd864ce6 100644 --- a/docs/maintain/maintain-guides-how-to-stop-validating.md +++ b/docs/maintain/maintain-guides-how-to-stop-validating.md @@ -48,7 +48,7 @@ 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](../learn/learn-guides-staking.md#bond-your-tokens) for more details. +See [Unbonding and Rebonding](../learn/learn-guides-nominator.md#bond-your-tokens) for more details. ::: diff --git a/kusama-guide/docusaurus.config.js b/kusama-guide/docusaurus.config.js index 17d99cc11f8f..63138abb1899 100644 --- a/kusama-guide/docusaurus.config.js +++ b/kusama-guide/docusaurus.config.js @@ -84,7 +84,7 @@ module.exports = { from: ['/docs/maintain-bug-bounty'] }, { - to: '/docs/learn-guides-assets-create', + to: '/docs/learn-guides-assets', from: ['/docs/kusama-statemine'] }, { diff --git a/kusama-guide/sidebars.js b/kusama-guide/sidebars.js index 46b6ba3a0b93..6b3e3e07f8d1 100644 --- a/kusama-guide/sidebars.js +++ b/kusama-guide/sidebars.js @@ -334,13 +334,11 @@ module.exports = { label: "Staking Guides", description: 'Polkadot-JS Guides about Staking.', link: { - type: 'generated-index', - title: 'Polkadot-JS Guides about Staking', - description: 'Polkadot-JS Guides about Staking.', - slug: '/learn-guides-staking-index', + type: 'doc', + id: 'learn/learn-guides-staking', }, items: [ - "learn/learn-guides-staking", + "learn/learn-guides-nominator", "learn/learn-guides-staking-pools", ], }, @@ -353,12 +351,10 @@ module.exports = { { type: "category", label: "Asset Hub Guides", - description: 'Polkadot-JS Guides about the Asset Hub.', + description: 'Polkadot-JS Guides about Asset Hub.', link: { - type: 'generated-index', - title: 'Advanced Guides for Asset Hub', - description: 'Polkadot-JS guides about the Asset Hub.', - slug: '/learn-guides-assets-index', + type: 'doc', + id: 'learn/learn-guides-assets', }, items: [ "learn/learn-guides-assets-create", diff --git a/kusama-guide/static/css/custom.css b/kusama-guide/static/css/custom.css index a7f7076c099b..2484e1d1b093 100755 --- a/kusama-guide/static/css/custom.css +++ b/kusama-guide/static/css/custom.css @@ -734,7 +734,7 @@ div.sticky { position: -webkit-sticky; position: sticky; top: 0; - background-color: yellow; + background-color: #f5cbc4; padding: 30px; font-size: 20px; font-family: 'Unbounded'; diff --git a/polkadot-wiki/docusaurus.config.js b/polkadot-wiki/docusaurus.config.js index 661670bbbdd8..6bdbbf13d6e5 100644 --- a/polkadot-wiki/docusaurus.config.js +++ b/polkadot-wiki/docusaurus.config.js @@ -126,7 +126,7 @@ module.exports = { from: ['/docs/learn-staking-faq'] }, { - to: '/docs/learn-guides-assets-create', + to: '/docs/learn-guides-assets', from: ['/docs/learn-statemint', '/docs/learn-assets-guides'] }, { diff --git a/polkadot-wiki/sidebars.js b/polkadot-wiki/sidebars.js index 5da95169adab..84f2058089d3 100644 --- a/polkadot-wiki/sidebars.js +++ b/polkadot-wiki/sidebars.js @@ -333,13 +333,11 @@ module.exports = { label: "Staking Guides", description: 'Polkadot-JS Guides about Staking.', link: { - type: 'generated-index', - title: 'Polkadot-JS Guides about Staking', - description: 'Polkadot-JS Guides about Staking.', - slug: '/learn-guides-staking-index', + type: 'doc', + id: 'learn/learn-guides-staking', }, items: [ - "learn/learn-guides-staking", + "learn/learn-guides-nominator", "learn/learn-guides-staking-pools", ], }, @@ -352,12 +350,10 @@ module.exports = { { type: "category", label: "Asset Hub Guides", - description: 'Polkadot-JS Guides about the Asset Hub.', + description: 'Polkadot-JS Guides about Asset Hub.', link: { - type: 'generated-index', - title: 'Advanced Guides for Asset Hub', - description: 'Polkadot-JS guides about the Asset Hub.', - slug: '/learn-guides-assets-index', + type: 'doc', + id: 'learn/learn-guides-assets', }, items: [ "learn/learn-guides-assets-create", diff --git a/polkadot-wiki/static/css/custom.css b/polkadot-wiki/static/css/custom.css index 8b674ed36e9d..d89053352cf9 100755 --- a/polkadot-wiki/static/css/custom.css +++ b/polkadot-wiki/static/css/custom.css @@ -317,7 +317,7 @@ div.sticky { position: -webkit-sticky; position: sticky; top: 0; - background-color: yellow; + background-color: #f5cbc4; padding: 30px; font-size: 20px; font-family: 'Unbounded';