CipherLabs
/
besu-docs
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Post-merge updates to match Teku docs (#1179)

Browse Source 
Signed-off-by: Alexandra Tran <alexandra.tran@consensys.net>

Signed-off-by: Alexandra Tran <alexandra.tran@consensys.net>
pull/1181/head
Alexandra Tran 2 years ago committed by GitHub
parent 80a58d10f1
commit 10be480c5c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 62 additions and 60 deletions
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Show Stats Download Patch File Download Diff File
  1. 28
      docs/public-networks/concepts/proof-of-stake.md
  2. 3
      docs/public-networks/get-started/connect/mainnet.md
  3. 3
      docs/public-networks/get-started/connect/testnet.md
  4. 45
      docs/public-networks/tutorials/besu-teku-mainnet.md
  5. 43
      docs/public-networks/tutorials/besu-teku-testnet.md

28
docs/public-networks/concepts/proof-of-stake.md
Unescape View File

@ -7,6 +7,20 @@ description: Ethereum proof of stake
[The Merge](the-merge.md) transitioned Ethereum Mainnet to
[proof of stake (PoS)](https://ethereum.org/en/developers/docs/consensus-mechanisms/pos/) consensus.
In Ethereum's PoS, you must run a [full node](the-merge.md#execution-and-consensus-clients) and
[stake 32 ETH](https://ethereum.org/en/staking/) to become a validator.
!!! important
Withdrawing staked ETH isn't yet supported and will be included in a separate upgrade following The Merge.
!!! note
You must run a beacon node and an execution client to operate a full node on Mainnet.
To become a validator, you must also run a validator client (either
[in the same process as the beacon node](https://docs.teku.consensys.net/en/stable/HowTo/Get-Started/Run-Teku/#start-the-clients-in-a-single-process) or
[separately](https://docs.teku.consensys.net/en/stable/HowTo/Get-Started/Run-Teku/#run-the-clients-separately)).
PoS is preferred over proof of work and proof of authority as a consensus mechanism
because it is more secure, requires less energy, and lowers the barrier to entry.
@ -36,17 +50,3 @@ If the block is valid, the execution client includes it in the execution chain a
state storage.
If a consensus block receives attestations backed by enough staked ETH, the block is included in the Beacon Chain.
In Ethereum's PoS, you must run a [full node](the-merge.md#execution-and-consensus-clients) and
[stake 32 ETH](https://ethereum.org/en/staking/) to become a validator.
!!! important
Withdrawing staked ETH isn't yet supported and will be included in a separate upgrade following The Merge.
!!! note
You must run a beacon node and an execution client to operate a full node on Mainnet.
To become a validator, you must also run a validator client (either
[in the same process as the beacon node](https://docs.teku.consensys.net/en/stable/HowTo/Get-Started/Run-Teku/#start-the-clients-in-a-single-process) or
[separately](https://docs.teku.consensys.net/en/stable/HowTo/Get-Started/Run-Teku/#run-the-clients-separately)).

3
docs/public-networks/get-started/connect/mainnet.md
Unescape View File

@ -80,6 +80,9 @@ Also, in the command:
You can modify the option values and add other [command line options](../../reference/cli/options.md)
as needed.
Ensure Besu is fully synced before submitting your staking deposit in the next step.
This can take several days.
### 3. Generate validator keys and stake ETH
If you're running a beacon node only, skip to the next step.

3
docs/public-networks/get-started/connect/testnet.md
Unescape View File

@ -80,6 +80,9 @@ using the [`--engine-jwt-secret`](../../reference/cli/options.md#engine-jwt-secr
You can modify the option values and add other [command line options](../../reference/cli/options.md)
as needed.
Ensure Besu is fully synced before submitting your staking deposit in the next step.
This can take several days.
### 3. Generate validator keys and stake ETH
If you're running a beacon node only, skip to the next step.

45
docs/public-networks/tutorials/besu-teku-mainnet.md
Unescape View File

@ -26,7 +26,7 @@ Run the following command:
openssl rand -hex 32 | tr -d "\n" > jwtsecret.hex
```
You will specify `jwtsecret.hex` when starting both Besu and Teku.
You will specify `jwtsecret.hex` when starting Besu and Teku.
This is a shared JWT secret the clients use to authenticate each other when using the
[Engine API](../how-to/use-engine-api.md).
@ -72,12 +72,15 @@ Also, in the command:
You can modify the option values and add other [command line options](../reference/cli/options.md)
as needed.
Ensure Besu is fully synced before submitting your staking deposit in the next step.
This can take several days.
## 4. Generate validator keys and stake ETH
If you're running a [beacon node only](#beacon-node-only), skip to the next step.
If you're running a beacon node only, skip to the next step.
If you're also running a [validator client](#beacon-node-and-validator-client), have a funded
Ethereum address ready (32 ETH and gas fees for each validator).
If you're also running a validator client, have a funded Ethereum address ready (32 ETH and gas fees
for each validator).
Generate validator keys and stake your ETH for one or more validators using the
[Staking Launchpad](https://launchpad.ethereum.org/en/).
@ -101,11 +104,10 @@ options in the [Teku configuration file]:
```bash
teku \
--data-path "datadir-teku" \
--ee-endpoint http://localhost:8551 \
--ee-jwt-secret-file <path to jwtsecret.hex> \
--log-destination console \
--rest-api-enabled=true \
--ee-endpoint=http://localhost:8551 \
--ee-jwt-secret-file=<path to jwtsecret.hex> \
--metrics-enabled=true \
--rest-api-enabled=true
```
Specify the path to the `jwtsecret.hex` file generated in [step 2](#2-generate-the-shared-secret) using
@ -114,13 +116,11 @@ option.
Also, in the command:
- [`--data-path`](https://docs.teku.consensys.net/en/latest/Reference/CLI/CLI-Syntax/#data-base-path-data-path)
is set to the path to the Teku data directory.
- [`ee-endpoint`](https://docs.teku.consensys.net/en/latest/Reference/CLI/CLI-Syntax/#ee-endpoint)
- [`--ee-endpoint`](https://docs.teku.consensys.net/en/latest/Reference/CLI/CLI-Syntax/#ee-endpoint)
is set to the default URL of Besu's Engine API.
- [`log-destination`](https://docs.teku.consensys.net/en/latest/Reference/CLI/CLI-Syntax/#log-destination)
specifies outputting log information to the console.
- [`rest-api-enabled`](https://docs.teku.consensys.net/en/latest/Reference/CLI/CLI-Syntax/#rest-api-enabled)
- [`--metrics-enabled`](https://docs.teku.consensys.net/en/latest/Reference/CLI/CLI-Syntax/#metrics-enabled)
enables Teku's metrics exporter.
- [`--rest-api-enabled`](https://docs.teku.consensys.net/en/latest/Reference/CLI/CLI-Syntax/#rest-api-enabled)
enables Teku's REST API service.
You can modify the option values and add other [Teku command line options] as needed.
@ -132,13 +132,12 @@ the options in the [Teku configuration file]:
```bash
teku \
--data-path "datadir-teku" \
--ee-endpoint http://localhost:8551 \
--ee-jwt-secret-file <path to jwtsecret.hex> \
--log-destination console \
--metrics-enabled=true \
--rest-api-enabled=true \
--validators-proposer-default-fee-recipient=<ETH address> \
--validator-keys=<path to key file>:<path to mnemonic file>[,<path to key file>:<path to mnemonic file>,...] \
--validator-keys=<path to key file>:<path to password file>[,<path to key file>:<path to password file>,...]
```
Specify:
@ -155,13 +154,11 @@ Specify:
Also, in the command:
- [`--data-path`](https://docs.teku.consensys.net/en/latest/Reference/CLI/CLI-Syntax/#data-base-path-data-path)
is set to the path to the Teku data directory.
- [`ee-endpoint`](https://docs.teku.consensys.net/en/latest/Reference/CLI/CLI-Syntax/#ee-endpoint)
- [`--ee-endpoint`](https://docs.teku.consensys.net/en/latest/Reference/CLI/CLI-Syntax/#ee-endpoint)
is set to the default URL of Besu's Engine API.
- [`log-destination`](https://docs.teku.consensys.net/en/latest/Reference/CLI/CLI-Syntax/#log-destination)
specifies outputting log information to the console.
- [`rest-api-enabled`](https://docs.teku.consensys.net/en/latest/Reference/CLI/CLI-Syntax/#rest-api-enabled)
- [`--metrics-enabled`](https://docs.teku.consensys.net/en/latest/Reference/CLI/CLI-Syntax/#metrics-enabled)
enables Teku's metrics exporter.
- [`--rest-api-enabled`](https://docs.teku.consensys.net/en/latest/Reference/CLI/CLI-Syntax/#rest-api-enabled)
enables Teku's REST API service.
You can modify the option values and add other [Teku command line options] as needed.

43
docs/public-networks/tutorials/besu-teku-testnet.md
Unescape View File

@ -34,7 +34,7 @@ Run the following command:
openssl rand -hex 32 | tr -d "\n" > jwtsecret.hex
```
You will specify `jwtsecret.hex` when starting both Besu and Teku.
You will specify `jwtsecret.hex` when starting Besu and Teku.
This is a shared JWT secret the clients use to authenticate each other when using the
[Engine API](../how-to/use-engine-api.md).
@ -80,12 +80,14 @@ Specify the path to the `jwtsecret.hex` file generated in [step 2](#2-generate-t
You can modify the option values and add other [command line options](../reference/cli/options.md)
as needed.
Ensure Besu is fully synced before submitting your staking deposit in the next step.
This can take several days.
## 4. Generate validator keys and stake ETH
If you're running a [beacon node only](#beacon-node-only), skip to the next step.
If you're running a beacon node only, skip to the next step.
If you're also running a [validator client](#beacon-node-and-validator-client), create a test
Ethereum address (you can do this in
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).
@ -118,24 +120,22 @@ options in the [Teku configuration file]:
```bash
teku \
--data-path "datadir-teku" \
--network goerli \
--ee-endpoint http://localhost:8551 \
--ee-jwt-secret-file <path to jwtsecret.hex> \
--log-destination console \
--rest-api-enabled=true \
--network=goerli \
--ee-endpoint=http://localhost:8551 \
--ee-jwt-secret-file=<path to jwtsecret.hex> \
--metrics-enabled=true \
--rest-api-enabled=true
```
=== "Sepolia"
```bash
teku \
--data-path "datadir-teku" \
--network sepolia \
--ee-endpoint http://localhost:8551 \
--ee-jwt-secret-file <path to jwtsecret.hex> \
--log-destination console \
--rest-api-enabled=true \
--network=sepolia \
--ee-endpoint=http://localhost:8551 \
--ee-jwt-secret-file=<path to jwtsecret.hex> \
--metrics-enabled=true \
--rest-api-enabled=true
```
Specify the path to the `jwtsecret.hex` file generated in [step 2](#2-generate-the-shared-secret) using
@ -153,14 +153,13 @@ the options in the [Teku configuration file]:
```bash
teku \
--data-path "datadir-teku" \
--network goerli \
--ee-endpoint http://localhost:8551 \
--ee-jwt-secret-file <path to jwtsecret.hex> \
--log-destination console \
--network=goerli \
--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 mnemonic file>[,<path to key file>:<path to mnemonic file>,...] \
--validator-keys=<path to key file>:<path to password file>[,<path to key file>:<path to password file>,...]
```
=== "Sepolia"

Write Preview
Loading…
Cancel
Save