Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add ephemery command to documentation #621

Merged
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
remove ephemery tab from the validator section
Signed-off-by: gconnect <[email protected]>
gconnect committed Nov 4, 2024
commit 18da0345abbe123c3dedbdca66be9fcb53047f4a
12 changes: 0 additions & 12 deletions docs/get-started/connect/testnet.md
Original file line number Diff line number Diff line change
@@ -10,22 +10,22 @@
# Connect to a testnet

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

Check failure on line 13 in docs/get-started/connect/testnet.md

GitHub Actions / Lint

Trailing spaces

docs/get-started/connect/testnet.md:13:53 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1] https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md009.md
[Ephemery](https://ephemery.dev/)).

Check failure on line 14 in docs/get-started/connect/testnet.md

GitHub Actions / Spelling

[vale] reported by reviewdog 🐶 [Vale.Spelling] Did you really mean 'Ephemery'? Raw Output: {"message": "[Vale.Spelling] Did you really mean 'Ephemery'?", "location": {"path": "docs/get-started/connect/testnet.md", "range": {"start": {"line": 14, "column": 2}}}, "severity": "ERROR"}

If you're using [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

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.

Check failure on line 21 in docs/get-started/connect/testnet.md

GitHub Actions / Lint

Trailing spaces

docs/get-started/connect/testnet.md:21:178 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1] https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md009.md
You can connect your consensus client using the beacon node only, without any validator duties.

:::

:::note

Ephemery is a single network that rolls back to the genesis after a set period of time. Ephemery is focused on short term and heavy testing usecases. The purpose of this is also to avoid problems like insufficient testnet funds, inactive validators, state bloat, and similar issues faced by long-running testnets.

Check failure on line 28 in docs/get-started/connect/testnet.md

GitHub Actions / Spelling

[vale] reported by reviewdog 🐶 [Vale.Spelling] Did you really mean 'Ephemery'? Raw Output: {"message": "[Vale.Spelling] Did you really mean 'Ephemery'?", "location": {"path": "docs/get-started/connect/testnet.md", "range": {"start": {"line": 28, "column": 1}}}, "severity": "ERROR"}

Check failure on line 28 in docs/get-started/connect/testnet.md

GitHub Actions / Spelling

[vale] reported by reviewdog 🐶 [Vale.Spelling] Did you really mean 'Ephemery'? Raw Output: {"message": "[Vale.Spelling] Did you really mean 'Ephemery'?", "location": {"path": "docs/get-started/connect/testnet.md", "range": {"start": {"line": 28, "column": 89}}}, "severity": "ERROR"}

Check failure on line 28 in docs/get-started/connect/testnet.md

GitHub Actions / Spelling

[vale] reported by reviewdog 🐶 [Vale.Spelling] Did you really mean 'usecases'? Raw Output: {"message": "[Vale.Spelling] Did you really mean 'usecases'?", "location": {"path": "docs/get-started/connect/testnet.md", "range": {"start": {"line": 28, "column": 141}}}, "severity": "ERROR"}

Check failure on line 28 in docs/get-started/connect/testnet.md

GitHub Actions / Lint

Line length

docs/get-started/connect/testnet.md:28:201 MD013/line-length Line length [Expected: 200; Actual: 313] https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md013.md

:::

@@ -52,7 +52,7 @@
(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 [Holesky faucets](https://github.com/eth-clients/holesky#metadata) or
[Sepolia faucets](https://github.com/eth-clients/sepolia#meta-data-sepolia) or [Ephemery faucets](https://ephemery-faucet.pk910.de/).

Check failure on line 55 in docs/get-started/connect/testnet.md

GitHub Actions / Spelling

[vale] reported by reviewdog 🐶 [Vale.Spelling] Did you really mean 'Ephemery'? Raw Output: {"message": "[Vale.Spelling] Did you really mean 'Ephemery'?", "location": {"path": "docs/get-started/connect/testnet.md", "range": {"start": {"line": 55, "column": 81}}}, "severity": "ERROR"}

:::note

@@ -60,7 +60,7 @@

:::

Generate validator keys for one or more validators using the [Holesky Staking Launchpad](https://holesky.launchpad.ethereum.org/) or [Ephemery Staking Launchpad](https://launchpad.ephemery.dev/).

Check failure on line 63 in docs/get-started/connect/testnet.md

GitHub Actions / Spelling

[vale] reported by reviewdog 🐶 [Vale.Spelling] Did you really mean 'Ephemery'? Raw Output: {"message": "[Vale.Spelling] Did you really mean 'Ephemery'?", "location": {"path": "docs/get-started/connect/testnet.md", "range": {"start": {"line": 63, "column": 135}}}, "severity": "ERROR"}

Remember the passwords that you use to create the validator keys, because you
need them to [create the validator password files](#create-a-password-file-for-each-validator-key).
@@ -69,7 +69,7 @@

For each validator key, create a text file containing the password to decrypt the key.

Teku allows you to specify individual keys and passwords in the command line, or you can specify directories from which to load keys and passwords.

Check failure on line 72 in docs/get-started/connect/testnet.md

GitHub Actions / Lint

Trailing spaces

docs/get-started/connect/testnet.md:72:148 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1] https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md009.md
If specifying directories, password files must have the same name as the keys, but use the `.txt` extension.

:::info
@@ -124,7 +124,7 @@
```

</TabItem>
<TabItem value="Ephemery" label="Ephemery" >

Check failure on line 127 in docs/get-started/connect/testnet.md

GitHub Actions / Spelling

[vale] reported by reviewdog 🐶 [Vale.Spelling] Did you really mean 'Ephemery'? Raw Output: {"message": "[Vale.Spelling] Did you really mean 'Ephemery'?", "location": {"path": "docs/get-started/connect/testnet.md", "range": {"start": {"line": 127, "column": 19}}}, "severity": "ERROR"}

```bash
teku \
@@ -139,7 +139,7 @@
</TabItem>
</Tabs>


Check failure on line 142 in docs/get-started/connect/testnet.md

GitHub Actions / Lint

Multiple consecutive blank lines

docs/get-started/connect/testnet.md:142 MD012/no-multiple-blanks Multiple consecutive blank lines [Expected: 1; Actual: 2] https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md012.md
Specify:

- The path to the `jwtsecret.hex` file generated in [step 1] using the
@@ -153,7 +153,7 @@

You can run the Teku beacon node and validator client as a [single process](#single-process) or as [separate processes](#separate-processes).

You can check your validator status by searching your Ethereum address on the [Holesky Beacon Chain explorer](https://holesky.beaconcha.in/) or [Ephemery Beacon Chain Explorer](https://beaconchain.ephemery.dev).

Check failure on line 156 in docs/get-started/connect/testnet.md

GitHub Actions / Lint

Trailing spaces

docs/get-started/connect/testnet.md:156:212 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1] https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md009.md

Check failure on line 156 in docs/get-started/connect/testnet.md

GitHub Actions / Lint

Line length

docs/get-started/connect/testnet.md:156:201 MD013/line-length Line length [Expected: 200; Actual: 212] https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md013.md
Your validator might take multiple days to activate and start proposing blocks.

You can also use [Prometheus and Grafana](../../how-to/monitor/use-metrics.md) to monitor your nodes.
@@ -208,8 +208,8 @@
- The URL of a checkpoint sync endpoint using the
[`--checkpoint-sync-url`](../../reference/cli/index.md#checkpoint-sync-url) option.
- An Ethereum address you own as the default fee recipient using the [`--validators-proposer-default-fee-recipient`](../../reference/cli/index.md#validators-proposer-default-fee-recipient) option.
- The paths to the keystore `.json` file and password `.txt` file created in [step 2](#create-a-password-file-for-each-validator-key) for each validator using the [`--validator-keys`](../../reference/cli/index.md#validator-keys) option.

Check failure on line 211 in docs/get-started/connect/testnet.md

GitHub Actions / Lint

Trailing spaces

docs/get-started/connect/testnet.md:211:237 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1] https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md009.md

Check failure on line 211 in docs/get-started/connect/testnet.md

GitHub Actions / Lint

Line length

docs/get-started/connect/testnet.md:211:201 MD013/line-length Line length [Expected: 200; Actual: 237] https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md013.md
Separate the `.json` and `.txt` files with a colon, and separate entries for multiple validators with commas.

Check failure on line 212 in docs/get-started/connect/testnet.md

GitHub Actions / Lint

Trailing spaces

docs/get-started/connect/testnet.md:212:110 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1] https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md009.md
Alternatively, specify paths to directories to load multiple keys and passwords from.

You can modify the option values and add other [command line options](../../reference/cli/index.md) as needed.
@@ -235,18 +235,6 @@

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.

</TabItem>

<TabItem value="Ephemery" label="Ephemery" default>

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

</TabItem>
</Tabs>

Specify:
@@ -269,7 +257,7 @@
## 6. Stake ETH

Stake your testnet ETH for one or more validators using the
[Holesky Staking Launchpad](https://holesky.launchpad.ethereum.org/) or [Ephemery Staking Launchpad](https://launchpad.ephemery.dev).

Check failure on line 260 in docs/get-started/connect/testnet.md

GitHub Actions / Spelling

[vale] reported by reviewdog 🐶 [Vale.Spelling] Did you really mean 'Ephemery'? Raw Output: {"message": "[Vale.Spelling] Did you really mean 'Ephemery'?", "location": {"path": "docs/get-started/connect/testnet.md", "range": {"start": {"line": 260, "column": 74}}}, "severity": "ERROR"}

You can check your validator status by searching your Ethereum address on the
[Holesky Beacon Chain explorer](https://holesky.beaconcha.in/) or [Ephemery Beacon Chain explorer](https://beaconchain.ephemery.dev).
Loading