first

Documentation

Overview

Package first is a strategy that obtains beacon block headers from multiple nodes and selects the first one returned.

Index

• type Parameter
  • func WithBeaconBlockHeadersProviders(providers map[string]consensusclient.BeaconBlockHeadersProvider) Parameter
  • func WithClientMonitor(monitor metrics.ClientMonitor) Parameter
  • func WithLogLevel(logLevel zerolog.Level) Parameter
  • func WithTimeout(timeout time.Duration) Parameter
• type Service
  • func New(_ context.Context, params ...Parameter) (*Service, error)
  • func (s *Service) BeaconBlockHeader(ctx context.Context, opts *api.BeaconBlockHeaderOpts) (*api.Response[*apiv1.BeaconBlockHeader], error)

Types

type Parameter

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

Parameter is the interface for service parameters.

func WithBeaconBlockHeadersProviders

func WithBeaconBlockHeadersProviders(providers map[string]consensusclient.BeaconBlockHeadersProvider) Parameter

WithBeaconBlockHeadersProviders sets the beacon block headers providers.

func WithClientMonitor

func WithClientMonitor(monitor metrics.ClientMonitor) Parameter

WithClientMonitor sets the client monitor for the service.

func WithLogLevel

func WithLogLevel(logLevel zerolog.Level) Parameter

WithLogLevel sets the log level for the module.

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 headers.

func New

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

New creates a new beacon block headers strategy.

func (*Service) BeaconBlockHeader

func (s *Service) BeaconBlockHeader(ctx context.Context,
	opts *api.BeaconBlockHeaderOpts,
) (
	*api.Response[*apiv1.BeaconBlockHeader],
	error,
)

BeaconBlockHeader provides the beacon block header from a number of beacon nodes.