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

Revise secrets-dir flag in the VC #5480

Merged
merged 6 commits into from
Apr 18, 2024
Merged
Show file tree
Hide file tree
Changes from 2 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
4 changes: 0 additions & 4 deletions book/src/help_vc.md
Original file line number Diff line number Diff line change
Expand Up @@ -185,10 +185,6 @@ OPTIONS:
only be used if the user has a clear understanding that the broad Ethereum community has elected to override
this parameter in the event of an attack at the PoS transition block. Incorrect use of this flag can cause
your node to possibly accept an invalid chain or sync more slowly. Be extremely careful with this flag.
--secrets-dir <SECRETS_DIRECTORY>
The directory which contains the password to unlock the validator voting keypairs. Each password should be
contained in a file where the name is the 0x-prefixed hex representation of the validators voting public
key. Defaults to ~/.lighthouse/{network}/secrets.
--suggested-fee-recipient <FEE-RECIPIENT>
Once the merge has happened, this address will receive transaction fees from blocks proposed by this
validator client. If a fee recipient is configured in the validator definitions it takes priority over this
Expand Down
6 changes: 5 additions & 1 deletion book/src/validator-management.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,9 @@ Each permitted field of the file is listed below for reference:
- `voting_keystore_password`: The password to the EIP-2335 keystore.

> **Note**: Either `voting_keystore_password_path` or `voting_keystore_password` *must* be
> supplied. If both are supplied, `voting_keystore_password_path` is ignored.
> supplied. If both are supplied, `voting_keystore_password_path` is ignored.

>If you do not wish to have `voting_keystore_password` being stored in the `validator_definitions.yml` file, you can add the field `voting_keystore_password_path` and point it to a file containing the password. The file can be, e.g., on a mounted portable drive that contains the password so that no password is stored on the validating node.

## Populating the `validator_definitions.yml` file

Expand All @@ -75,6 +77,8 @@ recap:

### Automatic validator discovery

> Note: The description below only applies when the keystore files are created using the [`lighthouse account validator create`](./key-management.md) command, which has been deprecated.
Copy link
Member

@michaelsproul michaelsproul Apr 18, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we should delete this line

chong-he marked this conversation as resolved.
Show resolved Hide resolved

When the `--disable-auto-discover` flag is **not** provided, the validator client will search the
`validator-dir` for validators and add any *new* validators to the
`validator_definitions.yml` with `enabled: true`.
Expand Down
7 changes: 3 additions & 4 deletions validator_client/src/cli.rs
Original file line number Diff line number Diff line change
Expand Up @@ -67,13 +67,12 @@ pub fn cli_app<'a, 'b>() -> App<'a, 'b> {
.long("secrets-dir")
.value_name("SECRETS_DIRECTORY")
.help(
"The directory which contains the password to unlock the validator \
voting keypairs. Each password should be contained in a file where the \
name is the 0x-prefixed hex representation of the validators voting public \
key. Defaults to ~/.lighthouse/{network}/secrets.",
"This flag is not meant to be used together with the validator client. \
This flag has been hidden and will be deprecated in the future.",
)
.takes_value(true)
.conflicts_with("datadir")
.hidden(true)
)
.arg(
Arg::with_name("init-slashing-protection")
Expand Down
Loading