Skip to content

Commit

Permalink
Merge pull request #930 from Concordium/bw-120
Browse files Browse the repository at this point in the history
BW 1.2.0 release
  • Loading branch information
dg-concordium authored Nov 21, 2023
2 parents 98973d5 + 92e7112 commit 7dc71a1
Show file tree
Hide file tree
Showing 42 changed files with 138 additions and 121 deletions.
30 changes: 15 additions & 15 deletions source/mainnet/net/guides/add-delegation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -225,42 +225,42 @@ When you delegate some stake to a staking pool, it can influence the chances of

#. Click |earn| on the navigation bar. Use the left and right arrow to locate the button if necessary.

.. image:: ../images/browser-wallet/setup-baking-delegation.png
:width: 40%
.. image:: ../images/browser-wallet/setup-baking-delegation.png
:width: 40%

#. Click **Setup delegation**. If you are delegating for the first time on the account, you see some information about delegation.

.. image:: ../images/browser-wallet/add-delegation-baking.png
:width: 40%
.. image:: ../images/browser-wallet/add-delegation-baking.png
:width: 40%

#. On the **Register delegation** screen choose whether to delegate to a specific pool click **Staking pool** and enter the Validator ID of the pool owner. If you are delegating to passive delegation, click **Passive delegation**. Click **Continue**.

.. image:: ../images/browser-wallet/delegation-target.png
:width: 40%
.. image:: ../images/browser-wallet/delegation-target.png
:width: 40%

#. Select your restake preference. Click **Yes, restake** to restake any rewards or click **No, don't restake** if you don’t want to restake rewards. If you do not restake, rewards are deposited to your disposable balance. Click **Continue**.

.. image:: ../images/browser-wallet/delegation-restake-preference.png
:width: 40%
.. image:: ../images/browser-wallet/delegation-restake-preference.png
:width: 40%

#. You can see your available balance to delegate on the account that is in focus. You can change the account from the Accounts drop-down at the top of the screen if you want to set up delegation on a different account than the one in focus. **Enter the Amount you want to delegate** in the field. Click **Continue**.

.. image:: ../images/browser-wallet/create-delegation-amount.png
:width: 40%
.. image:: ../images/browser-wallet/create-delegation-amount.png
:width: 40%

#. Review the information in the transaction overview. When you are satisfied, click **Send**.

#. Once the transaction is submitted you see a confirmation screen. Click **Finish** to complete the action.

Once the transaction is finalized, the delegation is effective from the next pay day. You can see the delegation type and amount on the account card.

.. image:: ../images/browser-wallet/delegated-amount.png
:width: 40%
.. image:: ../images/browser-wallet/delegated-amount.png
:width: 40%

Accounts with delegation also have an icon in the account list.
Accounts with delegation also have a badge in the account list.

.. image:: ../images/browser-wallet/delegation-acct-list.png
:width: 40%
.. image:: ../images/browser-wallet/delegation-acct-list.png
:width: 40%

.. |earn| image:: ../images/earn.png
:alt: Hand receiving money
Expand Down
5 changes: 3 additions & 2 deletions source/mainnet/net/guides/remove-delegation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -189,8 +189,9 @@ If you remove the delegation, there is a :term:`cool-down period` before the del

#. You see your current delegation. Click **Stop**. Review the information about the cool-down period.

.. image:: ../images/browser-wallet/update-stop-delegation-baking.png
:width: 40%
.. image:: ../images/browser-wallet/update-stop-delegation-baking.png
:width: 40%
:alt: screen showing current delegation and buttons to update or stop

#. Review the information in the transaction overview. When you are satisfied, click **Send**.

Expand Down
52 changes: 29 additions & 23 deletions source/mainnet/net/guides/update-delegation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -209,50 +209,56 @@ Before delegating stake to a staking pool, it is important to research the pool

#. Bring the account whose delegation you want to update into focus by clicking the **Accounts** drop-down at the top of the screen and selecting the account.

.. image:: ../images/browser-wallet/select-account.png
:width: 40%
:alt: screen with accounts drop-down activated and account selection shown
.. image:: ../images/browser-wallet/select-account.png
:width: 40%
:alt: screen with accounts drop-down activated and account selection shown

#. Click |earn| on the navigation bar. Use the left and right arrow to locate the button if necessary.

.. image:: ../images/browser-wallet/delegation-update-stop.png
:width: 40%
:alt: screen showing current delegation and buttons to update or stop
.. image:: ../images/browser-wallet/delegation-update-stop.png
:width: 40%
:alt: screen showing current delegation and buttons to update or stop

#. You see your current delegation. Click **Update**. Review the information about updating your delegation.

.. image:: ../images/browser-wallet/update-stop-delegation-baking.png
:width: 40%
.. image:: ../images/browser-wallet/update-stop-delegation-baking.png
:width: 40%
:alt: screen showing current delegation and buttons to update or stop

#. If you want to delegate to a specific pool click **Target** and enter the validator ID of the pool owner you want to switch the delegation to. If you want to delegate to passive delegation, click **Passive**. Click **Continue**.

.. image:: ../images/browser-wallet/delegation-update-target.png
:width: 40%
:alt: screen showing current delegation and buttons to select target
.. image:: ../images/browser-wallet/delegation-update-target.png
:width: 40%
:alt: screen showing current delegation and buttons to select target


.. image:: ../images/browser-wallet/delegation-update-target1.png
:width: 40%
:alt: screen showing current delegation and buttons to select target

#. Select your restake preference. Click **Yes, restake** to restake any rewards or click **No, don't restake** if you don’t want to restake rewards. If you do not restake, rewards are deposited to your disposable balance. Click **Continue**.

.. image:: ../images/browser-wallet/delegation-update-restaking-pref.png
:width: 40%
:alt: screen with buttons to select restaking rewards preference
.. image:: ../images/browser-wallet/delegation-update-restaking-pref.png
:width: 40%
:alt: screen with buttons to select restaking rewards preference

#. You can see your balance available to delegate at the top of screen and the amount of your current delegation. If you want to change the amount enter that in the **Enter the Amount you want to delegate** field. Click **Continue**.

.. image:: ../images/browser-wallet/delegation-update-amount.png
:width: 40%
:alt: screen to enter delegation amount
.. image:: ../images/browser-wallet/delegation-update-amount.png
:width: 40%
:alt: screen to enter delegation amount

#. Review the information in the transaction overview. When you are satisfied, click **Send**.

.. image:: ../images/browser-wallet/delegation-update-xact-confirm.png
:width: 40%
:alt: screen showing delegation transaction details for review
.. image:: ../images/browser-wallet/delegation-update-xact-confirm.png
:width: 40%
:alt: screen showing delegation transaction details for review

#. Once the transaction is submitted you see a confirmation screen. Click **Finish** to complete the action.

.. image:: ../images/browser-wallet/delegation-update-submit.png
:width: 40%
:alt: screen showing transaction details submitted to chain
.. image:: ../images/browser-wallet/delegation-update-submit.png
:width: 40%
:alt: screen showing transaction details submitted to chain

Once the transaction is finalized, the delegation update is effective from the next pay day for most transactions, except reducing your stake.

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified source/mainnet/net/images/browser-wallet/add-baker-acct-list.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified source/mainnet/net/images/browser-wallet/add-baker-comms.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified source/mainnet/net/images/browser-wallet/add-baker-finish.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified source/mainnet/net/images/browser-wallet/add-baker-pool.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified source/mainnet/net/images/browser-wallet/add-baker-restake.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified source/mainnet/net/images/browser-wallet/add-baker-review.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified source/mainnet/net/images/browser-wallet/add-baker-url.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified source/mainnet/net/images/browser-wallet/delegated-amount.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified source/mainnet/net/images/browser-wallet/delegation-target.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified source/mainnet/net/images/browser-wallet/stop-baking-review.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified source/mainnet/net/images/browser-wallet/update-baker-keys.png
Binary file modified source/mainnet/net/images/browser-wallet/update-baker-stake.png
52 changes: 26 additions & 26 deletions source/mainnet/net/mobile-wallet/add-baker-mw.rst
Original file line number Diff line number Diff line change
Expand Up @@ -325,22 +325,22 @@ Prior to becoming a validator, read :ref:`Validator management<baker-pool>` to l

#. Click |earn| on the navigation bar. Use the left and right arrow to locate the button if necessary.

.. image:: ../images/browser-wallet/setup-baking-delegation.png
:width: 40%
.. image:: ../images/browser-wallet/setup-baking-delegation.png
:width: 40%

#. Click **Setup validator**. If you are setting up validation for the first time on this account, you see some information about validation.
#. Click **Setup validation**. If you are setting up validation for the first time on this account, you see some information about being a validator.

#. Select your restake preference. Validator accounts receive a reward when they have produced a block, and the reward is added to the staked amount on the account by default. However, you can change this setting so that the reward is added to the disposable amount instead. Click **Yes, restake** to restake any rewards or click **No, don't restake** if you don’t want to restake rewards. If you do not restake, rewards are deposited to your disposable balance. Click **Continue**.

.. image:: ../images/browser-wallet/add-baker-restake.png
:alt: screen with Yes restake or No don't restake text boxes to choose
:width: 40%
.. image:: ../images/browser-wallet/add-baker-restake.png
:alt: screen with Yes restake or No don't restake text boxes to choose
:width: 40%

#. Specify the amount that you want to stake. The more you stake, the greater the probability that your account will be chosen to produce the next block. Click **Continue**.

.. image:: ../images/browser-wallet/add-baker-staked-amt.png
:alt: screen with balances at the top and text box to enter amount to stake
:width: 40%
.. image:: ../images/browser-wallet/add-baker-staked-amt.png
:alt: screen with balances at the top and text box to enter amount to stake
:width: 40%

.. Note::

Expand All @@ -352,52 +352,52 @@ Prior to becoming a validator, read :ref:`Validator management<baker-pool>` to l

4. Choose whether you want to open a :term:`staking pool` or keep it closed. Choose **Open for delegation** to open a staking pool. 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. Click **Continue**.

.. image:: ../images/browser-wallet/add-baker-pool.png
:alt: screen with buttons to open a pool for delegation or close a pool for delegation
:width: 40%
.. image:: ../images/browser-wallet/add-baker-pool.png
:alt: screen with buttons to open a pool for delegation or close a pool for delegation
:width: 40%

5. Review the commissions paid to validators. You can use the sliders or type the amount of commission for the staking pool. When you open your validator as a pool, you earn commissions of stake delegated to your pool from other accounts. Click **Continue**.
5. Review and adjust the commissions paid to validators using the sliders or by typing in the percentage. When you open your validator as a pool, you earn commissions of stake delegated to your pool from other accounts. Click **Continue**.

.. image:: ../images/browser-wallet/add-baker-comms.png
:alt: screen showing commission amounts for validators in read-only
:width: 40%

6. If you open a staking pool, you can optionally enter a URL with information about your validator to give delegators more information about your staking pool to help them research staking pools. Click **Continue**.

.. image:: ../images/browser-wallet/add-baker-url.png
.. image:: ../images/browser-wallet/add-baker-url.png
:alt: screen with text box to enter url for staking pool information
:width: 40%

7. You have to export the validator keys so that you can start the node with the validator keys. Click **Export validator keys** and the keys are automatically downloaded as `validator-credentials.json` to your default download folder. Click **Continue** to complete the transaction.

.. image:: ../images/browser-wallet/add-baker-export-keys.png
.. image:: ../images/browser-wallet/add-baker-export-keys.png
:alt: screen with buttons to show keys or export validator keys
:width: 40%

.. image:: ../images/browser-wallet/add-baker-continue-after-export.png
:alt: screen with buttons to continue after export and wallet screen dimmed behind
:width: 40%
.. image:: ../images/browser-wallet/add-baker-continue-after-export.png
:alt: screen with buttons to continue after export and wallet screen dimmed behind
:width: 40%

.. Warning::

This is the only time that you can export the credentials. 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.

7. Once you have saved the keys, you see an overview screen of the add validator transaction. Review the information then click **Send**.

.. image:: ../images/browser-wallet/add-baker-review.png
:width: 40%
.. image:: ../images/browser-wallet/add-baker-review.png
:width: 40%

8. The wallet shows that the transaction has been submitted to the chain. Click **Finish**.

.. image:: ../images/browser-wallet/add-baker-finish.png
:width: 40%
.. image:: ../images/browser-wallet/add-baker-finish.png
:width: 40%

9. You need to import your validator keys file to your node in order to start producing blocks. It is preferable to update them on the node as close to the next :term:`pay day` as possible to prevent the node from being down as a validator for a longer time.

- :ref:`Windows<baker-windows>`
- :ref:`macOS<baker-macos>`
- :ref:`Docker<baking-docker>`
- :ref:`Ubuntu<baker-ubuntu>`
- :ref:`Windows<baker-windows>`
- :ref:`macOS<baker-macos>`
- :ref:`Docker<baking-docker>`
- :ref:`Ubuntu<baker-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 card.

Expand Down
Loading

0 comments on commit 7dc71a1

Please sign in to comment.