client

Documentation

Index

• Variables
• type BuilderBidProvider
• type Service
• type UnblindedProposalProvider
• type ValidatorRegistrationsSubmitter

Variables

var (
	// ErrNotActive is returned when a client is not active.
	ErrNotActive = errors.New("client is not active")
	// ErrNotSynced is returned when a client is not synced.
	ErrNotSynced = errors.New("client is not synced")
	// ErrNoOptions is returned when a request is made without options.
	ErrNoOptions = errors.New("no options specified")
	// ErrInvalidOptions is returned when a request is made with invalid options.
	ErrInvalidOptions = errors.New("invalid options")
	// ErrInconsistentResult is returned when a request returns with data at odds to that requested.
	ErrInconsistentResult = errors.New("inconsistent result")
)

Types

type BuilderBidProvider

type BuilderBidProvider interface {
	Service

	// BuilderBidProvider obtains a builder bid.
	BuilderBid(ctx context.Context,
		opts *api.BuilderBidOpts,
	) (
		*api.Response[*spec.VersionedSignedBuilderBid],
		error,
	)
}

BuilderBidProvider is the interface for a provider of builder bids.

type Service

type Service interface {
	// Name returns the name of the builder implementation.
	Name() string

	// Address returns the address of the builder.
	Address() string

	// Pubkey returns the public key of the builder (if any).
	Pubkey() *phase0.BLSPubKey
}

Service is the service providing a connection to an MEV relay.

type UnblindedProposalProvider

type UnblindedProposalProvider interface {
	Service

	// UnblindProposal unblinds a proposal.
	UnblindProposal(ctx context.Context,
		opts *api.UnblindProposalOpts,
	) (
		*api.Response[*consensusapi.VersionedSignedProposal],
		error,
	)
}

UnblindedProposalProvider is the interface for unblinded proposals.

type ValidatorRegistrationsSubmitter

type ValidatorRegistrationsSubmitter interface {
	Service

	// SubmitValidatorRegistrations submits validator registrations.
	SubmitValidatorRegistrations(ctx context.Context,
		opts *api.SubmitValidatorRegistrationsOpts,
	) error
}

ValidatorRegistrationsSubmitter is the interface for a submitter of validator registrations.