Skip to content

Commit

Permalink
Add Holesky testnet.
Browse files Browse the repository at this point in the history
Signed-off-by: bgravenorst <[email protected]>
  • Loading branch information
bgravenorst committed Aug 24, 2023
1 parent 02b1a99 commit 930543a
Show file tree
Hide file tree
Showing 5 changed files with 56 additions and 7 deletions.
47 changes: 42 additions & 5 deletions docs/get-started/connect/testnet.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,16 @@
---
title: Connect to a testnet
description: Connect Teku to the Goerli or Sepolia testnet.
description: Connect Teku to a testnet.
sidebar_position: 1
---

# Connect to a testnet

Run Teku as a consensus client with any execution client on the [Goerli](https://github.com/eth-clients/goerli) and [Sepolia](https://github.com/eth-clients/sepolia) testnets.
Run Teku as a consensus client with any execution client on a testnet (for example [Goerli](https://github.com/eth-clients/goerli),
[Sepolia](https://github.com/eth-clients/sepolia), or [Holesky](https://github.com/eth-clients/holesky)).

If you're using [Hyperledger Besu](https://besu.hyperledger.org/en/stable/) as an execution client, you can follow the [Besu and Teku testnet tutorial](https://besu.hyperledger.org/en/latest/public-networks/tutorials/besu-teku-testnet/).
If you're using [Hyperledger Besu](https://besu.hyperledger.org/en/stable/) as an execution client, you can follow the
[Besu and Teku testnet tutorial](https://besu.hyperledger.org/en/latest/public-networks/tutorials/besu-teku-testnet/).

:::note

Expand Down Expand Up @@ -38,7 +40,8 @@ If you're running a beacon node only, skip to the [next step](#3-start-the-execu
If you're also running a validator client, create a test Ethereum address
(you can do this in [MetaMask](https://metamask.zendesk.com/hc/en-us/articles/360015289452-How-to-create-an-additional-account-in-your-wallet)).
Fund this address with testnet ETH (32 ETH and gas fees for each validator) using a faucet.
See the list of [Goerli faucets](https://github.com/eth-clients/goerli#meta-data-g%C3%B6rli) and [Sepolia faucets](https://github.com/eth-clients/sepolia#meta-data-sepolia).
See the list of [Goerli faucets](https://github.com/eth-clients/goerli#meta-data-g%C3%B6rli),
[Sepolia faucets](https://github.com/eth-clients/sepolia#meta-data-sepolia), and [Holesky faucets](https://holesky.ethpandaops.io/).

:::note

Expand Down Expand Up @@ -95,6 +98,17 @@ teku \
--rest-api-enabled=true
```

# Holesky

```bash
teku \
--network=holesky \
--ee-endpoint=http://localhost:8551 \
--ee-jwt-secret-file=<path to jwtsecret.hex> \
--metrics-enabled=true \
--rest-api-enabled=true
```

# Sepolia

```bash
Expand Down Expand Up @@ -122,7 +136,8 @@ You can also use [Prometheus and Grafana](../../how-to/monitor/use-metrics.md) t

#### Single process

To run the Teku beacon node and validator client in a single process, run the following command or [specify the options in the configuration file](../../how-to/configure/use-config-file.md):
To run the Teku beacon node and validator client in a single process, run the following command or
[specify the options in the configuration file](../../how-to/configure/use-config-file.md):

<!--tabs-->

Expand All @@ -139,6 +154,19 @@ teku \
--validator-keys=<path to key file>:<path to password file>[,<path to key file>:<path to password file>,...]
```

# Holesky

```bash
teku \
--network=holesky \
--ee-endpoint=http://localhost:8551 \
--ee-jwt-secret-file=<path to jwtsecret.hex> \
--metrics-enabled=true \
--rest-api-enabled=true \
--validators-proposer-default-fee-recipient=<ETH address> \
--validator-keys=<path to key file>:<path to password file>[,<path to key file>:<path to password file>,...]
```

# Sepolia

Sepolia is a permissioned network and you can't run a validator client on it without [requesting to become a validator](https://notes.ethereum.org/zvkfSmYnT0-uxwwEegbCqg) first.
Expand Down Expand Up @@ -170,6 +198,15 @@ teku validator-client \
--validator-keys=<path to key file>:<path to password file>[,<path to key file>:<path to password file>,...]
```

# Holesky

```bash
teku validator-client \
--network=goerli \
--beacon-node-api-endpoint=<endpoint> \
--validator-keys=<path to key file>:<path to password file>[,<path to key file>:<path to password file>,...]
```

# Sepolia

Sepolia is a permissioned network and you can't run a validator client on it without [requesting to become a validator](https://notes.ethereum.org/zvkfSmYnT0-uxwwEegbCqg) first.
Expand Down
12 changes: 10 additions & 2 deletions docs/reference/cli/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -665,10 +665,17 @@ deposit-snapshot-enabled: false

Enables or disables using a bundled deposit contract tree snapshot and persisting the tree after finalization. The default is `true`.

Normally, at sync, Teku requests all deposit logs from the execution layer up to the head. At each startup, Teku loads all deposits from the disk and replays them to recreate the merkle tree. Both operations consume peer resources and delay node availability on restart. The feature enabled by this option dramatically decreases the time of both operations by bundling deposit tree snapshots in the Teku distribution for all major networks (Mainnet, Gnosis, Goerli, and Sepolia) and persisting the current tree after finalization. Instead of replaying thousands of deposits on startup, Teku loads the bundled tree or a saved one, whichever is the latest.
Normally, at sync, Teku requests all deposit logs from the execution layer up to the head. At each startup, Teku
loads all deposits from the disk and replays them to recreate the merkle tree. Both operations consume peer resources
and delay node availability on restart. The feature enabled by this option dramatically decreases the time of both
operations by bundling deposit tree snapshots in the Teku distribution for all major
networks (Mainnet, Gnosis, Goerli, and Sepolia) and persisting the current tree after finalization. Instead of
replaying thousands of deposits on startup, Teku loads the bundled tree or a saved one, whichever is the latest.

:::info Security considerations
If a malicious peer changes the bundled tree, Teku throws `InvalidDepositEventsException` on the next deposit received from the execution layer. The malicious peer can't follow up the chain, and so can't propose with an incorrect deposit tree snapshot.
If a malicious peer changes the bundled tree, Teku throws `InvalidDepositEventsException` on the next deposit received
from the execution layer. The malicious peer can't follow up the chain, and so can't propose with an incorrect
deposit tree snapshot.
:::

### exchange-capabilities-monitoring-enabled
Expand Down Expand Up @@ -1361,6 +1368,7 @@ Possible values are:
| `minimal` | Consensus layer | Test | Used for local testing and development networks |
| `goerli` | Consensus layer | Test | Multi-client testnet |
| `gnosis` | Consensus layer | Production | Network for the [Gnosis chain](https://www.gnosis.io/) |
| `holesky` | Consensus layer | Test | Multi-client testnet |
| `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/) |
Expand Down
2 changes: 2 additions & 0 deletions docs/reference/cli/subcommands/admin.md
Original file line number Diff line number Diff line change
Expand Up @@ -287,6 +287,7 @@ Possible values are:
| --- | --- | --- | --- |
| `mainnet` | Consensus layer | Production | Main network |
| `minimal` | Consensus layer | Test | Used for local testing and development networks |
| `holesky` | Consensus layer | Test | Multi-client testnet |
| `goerli` | Consensus layer | Test | Multi-client testnet |
| `gnosis` | Consensus layer | Production | Network for the [Gnosis chain](https://www.gnosis.io/) |
| `sepolia` | Consensus layer | Test | Multi-client testnet |
Expand Down Expand Up @@ -573,6 +574,7 @@ Possible values are:
| `minimal` | Consensus layer | Test | Used for local testing and development networks |
| `goerli` | Consensus layer | Test | Multi-client testnet |
| `gnosis` | Consensus layer | Production | Network for the [Gnosis chain](https://www.gnosis.io/) |
| `holesky` | Consensus layer | Test | Multi-client testnet |
| `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/) |
Expand Down
1 change: 1 addition & 0 deletions docs/reference/cli/subcommands/migrate-database.md
Original file line number Diff line number Diff line change
Expand Up @@ -158,6 +158,7 @@ Possible values are:
| `minimal` | Consensus layer | Test | Used for local testing and development networks |
| `goerli` | Consensus layer | Test | Multi-client testnet |
| `gnosis` | Consensus layer | Production | Network for the [Gnosis chain](https://www.gnosis.io/) |
| `holesky` | Consensus layer | Test | Multi-client testnet |
| `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/) |
1 change: 1 addition & 0 deletions docs/reference/cli/subcommands/slashing-protection.md
Original file line number Diff line number Diff line change
Expand Up @@ -367,6 +367,7 @@ Possible values are:
| `minimal` | Consensus layer | Test | Used for local testing and development networks |
| `goerli` | Consensus layer | Test | Multi-client testnet |
| `gnosis` | Consensus layer | Production | Network for the [Gnosis chain](https://www.gnosis.io/) |
| `holesky` | Consensus layer | Test | Multi-client testnet |
| `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/) |
Expand Down

0 comments on commit 930543a

Please sign in to comment.