diff --git a/website/docs/tools/simpleStaking.md b/website/docs/tools/simpleStaking.md index 9ece494f7f22551a1ac61f0514d3102f1a42218d..73b1447a9a50b3fd6f38aede8115cb8034cc8a8e 100644 --- a/website/docs/tools/simpleStaking.md +++ b/website/docs/tools/simpleStaking.md @@ -2,4 +2,190 @@ sidebar_position: 4 --- # Simple Staking -https://staking.xx.network \ No newline at end of file + +## Overview +[xx network's Simple Staking](https://staking.xx.network) simplifies staking for nominators. Nominators can manually [nominate validators](webWallet/staking/nominate) via the [Web Wallet - Targets Tab](https://wallet.xx.network/#/staking/targets) but since not everyone wants to invest that much time and effort, we created Simple Staking. With Simple Staking, a few minutes, and only a handful of clicks, nominators can bond and unbond coins, select and change validators, and redeem rewards, while ensuring control and custody of your coins at all times. + +:::danger Simple Staking is not 100% set and forget! +The participants of the xx network are ever changing. Validators come and go over time. We strongly suggest nominators invest the few minutes it takes to [Change Validators](#change-validators) at least once a month but weekly may also be justified. +::: +*** +## Connect Wallet + +To use Simple Staking, you must add an account. + + + +There are three ways to add accounts: + * [Generate a new account](#generate-wallet) + * [Add an account with a recovery phrase](#recovery-phrase) + * [Add an account with a .json file](#import-keyfile-json) + +:::info Accounts and browser sessions +When you add accounts, the account data is stored encrypted in the browser session data. Accounts are available across visits as long as you do not clear the session data. If you use multiple computers or browsers, accounts must be added to each. +::: +*** +### Generate Wallet + +If you do not have a native xxChain account, click the `GENERATE WALLET` button and follow the prompts. If you need help, see the documentation for the [Sleeve Wallet Generation Tool](sleeve), the process is similar. +:::info Fund the account +Once the newly generated account is added you will need to fund it. +::: +*** +### Recovery Phrase + +You can add an existing account by clicking the `RECOVERY PHRASE` button. You will be presented with a form in which you must enter a standard mnemonic phrase, set a password, and click `DONE` + + +*** +### Import KeyFile (json) + +If you have exported an account from another wallet, such as the [Web Wallet](https://wallet.xx.network/#/accounts), you can import the account via a `.json` file by clicking the `IMPORT KEYFILE (JSON)` button. + +First click the `UPLOAD FILE` button. + +*** +Next, you will be presented with a file selection window of your OS. Browse to the directory the `.json` file is located and select it. + +*** +You will see a notification it has found an account. Enter the password that was set when the account was exported and click `IMPORT`. + +*** +## Add More Wallets + +You can manage the staking preferences of multiple accounts, just click the `ADD MORE WALLETS` link and select how to add additional accounts. + +*** + +## Wallet Connected + +Once your wallet or wallets are found, click the `NEXT` button. + +*** + +## Select Wallet + +Select the wallet you want to manage. + +*** + +## Staking Options + + * [Stake](#stake) - Bond coins, select validators and stake. + * [Change Validators](#change-validators) - Quickly select new validators. + * [Unstake](#unstake) - Unbond and stop staking some or all of your coins. + * [Redeem](#redeem) - 28 days after unstaking, unbonded coins can be unlocked and made transferable. +*** +### Stake + +Select the `STAKE` radio button and click the `NEXT` button. + +*** +Input the amount of xx coins you wish to bond and stake and click the `NEXT` button. + +*** +Wait a few seconds while the app selects validators for you. + +*** +Once validators are selected, you can review the list by clicking the `SHOW VALIDATORS` button. + +*** +Enter the password of the account and click the `CONFIRM PASSWORD` button. + +*** +Click the `SUBMIT` button. + +*** +Wait while the transaction is signed and submitted to the blockchain. + + +*** +Once successfully completed you will see a summary of your staking preferences. + + +:::warning come back regularly +We strongly suggest nominators [Change Validators](#change-validators) at least once a month but weekly may also be justified. +::: + +### Change Validators + +Select the `CHANGE VALIDATORS` radio button and click the `NEXT` button. + +*** +Click the `NEXT` button. + +*** +Wait a few seconds while the app selects validators for you. + +*** +Once validators are selected, you can review the list by clicking the `SHOW VALIDATORS` button. + +*** +Enter the password of the account and click the `CONFIRM PASSWORD` button. + +*** +Click the `SUBMIT` button. + +*** +Wait while the transaction is signed and submitted to the blockchain. + + +*** +Once successfully completed you will see a summary of your staking preferences. + + +:::warning come back regularly +We strongly suggest nominators [Change Validators](#change-validators) at least once a month but weekly may also be justified. +::: + +### Unstake + +Select the `UNSTAKE` radio button and click the `NEXT` button. + +*** +Input the amount of xx coins you wish to unstake and begin unbonding, and then click the `NEXT` button. + +*** +Enter the password of the account and click the `CONFIRM PASSWORD` button. + +*** +Click the `SUBMIT` button. + +*** +Wait while the transaction is signed and submitted to the blockchain. + + +*** +Once successfully completed you will see a summary of your staking preferences. + + +### Redeem + +:::info About redeeming +Every 24 hours an era ends. At which time the earned rewards are paid out and begin to unbond. Unbonding takes 28 days. If rewards were paid out on Jan. 01, one would be able to redeem them on Jan. 29. +::: + +To check on the status of coins available to be redeemed one must [connect an account](#connect-wallet). +Once your wallet or wallets are found, click the `NEXT` button. + +*** +Select the wallet you want to manage and click the `NEXT` button. + +*** + +If funds are available to be redeemed the `REDEEM` radio button will be enabled to select and the amount of coins available to be redeemed will be stated. + +If funds are not available to be redeemed view the `UNSTAKED FUNDS` section. You will see the `AMOUNT` currently unstaked and the number of days the funds will be `AVAILABLE TO REDEEM IN`. + + +## Forget Wallet + +If you would like to remove an account from the app, click the `Forget?` link. + +*** +You will be asked to confirm you wish to delete the account. + + +:::info +You can [connect the account](#connect-wallet) again at any time. +::: \ No newline at end of file diff --git a/website/static/img/simple-staking/connect-add-more-wallets.png b/website/static/img/simple-staking/connect-add-more-wallets.png new file mode 100644 index 0000000000000000000000000000000000000000..60d9c4d1c8c0b0641f5dfab56014e074e570ba63 Binary files /dev/null and b/website/static/img/simple-staking/connect-add-more-wallets.png differ diff --git a/website/static/img/simple-staking/connect-forget-confirm.png b/website/static/img/simple-staking/connect-forget-confirm.png new file mode 100644 index 0000000000000000000000000000000000000000..4f6339710c628d8ea0d7c5ef373a5cff1c8d33cd Binary files /dev/null and b/website/static/img/simple-staking/connect-forget-confirm.png differ diff --git a/website/static/img/simple-staking/connect-forget.png b/website/static/img/simple-staking/connect-forget.png new file mode 100644 index 0000000000000000000000000000000000000000..59cf047a9f04ef4b48b53dabef4b359ffdf2892f Binary files /dev/null and b/website/static/img/simple-staking/connect-forget.png differ diff --git a/website/static/img/simple-staking/connect-generate-wallet.png b/website/static/img/simple-staking/connect-generate-wallet.png new file mode 100644 index 0000000000000000000000000000000000000000..42b35e378459f42019f90f68630446a44d2b1a54 Binary files /dev/null and b/website/static/img/simple-staking/connect-generate-wallet.png differ diff --git a/website/static/img/simple-staking/connect-import-found.png b/website/static/img/simple-staking/connect-import-found.png new file mode 100644 index 0000000000000000000000000000000000000000..5e1437b1ef927c5efc711f4e6c624971f4453fa3 Binary files /dev/null and b/website/static/img/simple-staking/connect-import-found.png differ diff --git a/website/static/img/simple-staking/connect-import-select-json.png b/website/static/img/simple-staking/connect-import-select-json.png new file mode 100644 index 0000000000000000000000000000000000000000..11038f17c5f222c2eb528badac860c481630eb8a Binary files /dev/null and b/website/static/img/simple-staking/connect-import-select-json.png differ diff --git a/website/static/img/simple-staking/connect-import.png b/website/static/img/simple-staking/connect-import.png new file mode 100644 index 0000000000000000000000000000000000000000..ae1c22182b0265366b5bd4634b1c84c99a04f04a Binary files /dev/null and b/website/static/img/simple-staking/connect-import.png differ diff --git a/website/static/img/simple-staking/connect-recovery-phrase.png b/website/static/img/simple-staking/connect-recovery-phrase.png new file mode 100644 index 0000000000000000000000000000000000000000..efcd09a4ffe54aee0ace9632a9379b49866309da Binary files /dev/null and b/website/static/img/simple-staking/connect-recovery-phrase.png differ diff --git a/website/static/img/simple-staking/connect-wallet-found.png b/website/static/img/simple-staking/connect-wallet-found.png new file mode 100644 index 0000000000000000000000000000000000000000..fb462ba143b90be6c8cdbd4eadbf4367d645c9d2 Binary files /dev/null and b/website/static/img/simple-staking/connect-wallet-found.png differ diff --git a/website/static/img/simple-staking/finish.png b/website/static/img/simple-staking/finish.png new file mode 100644 index 0000000000000000000000000000000000000000..36ef2e99a8d591fa1ce31eed7fea7e0241667ef5 Binary files /dev/null and b/website/static/img/simple-staking/finish.png differ diff --git a/website/static/img/simple-staking/input-amount-unstake.png b/website/static/img/simple-staking/input-amount-unstake.png new file mode 100644 index 0000000000000000000000000000000000000000..c37e0cb50c506d83bbc86430273eea87b6e33cb9 Binary files /dev/null and b/website/static/img/simple-staking/input-amount-unstake.png differ diff --git a/website/static/img/simple-staking/input-amount.png b/website/static/img/simple-staking/input-amount.png new file mode 100644 index 0000000000000000000000000000000000000000..9b5969c8c6713737314155296fb56abe9c052a02 Binary files /dev/null and b/website/static/img/simple-staking/input-amount.png differ diff --git a/website/static/img/simple-staking/landing-no-wallet.png b/website/static/img/simple-staking/landing-no-wallet.png new file mode 100644 index 0000000000000000000000000000000000000000..59e014ece4f9e02c439bf4e9ebc6cec2f9957eaa Binary files /dev/null and b/website/static/img/simple-staking/landing-no-wallet.png differ diff --git a/website/static/img/simple-staking/nominate-confirm-password.png b/website/static/img/simple-staking/nominate-confirm-password.png new file mode 100644 index 0000000000000000000000000000000000000000..325efe25da62f4e0a05449d654e7209a6cde4905 Binary files /dev/null and b/website/static/img/simple-staking/nominate-confirm-password.png differ diff --git a/website/static/img/simple-staking/nominate-selecting.png b/website/static/img/simple-staking/nominate-selecting.png new file mode 100644 index 0000000000000000000000000000000000000000..ff43eeb9de33b744d84988ede89678aae00dd1b6 Binary files /dev/null and b/website/static/img/simple-staking/nominate-selecting.png differ diff --git a/website/static/img/simple-staking/nominate-show.png b/website/static/img/simple-staking/nominate-show.png new file mode 100644 index 0000000000000000000000000000000000000000..c39d70dfaa66f0535e145776b6383330d3cb8369 Binary files /dev/null and b/website/static/img/simple-staking/nominate-show.png differ diff --git a/website/static/img/simple-staking/nominate-submit.png b/website/static/img/simple-staking/nominate-submit.png new file mode 100644 index 0000000000000000000000000000000000000000..9f4ed565b0129cc8e05d23b8ab1dfc04b62f2b48 Binary files /dev/null and b/website/static/img/simple-staking/nominate-submit.png differ diff --git a/website/static/img/simple-staking/select.png b/website/static/img/simple-staking/select.png new file mode 100644 index 0000000000000000000000000000000000000000..6947329c24819298bc8e190e045f5a1d8c0a7e28 Binary files /dev/null and b/website/static/img/simple-staking/select.png differ diff --git a/website/static/img/simple-staking/sign.png b/website/static/img/simple-staking/sign.png new file mode 100644 index 0000000000000000000000000000000000000000..4e107826833701b0aedc92395a12319d3a546fcf Binary files /dev/null and b/website/static/img/simple-staking/sign.png differ diff --git a/website/static/img/simple-staking/staking-options-change-01.png b/website/static/img/simple-staking/staking-options-change-01.png new file mode 100644 index 0000000000000000000000000000000000000000..fe3e70bf926b1bf7b05b30c5f120d908ee151651 Binary files /dev/null and b/website/static/img/simple-staking/staking-options-change-01.png differ diff --git a/website/static/img/simple-staking/staking-options-change-02.png b/website/static/img/simple-staking/staking-options-change-02.png new file mode 100644 index 0000000000000000000000000000000000000000..3b7006ae5022f0ba8c558a322135cf3db6c6e69b Binary files /dev/null and b/website/static/img/simple-staking/staking-options-change-02.png differ diff --git a/website/static/img/simple-staking/staking-options-stake.png b/website/static/img/simple-staking/staking-options-stake.png new file mode 100644 index 0000000000000000000000000000000000000000..9f47794ef35bf9d8eacc52c62b5403176fdf7458 Binary files /dev/null and b/website/static/img/simple-staking/staking-options-stake.png differ diff --git a/website/static/img/simple-staking/staking-options-unstake.png b/website/static/img/simple-staking/staking-options-unstake.png new file mode 100644 index 0000000000000000000000000000000000000000..ab39439edfd926ee08a4a0024b008a16d62d5e03 Binary files /dev/null and b/website/static/img/simple-staking/staking-options-unstake.png differ diff --git a/website/static/img/simple-staking/unstake-amount-confirm.png b/website/static/img/simple-staking/unstake-amount-confirm.png new file mode 100644 index 0000000000000000000000000000000000000000..aca65420b1e1b13d19cb7c2aab7bc7141975b1e9 Binary files /dev/null and b/website/static/img/simple-staking/unstake-amount-confirm.png differ diff --git a/website/static/img/simple-staking/unstake-finish.png b/website/static/img/simple-staking/unstake-finish.png new file mode 100644 index 0000000000000000000000000000000000000000..ed33a9351638859c3839ff181416c812fa50a117 Binary files /dev/null and b/website/static/img/simple-staking/unstake-finish.png differ diff --git a/website/static/img/simple-staking/unstake-submit.png b/website/static/img/simple-staking/unstake-submit.png new file mode 100644 index 0000000000000000000000000000000000000000..e3aa7d10bef3930294fae4e406af4b98c759a1ea Binary files /dev/null and b/website/static/img/simple-staking/unstake-submit.png differ diff --git a/website/static/img/simple-staking/waiting.png b/website/static/img/simple-staking/waiting.png new file mode 100644 index 0000000000000000000000000000000000000000..e55b9b56aaf6a16e1a72be15e570544b2bd3520c Binary files /dev/null and b/website/static/img/simple-staking/waiting.png differ