blockauctioneer

Documentation

Index

• type BlockAuctioneer
• type Participation
• type Results
• type Service

Types

type BlockAuctioneer

type BlockAuctioneer interface {
	// AuctionBlock obtains the best available use of the block space.
	AuctionBlock(ctx context.Context,
		slot phase0.Slot,
		parentHash phase0.Hash32,
		pubkey phase0.BLSPubKey,
	) (
		*Results,
		error,
	)
}

BlockAuctioneer is the interface for auctioning block space.

type Participation

type Participation struct {
	// Category is the category of the bid.
	// This is free-form text, and could for example be "Priority", "Excluded" etc.
	Category string
	// Score is the eligibility score.
	Score *big.Int
	// Bid is the signed builder bid.
	Bid *spec.VersionedSignedBuilderBid
}

Participation provide detailed information about a relay's participation in the auction process.

type Results

type Results struct {
	// Participation contains details of each provider's participation.
	// There is only a single result per provider, being that with the highest score.
	Participation map[string]*Participation
	// AllProviders is the list of providers that were queried for bids.
	AllProviders []builderclient.BuilderBidProvider
	// WinningParticipation is the current winning bid amongst all participants.
	WinningParticipation *Participation
	// Providers is the list of providers that returned the winning bid.
	Providers []builderclient.BuilderBidProvider
}

Results provides the results of the auction process.

type Service

type Service interface{}

Service defines the block auctioneer service.