client

Documentation

Index

• type DeliveredBidTraceProvider
• type QueuedProposersProvider
• type ReceivedBidTracesProvider
• type Service

Types

type DeliveredBidTraceProvider

type DeliveredBidTraceProvider interface {
	Service

	// DeliveredBidTrace provides a bid trace of a delivered payload for a given slot.
	// Will return nil if the relay did not deliver a bid for the slot.
	DeliveredBidTrace(ctx context.Context, slot phase0.Slot) (*v1.BidTrace, error)
}

DeliveredBidTraceProvider is the interface for providing bid traces for delivered payloads.

type QueuedProposersProvider

type QueuedProposersProvider interface {
	Service

	// QueuedProposers provides information on the proposers queued to obtain a blinded block.
	QueuedProposers(ctx context.Context) ([]*v1.QueuedProposer, error)
}

QueuedProposersProviders is the interface for providing queued proposer information.

type ReceivedBidTracesProvider

type ReceivedBidTracesProvider interface {
	Service

	// ReceivedBidTraces provides all bid traces received for a given slot.
	ReceivedBidTraces(ctx context.Context, slot phase0.Slot) ([]*v1.BidTraceWithTimestamp, error)
}

ReceivedBidTracesProvider is the interface for obtaining bid traces received by a relay.

type Service

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

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

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

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