Skip to content

Commit

Permalink
vc: initial documentation (#3798)
Browse files Browse the repository at this point in the history
* vc: initial documentation

bare-bones, but enough to get started

* fixup

* Apply suggestions from code review

* remove prater, link upgrade

* reword
  • Loading branch information
arnetheduck authored Jun 27, 2022
1 parent 91d5434 commit 8b6f05a
Show file tree
Hide file tree
Showing 2 changed files with 66 additions and 0 deletions.
1 change: 1 addition & 0 deletions docs/the_nimbus_book/src/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@
- [Add an additional validator](./additional-validator.md)
- [Monitor attestation performance](./attestation-performance.md)
- [Monitor specific validators](./validator-monitor.md)
- [Run a separate validator client](./validator-client.md)

# How-to (misc)
- [Upgrade / downgrade Nimbus](./keep-updated.md)
Expand Down
65 changes: 65 additions & 0 deletions docs/the_nimbus_book/src/validator-client.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
# Run a separate validator client

> ⚠️ 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
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).

> ⚠️ 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.
## 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>"
```

> ⚠️ 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!
> ⚠️ 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
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/
```

0 comments on commit 8b6f05a

Please sign in to comment.