server

Documentation

Index

• Constants
• func ComputeDomain(domainType phase0.DomainType, forkVersionHex, genesisValidatorsRootHex string) (domain phase0.Domain, err error)
• func DecodeJSON(r io.Reader, dst any) error
• func SendHTTPRequest(ctx context.Context, client http.Client, method, url string, ...) (code int, err error)
• func SendHTTPRequestWithRetries(ctx context.Context, client http.Client, method, url string, ...) (code int, err error)
• type BlockHashHex
• type BoostService
  • func NewBoostService(opts BoostServiceOpts) (*BoostService, error)
  • func (m *BoostService) CheckRelays() int
  • func (m *BoostService) StartHTTPServer() error
• type BoostServiceOpts
• type UserAgent

Constants

const (
	HeaderKeySlotUID      = "X-MEVBoost-SlotID"
	HeaderKeyVersion      = "X-MEVBoost-Version"
	HeaderStartTimeUnixMS = "X-MEVBoost-StartTimeUnixMS"
)

Functions

func ComputeDomain

func ComputeDomain(domainType phase0.DomainType, forkVersionHex, genesisValidatorsRootHex string) (domain phase0.Domain, err error)

ComputeDomain computes the signing domain

func DecodeJSON

func DecodeJSON(r io.Reader, dst any) error

DecodeJSON reads JSON from io.Reader and decodes it into a struct

func SendHTTPRequest

func SendHTTPRequest(ctx context.Context, client http.Client, method, url string, userAgent UserAgent, headers map[string]string, payload, dst any) (code int, err error)

SendHTTPRequest - prepare and send HTTP request, marshaling the payload if any, and decoding the response if dst is set

func SendHTTPRequestWithRetries

func SendHTTPRequestWithRetries(ctx context.Context, client http.Client, method, url string, userAgent UserAgent, headers map[string]string, payload, dst any, maxRetries int, log *logrus.Entry) (code int, err error)

SendHTTPRequestWithRetries - prepare and send HTTP request, retrying the request if within the client timeout

Types

type BlockHashHex

type BlockHashHex string

BlockHashHex is a hex-string representation of a block hash

type BoostService

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

BoostService - the mev-boost service

func NewBoostService

func NewBoostService(opts BoostServiceOpts) (*BoostService, error)

NewBoostService created a new BoostService

func (*BoostService) CheckRelays

func (m *BoostService) CheckRelays() int

CheckRelays sends a request to each one of the relays previously registered to get their status

func (*BoostService) StartHTTPServer

func (m *BoostService) StartHTTPServer() error

StartHTTPServer starts the HTTP server for this boost service instance

type BoostServiceOpts

type BoostServiceOpts struct {
	Log                   *logrus.Entry
	ListenAddr            string
	Relays                []types.RelayEntry
	RelayMonitors         []*url.URL
	GenesisForkVersionHex string
	GenesisTime           uint64
	RelayCheck            bool
	RelayMinBid           types.U256Str

	RequestTimeoutGetHeader  time.Duration
	RequestTimeoutGetPayload time.Duration
	RequestTimeoutRegVal     time.Duration
	RequestMaxRetries        int
}

BoostServiceOpts provides all available options for use with NewBoostService

type UserAgent

type UserAgent string

UserAgent is a custom string type to avoid confusing url + userAgent parameters in SendHTTPRequest