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

44 lines
1.9 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
Doc fixes, part 2 (#4806) * part 2 of the initial doc fixes - spelling fixes - grammar fixes - em-dashes should be em-dashes (`—`): double dashes (`--`) are not rendered properly - reduce overusage of em-dashes, some of those should be separate sentences - use the correct syntax for notes, tips and warnings - every sentence is in a separate line (helps with future diffs) - add missing dots at the end of list items - fix some lists * sentences on separate lines in the remaining files
2023-04-11 15:42:35 +00:00
Some features of the validator client, such as the metrics server, are currently in BETA and details may change in response to community feedback.
Please consult the `--help` screen for more details.
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
doc updates (#4314) * optimise index / landing page real estate, add feature list * fee recipient in quickstart * recommend http over websockets (fewer command line options needed) * simplify PBS, fee recipient docs * add VC role / sentry node docs (#4140) * Update docs/the_nimbus_book/src/rest-api.md Co-authored-by: tersec <tersec@users.noreply.github.com>
2022-11-13 06:59:55 +00:00
By default, Nimbus integrates the validator client into the main beacon node process - this is a simple, safe and efficient way to run a validator.
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
Doc fixes, part 2 (#4806) * part 2 of the initial doc fixes - spelling fixes - grammar fixes - em-dashes should be em-dashes (`—`): double dashes (`--`) are not rendered properly - reduce overusage of em-dashes, some of those should be separate sentences - use the correct syntax for notes, tips and warnings - every sentence is in a separate line (helps with future diffs) - add missing dots at the end of list items - fix some lists * sentences on separate lines in the remaining files
2023-04-11 15:42:35 +00:00
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).
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
Doc fixes, part 2 (#4806) * part 2 of the initial doc fixes - spelling fixes - grammar fixes - em-dashes should be em-dashes (`—`): double dashes (`--`) are not rendered properly - reduce overusage of em-dashes, some of those should be separate sentences - use the correct syntax for notes, tips and warnings - every sentence is in a separate line (helps with future diffs) - add missing dots at the end of list items - fix some lists * sentences on separate lines in the remaining files
2023-04-11 15:42:35 +00:00
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
## Setup
Documentation improvements (#4794)
2023-04-27 21:30:58 +00:00
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.
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
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
Doc fixes, part 2 (#4806) * part 2 of the initial doc fixes - spelling fixes - grammar fixes - em-dashes should be em-dashes (`—`): double dashes (`--`) are not rendered properly - reduce overusage of em-dashes, some of those should be separate sentences - use the correct syntax for notes, tips and warnings - every sentence is in a separate line (helps with future diffs) - add missing dots at the end of list items - fix some lists * sentences on separate lines in the remaining files
2023-04-11 15:42:35 +00:00
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
```
doc updates (#4314) * optimise index / landing page real estate, add feature list * fee recipient in quickstart * recommend http over websockets (fewer command line options needed) * simplify PBS, fee recipient docs * add VC role / sentry node docs (#4140) * Update docs/the_nimbus_book/src/rest-api.md Co-authored-by: tersec <tersec@users.noreply.github.com>
2022-11-13 06:59:55 +00:00
# Options
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
doc updates (#4314) * optimise index / landing page real estate, add feature list * fee recipient in quickstart * recommend http over websockets (fewer command line options needed) * simplify PBS, fee recipient docs * add VC role / sentry node docs (#4140) * Update docs/the_nimbus_book/src/rest-api.md Co-authored-by: tersec <tersec@users.noreply.github.com>
2022-11-13 06:59:55 +00:00
See the [validator client options](./validator-client-options.md) page for more information about beacon node roles, redundant setups and sentry nodes!