Skip to content

Commit 1dbb073

Browse files
authored
Merge pull request #93 from casper-network/kara/update-operators-node-setup-section
Update "Operators > Node Setup > Installation"
2 parents 021a76c + 9ab98d3 commit 1dbb073

File tree

2 files changed

+26
-24
lines changed

2 files changed

+26
-24
lines changed

docs/operators/setup/install-node.md

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ We are creating /etc/apt/keyrings if needed, so we don't have the issue with thi
7171
## Required Tools
7272

7373
```bash
74-
sudo apt install -y casper-client casper-node-launcher jq
74+
sudo apt install -y casper-client casper-node-launcher casper-sidecar jq
7575
```
7676

7777
## Enable Bash Auto-Completion for `casper-client` (Optional)
@@ -129,38 +129,39 @@ NODE_ADDR can be set to an IP of a trusted node, or to Casper Association's publ
129129

130130
You can find active peers at https://cspr.live/tools/peers or use the following Casper Association public nodes:
131131

132-
* Testnet - NODE_ADDR=https://node.testnet.casper.network
132+
* Testnet - NODE_ADDR=https://node.testnet.casper.network/rpc
133133

134-
* Mainnet - NODE_ADDR=https://node.mainnet.casper.network
134+
* Mainnet - NODE_ADDR=https://node.mainnet.casper.network/rpc
135135

136136
### Protocol Version
137137

138-
Protocol version should be set to the largest available protocol version you see in `ls /etc/casper`. As of writing this, it was 1_5_8:
138+
Protocol version should be set to the largest available protocol version you see in `ls /etc/casper`. As of writing this, it was 2_0_0:
139139

140140
```bash
141-
PROTOCOL=1_5_8
141+
PROTOCOL=2_0_0
142142
```
143143

144144
### Load `trusted_hash` in Config.toml of the Protocol Version
145145

146146
The following command uses the previously established NODE_ADDR and PROTOCOL to load the `trusted_hash`:
147147

148148
```bash
149-
NODE_ADDR=https://node.mainnet.casper.network
150-
PROTOCOL=1_5_8
151-
sudo sed -i "/trusted_hash =/c\trusted_hash = '$(casper-client get-block --node-address $NODE_ADDR | jq -r .result.block.hash | tr -d '\n')'" /etc/casper/$PROTOCOL/config.toml
149+
NODE_ADDR=https://node.mainnet.casper.network/rpc
150+
PROTOCOL=2_0_0
151+
sudo sed -i "/trusted_hash =/c\trusted_hash = '$(casper-client get-block --node-address $NODE_ADDR | jq -r .result.block_with_signatures.block.Version2.hash | tr -d '\n')'" /etc/casper/$PROTOCOL/config.toml
152152
```
153153

154154
## Syncing to Genesis
155155

156-
In the latest protocol version's *Config.toml*, you will find the option `sync_to_genesis`. By default, this value will be set to `true`.
156+
In the latest protocol version's *Config.toml*, you will find the option `sync_handling`. By default, this value will be set to `ttl`, which means the node will attempt to acquire all block data to comply with time to live enforcement, but will not attempt to sync all the way back to genesis.
157157

158-
If you are planning to run a validator node, it is better to not sync your node to genesis. This will increase node performance. In this case, the option should be changed to:
158+
**If you are planning to run a validator node, leave this option at the default value of `ttl`**; this will increase node performance.
159+
160+
If you are using the node for historical data and want to query back to genesis, then this option should be changed to:
159161

160162
```bash
161-
sync_to_genesis = false
163+
sync_handling = genesis
162164
```
163-
If you are using the node for historical data and want to query back to genesis, you can leave the default value in place.
164165

165166
## Starting the Node
166167

versioned_docs/version-2.0.0/operators/setup/install-node.md

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ We are creating /etc/apt/keyrings if needed, so we don't have the issue with thi
7171
## Required Tools
7272

7373
```bash
74-
sudo apt install -y casper-client casper-node-launcher jq
74+
sudo apt install -y casper-client casper-node-launcher casper-sidecar jq
7575
```
7676

7777
## Enable Bash Auto-Completion for `casper-client` (Optional)
@@ -129,38 +129,39 @@ NODE_ADDR can be set to an IP of a trusted node, or to Casper Association public
129129

130130
You can find active peers at https://cspr.live/tools/peers or use the following Casper Association's public nodes:
131131

132-
* Testnet - NODE_ADDR=https://node.testnet.casper.network
132+
* Testnet - NODE_ADDR=https://node.testnet.casper.network/rpc
133133

134-
* Mainnet - NODE_ADDR=https://node.mainnet.casper.network
134+
* Mainnet - NODE_ADDR=https://node.mainnet.casper.network/rpc
135135

136136
### Protocol Version
137137

138-
Protocol version should be set to the largest available protocol version you see in `ls /etc/casper`. As of writing this, it was 1_5_8:
138+
Protocol version should be set to the largest available protocol version you see in `ls /etc/casper`. As of writing this, it was 2_0_0:
139139

140140
```bash
141-
PROTOCOL=1_5_8
141+
PROTOCOL=2_0_0
142142
```
143143

144144
### Load `trusted_hash` in Config.toml of the Protocol Version
145145

146146
The following command uses the previously established NODE_ADDR and PROTOCOL to load the `trusted_hash`:
147147

148148
```bash
149-
NODE_ADDR=https://node.mainnet.casper.network
150-
PROTOCOL=1_5_8
151-
sudo sed -i "/trusted_hash =/c\trusted_hash = '$(casper-client get-block --node-address $NODE_ADDR | jq -r .result.block.hash | tr -d '\n')'" /etc/casper/$PROTOCOL/config.toml
149+
NODE_ADDR=https://node.mainnet.casper.network/rpc
150+
PROTOCOL=2_0_0
151+
sudo sed -i "/trusted_hash =/c\trusted_hash = '$(casper-client get-block --node-address $NODE_ADDR | jq -r .result.block_with_signatures.block.Version2.hash | tr -d '\n')'" /etc/casper/$PROTOCOL/config.toml
152152
```
153153

154154
## Syncing to Genesis
155155

156-
In the latest protocol version's *Config.toml*, you will find the option `sync_to_genesis`. By default, this value will be set to `true`.
156+
In the latest protocol version's *Config.toml*, you will find the option `sync_handling`. By default, this value will be set to `ttl`, which means the node will attempt to acquire all block data to comply with time to live enforcement, but will not attempt to sync all the way back to genesis.
157157

158-
If you are planning to run a validator node, it is better to not sync your node to genesis. This will increase node performance. In this case, the option should be changed to:
158+
**If you are planning to run a validator node, leave this option at the default value of `ttl`**; this will increase node performance.
159+
160+
If you are using the node for historical data and want to query back to genesis, then this option should be changed to:
159161

160162
```bash
161-
sync_to_genesis = false
163+
sync_handling = genesis
162164
```
163-
If you are using the node for historical data and want to query back to genesis, you can leave the default value in place.
164165

165166
## Starting the Node
166167

0 commit comments

Comments
 (0)