best

Documentation

Overview

Package best is a strategy that obtains beacon block proposals from multiple nodes and selects the best one based on its attestation load.

Index

• type Parameter
  • func WithBlockRootToSlotCache(cache cache.BlockRootToSlotProvider) Parameter
  • func WithChainTimeService(chainTime chaintime.Service) Parameter
  • func WithClientMonitor(monitor metrics.ClientMonitor) Parameter
  • func WithEventsProvider(provider eth2client.EventsProvider) Parameter
  • func WithExecutionPayloadFactor(factor float64) Parameter
  • func WithLogLevel(logLevel zerolog.Level) Parameter
  • func WithProcessConcurrency(concurrency int64) Parameter
  • func WithProposalProviders(providers map[string]eth2client.ProposalProvider) Parameter
  • func WithSignedBeaconBlockProvider(provider eth2client.SignedBeaconBlockProvider) Parameter
  • func WithSpecProvider(provider eth2client.SpecProvider) Parameter
  • func WithTimeout(timeout time.Duration) Parameter
• type Service
  • func New(ctx context.Context, params ...Parameter) (*Service, error)
  • func (s *Service) HandleHeadEvent(event *apiv1.Event)
  • func (s *Service) Proposal(ctx context.Context, opts *api.ProposalOpts) (*api.Response[*api.VersionedProposal], error)

Types

type Parameter

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

Parameter is the interface for service parameters.

func WithBlockRootToSlotCache

func WithBlockRootToSlotCache(cache cache.BlockRootToSlotProvider) Parameter

WithBlockRootToSlotCache sets the block root to slot cache.

func WithChainTimeService

func WithChainTimeService(chainTime chaintime.Service) Parameter

WithChainTimeService sets the chain time service.

func WithClientMonitor

func WithClientMonitor(monitor metrics.ClientMonitor) Parameter

WithClientMonitor sets the client monitor for the service.

func WithEventsProvider

func WithEventsProvider(provider eth2client.EventsProvider) Parameter

WithEventsProvider sets the events provider.

func WithExecutionPayloadFactor

func WithExecutionPayloadFactor(factor float64) Parameter

WithExecutionPayloadFactor sets the relative weight of execution payload gas to block score.

func WithLogLevel

func WithLogLevel(logLevel zerolog.Level) Parameter

WithLogLevel sets the log level for the module.

func WithProcessConcurrency

func WithProcessConcurrency(concurrency int64) Parameter

WithProcessConcurrency sets the concurrency for the service.

func WithProposalProviders

func WithProposalProviders(providers map[string]eth2client.ProposalProvider) Parameter

WithProposalProviders sets the proposal providers.

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 beacon spec provider.

func WithTimeout

func WithTimeout(timeout time.Duration) Parameter

WithTimeout sets the timeout for requests.

type Service

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

Service is the provider for beacon block proposals.

func New

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

New creates a new beacon block proposal strategy.

func (*Service) HandleHeadEvent

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

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

func (*Service) Proposal

func (s *Service) Proposal(ctx context.Context,
	opts *api.ProposalOpts,
) (
	*api.Response[*api.VersionedProposal],
	error,
)

Proposal provides the best beacon block proposal from a number of beacon nodes.