Skip to content

Commit f2e4a28

Browse files
authored
Merge pull request #1221 from Concordium/updateCCValidatorArticle
Update client validation article
2 parents c60b6b5 + 2288509 commit f2e4a28

File tree

2 files changed

+8
-17
lines changed

2 files changed

+8
-17
lines changed

source/mainnet/docs/network/guides/baker-docker.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ To register the keys in the network you need to be :ref:`running a node <running
2323

2424
.. code-block:: console
2525
26-
$concordium-client validator add <keys-file>.json --sender validatorAccount --stake <amount-to-stake> --out <concordium-data-dir>/validator-credentials.json
26+
$ concordium-client validator add <keys-file>.json --sender validatorAccount --stake <amount-to-stake> --validator-credentials-out <concordium-data-dir>/validator-credentials.json
2727
2828
where you replace
2929

source/mainnet/docs/network/guides/become-baker.rst

Lines changed: 7 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -45,24 +45,16 @@ This section provides a brief description of how to import an account using the
4545

4646
.. Note::
4747

48-
You can only import accounts created in the |mw-gen2|, |bw|, or |mw-gen1| into the Concordium Client. That is, you cannot import accounts created in the Desktop Wallet because they are created using a LEDGER device. You get the account information by exporting a JSON file with the account information.
48+
You can only import accounts created in the |cryptox| or |bw| into the Concordium Client. That is, you cannot import accounts created in the Desktop Wallet because they are created using a LEDGER device. You get the account information by exporting a JSON file with the account information.
4949

50-
* To export the JSON file in |mw-gen1|, see :ref:`Make a backup of identities and accounts<export-import>`.
51-
52-
* To export the private key in |mw-gen2| and |bw|, see :ref:`Export a private key<export-key>`.
50+
* To export the private key in |cryptox| and |bw|, see :ref:`Export a private key<export-key>`.
5351

5452
To import an account run:
5553

5654
.. code-block:: console
5755
5856
$ concordium-client config account import <path/to/exported/file> --name validatorAccount
5957
60-
For the |bw|, use the following command:
61-
62-
.. code-block:: console
63-
64-
$ concordium-client config account import <Wallet.export> --name <Your-Wallet-Name>.json
65-
6658
``concordium-client`` asks for a password to decrypt the exported file and import all accounts. The same password will be used for encrypting the transaction signing keys and the encrypted transfers key.
6759

6860
.. _create-register-baker-keys:
@@ -78,11 +70,11 @@ To create a fresh set of keys run:
7870
7971
$ concordium-client validator generate-keys <keys-file>.json
8072
81-
You can choose an arbitrary name for the ``<keys file>``. To register the keys in the network you need to be :ref:`running a node <running-a-node>` and send a ``validator add`` transaction to the network:
73+
You can choose an arbitrary name for the ``<keys file>``. To register the keys in the network you need to be :ref:`running a node <node-requirements>` and send a ``validator add`` transaction to the network:
8274

8375
.. code-block:: console
8476
85-
$ concordium-client validator add MyValidatorKeys.json --sender validatorAccount --stake <amount-to-stake> --open-delegation-for all --delegation-transaction-fee-commission 0.1 --delegation-baking-commission 0.1 --delegation-finalization-commission 1.0 --validator-url https://example.com/validator --out <concordium-data-dir>/validator-credentials.json
77+
$ concordium-client validator add MyValidatorKeys.json --sender validatorAccount --stake <amount-to-stake> --open-delegation-for all --delegation-transaction-fee-commission 0.1 --delegation-baking-commission 0.1 --delegation-finalization-commission 1.0 --validator-url https://example.com/validator --validator-credentials-out <concordium-data-dir>/validator-credentials.json
8678
8779
8880
where you replace
@@ -91,6 +83,7 @@ where you replace
9183
- ``<amount-to-stake>`` with the CCD amount for the validator's initial stake
9284
- ``MyValidatorURL`` with the URL containing information for your staking pool; can be left as an empty string if you do not want to provide a URL.
9385
- ``<concordium-data-dir>`` with any path of your choice.
86+
- ``validatorAccount`` with the name you've chosen for the account
9487

9588
.. Note::
9689

@@ -106,8 +99,6 @@ where you replace
10699
* on Windows: See :ref:`configure Windows node<configure-baker-windows>`.
107100
* on Ubuntu: See :ref:`configure Ubuntu node<baker-ubuntu>`.
108101

109-
Keep the output file name as ``validator-credentials.json``.
110-
111102
The following arguments are also required for the ``validator add`` transaction:
112103

113104
- ``--open-delegation-for`` sets whether the validator's staking pool is open for delegators. Options are: ``none`` (no delegators will be allowed), ``all`` (any account can delegate), ``existing`` (only existing delegators can delegate).
@@ -134,7 +125,7 @@ The following arguments are optional. If no selection is made, earnings are rest
134125
.. Warning::
135126
Do not stake all of your funds or you will not have enough funds to cover transaction fees.
136127

137-
To start the node with these validator keys and produce blocks, configure the node to use the validator keys, and **restart** it. The node will automatically start producing blocks when the validator is included in the validators list for the current epoch.
128+
To start the node with these validator keys and produce blocks, :ref:`configure the node to use the validator keys<baker-macos>`, and **restart** it. The node will automatically start producing blocks when the validator is included in the validators list for the current epoch.
138129

139130
This change is executed immediately, and it will take effect at the next :term:`pay day` after the one in which the transaction for adding the validator was included in a block. If the change is made in the last epoch before pay day, then the change will not occur until the following pay day.
140131

@@ -294,7 +285,7 @@ When the validator is registered, it will automatically restake the earnings, bu
294285

295286
.. code-block:: console
296287
297-
$ concordium-client validator add validator-keys.json --sender validatorAccount --stake <amount-to-stake> --out validator-credentials.json --no-restake
288+
$ concordium-client validator add validator-keys.json --sender validatorAccount --stake <amount-to-stake> --validator-credentials-out validator-credentials.json --no-restake
298289
299290
Update validator keys
300291
---------------------

0 commit comments

Comments
 (0)