From bf6d6eae06f22b0e6b8815eabb7ecc056062418b Mon Sep 17 00:00:00 2001 From: Roland Tyler Date: Wed, 25 Aug 2021 12:13:09 -0400 Subject: [PATCH 1/7] update sync message (#299) --- docs/HowTo/Troubleshoot/Troubleshooting.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/HowTo/Troubleshoot/Troubleshooting.md b/docs/HowTo/Troubleshoot/Troubleshooting.md index 35faa4e73..4c00e47f6 100644 --- a/docs/HowTo/Troubleshoot/Troubleshooting.md +++ b/docs/HowTo/Troubleshoot/Troubleshooting.md @@ -105,7 +105,7 @@ If all recent attestations are marked as missed, check the following: * **Is the beacon node still syncing?** Validators can only attest when the beacon node is in sync. If you see lines similar to, - `teku-event-log | Sync Event *** Current slot: 239418, Head slot: 123456`, then the node is + `teku-event-log | Syncing *** Target slot: 2017218, Head slot: 123456, Remaining slots: 2015500, Connecting peers: 12`, then the node is still syncing. Syncing is complete when the head slot reaches the current slot. If the node is synced, the From b49d9948a0b3e14dbc966ddeb7de5bbcf33f08c6 Mon Sep 17 00:00:00 2001 From: Roland Tyler Date: Mon, 30 Aug 2021 15:06:58 -0400 Subject: [PATCH 2/7] added slashing-protection repair commands (#295) --- .../CLI/Subcommands/Slashing-Protection.md | 179 ++++++++++++++++++ 1 file changed, 179 insertions(+) diff --git a/docs/Reference/CLI/Subcommands/Slashing-Protection.md b/docs/Reference/CLI/Subcommands/Slashing-Protection.md index 21b21ada8..52530916e 100644 --- a/docs/Reference/CLI/Subcommands/Slashing-Protection.md +++ b/docs/Reference/CLI/Subcommands/Slashing-Protection.md @@ -146,7 +146,186 @@ The file to export the slashing protection database to. Exports the database in the [validator client interchange format] format. +## `repair` + +Repairs corrupted slashing-protection data files used by Teku. + +### check-only-enabled + +=== "Syntax" + + ```bash + teku slashing-protection repair --checking-only-enabled[=] + ``` + +=== "Command Line" + + ```bash + teku slashing-protection repair --checking-only-enabled=false + ``` + +Reads and reports potential slashing-protection file problems, but doesn't update any files. + +### config-file + +=== "Syntax" + + ```bash + teku slashing-protection repair --config-file= + ``` + +=== "Command Line" + + ```bash + teku slashing-protection repair --config-file=/home/me/me_node/config.yaml + ``` + +The path to the YAML configuration file. +The default is `none`. + +### data-base-path, data-path + +=== "Syntax" + + ```bash + teku slashing-protection repair --data-base-path= + ``` + +=== "Command Line" + + ```bash + teku slashing-protection repair --data-base-path=/home/me/me_node + ``` + +The path to the Teku data directory. The default directory is OS dependent: + +* macOS: `~/Library/teku` +* Unix/Linux: `$XDG_DATA_HOME/teku` if `$XDG_DATA_HOME` is set; otherwise `~/.local/share/teku` +* Windows: `%localappdata%\teku`. + +The default Docker image location is `/root/.local/share/teku`. + +### data-validator-path + +=== "Syntax" + + ```bash + teku slashing-protection repair --data-validator-path= + ``` + +=== "Command Line" + + ```bash + teku slashing-protection repair --data-validator-path=/home/me/me_validator + ``` + +Path to validator client data. Defaults to `/validator` where `` +is specified using [`--data-base-path`](#data-base-path-data-path). + +### eth1-deposit-contract-address + +=== "Syntax" + + ```bash + teku slashing-protection repair --eth1-deposit-contract-address=
+ ``` + +=== "Command Line" + + ```bash + teku slashing-protection repair --eth1-deposit-contract-address=0x77f7bED277449F51505a4C54550B074030d989bC + ``` + +Ethereum 1.0 address of the deposit contract. Only required when creating a custom network. + +### initial-state + +=== "Syntax" + + ```bash + teku slashing-protection repair --initial-state= + ``` + +=== "Command Line" + + ```bash + teku slashing-protection repair --initial-state=/home/me/genesis.ssz + ``` + +Path or URL to an SSZ-encoded state file. The state file can be used to specify the genesis state, +or a [recent finalized checkpoint state from which to sync]. + +This option does not need to be specified if the initial state is provided by the network specified +using the [`--network`](#network) option. + +### network + +=== "Syntax" + + ```bash + teku slashing-protection repair --network= + ``` + +=== "Command Line" + + ```bash + teku slashing-protection repair --network=mainnet + ``` + +Predefined network configuration. Accepts a predefined network name, or file path or URL +to a YAML configuration file. The default is `mainnet`. + +Possible values are: + +| Network | Chain | Type | Description | +|-----------|---------|-------------|--------------------------------------------------| +| `mainnet` | Eth 2.0 | Production | Main network. | +| `minimal` | Eth 2.0 | Test | Used for local testing and development networks. | +| `pyrmont` | Eth 2.0 | Test | Multi-client testnet. | +| `prater` | Eth 2.0 | Test | Multi-client testnet. | + +Predefined networks can provide defaults such the initial state of the network, +bootnodes, and the address of the Ethereum 1.0 deposit contract. + +### slot + +=== "Syntax" + + ```bash + teku slashing-protection repair --slot= + ``` + +=== "Command Line" + + ```bash + teku slashing-protection repair --slot=1028 + ``` + +Updates slashing protection files to contain the specified slot as a minimum. The value should be a future +slot, or after when the validators stopped performing duties. + +!!! note + + This can be automatically calculated for most networks, and is generally not required. + +### update-all-enabled + +=== "Syntax" + + ```bash + teku slashing-protection repair --update-all-enabled[=] + ``` + +=== "Command Line" + + ```bash + teku slashing-protection repair --update-all-enabled=true + ``` + +Enables slashing protection records to be updated. Defaults to `true`. + [slashing protection data]: ../../../Concepts/Slashing-Protection.md [validator client interchange format]: https://eips.ethereum.org/EIPS/eip-3076 [environment variables or a configuration file]: ../CLI-Syntax.md#specifying-options +[recent finalized checkpoint state from which to sync]: ../../../HowTo/Get-Started/Checkpoint-Start.md From 95f23a9c566478f55b58fd611677cede864fd588 Mon Sep 17 00:00:00 2001 From: Roland Tyler Date: Tue, 31 Aug 2021 13:45:56 -0400 Subject: [PATCH 3/7] added slashing-protection repair commands (#295) --- docs/HowTo/Troubleshoot/Troubleshooting.md | 2 +- .../CLI/Subcommands/Slashing-Protection.md | 42 ++----------------- 2 files changed, 5 insertions(+), 39 deletions(-) diff --git a/docs/HowTo/Troubleshoot/Troubleshooting.md b/docs/HowTo/Troubleshoot/Troubleshooting.md index 4c00e47f6..cc542aa0f 100644 --- a/docs/HowTo/Troubleshoot/Troubleshooting.md +++ b/docs/HowTo/Troubleshoot/Troubleshooting.md @@ -105,7 +105,7 @@ If all recent attestations are marked as missed, check the following: * **Is the beacon node still syncing?** Validators can only attest when the beacon node is in sync. If you see lines similar to, - `teku-event-log | Syncing *** Target slot: 2017218, Head slot: 123456, Remaining slots: 2015500, Connecting peers: 12`, then the node is + `teku-event-log | Syncing *** Target slot: 2017218, Head slot: 123456, Remaining slots: 2015500, Connecting peers: 12`, then the node is still syncing. Syncing is complete when the head slot reaches the current slot. If the node is synced, the diff --git a/docs/Reference/CLI/Subcommands/Slashing-Protection.md b/docs/Reference/CLI/Subcommands/Slashing-Protection.md index 52530916e..57354ca91 100644 --- a/docs/Reference/CLI/Subcommands/Slashing-Protection.md +++ b/docs/Reference/CLI/Subcommands/Slashing-Protection.md @@ -165,6 +165,8 @@ Repairs corrupted slashing-protection data files used by Teku. ``` Reads and reports potential slashing-protection file problems, but doesn't update any files. +You can specify which files are checked using [`--config-file`](#config-file_2), [`--data-base-path`](#data-base-path-data-path), +or [`--network`](#network). ### config-file @@ -222,42 +224,6 @@ The default Docker image location is `/root/.local/share/teku`. Path to validator client data. Defaults to `/validator` where `` is specified using [`--data-base-path`](#data-base-path-data-path). -### eth1-deposit-contract-address - -=== "Syntax" - - ```bash - teku slashing-protection repair --eth1-deposit-contract-address=
- ``` - -=== "Command Line" - - ```bash - teku slashing-protection repair --eth1-deposit-contract-address=0x77f7bED277449F51505a4C54550B074030d989bC - ``` - -Ethereum 1.0 address of the deposit contract. Only required when creating a custom network. - -### initial-state - -=== "Syntax" - - ```bash - teku slashing-protection repair --initial-state= - ``` - -=== "Command Line" - - ```bash - teku slashing-protection repair --initial-state=/home/me/genesis.ssz - ``` - -Path or URL to an SSZ-encoded state file. The state file can be used to specify the genesis state, -or a [recent finalized checkpoint state from which to sync]. - -This option does not need to be specified if the initial state is provided by the network specified -using the [`--network`](#network) option. - ### network === "Syntax" @@ -319,10 +285,10 @@ slot, or after when the validators stopped performing duties. === "Command Line" ```bash - teku slashing-protection repair --update-all-enabled=true + teku slashing-protection repair --update-all-enabled=false ``` -Enables slashing protection records to be updated. Defaults to `true`. +Enables all slashing-protection records to be updated. Defaults to `false`. [slashing protection data]: ../../../Concepts/Slashing-Protection.md From b8011b36bcfa5be422de63c666a851a592c8c623 Mon Sep 17 00:00:00 2001 From: Roland Tyler Date: Tue, 31 Aug 2021 13:58:03 -0400 Subject: [PATCH 4/7] added slashing-protection repair commands (#295) --- docs/Reference/CLI/Subcommands/Slashing-Protection.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/Reference/CLI/Subcommands/Slashing-Protection.md b/docs/Reference/CLI/Subcommands/Slashing-Protection.md index 57354ca91..a6f6990ce 100644 --- a/docs/Reference/CLI/Subcommands/Slashing-Protection.md +++ b/docs/Reference/CLI/Subcommands/Slashing-Protection.md @@ -165,7 +165,7 @@ Repairs corrupted slashing-protection data files used by Teku. ``` Reads and reports potential slashing-protection file problems, but doesn't update any files. -You can specify which files are checked using [`--config-file`](#config-file_2), [`--data-base-path`](#data-base-path-data-path), +You can specify which files are checked using [`--config-file`](#config-file_2), [`--data-base-path`](#data-base-path-data-path), or [`--network`](#network). ### config-file From df70840822158655ab41fd00767688eda2d3ff12 Mon Sep 17 00:00:00 2001 From: Roland Tyler Date: Tue, 31 Aug 2021 16:53:06 -0400 Subject: [PATCH 5/7] added slashing-protection repair commands (#295) --- docs/Reference/CLI/Subcommands/Slashing-Protection.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/Reference/CLI/Subcommands/Slashing-Protection.md b/docs/Reference/CLI/Subcommands/Slashing-Protection.md index a6f6990ce..aa16e5efb 100644 --- a/docs/Reference/CLI/Subcommands/Slashing-Protection.md +++ b/docs/Reference/CLI/Subcommands/Slashing-Protection.md @@ -165,8 +165,8 @@ Repairs corrupted slashing-protection data files used by Teku. ``` Reads and reports potential slashing-protection file problems, but doesn't update any files. -You can specify which files are checked using [`--config-file`](#config-file_2), [`--data-base-path`](#data-base-path-data-path), -or [`--network`](#network). +You can specify which files are checked using [`--config-file`](#config-file_2), [`--data-base-path`](#data-base-path-data-path). +Adding [`--network`](#network) will get the genesis time for the specified network if you need to calculate a slot. ### config-file From b4afe2dd01b02e533191738e64d3f045d89a4b0e Mon Sep 17 00:00:00 2001 From: Roland Tyler Date: Wed, 1 Sep 2021 10:53:22 -0400 Subject: [PATCH 6/7] added slashing-protection repair commands (#295) --- docs/Reference/CLI/Subcommands/Slashing-Protection.md | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/Reference/CLI/Subcommands/Slashing-Protection.md b/docs/Reference/CLI/Subcommands/Slashing-Protection.md index aa16e5efb..ffc4a5f51 100644 --- a/docs/Reference/CLI/Subcommands/Slashing-Protection.md +++ b/docs/Reference/CLI/Subcommands/Slashing-Protection.md @@ -166,7 +166,6 @@ Repairs corrupted slashing-protection data files used by Teku. Reads and reports potential slashing-protection file problems, but doesn't update any files. You can specify which files are checked using [`--config-file`](#config-file_2), [`--data-base-path`](#data-base-path-data-path). -Adding [`--network`](#network) will get the genesis time for the specified network if you need to calculate a slot. ### config-file From f861f422b7a785762a1143b505959e3fdaae0afd Mon Sep 17 00:00:00 2001 From: Roland Tyler Date: Thu, 2 Sep 2021 11:31:02 -0400 Subject: [PATCH 7/7] added slashing-protection repair commands (#295) --- docs/Reference/CLI/CLI-Syntax.md | 40 +++++++++---------- docs/Reference/CLI/Subcommands/Admin.md | 24 +++++------ .../CLI/Subcommands/Migrate-Database.md | 6 +-- .../CLI/Subcommands/Slashing-Protection.md | 18 ++++----- .../CLI/Subcommands/Validator-Client.md | 26 ++++++------ .../CLI/Subcommands/Voluntary-Exit.md | 10 ++--- 6 files changed, 62 insertions(+), 62 deletions(-) diff --git a/docs/Reference/CLI/CLI-Syntax.md b/docs/Reference/CLI/CLI-Syntax.md index bd807798b..78da2e9ae 100644 --- a/docs/Reference/CLI/CLI-Syntax.md +++ b/docs/Reference/CLI/CLI-Syntax.md @@ -58,7 +58,7 @@ teku [OPTIONS] [COMMAND] TEKU_CONFIG_FILE=/home/me/me_node/config.yaml ``` -The path to the [YAML configuration file](../../HowTo/Configure/Use-Configuration-File.md). +Path to the [YAML configuration file](../../HowTo/Configure/Use-Configuration-File.md). The default is `none`. ### data-base-path, data-path @@ -87,7 +87,7 @@ The default is `none`. data-base-path: "/home/me/me_node" ``` -The path to the Teku data directory. The default directory is OS dependent: +Path to the Teku data directory. The default directory is OS-dependent: * macOS: `~/Library/teku` * 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`. data-beacon-path: "/home/me/me_beaon" ``` -Path to the beacon chain client data. Defaults to `/beacon` where `` +Path to the beacon chain client data. The default is `/beacon` where `` is specified using [`--data-base-path`](#data-base-path-data-path). ### data-storage-archive-frequency @@ -150,7 +150,7 @@ is specified using [`--data-base-path`](#data-base-path-data-path). data-storage-archive-frequency: 1028 ``` -Set the frequency (in slots) at which to store finalized states to disk. Defaults to 2048. +Set the frequency (in slots) at which to store finalized states to disk. The default is 2048. This option is ignored if [`--data-storage-mode`](#data-storage-mode) is set to `prune`. @@ -192,7 +192,7 @@ This option is ignored if [`--data-storage-mode`](#data-storage-mode) is set to ``` Set the strategy for handling historical chain data. Valid options are `prune` and `archive`. -Defaults to `prune`. +The default is `prune`. ### data-validator-path @@ -220,7 +220,7 @@ Defaults to `prune`. data-validator-path: "/home/me/me_validator" ``` -Path to the validator client data. Defaults to `/validator` where `` +Path to the validator client data. The default is `/validator` where `` is specified using [`--data-base-path`](#data-base-path-data-path). ### eth1-deposit-contract-address @@ -283,7 +283,7 @@ The deposit contract address can also be defined in: ``` The maximum number of blocks to request deposit contract event logs for in a single request. -Defaults to 10000. +The default is 10000. Setting a smaller max size may help if your ETH1 node is slow at loading deposit event logs, or when receiving warnings that the ETH1 node is unavailable. @@ -436,7 +436,7 @@ Default is `INFO`. ``` Specify whether status and event log messages include a console color display code. -Defaults to `true`. +The default is `true`. ### log-destination @@ -471,7 +471,7 @@ Specify where to output log information. Valid options are: * `DEFAULT_BOTH` * `FILE` -Defaults to `DEFAULT_BOTH`. When using `BOTH` or `DEFAULT_BOTH`, system updates such as blockchain +The default is `DEFAULT_BOTH`. When using `BOTH` or `DEFAULT_BOTH`, system updates such as blockchain events are displayed on the console, and errors and other information are logged to a file. Specify the log file with the [`--log-file`](#log-file) command-line option. @@ -512,7 +512,7 @@ information is available in one place. Relative or absolute location, and filename of the log file. -The default directory is OS dependent: +The default directory is OS-dependent: * macOS: `~/Library/teku/logs` * 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. ``` Specify whether to log frequent update events. For example every slot event with -validators and attestations. Defaults to `true`. +validators and attestations. The default is `true`. ### log-include-validator-duties-enabled @@ -603,7 +603,7 @@ validators and attestations. Defaults to `true`. log-include-validator-duties-enabled: false ``` -Specify whether to log details of validator event duties. Defaults to `true`. +Specify whether to log details of validator event duties. The default is `true`. !!! note Logs could become noisy when running many validators. @@ -828,7 +828,7 @@ bootnodes, and the address of the Ethereum 1.0 deposit contract. p2p-advertised-ip: "192.168.1.132" ``` -Advertised peer-to-peer IP address. Default is `127.0.0.1`. +Advertised peer-to-peer IP address. The default is `127.0.0.1`. ### p2p-enabled @@ -1186,7 +1186,7 @@ of static peers. ``` Forces the beacon node to stay subscribed to all subnets regardless of the number of validators. -Defaults to `false`. +The default is `false`. When set to `true` and running a low number of validators, Teku subscribes and unsubscribes from subnets as needed for the running validators. @@ -1232,7 +1232,7 @@ them with commas. Listed domains can access the node using HTTP REST API calls. If your client interacts with Teku using a browser app (such as a block explorer), add the client domain to the list. -The default value is "none." If you don't list any domains, browser apps can't interact with your +The default is "none." If you don't list any domains, browser apps can't interact with your Teku node. !!! tip @@ -1489,7 +1489,7 @@ When specifying file names, Teku expects that the files exist. ``` Specify whether to use Teku's built-in early attestation production, which creates an -attestation as soon as a block is received. Defaults to `true`. +attestation as soon as a block is received. The default is `true`. Set this option to `false` if running a validator client connected to a load balanced beacon node (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. ``` Specify whether to use Teku's built-in [slashing protection] when using an external signer such as -[Web3Signer]. Defaults to `true`. +[Web3Signer]. The default is `true`. Set this option to `false` if using the slashing protection implemented by an external signer. @@ -1665,7 +1665,7 @@ using Teku to sign blocks and attestations always uses its built-in slashing pro validators-external-signer-timeout: 2000 ``` -Timeout in milliseconds for requests to the external signer. Default is 1000. +Timeout in milliseconds for requests to the external signer. The default is 1000. ### validators-external-signer-truststore @@ -1844,7 +1844,7 @@ This option takes precedence over [`--validators-graffiti`](#validators-graffiti validators-keystore-locking-enabled: true ``` -Locks the keystore files listed in [`--validator-keys`](#validator-keys). Defaults to `true`. +Locks the keystore files listed in [`--validator-keys`](#validator-keys). The default is `true`. Attempts to lock all keystores in a directory if a directory is specified in [`--validator-keys`](#validator-keys). @@ -1876,7 +1876,7 @@ Attempts to lock all keystores in a directory if a directory is specified in ``` Set the validator performance tracking strategy. Valid options are `LOGGING`, `METRICS`, `ALL`, and -`NONE`. Defaults to `ALL`. +`NONE`. The default is `ALL`. When `LOGGING` is enabled, attestation and block performance is reported as log messages. When `METRICS` is enabled, attestation and block performance is reported using [metrics] in the diff --git a/docs/Reference/CLI/Subcommands/Admin.md b/docs/Reference/CLI/Subcommands/Admin.md index 66bb5c2ce..5b9010e08 100644 --- a/docs/Reference/CLI/Subcommands/Admin.md +++ b/docs/Reference/CLI/Subcommands/Admin.md @@ -40,7 +40,7 @@ Clears the stored weak subjectivity configuration. TEKU_CONFIG_FILE=/home/me/me_node/config.yaml ``` -The path to the YAML configuration file. +Path to the YAML configuration file. The default is `none`. #### data-base-path, data-path @@ -69,7 +69,7 @@ The default is `none`. data-base-path: "/home/me/me_node" ``` -The path to the Teku data directory. The default directory is OS dependent: +Path to the Teku data directory. The default directory is OS-dependent: * macOS: `~/Library/teku` * 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`. data-beacon-path: "/home/me/me_beaon" ``` -Path to the beacon chain client data. Defaults to `/beacon` where `` +Path to the beacon chain client data. The default is `/beacon` where `` is specified using [`--data-base-path`](#data-base-path-data-path). #### data-storage-archive-frequency @@ -132,7 +132,7 @@ is specified using [`--data-base-path`](#data-base-path-data-path). data-storage-archive-frequency: 1028 ``` -Set the frequency (in slots) at which to store finalized states to disk. Defaults to 2048. +Set the frequency (in slots) at which to store finalized states to disk. The default is 2048. This option is ignored if [`--data-storage-mode`](#data-storage-mode) is set to `prune`. @@ -174,7 +174,7 @@ This option is ignored if [`--data-storage-mode`](#data-storage-mode) is set to ``` Set the strategy for handling historical chain data. Valid options are `prune` and `archive`. -Defaults to `prune`. +The default is `prune`. #### data-validator-path @@ -202,7 +202,7 @@ Defaults to `prune`. data-validator-path: "/home/me/me_validator" ``` -Path to the validator client data. Defaults to `/validator` where `` +Path to the validator client data. The default is `/validator` where `` is specified using [`--data-base-path`](#data-base-path-data-path). #### eth1-deposit-contract-address @@ -298,7 +298,7 @@ Displays the stored weak subjectivity configuration. TEKU_CONFIG_FILE=/home/me/me_node/config.yaml ``` -The path to the YAML configuration file. +Path to the YAML configuration file. The default is `none`. #### data-base-path, data-path @@ -327,7 +327,7 @@ The default is `none`. data-base-path: "/home/me/me_node" ``` -The path to the Teku data directory. The default directory is OS dependent: +Path to the Teku data directory. The default directory is OS-dependent: * macOS: `~/Library/teku` * 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`. data-beacon-path: "/home/me/me_beaon" ``` -Path to the beacon chain client data. Defaults to `/beacon` where `` +Path to the beacon chain client data. The default is `/beacon` where `` is specified using [`--data-base-path`](#data-base-path-data-path). #### data-storage-archive-frequency @@ -390,7 +390,7 @@ is specified using [`--data-base-path`](#data-base-path-data-path). data-storage-archive-frequency: 1028 ``` -Set the frequency (in slots) at which to store finalized states to disk. Defaults to 2048. +Set the frequency (in slots) at which to store finalized states to disk. The default is 2048. This option is ignored if [`--data-storage-mode`](#data-storage-mode) is set to `prune`. @@ -432,7 +432,7 @@ This option is ignored if [`--data-storage-mode`](#data-storage-mode) is set to ``` Set the strategy for handling historical chain data. Valid options are `prune` and `archive`. -Defaults to `prune`. +The default is `prune`. #### data-validator-path @@ -460,7 +460,7 @@ Defaults to `prune`. data-validator-path: "/home/me/me_validator" ``` -Path to the validator client data. Defaults to `/validator` where `` +Path to the validator client data. The default is `/validator` where `` is specified using [`--data-base-path`](#data-base-path-data-path). #### eth1-deposit-contract-address diff --git a/docs/Reference/CLI/Subcommands/Migrate-Database.md b/docs/Reference/CLI/Subcommands/Migrate-Database.md index ed197a3dd..cead3c6e6 100644 --- a/docs/Reference/CLI/Subcommands/Migrate-Database.md +++ b/docs/Reference/CLI/Subcommands/Migrate-Database.md @@ -31,7 +31,7 @@ title: Database migration subcommand options TEKU_CONFIG_FILE=/home/me/me_node/config.yaml ``` -The path to the [YAML configuration file](../../../HowTo/Configure/Use-Configuration-File.md). +Path to the [YAML configuration file](../../../HowTo/Configure/Use-Configuration-File.md). The default is `none`. ## data-base-path, data-path @@ -60,7 +60,7 @@ The default is `none`. data-base-path: "/home/me/me_node" ``` -The path to the Teku data directory. The default directory is OS dependent: +Path to the Teku data directory. The default directory is OS-dependent: * macOS: `~/Library/teku` * 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`. data-beacon-path: "/home/me/me_node" ``` -Path to the beacon chain client data. Defaults to `/beacon` where `` +Path to the beacon chain client data. The default is `/beacon` where `` is specified using [`--data-base-path`](#data-base-path-data-path). ## network diff --git a/docs/Reference/CLI/Subcommands/Slashing-Protection.md b/docs/Reference/CLI/Subcommands/Slashing-Protection.md index ffc4a5f51..cb962a142 100644 --- a/docs/Reference/CLI/Subcommands/Slashing-Protection.md +++ b/docs/Reference/CLI/Subcommands/Slashing-Protection.md @@ -37,7 +37,7 @@ Imports the slashing protection database using the [validator client interchange TEKU_CONFIG_FILE=/home/me/me_node/config.yaml ``` -The path to the YAML configuration file. +Path to the YAML configuration file. The default is `none`. ### data-path @@ -54,7 +54,7 @@ The default is `none`. teku slashing-protection import --data-path=/home/me/me_node ``` -The path to the Teku data directory. The default directory is OS dependent: +Path to the Teku data directory. The default directory is OS-dependent: * macOS: `~/Library/teku` * Unix/Linux: `$XDG_DATA_HOME/teku` if `$XDG_DATA_HOME` is set; otherwise `~/.local/share/teku` @@ -105,7 +105,7 @@ Exports the slashing protection database in the [validator client interchange fo TEKU_CONFIG_FILE=/home/me/me_node/config.yaml ``` -The path to the YAML configuration file. +Path to the YAML configuration file. The default is `none`. ### data-path @@ -122,7 +122,7 @@ The default is `none`. teku slashing-protection export --data-path=/home/me/me_node ``` -The path to the Teku data directory. The default directory is OS dependent: +Path to the Teku data directory. The default directory is OS-dependent: * macOS: `~/Library/teku` * Unix/Linux: `$XDG_DATA_HOME/teku` if `$XDG_DATA_HOME` is set; otherwise `~/.local/share/teku` @@ -181,7 +181,7 @@ You can specify which files are checked using [`--config-file`](#config-file_2), teku slashing-protection repair --config-file=/home/me/me_node/config.yaml ``` -The path to the YAML configuration file. +Path to the YAML configuration file. The default is `none`. ### data-base-path, data-path @@ -198,11 +198,11 @@ The default is `none`. teku slashing-protection repair --data-base-path=/home/me/me_node ``` -The path to the Teku data directory. The default directory is OS dependent: +Path to the Teku data directory. The default directory is OS-dependent: * macOS: `~/Library/teku` * Unix/Linux: `$XDG_DATA_HOME/teku` if `$XDG_DATA_HOME` is set; otherwise `~/.local/share/teku` -* Windows: `%localappdata%\teku`. +* Windows: `%localappdata%\teku` The default Docker image location is `/root/.local/share/teku`. @@ -220,7 +220,7 @@ The default Docker image location is `/root/.local/share/teku`. teku slashing-protection repair --data-validator-path=/home/me/me_validator ``` -Path to validator client data. Defaults to `/validator` where `` +Path to validator client data. The default is `/validator` where `` is specified using [`--data-base-path`](#data-base-path-data-path). ### network @@ -287,7 +287,7 @@ slot, or after when the validators stopped performing duties. teku slashing-protection repair --update-all-enabled=false ``` -Enables all slashing-protection records to be updated. Defaults to `false`. +Enables all slashing-protection records to be updated. The default is `false`. [slashing protection data]: ../../../Concepts/Slashing-Protection.md diff --git a/docs/Reference/CLI/Subcommands/Validator-Client.md b/docs/Reference/CLI/Subcommands/Validator-Client.md index 4af88a270..f95dc466b 100644 --- a/docs/Reference/CLI/Subcommands/Validator-Client.md +++ b/docs/Reference/CLI/Subcommands/Validator-Client.md @@ -47,7 +47,7 @@ You can also supply the subcommand options using [environment variables or a con beacon-node-api-endpoint: "http://192.138.10.12" ``` -Endpoint of the beacon node's REST API. Default is `http://127.0.0.1:5051`. +Endpoint of the beacon node's REST API. The default is `http://127.0.0.1:5051`. ### config-file @@ -69,7 +69,7 @@ Endpoint of the beacon node's REST API. Default is `http://127.0.0.1:5051`. TEKU_CONFIG_FILE=/home/me/me_node/config.yaml ``` -The path to the YAML configuration file. +Path to the YAML configuration file. The default is `none`. ### data-base-path, data-path @@ -98,7 +98,7 @@ The default is `none`. data-base-path: "/home/me/me_node" ``` -The path to the Teku base directory for storage. The default directory is OS dependent: +Path to the Teku base directory for storage. The default directory is OS-dependent: * macOS: `~/Library/teku` * Unix/Linux: `$XDG_DATA_HOME/teku` if `$XDG_DATA_HOME` is set; otherwise `~/.local/share/teku` @@ -132,7 +132,7 @@ The default Docker image location is `/root/.local/share/teku`. data-validator-path: "/home/me/me_validator" ``` -Path to the validator client data. Defaults to `/validator` where `` +Path to the validator client data. The default is `/validator` where `` is specified using [`--data-base-path`](#data-base-path-data-path). ### initial-state @@ -194,7 +194,7 @@ using the [`--network`](#network) option. ``` Specify whether status and event log messages include a console color display code. -Defaults to `true`. +The default is `true`. ### log-destination @@ -229,7 +229,7 @@ Specify where to output log information. Valid options are: * `DEFAULT_BOTH` * `FILE` -Defaults to `DEFAULT_BOTH`. When using `BOTH` or `DEFAULT_BOTH`, system updates such as blockchain +The default is `DEFAULT_BOTH`. When using `BOTH` or `DEFAULT_BOTH`, system updates such as blockchain events are displayed on the console, and errors and other information are logged to a file. Specify the log file with the [`--log-file`](#log-file) command-line option. @@ -270,7 +270,7 @@ information is available in one place. Relative or absolute location, and filename of the log file. -The default directory is OS dependent: +The default directory is OS-dependent: * macOS: `~/Library/teku/logs` * Unix/Linux: `$XDG_DATA_HOME/teku/logs` if `$XDG_DATA_HOME` is set; otherwise `~/.local/share/teku/logs` @@ -333,7 +333,7 @@ Filename pattern to apply when creating log files. ``` Specify whether to log frequent update events. For example every slot event with -validators and attestations. Defaults to `true`. +validators and attestations. The default is `true`. ### log-include-validator-duties-enabled @@ -361,7 +361,7 @@ validators and attestations. Defaults to `true`. log-include-validator-duties-enabled: true ``` -Specify whether to log details of validator event duties. Defaults to `false`. +Specify whether to log details of validator event duties. The default is `false`. !!! note Logs could become noisy when running many validators. @@ -657,7 +657,7 @@ List of validator public keys used by an external signer (for example, [Web3Sign ``` Specify whether to use Teku's built-in [slashing protection] when using an external signer such as -[Web3Signer]. Defaults to `true`. +[Web3Signer]. The default is `true`. Set this option to `false` if using the slashing protection implemented by an external signer. @@ -695,7 +695,7 @@ using Teku to sign blocks and attestations always uses its built-in slashing pro validators-external-signer-timeout: 2000 ``` -Timeout in milliseconds for requests to the external signer. Default is 1000. +Timeout in milliseconds for requests to the external signer. The default is 1000. ### validators-external-signer-url @@ -781,7 +781,7 @@ The same graffiti is used for all validators started with this beacon node. validators-keystore-locking-enabled: true ``` -Locks the keystore files listed in [`--validator-keys`](#validator-keys). Defaults to `true`. +Locks the keystore files listed in [`--validator-keys`](#validator-keys). The default is `true`. Attempts to lock all keystores in a directory if a directory is specified in [`--validator-keys`](#validator-keys). @@ -813,7 +813,7 @@ Attempts to lock all keystores in a directory if a directory is specified in ``` Set the validator performance tracking strategy. Valid options are `LOGGING`, `METRICS`, `ALL`, and -`NONE`. Defaults to `ALL`. +`NONE`. The default is `ALL`. When `LOGGING` is enabled, attestation and block performance is reported as log messages. When `METRICS` is enabled, attestation and block performance is reported using [metrics] in the diff --git a/docs/Reference/CLI/Subcommands/Voluntary-Exit.md b/docs/Reference/CLI/Subcommands/Voluntary-Exit.md index b878fb1b2..97c4f3f13 100644 --- a/docs/Reference/CLI/Subcommands/Voluntary-Exit.md +++ b/docs/Reference/CLI/Subcommands/Voluntary-Exit.md @@ -34,7 +34,7 @@ Create and sign a voluntary exit for the specified validator or set of validator beacon-node-api-endpoint: "http://192.138.10.12" ``` -Endpoint of the beacon node's REST API. Default is `http://127.0.0.1:5051`. +Endpoint of the beacon node's REST API. The default is `http://127.0.0.1:5051`. ### config-file @@ -56,7 +56,7 @@ Endpoint of the beacon node's REST API. Default is `http://127.0.0.1:5051`. TEKU_CONFIG_FILE=/home/me/me_node/config.yaml ``` -The path to the YAML configuration file. +Path to the YAML configuration file. The default is `none`. ### confirmation-enabled @@ -85,7 +85,7 @@ The default is `none`. confirmation-enabled: false ``` -Specify whether to request confirmation when exiting a validator. Defaults to `true`. +Specify whether to request confirmation when exiting a validator. The default is `true`. !!! danger @@ -113,7 +113,7 @@ Specify whether to request confirmation when exiting a validator. Defaults to `t ``` Earliest epoch that the voluntary exit can be processed. The specified epoch can be a past epoch, -or current epoch. You cannot specify a future epoch. Defaults to the current epoch. +or current epoch. You cannot specify a future epoch. The default is the current epoch. !!! note @@ -220,7 +220,7 @@ List of public keys of validators that you wish to voluntarily exit when using a validators-external-signer-timeout: 2000 ``` -Timeout in milliseconds for requests to the external signer. Default is 1000. +Timeout in milliseconds for requests to the external signer. The default is 1000. ### validators-external-signer-url