standard

Documentation

Index

• type Parameter
  • func WithAccountsRefresher(refresher accountmanager.Refresher) Parameter
  • func WithAttestationAggregationDelay(delay time.Duration) Parameter
  • func WithAttestationAggregator(aggregator attestationaggregator.Service) Parameter
  • func WithAttester(attester attester.Service) Parameter
  • func WithAttesterDutiesProvider(provider eth2client.AttesterDutiesProvider) Parameter
  • func WithBeaconBlockHeadersProvider(provider eth2client.BeaconBlockHeadersProvider) Parameter
  • func WithBeaconBlockProposer(proposer beaconblockproposer.Service) Parameter
  • func WithBeaconCommitteeSubscriber(subscriber beaconcommitteesubscriber.Service) Parameter
  • func WithBlockToSlotSetter(setter cache.BlockRootToSlotSetter) Parameter
  • func WithChainTimeService(service chaintime.Service) Parameter
  • func WithEventsProvider(provider eth2client.EventsProvider) Parameter
  • func WithLogLevel(logLevel zerolog.Level) Parameter
  • func WithMaxAttestationDelay(delay time.Duration) Parameter
  • func WithMaxProposalDelay(delay time.Duration) Parameter
  • func WithMaxSyncCommitteeMessageDelay(delay time.Duration) Parameter
  • func WithMonitor(monitor metrics.ControllerMonitor) Parameter
  • func WithProposalsPreparer(provider proposalpreparer.Service) Parameter
  • func WithProposerDutiesProvider(provider eth2client.ProposerDutiesProvider) Parameter
  • func WithScheduler(scheduler scheduler.Service) Parameter
  • func WithSignedBeaconBlockProvider(provider eth2client.SignedBeaconBlockProvider) Parameter
  • func WithSpecProvider(provider eth2client.SpecProvider) Parameter
  • func WithSyncCommitteeAggregationDelay(delay time.Duration) Parameter
  • func WithSyncCommitteeAggregator(aggregator synccommitteeaggregator.Service) Parameter
  • func WithSyncCommitteeDutiesProvider(provider eth2client.SyncCommitteeDutiesProvider) Parameter
  • func WithSyncCommitteeMessenger(messenger synccommitteemessenger.Service) Parameter
  • func WithSyncCommitteeSubscriber(subscriber synccommitteesubscriber.Service) Parameter
  • func WithValidatingAccountsProvider(provider accountmanager.ValidatingAccountsProvider) Parameter
  • func WithWaitedForGenesis(waitedForGenesis bool) Parameter
• type Service
  • func New(ctx context.Context, params ...Parameter) (*Service, error)
  • func (s *Service) AttestAndScheduleAggregate(ctx context.Context, data interface{})
  • func (s *Service) HandleBlockEvent(event *api.Event)
  • func (s *Service) HandleHeadEvent(event *api.Event)
  • func (s *Service) HasPendingAttestations(_ context.Context, slot phase0.Slot) bool

Types

type Parameter

type Parameter interface {
	// contains filtered or unexported methods
}

Parameter is the interface for service parameters.

func WithAccountsRefresher

func WithAccountsRefresher(refresher accountmanager.Refresher) Parameter

WithAccountsRefresher sets the account refresher.

func WithAttestationAggregationDelay

func WithAttestationAggregationDelay(delay time.Duration) Parameter

WithAttestationAggregationDelay sets the delay before aggregating attestations.

func WithAttestationAggregator

func WithAttestationAggregator(aggregator attestationaggregator.Service) Parameter

WithAttestationAggregator sets the attestation aggregator.

func WithAttester

func WithAttester(attester attester.Service) Parameter

WithAttester sets the attester.

func WithAttesterDutiesProvider

func WithAttesterDutiesProvider(provider eth2client.AttesterDutiesProvider) Parameter

WithAttesterDutiesProvider sets the attester duties provider.

func WithBeaconBlockHeadersProvider

func WithBeaconBlockHeadersProvider(provider eth2client.BeaconBlockHeadersProvider) Parameter

WithBeaconBlockHeadersProvider sets the beacon block headers provider.

func WithBeaconBlockProposer

func WithBeaconBlockProposer(proposer beaconblockproposer.Service) Parameter

WithBeaconBlockProposer sets the beacon block propser.

func WithBeaconCommitteeSubscriber

func WithBeaconCommitteeSubscriber(subscriber beaconcommitteesubscriber.Service) Parameter

WithBeaconCommitteeSubscriber sets the beacon committee subscriber.

func WithBlockToSlotSetter

func WithBlockToSlotSetter(setter cache.BlockRootToSlotSetter) Parameter

WithBlockToSlotSetter sets the setter for the block to slot cache.

func WithChainTimeService

func WithChainTimeService(service chaintime.Service) Parameter

WithChainTimeService sets the chain time service.

func WithEventsProvider

func WithEventsProvider(provider eth2client.EventsProvider) Parameter

WithEventsProvider sets the events provider.

func WithLogLevel

func WithLogLevel(logLevel zerolog.Level) Parameter

WithLogLevel sets the log level for the module.

func WithMaxAttestationDelay

func WithMaxAttestationDelay(delay time.Duration) Parameter

WithMaxAttestationDelay sets the maximum delay before attesting.

func WithMaxProposalDelay

func WithMaxProposalDelay(delay time.Duration) Parameter

WithMaxProposalDelay sets the maximum delay before proposing.

func WithMaxSyncCommitteeMessageDelay

func WithMaxSyncCommitteeMessageDelay(delay time.Duration) Parameter

WithMaxSyncCommitteeMessageDelay sets the maximum delay before generating sync committee messages.

func WithMonitor

func WithMonitor(monitor metrics.ControllerMonitor) Parameter

WithMonitor sets the monitor for the module.

func WithProposalsPreparer

func WithProposalsPreparer(provider proposalpreparer.Service) Parameter

WithProposalsPreparer sets the proposals preparer.

func WithProposerDutiesProvider

func WithProposerDutiesProvider(provider eth2client.ProposerDutiesProvider) Parameter

WithProposerDutiesProvider sets the proposer duties provider.

func WithScheduler

func WithScheduler(scheduler scheduler.Service) Parameter

WithScheduler sets the scheduler.

func WithSignedBeaconBlockProvider

func WithSignedBeaconBlockProvider(provider eth2client.SignedBeaconBlockProvider) Parameter

WithSignedBeaconBlockProvider sets the signed beacon block provider.

func WithSpecProvider

func WithSpecProvider(provider eth2client.SpecProvider) Parameter

WithSpecProvider sets the spec provider.

func WithSyncCommitteeAggregationDelay

func WithSyncCommitteeAggregationDelay(delay time.Duration) Parameter

WithSyncCommitteeAggregationDelay sets the delay before aggregating sync committee messages.

func WithSyncCommitteeAggregator

func WithSyncCommitteeAggregator(aggregator synccommitteeaggregator.Service) Parameter

WithSyncCommitteeAggregator sets the sync committee aggregator.

func WithSyncCommitteeDutiesProvider

func WithSyncCommitteeDutiesProvider(provider eth2client.SyncCommitteeDutiesProvider) Parameter

WithSyncCommitteeDutiesProvider sets the sync committee duties provider.

func WithSyncCommitteeMessenger

func WithSyncCommitteeMessenger(messenger synccommitteemessenger.Service) Parameter

WithSyncCommitteeMessenger sets the sync committee messenger.

func WithSyncCommitteeSubscriber

func WithSyncCommitteeSubscriber(subscriber synccommitteesubscriber.Service) Parameter

WithSyncCommitteeSubscriber sets the sync committee subscriber.

func WithValidatingAccountsProvider

func WithValidatingAccountsProvider(provider accountmanager.ValidatingAccountsProvider) Parameter

WithValidatingAccountsProvider sets the validating accounts provider.

func WithWaitedForGenesis

func WithWaitedForGenesis(waitedForGenesis bool) Parameter

WithWaitedForGenesis is true if we waited for genesis.

type Service

type Service struct {
	// contains filtered or unexported fields
}

Service is the co-ordination system for vouch. It runs purely against clock events, setting up jobs for the validator's processes of block proposal, attestation creation and attestation aggregation.

func New

func New(ctx context.Context, params ...Parameter) (*Service, error)

New creates a new controller.

func (*Service) AttestAndScheduleAggregate

func (s *Service) AttestAndScheduleAggregate(ctx context.Context, data interface{})

AttestAndScheduleAggregate attests, then schedules aggregation jobs as required.

func (*Service) HandleBlockEvent

func (s *Service) HandleBlockEvent(event *api.Event)

HandleBlockEvent handles the "block" events from the beacon node.

func (*Service) HandleHeadEvent

func (s *Service) HandleHeadEvent(event *api.Event)

HandleHeadEvent handles the "head" events from the beacon node.

func (*Service) HasPendingAttestations

func (s *Service) HasPendingAttestations(_ context.Context,
	slot phase0.Slot,
) bool

HasPendingAttestations returns true if there are pending attestations for the given slot.