Skip to content

Commit

Permalink
Deploy preview for PR 927 🛫
Browse files Browse the repository at this point in the history
  • Loading branch information
dg-concordium committed Nov 24, 2023
1 parent d0fce1c commit 8649665
Show file tree
Hide file tree
Showing 534 changed files with 918 additions and 947 deletions.
Binary file modified pr-preview/pr-927/en/mainnet/.doctrees/environment.pickle
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file modified pr-preview/pr-927/en/mainnet/_images/account-delegating.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 pr-preview/pr-927/en/mainnet/_images/add-delegation-amt-mw.jpg
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 pr-preview/pr-927/en/mainnet/_images/add-delegation-conf-mw.jpg
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 pr-preview/pr-927/en/mainnet/_images/add-delegation-mw.jpg
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 pr-preview/pr-927/en/mainnet/_images/baker-status-mw.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.
Original file line number Diff line number Diff line change
Expand Up @@ -133,14 +133,14 @@ When you delegate some stake to a staking pool, it can influence the chances of

#. Tap **Continue to delegation setup**. If you are delegating for the first time, you see some information about delegation.

.. image:: ../images/mobile-wallet/earning-add.png
:width: 50%
:alt: screen with earning options

#. Tap **Register delegation**.

#. If you want to delegate to a specific pool tap **Staking pool** and enter the Validator ID of the pool owner. If you are delegating to passive delegation, tap **Passive delegation**. Tap **Continue**.

.. image:: ../images/mobile-wallet/add-delegation-mw.jpg
:width: 50%
:alt: screen with options to choose delegation type

#. You can see your balance available to delegate. **Enter the Amount you want to delegate** in the field. And tap **Yes, restake** to restake any rewards or tap **No, don't restake** if you don’t want to restake rewards. If you do not restake, rewards are deposited to your disposable balance. Tap **Continue**.

.. image:: ../images/mobile-wallet/add-delegation-amt-mw.jpg
Expand All @@ -149,16 +149,8 @@ When you delegate some stake to a staking pool, it can influence the chances of

#. Review the information in the transaction overview. When you are satisfied, tap **Submit delegation transaction**.

.. image:: ../images/mobile-wallet/add-delegation-conf-mw.jpg
:width: 50%
:alt: screen showing overview of the transaction before submission

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

.. image:: ../images/mobile-wallet/add-delegation-submit-mw.jpg
:width: 50%
:alt: screen showing submitted transaction details

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

.. image:: ../images/mobile-wallet/account-delegating.png
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,18 +16,18 @@ The chain is run by a network of validator nodes that produce blocks. In the fol

Prerequisites
=============
You will either need a working installation of the Concordium Node distribution or Docker, instances of which will be used to run the validator node(s). You will need :term:`genesis block` data which defines your local chain and sets of credentials for validator accounts of the chain. The number of sets of validator credentials needed thus depends on the desired number of validators in the network, which in this example is 1.
You will either need a working installation of the :ref:`Concordium Node distribution<node-downloads>` or `Docker <https://www.docker.com/>`_, instances of which will be used to run the validator node(s). You will need :term:`genesis block` data, which defines your local chain and sets of credentials for validator accounts of the chain. The number of sets of validator credentials needed thus depends on the desired number of validators in the network, which in this example is one.

Install the node distribution
-----------------------------
Concordium Node releases exist for Ubuntu, MacOS and Windows and Docker. See the :ref:`Node Requirements<node-requirements>` section for information on system requirements and detailed instructions on how to obtain, run, and manage a node. To run a validator, you either need a Concordium node binary supplied with your appropriate distribution in your path or a working Docker installation. This depends on whether you want to run the Node binary directly on your host or as a Docker instance. The details below assume the former, but if you want to run a Docker instance, you can skip to the next section.
Concordium Node releases exist for Ubuntu, MacOS, Windows and Docker. See the :ref:`Node Requirements<node-requirements>` section for information on system requirements and detailed instructions on how to obtain, run, and manage a node. To run a validator, you either need a Concordium node binary supplied with your appropriate distribution in your path or a working Docker installation. This depends on whether you want to run the Node binary directly on your host or as a Docker instance. The details below assume the former, but if you want to run a Docker instance, you can skip to the next section.

The name of the binary has ``concordium-`` as its prefix but depends on the distribution, so you may have to confer with the installation instructions to figure out the exact name. Upon successful installation of the distribution, verify that the binary exists in your path at the required version:

.. code-block:: console
$ concordium-node --version # name depends on distribution
concordium_node 5.3.2
concordium_node 6.1.7
.. Note::

Expand Down Expand Up @@ -77,19 +77,23 @@ The ``genesis-creator`` tool uses a TOML configuration file format for specifyin
* keys for updating the chain
* various parameters for the genesis

Furthermore, it specifies where to save the output that is used to invoke the node binary. Most of these options are of little importance when testing smart contracts and the easiest way to get started is to piggyback off of the example configuration file ``single-baker-example-p5.toml`` found `here <https://raw.githubusercontent.com/Concordium/concordium-misc-tools/9d347761aadd432cbb6211a7d7ba38cdc07f1d11/genesis-creator/examples/single-baker-example-p5.toml>`_. Inspecting the configuration reveals that it specifies an initial protocol version of 5 to output credentials for 1 validator account, 1 foundation account, and 100 regular accounts. It specifies the system time at generation for the genesis time, and finally, specifies 5 seconds as the average time per block.
Furthermore, it specifies where to save the output that is used to invoke the node binary. Most of these options are of little importance when testing smart contracts and the easiest way to get started is to piggyback off of the example configuration file ``single-baker-example-p6.toml`` found `here <https://raw.githubusercontent.com/Concordium/concordium-misc-tools/main/genesis-creator/examples/single-baker-example-p6.toml>`_. Inspecting the configuration reveals that it specifies an initial protocol version of 6 to output credentials for 1 validator account, 1 foundation account, and 100 regular accounts. It specifies the system time at generation for the genesis time, and finally, specifies 2 seconds as the minimum time per block.

Further inspection of the tables at the ``accounts`` keys reveals that the validator account has an initial balance of 3.5 * 10^15 microCCD and stake of 3.0 * 10^15 microCCD, the foundation account has an initial balance of 10^16 microCCD, and the regular accounts each have an initial balance of 2.0 * 10^12. You can change the initial stake and balances if desired. The number of credentials produced for each type of account can also be adjusted by setting the values of the ``repeat`` keys to your choosing.
.. note::

Validators were previously called *bakers*, and remnants of the old name are still present in our tools. Whenever you read *baker*, think *validator*.

Further inspection of the tables at the ``accounts`` keys reveals that the validator account has an initial balance of 3.5 * 10^15 microCCD and stake of 3.0 * 10^15 microCCD, the foundation account has an initial balance of 10^16 microCCD, and the regular accounts each have an initial balance of 2.0 * 10^12. You can change the initial stake and balances if desired. The number of accounts produced of each type can also be adjusted by setting the values of the ``repeat`` keys to your choosing.

.. Note::

The staked amount needed for a validator to participate in the finalization committee is some fraction of the total amount of existing CCD set in the configuration. The total amount is the sum of the balances of all the validator and foundation accounts specified in the genesis configuration file. In this particular example, the stake is sufficient for producing blocks.

Save the file as ``single-baker-example-p5.toml`` and generate the genesis data:
Save the file as ``single-baker-example-p6.toml`` and generate the genesis data:

.. code-block:: console
$ ~/.cargo/bin/genesis-creator generate --config ./single-baker-example-p5.toml
$ ~/.cargo/bin/genesis-creator generate --config ./single-baker-example-p6.toml
Deleting any existing directories.
Account keys will be generated in ./accounts
Chain update keys will be generated in ./update-keys
Expand Down Expand Up @@ -153,25 +157,25 @@ If you ran the validator node by invoking the node binary directly on your host,
image: concordium/mainnet-node:latest
pull_policy: always
environment:
# Baker credentials file
# Validator credentials file
- CONCORDIUM_NODE_BAKER_CREDENTIALS_FILE=/mnt/baker-0-credentials.json
# General node configuration Data and config directories (it's OK if they
# General node configuration data and config directories (it's OK if they
# are the same). This should match the volume mount below. If the location
# of the mount inside the container is changed, then these should be
# changed accordingly as well.
- CONCORDIUM_NODE_DATA_DIR=/mnt/data
- CONCORDIUM_NODE_CONFIG_DIR=/mnt/data
# port on which the node will listen for incoming connections. This is a
# The port on which the node will listen for incoming connections. This is a
# port inside the container. It is mapped to an external port by the port
# mapping in the `ports` section below. If the internal and external ports
# are going to be different then you should also set
# `CONCORDIUM_NODE_EXTERNAL_PORT` variable to what the external port value is.
- CONCORDIUM_NODE_LISTEN_PORT=8169
# Address of the V2 GRPC server
# Address of the V2 GRPC server.
- CONCORDIUM_NODE_GRPC2_LISTEN_ADDRESS=0.0.0.0
# And its port
# And its port.
- CONCORDIUM_NODE_GRPC2_LISTEN_PORT=20100
# Do not bootstrap via DNS
# Do not bootstrap via DNS.
- CONCORDIUM_NODE_CONNECTION_NO_BOOTSTRAP_DNS=true
entrypoint: ["/concordium-node"]
# Exposed ports. The ports the node listens on inside the container (defined
Expand Down Expand Up @@ -205,7 +209,7 @@ You can now interact with your local chain through the node via the :ref:`Concor

.. code-block:: console
$ concordium-client --grpc-ip 127.0.0.1 --grpc-port 20100 account list
$ concordium-client --grpc-ip 127.0.0.1 --grpc-port 20100 account list
Accounts:
Account Address Account Names
--------------------------------------------------------------------
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -147,24 +147,16 @@ Before delegating stake to a staking pool, it is important to research the pool
:width: 50%
:alt: screen showing current delegation with options to stop or update

#. If you want to delegate to a specific pool tap **Staking pool** and enter the validator ID of the pool owner you want to switch the delegation to. If you want to delegate to passive delegation, tap **Passive delegation**. Tap **Continue**.
#. If you want to delegate to a specific pool tap **Validator** and enter the validator ID of the pool owner you want to switch the delegation to. If you want to delegate to passive delegation, tap **Passive delegation**. Tap **Continue**.

.. image:: ../images/mobile-wallet/update-delegation-target-mw.jpg
.. image:: ../images/mobile-wallet/update-delegation-amt-mw.jpg
:width: 50%
:alt: screen with options to choose delegation type

#. 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. And tap **Yes, restake** to restake any rewards or tap **No, don't restake** if you don’t want to restake rewards. If you do not restake, rewards are deposited to your disposable balance. Tap **Continue**.

.. image:: ../images/mobile-wallet/update-delegation-amt-mw.jpg
: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**.

.. image:: ../images/mobile-wallet/update-delegation-conf-mw.jpg
:width: 50%
:alt: screen showing overview of the transaction before submission

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

.. dropdown:: |mw-gen1|
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -191,9 +191,13 @@ Prior to becoming a validator, read :ref:`Validator management<baker-pool>` to l

#. Select **Continue to validator setup**.

.. image:: ../images/mobile-wallet/earning-add.png
:width: 50%
:alt: screen with earning options

#. After the screens explaining validation, specify the amount that you want to stake on the Register Validator screen. The more you stake, the greater the probability that your account will be chosen to produce the next block. 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. Select **Don’t restake** if you'd rather add the rewards to the disposable amount on the account.

.. image:: ../images/mobile-wallet/add-baker-amt-mw.png
.. image:: ../images/mobile-wallet/add-baker-pool-mw.png
:alt: screen to register validator for first time showing balance, amount to stake, and restake parameters
:width: 50%

Expand All @@ -207,7 +211,7 @@ 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. 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.

.. image:: ../images/mobile-wallet/add-baker-pool-mw.png
.. image:: ../images/mobile-wallet/add-baker-amt-mw.png
:alt: screen to register validator for first time showing options to open or close pool for delegation
:width: 50%

Expand Down Expand Up @@ -235,16 +239,8 @@ Prior to becoming a validator, read :ref:`Validator management<baker-pool>` to l

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

.. image:: ../images/mobile-wallet/add-baker-submit-mw.png
:alt: screen to register validator for first time showing transaction details with option to submit
:width: 50%

8. The wallet 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.

.. image:: ../images/mobile-wallet/add-baker-finish-mw.png
:alt: screen to register validator for first time showing transaction submission and finish option
:width: 50%

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>`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -247,7 +247,9 @@ Update pool settings

If you choose **Open 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. This information is not shared in the case of a closed pool.
#. 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.

#. In the Update pool settings overview screen review the information then tap **Submit delegation transaction**.

Expand All @@ -257,6 +259,8 @@ Update pool settings

Existing delegators remain in the pool. You have the option to adjust commission fees and your validator information URL.

#. 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.

#. In the Update pool settings overview screen review the information then tap **Submit delegation transaction**.
Expand All @@ -275,8 +279,6 @@ Update pool settings

In the |mw-gen1| it is not possible for pool owners to set the commissions. They are fixed at 10%. If you want to be able to adjust commissions, you must use the |mw-gen2| or |bw|. For information about the process, see :ref:`the delegation FAQ<wallet-migrate>`.

Once you have adjusted your pool status, you can use the sliders to update the validator commission rates or type in the percentage you want for your commission rates, if desired, in the |mw-gen2|. 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.

.. dropdown:: |bw|

#. Click |earn| on the navigation bar. Use the left and right arrow to locate the button if necessary. Use the Accounts drop-down at the top of the window to select the account.
Expand Down

Large diffs are not rendered by default.

This file was deleted.

Loading

0 comments on commit 8649665

Please sign in to comment.