Skip to content

Commit 2ab7f17

Browse files
committed
Merge branch 'documentation' into 'master'
Updated documentation regarding running a new node See merge request zb-ledger/zb-ledger!30
2 parents ed2c85a + 4d9f247 commit 2ab7f17

File tree

2 files changed

+28
-7
lines changed

2 files changed

+28
-7
lines changed

docs/how-to.md

+12-2
Original file line numberDiff line numberDiff line change
@@ -56,8 +56,17 @@ Here are steps for setting up a new validator node.
5656
* Get this node's tendermint validator *consensus address*: `zbld tendermint show-address`
5757
* Get this node's tendermint validator *consensus pubkey*: `zbld tendermint show-validator`
5858
* Note that *consensus address* and *consensus pubkey* are not the same as `address` and `pubkey` were used for account creation.
59-
* Add validator node: `zblcli tx validator add-node --validator-address=<validator address> --validator-pubkey=<validator pubkey> --name=<node name> --from=<name>`
6059
* Start node: `zbld start`
60+
* In the output, you can notice that `height` increases quickly over time.
61+
This means that the node is in updating to the latest network state (it takes some time).
62+
63+
You can also check node status by connecting CLI to your local node `zblcli config node tcp://0.0.0.0:26657`
64+
and executing the command `zblcli status` to get the current status.
65+
The `true` value for `catching_up` field means that the node is in the updating process.
66+
The value of `latest_block_height` reflects the current node height.
67+
68+
* Wait until the value of `catching_up` field gets to `false` value.
69+
* Add validator node: `zblcli tx validator add-node --validator-address=<validator address> --validator-pubkey=<validator pubkey> --name=<node name> --from=<name>`
6170

6271
* Congrats! You are an owner of the validator node.
6372

@@ -74,8 +83,9 @@ Example:
7483
* `sed -i "s/persistent_peers = \"\"/<node id>@<node ip>,<node2 id>@<node2 ip>/g" $HOME/.zbld/config/config.toml`
7584
* `sudo ufw allow 26656/tcp`
7685
* `sudo ufw allow 26657/tcp`
77-
* `zblcli tx validator add-node --validator-address=$(zbld tendermint show-address) --validator-pubkey=$(zbld tendermint show-validator) --name=node-name --from=node_admin`
7886
* `zbld start`
87+
* `zbld status`
88+
* `zblcli tx validator add-node --validator-address=$(zbld tendermint show-address) --validator-pubkey=$(zbld tendermint show-validator) --name=node-name --from=node_admin`
7989
* `zblcli query validator all-nodes`
8090

8191
##### Policy

docs/running-node.md

+16-5
Original file line numberDiff line numberDiff line change
@@ -101,15 +101,26 @@ The delivery consists of the following components:
101101
cosmosvalconspub1zcjduepqcwg4eenpcxgs0269xuup5jlzj3pdquxlvj494cjxtqtcathsq7esfrsapa
102102
```
103103
* Note that *validator address* and *validator pubkey* are not the same as `address` and `pubkey` were used for account creation.
104-
105-
* Add validator node: `zblcli tx validator add-node --validator-address=<validator address> --validator-pubkey=<validator pubkey> --name=<node name> --from=<key name>`.
106-
If the transaction has been successfully written you would find `"success": true` in the output JSON.
107-
104+
108105
* Enable the service: `sudo systemctl enable zbld`
109106
* Start node: `sudo systemctl start zbld`
110-
107+
111108
* For testing purpose the node can be started in CLI mode: `zbld start` (instead of two previous `systemctl` commands).
112109
Service mode is recommended for demo and production environment.
110+
111+
* Use `systemctl start status` to get the node service status.
112+
In the output, you can notice that `height` increases quickly over time.
113+
This means that the node in updating to the latest network state (it takes some time).
114+
115+
You can also check node status by connecting CLI to your local node `zblcli config node tcp://0.0.0.0:26657`
116+
and executing the command `zblcli status` to get the current status.
117+
The `true` value for `catching_up` field means that the node is in the updating process.
118+
The value of `latest_block_height` reflects the current node height.
119+
120+
* Wait until the value of `catching_up` field gets to `false` value.
121+
122+
* Add validator node: `zblcli tx validator add-node --validator-address=<validator address> --validator-pubkey=<validator pubkey> --name=<node name> --from=<key name>`.
123+
If the transaction has been successfully written you would find `"success": true` in the output JSON.
113124

114125
6. Check the node is running and participates in consensus:
115126
* Get the list of all nodes: `zblcli query validator all-nodes`.

0 commit comments

Comments
 (0)