goclient

Documentation

Index

• Constants
• Variables
• func ComputeForkDigest(version phase0.Version, genesisValidatorsRoot phase0.Root) ([4]byte, error)
• func Hash(data []byte) [32]byte
• func New(logger *zap.Logger, opt beaconprotocol.Options, ...) (beaconprotocol.BeaconNode, error)
• func ToBytes4(x []byte) [4]byte
• type Client
• type NodeClient
  • func ParseNodeClient(version string) NodeClient
• type NodeClientProvider

Constants

const DataVersionNil spec.DataVersion = math.MaxUint64

DataVersionNil is just a placeholder for a nil data version. Don't check for it, check for errors or nil data instead.

Variables

var (
	SyncCommitteeSize                    uint64       = 512
	SyncCommitteeSubnetCount             uint64       = 4
	TargetAggregatorsPerSyncSubcommittee uint64       = 16
	EpochsPerSyncCommitteePeriod         uint64       = 256
	TargetAggregatorsPerCommittee        uint64       = 16
	FarFutureEpoch                       phase0.Epoch = 1<<64 - 1
	IntervalsPerSlot                     uint64       = 3
)

Functions

func ComputeForkDigest

func ComputeForkDigest(version phase0.Version, genesisValidatorsRoot phase0.Root) ([4]byte, error)

ComputeForkDigest returns the fork for the current version and genesis validator root

Spec pseudocode definition:

	def compute_fork_digest(current_version: Version, genesis_validators_root: Root) -> ForkDigest:
   """
   Return the 4-byte fork digest for the ``current_version`` and ``genesis_validators_root``.
   This is a digest primarily used for domain separation on the p2p layer.
   4-bytes suffices for practical separation of forks/chains.
   """
   return ForkDigest(compute_fork_data_root(current_version, genesis_validators_root)[:4])

func Hash

func Hash(data []byte) [32]byte

Hash defines a function that returns the sha256 checksum of the data passed in. https://github.com/ethereum/consensus-specs/blob/v0.9.3/specs/core/0_beacon-chain.md#hash

func New

func New(logger *zap.Logger, opt beaconprotocol.Options, operatorID spectypes.OperatorID, slotTickerProvider slotticker.Provider) (beaconprotocol.BeaconNode, error)

New init new client and go-client instance

func ToBytes4

func ToBytes4(x []byte) [4]byte

ToBytes4 is a convenience method for converting a byte slice to a fix sized 4 byte array. This method will truncate the input if it is larger than 4 bytes.

Types

type Client

type Client interface {
	eth2client.Service
	eth2client.NodeVersionProvider
	eth2client.NodeClientProvider

	eth2client.AttestationDataProvider
	eth2client.AggregateAttestationProvider
	eth2client.AggregateAttestationsSubmitter
	eth2client.AttestationDataProvider
	eth2client.AttestationsSubmitter
	eth2client.BeaconCommitteeSubscriptionsSubmitter
	eth2client.SyncCommitteeSubscriptionsSubmitter
	eth2client.AttesterDutiesProvider
	eth2client.ProposerDutiesProvider
	eth2client.SyncCommitteeDutiesProvider
	eth2client.NodeSyncingProvider
	eth2client.BeaconBlockProposalProvider
	eth2client.BeaconBlockSubmitter
	eth2client.BlindedBeaconBlockProposalProvider
	eth2client.BlindedBeaconBlockSubmitter
	eth2client.DomainProvider
	eth2client.BeaconBlockRootProvider
	eth2client.SyncCommitteeMessagesSubmitter
	eth2client.BeaconBlockRootProvider
	eth2client.SyncCommitteeContributionProvider
	eth2client.SyncCommitteeContributionsSubmitter
	eth2client.ValidatorsProvider
	eth2client.ProposalPreparationsSubmitter
	eth2client.EventsProvider
	eth2client.BlindedBeaconBlockProposalProvider
	eth2client.BlindedBeaconBlockSubmitter
	eth2client.ValidatorRegistrationsSubmitter
	eth2client.VoluntaryExitSubmitter
}

Client defines all go-eth2-client interfaces used in ssv

type NodeClient

type NodeClient string

NodeClient is the type of the Beacon node.

const (
	NodeLighthouse NodeClient = "lighthouse"
	NodePrysm      NodeClient = "prysm"
	NodeUnknown    NodeClient = "unknown"
)

func ParseNodeClient

func ParseNodeClient(version string) NodeClient

ParseNodeClient derives the client from node's version string.

type NodeClientProvider

type NodeClientProvider interface {
	NodeClient() NodeClient
}