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

Remove Hyperledger from product name #606

Merged
merged 6 commits into from
Sep 18, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
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
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,5 @@
This documentation repository is built using [Docusaurus](https://docusaurus.io/), and the doc
site is published at [`docs.teku.consensys.net`](https://docs.teku.consensys.net/).

View the [ConsenSys doc contribution guidelines](https://docs-template.consensys.net/) for
View the [Consensys doc contribution guidelines](https://docs-template.consensys.net/) for
information about submitting documentation changes and previewing the site locally.
2 changes: 1 addition & 1 deletion docs/concepts/node-types.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
An Ethereum node is an instance of an Ethereum client, which consists of:

- A consensus client (for example, Teku)
- An execution client (for example, Hyperledger Besu)
- An execution client (for example, Besu)

:::info

Expand Down Expand Up @@ -42,3 +42,3 @@

To become a validator, you must also run a validator client (either [in the same process as the beacon node](../get-started/start-teku.md#start-the-clients-in-a-single-process) or [separately](../get-started/start-teku.md#run-the-clients-separately)).

Expand Down
16 changes: 11 additions & 5 deletions docs/get-started/connect/mainnet.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@

Run Teku as a consensus client with any execution client on Ethereum Mainnet.

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

## Prerequisites
Expand Down Expand Up @@ -50,7 +50,8 @@

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. If specifying directories, password files must have the same name as the keys, but use the `.txt` extension.
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 warning on line 53 in docs/get-started/connect/mainnet.md

View workflow job for this annotation

GitHub Actions / Spelling

[vale] reported by reviewdog 🐶 [Microsoft.Vocab] Verify your use of 'allows' with the A-Z word list. Raw Output: {"message": "[Microsoft.Vocab] Verify your use of 'allows' with the A-Z word list.", "location": {"path": "docs/get-started/connect/mainnet.md", "range": {"start": {"line": 53, "column": 6}}}, "severity": "INFO"}
If specifying directories, password files must have the same name as the keys, but use the `.txt` extension.

:::info

Expand Down Expand Up @@ -105,7 +106,8 @@

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 [Beacon Chain explorer](https://beaconcha.in/). It may take up to multiple days for your validator to be activated and start proposing blocks.
You can check your validator status by searching your Ethereum address on the [Beacon Chain explorer](https://beaconcha.in/).
Your validator might take up to 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.

Expand All @@ -130,7 +132,9 @@
- 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. Separate the `.json` and `.txt` files with a colon, and separate entries for multiple validators with commas. Alternatively, specify paths to directories to load multiple keys and passwords from.
- 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 135 in docs/get-started/connect/mainnet.md

View workflow job for this annotation

GitHub Actions / Lint

Line length

docs/get-started/connect/mainnet.md:135:201 MD013/line-length Line length [Expected: 200; Actual: 236] 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.
Alternatively, specify paths to directories to load multiple keys and passwords from.

Also, in the command:

Expand All @@ -154,8 +158,10 @@

Specify:

- The location of one or more beacon node API endpoints using the [`--beacon-node-api-endpoint`](../../reference/cli/subcommands/validator-client.md#beacon-node-api-endpoint-beacon-node-api-endpoints) option.

Check failure on line 161 in docs/get-started/connect/mainnet.md

View workflow job for this annotation

GitHub Actions / Lint

Line length

docs/get-started/connect/mainnet.md:161:201 MD013/line-length Line length [Expected: 200; Actual: 208] https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md013.md
- 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. Separate the `.json` and `.txt` files with a colon, and separate entries for multiple validators with commas. Alternatively, specify paths to directories to load multiple keys and passwords from.
- 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 162 in docs/get-started/connect/mainnet.md

View workflow job for this annotation

GitHub Actions / Lint

Trailing spaces

docs/get-started/connect/mainnet.md:162: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 162 in docs/get-started/connect/mainnet.md

View workflow job for this annotation

GitHub Actions / Lint

Line length

docs/get-started/connect/mainnet.md:162: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 163 in docs/get-started/connect/mainnet.md

View workflow job for this annotation

GitHub Actions / Lint

Trailing spaces

docs/get-started/connect/mainnet.md:163: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.

## 5. Wait for the clients to sync

Expand Down
19 changes: 13 additions & 6 deletions docs/get-started/connect/testnet.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,13 @@
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)).

If you're using [Hyperledger Besu](https://besu.hyperledger.org/en/stable/) as an execution client, you can follow the
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. You can connect your consensus client using the beacon node only, without any validator duties.
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 20 in docs/get-started/connect/testnet.md

View workflow job for this annotation

GitHub Actions / Lint

Trailing spaces

docs/get-started/connect/testnet.md:20: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.

:::

Expand Down Expand Up @@ -61,7 +62,8 @@

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. If specifying directories, password files must have the same name as the keys, but use the `.txt` extension.
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 65 in docs/get-started/connect/testnet.md

View workflow job for this annotation

GitHub Actions / Lint

Trailing spaces

docs/get-started/connect/testnet.md:65: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

Check warning on line 65 in docs/get-started/connect/testnet.md

View workflow job for this annotation

GitHub Actions / Spelling

[vale] reported by reviewdog 🐶 [Microsoft.Vocab] Verify your use of 'allows' with the A-Z word list. Raw Output: {"message": "[Microsoft.Vocab] Verify your use of 'allows' with the A-Z word list.", "location": {"path": "docs/get-started/connect/testnet.md", "range": {"start": {"line": 65, "column": 6}}}, "severity": "INFO"}
If specifying directories, password files must have the same name as the keys, but use the `.txt` extension.

:::info

Expand Down Expand Up @@ -130,7 +132,8 @@

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/). It may take up to multiple days for your validator to be activated and start proposing blocks.
You can check your validator status by searching your Ethereum address on the [Holesky Beacon Chain explorer](https://holesky.beaconcha.in/).

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

View workflow job for this annotation

GitHub Actions / Lint

Trailing spaces

docs/get-started/connect/testnet.md:135:142 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1] https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md009.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.

Expand Down Expand Up @@ -168,7 +171,9 @@
- 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. Separate the `.json` and `.txt` files with a colon, and separate entries for multiple validators with commas. Alternatively, specify paths to directories to load multiple keys and passwords from.
- 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 174 in docs/get-started/connect/testnet.md

View workflow job for this annotation

GitHub Actions / Lint

Trailing spaces

docs/get-started/connect/testnet.md:174: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
Separate the `.json` and `.txt` files with a colon, and separate entries for multiple validators with commas.
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.

Expand Down Expand Up @@ -199,7 +204,9 @@
Specify:

- The location of one or more beacon node API endpoints using the [`--beacon-node-api-endpoint`](../../reference/cli/subcommands/validator-client.md#beacon-node-api-endpoint-beacon-node-api-endpoints) 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. Separate the `.json` and `.txt` files with a colon, and separate entries for multiple validators with commas. Alternatively, specify paths to directories to load multiple keys and passwords from.
- 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.
Separate the `.json` and `.txt` files with a colon, and separate entries for multiple validators with commas
Alternatively, specify paths to directories to load multiple keys and passwords from.

## 5. Wait for the clients to sync

Expand Down
4 changes: 2 additions & 2 deletions docs/get-started/install/run-docker-image.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ docker run -p 30303:30303/tcp -p 30303:30303/udp -p 5051:5051 --mount type=bind,

- [Docker Compose](https://docs.docker.com/compose/)

The following `docker-compose.yml` file starts a [Hyperledger Besu] and Teku node.
The following `docker-compose.yml` file starts a [Besu] and Teku node.

:::note

Expand Down Expand Up @@ -200,4 +200,4 @@ services:

<!-- Links -->

[Hyperledger Besu]: https://besu.hyperledger.org/en/stable/
[Besu]: https://besu.hyperledger.org/en/stable/
4 changes: 2 additions & 2 deletions docs/how-to/configure/tls.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ The [Teku and Web3Signer TLS configuration tutorial] provides instructions to cr

- [Teku's password-protected PKCS12 or JKS keystore and password file].
- [Web3Signer's password-protected PKCS12 or JKS truststore and password file].
- ETH1 client (for example [Hyperledger Besu]) synced to the required network.
- ETH1 client (for example [Besu]) synced to the required network.

## Start Web3Signer

Expand Down Expand Up @@ -76,6 +76,6 @@ In the command:
[Known clients file]: ../../tutorials/configure-external-signer-tls.md#3-create-the-known-clients-file
[Teku's password-protected PKCS12 or JKS keystore and password file]: ../../tutorials/configure-external-signer-tls.md#teku-keystore-and-password-file
[Web3Signer's password-protected PKCS12 or JKS truststore and password file]: ../../tutorials/configure-external-signer-tls.md#2-create-the-truststore-and-password-file
[Hyperledger Besu]: https://besu.hyperledger.org/stable/public-networks/get-started/install
[Besu]: https://besu.hyperledger.org/stable/public-networks/get-started/install
[Slashing protection]: https://docs.web3signer.consensys.net/en/latest/concepts/slashing-protection/
[configure your slashing protection database]: https://docs.web3signer.consensys.net/en/latest/HowTo/Configure-Slashing-Protection/
4 changes: 2 additions & 2 deletions docs/tutorials/configure-external-signer-tls.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ This tutorial configures TLS between Teku and Web3Signer, and uses the [`keytool
- [Web3Signer signing key files](https://docs.web3signer.consensys.net/en/latest/HowTo/Use-Signing-Keys/) for validators on the testnet.
- [Teku Installed](../get-started/install/install-binaries.md).
- [Java `keytool`](https://docs.oracle.com/en/java/javase/12/tools/keytool.html).
- A running execution client such as [Hyperledger Besu].
- A running execution client such as [Besu].

This tutorial connects to the Holesky testnet.
You can [run a Besu node on Holesky](https://besu.hyperledger.org/development/public-networks/get-started/start-node#run-a-node-on-holesky-testnet).
Expand Down Expand Up @@ -171,5 +171,5 @@ teku --network=holesky \
<!-- links -->

[Web3Signer]: https://docs.web3signer.consensys.net/en/latest/
[Hyperledger Besu]: https://besu.hyperledger.org/development/public-networks/get-started/install
[Besu]: https://besu.hyperledger.org/development/public-networks/get-started/install
[Web3Signer slashing protection]: https://docs.web3signer.consensys.net/en/latest/concepts/slashing-protection/
Loading