Skip to content

Commit 720d21f

Browse files
authored
Add slashing protection repair cli (#295) (#304)
* update sync message (#299) * added slashing-protection repair commands (#295) * added slashing-protection repair commands (#295) * added slashing-protection repair commands (#295) * added slashing-protection repair commands (#295) * added slashing-protection repair commands (#295) * added slashing-protection repair commands (#295)
1 parent 48b1364 commit 720d21f

File tree

7 files changed

+203
-58
lines changed

7 files changed

+203
-58
lines changed

docs/HowTo/Troubleshoot/Troubleshooting.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,8 @@ If all recent attestations are marked as missed, check the following:
105105
* **Is the beacon node still syncing?**
106106

107107
Validators can only attest when the beacon node is in sync. If you see lines similar to,
108-
`teku-event-log | Syncing *** Target slot: 2017218, Head slot: 123456, Remaining slots: 2015500, Connecting peers: 12`, then the node is
108+
109+
`teku-event-log | Syncing *** Target slot: 2017218, Head slot: 123456, Remaining slots: 2015500, Connecting peers: 12`, then the node is
109110
still syncing.
110111

111112
Syncing is complete when the head slot reaches the current slot. If the node is synced, the

docs/Reference/CLI/CLI-Syntax.md

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ teku [OPTIONS] [COMMAND]
5858
TEKU_CONFIG_FILE=/home/me/me_node/config.yaml
5959
```
6060

61-
The path to the [YAML configuration file](../../HowTo/Configure/Use-Configuration-File.md).
61+
Path to the [YAML configuration file](../../HowTo/Configure/Use-Configuration-File.md).
6262
The default is `none`.
6363

6464
### data-base-path, data-path
@@ -87,7 +87,7 @@ The default is `none`.
8787
data-base-path: "/home/me/me_node"
8888
```
8989

90-
The path to the Teku data directory. The default directory is OS dependent:
90+
Path to the Teku data directory. The default directory is OS-dependent:
9191

9292
* macOS: `~/Library/teku`
9393
* Unix/Linux: `$XDG_DATA_HOME/teku` if `$XDG_DATA_HOME` is set; otherwise `~/.local/share/teku`
@@ -121,7 +121,7 @@ The default Docker image location is `/root/.local/share/teku`.
121121
data-beacon-path: "/home/me/me_beaon"
122122
```
123123

124-
Path to the beacon chain client data. Defaults to `<data-base-path>/beacon` where `<data-base-path>`
124+
Path to the beacon chain client data. The default is `<data-base-path>/beacon` where `<data-base-path>`
125125
is specified using [`--data-base-path`](#data-base-path-data-path).
126126

127127
### data-storage-archive-frequency
@@ -150,7 +150,7 @@ is specified using [`--data-base-path`](#data-base-path-data-path).
150150
data-storage-archive-frequency: 1028
151151
```
152152

153-
Set the frequency (in slots) at which to store finalized states to disk. Defaults to 2048.
153+
Set the frequency (in slots) at which to store finalized states to disk. The default is 2048.
154154

155155
This option is ignored if [`--data-storage-mode`](#data-storage-mode) is set to `prune`.
156156

@@ -192,7 +192,7 @@ This option is ignored if [`--data-storage-mode`](#data-storage-mode) is set to
192192
```
193193

194194
Set the strategy for handling historical chain data. Valid options are `prune` and `archive`.
195-
Defaults to `prune`.
195+
The default is `prune`.
196196

197197
### data-validator-path
198198

@@ -220,7 +220,7 @@ Defaults to `prune`.
220220
data-validator-path: "/home/me/me_validator"
221221
```
222222

223-
Path to the validator client data. Defaults to `<data-base-path>/validator` where `<data-base-path>`
223+
Path to the validator client data. The default is `<data-base-path>/validator` where `<data-base-path>`
224224
is specified using [`--data-base-path`](#data-base-path-data-path).
225225

226226
### eth1-deposit-contract-address
@@ -283,7 +283,7 @@ The deposit contract address can also be defined in:
283283
```
284284

285285
The maximum number of blocks to request deposit contract event logs for in a single request.
286-
Defaults to 10000.
286+
The default is 10000.
287287

288288
Setting a smaller max size may help if your ETH1 node is slow at loading deposit event logs, or when
289289
receiving warnings that the ETH1 node is unavailable.
@@ -436,7 +436,7 @@ Default is `INFO`.
436436
```
437437

438438
Specify whether status and event log messages include a console color display code.
439-
Defaults to `true`.
439+
The default is `true`.
440440

441441
### log-destination
442442

@@ -471,7 +471,7 @@ Specify where to output log information. Valid options are:
471471
* `DEFAULT_BOTH`
472472
* `FILE`
473473

474-
Defaults to `DEFAULT_BOTH`. When using `BOTH` or `DEFAULT_BOTH`, system updates such as blockchain
474+
The default is `DEFAULT_BOTH`. When using `BOTH` or `DEFAULT_BOTH`, system updates such as blockchain
475475
events are displayed on the console, and errors and other information are logged to a file. Specify
476476
the log file with the [`--log-file`](#log-file) command-line option.
477477

@@ -512,7 +512,7 @@ information is available in one place.
512512

513513
Relative or absolute location, and filename of the log file.
514514

515-
The default directory is OS dependent:
515+
The default directory is OS-dependent:
516516

517517
* macOS: `~/Library/teku/logs`
518518
* Unix/Linux: `$XDG_DATA_HOME/teku/logs` if `$XDG_DATA_HOME` is set; otherwise `~/.local/share/teku/logs`
@@ -575,7 +575,7 @@ Filename pattern to apply when creating log files.
575575
```
576576

577577
Specify whether to log frequent update events. For example every slot event with
578-
validators and attestations. Defaults to `true`.
578+
validators and attestations. The default is `true`.
579579

580580
### log-include-validator-duties-enabled
581581

@@ -603,7 +603,7 @@ validators and attestations. Defaults to `true`.
603603
log-include-validator-duties-enabled: false
604604
```
605605

606-
Specify whether to log details of validator event duties. Defaults to `true`.
606+
Specify whether to log details of validator event duties. The default is `true`.
607607

608608
!!! note
609609
Logs could become noisy when running many validators.
@@ -828,7 +828,7 @@ bootnodes, and the address of the Ethereum 1.0 deposit contract.
828828
p2p-advertised-ip: "192.168.1.132"
829829
```
830830

831-
Advertised peer-to-peer IP address. Default is `127.0.0.1`.
831+
Advertised peer-to-peer IP address. The default is `127.0.0.1`.
832832

833833
### p2p-enabled
834834

@@ -1186,7 +1186,7 @@ of static peers.
11861186
```
11871187

11881188
Forces the beacon node to stay subscribed to all subnets regardless of the number of validators.
1189-
Defaults to `false`.
1189+
The default is `false`.
11901190

11911191
When set to `true` and running a low number of validators, Teku subscribes and unsubscribes from
11921192
subnets as needed for the running validators.
@@ -1232,7 +1232,7 @@ them with commas.
12321232
Listed domains can access the node using HTTP REST API calls. If your client interacts with Teku
12331233
using a browser app (such as a block explorer), add the client domain to the list.
12341234

1235-
The default value is "none." If you don't list any domains, browser apps can't interact with your
1235+
The default is "none." If you don't list any domains, browser apps can't interact with your
12361236
Teku node.
12371237

12381238
!!! tip
@@ -1489,7 +1489,7 @@ When specifying file names, Teku expects that the files exist.
14891489
```
14901490

14911491
Specify whether to use Teku's built-in early attestation production, which creates an
1492-
attestation as soon as a block is received. Defaults to `true`.
1492+
attestation as soon as a block is received. The default is `true`.
14931493

14941494
Set this option to `false` if running a validator client connected to a load balanced beacon node
14951495
(including most hosted beacon nodes such as [Infura]), and validator effectiveness is poor.
@@ -1627,7 +1627,7 @@ Ensure the external signer is running before starting Teku.
16271627
```
16281628

16291629
Specify whether to use Teku's built-in [slashing protection] when using an external signer such as
1630-
[Web3Signer]. Defaults to `true`.
1630+
[Web3Signer]. The default is `true`.
16311631

16321632
Set this option to `false` if using the slashing protection implemented by an external signer.
16331633

@@ -1665,7 +1665,7 @@ using Teku to sign blocks and attestations always uses its built-in slashing pro
16651665
validators-external-signer-timeout: 2000
16661666
```
16671667

1668-
Timeout in milliseconds for requests to the external signer. Default is 1000.
1668+
Timeout in milliseconds for requests to the external signer. The default is 1000.
16691669

16701670
### validators-external-signer-truststore
16711671

@@ -1844,7 +1844,7 @@ This option takes precedence over [`--validators-graffiti`](#validators-graffiti
18441844
validators-keystore-locking-enabled: true
18451845
```
18461846

1847-
Locks the keystore files listed in [`--validator-keys`](#validator-keys). Defaults to `true`.
1847+
Locks the keystore files listed in [`--validator-keys`](#validator-keys). The default is `true`.
18481848

18491849
Attempts to lock all keystores in a directory if a directory is specified in
18501850
[`--validator-keys`](#validator-keys).
@@ -1876,7 +1876,7 @@ Attempts to lock all keystores in a directory if a directory is specified in
18761876
```
18771877

18781878
Set the validator performance tracking strategy. Valid options are `LOGGING`, `METRICS`, `ALL`, and
1879-
`NONE`. Defaults to `ALL`.
1879+
`NONE`. The default is `ALL`.
18801880

18811881
When `LOGGING` is enabled, attestation and block performance is reported as log messages. When
18821882
`METRICS` is enabled, attestation and block performance is reported using [metrics] in the

docs/Reference/CLI/Subcommands/Admin.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ Clears the stored weak subjectivity configuration.
4040
TEKU_CONFIG_FILE=/home/me/me_node/config.yaml
4141
```
4242

43-
The path to the YAML configuration file.
43+
Path to the YAML configuration file.
4444
The default is `none`.
4545

4646
#### data-base-path, data-path
@@ -69,7 +69,7 @@ The default is `none`.
6969
data-base-path: "/home/me/me_node"
7070
```
7171

72-
The path to the Teku data directory. The default directory is OS dependent:
72+
Path to the Teku data directory. The default directory is OS-dependent:
7373

7474
* macOS: `~/Library/teku`
7575
* Unix/Linux: `$XDG_DATA_HOME/teku` if `$XDG_DATA_HOME` is set; otherwise `~/.local/share/teku`
@@ -103,7 +103,7 @@ The default Docker image location is `/root/.local/share/teku`.
103103
data-beacon-path: "/home/me/me_beaon"
104104
```
105105

106-
Path to the beacon chain client data. Defaults to `<data-base-path>/beacon` where `<data-base-path>`
106+
Path to the beacon chain client data. The default is `<data-base-path>/beacon` where `<data-base-path>`
107107
is specified using [`--data-base-path`](#data-base-path-data-path).
108108

109109
#### data-storage-archive-frequency
@@ -132,7 +132,7 @@ is specified using [`--data-base-path`](#data-base-path-data-path).
132132
data-storage-archive-frequency: 1028
133133
```
134134

135-
Set the frequency (in slots) at which to store finalized states to disk. Defaults to 2048.
135+
Set the frequency (in slots) at which to store finalized states to disk. The default is 2048.
136136

137137
This option is ignored if [`--data-storage-mode`](#data-storage-mode) is set to `prune`.
138138

@@ -174,7 +174,7 @@ This option is ignored if [`--data-storage-mode`](#data-storage-mode) is set to
174174
```
175175

176176
Set the strategy for handling historical chain data. Valid options are `prune` and `archive`.
177-
Defaults to `prune`.
177+
The default is `prune`.
178178

179179
#### data-validator-path
180180

@@ -202,7 +202,7 @@ Defaults to `prune`.
202202
data-validator-path: "/home/me/me_validator"
203203
```
204204

205-
Path to the validator client data. Defaults to `<data-base-path>/validator` where `<data-base-path>`
205+
Path to the validator client data. The default is `<data-base-path>/validator` where `<data-base-path>`
206206
is specified using [`--data-base-path`](#data-base-path-data-path).
207207

208208
#### eth1-deposit-contract-address
@@ -298,7 +298,7 @@ Displays the stored weak subjectivity configuration.
298298
TEKU_CONFIG_FILE=/home/me/me_node/config.yaml
299299
```
300300

301-
The path to the YAML configuration file.
301+
Path to the YAML configuration file.
302302
The default is `none`.
303303

304304
#### data-base-path, data-path
@@ -327,7 +327,7 @@ The default is `none`.
327327
data-base-path: "/home/me/me_node"
328328
```
329329

330-
The path to the Teku data directory. The default directory is OS dependent:
330+
Path to the Teku data directory. The default directory is OS-dependent:
331331

332332
* macOS: `~/Library/teku`
333333
* Unix/Linux: `$XDG_DATA_HOME/teku` if `$XDG_DATA_HOME` is set; otherwise `~/.local/share/teku`
@@ -361,7 +361,7 @@ The default Docker image location is `/root/.local/share/teku`.
361361
data-beacon-path: "/home/me/me_beaon"
362362
```
363363

364-
Path to the beacon chain client data. Defaults to `<data-base-path>/beacon` where `<data-base-path>`
364+
Path to the beacon chain client data. The default is `<data-base-path>/beacon` where `<data-base-path>`
365365
is specified using [`--data-base-path`](#data-base-path-data-path).
366366

367367
#### data-storage-archive-frequency
@@ -390,7 +390,7 @@ is specified using [`--data-base-path`](#data-base-path-data-path).
390390
data-storage-archive-frequency: 1028
391391
```
392392

393-
Set the frequency (in slots) at which to store finalized states to disk. Defaults to 2048.
393+
Set the frequency (in slots) at which to store finalized states to disk. The default is 2048.
394394

395395
This option is ignored if [`--data-storage-mode`](#data-storage-mode) is set to `prune`.
396396

@@ -432,7 +432,7 @@ This option is ignored if [`--data-storage-mode`](#data-storage-mode) is set to
432432
```
433433

434434
Set the strategy for handling historical chain data. Valid options are `prune` and `archive`.
435-
Defaults to `prune`.
435+
The default is `prune`.
436436

437437
#### data-validator-path
438438

@@ -460,7 +460,7 @@ Defaults to `prune`.
460460
data-validator-path: "/home/me/me_validator"
461461
```
462462

463-
Path to the validator client data. Defaults to `<data-base-path>/validator` where `<data-base-path>`
463+
Path to the validator client data. The default is `<data-base-path>/validator` where `<data-base-path>`
464464
is specified using [`--data-base-path`](#data-base-path-data-path).
465465

466466
#### eth1-deposit-contract-address

docs/Reference/CLI/Subcommands/Migrate-Database.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ title: Database migration subcommand options
3131
TEKU_CONFIG_FILE=/home/me/me_node/config.yaml
3232
```
3333

34-
The path to the [YAML configuration file](../../../HowTo/Configure/Use-Configuration-File.md).
34+
Path to the [YAML configuration file](../../../HowTo/Configure/Use-Configuration-File.md).
3535
The default is `none`.
3636

3737
## data-base-path, data-path
@@ -60,7 +60,7 @@ The default is `none`.
6060
data-base-path: "/home/me/me_node"
6161
```
6262

63-
The path to the Teku data directory. The default directory is OS dependent:
63+
Path to the Teku data directory. The default directory is OS-dependent:
6464

6565
* macOS: `~/Library/teku`
6666
* Unix/Linux: `$XDG_DATA_HOME/teku` if `$XDG_DATA_HOME` is set; otherwise `~/.local/share/teku`
@@ -94,7 +94,7 @@ The default Docker image location is `/root/.local/share/teku`.
9494
data-beacon-path: "/home/me/me_node"
9595
```
9696

97-
Path to the beacon chain client data. Defaults to `<data-base-path>/beacon` where `<data-base-path>`
97+
Path to the beacon chain client data. The default is `<data-base-path>/beacon` where `<data-base-path>`
9898
is specified using [`--data-base-path`](#data-base-path-data-path).
9999

100100
## network

0 commit comments

Comments
 (0)