client

Documentation

Index

• type BuilderBidProvider
• type Service
• type UnblindedBlockProvider
• type UnblindedProposalProvider
• type ValidatorRegistrationsSubmitter

Types

type BuilderBidProvider

type BuilderBidProvider interface {
	Service

	// BuilderBidProvider obtains a builder bid.
	BuilderBid(ctx context.Context,
		slot phase0.Slot,
		parentHash phase0.Hash32,
		pubKey phase0.BLSPubKey,
	) (
		*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 UnblindedBlockProvider

type UnblindedBlockProvider interface {
	Service

	// UnblindBlock unblinds a block.
	//
	// Deprecated: this will not work from the deneb hard-fork onwards.  Use UnblindedProposalProvider.UnblindProposal() instead.
	UnblindBlock(ctx context.Context,
		block *consensusapi.VersionedSignedBlindedBeaconBlock,
	) (
		*consensusapi.VersionedSignedProposal,
		error,
	)
}

UnblindedBlockProvider is the interface for a provider of unblinded blocks.

type UnblindedProposalProvider

type UnblindedProposalProvider interface {
	Service

	// UnblindProposal unblinds a proposal.
	UnblindProposal(ctx context.Context,
		proposal *consensusapi.VersionedSignedBlindedProposal,
	) (
		*consensusapi.VersionedSignedProposal,
		error,
	)
}

UnblindedProposalProvider is the interface for unblinded proposals.

type ValidatorRegistrationsSubmitter

type ValidatorRegistrationsSubmitter interface {
	Service

	// SubmitValidatorRegistrations submits validator registrations.
	SubmitValidatorRegistrations(ctx context.Context, registrations []*api.VersionedSignedValidatorRegistration) error
}

ValidatorRegistrationsSubmitter is the interface for a submitter of validator registrations.