-
Notifications
You must be signed in to change notification settings - Fork 261
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
vc: initial documentation #3798
Conversation
bare-bones, but enough to get started
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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The documentation typically uses this rather than something like -j$(nproc)
. Presumably, this compromises between a reasonable guess at lowest-common-denominator number of cores and compatibility across Linux and macOS (which doesn't support, per se, nproc
, though it has its own approaches to this), but it's not ideal.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
indeed - this lowest-common-denominator approach gives most of the benefit without the mess
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is an issue of not-great defaults though, and while it's messy, it's messiness that should be handled by default by the build system: #3806
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
But, out of scope of this PR, sure.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, apparently that's difficult to do, at a make level for whatever reason. I'm guessing nimble
will learn this at some point
|
||
## Options | ||
|
||
`nimbus_validator_client` supports command line options similar to the beacon node: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Probably better to be consistent here and either refer to beacon nodes generically as a non-specific noun (as is now) but in a way that's accurate and precise with regard to what beacon nodes in general do, or specifically nimbus_beacon_node
, with which it's being compared.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
bare-bones, but enough to get started