From 564ef83db5e816d35c10c47c70f9b9279db8b0fa Mon Sep 17 00:00:00 2001 From: chonghe Date: Fri, 15 Sep 2023 18:35:17 +0800 Subject: [PATCH] update --- book/src/help_am.md | 9 +++++++- book/src/help_bn.md | 45 ++++++++++++++++++++++++++++++++++++++-- book/src/help_general.md | 39 ++++++++++++++++++++-------------- book/src/help_vc.md | 17 ++++++++++++++- 4 files changed, 91 insertions(+), 19 deletions(-) diff --git a/book/src/help_am.md b/book/src/help_am.md index 586b4bda99..e2063b853f 100644 --- a/book/src/help_am.md +++ b/book/src/help_am.md @@ -30,6 +30,13 @@ OPTIONS: --debug-level Specifies the verbosity level used when emitting logs to the terminal. [default: info] [possible values: info, debug, trace, warn, error, crit] + --genesis-state-url + A URL of a beacon-API compatible server from which to download the genesis state. Checkpoint sync server + URLs can generally be used with this flag. If not supplied, a default URL or the --checkpoint-sync-url may + be used. If the genesis state is already included in this binary then this value will be ignored. + --genesis-state-url-timeout + The timeout in seconds for the request to --genesis-state-url. [default: 180] + --log-format Specifies the log format used when emitting logs to the terminal. [possible values: JSON] @@ -51,7 +58,7 @@ OPTIONS: disabled. [default: 200] --network Name of the Eth2 chain Lighthouse will sync and follow. [possible values: mainnet, prater, goerli, gnosis, - sepolia] + chiado, sepolia, holesky] --safe-slots-to-import-optimistically Used to coordinate manual overrides of the SAFE_SLOTS_TO_IMPORT_OPTIMISTICALLY parameter. This flag should only be used if the user has a clear understanding that the broad Ethereum community has elected to override diff --git a/book/src/help_bn.md b/book/src/help_bn.md index 9350befc9b..d9c454be1a 100644 --- a/book/src/help_bn.md +++ b/book/src/help_bn.md @@ -62,6 +62,8 @@ FLAGS: --eth1-purge-cache Purges the eth1 block and deposit caches --genesis-backfill Attempts to download blocks all the way back to genesis when checkpoint syncing. + --gui Enable the graphical user interface and all its requirements. This + enables --http and --validator-monitor-auto and enables SSE logging. -h, --help Prints help information --http Enable the RESTful HTTP API server. Disabled by default. --http-allow-sync-stalled Forces the HTTP to indicate that the node is synced when sync is actually @@ -119,6 +121,25 @@ OPTIONS: --auto-compact-db Enable or disable automatic compaction of the database on finalization. [default: true] + --beacon-processor-aggregate-batch-size + Specifies the number of gossip aggregate attestations in a signature verification batch. Higher values may + reduce CPU usage in a healthy network while lower values may increase CPU usage in an unhealthy or hostile + network. [default: 64] + --beacon-processor-attestation-batch-size + Specifies the number of gossip attestations in a signature verification batch. Higher values may reduce CPU + usage in a healthy network whilst lower values may increase CPU usage in an unhealthy or hostile network. + [default: 64] + --beacon-processor-max-workers + Specifies the maximum concurrent tasks for the task scheduler. Increasing this value may increase resource + consumption. Reducing the value may result in decreased resource usage and diminished performance. The + default value is the number of logical CPU cores on the host. + --beacon-processor-reprocess-queue-len + Specifies the length of the queue for messages requiring delayed processing. Higher values may prevent + messages from being dropped while lower values may help protect the node from becoming overwhelmed. + [default: 12288] + --beacon-processor-work-queue-len + Specifies the length of the inbound event queue. Higher values may prevent messages from being dropped while + lower values may help protect the node from becoming overwhelmed. [default: 16384] --block-cache-size Specifies how many blocks the database should cache in memory [default: 5] @@ -162,7 +183,7 @@ OPTIONS: Set the remote beacon node HTTP endpoint to use for checkpoint sync. --checkpoint-sync-url-timeout - Set the timeout for checkpoint sync calls to remote beacon node HTTP endpoint. [default: 60] + Set the timeout for checkpoint sync calls to remote beacon node HTTP endpoint. [default: 180] -d, --datadir Used to specify a custom root data directory for lighthouse keys and databases. Defaults to @@ -195,6 +216,9 @@ OPTIONS: --enr-udp6-port The UDP6 port of the local ENR. Set this only if you are sure other nodes can connect to your local node on this port over IpV6. + --epochs-per-migration + The number of epochs to wait between running the migration of data from the hot DB to the cold DB. Less + frequent runs can be useful for minimizing disk writes [default: 1] --eth1-blocks-per-log-query Specifies the number of blocks that a deposit log query should span. This will reduce the size of responses from the Eth1 endpoint. [default: 1000] @@ -234,6 +258,13 @@ OPTIONS: --freezer-dir Data directory for the freezer database. + --genesis-state-url + A URL of a beacon-API compatible server from which to download the genesis state. Checkpoint sync server + URLs can generally be used with this flag. If not supplied, a default URL or the --checkpoint-sync-url may + be used. If the genesis state is already included in this binary then this value will be ignored. + --genesis-state-url-timeout + The timeout in seconds for the request to --genesis-state-url. [default: 180] + --graffiti Specify your custom graffiti to be included in blocks. Defaults to the current version and commit, truncated to fit in 32 bytes. @@ -247,12 +278,22 @@ OPTIONS: Set the value of the Access-Control-Allow-Origin response HTTP header. Use * to allow any origin (not recommended in production). If no value is supplied, the CORS allowed origin is set to the listen address of this server (e.g., http://localhost:5052). + --http-duplicate-block-status + Status code to send when a block that is already known is POSTed to the HTTP API. [default: 202] + + --http-enable-beacon-processor + The beacon processor is a scheduler which provides quality-of-service and DoS protection. When set to + "true", HTTP API requests will be queued and scheduled alongside other tasks. When set to "false", HTTP API + responses will be executed immediately. [default: true] --http-port Set the listen TCP port for the RESTful HTTP API server. [default: 5052] --http-spec-fork Serve the spec for a specific hard fork on /eth/v1/config/spec. It should not be necessary to set this flag. + --http-sse-capacity-multiplier + Multiplier to apply to the length of HTTP server-sent-event (SSE) channels. Increasing this value can + prevent messages from being dropped. [default: 1] --http-tls-cert The path of the certificate to be used when serving the HTTP API server over TLS. @@ -319,7 +360,7 @@ OPTIONS: --network Name of the Eth2 chain Lighthouse will sync and follow. [possible values: mainnet, prater, goerli, gnosis, - sepolia] + chiado, sepolia, holesky] --network-dir Data directory for network keys. Defaults to network/ inside the beacon node dir. diff --git a/book/src/help_general.md b/book/src/help_general.md index 59db3531e3..4906ea82f2 100644 --- a/book/src/help_general.md +++ b/book/src/help_general.md @@ -34,6 +34,13 @@ OPTIONS: --debug-level Specifies the verbosity level used when emitting logs to the terminal. [default: info] [possible values: info, debug, trace, warn, error, crit] + --genesis-state-url + A URL of a beacon-API compatible server from which to download the genesis state. Checkpoint sync server + URLs can generally be used with this flag. If not supplied, a default URL or the --checkpoint-sync-url may + be used. If the genesis state is already included in this binary then this value will be ignored. + --genesis-state-url-timeout + The timeout in seconds for the request to --genesis-state-url. [default: 180] + --log-format Specifies the log format used when emitting logs to the terminal. [possible values: JSON] @@ -55,7 +62,7 @@ OPTIONS: disabled. [default: 200] --network Name of the Eth2 chain Lighthouse will sync and follow. [possible values: mainnet, prater, goerli, gnosis, - sepolia] + chiado, sepolia, holesky] --safe-slots-to-import-optimistically Used to coordinate manual overrides of the SAFE_SLOTS_TO_IMPORT_OPTIMISTICALLY parameter. This flag should only be used if the user has a clear understanding that the broad Ethereum community has elected to override @@ -84,18 +91,20 @@ OPTIONS: if there is no existing database. SUBCOMMANDS: - account_manager Utilities for generating and managing Ethereum 2.0 accounts. [aliases: a, am, account, - account_manager] - beacon_node The primary component which connects to the Ethereum 2.0 P2P network and downloads, verifies - and stores blocks. Provides a HTTP API for querying the beacon chain and publishing messages - to the network. [aliases: b, bn, beacon] - boot_node Start a special Lighthouse process that only serves as a discv5 boot-node. This process will - *not* import blocks or perform most typical beacon node functions. Instead, it will simply - run the discv5 service and assist nodes on the network to discover each other. This is the - recommended way to provide a network boot-node since it has a reduced attack surface - compared to a full beacon node. - database_manager Manage a beacon node database [aliases: db] - help Prints this message or the help of the given subcommand(s) - validator_client When connected to a beacon node, performs the duties of a staked validator (e.g., proposing - blocks and attestations). [aliases: v, vc, validator] + account_manager Utilities for generating and managing Ethereum 2.0 accounts. [aliases: a, am, account, + account_manager] + beacon_node The primary component which connects to the Ethereum 2.0 P2P network and downloads, + verifies and stores blocks. Provides a HTTP API for querying the beacon chain and + publishing messages to the network. [aliases: b, bn, beacon] + boot_node Start a special Lighthouse process that only serves as a discv5 boot-node. This process + will *not* import blocks or perform most typical beacon node functions. Instead, it will + simply run the discv5 service and assist nodes on the network to discover each other. This + is the recommended way to provide a network boot-node since it has a reduced attack surface + compared to a full beacon node. + database_manager Manage a beacon node database [aliases: db] + help Prints this message or the help of the given subcommand(s) + validator_client When connected to a beacon node, performs the duties of a staked validator (e.g., proposing + blocks and attestations). [aliases: v, vc, validator] + validator_manager Utilities for managing a Lighthouse validator client via the HTTP API. [aliases: vm, + validator-manager, validator_manager] ``` \ No newline at end of file diff --git a/book/src/help_vc.md b/book/src/help_vc.md index f1f1e2d2c2..e031a6ecce 100644 --- a/book/src/help_vc.md +++ b/book/src/help_vc.md @@ -38,6 +38,14 @@ FLAGS: metrics being collected. -h, --help Prints help information --http Enable the RESTful HTTP API server. Disabled by default. + --http-allow-keystore-export + If present, allow access to the DELETE /lighthouse/keystores HTTP API method, which allows exporting + keystores and passwords to HTTP API consumers who have access to the API token. This method is useful for + exporting validators, however it should be used with caution since it exposes private key data to authorized + users. + --http-store-passwords-in-secrets-dir + If present, any validators created via the HTTP will have keystore passwords stored in the secrets-dir + rather than the validator definitions file. --init-slashing-protection If present, do not require the slashing protection database to exist before running. You SHOULD NOT use this flag unless you're certain that a new slashing protection database is required. Usually, your database will @@ -93,6 +101,13 @@ OPTIONS: The gas limit to be used in all builder proposals for all validators managed by this validator client. Note this will not necessarily be used if the gas limit set here moves too far from the previous block's gas limit. [default: 30,000,000] + --genesis-state-url + A URL of a beacon-API compatible server from which to download the genesis state. Checkpoint sync server + URLs can generally be used with this flag. If not supplied, a default URL or the --checkpoint-sync-url may + be used. If the genesis state is already included in this binary then this value will be ignored. + --genesis-state-url-timeout + The timeout in seconds for the request to --genesis-state-url. [default: 180] + --graffiti Specify your custom graffiti to be included in blocks. @@ -154,7 +169,7 @@ OPTIONS: --network Name of the Eth2 chain Lighthouse will sync and follow. [possible values: mainnet, prater, goerli, gnosis, - sepolia] + chiado, sepolia, holesky] --proposer-nodes Comma-separated addresses to one or more beacon node HTTP APIs. These specify nodes that are used to send beacon block proposals. A failure will revert back to the standard beacon nodes specified in --beacon-nodes.