README
¶
Vouch
An Ethereum 2 multi-node validator client.
Table of Contents
Install
Binaries
Binaries for the latest version of Vouch can be obtained from the releases page.
Docker
You can obtain the latest version of Vouch using docker with:
docker pull attestant/vouch
Source
Vouch is a standard Go module which can be installed with:
go get github.com/attestantio/vouch
Usage
Vouch sits between the beacon node(s) and signer(s) in an Ethereum 2 validating infrastructure. It runs as a standard daemon process. The following documents provide information about configuring and using Vouch:
- Getting started starting Vouch for the first time
- Prometheus metrics Prometheus metrics
- Configuration Sample annotated configuration file
- Account manager Details of the supported account managers
- Fee recipients Details of the fee recipient configuration
- Graffiti Details of the graffiti provider
Known issues
- lighthouse does not yet implement server-sent events. As a result, if you are using Lighthouse you will see an occasional error in the logs that looks like:
{"level":"error","service":"client","impl":"standardv1","error":"could not connect to stream","time":"2020-11-26T08:01:09Z","message":"Failed to subscribe to event stream"}
Maintainers
Jim McDonald: @mcdee.
Contribute
Contributions welcome. Please check out the issues.
License
Apache-2.0 © 2020 Attestant Limited.
Documentation
¶
There is no documentation for this package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
services
|
|
|
accountmanager
Package accountmanager is a package that manages validator accounts from multiple sources.
|
Package accountmanager is a package that manages validator accounts from multiple sources. |
|
beaconcommitteesubscriber
Package beaconcommitteesubscriber is a package that manages subscriptions for beacon committees.
|
Package beaconcommitteesubscriber is a package that manages subscriptions for beacon committees. |
|
feerecipientprovider
Package feerecipientprovider provides fee recipients for block proposals.
|
Package feerecipientprovider provides fee recipients for block proposals. |
|
graffitiprovider
Package graffitiprovider provides graffiti for block proposals.
|
Package graffitiprovider provides graffiti for block proposals. |
|
metrics
Package metrics tracks various metrics that measure the performance of vouch.
|
Package metrics tracks various metrics that measure the performance of vouch. |
|
metrics/null
Package null is a null metrics logger.
|
Package null is a null metrics logger. |
|
signer
Package signer is a package that provides application-level signing operations.
|
Package signer is a package that provides application-level signing operations. |
|
submitter/immediate
Package immediate is a submitter that immediately submits requests received.
|
Package immediate is a submitter that immediately submits requests received. |
|
submitter/multinode
Package multinode is a strategy that obtains beacon block proposals from multiple nodes and selects the best one based on its attestation load.
|
Package multinode is a strategy that obtains beacon block proposals from multiple nodes and selects the best one based on its attestation load. |
|
submitter/null
Package null is a submitter that does not submit requests.
|
Package null is a submitter that does not submit requests. |
|
synccommitteesubscriber
Package synccommitteesubscriber is a package that manages subscriptions for sync committees.
|
Package synccommitteesubscriber is a package that manages subscriptions for sync committees. |
|
validatorsmanager
Package validatorsmanager is a package that manages validator information, primarily from local information and backed by the data from a beacon node.
|
Package validatorsmanager is a package that manages validator information, primarily from local information and backed by the data from a beacon node. |
|
strategies
|
|
|
aggregateattestation/best
Package best is a strategy that obtains attestation from multiple nodes and selects the best one.
|
Package best is a strategy that obtains attestation from multiple nodes and selects the best one. |
|
aggregateattestation/first
Package first is a strategy that obtains attestation from multiple nodes and selects the first one returned.
|
Package first is a strategy that obtains attestation from multiple nodes and selects the first one returned. |
|
attestationdata/best
Package best is a strategy that obtains attestation from multiple nodes and selects the best one.
|
Package best is a strategy that obtains attestation from multiple nodes and selects the best one. |
|
attestationdata/first
Package first is a strategy that obtains attestation from multiple nodes and selects the first one returned.
|
Package first is a strategy that obtains attestation from multiple nodes and selects the first one returned. |
|
beaconblockproposal/best
Package best is a strategy that obtains beacon block proposals from multiple nodes and selects the best one based on its attestation load.
|
Package best is a strategy that obtains beacon block proposals from multiple nodes and selects the best one based on its attestation load. |
|
beaconblockproposal/first
Package first is a strategy that obtains beacon block proposals from multiple nodes and selects the first one returned.
|
Package first is a strategy that obtains beacon block proposals from multiple nodes and selects the first one returned. |
|
synccommitteecontribution/best
Package best is a strategy that obtains sync committee contributions from multiple nodes and selects the best one.
|
Package best is a strategy that obtains sync committee contributions from multiple nodes and selects the best one. |
|
synccommitteecontribution/first
Package first is a strategy that obtains sync committee contributions from multiple nodes and selects the first one returned.
|
Package first is a strategy that obtains sync committee contributions from multiple nodes and selects the first one returned. |
|
testing
|
|
Click to show internal directories.
Click to hide internal directories.