Add Ephemery command to other files

Signed-off-by: gconnect <[email protected]>
Consensys · Nov 1, 2024 · 1d2e1d2 · 1d2e1d2
1 parent be7b918
commit 1d2e1d2
Show file tree

Hide file tree

Showing 7 changed files with 125 additions and 3 deletions.
diff --git a/docs/get-started/install/run-docker-image.md b/docs/get-started/install/run-docker-image.md
@@ -141,6 +141,66 @@ services:
 ```
 
   </TabItem>
+
+  <TabItem value="Ephemery" label="Ephemery" default>
+
+```yaml
+---
+version: "3.4"
+services:
+  besu_node:
+    image: hyperledger/besu:latest
+    command:
+      [
+        "--network=ephemery",
+        "--data-path=/var/lib/besu/data",
+        "--host-allowlist=*",
+        "--sync-mode=FAST",
+        "--rpc-http-enabled",
+        "--rpc-http-cors-origins=*",
+        "--rpc-http-api=ETH,NET,CLIQUE,DEBUG,MINER,NET,PERM,ADMIN,EEA,TXPOOL,PRIV,WEB3",
+        "--engine-jwt-secret=/var/lib/besu/data/token.txt",
+        "--engine-host-allowlist=*",
+        "--engine-rpc-enabled=true",
+      ]
+    volumes:
+      - ./besu:/var/lib/besu/data
+    ports:
+      # Map the p2p port(30303), RPC HTTP port(8545), and engine port (8551)
+      - "8545:8545"
+      - "8551:8551"
+      - "30303:30303/tcp"
+      - "30303:30303/udp"
+
+  teku_node:
+    environment:
+      - "JAVA_OPTS=-Xmx4g"
+    image: consensys/teku:latest
+    command:
+      [
+        "--network=ephemery",
+        "--data-base-path=/var/lib/teku/data",
+        "--validators-proposer-default-fee-recipient=YOUR_WALLET",
+        "--ee-endpoint=http://besu_node:8551",
+        "--ee-jwt-secret-file=/var/lib/teku/data/token.txt",
+        "--validator-keys=/var/lib/teku/data/validator/keys:/var/lib/teku/data/validator/passwords",
+        "--p2p-port=9000",
+        "--rest-api-enabled=true",
+        "--rest-api-docs-enabled=true",
+      ]
+    depends_on:
+      - besu_node
+    volumes:
+      - ./teku:/var/lib/teku/data
+    ports:
+      # Map the p2p port(9000) and REST API port(5051)
+      - "9000:9000/tcp"
+      - "9000:9000/udp"
+      - "5051:5051"
+```
+
+  </TabItem>
+
   <TabItem value="Mainnet" label="Mainnet" >
 
 ```yaml

diff --git a/docs/how-to/configure/tls.md b/docs/how-to/configure/tls.md
@@ -4,6 +4,9 @@ description: Configure TLS communication between Teku and Web3Signer.
 sidebar_position: 4
 ---
 
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
 # Configure TLS
 
 You can configure TLS for communication between Teku and an external signer, for example [Web3Signer].
@@ -49,6 +52,9 @@ eth2
 
 Start Teku with the external signer, keystore, and truststore details:
 
+<Tabs>
+  <TabItem value="Holesky" label="Holesky" default>
+
 ```bash
 teku --network=holesky \
 --eth1-endpoint=http://localhost:8545 \
@@ -59,7 +65,22 @@ teku --network=holesky \
 --validators-external-signer-keystore=/Users/me/certs/teku_client_keystore.p12 \
 --validators-external-signer-keystore-password-file=/Users/me/certs/teku_keystore_password.txt
 ```
+  </TabItem>
+
+    <TabItem value="Ephemery" label="Ephemery" default>
 
+```bash
+teku --network=ephemery \
+--eth1-endpoint=http://localhost:8545 \
+--validators-external-signer-public-keys=0xa99a...e44c,0xb89b...4a0b \
+--validators-external-signer-url=https://localhost:9000 \
+--validators-external-signer-truststore=/Users/me/certs/web3signer_truststore.p12 \
+--validators-external-signer-truststore-password-file=/Users/me/certs/truststore_pass.txt \
+--validators-external-signer-keystore=/Users/me/certs/teku_client_keystore.p12 \
+--validators-external-signer-keystore-password-file=/Users/me/certs/teku_keystore_password.txt
+```
+  </TabItem>
+</Tabs>
 In the command:
 
 - Specify the JSON-RPC URL of the ETH1 node using [`--eth1-endpoint`](../../reference/cli/index.md#eth1-endpoint-eth1-endpoints).

diff --git a/docs/how-to/use-external-signer/use-web3signer.md b/docs/how-to/use-external-signer/use-web3signer.md
@@ -4,6 +4,9 @@ description: Use the Web3Signer external signing client.
 sidebar_position: 1
 ---
 
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
 # Use Web3Signer
 
 Teku supports the [Web3Signer] external signing client.
@@ -17,12 +20,27 @@ Teku supports the [Web3Signer] external signing client.
 
 Start Teku and specify the external signer options.
 
+<Tabs>
+  <TabItem value="Holesky" label="Holesky" default>
+
 ```bash
 teku --network=holesky \
 --eth1-endpoint=http://localhost:8545 \
 --validators-external-signer-public-keys=0xa99a...e44c,0xb89b...4a0b \
 --validators-external-signer-url=http://localhost:9000
 ```
+  </TabItem>
+
+  <TabItem value="Ephemery" label="Ephemery" default>
+
+```bash
+teku --network=ephemery \
+--eth1-endpoint=http://localhost:8545 \
+--validators-external-signer-public-keys=0xa99a...e44c,0xb89b...4a0b \
+--validators-external-signer-url=http://localhost:9000
+```
+  </TabItem>
+</Tabs>
 
 The command line specifies the following:
 

diff --git a/docs/reference/cli/subcommands/admin.md b/docs/reference/cli/subcommands/admin.md
@@ -318,7 +318,7 @@ Possible values are:
 | `sepolia` | Consensus layer | Test | Multi-client testnet |
 | `chiado` | Consensus layer | Test | Gnosis [testnet](https://docs.gnosischain.com/about/networks/chiado/) |
 | `lukso` | Consensus layer | Production | Network for the [Lukso chain](https://lukso.network/) |
-| `ephemery` | Consensus layer | Test | Multi-client testnet 
+| `ephemery` | Consensus layer | Test | Multi-client testnet |
 
 Predefined networks can provide defaults such the initial state of the network, bootnodes, and the address of the deposit contract.
 
@@ -626,6 +626,6 @@ Possible values are:
 | `sepolia` | Consensus layer | Test       | Multi-client testnet |
 | `chiado`  | Consensus layer | Test       | Gnosis [testnet](https://docs.gnosischain.com/about/networks/chiado/) |
 | `lukso`   | Consensus layer | Production | Network for the [Lukso chain](https://lukso.network/) |
-| `ephemery` | Consensus layer | Test | Multi-client testnet 
+| `ephemery` | Consensus layer | Test | Multi-client testnet |
 
 Predefined networks can provide defaults such the initial state of the network, bootnodes, and the address of the deposit contract.
diff --git a/docs/reference/cli/subcommands/migrate-database.md b/docs/reference/cli/subcommands/migrate-database.md
@@ -175,3 +175,4 @@ Possible values are:
 | `sepolia` | Consensus layer | Test | Multi-client testnet |
 | `chiado` | Consensus layer | Test | Gnosis [testnet](https://docs.gnosischain.com/about/networks/chiado/) |
 | `lukso` | Consensus layer | Production | Network for the [Lukso chain](https://lukso.network/) |
+| `ephemery` | Consensus layer | Test | Multi-client testnet |
diff --git a/docs/reference/cli/subcommands/slashing-protection.md b/docs/reference/cli/subcommands/slashing-protection.md
@@ -393,6 +393,7 @@ Possible values are:
 | `sepolia` | Consensus layer | Test | Multi-client testnet |
 | `chiado` | Consensus layer | Test | Gnosis [testnet](https://docs.gnosischain.com/about/networks/chiado/) |
 | `lukso` | Consensus layer | Production | Network for the [Lukso chain](https://lukso.network/) |
+| `ephemery` | Consensus layer | Test | Multi-client testnet |
 
 Predefined networks can provide defaults such the initial state of the network, bootnodes, and the address of the deposit contract.
 

diff --git a/docs/tutorials/configure-external-signer-tls.md b/docs/tutorials/configure-external-signer-tls.md
@@ -4,6 +4,9 @@ description: Configure TLS communication between Teku and Web3Signer.
 sidebar_position: 1
 ---
 
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
 # Configure TLS communication
 
 Configure TLS communication with an external signer such as [Web3Signer] which accepts connections from clients that use trusted CA certificates or self-signed certificates.
@@ -154,9 +157,12 @@ eth2 --slashing-protection-enabled=false
 Start Teku and specify the [keystore](#teku-keystore-and-password-file) and [truststore](#2-create-the-truststore-and-password-file) created earlier, with the accompanying password files.
 
 :::note
-This example connects to the Holesky testnet, and connects to the execution client's JSON-RPC URL at `http://127.0.0.1:8551`.
+This example connects to the Holesky or Ephemery testnet, and connects to the execution client's JSON-RPC URL at `http://127.0.0.1:8551`.
 :::
 
+<Tabs>
+  <TabItem value="Holesky" label="Holesky" default>
+
 ```bash
 teku --network=holesky \
 --ee-endpoint=http://127.0.0.1:8551 \
@@ -167,7 +173,22 @@ teku --network=holesky \
 --validators-external-signer-keystore=/Users/me/certs/teku_client_keystore.p12 \
 --validators-external-signer-keystore-password-file=/Users/me/certs/teku_keystore_password.txt
 ```
+  </TabItem>
+
+    <TabItem value="Ephemery" label="Ephemery" default>
 
+```bash
+teku --network=ephemery \
+--ee-endpoint=http://127.0.0.1:8551 \
+--validators-external-signer-public-keys=0xa99a...e44c,0xb89b...4a0b \
+--validators-external-signer-url=https://localhost:9000 \
+--validators-external-signer-truststore=/Users/me/certs/web3signer_truststore.p12 \
+--validators-external-signer-truststore-password-file=/Users/me/certs/truststore_pass.txt \
+--validators-external-signer-keystore=/Users/me/certs/teku_client_keystore.p12 \
+--validators-external-signer-keystore-password-file=/Users/me/certs/teku_keystore_password.txt
+```
+  </TabItem>
+</Tabs>
 <!-- links -->
 
 [Web3Signer]: https://docs.web3signer.consensys.net/en/latest/