Update eth1-endpoint CLI option (Consensys#278)

* Add CLI option to disable built-in slashing protection for external signers. Signed-off-by: Byron Gravenorst <[email protected]> * Add instructions to connect to mainnet. Signed-off-by: Byron Gravenorst <[email protected]> * updating submodule to latest * Add instructions to connect to mainnet. Signed-off-by: Byron Gravenorst <[email protected]> * Fix markdown issue. Signed-off-by: Byron Gravenorst <[email protected]> * Update eth1-endpoint CLI option. Signed-off-by: bgravenorst <[email protected]> * Minor update. Signed-off-by: bgravenorst <[email protected]>
seroze · Apr 27, 2021 · 4389d99 · 4389d99
1 parent 5a504b1
commit 4389d99
Show file tree

Hide file tree

Showing 5 changed files with 17 additions and 14 deletions.
diff --git a/docs/HowTo/Configure/Configure-TLS.md b/docs/HowTo/Configure/Configure-TLS.md
@@ -59,7 +59,7 @@ teku --network=pyrmont \
 In the command:
 
 * Specify the JSON-RPC URL of the ETH1 node using
-    [`--eth1-endpoint`](../../Reference/CLI/CLI-Syntax.md#eth1-endpoint).
+    [`--eth1-endpoint`](../../Reference/CLI/CLI-Syntax.md#eth1-endpoint-eth1-endpoints).
 * Specify the validator's public keys using
     [`--validators-external-signer-public-keys`](../../Reference/CLI/CLI-Syntax.md#validators-external-signer-public-keys).
 * Specify the URL of the running external signer using

diff --git a/docs/HowTo/Get-Started/Connect/Connect-To-Testnet.md b/docs/HowTo/Get-Started/Connect/Connect-To-Testnet.md
@@ -118,8 +118,8 @@ and the text files containing the password to decrypt the validator key.
 !!! note
 
     If using a cloud-based service such as [Infura], then set
-    [`--eth1-endpoint`](../../../Reference/CLI/CLI-Syntax.md#eth1-endpoint) to the supplied URL. For
-    example, `https://goerli.infura.io/v3/<Project_ID>`.
+    [`--eth1-endpoint`](../../../Reference/CLI/CLI-Syntax.md#eth1-endpoint-eth1-endpoints) to the
+    supplied URL. For example, `https://goerli.infura.io/v3/<Project_ID>`.
 
 Alternatively, use [`--validator-keys`](../../../Reference/CLI/CLI-Syntax.md#validator-keys) to
 specify the directory to load multiple keys and passwords from.

diff --git a/docs/HowTo/Get-Started/Run-Teku.md b/docs/HowTo/Get-Started/Run-Teku.md
@@ -20,8 +20,8 @@ on the same machine.
     By default, Teku connects to `mainnet`. Use the [`--network`](../../Reference/CLI/CLI-Syntax.md#network)
     command line option to specify an alternate network.
 
-    If the genesis state of a network is not yet known, then
-    include the [`--eth1-endpoint`](../../Reference/CLI/CLI-Syntax.md#eth1-endpoint) command line
+    If the genesis state of a network is not yet known, then include the
+    [`--eth1-endpoint`](../../Reference/CLI/CLI-Syntax.md#eth1-endpoint-eth1-endpoints) command line
     option.
 
 ## Start the clients in a single process
@@ -32,7 +32,7 @@ with the [`teku`](../../Reference/CLI/CLI-Syntax.md#options) command
 !!! example
 
     ```
-    teku --network=pyrmont --eth1-endpoint=http://localhost:8545 \
+    teku --network=pyrmont --eth1-endpoint=http://localhost:8545,https://goerli.infura.iov3/b0f36cebcab24eef9984422efbc51f21 \
     --validator-keys=validator/keys/validator_888eef.json:validator/passwords/validator_888eef.txt \
     --rest-api-enabled=true --rest-api-docs-enabled=true \
     --metrics-enabled

diff --git a/docs/Reference/CLI/CLI-Syntax.md b/docs/Reference/CLI/CLI-Syntax.md
@@ -288,33 +288,35 @@ Defaults to 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.
 
-### eth1-endpoint
+### eth1-endpoint, eth1-endpoints
 
 === "Syntax"
 
     ```bash
-    --eth1-endpoint=<URL>
+    --eth1-endpoint=<URL>[,<URL>...]...
     ```
 
 === "Command Line"
 
     ```bash
-    --eth1-endpoint=http://localhost:8545
+    --eth1-endpoint=http://localhost:8545,https://mainnet.infura.io/v3/d0e21ccd0b1e4eef7784422eabc51111
     ```
 
 === "Environment Variable"
 
     ```bash
-    TEKU_ETH1_ENDPOINT=http://localhost:8545
+    TEKU_ETH1_ENDPOINT=http://localhost:8545,https://mainnet.infura.io/v3/d0e21ccd0b1e4eef7784422eabc51111
     ```
 
 === "Configuration File"
 
     ```bash
-    eth1-endpoint: "http://localhost:8545"
+    eth1-endpoint: ["http://localhost:8545","https://mainnet.infura.io/v3/d0e21ccd0b1e4eef7784422eabc51111"]
     ```
 
-The JSON-RPC URL of Ethereum 1.0 node. This option must be specified if running a validator.
+Comma-separated list of JSON-RPC URLs of Ethereum 1.0 nodes. Each time Teku makes a call, it finds
+the first provider in the list that is available, on the right chain, and in sync. This option must
+be specified if running a validator.
 
 If not specified (that is, you're running a beacon chain client only), then provide an initial state
 using the [`--initial-state`](#initial-state) option, or start Teku from an existing database using

diff --git a/docs/Tutorials/Configure-External-Signer-TLS.md b/docs/Tutorials/Configure-External-Signer-TLS.md
@@ -176,8 +176,9 @@ password files.
 !!! important
 
     This example connects to an [Infura] ETH1 endpoint, if running your own client, like
-    [Hyperledger Besu], then replace [`--eth1-endpoint`](../Reference/CLI/CLI-Syntax.md#eth1-endpoint)
-    with the location of the JSON-RPC URL of the ETH1 node.
+    [Hyperledger Besu], then add the JSON-RPC URL of the ETH1 node
+    to the [`--eth1-endpoint`](../Reference/CLI/CLI-Syntax.md#eth1-endpoint-eth1-endpoints)
+    command line option.
 
 ```bash
 teku --network=pyrmont \