status-im
/
nimbus-eth2
mirror of https://github.com/status-im/nimbus-eth2.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity
nimbus-eth2/docs/the_nimbus_book/src/validator-client.md

70 lines
2.7 KiB
Markdown
Raw Normal View History

vc: initial documentation (#3798) * vc: initial documentation bare-bones, but enough to get started * fixup * Apply suggestions from code review * remove prater, link upgrade * reword
2022-06-27 14:24:55 +00:00
# Run a separate validator client
Migrate docs to mkdocs (#3900) `mkdocs` works with markdown similar to `mdbook` but is generally more pleasing to the eye and has several nice UX features. This PR does the bulk of the transition - likely, a followup would be needed to fully make use of the extra features and navigation. Book pages have been kept url-compatible, meaning that for the most part, old links should continue to work! Co-authored-by: Etan Kissling <etan@status.im>
2022-07-22 19:47:24 +00:00
!!! warning
This feature is currently in BETA - we are still testing it and implementation details may change in response to community feedback. **We strongly advise against using it on mainnet** - your validators may get slashed
vc: initial documentation (#3798) * vc: initial documentation bare-bones, but enough to get started * fixup * Apply suggestions from code review * remove prater, link upgrade * reword
2022-06-27 14:24:55 +00:00
By default, Nimbus loads validator keys into the main beacon node process, which is a simple, safe and efficient way to run a validator.
Advanced users may wish to run validators in a separate process, allowing more flexible deployment strategies. The Nimbus beacon node supports both its own and third-party validator clients via the built-in [REST API](./rest-api.md).
Migrate docs to mkdocs (#3900) `mkdocs` works with markdown similar to `mdbook` but is generally more pleasing to the eye and has several nice UX features. This PR does the bulk of the transition - likely, a followup would be needed to fully make use of the extra features and navigation. Book pages have been kept url-compatible, meaning that for the most part, old links should continue to work! Co-authored-by: Etan Kissling <etan@status.im>
2022-07-22 19:47:24 +00:00
!!! warning
So far, all slashings with known causes have been linked to overly complex setups involving separation between beacon node and validator client! Only use this setup if you've taken steps to mitigate the increased risk.
vc: initial documentation (#3798) * vc: initial documentation bare-bones, but enough to get started * fixup * Apply suggestions from code review * remove prater, link upgrade * reword
2022-06-27 14:24:55 +00:00
## Build
The validator client is currently only available when built from source. To build the validator client, [build the beacon node](./build.md), then issue:
```sh
make -j4 nimbus_validator_client
```
When upgrading, follow the [upgrade guide](./keep-updated.md) but use the following command to update both beacon node and validator client at the same time:
```sh
# after "git pull && make update":
make -j4 nimbus_beacon_node nimbus_validator_client
```
## Setup
To run a separate validator client, you must first make sure that your beacon node has its REST API enabled - start it with the `--rest` option.
Next, choose a data directory for the validator client and import the keys there:
```sh
build/nimbus_beacon_node deposits import \
--data-dir:build/data/vc_shared_prater_0 "<YOUR VALIDATOR KEYS DIRECTORY>"
```
Migrate docs to mkdocs (#3900) `mkdocs` works with markdown similar to `mdbook` but is generally more pleasing to the eye and has several nice UX features. This PR does the bulk of the transition - likely, a followup would be needed to fully make use of the extra features and navigation. Book pages have been kept url-compatible, meaning that for the most part, old links should continue to work! Co-authored-by: Etan Kissling <etan@status.im>
2022-07-22 19:47:24 +00:00
!!! warning
Do not use the same data directory for beacon node and validator client - they will both try to load the same keys which may result in slashing!
vc: initial documentation (#3798) * vc: initial documentation bare-bones, but enough to get started * fixup * Apply suggestions from code review * remove prater, link upgrade * reword
2022-06-27 14:24:55 +00:00
Migrate docs to mkdocs (#3900) `mkdocs` works with markdown similar to `mdbook` but is generally more pleasing to the eye and has several nice UX features. This PR does the bulk of the transition - likely, a followup would be needed to fully make use of the extra features and navigation. Book pages have been kept url-compatible, meaning that for the most part, old links should continue to work! Co-authored-by: Etan Kissling <etan@status.im>
2022-07-22 19:47:24 +00:00
!!! warning
If you are migrating your keys from the beacon node to the validator client, simply move the `secrets` and `validators` folders in the beacon node data directory to the data directory of the validator client
vc: initial documentation (#3798) * vc: initial documentation bare-bones, but enough to get started * fixup * Apply suggestions from code review * remove prater, link upgrade * reword
2022-06-27 14:24:55 +00:00
With the keys imported, you are ready to start validator client:
```sh
build/nimbus_validator_client \
--data-dir:build/data/vc_shared_prater_0
```
## Options
The validator client shares many of its options with the beacon node. To see the available command line options, run:
```sh
# See help
build/nimbus_validator_client --help
```
### `--beacon-node`
The client will by defualt connect to a beacon node on the same machine as the validator client. Pick a different node with `--beacon-node`:
```sh
build/nimbus_validator_client \
--data-dir:build/data/vc_shared_prater_0 \
--beacon-node:http://host:port/
```