api

Documentation

Index

• Constants
• Variables
• func ParseHeaderRequest(r *http.Request) structs.HeaderRequest
• type API
  • func NewApi(l log.Logger, enabled *EnabledEndpoints, r Relay, reg Registrations, st State, ...) (a *API)
  • func (api *API) AttachMetrics(m *metrics.Metrics)
  • func (a *API) AttachToHandler(m *http.ServeMux)
  • func (a *API) OnConfigChange(c structs.OldNew) (err error)
• type APIMetrics
• type Cache
• type EnabledEndpoints
  • func (ee *EnabledEndpoints) GetBool(key string) (bool, error)
  • func (ee *EnabledEndpoints) SetBool(key string, val bool) error
• type Limitter
  • func NewLimitter(l log.Logger, ratel int, burst int, c Cache) *Limitter
  • func (l *Limitter) Allow(ctx context.Context, pubkey [48]byte) error
  • func (l *Limitter) OnConfigChange(c structs.OldNew) (err error)
  • func (l *Limitter) ParseInitialConfig(keys []string) (err error)
• type RateLimitter
• type Registrations
• type Relay
• type State

Constants

const (
	// proposer endpoints
	PathStatus            = "/eth/v1/builder/status"
	PathRegisterValidator = "/eth/v1/builder/validators"
	PathGetHeader         = "/eth/v1/builder/header/{slot:[0-9]+}/{parent_hash:0x[a-fA-F0-9]+}/{pubkey:0x[a-fA-F0-9]+}"
	PathGetPayload        = "/eth/v1/builder/blinded_blocks"

	// builder endpoints
	PathGetValidators = "/relay/v1/builder/validators"
	PathSubmitBlock   = "/relay/v1/builder/blocks"

	// data api
	PathBuilderBlocksReceived     = "/relay/v1/data/bidtraces/builder_blocks_received"
	PathProposerPayloadsDelivered = "/relay/v1/data/bidtraces/proposer_payload_delivered"
	PathSpecificRegistration      = "/relay/v1/data/validator_registration"
)

Router paths

Variables

var (
	ErrParamNotFound = errors.New("not found")
)

var ErrTooManyCalls = errors.New("too many calls")

Functions

func ParseHeaderRequest

func ParseHeaderRequest(r *http.Request) structs.HeaderRequest

Types

type API

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

func NewApi

func NewApi(l log.Logger, enabled *EnabledEndpoints, r Relay, reg Registrations, st State, lim RateLimitter, dataLimit int, errorsOnDisable bool) (a *API)

func (*API) AttachMetrics

func (api *API) AttachMetrics(m *metrics.Metrics)

func (*API) AttachToHandler

func (a *API) AttachToHandler(m *http.ServeMux)

func (*API) OnConfigChange

func (a *API) OnConfigChange(c structs.OldNew) (err error)

type APIMetrics

type APIMetrics struct {
	ApiReqCounter *prometheus.CounterVec
	ApiReqTiming  *prometheus.HistogramVec
	ApiReqElCount *prometheus.HistogramVec

	RelayTiming *prometheus.HistogramVec
}

type Cache

type Cache interface {
	Get([48]byte) (*rate.Limiter, bool)
	Add([48]byte, *rate.Limiter) bool
	Purge()
}

type EnabledEndpoints

type EnabledEndpoints struct {
	GetHeader   bool
	GetPayload  bool
	SubmitBlock bool
}

func (*EnabledEndpoints) GetBool

func (ee *EnabledEndpoints) GetBool(key string) (bool, error)

func (*EnabledEndpoints) SetBool

func (ee *EnabledEndpoints) SetBool(key string, val bool) error

type Limitter

type Limitter struct {
	AllowedBuilders map[[48]byte]struct{}

	RateLimit         rate.Limit
	Burst             int
	LimitterCacheSize int
	// contains filtered or unexported fields
}

func NewLimitter

func NewLimitter(l log.Logger, ratel int, burst int, c Cache) *Limitter

func (*Limitter) Allow

func (l *Limitter) Allow(ctx context.Context, pubkey [48]byte) error

func (*Limitter) OnConfigChange

func (l *Limitter) OnConfigChange(c structs.OldNew) (err error)

func (*Limitter) ParseInitialConfig

func (l *Limitter) ParseInitialConfig(keys []string) (err error)

type RateLimitter

type RateLimitter interface {
	Allow(ctx context.Context, pubkey [48]byte) error
}

type Registrations

type Registrations interface {
	// Proposer APIs (builder spec https://github.com/ethereum/builder-specs)
	RegisterValidator(context.Context, *structs.MetricGroup, []types.SignedValidatorRegistration) error
	// Data APIs
	Registration(context.Context, types.PublicKey) (types.SignedValidatorRegistration, error)
	// Builder APIs (relay spec https://flashbots.notion.site/Relay-API-Spec-5fb0819366954962bc02e81cb33840f5)
	GetValidators(*structs.MetricGroup) structs.BuilderGetValidatorsResponseEntrySlice
}

type Relay

type Relay interface {
	// Proposer APIs (builder spec https://github.com/ethereum/builder-specs)
	GetHeader(context.Context, *structs.MetricGroup, structs.UserContent, structs.HeaderRequest) (structs.GetHeaderResponse, error)
	GetPayload(context.Context, *structs.MetricGroup, structs.UserContent, structs.SignedBlindedBeaconBlock) (structs.GetPayloadResponse, error)

	// Builder APIs (relay spec https://flashbots.notion.site/Relay-API-Spec-5fb0819366954962bc02e81cb33840f5)
	SubmitBlock(context.Context, *structs.MetricGroup, structs.UserContent, structs.SubmitBlockRequest) error

	// Data APIs
	GetPayloadDelivered(context.Context, io.Writer, structs.PayloadTraceQuery) error
	GetBlockReceived(ctx context.Context, w io.Writer, query structs.SubmissionTraceQuery) error
}

type State

type State interface {
	ForkVersion(epoch structs.Slot) structs.ForkVersion
	HeadSlot() structs.Slot
}