From 8c48f8ee3e99c3148acc252b3a86c6634b6e9850 Mon Sep 17 00:00:00 2001 From: Joan E <153745173+joaniefromtheblock@users.noreply.github.com> Date: Tue, 17 Sep 2024 14:06:30 +0000 Subject: [PATCH 1/5] Remove Hyperledger from product name --- README.md | 2 +- docs/concepts/node-types.md | 2 +- docs/get-started/connect/mainnet.md | 2 +- docs/get-started/connect/testnet.md | 2 +- docs/get-started/install/run-docker-image.md | 4 ++-- docs/how-to/configure/tls.md | 4 ++-- docs/tutorials/configure-external-signer-tls.md | 4 ++-- 7 files changed, 10 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 6787c818a..c863bf236 100644 --- a/README.md +++ b/README.md @@ -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. diff --git a/docs/concepts/node-types.md b/docs/concepts/node-types.md index 107029a34..7476bfec3 100644 --- a/docs/concepts/node-types.md +++ b/docs/concepts/node-types.md @@ -7,7 +7,7 @@ sidebar_position: 5 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 diff --git a/docs/get-started/connect/mainnet.md b/docs/get-started/connect/mainnet.md index 941a8dc05..3ce109732 100644 --- a/docs/get-started/connect/mainnet.md +++ b/docs/get-started/connect/mainnet.md @@ -15,7 +15,7 @@ both [an execution client and a consensus client](../../concepts/node-types.md#e 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 diff --git a/docs/get-started/connect/testnet.md b/docs/get-started/connect/testnet.md index a5330c52c..e995d110d 100644 --- a/docs/get-started/connect/testnet.md +++ b/docs/get-started/connect/testnet.md @@ -12,7 +12,7 @@ import TabItem from '@theme/TabItem'; 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 diff --git a/docs/get-started/install/run-docker-image.md b/docs/get-started/install/run-docker-image.md index db6a03a32..10d417049 100644 --- a/docs/get-started/install/run-docker-image.md +++ b/docs/get-started/install/run-docker-image.md @@ -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 @@ -200,4 +200,4 @@ services: -[Hyperledger Besu]: https://besu.hyperledger.org/en/stable/ +[]: https://besu.hyperledger.org/en/stable/ diff --git a/docs/how-to/configure/tls.md b/docs/how-to/configure/tls.md index d77fdafb9..fc209fd58 100644 --- a/docs/how-to/configure/tls.md +++ b/docs/how-to/configure/tls.md @@ -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 @@ -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 +[HyperledgerBesu]: 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/ diff --git a/docs/tutorials/configure-external-signer-tls.md b/docs/tutorials/configure-external-signer-tls.md index 99c4df3ab..546019083 100644 --- a/docs/tutorials/configure-external-signer-tls.md +++ b/docs/tutorials/configure-external-signer-tls.md @@ -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). @@ -171,5 +171,5 @@ teku --network=holesky \ [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/ From 69c5e123fe3c77f0941315afa1099f4d990c5f7f Mon Sep 17 00:00:00 2001 From: Joan E <153745173+joaniefromtheblock@users.noreply.github.com> Date: Tue, 17 Sep 2024 19:31:19 +0000 Subject: [PATCH 2/5] remove mistake edit --- docs/get-started/install/run-docker-image.md | 2 +- docs/how-to/configure/tls.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/get-started/install/run-docker-image.md b/docs/get-started/install/run-docker-image.md index 10d417049..19f43a0d7 100644 --- a/docs/get-started/install/run-docker-image.md +++ b/docs/get-started/install/run-docker-image.md @@ -200,4 +200,4 @@ services: -[]: https://besu.hyperledger.org/en/stable/ +[Besu]: https://besu.hyperledger.org/en/stable/ diff --git a/docs/how-to/configure/tls.md b/docs/how-to/configure/tls.md index fc209fd58..ccf6fe2b5 100644 --- a/docs/how-to/configure/tls.md +++ b/docs/how-to/configure/tls.md @@ -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 -[HyperledgerBesu]: 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/ From 842dc7eeffd3589e7555fc1e84756f233fd7b1e4 Mon Sep 17 00:00:00 2001 From: Joan E <153745173+joaniefromtheblock@users.noreply.github.com> Date: Tue, 17 Sep 2024 21:09:40 +0000 Subject: [PATCH 3/5] update line length --- docs/get-started/connect/mainnet.md | 11 ++++++++--- docs/get-started/connect/testnet.md | 17 ++++++++++++----- 2 files changed, 20 insertions(+), 8 deletions(-) diff --git a/docs/get-started/connect/mainnet.md b/docs/get-started/connect/mainnet.md index 3ce109732..c0e9245e7 100644 --- a/docs/get-started/connect/mainnet.md +++ b/docs/get-started/connect/mainnet.md @@ -50,7 +50,8 @@ need them to [create the validator password files](#create-a-password-file-for-e 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. +If specifying directories, password files must have the same name as the keys, but use the `.txt` extension. :::info @@ -130,7 +131,9 @@ Specify: - 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. +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: @@ -155,7 +158,9 @@ teku validator-client \ 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 diff --git a/docs/get-started/connect/testnet.md b/docs/get-started/connect/testnet.md index e995d110d..40a0d8f94 100644 --- a/docs/get-started/connect/testnet.md +++ b/docs/get-started/connect/testnet.md @@ -17,7 +17,8 @@ If you're using [Besu](https://besu.hyperledger.org/en/stable/) as an execution :::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. +You can connect your consensus client using the beacon node only, without any validator duties. ::: @@ -61,7 +62,8 @@ need them to [create the validator password files](#create-a-password-file-for-e 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. +If specifying directories, password files must have the same name as the keys, but use the `.txt` extension. :::info @@ -130,7 +132,8 @@ You can modify the option values and add other [command line options](../../refe 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/). +It may take up to multiple days for your validator to be activated and start proposing blocks. You can also use [Prometheus and Grafana](../../how-to/monitor/use-metrics.md) to monitor your nodes. @@ -168,7 +171,9 @@ Specify: - 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. +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. @@ -199,7 +204,9 @@ Sepolia is a permissioned network and you can't run a validator client on it wit 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 From efac018a17d1019a36a7495e5a1f4e305c22e42e Mon Sep 17 00:00:00 2001 From: Joan E <153745173+joaniefromtheblock@users.noreply.github.com> Date: Tue, 17 Sep 2024 21:20:08 +0000 Subject: [PATCH 4/5] updates for vale --- docs/get-started/connect/mainnet.md | 9 +++++---- docs/get-started/connect/testnet.md | 2 +- 2 files changed, 6 insertions(+), 5 deletions(-) diff --git a/docs/get-started/connect/mainnet.md b/docs/get-started/connect/mainnet.md index c0e9245e7..8c8be69e3 100644 --- a/docs/get-started/connect/mainnet.md +++ b/docs/get-started/connect/mainnet.md @@ -50,7 +50,7 @@ need them to [create the validator password files](#create-a-password-file-for-e 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. +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. :::info @@ -106,7 +106,8 @@ You can modify the option values and add other [command line options](../../refe 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/). +It may take up to multiple days for your validator to be activated and start proposing blocks. You can also use [Prometheus and Grafana](../../how-to/monitor/use-metrics.md) to monitor your nodes. @@ -131,8 +132,8 @@ Specify: - 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. +- 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. Also, in the command: diff --git a/docs/get-started/connect/testnet.md b/docs/get-started/connect/testnet.md index 40a0d8f94..2ef8ac7c7 100644 --- a/docs/get-started/connect/testnet.md +++ b/docs/get-started/connect/testnet.md @@ -133,7 +133,7 @@ You can modify the option values and add other [command line options](../../refe 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. +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. From da4313e5dbc0c2950eabccd680baee6069eb39a3 Mon Sep 17 00:00:00 2001 From: Joan E <153745173+joaniefromtheblock@users.noreply.github.com> Date: Wed, 18 Sep 2024 04:42:54 -0400 Subject: [PATCH 5/5] make active --- docs/get-started/connect/mainnet.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/get-started/connect/mainnet.md b/docs/get-started/connect/mainnet.md index 8c8be69e3..2c0e8bf75 100644 --- a/docs/get-started/connect/mainnet.md +++ b/docs/get-started/connect/mainnet.md @@ -107,7 +107,7 @@ You can modify the option values and add other [command line options](../../refe 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. +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.