Skip to content
Merged
Show file tree
Hide file tree
Changes from 5 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 book/src/archived_key_management.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ using Lighthouse.
Rather than continuing to read this page, we recommend users visit either:

- The [Staking Launchpad][launchpad] for detailed, beginner-friendly instructions.
- The [staking-deposit-cli](https://github.com/ethereum/staking-deposit-cli) for a CLI tool used by the [Staking Launchpad][launchpad].
- The [ethstaker-deposit-cli](https://github.com/eth-educators/ethstaker-deposit-cli/releases) for a CLI tool used by the [Staking Launchpad][launchpad].
- The [validator-manager documentation](./validator_manager.md) for a Lighthouse-specific tool for streamlined validator management tools.

## The `lighthouse account-manager`
Expand Down
2 changes: 1 addition & 1 deletion book/src/help_vm.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Commands:
data. This file can then be imported to a validator client using the
"import-validators" command. Another, optional JSON file is created
which contains a list of validator deposits in the same format as the
"ethereum/staking-deposit-cli" tool.
"ethstaker-deposit-cli" tool.
import
Uploads validators to a validator client using the HTTP API. The
validators are defined in a JSON file which can be generated using the
Expand Down
2 changes: 1 addition & 1 deletion book/src/help_vm_create.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Creates new validators from BIP-39 mnemonic. A JSON file will be created which
contains all the validator keystores and other validator data. This file can
then be imported to a validator client using the "import-validators" command.
Another, optional JSON file is created which contains a list of validator
deposits in the same format as the "ethereum/staking-deposit-cli" tool.
deposits in the same format as the "ethstaker-deposit-cli" tool.

Usage: lighthouse validator_manager create [OPTIONS] --output-path <DIRECTORY>

Expand Down
3 changes: 1 addition & 2 deletions book/src/help_vm_import.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,8 +39,7 @@ Options:
[default: 300]
--keystore-file <PATH_TO_KEYSTORE_FILE>
The path to a keystore JSON file to be imported to the validator
client. This file is usually created using staking-deposit-cli or
ethstaker-deposit-cli
client. This file is usually created using ethstaker-deposit-cli
--log-format <FORMAT>
Specifies the log format used when emitting logs to the terminal.
[possible values: JSON]
Expand Down
3 changes: 3 additions & 0 deletions book/src/installation_homebrew.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,9 @@ Lighthouse is available on Linux and macOS via the [Homebrew package manager](ht
Please note that this installation method is maintained by the Homebrew community.
It is not officially supported by the Lighthouse team.

> Note: There is a [compilation error](https://github.com/Homebrew/homebrew-core/pull/220922) for Lighthouse v7.0.0 and above that remains unresolved. Users are recommended to download the binary from [the release
page](https://github.com/sigp/lighthouse/releases) or build from source.

## Installation

Install the latest version of the [`lighthouse`][formula] formula with:
Expand Down
14 changes: 7 additions & 7 deletions book/src/mainnet_validator.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ hardware. 32 ETH is a significant outlay and joining a testnet is a great way to

### Step 1. Create validator keys

The Ethereum Foundation provides the [staking-deposit-cli](https://github.com/ethereum/staking-deposit-cli/releases) for creating validator keys. Download and run the `staking-deposit-cli` with the command:
The Ethereum Foundation provides the [ethstaker-deposit-cli](https://github.com/eth-educators/ethstaker-deposit-cli/releases) for creating validator keys. Download and run the `ethstaker-deposit-cli` with the command:

```bash
./deposit new-mnemonic
Expand All @@ -52,7 +52,7 @@ and follow the instructions to generate the keys. When prompted for a network, s

> **Important note:** A mnemonic (or seed phrase) is a 24-word string randomly generated in the process. It is highly recommended to write down the mnemonic and keep it safe offline. It is important to ensure that the mnemonic is never stored in any digital form (computers, mobile phones, etc) connected to the internet. Please also make one or more backups of the mnemonic to ensure your ETH is not lost in the case of data loss. It is very important to keep your mnemonic private as it represents the ultimate control of your ETH.

Upon completing this step, the files `deposit_data-*.json` and `keystore-m_*.json` will be created. The keys that are generated from staking-deposit-cli can be easily loaded into a Lighthouse validator client (`lighthouse vc`) in [Step 3](#step-3-import-validator-keys-to-lighthouse). In fact, both of these programs are designed to work with each other.
Upon completing this step, the files `deposit_data-*.json` and `keystore-m_*.json` will be created. The keys that are generated from `ethstaker-deposit-cli` can be easily loaded into a Lighthouse validator client (`lighthouse vc`) in [Step 3](#step-3-import-validator-keys-to-lighthouse). In fact, both of these programs are designed to work with each other.

> Lighthouse also supports creating validator keys, see [Validator Manager Create](./validator_manager_create.md) for more info.

Expand All @@ -62,19 +62,19 @@ Start an execution client and Lighthouse beacon node according to the [Run a Nod

### Step 3. Import validator keys to Lighthouse

In [Step 1](#step-1-create-validator-keys), the staking-deposit-cli will generate the validator keys into a `validator_keys` directory. Let's assume that
this directory is `$HOME/staking-deposit-cli/validator_keys`. Using the default `validators` directory in Lighthouse (`~/.lighthouse/mainnet/validators`), run the following command to import validator keys:
In [Step 1](#step-1-create-validator-keys), the `ethstaker-deposit-cli` will generate the validator keys into a `validator_keys` directory. Let's assume that
this directory is `$HOME/ethstaker-deposit-cli/validator_keys`. Using the default `validators` directory in Lighthouse (`~/.lighthouse/mainnet/validators`), run the following command to import validator keys:

Mainnet:

```bash
lighthouse --network mainnet account validator import --directory $HOME/staking-deposit-cli/validator_keys
lighthouse --network mainnet account validator import --directory $HOME/ethstaker-deposit-cli/validator_keys
```

Hoodi testnet:

```bash
lighthouse --network hoodi account validator import --directory $HOME/staking-deposit-cli/validator_keys
lighthouse --network hoodi account validator import --directory $HOME/ethstaker-deposit-cli/validator_keys
```

> Note: The user must specify the consensus client network that they are importing the keys by using the `--network` flag.
Expand All @@ -88,7 +88,7 @@ lighthouse --network hoodi account validator import --directory $HOME/staking-de
The user will be prompted for a password for each keystore discovered:

```
Keystore found at "/home/{username}/staking-deposit-cli/validator_keys/keystore-m_12381_3600_0_0_0-1595406747.json":
Keystore found at "/home/{username}/ethstaker-deposit-cli/validator_keys/keystore-m_12381_3600_0_0_0-1595406747.json":

- Public key: 0xa5e8702533f6d66422e042a0bf3471ab9b302ce115633fa6fdc5643f804b6b4f1c33baf95f125ec21969a3b1e0dd9e56
- UUID: 8ea4cf99-8719-43c5-9eda-e97b8a4e074f
Expand Down
2 changes: 1 addition & 1 deletion book/src/validator_manager.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ except the latter creates files that will be read by the VC next time it starts
whilst the former makes instant changes to a live VC.

The `account-manager` is ideal for importing keys created with the
[staking-deposit-cli](https://github.com/ethereum/staking-deposit-cli). On the
[ethstaker-deposit-cli](https://github.com/eth-educators/ethstaker-deposit-cli). On the
other hand, the `validator-manager` is ideal for moving existing validators
between two VCs or for advanced users to create validators at scale with less
downtime.
Expand Down
2 changes: 1 addition & 1 deletion book/src/validator_manager_api.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ lighthouse vm delete --vc-token ~/.lighthouse/mainnet/validators/api-token.txt -

## Import

The `import` command imports validator keystores generated by the staking-deposit-cli/ethstaker-deposit-cli. To import a validator keystore:
The `import` command imports validator keystores generated by the `ethstaker-deposit-cli`. To import a validator keystore:

```bash
lighthouse vm import --vc-token <API-TOKEN-PATH> --keystore-file /path/to/json --password keystore_password
Expand Down
4 changes: 2 additions & 2 deletions book/src/validator_manager_create.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ mnemonic and produces two files:
- `validators.json`: the keystores and passwords for the newly generated
validators, in JSON format.
- `deposits.json`: a JSON file of the same format as
[staking-deposit-cli](https://github.com/ethereum/staking-deposit-cli) which can
[ethstaker-deposit-cli](https://github.com/eth-educators/ethstaker-deposit-cli) which can
be used for deposit submission via the [Ethereum Staking
Launchpad][].

Expand Down Expand Up @@ -69,7 +69,7 @@ lighthouse \
> Be sure to remove `./validators.json` after the import is successful since it
> contains unencrypted validator keystores.

> Note: To import validators with validator-manager using keystore files created using the staking deposit CLI, refer to [Managing Validators](./validator_manager_api.md#import).
> Note: To import validators with validator-manager using keystore files created using the `ethstaker-deposit-cli`, refer to [Managing Validators](./validator_manager_api.md#import).

## Detailed Guide

Expand Down
2 changes: 1 addition & 1 deletion book/src/validator_slashing_protection.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ and carefully to keep your validators safe. See the [Troubleshooting](#troublesh

The database will be automatically created, and your validators registered with it when:

* Importing keys from another source (e.g. [staking-deposit-cli](https://github.com/ethereum/staking-deposit-cli/releases), Lodestar, Nimbus, Prysm, Teku, [ethdo](https://github.com/wealdtech/ethdo)).
* Importing keys from another source (e.g. [ethstaker-deposit-cli](https://github.com/eth-educators/ethstaker-deposit-cli), Lodestar, Nimbus, Prysm, Teku, [ethdo](https://github.com/wealdtech/ethdo)).
See [import validator keys](./mainnet_validator.md#step-3-import-validator-keys-to-lighthouse).
* Creating keys using Lighthouse itself (`lighthouse account validator create`)
* Creating keys via the [validator client API](./api_vc.md).
Expand Down
2 changes: 1 addition & 1 deletion book/src/validator_voluntary_exit.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ After the [Capella](https://ethereum.org/en/history/#capella) upgrade on 12<sup>
There are two types of withdrawal credentials, `0x00` and `0x01`. To check which type your validator has, go to [Staking launchpad](https://launchpad.ethereum.org/en/withdrawals), enter your validator index and click `verify on mainnet`:

- `withdrawals enabled` means your validator is of type `0x01`, and you will automatically receive the full withdrawal to the withdrawal address that you set.
- `withdrawals not enabled` means your validator is of type `0x00`, and will need to update your withdrawal credentials from `0x00` type to `0x01` type (also known as BLS-to-execution-change, or BTEC) to receive the staked funds. The common way to do this is using `Staking deposit CLI` or `ethdo`, with the instructions available [here](https://launchpad.ethereum.org/en/withdrawals#update-your-keys).
- `withdrawals not enabled` means your validator is of type `0x00`, and will need to update your withdrawal credentials from `0x00` type to `0x01` type (also known as BLS-to-execution-change, or BTEC) to receive the staked funds. The common way to do this is using `ethstaker-deposit-cli` or `ethdo`, with the instructions available [here](https://launchpad.ethereum.org/en/withdrawals#update-your-keys).

### 2. What if my validator is of type `0x00` and I do not update my withdrawal credentials after I initiated a voluntary exit?

Expand Down
4 changes: 2 additions & 2 deletions validator_manager/src/create_validators.rs
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ pub fn cli_app() -> Command {
contains all the validator keystores and other validator data. This file can then \
be imported to a validator client using the \"import-validators\" command. \
Another, optional JSON file is created which contains a list of validator \
deposits in the same format as the \"ethereum/staking-deposit-cli\" tool.",
deposits in the same format as the \"ethstaker-deposit-cli\" tool.",
)
.arg(
Arg::new(OUTPUT_PATH_FLAG)
Expand Down Expand Up @@ -487,7 +487,7 @@ impl ValidatorsAndDeposits {
};

// Create a JSON structure equivalent to the one generated by
// `ethereum/staking-deposit-cli`.
// `ethstaker-deposit-cli`.
let json_deposit = StandardDepositDataJson::new(
&voting_keypair,
withdrawal_credentials.into(),
Expand Down
2 changes: 1 addition & 1 deletion validator_manager/src/import_validators.rs
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ pub fn cli_app() -> Command {
.help(
"The path to a keystore JSON file to be \
imported to the validator client. This file is usually created \
using staking-deposit-cli or ethstaker-deposit-cli",
using ethstaker-deposit-cli",
)
.action(ArgAction::Set)
.display_order(0)
Expand Down