duties

Documentation

Overview

Package duties is a generated GoMock package.

Index

• type AttesterHandler
  • func NewAttesterHandler(duties *dutystore.Duties[eth2apiv1.AttesterDuty]) *AttesterHandler
  • func (h *AttesterHandler) HandleDuties(ctx context.Context)
  • func (b *AttesterHandler) HandleInitialDuties(context.Context)
  • func (h *AttesterHandler) Name() string
  • func (h *AttesterHandler) Setup(name string, logger *zap.Logger, beaconNode BeaconNode, ...)
• type BeaconNode
• type EventFeed
  • func NewEventFeed[T any]() *EventFeed[T]
  • func (f *EventFeed[T]) FanOut(ctx context.Context, in <-chan T)
  • func (f *EventFeed[T]) Send(item T)
  • func (f *EventFeed[T]) Subscribe(ch chan<- T) event.Subscription
• type ExecuteDutiesFunc
• type ExecuteDutyFunc
• type ExecutionClient
• type ExitDescriptor
• type MockdutyHandler
  • func NewMockdutyHandler(ctrl *gomock.Controller) *MockdutyHandler
  • func (m *MockdutyHandler) EXPECT() *MockdutyHandlerMockRecorder
  • func (m *MockdutyHandler) HandleDuties(arg0 context.Context)
  • func (m *MockdutyHandler) HandleInitialDuties(arg0 context.Context)
  • func (m *MockdutyHandler) Name() string
  • func (m *MockdutyHandler) Setup(arg0 string, arg1 *zap.Logger, arg2 BeaconNode, arg3 ExecutionClient, ...)
• type MockdutyHandlerMockRecorder
  • func (mr *MockdutyHandlerMockRecorder) HandleDuties(arg0 interface{}) *gomock.Call
  • func (mr *MockdutyHandlerMockRecorder) HandleInitialDuties(arg0 interface{}) *gomock.Call
  • func (mr *MockdutyHandlerMockRecorder) Name() *gomock.Call
  • func (mr *MockdutyHandlerMockRecorder) Setup(arg0, arg1, arg2, arg3, arg4, arg5, arg6, arg7, arg8, arg9 interface{}) *gomock.Call
• type ProposerHandler
  • func NewProposerHandler(duties *dutystore.Duties[eth2apiv1.ProposerDuty]) *ProposerHandler
  • func (h *ProposerHandler) HandleDuties(ctx context.Context)
  • func (h *ProposerHandler) HandleInitialDuties(ctx context.Context)
  • func (h *ProposerHandler) Name() string
  • func (h *ProposerHandler) Setup(name string, logger *zap.Logger, beaconNode BeaconNode, ...)
• type ReorgEvent
• type Scheduler
  • func NewScheduler(opts *SchedulerOptions) *Scheduler
  • func (s *Scheduler) ExecuteDuties(logger *zap.Logger, duties []*spectypes.Duty)
  • func (s *Scheduler) HandleHeadEvent(logger *zap.Logger) func(event *eth2apiv1.Event)
  • func (s *Scheduler) SlotTicker(ctx context.Context)
  • func (s *Scheduler) Start(ctx context.Context, logger *zap.Logger) error
  • func (s *Scheduler) Wait() error
• type SchedulerOptions
• type SlotTicker
• type SyncCommitteeHandler
  • func NewSyncCommitteeHandler(duties *dutystore.SyncCommitteeDuties) *SyncCommitteeHandler
  • func (h *SyncCommitteeHandler) HandleDuties(ctx context.Context)
  • func (h *SyncCommitteeHandler) HandleInitialDuties(ctx context.Context)
  • func (h *SyncCommitteeHandler) Name() string
  • func (h *SyncCommitteeHandler) Setup(name string, logger *zap.Logger, beaconNode BeaconNode, ...)
• type ValidatorController
• type ValidatorRegistrationHandler
  • func NewValidatorRegistrationHandler() *ValidatorRegistrationHandler
  • func (h *ValidatorRegistrationHandler) HandleDuties(ctx context.Context)
  • func (b *ValidatorRegistrationHandler) HandleInitialDuties(context.Context)
  • func (h *ValidatorRegistrationHandler) Name() string
  • func (h *ValidatorRegistrationHandler) Setup(name string, logger *zap.Logger, beaconNode BeaconNode, ...)
• type VoluntaryExitHandler
  • func NewVoluntaryExitHandler(validatorExitCh <-chan ExitDescriptor) *VoluntaryExitHandler
  • func (h *VoluntaryExitHandler) HandleDuties(ctx context.Context)
  • func (b *VoluntaryExitHandler) HandleInitialDuties(context.Context)
  • func (h *VoluntaryExitHandler) Name() string
  • func (h *VoluntaryExitHandler) Setup(name string, logger *zap.Logger, beaconNode BeaconNode, ...)

Types

type AttesterHandler

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

func NewAttesterHandler

func NewAttesterHandler(duties *dutystore.Duties[eth2apiv1.AttesterDuty]) *AttesterHandler

func (*AttesterHandler) HandleDuties

func (h *AttesterHandler) HandleDuties(ctx context.Context)

HandleDuties manages the duty lifecycle, handling different cases:

On First Run:

1. Fetch duties for the current epoch.
2. If necessary, fetch duties for the next epoch.
3. Execute duties.

On Re-org:

If the previous dependent root changed:
    1. Fetch duties for the current epoch.
    2. Execute duties.
If the current dependent root changed:
    1. Execute duties.
    2. If necessary, fetch duties for the next epoch.

On Indices Change:

1. Execute duties.
2. ResetEpoch duties for the current epoch.
3. Fetch duties for the current epoch.
4. If necessary, fetch duties for the next epoch.

On Ticker event:

1. Execute duties.
2. If necessary, fetch duties for the next epoch.

func (*AttesterHandler) HandleInitialDuties

func (b *AttesterHandler) HandleInitialDuties(context.Context)

func (*AttesterHandler) Name

func (h *AttesterHandler) Name() string

func (*AttesterHandler) Setup

func (h *AttesterHandler) Setup(name string, logger *zap.Logger, beaconNode BeaconNode, executionClient ExecutionClient, network networkconfig.NetworkConfig, validatorController ValidatorController, executeDuties ExecuteDutiesFunc, slotTickerProvider slotticker.Provider, reorgEvents chan ReorgEvent, indicesChange chan struct{})

type BeaconNode

type BeaconNode interface {
	AttesterDuties(ctx context.Context, epoch phase0.Epoch, validatorIndices []phase0.ValidatorIndex) ([]*eth2apiv1.AttesterDuty, error)
	ProposerDuties(ctx context.Context, epoch phase0.Epoch, validatorIndices []phase0.ValidatorIndex) ([]*eth2apiv1.ProposerDuty, error)
	SyncCommitteeDuties(ctx context.Context, epoch phase0.Epoch, indices []phase0.ValidatorIndex) ([]*eth2apiv1.SyncCommitteeDuty, error)
	Events(ctx context.Context, topics []string, handler eth2client.EventHandlerFunc) error
	SubmitBeaconCommitteeSubscriptions(ctx context.Context, subscription []*eth2apiv1.BeaconCommitteeSubscription) error
	SubmitSyncCommitteeSubscriptions(ctx context.Context, subscription []*eth2apiv1.SyncCommitteeSubscription) error
}

type EventFeed

type EventFeed[T any] struct {
	// contains filtered or unexported fields
}

func NewEventFeed

func NewEventFeed[T any]() *EventFeed[T]

func (*EventFeed[T]) FanOut

func (f *EventFeed[T]) FanOut(ctx context.Context, in <-chan T)

func (*EventFeed[T]) Send

func (f *EventFeed[T]) Send(item T)

func (*EventFeed[T]) Subscribe

func (f *EventFeed[T]) Subscribe(ch chan<- T) event.Subscription

type ExecuteDutiesFunc

type ExecuteDutiesFunc func(logger *zap.Logger, duties []*spectypes.Duty)

ExecuteDutiesFunc is a non-blocking functions which executes the given duties.

type ExecuteDutyFunc

type ExecuteDutyFunc func(logger *zap.Logger, duty *spectypes.Duty)

type ExecutionClient

type ExecutionClient interface {
	BlockByNumber(ctx context.Context, blockNumber *big.Int) (*ethtypes.Block, error)
}

type ExitDescriptor

type ExitDescriptor struct {
	PubKey         phase0.BLSPubKey
	ValidatorIndex phase0.ValidatorIndex
	BlockNumber    uint64
}

type MockdutyHandler

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

MockdutyHandler is a mock of dutyHandler interface.

func NewMockdutyHandler

func NewMockdutyHandler(ctrl *gomock.Controller) *MockdutyHandler

NewMockdutyHandler creates a new mock instance.

func (*MockdutyHandler) EXPECT

func (m *MockdutyHandler) EXPECT() *MockdutyHandlerMockRecorder

EXPECT returns an object that allows the caller to indicate expected use.

func (*MockdutyHandler) HandleDuties

func (m *MockdutyHandler) HandleDuties(arg0 context.Context)

HandleDuties mocks base method.

func (*MockdutyHandler) HandleInitialDuties

func (m *MockdutyHandler) HandleInitialDuties(arg0 context.Context)

HandleInitialDuties mocks base method.

func (*MockdutyHandler) Name

func (m *MockdutyHandler) Name() string

Name mocks base method.

func (*MockdutyHandler) Setup

func (m *MockdutyHandler) Setup(arg0 string, arg1 *zap.Logger, arg2 BeaconNode, arg3 ExecutionClient, arg4 networkconfig.NetworkConfig, arg5 ValidatorController, arg6 ExecuteDutiesFunc, arg7 slotticker.Provider, arg8 chan ReorgEvent, arg9 chan struct{})

Setup mocks base method.

type MockdutyHandlerMockRecorder

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

MockdutyHandlerMockRecorder is the mock recorder for MockdutyHandler.

func (*MockdutyHandlerMockRecorder) HandleDuties

func (mr *MockdutyHandlerMockRecorder) HandleDuties(arg0 interface{}) *gomock.Call

HandleDuties indicates an expected call of HandleDuties.

func (*MockdutyHandlerMockRecorder) HandleInitialDuties

func (mr *MockdutyHandlerMockRecorder) HandleInitialDuties(arg0 interface{}) *gomock.Call

HandleInitialDuties indicates an expected call of HandleInitialDuties.

func (*MockdutyHandlerMockRecorder) Name

func (mr *MockdutyHandlerMockRecorder) Name() *gomock.Call

Name indicates an expected call of Name.

func (*MockdutyHandlerMockRecorder) Setup

func (mr *MockdutyHandlerMockRecorder) Setup(arg0, arg1, arg2, arg3, arg4, arg5, arg6, arg7, arg8, arg9 interface{}) *gomock.Call

Setup indicates an expected call of Setup.

type ProposerHandler

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

func NewProposerHandler

func NewProposerHandler(duties *dutystore.Duties[eth2apiv1.ProposerDuty]) *ProposerHandler

func (*ProposerHandler) HandleDuties

func (h *ProposerHandler) HandleDuties(ctx context.Context)

HandleDuties manages the duty lifecycle, handling different cases:

On First Run:

1. Fetch duties for the current epoch.
2. Execute duties.

On Re-org (current dependent root changed):

1. Fetch duties for the current epoch.
2. Execute duties.

On Indices Change:

1. Execute duties.
2. ResetEpoch duties for the current epoch.
3. Fetch duties for the current epoch.

On Ticker event:

1. Execute duties.
2. If necessary, fetch duties for the current epoch.

func (*ProposerHandler) HandleInitialDuties

func (h *ProposerHandler) HandleInitialDuties(ctx context.Context)

func (*ProposerHandler) Name

func (h *ProposerHandler) Name() string

func (*ProposerHandler) Setup

func (h *ProposerHandler) Setup(name string, logger *zap.Logger, beaconNode BeaconNode, executionClient ExecutionClient, network networkconfig.NetworkConfig, validatorController ValidatorController, executeDuties ExecuteDutiesFunc, slotTickerProvider slotticker.Provider, reorgEvents chan ReorgEvent, indicesChange chan struct{})

type ReorgEvent

type ReorgEvent struct {
	Slot     phase0.Slot
	Previous bool
	Current  bool
}

type Scheduler

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

func NewScheduler

func NewScheduler(opts *SchedulerOptions) *Scheduler

func (*Scheduler) ExecuteDuties

func (s *Scheduler) ExecuteDuties(logger *zap.Logger, duties []*spectypes.Duty)

ExecuteDuties tries to execute the given duties

func (*Scheduler) HandleHeadEvent

func (s *Scheduler) HandleHeadEvent(logger *zap.Logger) func(event *eth2apiv1.Event)

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

func (*Scheduler) SlotTicker

func (s *Scheduler) SlotTicker(ctx context.Context)

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

func (*Scheduler) Start

func (s *Scheduler) Start(ctx context.Context, logger *zap.Logger) error

Start initializes the Scheduler and begins its operation. Note: This function includes blocking operations, especially within the handler's HandleInitialDuties call, which will block until initial duties are fully handled.

func (*Scheduler) Wait

func (s *Scheduler) Wait() error

type SchedulerOptions

type SchedulerOptions struct {
	Ctx                 context.Context
	BeaconNode          BeaconNode
	ExecutionClient     ExecutionClient
	Network             networkconfig.NetworkConfig
	ValidatorController ValidatorController
	ExecuteDuty         ExecuteDutyFunc
	IndicesChg          chan struct{}
	ValidatorExitCh     <-chan ExitDescriptor
	SlotTickerProvider  slotticker.Provider
	BuilderProposals    bool
	DutyStore           *dutystore.Store
}

type SlotTicker

type SlotTicker interface {
	Next() <-chan time.Time
	Slot() phase0.Slot
}

type SyncCommitteeHandler

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

func NewSyncCommitteeHandler

func NewSyncCommitteeHandler(duties *dutystore.SyncCommitteeDuties) *SyncCommitteeHandler

func (*SyncCommitteeHandler) HandleDuties

func (h *SyncCommitteeHandler) HandleDuties(ctx context.Context)

HandleDuties manages the duty lifecycle, handling different cases:

On First Run:

1. Fetch duties for the current period.
2. If necessary, fetch duties for the next period.
3. Execute duties.

On Re-org:

1. Execute duties.
2. If necessary, fetch duties for the next period.

On Indices Change:

1. Execute duties.
2. ResetEpoch duties for the current period.
3. Fetch duties for the current period.
4. If necessary, fetch duties for the next period.

On Ticker event:

1. Execute duties.
2. If necessary, fetch duties for the next period.

func (*SyncCommitteeHandler) HandleInitialDuties

func (h *SyncCommitteeHandler) HandleInitialDuties(ctx context.Context)

func (*SyncCommitteeHandler) Name

func (h *SyncCommitteeHandler) Name() string

func (*SyncCommitteeHandler) Setup

func (h *SyncCommitteeHandler) Setup(name string, logger *zap.Logger, beaconNode BeaconNode, executionClient ExecutionClient, network networkconfig.NetworkConfig, validatorController ValidatorController, executeDuties ExecuteDutiesFunc, slotTickerProvider slotticker.Provider, reorgEvents chan ReorgEvent, indicesChange chan struct{})

type ValidatorController

type ValidatorController interface {
	CommitteeActiveIndices(epoch phase0.Epoch) []phase0.ValidatorIndex
	AllActiveIndices(epoch phase0.Epoch, afterInit bool) []phase0.ValidatorIndex
	GetOperatorShares() []*types.SSVShare
}

ValidatorController represents the component that controls validators via the scheduler

type ValidatorRegistrationHandler

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

func NewValidatorRegistrationHandler

func NewValidatorRegistrationHandler() *ValidatorRegistrationHandler

func (*ValidatorRegistrationHandler) HandleDuties

func (h *ValidatorRegistrationHandler) HandleDuties(ctx context.Context)

func (*ValidatorRegistrationHandler) HandleInitialDuties

func (b *ValidatorRegistrationHandler) HandleInitialDuties(context.Context)

func (*ValidatorRegistrationHandler) Name

func (h *ValidatorRegistrationHandler) Name() string

func (*ValidatorRegistrationHandler) Setup

func (h *ValidatorRegistrationHandler) Setup(name string, logger *zap.Logger, beaconNode BeaconNode, executionClient ExecutionClient, network networkconfig.NetworkConfig, validatorController ValidatorController, executeDuties ExecuteDutiesFunc, slotTickerProvider slotticker.Provider, reorgEvents chan ReorgEvent, indicesChange chan struct{})

type VoluntaryExitHandler

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

func NewVoluntaryExitHandler

func NewVoluntaryExitHandler(validatorExitCh <-chan ExitDescriptor) *VoluntaryExitHandler

func (*VoluntaryExitHandler) HandleDuties

func (h *VoluntaryExitHandler) HandleDuties(ctx context.Context)

func (*VoluntaryExitHandler) HandleInitialDuties

func (b *VoluntaryExitHandler) HandleInitialDuties(context.Context)

func (*VoluntaryExitHandler) Name

func (h *VoluntaryExitHandler) Name() string

func (*VoluntaryExitHandler) Setup

func (h *VoluntaryExitHandler) Setup(name string, logger *zap.Logger, beaconNode BeaconNode, executionClient ExecutionClient, network networkconfig.NetworkConfig, validatorController ValidatorController, executeDuties ExecuteDutiesFunc, slotTickerProvider slotticker.Provider, reorgEvents chan ReorgEvent, indicesChange chan struct{})