Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/protolambda/eth2-val-tools
Some experimental tools to manage validators - use at your own risk
https://github.com/protolambda/eth2-val-tools
Last synced: about 8 hours ago
JSON representation
Some experimental tools to manage validators - use at your own risk
- Host: GitHub
- URL: https://github.com/protolambda/eth2-val-tools
- Owner: protolambda
- License: mit
- Created: 2020-04-18T20:45:08.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-02-19T10:42:30.000Z (8 months ago)
- Last Synced: 2024-06-19T01:47:19.606Z (4 months ago)
- Language: Go
- Size: 261 KB
- Stars: 59
- Watchers: 6
- Forks: 19
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Validator management tools
__*Warning: Use at your own RISK, this is all very EXPERIMENTAL*__
## Commands
### `keystores`
Builds keystores/secrets in every format, for a given mnemonic and account range.
```
Usage:
eth2-val-tools keystores [flags]
Flags:
-h, --help help for keystores
--insecure Enable to output insecure keystores (faster generation, ONLY for ephemeral private testnets
--out-loc string Path of the output data for the host, where wallets, keys, secrets dir, etc. are written (default "assigned_data")
--prysm-pass string Password for all-accounts keystore file (Prysm only)
--source-max uint Maximum validator index in HD path range (excl.)
--source-min uint Minimum validator index in HD path range (incl.)
--source-mnemonic string The validators mnemonic to source account keys from.
```
### `mnemonic`
Outputs a bare 256 bit entropy BIP39 mnemonic, or stops with exit code 1.
```
Create a random mnemonic
Usage:
eth2-val-tools mnemonic [flags]
Flags:
-h, --help help for mnemonic
```
### `deposit-data`
To quickly generate a list of deposit datas for a range of accounts.
```
Create deposit data for the given range of validators. 1 json-encoded deposit data per line.
Usage:
eth2-val-tools deposit-data [flags]
Flags:
--amount uint Amount to deposit, in Gwei (default 32000000000)
--as-json-list If the json datas should be wrapped with brackets and separated with commas, like a json list.
--fork-version string Fork version, e.g. 0x11223344
-h, --help help for deposit-data
--source-max uint Maximum validator index in HD path range (excl.)
--source-min uint Minimum validator index in HD path range (incl.)
--validators-mnemonic string Mnemonic to use for validators.
--withdrawals-mnemonic string Mnemonic to use for BLS withdrawal creds. Withdrawal accounts are assumed to have standard paths relative to validators.
```
### `bls-address-change`
```
Create signed BLS to execution address change messages for the given range of validators. 1 json-encoded message per line.
Usage:
eth2-val-tools bls-address-change [flags]
Flags:
--as-json-list If the json datas should be wrapped with brackets and separated with commas, like a json list.
--execution-address string Execution address to withdraw to. Hex encoded with prefix.
--fork-version string Genesis fork version, e.g. 0x11223344
--genesis-validators-root string Genesis validators root. Hex encoded with prefix.
-h, --help help for bls-address-change
--source-max uint Maximum validator index in HD path range (excl.)
--source-min uint Minimum validator index in HD path range (incl.)
--withdrawals-mnemonic string Mnemonic to use for BLS withdrawal creds. Withdrawal accounts are assumed to have standard paths relative to validators.
```
### `pubkeys`
```
List pubkeys of the given range of validators. Output encoded as one pubkey per line.
Usage:
eth2-val-tools pubkeys [flags]
Flags:
-h, --help help for pubkeys
--source-max uint Maximum validator index in HD path range (excl.)
--source-min uint Minimum validator index in HD path range (incl.)
--validators-mnemonic string Mnemonic to use for validators.
```
Example, list pubkeys (for a random new mnemonic), account range `[42, 123)`:
```shell script
eth2-val-tools pubkeys --validators-mnemonic="$(eth2-val-tools mnemonic)" --source-min=42 --source-max=123
```
## Output
Eth2 clients structure their validators differently, but this tool outputs all the required data for each of them.
### Prysm
Prysm is a special case, they are centric around the Ethdo wallet system. Instead of using the EIP 2335 key files directly, like all the other clients.
In the output directory, a `prysm` dir is placed, with the following contents:
- `keymanager_opts.json`: JSON file describing accounts and their passphrases. And the "Location" part can be configured with `--key-man-loc`,
which will point to some "wallets" directory: where the actual wallets can be found.
- Prysm requires Account names listed in the JSON to be prefixied with the wallet name, separated by a `/`. Like `Assigned/foobarvalidator`.
- Ethdo wallets are in the same big store, and only one directory in this store per wallet. The directory must be named as UUID, and in the directory there must be a file with the same UUID name to describe the wallet.
- Ethdo key files in the wallet must also be named as a UUID, so that they can be parsed in the `.Accounts()` call
- `wallets`: a directory which is an Ethdo store with a single non-deterministic wallet in it, covering all keys.
- The wallet name is called `Assigned`, and the keys are `Assigned/val_` (excluding `<` and `>`) The pubkey is hex encoded, without `0x`.
- The wallet also contains an `index` file and all other ethdo-specific things
### Lighthouse
Lighthouse is key-centric, no wallets involved. Following EIP 2335.
The output is:
- `secrets` directory, containing one file per validator. Named after the pubkey (hex-encoded, `0x` prefix).
Each file contains the passphrase for the `voting-keystore.json` of the validator.
- `keys` directory (equivalent of `.lighthouse/validators`, containing one directory per validator. Named after the pubkey (hex-encoded, `0x` prefix).
Each directory contains a `voting-keystore.json`, an EIP 2335 keystore file, with `path` field set to empty string.
The `voting-keystore.json` name is a requirement of Lighthouse.
If you use a custom `--datadir` value, a simple way to initialize your keys is to use the [automatic validator discovery](https://lighthouse-book.sigmaprime.io/validator-management.html#automatic-validator-discovery). Simply recursively copy your `secrets` directory into `$DATADIR` and recursively copy every files from the `keys` into `$DATADIR/validators`. Start the Lighthouse validator client with `--datadir $DATADIR`. If you start the validator client for the first time, you will need the `--init-slashing-protection` flag. After a successful validator key discovery and initialization for the first time, you can remove the `--init-slashing-protection` flag.
### Nimbus
Nimbus, a lot like lighthouse, expects a keys and secrets directory, which can be configured.
Each keystore is named `keystore.json` instead of `voting-keystore.json` however.
For ease of use, an additional `nimbus-keys` directory will be output, with this naming scheme.
### Teku
Like Lighthouse, Teku is also key-centric, but requires you to be explicit about finding keys. I.e. you need the CLI options:
```
--encrypted-keystore-validator-file=foobar/key.json
--encrypted-keystore-validator-password-file=secrets/foobar
```
This matches lighthouse close enough, but is clumsy. To make this easier,
a teku configuration file is output, with the validator mappings configured for you.
### Lodestar
Lodestar is very similar to Lighthouse/Nimbus, but has 3 directories:
```
--keystoresDir="{{keystores_relative_dir}}"
--secretsDir="{{secrets_relative_dir}}"
--validatorsDbDir="{{validators_db_relative_dir}}"
```
These directories are relative to the `--rootDir` directory.
The keystores dir has pubkey-named directories, each with a `voting-keystore.json`.
The secrets dir has pubkey-named files containing passwords, but the pubkey in the names are encoded without the `0x` prefix.
The validators-DB dir is unimportant, and can be left empty. This is managed by lodestar.
## License
MIT, see [`LICENSE`](./LICENSE) file.