From bde4c8f195ab751274643c5e3668e6d609efa143 Mon Sep 17 00:00:00 2001 From: Alexandra Tran Date: Fri, 11 Mar 2022 08:20:25 -0800 Subject: [PATCH 1/6] document merge options --- docs/Reference/CLI/CLI-Syntax.md | 142 +++++++++++++++++++++++++++++++ 1 file changed, 142 insertions(+) diff --git a/docs/Reference/CLI/CLI-Syntax.md b/docs/Reference/CLI/CLI-Syntax.md index 066af3a1f..8b42f4286 100644 --- a/docs/Reference/CLI/CLI-Syntax.md +++ b/docs/Reference/CLI/CLI-Syntax.md @@ -262,6 +262,63 @@ The default is `false`. Path to the validator client data. The default is `/validator` where `` is specified using [`--data-base-path`](#data-base-path-data-path). +### ee-endpoint + +=== "Syntax" + + ```bash + --ee-endpoint= + ``` + +=== "Example" + + ```bash + --ee-endpoint=https://mainnet.infura.io/v3/d0e21ccd0b1e4eef7784422eabc51111 + ``` + +=== "Environment variable" + + ```bash + TEKU_EE_ENDPOINT=https://mainnet.infura.io/v3/d0e21ccd0b1e4eef7784422eabc51111 + ``` + +=== "Configuration file" + + ```bash + ee-endpoint: "https://mainnet.infura.io/v3/d0e21ccd0b1e4eef7784422eabc51111" + ``` + +JSON-RPC URL of the execution engine node. + +### ee-jwt-secret-file + +=== "Syntax" + + ```bash + --ee-jwt-secret-file= + ``` + +=== "Example" + + ```bash + --ee-jwt-secret-file=ee-jwt-secret.hex + ``` + +=== "Environment variable" + + ```bash + TEKU_EE_JWT_SECRET_FILE=ee-jwt-secret.hex + ``` + +=== "Configuration file" + + ```bash + ee-jwt-secret-file: "ee-jwt-secret.hex" + ``` + +Location of the file specifying the hex-encoded 256-bit secret key to be used for verifying and generating JSON Web +Tokens. + ### eth1-deposit-contract-address === "Syntax" @@ -2034,6 +2091,91 @@ When `LOGGING` is enabled, attestation and block performance is reported as log `METRICS` is enabled, attestation and block performance is reported using [metrics] in the [`VALIDATOR_PERFORMANCE`](#metrics-categories) metrics category. +### validators-proposer-config + +=== "Syntax" + + ```bash + --validators-proposer-config= + ``` + +=== "Example" + + ```bash + --validators-proposer-config=/home/me/node/proposerConfig.json + ``` + +=== "Environment variable" + + ```bash + TEKU_VALIDATORS_PROPOSER_CONFIG=/home/me/node/proposerConfig.json + ``` + +=== "Configuration file" + + ```bash + validators-proposer-config: "/home/me/node/proposerConfig.json" + ``` + +Remote URL or local file path from which to load proposer configuration. + +### validators-proposer-config-refresh-enabled + +=== "Syntax" + + ```bash + --validators-proposer-config-refresh-enabled[=] + ``` + +=== "Example" + + ```bash + --validators-proposer-config-refresh-enabled=true + ``` + +=== "Environment variable" + + ```bash + TEKU_VALIDATORS_PROPOSER_CONFIG_REFRESH_ENABLED=true + ``` + +=== "Configuration file" + + ```bash + validators-proposer-config-refresh-enabled: true + ``` + +Set to `true` to enable reloading the proposer configuration on every proposer preparation (once per epoch). +The default is `false`. + +### validators-proposer-default-fee-recipient + +=== "Syntax" + + ```bash + --validators-proposer-default-fee-recipient=
+ ``` + +=== "Example" + + ```bash + --validators-proposer-default-fee-recipient=0xfe3b557e8fb62b89f4916b721be55ceb828dbd73 + ``` + +=== "Environment variable" + + ```bash + TEKU_VALIDATORS_PROPOSER_DEFAULT_FEE_RECIPIENT=0xfe3b557e8fb62b89f4916b721be55ceb828dbd73 + ``` + +=== "Configuration file" + + ```bash + validators-proposer-default-fee-recipient: "0xfe3b557e8fb62b89f4916b721be55ceb828dbd73" + ``` + +Default fee recipient when producing a new execution block. + ### ws-checkpoint === "Syntax" From 20fe97d10273afd6087f1919b02d20cf00cf3793 Mon Sep 17 00:00:00 2001 From: Alexandra Tran Date: Fri, 11 Mar 2022 08:24:05 -0800 Subject: [PATCH 2/6] minor edit --- docs/Reference/CLI/CLI-Syntax.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/Reference/CLI/CLI-Syntax.md b/docs/Reference/CLI/CLI-Syntax.md index 8b42f4286..ea6a21896 100644 --- a/docs/Reference/CLI/CLI-Syntax.md +++ b/docs/Reference/CLI/CLI-Syntax.md @@ -273,19 +273,19 @@ is specified using [`--data-base-path`](#data-base-path-data-path). === "Example" ```bash - --ee-endpoint=https://mainnet.infura.io/v3/d0e21ccd0b1e4eef7784422eabc51111 + --ee-endpoint=http://localhost:8545 ``` === "Environment variable" ```bash - TEKU_EE_ENDPOINT=https://mainnet.infura.io/v3/d0e21ccd0b1e4eef7784422eabc51111 + TEKU_EE_ENDPOINT=http://localhost:8545 ``` === "Configuration file" ```bash - ee-endpoint: "https://mainnet.infura.io/v3/d0e21ccd0b1e4eef7784422eabc51111" + ee-endpoint: "http://localhost:8545" ``` JSON-RPC URL of the execution engine node. @@ -2117,7 +2117,7 @@ When `LOGGING` is enabled, attestation and block performance is reported as log validators-proposer-config: "/home/me/node/proposerConfig.json" ``` -Remote URL or local file path from which to load proposer configuration. +Remote URL or local file path from which to load the proposer configuration. ### validators-proposer-config-refresh-enabled From 14538423ac071876b0af655db9210f804386a38a Mon Sep 17 00:00:00 2001 From: Alexandra Tran Date: Mon, 14 Mar 2022 12:01:33 -0700 Subject: [PATCH 3/6] reviewer feedback --- docs/Reference/CLI/CLI-Syntax.md | 29 ++++++++++++++++++++++++++--- 1 file changed, 26 insertions(+), 3 deletions(-) diff --git a/docs/Reference/CLI/CLI-Syntax.md b/docs/Reference/CLI/CLI-Syntax.md index ea6a21896..f2e5cb287 100644 --- a/docs/Reference/CLI/CLI-Syntax.md +++ b/docs/Reference/CLI/CLI-Syntax.md @@ -2117,7 +2117,28 @@ When `LOGGING` is enabled, attestation and block performance is reported as log validators-proposer-config: "/home/me/node/proposerConfig.json" ``` -Remote URL or local file path from which to load the proposer configuration. +Remote URL or local file path to the proposer configuration file, which is a JSON file that specifies: + +- `proposer_config` - (optional) A proposer configuration for multiple validator public keys. +- `default_config` - (required) A default proposer configuration for validator public keys not included in + `proposer_config`. + +Each proposer configuration must specify a `fee_recipient`. + +!!! example "`proposerConfig.json`" + + ```json + { + "proposer_config": { + "0xa057816155ad77931185101128655c0191bd0214c201ca48ed887f6c4c6adf334070efcd75140eada5ac83a92506dd7a": { + "fee_recipient": "0x50155530FCE8a85ec7055A5F8b2bE214B3DaeFd3", + } + }, + "default_config": { + "fee_recipient": "0x6e35733c5af9B61374A128e6F85f553aF09ff89A" + } + } + ``` ### validators-proposer-config-refresh-enabled @@ -2145,7 +2166,8 @@ Remote URL or local file path from which to load the proposer configuration. validators-proposer-config-refresh-enabled: true ``` -Set to `true` to enable reloading the proposer configuration on every proposer preparation (once per epoch). +Set to `true` to enable reloading the [proposer configuration](#validators-proposer-config) on every proposer +preparation (once per epoch). The default is `false`. ### validators-proposer-default-fee-recipient @@ -2174,7 +2196,8 @@ The default is `false`. validators-proposer-default-fee-recipient: "0xfe3b557e8fb62b89f4916b721be55ceb828dbd73" ``` -Default fee recipient when producing a new execution block. +Default fee recipient used if `fee_recipient` isn't specified in the +[default proposer configuration](#validators-proposer-config), when producing a new execution block. ### ws-checkpoint From c819f3d0e7f38e25b9f2f472fe32148a63d9c553 Mon Sep 17 00:00:00 2001 From: Alexandra Tran Date: Tue, 15 Mar 2022 11:48:08 -0700 Subject: [PATCH 4/6] reviewer suggestion --- docs/Reference/CLI/CLI-Syntax.md | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/docs/Reference/CLI/CLI-Syntax.md b/docs/Reference/CLI/CLI-Syntax.md index f2e5cb287..2bd2093ee 100644 --- a/docs/Reference/CLI/CLI-Syntax.md +++ b/docs/Reference/CLI/CLI-Syntax.md @@ -2196,8 +2196,15 @@ The default is `false`. validators-proposer-default-fee-recipient: "0xfe3b557e8fb62b89f4916b721be55ceb828dbd73" ``` -Default fee recipient used if `fee_recipient` isn't specified in the -[default proposer configuration](#validators-proposer-config), when producing a new execution block. +Default fee recipient for all validator keys. +When running a validator, this is an alternative to the `fee_recipient` in the +[default proposer configuration](#validators-proposer-config). + +!!! important + + We recommend using this option when running a beacon node serving APIs to other validator clients. + The specified fee recipient is used in rare cases when a validator requests a block production but its fee recipient + is still unknown for the beacon node. ### ws-checkpoint From 4b5ed4646c736af8cdc59954e1354252d042552e Mon Sep 17 00:00:00 2001 From: Alexandra Tran Date: Tue, 15 Mar 2022 11:49:15 -0700 Subject: [PATCH 5/6] fix list style --- docs/Reference/CLI/CLI-Syntax.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/Reference/CLI/CLI-Syntax.md b/docs/Reference/CLI/CLI-Syntax.md index 2bd2093ee..fbd92e9ad 100644 --- a/docs/Reference/CLI/CLI-Syntax.md +++ b/docs/Reference/CLI/CLI-Syntax.md @@ -2119,8 +2119,8 @@ When `LOGGING` is enabled, attestation and block performance is reported as log Remote URL or local file path to the proposer configuration file, which is a JSON file that specifies: -- `proposer_config` - (optional) A proposer configuration for multiple validator public keys. -- `default_config` - (required) A default proposer configuration for validator public keys not included in +* `proposer_config` - (optional) A proposer configuration for multiple validator public keys. +* `default_config` - (required) A default proposer configuration for validator public keys not included in `proposer_config`. Each proposer configuration must specify a `fee_recipient`. From 1528d380e97249bdde717fd4f6fcfd31bdca41bd Mon Sep 17 00:00:00 2001 From: Alexandra Tran Date: Wed, 16 Mar 2022 15:04:09 -0700 Subject: [PATCH 6/6] reviewer suggestions --- docs/Reference/CLI/CLI-Syntax.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/Reference/CLI/CLI-Syntax.md b/docs/Reference/CLI/CLI-Syntax.md index fbd92e9ad..39b112166 100644 --- a/docs/Reference/CLI/CLI-Syntax.md +++ b/docs/Reference/CLI/CLI-Syntax.md @@ -273,22 +273,22 @@ is specified using [`--data-base-path`](#data-base-path-data-path). === "Example" ```bash - --ee-endpoint=http://localhost:8545 + --ee-endpoint=http://localhost:8550 ``` === "Environment variable" ```bash - TEKU_EE_ENDPOINT=http://localhost:8545 + TEKU_EE_ENDPOINT=http://localhost:8550 ``` === "Configuration file" ```bash - ee-endpoint: "http://localhost:8545" + ee-endpoint: "http://localhost:8550" ``` -JSON-RPC URL of the execution engine node. +URL of the execution client's Engine JSON RPC APIs. ### ee-jwt-secret-file