diff --git a/docs/reference/cli/index.md b/docs/reference/cli/index.md index 45a423692..ec58c5130 100644 --- a/docs/reference/cli/index.md +++ b/docs/reference/cli/index.md @@ -53,7 +53,7 @@ teku --Tab+Tab ## Options -### beacon-liveness-tracking-enabled +### `beacon-liveness-tracking-enabled` @@ -88,7 +88,7 @@ beacon-liveness-tracking-enabled: true Enables or disables validator liveness tracking. Used by [doppelganger detection](../../how-to/enable-doppelganger-detection.md). The default is `false`. -### builder-bid-compare-factor +### `builder-bid-compare-factor` @@ -129,7 +129,7 @@ Use this option to set the compare factor applied to the builder bid value when Set this option to `BUILDER_ALWAYS` to always use the builder bid, unless the bid is invalid. -### builder-endpoint +### `builder-endpoint` @@ -164,7 +164,7 @@ builder-endpoint: "http://127.0.0.1:18550" The address for an external [builder endpoint](../../how-to/configure/builder-network.md). -### builder-set-user-agent-header +### `builder-set-user-agent-header` @@ -199,7 +199,7 @@ builder-set-user-agent-header: true Set the User-Agent header to `teku/v` (for example, `teku/v23.4.0`) when making a builder bid request to help builders identify clients and versions. The default is `true`. -### checkpoint-sync-url +### `checkpoint-sync-url` @@ -244,7 +244,7 @@ See [this community-maintained list of checkpoint state endpoints](https://eth-c When this option is set, and `--deposit-snapshot-enabled` is also not set or disabled, the `--checkpoint-sync-url` value will be used to determine the deposit snapshot. -### config-file +### `config-file` @@ -272,7 +272,7 @@ TEKU_CONFIG_FILE=/home/me/me_node/config.yaml Path to the [YAML configuration file](../../how-to/configure/use-config-file.md). The default is `none`. -### data-base-path, data-path +### `data-base-path`, `data-path` @@ -313,7 +313,7 @@ Path to the Teku data directory. The default directory is OS-dependent: The default Docker image location is `/root/.local/share/teku`. -### data-beacon-path +### `data-beacon-path` @@ -348,7 +348,7 @@ data-beacon-path: "/home/me/me_beaon" Path to the beacon node data. The default is `/beacon` where `` is specified using [`--data-base-path`](#data-base-path-data-path). -### data-storage-archive-frequency +### `data-storage-archive-frequency` @@ -393,7 +393,7 @@ Specifying a larger number of slots as the archive frequency has a potentially h For example, `--data-storage-archive-frequency=1` uses maximum disk space but has the lowest response time for retrieving a finalized state since each slot state is saved, whereas `--data-storage-archive-frequency=2048` uses less disk space, but may need to regenerate the state because every 2048th slot state is saved. -### data-storage-mode +### `data-storage-mode` @@ -434,7 +434,7 @@ Set the strategy for handling historical chain data. Valid options are: The default is `minimal`. -### data-storage-non-canonical-blocks-enabled +### `data-storage-non-canonical-blocks-enabled` @@ -469,7 +469,7 @@ data-storage-non-canonical-blocks-enabled: true Specify whether to store non-canonical blocks and blob sidecars. The default is `false`. -### data-validator-path +### `data-validator-path` @@ -505,7 +505,7 @@ data-validator-path: "/home/me/me_validator" Path to the validator client data. The default is `/validator` where `` is specified using [`--data-base-path`](#data-base-path-data-path). -### deposit-snapshot-enabled +### `deposit-snapshot-enabled` @@ -555,7 +555,7 @@ deposit tree snapshot. When this option is not set or is disabled, the `--checkpoint-sync-url` value will be used if provided to find the deposit snapshot URL. -### doppelganger-detection-enabled +### `doppelganger-detection-enabled` @@ -591,7 +591,7 @@ doppelganger-detection-enabled: true Enables or disables [doppelganger detection](../../how-to/enable-doppelganger-detection.md). The default is `false`. -### ee-endpoint +### `ee-endpoint` @@ -626,7 +626,7 @@ ee-endpoint: "http://localhost:8550" URL of the [execution client's](../../concepts/merge.md#execution-clients) Engine JSON-RPC APIs. This replaces [`eth1-endpoint`](#eth1-endpoint-eth1-endpoints) after [The Merge](../../concepts/merge.md). -### ee-jwt-secret-file +### `ee-jwt-secret-file` @@ -661,7 +661,7 @@ ee-jwt-secret-file: "ee-jwt-secret.hex" Shared secret used to authenticate [execution clients](../../concepts/merge.md#execution-and-consensus-clients) when using the Engine JSON-RPC API. Contents of file must be 32 hex-encoded bytes. May be a relative or absolute path. See an [example of how to generate this](../../get-started/connect/mainnet.md#1-generate-the-shared-secret). -### eth1-deposit-contract-address +### `eth1-deposit-contract-address` @@ -701,7 +701,7 @@ The deposit contract address can also be defined in: - The genesis file specified using [`--initial-state`](#initial-state) - The predefined network supplied using [`--network`](#network). -### eth1-deposit-contract-max-request-size +### `eth1-deposit-contract-max-request-size` @@ -738,7 +738,7 @@ The maximum number of blocks to request deposit contract event logs for in a sin 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. -### eth1-endpoint, eth1-endpoints +### `eth1-endpoint`, `eth1-endpoints` @@ -783,7 +783,7 @@ After [The Merge](../../concepts/merge.md), you can't use `eth1-endpoint` to spe ::: -### exchange-capabilities-monitoring-enabled +### `exchange-capabilities-monitoring-enabled` @@ -818,7 +818,7 @@ exchange-capabilities-monitoring-enabled: true Enables or disables querying the [execution client](../../concepts/merge.md#execution-clients) periodically for the Engine API methods it supports. If enabled and incompatibility is detected, a warning is raised in the logs. The default is `true`. -### exit-when-no-validator-keys-enabled +### `exit-when-no-validator-keys-enabled` @@ -852,7 +852,7 @@ exit-when-no-validator-keys-enabled: true -If set to `true` Teku won't start if validators have not been loaded, or there are no active validators. The default is `false`. +The default is `false`. If set to `true` Teku won't start if validators have not been loaded, or there are no active validators. :::important @@ -861,7 +861,7 @@ This option should be used on the client loading the validator keys. ::: -### genesis-state +### `genesis-state` @@ -910,7 +910,7 @@ If overriding the genesis state in a custom network, you must supply the genesis ::: -### help +### `help` ```bash title="Syntax" -h, --help @@ -918,7 +918,7 @@ If overriding the genesis state in a custom network, you must supply the genesis Show the help message and exit. -### ignore-weak-subjectivity-period-enabled +### `ignore-weak-subjectivity-period-enabled` @@ -959,7 +959,7 @@ The default is `false`. Syncing from outside the weak subjectivity period is considered unsafe. ::: -### initial-state +### `initial-state` @@ -1008,7 +1008,7 @@ See [this community-maintained list of checkpoint state endpoints](https://eth-c ::: -### log-color-enabled +### `log-color-enabled` @@ -1043,7 +1043,7 @@ log-color-enabled: false Specify whether status and event log messages include a console color display code. The default is `true`. -### log-destination +### `log-destination` @@ -1093,7 +1093,7 @@ Use `DEFAULT_BOTH` when using a [custom Log4J2 configuration file](../../how-to/ ::: -### log-file +### `log-file` @@ -1136,7 +1136,7 @@ The default directory is OS-dependent: The default Docker image location is `/root/.local/share/teku/logs`. -### log-file-name-pattern +### `log-file-name-pattern` @@ -1171,7 +1171,7 @@ log-file-name-pattern: "tekuL_%d{yyyy-MM-dd}.log" Filename pattern to apply when creating log files. The default pattern is `teku_%d{yyyy-MM-dd}.log` -### log-include-events-enabled +### `log-include-events-enabled` @@ -1206,7 +1206,7 @@ log-include-events-enabled: false Specify whether to log frequent update events. For example every slot event with validators and attestations. The default is `true`. -### log-include-validator-duties-enabled +### `log-include-validator-duties-enabled` @@ -1247,7 +1247,7 @@ Logs could become noisy when running many validators. ::: -### logging +### `logging` @@ -1282,7 +1282,7 @@ logging: "DEBUG" Sets the logging verbosity. Log levels are `OFF`, `FATAL`, `ERROR`, `WARN`, `INFO`, `DEBUG`, `TRACE`, `ALL`. Default is `INFO`. -### metrics-block-timing-tracking-enabled +### `metrics-block-timing-tracking-enabled` @@ -1317,7 +1317,7 @@ metrics-block-timing-tracking-enabled: false Enables or disables block timing metrics. The default is `true`. -### metrics-categories +### `metrics-categories` @@ -1354,7 +1354,7 @@ Categories for which to track metrics. Options are `JVM`, `PROCESS`, `BEACON`, ` When `metrics-categories` is used, only the categories specified in this option are enabled (all other categories are disabled). -### metrics-enabled +### `metrics-enabled` @@ -1389,7 +1389,7 @@ metrics-enabled: true Set to `true` to enable the metrics exporter. The default is `false`. -### metrics-host-allowlist +### `metrics-host-allowlist @@ -1430,7 +1430,7 @@ To allow all hostnames, use `"*"`. We don't recommend allowing all hostnames for ::: -### metrics-interface +### `metrics-interface` @@ -1465,7 +1465,7 @@ metrics-interface: "192.168.10.101" Host on which Prometheus accesses Teku metrics. The default is `127.0.0.1`. -### metrics-port +### `metrics-port` @@ -1500,7 +1500,7 @@ metrics-port: 6174 Specifies the port (TCP) on which [Prometheus](https://prometheus.io/) accesses Teku metrics. The default is `8008`. -### metrics-publish-endpoint +### `metrics-publish-endpoint` @@ -1535,7 +1535,7 @@ metrics-publish-endpoint: "https://beaconcha.in/api/v1/client/metrics?apikey={ap Endpoint URL of an external service such as [beaconcha.in](https://beaconcha.in/) to which Teku publishes metrics for node monitoring. -### metrics-publish-interval +### `metrics-publish-interval` @@ -1570,7 +1570,7 @@ metrics-publish-interval: "60" Interval between metric publications to the external service defined in [metrics-publish-endpoint](#metrics-publish-endpoint), measured in seconds. The default is `60`. -### network +### `network` @@ -1622,7 +1622,7 @@ Possible values are: Predefined networks can provide defaults such as the initial state of the network, bootnodes, and the address of the deposit contract. -### p2p-advertised-ip +### `p2p-advertised-ip` @@ -1657,7 +1657,7 @@ p2p-advertised-ip: "192.168.1.132" Advertised peer-to-peer IP address. The default is `127.0.0.1`. -### p2p-advertised-port +### `p2p-advertised-port` @@ -1694,7 +1694,7 @@ The advertised P2P port. The default is the port specified in [`--p2p-port`](#p2 The advertised port can differ from the [`--p2p-port`](#p2p-port). For example, you can set the advertised port to 9010, and the `--p2p-port` value to 9009, then manually configure the firewall to forward external incoming requests on port 9010 to port 9009 on the Teku node. -### p2p-advertised-udp-port +### `p2p-advertised-udp-port` @@ -1730,7 +1730,7 @@ p2p-advertised-udp-port: 1789 The advertised UDP port to external peers. The default is the port specified in [`--p2p-advertised-port`](#p2p-advertised-port) if it is set. Otherwise, the default is the port specified in [`--p2p-port`](#p2p-port). -### p2p-discovery-bootnodes +### `p2p-discovery-bootnodes` @@ -1768,7 +1768,7 @@ List of comma-separated Ethereum Node Records (ENRs) for P2P discovery bootstrap -### p2p-discovery-enabled +### `p2p-discovery-enabled` @@ -1803,7 +1803,7 @@ p2p-discovery-enabled: false Enables or disables P2P peer discovery. If disabled, [`p2p-static-peers`](#p2p-static-peers) defines the peer connections. The default is `true`. -### p2p-discovery-site-local-addresses-enabled +### `p2p-discovery-site-local-addresses-enabled` @@ -1848,7 +1848,7 @@ Normal Teku operation shouldn't send traffic to these local network addresses. In test or private networks, operators might need to enable discovery of local addresses. For example, when you run multiple consensus layer nodes in one local network, these nodes are not discovered on the public internet and are advertised with local (RFC1918) addresses. -### p2p-enabled +### `p2p-enabled` @@ -1883,7 +1883,7 @@ p2p-enabled: false Enables or disables all P2P communication. The default is `true`. -### p2p-interface +### `p2p-interface` @@ -1918,7 +1918,7 @@ p2p-interface: "192.168.1.132" Specifies the network interface on which the node listens for P2P communication. The default is `0.0.0.0` (all interfaces). -### p2p-nat-method +### `p2p-nat-method` @@ -1961,7 +1961,7 @@ UPnP support is often disabled by default in networking firmware. If disabled by ::: -### p2p-peer-lower-bound +### `p2p-peer-lower-bound` @@ -1996,7 +1996,7 @@ p2p-peer-lower-bound: 25 Lower bound on the target number of peers. Teku will actively seek new peers if the number of peers falls below this value. The default is `64`. -### p2p-peer-upper-bound +### `p2p-peer-upper-bound` @@ -2031,7 +2031,7 @@ p2p-peer-upper-bound: 40 Upper bound on the target number of peers. Teku will refuse new peer requests that would cause the number of peers to exceed this value. The default is `100`. -### p2p-port +### `p2p-port` @@ -2069,7 +2069,7 @@ p2p-port: 1789 Specifies the P2P listening ports (UDP and TCP). The default is `9000`. -### p2p-private-key-file +### `p2p-private-key-file` @@ -2104,7 +2104,7 @@ p2p-private-key-file: "/home/me/me_node/key" File containing the [node's private key](../../concepts/p2p-private-key.md). -### p2p-static-peers +### `p2p-static-peers` @@ -2140,10 +2140,7 @@ p2p-static-peers: ["/ip4/151.150.191.80/tcp/9000/p2p/16Ui...aXRz", List of comma-separated [multiaddresses](https://docs.libp2p.io/concepts/appendix/glossary/#multiaddr) of static peers. - - - -### p2p-subscribe-all-subnets-enabled +### `p2p-subscribe-all-subnets-enabled` @@ -2188,7 +2185,7 @@ When set to `true`, Teku uses more CPU and bandwidth, and for most users there ::: -### p2p-udp-port +### `p2p-udp-port` @@ -2223,7 +2220,7 @@ p2p-udp-port: 1789 The UDP port used for discovery. The default is the port specified in [`--p2p-port`](#p2p-port). -### reconstruct-historic-states +### `reconstruct-historic-states` @@ -2260,7 +2257,7 @@ When set to `true` the [Reconstruct Historical States Service](../../how-to/reco When set to `false` this service is not enabled. -### rest-api-cors-origins +### `rest-api-cors-origins` @@ -2305,7 +2302,7 @@ For testing and development purposes, use `*` to accept requests from any domain ::: -### rest-api-docs-enabled +### `rest-api-docs-enabled` @@ -2345,7 +2342,7 @@ The documentation can be accessed at `http://:/swagger-ui` wher - `interface` is specified using [`--rest-api-interface`](#rest-api-interface) - `port` is specified using [`--rest-api-port`](#rest-api-port) -### rest-api-enabled +### `rest-api-enabled` @@ -2382,7 +2379,7 @@ Set to `true` to enable the [REST API service](../rest.md). The default is `fals If set to `true`, then use [`--rest-api-host-allowlist`](#rest-api-host-allowlist) to limit access to trusted parties. -### rest-api-host-allowlist +### `rest-api-host-allowlist` @@ -2425,7 +2422,7 @@ We don't recommend allowing all hostnames (`"*"`) for production environments. ::: -### rest-api-interface +### `rest-api-interface` @@ -2461,7 +2458,7 @@ rest-api-interface: "0.0.0.0" Specifies the interface on which the REST API listens. The default is `127.0.0.1`. -### rest-api-port +### `rest-api-port` @@ -2497,7 +2494,7 @@ rest-api-port: 3435 Specifies REST API listening port (HTTP). The default is 5051. -### sentry-config-file +### `sentry-config-file` @@ -2538,9 +2535,7 @@ This option can't be used with [`--beacon-node-api-endpoint`](subcommands/valida ::: - - -### validator-api-cors-origins +### `validator-api-cors-origins` @@ -2585,7 +2580,7 @@ For testing and development purposes, use `*` to accept requests from any domain ::: -### validator-api-docs-enabled +### `validator-api-docs-enabled` @@ -2625,7 +2620,7 @@ When enabling the API documentation endpoint, you must also specify: - `interface` by using [`--validator-api-interface`](#validator-api-interface). - `port` by using [`--validator-api-port`](#validator-api-port). -### validator-api-enabled +### `validator-api-enabled` @@ -2662,7 +2657,7 @@ Set to `true` to enable the [validator client API](../rest.md#enable-the-validat If set to `true`, then use [`--validator-api-host-allowlist`](#validator-api-host-allowlist) to limit access to trusted parties. -### validator-api-host-allowlist +### `validator-api-host-allowlist` @@ -2705,7 +2700,7 @@ We don't recommend allowing all hostnames (`"*"`) for production environments. ::: -### validator-api-interface +### `validator-api-interface` @@ -2741,7 +2736,7 @@ validator-api-interface: "0.0.0.0" The interface on which the [validator REST API](../rest.md#enable-the-validator-client-api) listens. The default is `127.0.0.1`. -### validator-api-keystore-file +### `validator-api-keystore-file` @@ -2776,7 +2771,7 @@ validator-api-keystore-file: "validator_keystore.p12" Keystore file for the [validator REST API](../rest.md#enable-the-validator-client-api). Teku can use PKCS12 or JKS keystore types. You must [create a keystore](../../how-to/use-external-signer/manage-keys.md#create-a-keystore) to enable access. -### validator-api-keystore-password-file +### `validator-api-keystore-password-file` @@ -2811,7 +2806,7 @@ validator-api-keystore-password-file: "validator_keystore_pass.txt" Password used to decrypt the keystore for the [validator REST API](../rest.md#enable-the-validator-client-api). -### validator-api-port +### `validator-api-port` @@ -2847,7 +2842,7 @@ validator-api-port: 5052 The [validator REST API](../rest.md#enable-the-validator-client-api) listening port (HTTP). The default is 5052. -### validators-builder-registration-default-enabled +### `validators-builder-registration-default-enabled` @@ -2882,7 +2877,7 @@ validators-builder-registration-default-enabled: true Set to `true` to have all validators managed by the validator client register to the [builder endpoint](../../how-to/configure/builder-network.md) when proposing a block. -### validators-early-attestations-enabled +### `validators-early-attestations-enabled` @@ -2925,7 +2920,7 @@ Delaying attestation production increases the chances of generating a correct at ::: -### validators-external-signer-keystore +### `validators-external-signer-keystore` @@ -2962,7 +2957,7 @@ The keystore that Teku presents to the external signer for TLS authentication. T Use the PKCS12 keystore type if connecting to Web3Signer. -### validators-external-signer-keystore-password-file +### `validators-external-signer-keystore-password-file` @@ -2997,7 +2992,7 @@ validators-external-signer-keystore-password-file: "keystore_pass.txt" Password file used to decrypt the keystore. -### validators-external-signer-public-keys +### `validators-external-signer-public-keys` @@ -3052,7 +3047,7 @@ You can [load new validators without restarting Teku] if you specify a URL from Ensure the external signer is running before starting Teku. -### validators-external-signer-slashing-protection-enabled +### `validators-external-signer-slashing-protection-enabled` @@ -3097,7 +3092,7 @@ Ensure the external signer has slashing protection enabled before disabling Teku Built-in slashing protection can only be disabled for validators using external signers. Validators using Teku to sign blocks and attestations always uses its built-in slashing protection. -### validators-external-signer-timeout +### `validators-external-signer-timeout` @@ -3132,7 +3127,7 @@ validators-external-signer-timeout: 2000 Timeout in milliseconds for requests to the external signer. The default is 5000. -### validators-external-signer-truststore +### `validators-external-signer-truststore` @@ -3167,7 +3162,7 @@ validators-external-signer-truststore: "websigner_truststore.p12" PKCS12 or JKS keystore used to trust external signer's self-signed certificate or CA certificate which signs the external signer's certificate. -### validators-external-signer-truststore-password-file +### `validators-external-signer-truststore-password-file` @@ -3202,7 +3197,7 @@ validators-external-signer-truststore-password-file: "truststore_pass.txt" Password file used to decrypt the keystore. -### validators-external-signer-url +### `validators-external-signer-url` @@ -3237,7 +3232,7 @@ validators-external-signer-url: "http://localhost:9000" URL on which the external signer (for example, Web3Signer) is running. -### validators-graffiti +### `validators-graffiti` @@ -3276,7 +3271,7 @@ The same graffiti is used for all validators started with this beacon node. [`--validators-graffiti-file`](#validators-graffiti-file) takes precedence if both options are set. -### validators-graffiti-file +### `validators-graffiti-file` @@ -3315,7 +3310,7 @@ You can overwrite the file while Teku is running to update the graffiti. This option takes precedence over [`--validators-graffiti`](#validators-graffiti). -### validator-keys +### `validator-keys` @@ -3373,7 +3368,7 @@ The path separator is operating system dependent, and should be `;` in Windows r ::: -### validators-keystore-locking-enabled +### `validators-keystore-locking-enabled` @@ -3410,7 +3405,7 @@ Locks the keystore files listed in [`--validator-keys`](#validator-keys). The de Attempts to lock all keystores in a directory if a directory is specified in [`--validator-keys`](#validator-keys). -### validators-performance-tracking-mode +### `validators-performance-tracking-mode` @@ -3447,7 +3442,7 @@ Set the validator performance tracking strategy. Valid options are `LOGGING`, `M 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 [`VALIDATOR_PERFORMANCE`](#metrics-categories) metrics category. -### validators-proposer-blinded-blocks-enabled +### `validators-proposer-blinded-blocks-enabled` @@ -3482,7 +3477,7 @@ validators-proposer-blinded-blocks-enabled: true Set to `true` to enable blinded blocks production, a prerequisite for the [builder network](../../how-to/configure/builder-network.md). When [`--validators-builder-registration-default-enabled`](#validators-builder-registration-default-enabled) is enabled this option is enabled automatically. The default is `false`. -### validators-proposer-config +### `validators-proposer-config` @@ -3517,7 +3512,7 @@ validators-proposer-config: "/home/me/node/proposerConfig.json" Remote URL or local file path to the [proposer configuration file](../../how-to/configure/use-proposer-config-file.md). -### validators-proposer-config-refresh-enabled +### `validators-proposer-config-refresh-enabled` @@ -3552,7 +3547,7 @@ validators-proposer-config-refresh-enabled: true Set to `true` to enable reloading the [proposer configuration](../../how-to/configure/use-proposer-config-file.md) on every proposer preparation (once per epoch). The default is `false`. -### validators-proposer-default-fee-recipient +### `validators-proposer-default-fee-recipient` @@ -3595,7 +3590,7 @@ The specified fee recipient is used in rare cases when a validator requests a bl ::: -### version +### `version` ```bash title="Syntax" -V, --version @@ -3603,7 +3598,7 @@ The specified fee recipient is used in rare cases when a validator requests a bl Displays the version and exits. -### ws-checkpoint +### `ws-checkpoint` diff --git a/docs/reference/cli/subcommands/development.md b/docs/reference/cli/subcommands/development.md index d0d52bdc7..e05bf85e2 100644 --- a/docs/reference/cli/subcommands/development.md +++ b/docs/reference/cli/subcommands/development.md @@ -8,14 +8,19 @@ sidebar_position: 7 The following subcommands are used for development and testing purposes. -## `transition` +## `genesis` -Manually run state transitions for blocks or slots for debugging. +Generate a genesis state for a network. ```bash -teku transition +teku genesis ``` + + +[environment variables]: ../index.md##teku-environment-variables +[configuration file]: ../../../how-to/configure/use-config-file.md + ## `peer` Generate a list of peer IDs, including the private key, public key, and peer ID. @@ -24,15 +29,10 @@ Generate a list of peer IDs, including the private key, public key, and peer ID. teku peer ``` -## `genesis` +## `transition` -Generate a genesis state for a network. +Manually run state transitions for blocks or slots for debugging. ```bash -teku genesis -``` - - - -[environment variables]: ../index.md##teku-environment-variables -[configuration file]: ../../../how-to/configure/use-config-file.md +teku transition +``` \ No newline at end of file diff --git a/docs/reference/cli/subcommands/slashing-protection.md b/docs/reference/cli/subcommands/slashing-protection.md index 01380caab..dd78a9fc5 100644 --- a/docs/reference/cli/subcommands/slashing-protection.md +++ b/docs/reference/cli/subcommands/slashing-protection.md @@ -10,15 +10,9 @@ import TabItem from '@theme/TabItem'; Manage the local [slashing protection data] used by the validator. -## `import` - -Imports the slashing protection database using the [validator client interchange format]. - -:::caution - -Before running the import, you must stop the validator and confirm the process has fully exited and won't be restarted. +## `export` -::: +Exports the slashing protection database in the [validator client interchange format] format. ### `config-file` @@ -26,14 +20,14 @@ Before running the import, you must stop the validator and confirm the process h ```bash -teku slashing-protection import --config-file= +teku slashing-protection export --config-file= ``` ```bash -teku slashing-protection import --config-file=/home/me/me_node/config.yaml +teku slashing-protection export --config-file=/home/me/me_node/config.yaml ``` @@ -54,14 +48,14 @@ Path to the YAML configuration file. The default is `none`. ```bash -teku slashing-protection import --data-path= +teku slashing-protection export --data-path= ``` ```bash -teku slashing-protection import --data-path=/home/me/me_node +teku slashing-protection export --data-path=/home/me/me_node ``` @@ -79,14 +73,14 @@ Path to the Teku data directory. The default directory is OS-dependent: ```bash -teku slashing-protection import --data-validator-path= +teku slashing-protection export --data-validator-path= ``` ```bash -teku slashing-protection import --data-validator-path=/home/me/me_validator +teku slashing-protection export --data-validator-path=/home/me/me_validator ``` @@ -110,38 +104,42 @@ Path to the validator client data. The default is `/validator` where :::info -Teku imports slashing protection data into a `slashprotection` directory under the validator client data directory. +Teku exports slashing protection data from the `slashprotection` directory under the validator client data directory. ::: -### `from` +### `to` ```bash -teku slashing-protection import --from= +teku slashing-protection export --to= ``` ```bash -teku slashing-protection import --from=/home/slash/b845...23bed.json +teku slashing-protection export --to=/home/slash/b845...23bed.json ``` -The file to import the slashing protection database from. +The file to export the slashing protection database to. -Teku imports the file to the `/validators/slashprotection/` directory in the format `.yml` (with no 0x prefix). +Exports the database in the [validator client interchange format] format. -`` is defined using [`--data-path`](#data-path). +## `import` -## `export` +Imports the slashing protection database using the [validator client interchange format]. -Exports the slashing protection database in the [validator client interchange format] format. +:::caution + +Before running the import, you must stop the validator and confirm the process has fully exited and won't be restarted. + +::: ### `config-file` @@ -149,14 +147,14 @@ Exports the slashing protection database in the [validator client interchange fo ```bash -teku slashing-protection export --config-file= +teku slashing-protection import --config-file= ``` ```bash -teku slashing-protection export --config-file=/home/me/me_node/config.yaml +teku slashing-protection import --config-file=/home/me/me_node/config.yaml ``` @@ -177,14 +175,14 @@ Path to the YAML configuration file. The default is `none`. ```bash -teku slashing-protection export --data-path= +teku slashing-protection import --data-path= ``` ```bash -teku slashing-protection export --data-path=/home/me/me_node +teku slashing-protection import --data-path=/home/me/me_node ``` @@ -202,14 +200,14 @@ Path to the Teku data directory. The default directory is OS-dependent: ```bash -teku slashing-protection export --data-validator-path= +teku slashing-protection import --data-validator-path= ``` ```bash -teku slashing-protection export --data-validator-path=/home/me/me_validator +teku slashing-protection import --data-validator-path=/home/me/me_validator ``` @@ -233,32 +231,35 @@ Path to the validator client data. The default is `/validator` where :::info -Teku exports slashing protection data from the `slashprotection` directory under the validator client data directory. +Teku imports slashing protection data into a `slashprotection` directory under the validator client data directory. ::: -### `to` +### `from` ```bash -teku slashing-protection export --to= +teku slashing-protection import --from= ``` ```bash -teku slashing-protection export --to=/home/slash/b845...23bed.json +teku slashing-protection import --from=/home/slash/b845...23bed.json ``` -The file to export the slashing protection database to. +The file to import the slashing protection database from. + +Teku imports the file to the `/validators/slashprotection/` directory in the format `.yml` (with no 0x prefix). + +`` is defined using [`--data-path`](#data-path). -Exports the database in the [validator client interchange format] format. ## `repair` diff --git a/docs/reference/cli/subcommands/validator-client.md b/docs/reference/cli/subcommands/validator-client.md index fe084b1a3..f3c69789f 100644 --- a/docs/reference/cli/subcommands/validator-client.md +++ b/docs/reference/cli/subcommands/validator-client.md @@ -433,118 +433,118 @@ Logs could become noisy when running many validators. ::: -## `metrics-enabled` +## `metrics-categories` ```bash -teku vc --metrics-enabled[=] +teku vc --metrics-categories=[,...]... ``` ```bash -teku vc --metrics-enabled=true +teku vc --metrics-categories=BEACON,JVM,PROCESS ``` ```bash -TEKU_METRICS_ENABLED=true +TEKU_METRICS_CATEGORIES=BEACON,JVM,PROCESS ``` ```bash -metrics-enabled: true +metrics-categories: ["BEACON", "JVM", "PROCESS"] ``` -Set to `true` to enable the metrics exporter. The default is `false`. +Categories for which to track metrics. Options are `JVM`, `PROCESS`, `BEACON`, `DISCOVERY`, `EVENTBUS`, `EXECUTOR`, `LIBP2P`, `NETWORK`, `STORAGE`, `STORAGE_HOT_DB`, `STORAGE_FINALIZED_DB`, `REMOTE_VALIDATOR`, `VALIDATOR`, `VALIDATOR_PERFORMANCE`, `VALIDATOR_DUTY`. All but `VALIDATOR_DUTY` categories are enabled by default. -## `metrics-host-allowlist` +When `metrics-categories` is used, only the categories specified in this option are enabled (all other categories are disabled). + +## `metrics-enabled` ```bash -teku vc --metrics-host-allowlist=[,...]... or "*" +teku vc --metrics-enabled[=] ``` ```bash -teku vc --metrics-host-allowlist=medomain.com,meotherdomain.com +teku vc --metrics-enabled=true ``` ```bash -TEKU_METRICS_HOST_ALLOWLIST=medomain.com,meotherdomain.com +TEKU_METRICS_ENABLED=true ``` ```bash -metrics-host-allowlist: ["medomain.com", "meotherdomain.com"] +metrics-enabled: true ``` -A comma-separated list of hostnames to allow access to the [Teku metrics]. By default, Teku accepts access from `localhost` and `127.0.0.1`. - -:::tip - -To allow all hostnames, use `"*"`. We don't recommend allowing all hostnames for production environments. - -::: +Set to `true` to enable the metrics exporter. The default is `false`. -## `metrics-categories` +## `metrics-host-allowlist` ```bash -teku vc --metrics-categories=[,...]... +teku vc --metrics-host-allowlist=[,...]... or "*" ``` ```bash -teku vc --metrics-categories=BEACON,JVM,PROCESS +teku vc --metrics-host-allowlist=medomain.com,meotherdomain.com ``` ```bash -TEKU_METRICS_CATEGORIES=BEACON,JVM,PROCESS +TEKU_METRICS_HOST_ALLOWLIST=medomain.com,meotherdomain.com ``` ```bash -metrics-categories: ["BEACON", "JVM", "PROCESS"] +metrics-host-allowlist: ["medomain.com", "meotherdomain.com"] ``` -Categories for which to track metrics. Options are `JVM`, `PROCESS`, `BEACON`, `DISCOVERY`, `EVENTBUS`, `EXECUTOR`, `LIBP2P`, `NETWORK`, `STORAGE`, `STORAGE_HOT_DB`, `STORAGE_FINALIZED_DB`, `REMOTE_VALIDATOR`, `VALIDATOR`, `VALIDATOR_PERFORMANCE`, `VALIDATOR_DUTY`. All but `VALIDATOR_DUTY` categories are enabled by default. +A comma-separated list of hostnames to allow access to the [Teku metrics]. By default, Teku accepts access from `localhost` and `127.0.0.1`. -When `metrics-categories` is used, only the categories specified in this option are enabled (all other categories are disabled). +:::tip + +To allow all hostnames, use `"*"`. We don't recommend allowing all hostnames for production environments. + +::: ## `metrics-interface`