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
- Grafana dashboard based on prometheus metrics
- Configuration Sample annotated configuration file
- Account manager Details of the supported account managers
- Execution configuration Details of the execution configuration
- Graffiti Details of the graffiti provider
Known issues
Maintainers
Chris Berry: @bez625.
Contribute
Contributions welcome. Please see the CONTRIBUTING.md doc.
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. |
|
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. |
|
multiinstance
Package multiinstance manages co-ordination of multiple instance validator actions.
|
Package multiinstance manages co-ordination of multiple instance validator actions. |
|
multiinstance/always
Package always will always attest and propose immediately.
|
Package always will always attest and propose immediately. |
|
multiinstance/staticdelay
Package staticdelay provides a static delay in which a Vouch instance waits to see if another instance has attested or proposed before doing so itself.
|
Package staticdelay provides a static delay in which a Vouch instance waits to see if another instance has attested or proposed before doing so itself. |
|
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. |
|
attestationdata/majority
package majority is a strategy that obtains attestation from multiple nodes and selects the best one.
|
package majority is a strategy that obtains attestation from multiple nodes and selects the best one. |
|
attestationpool/combined
Package combined is a strategy that obtains attestation pools from multiple nodes and combines them into a single set.
|
Package combined is a strategy that obtains attestation pools from multiple nodes and combines them into a single set. |
|
beaconblockheader/first
Package first is a strategy that obtains beacon block headers from multiple nodes and selects the first one returned.
|
Package first is a strategy that obtains beacon block headers 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. |
|
beaconblockroot/first
Package first is a strategy that obtains beacon block roots from multiple nodes and selects the first one returned.
|
Package first is a strategy that obtains beacon block roots from multiple nodes and selects the first one returned. |
|
beaconblockroot/latest
Package latest is a strategy that obtains beacon block roots from multiple nodes and selects the one relating to the latest slot.
|
Package latest is a strategy that obtains beacon block roots from multiple nodes and selects the one relating to the latest slot. |
|
beaconblockroot/majority
Package majority is a strategy that obtains beacon block roots from multiple nodes and selects the most common.
|
Package majority is a strategy that obtains beacon block roots from multiple nodes and selects the most common. |
|
builderbid/best
package deadline is a strategy that obtains builder bids from multiple relays repeatedly up to the supplied deadline into a slot.
|
package deadline is a strategy that obtains builder bids from multiple relays repeatedly up to the supplied deadline into a slot. |
|
builderbid/deadline
package deadline is a strategy that obtains builder bids from multiple relays repeatedly up to the supplied deadline into a slot.
|
package deadline is a strategy that obtains builder bids from multiple relays repeatedly up to the supplied deadline into a slot. |
|
signedbeaconblock/first
Package first is a strategy that obtains signed beacon blocks from multiple nodes and selects the first one returned.
|
Package first is a strategy that obtains signed beacon blocks 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.