diff --git a/source/mainnet/docs/guides/add-delegation.rst b/source/mainnet/docs/guides/add-delegation.rst index 87d7a235c4..2a8b582440 100644 --- a/source/mainnet/docs/guides/add-delegation.rst +++ b/source/mainnet/docs/guides/add-delegation.rst @@ -20,47 +20,35 @@ When you delegate some stake to a staking pool, it can influence the chances of .. dropdown:: |cryptox| - #. Tap the account you want to delegate from on the accounts screen. - #. Tap |cryptoX-earn| on the account balance screen. + #. In the dropdown list, select the account that you want to delegate from and tap **Earn**. + #. Tap **Continue to delegation setup** - .. image:: ../images/cryptoX/cryptoX-earning-rewards.png + .. image:: ../images/cryptoX/cryptoX-earning-rewards.png :width: 50% :alt: screen with earning options - #. You can now go through informational screens explaining the key concepts of delegation on the Concordium blockchain. Tap **Next** to navigate through the screens. Tap **Skip** to proceed directly to registering your delegation. + #. You can now go through informational screens explaining the key concepts of delegation on the Concordium blockchain, including the delegator role, delegation models, pay days, lock-in and cooldowns, and delegation updates. Tap **Next** to navigate through the screens. Tap **Skip** to proceed directly to registering your delegation. #. On the **Register delegation** screen, you have two options: If you want to delegate to a specific pool, tap **Validator** and enter the Validator ID of the pool owner. If you want to register a passive delegation, tap **Passive**. Tap **Continue**. - .. image:: ../images/cryptoX/cryptoX-register-delegation.png + .. image:: ../images/cryptoX/cryptoX-register-delegation.png :width: 50% :alt: screen with earning options - #. You can see your balance available to delegate. Enter the Amount you want to delegate in the field. Tap **Yes, add** to restake any rewards, or tap **No, don't add** if you don’t want to restake rewards. In this case, rewards are deposited to your disposable balance at each pay day. Tap **Continue**. + #. You can see your balance available to delegate. Enter the amount you want to delegate in the field. Tap **Yes, add** to restake any rewards, or tap **No, don't add** if you don’t want to restake rewards. In this case, rewards are deposited to your disposable balance at each pay day. Then, tap **Continue**. - .. image:: ../images/cryptoX/cryptoX-register-delegation-add-rewards.png + .. image:: ../images/cryptoX/cryptox-register-delegation-add-rewards-new.png :width: 50% :alt: screen to register delegation amount and restake preference #. Review the information in the transaction overview. When you are satisfied, tap **Submit delegation transaction**. - #. Once the transaction is submitted you see a confirmation screen. Tap **Finish** to complete the action. + #. Once the transaction is submitted, you see a confirmation screen. Tap **Finish**. Once the transaction is finalized, the delegation is effective from the next pay day. - The account will be marked as Delegator in the account list. - - .. image:: ../images/cryptoX/cryptoX-account-delegating.png - :width: 50% - :alt: account in list with delegating text and pie icon - - - You can see information about the delegation on the delegation status screen. Here, you can also make updates to your delegation or stop it. - - .. image:: ../images/cryptoX/cryptoX-account-status-screen.png - :width: 50% - :alt: account details showing delegation details .. dropdown:: Desktop Wallet diff --git a/source/mainnet/docs/guides/remove-delegation.rst b/source/mainnet/docs/guides/remove-delegation.rst index a28f949ba6..6faa1b0613 100644 --- a/source/mainnet/docs/guides/remove-delegation.rst +++ b/source/mainnet/docs/guides/remove-delegation.rst @@ -20,25 +20,20 @@ If you remove the delegation, there is a :term:`cool-down period` before the amo .. dropdown:: |cryptox| - #. Tap the account on the accounts screen. + #. In the dropdown list, select the account from which you want to remove delegation and tap **Earn**. - #. Tap |cryptoX-earn| on the account balance screen. + #. On the delegation status screen, tap **Stop delegation**. - #. Now you see your current delegation. Tap **Stop delegation**. + .. image:: ../images/cryptoX/cryptoX-delegation-status.png + :width: 50% + :alt: screen showing current delegation status with options to update or stop - .. image:: ../images/cryptoX/cryptoX-delegation-status.png - :width: 50% - :alt: screen showing current delegation status with options to update or stop - #. You can now go through informational screens explaining the implications of stopping your delegation. Tap **Next** to navigate through the screens. Tap **Skip** to proceed directly to stopping the delegation. + #. After the screen explaining the implications of stopping your delegation, tap **Continue** to proceed. - #. Review the information in the transaction overview. When you are satisfied, tap **Submit delegation transaction**. + #. Review the information in the transaction overview. When you are satisfied, tap **Submit delegation transaction**. - .. image:: ../images/cryptoX/cryptoX-stop-delegation.png - :width: 50% - :alt: screen shown to review delegation stop details - - #. Once the transaction is submitted, you see a confirmation screen. Tap **Finish** to complete the action. + #. Once the transaction is submitted, you see a confirmation screen. Tap **Finish**. .. dropdown:: Desktop Wallet diff --git a/source/mainnet/docs/guides/update-delegation.rst b/source/mainnet/docs/guides/update-delegation.rst index e34f030336..efa6b78ff2 100644 --- a/source/mainnet/docs/guides/update-delegation.rst +++ b/source/mainnet/docs/guides/update-delegation.rst @@ -26,12 +26,12 @@ Before delegating stake to a staking pool, it is important to research the pool .. Warning:: Make sure you have enough funds in your disposable balance to cover transaction fees. -Updating delegation from a suspendet validator +Updating delegation from a suspended validator ---------------------------------------------- If a validator you've delegated to becomes suspended, you'll see a warning banner in your wallet interface indicating *Your validator has been suspended*. When a validator is suspended, both the validator and its delegators stop earning rewards. To maintain your earning potential, you may consider moving your delegation to another active validator or to passive delegation. -.. image:: ../images/browser-wallet/new/your_validator_suspended_banner.png +.. image:: ../images/browser-wallet/new/validator_suspended_banner.png :width: 50% @@ -42,27 +42,25 @@ Update delegation .. dropdown:: |cryptox| - #. Tap the account on the accounts screen. + #. In the dropdown list, select the account from which you want to change your delegation preferences and tap **Earn**. - #. Tap |cryptoX-earn| on the account balance screen. + #. On the delegation status screen, tap **Update current delegation**. - #. Now you see your current delegation. Tap **Update current delegation**. - - .. image:: ../images/cryptoX/cryptoX-delegation-status.png + .. image:: ../images/cryptoX/cryptoX-delegation-status.png :width: 50% :alt: screen showing current delegation with options to stop or update - #. You can now go through informational screens explaining the update options releated to delegation. Tap **Next** to navigate through the screens. Tap **Skip** to proceed directly to updating. + #. You can now go through informational screens explaining the update options for delegation. Tap **Next** to navigate through the screens. Tap **Skip** to proceed directly to updating. - #. If you want to delegate to a specific pool, tap **Validator** and enter the validator ID of the desired pool owner. If you want to delegate to passive delegation, tap **Passive**. Tap **Continue**. + #. If you want to delegate to a specific pool, select **Validator** and enter the validator ID of the desired pool owner. If you want to delegate to passive delegation, select **Passive**. Tap **Continue**. - .. image:: ../images/cryptoX/cryptoX-update-delegation.png + .. image:: ../images/cryptoX/cryptoX-update-delegation.png :width: 50% :alt: screen with options to choose delegation type - #. On the next screen you can see your balance available for delegation and the amount of your current delegation. If you want to change the amount, tap on the field **Optional: Type the new amount** and enter the amount. Tap **Yes, add** to restake any rewards or tap **No, don't add** if you don’t want to restake rewards. If you do not restake, rewards are deposited to your disposable balance. Tap **Continue**. + #. On the next screen you can see your balance available for delegation and the amount of your current delegation. If you want to change the amount, tap on the field **Optional: Type the new amount** and enter the amount. Tap **Yes, add** to restake any rewards or tap **No, don't add** if you don’t want to restake rewards. If you do not restake, rewards are deposited to your disposable balance at each payday. When satisfied with your settings, tap **Continue**. - .. image:: ../images/cryptoX/cryptoX-update-delegation-2.png + .. image:: ../images/cryptoX/cryptox-update-delegation2-new.png :width: 50% :alt: screen with options to choose delegation type diff --git a/source/mainnet/docs/images/browser-wallet/new/validator_suspended_banner.png b/source/mainnet/docs/images/browser-wallet/new/validator_suspended_banner.png new file mode 100644 index 0000000000..3cf34f2ea0 Binary files /dev/null and b/source/mainnet/docs/images/browser-wallet/new/validator_suspended_banner.png differ diff --git a/source/mainnet/docs/images/cryptoX/cryptoX-register-delegation-add-rewards.png b/source/mainnet/docs/images/cryptoX/cryptoX-register-delegation-add-rewards.png deleted file mode 100644 index 600cc11966..0000000000 Binary files a/source/mainnet/docs/images/cryptoX/cryptoX-register-delegation-add-rewards.png and /dev/null differ diff --git a/source/mainnet/docs/images/cryptoX/cryptoX-update-delegation-2.png b/source/mainnet/docs/images/cryptoX/cryptoX-update-delegation-2.png deleted file mode 100644 index d223ac4b5f..0000000000 Binary files a/source/mainnet/docs/images/cryptoX/cryptoX-update-delegation-2.png and /dev/null differ diff --git a/source/mainnet/docs/images/cryptoX/cryptox-change-validating-status-options.png b/source/mainnet/docs/images/cryptoX/cryptox-change-validating-status-options.png new file mode 100644 index 0000000000..31da782236 Binary files /dev/null and b/source/mainnet/docs/images/cryptoX/cryptox-change-validating-status-options.png differ diff --git a/source/mainnet/docs/images/cryptoX/cryptox-change-validating-status.png b/source/mainnet/docs/images/cryptoX/cryptox-change-validating-status.png new file mode 100644 index 0000000000..7ace5559cd Binary files /dev/null and b/source/mainnet/docs/images/cryptoX/cryptox-change-validating-status.png differ diff --git a/source/mainnet/docs/images/cryptoX/cryptox-register-delegation-add-rewards-new.png b/source/mainnet/docs/images/cryptoX/cryptox-register-delegation-add-rewards-new.png new file mode 100644 index 0000000000..ab2f51c78f Binary files /dev/null and b/source/mainnet/docs/images/cryptoX/cryptox-register-delegation-add-rewards-new.png differ diff --git a/source/mainnet/docs/images/cryptoX/cryptox-register-delegation-finish.png b/source/mainnet/docs/images/cryptoX/cryptox-register-delegation-finish.png new file mode 100644 index 0000000000..5cc75c8167 Binary files /dev/null and b/source/mainnet/docs/images/cryptoX/cryptox-register-delegation-finish.png differ diff --git a/source/mainnet/docs/images/cryptoX/cryptox-register-delegation-submit-transaction.png b/source/mainnet/docs/images/cryptoX/cryptox-register-delegation-submit-transaction.png new file mode 100644 index 0000000000..2af61801c7 Binary files /dev/null and b/source/mainnet/docs/images/cryptoX/cryptox-register-delegation-submit-transaction.png differ diff --git a/source/mainnet/docs/images/cryptoX/cryptox-register-validator_new.png b/source/mainnet/docs/images/cryptoX/cryptox-register-validator_new.png new file mode 100644 index 0000000000..ea898add06 Binary files /dev/null and b/source/mainnet/docs/images/cryptoX/cryptox-register-validator_new.png differ diff --git a/source/mainnet/docs/images/cryptoX/cryptox-register_validator_commissions_new.png b/source/mainnet/docs/images/cryptoX/cryptox-register_validator_commissions_new.png new file mode 100644 index 0000000000..43f6b83e4a Binary files /dev/null and b/source/mainnet/docs/images/cryptoX/cryptox-register_validator_commissions_new.png differ diff --git a/source/mainnet/docs/images/cryptoX/cryptox-resume-validation-finish.png b/source/mainnet/docs/images/cryptoX/cryptox-resume-validation-finish.png new file mode 100644 index 0000000000..98001da862 Binary files /dev/null and b/source/mainnet/docs/images/cryptoX/cryptox-resume-validation-finish.png differ diff --git a/source/mainnet/docs/images/cryptoX/cryptox-resume-validation-submit-transaction.png b/source/mainnet/docs/images/cryptoX/cryptox-resume-validation-submit-transaction.png new file mode 100644 index 0000000000..3e8716a239 Binary files /dev/null and b/source/mainnet/docs/images/cryptoX/cryptox-resume-validation-submit-transaction.png differ diff --git a/source/mainnet/docs/images/cryptoX/cryptox-resume-validation.png b/source/mainnet/docs/images/cryptoX/cryptox-resume-validation.png new file mode 100644 index 0000000000..c7e98b7b52 Binary files /dev/null and b/source/mainnet/docs/images/cryptoX/cryptox-resume-validation.png differ diff --git a/source/mainnet/docs/images/cryptoX/cryptox-update-commissions.png b/source/mainnet/docs/images/cryptoX/cryptox-update-commissions.png new file mode 100644 index 0000000000..43f6b83e4a Binary files /dev/null and b/source/mainnet/docs/images/cryptoX/cryptox-update-commissions.png differ diff --git a/source/mainnet/docs/images/cryptoX/cryptox-update-delegation2-new.png b/source/mainnet/docs/images/cryptoX/cryptox-update-delegation2-new.png new file mode 100644 index 0000000000..ffe02962cd Binary files /dev/null and b/source/mainnet/docs/images/cryptoX/cryptox-update-delegation2-new.png differ diff --git a/source/mainnet/docs/images/cryptoX/cryptox-update-pool-settings-metadata-url.png b/source/mainnet/docs/images/cryptoX/cryptox-update-pool-settings-metadata-url.png new file mode 100644 index 0000000000..0eb6df6872 Binary files /dev/null and b/source/mainnet/docs/images/cryptoX/cryptox-update-pool-settings-metadata-url.png differ diff --git a/source/mainnet/docs/images/cryptoX/cryptox-update-pool-settings_new.png b/source/mainnet/docs/images/cryptoX/cryptox-update-pool-settings_new.png new file mode 100644 index 0000000000..d9ba2b6f8a Binary files /dev/null and b/source/mainnet/docs/images/cryptoX/cryptox-update-pool-settings_new.png differ diff --git a/source/mainnet/docs/images/cryptoX/cryptox-update-validator-stake_new.png b/source/mainnet/docs/images/cryptoX/cryptox-update-validator-stake_new.png new file mode 100644 index 0000000000..22919434c8 Binary files /dev/null and b/source/mainnet/docs/images/cryptoX/cryptox-update-validator-stake_new.png differ diff --git a/source/mainnet/docs/images/cryptoX/cryptox-validator-primed-for-suspension-banner.png b/source/mainnet/docs/images/cryptoX/cryptox-validator-primed-for-suspension-banner.png new file mode 100644 index 0000000000..6505672d4c Binary files /dev/null and b/source/mainnet/docs/images/cryptoX/cryptox-validator-primed-for-suspension-banner.png differ diff --git a/source/mainnet/docs/images/cryptoX/cryptox-validator-suspended-account-list.png b/source/mainnet/docs/images/cryptoX/cryptox-validator-suspended-account-list.png new file mode 100644 index 0000000000..6785187b7d Binary files /dev/null and b/source/mainnet/docs/images/cryptoX/cryptox-validator-suspended-account-list.png differ diff --git a/source/mainnet/docs/images/cryptoX/cryptox-validator-suspended-banner-new.png b/source/mainnet/docs/images/cryptoX/cryptox-validator-suspended-banner-new.png new file mode 100644 index 0000000000..e272410771 Binary files /dev/null and b/source/mainnet/docs/images/cryptoX/cryptox-validator-suspended-banner-new.png differ diff --git a/source/mainnet/docs/images/cryptoX/cryptox-validator-suspended-banner.png b/source/mainnet/docs/images/cryptoX/cryptox-validator-suspended-banner.png new file mode 100644 index 0000000000..db74026ee9 Binary files /dev/null and b/source/mainnet/docs/images/cryptoX/cryptox-validator-suspended-banner.png differ diff --git a/source/mainnet/docs/images/cryptoX/cryptox-validator-suspended-validator-status.png b/source/mainnet/docs/images/cryptoX/cryptox-validator-suspended-validator-status.png new file mode 100644 index 0000000000..d95186c828 Binary files /dev/null and b/source/mainnet/docs/images/cryptoX/cryptox-validator-suspended-validator-status.png differ diff --git a/source/mainnet/docs/mobile-wallet/add-baker-mw.rst b/source/mainnet/docs/mobile-wallet/add-baker-mw.rst index 5830e6e325..2a3f7fcb83 100644 --- a/source/mainnet/docs/mobile-wallet/add-baker-mw.rst +++ b/source/mainnet/docs/mobile-wallet/add-baker-mw.rst @@ -19,43 +19,43 @@ Prior to becoming a validator, read :ref:`Validator management` to l .. dropdown:: |cryptox| - #. Tap the account on the accounts screen and tap |cryptoX-earn| on the account balance screen. + #. In the dropdown list, select the account for which you will set up a validator an tap **Earn**. #. Select **Continue to validator setup**. - .. image:: ../images/cryptoX/cryptoX-earning-rewards.png + .. image:: ../images/cryptoX/cryptoX-earning-rewards.png :width: 50% :alt: screen with earning options - #. You can now go through informational screens explaining the key concepts of validation on the Concordium blockchain. Tap **Next** to navigate through the screens. Tap **Skip** to proceed directly to registering your validation. + #. You can now go through informational screens explaining the key concepts of validation on the Concordium blockchain, including the validator role and key generation, node requirements, staking pool options, and suspension policies. Tap **Next** to navigate through the screens. Tap **Skip** to proceed directly to registering your validation. #. On the register validator screen you can see your available balance. Enter the amount you want to stake in the field. Tap **Yes, add** to restake validator rewards, or tap **No, don't add** if you don’t want to restake rewards. In this case, rewards are deposited to your disposable balance at each pay day. Tap **Continue**. - .. image:: ../images/cryptoX/cryptoX-register-validator.png + .. image:: ../images/cryptoX/cryptox-register-validator_new.png :alt: screen to register validator for first time showing balance, amount to stake, and restake parameters :width: 50% 4. Choose whether you want to open a :term:`staking pool` or keep it closed. By opening a staking pool, others can delegate stake to your validator, thus increasing the chance that you are selected to produce a block and earn rewards. If you have a staking pool with delegators, the delegators also earn rewards when you produce blocks. Validators are also paid a commission by the delegators for producing blocks on their behalf. You can choose **Close for delegation** if you do not wish to run a staking pool. Tap **Continue**. - .. image:: ../images/cryptoX/cryptoX-register-validator-open-del.png + .. image:: ../images/cryptoX/cryptoX-register-validator-open-del.png :alt: screen to register validator for first time showing options to open or close pool for delegation :width: 50% - 5. Set your commissions for your pool. This is the percentage you wish to earn from delegators to your pool when you have produced a block. Delegators can use this information when choosing a pool. Tap **Continue**. + 5. Set commissions for your pool. This is the percentage you wish to earn from delegators to your pool when you have produced a block. Delegators can use this information when choosing a pool. Tap **Continue**. - .. image:: ../images/cryptoX/cryptoX-register-validator-commissions.png + .. image:: ../images/cryptoX/cryptox-register_validator_commissions_new.png :alt: screen to register validator for first time showing commission rates for staking pools :width: 50% 6. If you open a staking pool, you can optionally provide a URL with information about your validator. This allows delegators to learn more about your pool and make informed decisions. This information is not shared for closed pools or validators. Tap **Continue**. - .. image:: ../images/cryptoX/cryptoX-register-validator-metadata.png + .. image:: ../images/cryptoX/cryptoX-register-validator-metadata.png :alt: screen to register validator for first time showing field to paste URL with metadata for staking pools :width: 50% 6. Now, export the validator keys. You need the validator keys to start the node. Tap **Export validator keys** and navigate to the location on your device where you want to save the file. Give the file a name and the extension .json. - .. image:: ../images/cryptoX/cryptoX-register-validator-export-validator-keys.png + .. image:: ../images/cryptoX/cryptoX-register-validator-export-validator-keys.png :alt: screen to register validator for first time showing all of the validator keys with option to export :width: 50% @@ -74,15 +74,6 @@ Prior to becoming a validator, read :ref:`Validator management` to l - :ref:`Docker` - :ref:`Ubuntu` - Once the transaction is finalized after importing your validator keys to the node, you see the status reflected in the account list and on the account balance screen. - - .. image:: ../images/cryptoX/cryptoX-account-list-validator.png - :alt: account information in list showing validator badge - :width: 40% - - .. image:: ../images/cryptoX/cryptoX-account-balance-screen-validator.png - :alt: account card showing staked amount with validator number - :width: 40% .. dropdown:: Desktop wallet diff --git a/source/mainnet/docs/mobile-wallet/stop-validator.rst b/source/mainnet/docs/mobile-wallet/stop-validator.rst index 404ea28ab5..aa85b4072d 100644 --- a/source/mainnet/docs/mobile-wallet/stop-validator.rst +++ b/source/mainnet/docs/mobile-wallet/stop-validator.rst @@ -7,8 +7,13 @@ Stop a validator If you remove a validator, the node that is configured with the :term:`validator keys` will stop producing blocks after the next :term:`pay day`. -After the :term:`cool-down period`, the amount that you previously staked is returned to your disposable balance at the next pay day. When you've removed the validator, -it is recommended that you also remove the keys from the node, but you should only do this after the node has stopped producing blocks, i.e. after the payday. +After the :term:`cool-down period`, the amount that you previously staked is returned to your disposable balance at the next pay day. + +If your pool has any delegators, they will be automatically moved to passive delegation, if they don't decide to do something else. + + + +When you've removed the validator, it is recommended that you also remove the keys from the node, but you should only do this after the node has stopped producing blocks, i.e. after the payday. If you want to use the node for validation at a later point in time, you'll then have to create a new set of validator keys. @@ -16,11 +21,19 @@ If you no longer wish to produce blocks on this account, you can stop validation .. dropdown:: |cryptox| - #. Tap **Stop validation**. + #. In the dropdown list, select the account for which you want to stop validation and tap **Earn**. + + #. On the Validator status screen, tap **Change validating status**. + + .. image:: ../images/cryptoX/cryptox-change-validating-status.png + :width: 50% + :alt: screen showing validator status + + #. You now see the options for changing the validating status. Tap **Stop validating**. - .. image:: ../images/cryptoX/cryptoX-stop-validation.png + .. image:: ../images/cryptoX/cryptox-change-validating-status-options.png :width: 50% - :alt: screen showing all validator options + :alt: screen showing options for changing validating status #. After the screens explaining validator removal, tap **Continue**. diff --git a/source/mainnet/docs/mobile-wallet/suspend-unsuspend-validator.rst b/source/mainnet/docs/mobile-wallet/suspend-unsuspend-validator.rst index bc972bb6d6..1974bfb44f 100644 --- a/source/mainnet/docs/mobile-wallet/suspend-unsuspend-validator.rst +++ b/source/mainnet/docs/mobile-wallet/suspend-unsuspend-validator.rst @@ -50,6 +50,50 @@ Self-suspend a validator .. dropdown:: |cryptox| + #. In the dropdown list, select the account for which you want to suspend validation and tap **Earn**. + + #. On the Validator status screen, tap **Change validating status**. + + .. image:: ../images/cryptoX/cryptox-change-validating-status.png + :width: 50% + :alt: screen showing validator status + + #. You now see the options for changing the validating status. Tap **Suspend valdiation**. + + .. image:: ../images/cryptoX/cryptox-change-validating-status-options.png + :width: 50% + :alt: screen showing options for changing validating status + + #. On the next screen, read the information about the consequences of suspending your validator. Tap **Continue** to proceed with the suspension or go back if you need to reconsider. + + #. Review the transaction details for suspending your validator. Note that the suspension will take effect from the next payday. Tap **Submit validator transaction** to confirm and send your suspension transaction to the blockchain. + + #. The |cryptox| shows that the transaction has been submitted to the chain. Tap **Finish**. + + + After successfully suspending your validator, you'll notice several clear indicators throughout the wallet interface: + + On your account overview screen, a prominent red banner appears at the bottom stating *Your validation has been suspended*. This banner serves as both a notification and a shortcut. Additionally, a red dot appears on the **Earn** button, providing a visual indicator that your validator requires attention. + + .. image:: ../images/cryptoX/cryptox-validator-suspended-banner-new.png + :width: 50% + :alt: screen showing validator suspended banner + + **Note:** If you have both a suspended validator and a suspended delegator, a banner will be shown for each. + + In the account list view, suspended validators are marked with a red indicator dot to the left of the account address. + + .. image:: ../images/cryptoX/cryptox-validator-suspended-account-list.png + :width: 50% + :alt: screen showing suspended alidator in accountlist + + When viewing your validator status information, a warning message clearly states *Your validation has been suspended* along with information that your node is not currently earning rewards. + + .. image:: ../images/cryptoX/cryptox-validator-suspended-validator-status.png + :width: 50% + :alt: screen showing suspended validator in validator status screen + + .. dropdown:: |bw| #. In the dropdown list, select the account for which you want to suspend the validator and click **Earn**. @@ -103,14 +147,34 @@ Self-suspend a validator This persistent notification ensures you're always aware of the suspension status and provides quick access to resume validation when you're ready. -Unsuspend a self-suspendet validator +Unsuspend a self-suspended validator ------------------------------------ .. dropdown:: |cryptox| + #. Navigate to the suspended validator. Tapping the suspension notification banner will immediately take you to the suspended validator's status page. + + #. Tap **Change validating status**. + + .. image:: ../images/cryptoX/cryptox-validator-suspended-validator-status.png + :width: 50% + :alt: screen showing suspended validator in validator status screen + + + #. Then, tap **Resume validation**. + + .. image:: ../images/cryptoX/cryptox-resume-validation.png + :width: 50% + :alt: screen showing resume validation action for suspended validator + + #. Review the resume validation info and tap **Submit validator transaction** to proceed. + + #. The CryptoX Concordium Wallet shows that the transaction has been submitted to the chain. Tap **Finish**. + + .. dropdown:: |bw| - #. Navigate to the unsuspendet validator. Clicking the suspension notification banner will immediately take you to the suspended validator's details page. + #. Navigate to the suspended validator. Clicking the suspension notification banner will immediately take you to the suspended validator's details page. #. Click **Resume**. @@ -129,11 +193,45 @@ Unsuspend a self-suspendet validator :width: 50% -Unsuspend an automatically suspendet validator +Unsuspend an automatically suspended validator ---------------------------------------------- .. dropdown:: |cryptox| + When your validator becomes inactive, it first enters a *primed for suspension* state. During this period, a red warning banner appears at the top of your wallet interface stating "Your validation is primed for suspension". + + Additionally, a red dot appears on the Earn button, providing a visual indicator that your validator requires attention. + + .. image:: ../images/cryptoX/cryptox-validator-primed-for-suspension-banner.png + :width: 50% + :alt: screen showing suspended validator in validator status screen + + Your node has until the next snapshot epoch to show activity. If your node remains inactive, full suspension takes effect at the next payday. + + If your validator has been suspended: + + #. First check your node and resolve the underlying issues: Identify what caused the automatic suspension, fix the identified issues on your node, and restart your node. + + #. Then, navigate to the suspended validator. Tapping the suspension notification banner will immediately take you to the suspended validator's details page. + + #. Tap **Change validating status**. + + .. image:: ../images/cryptoX/cryptox-validator-suspended-validator-status.png + :width: 50% + :alt: screen showing suspended validator in validator status screen + + + #. Then, tap **Resume validation**. + + .. image:: ../images/cryptoX/cryptox-resume-validation.png + :width: 50% + :alt: screen showing resume validation action for suspended validator + + #. Review the resume validation info and tap **Submit validator transaction** to proceed. + + #. The CryptoX Concordium Wallet shows that the transaction has been submitted to the chain. Tap **Finish**. + + .. dropdown:: |bw| When your validator becomes inactive, it first enters a *primed for suspension* state. During this period, a red warning banner appears at the bottom of your wallet interface stating "Your validation is primed for suspension". @@ -149,7 +247,7 @@ Unsuspend an automatically suspendet validator #. First check your node and resolve the underlying issues: Identify what caused the automatic suspension, fix the identified issues on your node, and restart your node. - #. Then, Navigate to the unsuspendet validator. Clicking the suspension notification banner will immediately take you to the suspended validator's details page. + #. Then, navigate to the suspended validator. Clicking the suspension notification banner will immediately take you to the suspended validator's status page. #. Click **Resume**. diff --git a/source/mainnet/docs/mobile-wallet/update-baker-mw.rst b/source/mainnet/docs/mobile-wallet/update-baker-mw.rst index 174f985510..b9e6b12449 100644 --- a/source/mainnet/docs/mobile-wallet/update-baker-mw.rst +++ b/source/mainnet/docs/mobile-wallet/update-baker-mw.rst @@ -16,27 +16,6 @@ Change validator options The following information describes how to access validator settings to update your stake or restaking preference, to open and manage a staking pool, update validator keys, or stop validation for the |cryptox|, |bw|, and Desktop Wallet. -The steps to get to these settings for |cryptox| are described below. - -.. dropdown:: |cryptox| - - #. Tap the account. - - #. Tap |cryptoX-earn| on the account balance screen. - - #. Tap **Change validating status**. - - .. image:: ../images/cryptoX/cryptoX-change-validator-status.png - :width: 50% - :alt: screen showing current validator settings and change button - - -Once you access the validator settings for your wallet, you have four options: - -- Update validator stake -- Update pool settings -- Update validator keys -- Stop validation .. _update-baker-stake-mw: @@ -52,20 +31,34 @@ When you change the stake it can influence your :term:`chance of being selected .. dropdown:: |cryptox| - #. Tap **Update validator stake**. + #. In the dropdown list, select the account for which you want to update the validation options and tap **Earn**. + + #. On the validator status screen, tap **Change validating status**. + + .. image:: ../images/cryptoX/cryptox-change-validating-status.png + :width: 50% + :alt: screen showing validating status - #. You can now go through informational screens explaining the options for changing validator status. Tap Next to navigate through the screens. Tap Skip to proceed directly to updating the validator stake. + #. You now see the options for changing the validating status. Tap **Update validator stake** - .. image:: ../images/cryptoX/cryptoX-update-validator-stake.png + .. image:: ../images/cryptoX/cryptox-change-validating-status-options.png :width: 50% - :alt: screen to update validator stake showing amount and restake preference options + :alt: screen showing options for changing validating status + + #. You can now go through informational screens explaining the options for changing validator status. Tap **Next** to navigate through the screens. Tap **Skip** to proceed directly to updating the validator stake. - #. Now you see your balance and the current Validator stake amount. + #. Now you see your balance and the current validator stake amount. Enter the total amount you want to stake. - You can also choose to adjust your restake setting between **Yes, restake** rewards or **No, don’t restake** rewards. Tap **Continue**. + You can also choose to adjust your restake settings. Select **Yes, add** to automatically add your validation rewards to your validation amount, or **No, don’t add** to have the rewards deposited to your disposable balance at each payday. When you're satisfied with your staking configuration, tap **Continue** to proceed with your updates. + + .. image:: ../images/cryptoX/cryptox-update-validator-stake_new.png + :width: 50% + :alt: screen showing options for changing validating status #. On the overview screen, check the information. Once you are satisfied, tap **Submit validator transaction**. + #. The CryptoX Concordium Wallet shows that the transaction has been submitted to the chain. Tap **Finish**. + .. dropdown:: |bw| @@ -219,52 +212,59 @@ Update pool settings .. dropdown:: |cryptox| - #. Tap **Update pool settings** + #. In the dropdown list, select the account for which you want to update the pool settings and tap **Earn**. - #. You can now go through informational screens explaining the options for changing validator status. - Tap Next to navigate through the screens. Tap Skip to proceed directly to updating the pool settings. + #. On the Validator status screen, tap **Change validating status**. - .. image:: ../images/cryptoX/cryptoX-update-pool-settings1.png + .. image:: ../images/cryptoX/cryptox-change-validating-status.png :width: 50% - :alt: screen showing three staking pool options + :alt: screen showing validator status - - Open pool: open a pool for a previously closed validator - - Closed for new: close the pool to new delegators. Existing delegators are not affected. You might do this when, for example, the pool is close to meeting one or both of the :ref:`bounding caps`. **It is the validator's responsibility to monitor the stake to make pool management decisions.** - - Close pool: close a pool permanently. + #. You now see the options for changing the validating status. Tap **Update pool settings**. - If you choose **Open pool**: + .. image:: ../images/cryptoX/cryptox-change-validating-status-options.png + :width: 50% + :alt: screen showing options for changing validating status - #. Use the sliders to update the validator commission rates or type in the percentage you want for your commission rates, if desired. This is the percentage you wish to earn from delegators to your pool when you have produced a block. Delegators can use this information when choosing a pool. - #. Enter an optional URL with information about your validator to give delegators more information about your staking pool to help them research staking pools. This information is not shared in the case of a closed pool. + #. You can now go through informational screens explaining the options for changing validator status. + Tap **Next** to navigate through the screens. Tap **Skip** to proceed directly to updating the pool settings. - #. In the Update pool settings overview screen review the information then tap **Submit delegation transaction**. + #. You now see the pool setting options and your current status: - #. The |cryptox| shows that the transaction has been submitted to the chain. Tap **Finish**. Once the transaction is approved, the active validator screen appears where you have the possibility to update validator settings. + - **Open for delegation**: Select this option for opening a pool for a previously closed validator + - **Close for new delegators**: Select this option for closing the pool to new delegators. Existing delegators are not affected. You might do this when, for example, the pool is close to meeting one or both of the :ref:`bounding caps`. + - **Close for delegation**: Select this option for closing a pool permanently. - If you choose **Closed for new**: + Select the preferred setting and tap **Continue**. - Existing delegators remain in the pool. You have the option to adjust commission fees and your validator information URL. + .. image:: ../images/cryptoX/cryptox-update-pool-settings_new.png + :width: 50% + :alt: screen showing three staking pool options - #. Use the sliders to update the validator commission rates or type in the percentage you want for your commission rates, if desired. This is the percentage you wish to earn from delegators to your pool when you have produced a block. Delegators can use this information when choosing a pool. + #. If you have an open pool, you can set or update the validator commission rates here. This is the percentage of rewards you keep when others delegate their stake to your validator pool. - #. Enter an optional URL with information about your validator to give delegators more information about your staking pool to help them research staking pools. This information is not shared in the case of a closed pool. + Use the sliders to adjust both the Transaction fee commission and Block reward commission - by default, both are set to 100% (meaning you keep all rewards). After setting your desired commission rates, tap **Continue** to proceed. - #. In the Update pool settings overview screen review the information then tap **Submit delegation transaction**. + .. image:: ../images/cryptoX/cryptox-update-commissions.png + :width: 50% + :alt: screen showing sliders for defining validator commissions - #. The |cryptox| shows that the transaction has been submitted to the chain. Tap **Finish**. Once the transaction is approved, the active validator screen appears where you have the possibility to update validator settings. + #. If you have an open pool, you can, optionally, enter a URL with information about your validator. This will give delegators additional information when researching staking pools. This information is not shared in the case of a closed pool. Tap **Continue** to proceed. + + .. image:: ../images/cryptoX/cryptox-update-pool-settings-metadata-url.png + :width: 50% + :alt: screen showing option for entering metadata url - If you choose **Close pool**: - This closes the pool completely for both existing delegators and new delegators. + #. In the Update pool settings overview screen, review the information then tap **Submit delegation transaction**. - #. In the Update pool settings overview screen review the information then tap **Submit delegation transaction**. - #. The |cryptoX| shows that the transaction has been submitted to the chain. Tap **Finish**. Once the transaction is approved, the active validator screen appears where you have the possibility to update validator settings. + #. The |cryptox| shows that the transaction has been submitted to the chain. Tap **Finish**. .. dropdown:: |bw| - #. In the dropdown list, select the account for which you want to update the validation options and click **Earn**. + #. In the dropdown list, select the account for which you want to update the pool settings and click **Earn**. #. On the next screen, click **Update**. @@ -274,7 +274,7 @@ Update pool settings #. On the next screen, click **Update pool settings**. .. image:: ../images/browser-wallet/new/update_validation2.png - :width: 40% + :width: 50% :alt: screen showing validator update options #. On this screen, you can toggle whether your validator is open for delegation. When enabled, other users can delegate their tokens to your validator, increasing your total stake and improving your chances of producing blocks. Rewards earned will be distributed between you and your delegators at each pay day. If you prefer to validate with only your own stake, you can disable this option. Once you've made your selection, tap **Continue** to proceed. @@ -455,36 +455,50 @@ If you believe your validator keys have been compromised or lost, you can genera .. dropdown:: |cryptox| - #. Tap **Update validator keys** + #. In the dropdown list, select the account for which you want to update the validator keys and tap **Earn**. - #. You can now go through informational screens explaining the options for changing validator status. - Tap Next to navigate through the screens. Tap Skip to proceed directly to updating the validator keys. + #. On the Validator status screen, tap **Change validating status**. - .. image:: ../images/cryptoX/cryptoX-update-validator-keys.png + .. image:: ../images/cryptoX/cryptox-change-validating-status.png :width: 50% - :alt: screen showing new keys with button to export + :alt: screen showing validator status - #. Tap **Export validator keys**. + #. You now see the options for changing the validating status. Tap **Update validator keys**. - .. Warning:: + .. image:: ../images/cryptoX/cryptox-change-validating-status-options.png + :width: 50% + :alt: screen showing options for changing validating status + + + #. You can now go through informational screens explaining the options for changing validator status. + Tap **Next** to navigate through the screens. Tap **Skip** to proceed directly to updating the pool settings. + + #. On the Update validator keys screen, tap **Export validator keys**. + + .. Warning:: If you're going to transfer the validator keys to someone else, make sure to do so through a secure channel. Generate new keys if you believe the keys have been compromised or lost. + + .. image:: ../images/cryptoX/cryptoX-update-validator-keys.png + :width: 50% + :alt: screen showing new keys with button to export + #. Once you have saved the keys, review the information on the overview screen of the add validator transaction then tap **Submit validator transaction**. #. The |cryptox| shows that the transaction has been submitted to the chain. Tap **Finish**. Once the transaction is approved, the active validator screen appears where you have the possibility to update validator settings. #. You need to import your validator keys file to your node in order to start producing blocks with the new keys. It is preferable to update them on the node as close to :term:`pay day` as possible to prevent the node from being down as a validator for a longer time. - - :ref:`Windows` - - :ref:`macOS` - - :ref:`Docker` - - :ref:`Ubuntu` + - :ref:`Windows` + - :ref:`macOS` + - :ref:`Docker` + - :ref:`Ubuntu` .. dropdown:: |bw| - #. In the dropdown list, select the account for which you want to update the validation options and click **Earn**. + #. In the dropdown list, select the account for which you want to update the validator keys and click **Earn**. #. On the next screen, click **Update**.