builder

Documentation

Index

• Variables
• type BlockBuilder
• type Option
  • func FlagOptions(c *cli.Context) ([]Option, error)
  • func WithBuilderEndpoints(endpoint string) Option
  • func WithDatabase(beaconDB db.HeadAccessDatabase) Option
  • func WithHeadFetcher(svc *blockchain.Service) Option
• type Service
  • func NewService(ctx context.Context, opts ...Option) (*Service, error)
  • func (s *Service) Configured() bool
  • func (s *Service) GetHeader(ctx context.Context, slot types.Slot, parentHash [32]byte, pubKey [48]byte) (*ethpb.SignedBuilderBid, error)
  • func (s *Service) RegisterValidator(ctx context.Context, reg []*ethpb.SignedValidatorRegistrationV1) error
  • func (*Service) Start()
  • func (s *Service) Status() error
  • func (*Service) Stop() error
  • func (s *Service) SubmitBlindedBlock(ctx context.Context, b *ethpb.SignedBlindedBeaconBlockBellatrix) (*v1.ExecutionPayload, error)

Variables

var ErrNoBuilder = errors.New("builder endpoint not configured")

ErrNoBuilder is used when builder endpoint is not configured.

Types

type BlockBuilder

type BlockBuilder interface {
	SubmitBlindedBlock(ctx context.Context, block *ethpb.SignedBlindedBeaconBlockBellatrix) (*v1.ExecutionPayload, error)
	GetHeader(ctx context.Context, slot types.Slot, parentHash [32]byte, pubKey [48]byte) (*ethpb.SignedBuilderBid, error)
	RegisterValidator(ctx context.Context, reg []*ethpb.SignedValidatorRegistrationV1) error
	Configured() bool
}

BlockBuilder defines the interface for interacting with the block builder

type Option

type Option func(s *Service) error

func FlagOptions

func FlagOptions(c *cli.Context) ([]Option, error)

FlagOptions for builder service flag configurations.

func WithBuilderEndpoints

func WithBuilderEndpoints(endpoint string) Option

WithBuilderEndpoints sets the endpoint for the beacon chain builder service.

func WithDatabase

func WithDatabase(beaconDB db.HeadAccessDatabase) Option

WithDatabase for head access.

func WithHeadFetcher

func WithHeadFetcher(svc *blockchain.Service) Option

WithHeadFetcher gets the head info from chain service.

type Service

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

Service defines a service that provides a client for interacting with the beacon chain and MEV relay network.

func NewService

func NewService(ctx context.Context, opts ...Option) (*Service, error)

NewService instantiates a new service.

func (*Service) Configured

func (s *Service) Configured() bool

Configured returns true if the user has input a builder URL.

func (*Service) GetHeader

func (s *Service) GetHeader(ctx context.Context, slot types.Slot, parentHash [32]byte, pubKey [48]byte) (*ethpb.SignedBuilderBid, error)

GetHeader retrieves the header for a given slot and parent hash from the builder relay network.

func (*Service) RegisterValidator

func (s *Service) RegisterValidator(ctx context.Context, reg []*ethpb.SignedValidatorRegistrationV1) error

RegisterValidator registers a validator with the builder relay network. It also saves the registration object to the DB.

func (*Service) Start

func (*Service) Start()

Start initializes the service.

func (*Service) Status

func (s *Service) Status() error

Status retrieves the status of the builder relay network.

func (*Service) Stop

func (*Service) Stop() error

Stop halts the service.

func (*Service) SubmitBlindedBlock

func (s *Service) SubmitBlindedBlock(ctx context.Context, b *ethpb.SignedBlindedBeaconBlockBellatrix) (*v1.ExecutionPayload, error)

SubmitBlindedBlock submits a blinded block to the builder relay network.