api

Documentation

Overview

Package api contains the API webserver for the proposer and block-builder APIs

Index

• Variables
• func BuildGetHeaderResponse(payload *common.BuilderSubmitBlockRequest, sk *bls.SecretKey, ...) (*common.GetHeaderResponse, error)
• func BuildGetPayloadResponse(payload *common.BuilderSubmitBlockRequest) (*common.GetPayloadResponse, error)
• func BuilderSubmitBlockRequestToSignedBuilderBid(req *boostTypes.BuilderSubmitBlockRequest, sk *bls.SecretKey, ...) (*boostTypes.SignedBuilderBid, error)
• func CapellaBuilderSubmitBlockRequestToSignedBuilderBid(req *capella.SubmitBlockRequest, sk *bls.SecretKey, pubkey *phase0.BLSPubKey, ...) (*capella.SignedBuilderBid, error)
• func CapellaPayloadToPayloadHeader(p *consensuscapella.ExecutionPayload) (*consensuscapella.ExecutionPayloadHeader, error)
• func ComputeWithdrawalsRoot(w []*capella.Withdrawal) (phase0.Root, error)
• func SanityCheckBuilderBlockSubmission(payload *common.BuilderSubmitBlockRequest) error
• func SendJSONRPCRequest(client *http.Client, req jsonrpc.JSONRPCRequest, url string, isHighPrio bool) (res *jsonrpc.JSONRPCResponse, err error)
• func SignedBlindedBeaconBlockToBeaconBlock(signedBlindedBeaconBlock *common.SignedBlindedBeaconBlock, ...) *common.SignedBeaconBlock
• type BlockSimulationRateLimiter
  • func NewBlockSimulationRateLimiter(blockSimURL string) *BlockSimulationRateLimiter
• type BuilderBlockValidationRequest
  • func (r *BuilderBlockValidationRequest) MarshalJSON() ([]byte, error)
• type HTTPErrorResp
• type RelayAPI
  • func NewRelayAPI(opts RelayAPIOpts) (api *RelayAPI, err error)
  • func (api *RelayAPI) RespondError(w http.ResponseWriter, code int, message string)
  • func (api *RelayAPI) RespondOK(w http.ResponseWriter, response any)
  • func (api *RelayAPI) StartServer() (err error)
  • func (api *RelayAPI) StopServer() (err error)
• type RelayAPIOpts

Variables

var (
	ErrRequestClosed    = errors.New("request context closed")
	ErrSimulationFailed = errors.New("simulation failed")
)

var (
	ErrMissingLogOpt              = errors.New("log parameter is nil")
	ErrMissingBeaconClientOpt     = errors.New("beacon-client is nil")
	ErrMissingDatastoreOpt        = errors.New("proposer datastore is nil")
	ErrRelayPubkeyMismatch        = errors.New("relay pubkey does not match existing one")
	ErrServerAlreadyStarted       = errors.New("server was already started")
	ErrBuilderAPIWithoutSecretKey = errors.New("cannot start builder API without secret key")
	ErrMismatchedForkVersions     = errors.New("can not find matching fork versions as retrieved from beacon node")
	ErrMissingForkVersions        = errors.New("invalid bellatrix/capella fork version from beacon node")
)

var (
	ErrMissingRequest     = errors.New("req is nil")
	ErrMissingSecretKey   = errors.New("secret key is nil")
	ErrEmptyPayload       = errors.New("nil payload")
	ErrInvalidTransaction = errors.New("invalid transaction")
)

var (
	ErrBlockHashMismatch  = errors.New("blockHash mismatch")
	ErrParentHashMismatch = errors.New("parentHash mismatch")
)

var NilResponse = struct{}{}

var VersionBellatrix boostTypes.VersionString = "bellatrix"

var ZeroU256 = boostTypes.IntToU256(0)

Functions

func BuildGetHeaderResponse

func BuildGetHeaderResponse(payload *common.BuilderSubmitBlockRequest, sk *bls.SecretKey, pubkey *boostTypes.PublicKey, domain boostTypes.Domain) (*common.GetHeaderResponse, error)

func BuildGetPayloadResponse

func BuildGetPayloadResponse(payload *common.BuilderSubmitBlockRequest) (*common.GetPayloadResponse, error)

func BuilderSubmitBlockRequestToSignedBuilderBid

func BuilderSubmitBlockRequestToSignedBuilderBid(req *boostTypes.BuilderSubmitBlockRequest, sk *bls.SecretKey, pubkey *boostTypes.PublicKey, domain boostTypes.Domain) (*boostTypes.SignedBuilderBid, error)

func CapellaBuilderSubmitBlockRequestToSignedBuilderBid

func CapellaBuilderSubmitBlockRequestToSignedBuilderBid(req *capella.SubmitBlockRequest, sk *bls.SecretKey, pubkey *phase0.BLSPubKey, domain boostTypes.Domain) (*capella.SignedBuilderBid, error)

func CapellaPayloadToPayloadHeader

func CapellaPayloadToPayloadHeader(p *consensuscapella.ExecutionPayload) (*consensuscapella.ExecutionPayloadHeader, error)

func ComputeWithdrawalsRoot

func ComputeWithdrawalsRoot(w []*capella.Withdrawal) (phase0.Root, error)

func SanityCheckBuilderBlockSubmission

func SanityCheckBuilderBlockSubmission(payload *common.BuilderSubmitBlockRequest) error

func SendJSONRPCRequest

func SendJSONRPCRequest(client *http.Client, req jsonrpc.JSONRPCRequest, url string, isHighPrio bool) (res *jsonrpc.JSONRPCResponse, err error)

SendJSONRPCRequest sends the request to URL and returns the general JsonRpcResponse, or an error (note: not the JSONRPCError)

func SignedBlindedBeaconBlockToBeaconBlock

func SignedBlindedBeaconBlockToBeaconBlock(signedBlindedBeaconBlock *common.SignedBlindedBeaconBlock, executionPayload *common.VersionedExecutionPayload) *common.SignedBeaconBlock

Types

type BlockSimulationRateLimiter

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

func NewBlockSimulationRateLimiter

func NewBlockSimulationRateLimiter(blockSimURL string) *BlockSimulationRateLimiter

type BuilderBlockValidationRequest

type BuilderBlockValidationRequest struct {
	common.BuilderSubmitBlockRequest
	RegisteredGasLimit uint64 `json:"registered_gas_limit,string"`
}

func (*BuilderBlockValidationRequest) MarshalJSON

func (r *BuilderBlockValidationRequest) MarshalJSON() ([]byte, error)

type HTTPErrorResp

type HTTPErrorResp struct {
	Code    int    `json:"code"`
	Message string `json:"message"`
}

type RelayAPI

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

RelayAPI represents a single Relay instance

func NewRelayAPI

func NewRelayAPI(opts RelayAPIOpts) (api *RelayAPI, err error)

NewRelayAPI creates a new service. if builders is nil, allow any builder

func (*RelayAPI) RespondError

func (api *RelayAPI) RespondError(w http.ResponseWriter, code int, message string)

func (*RelayAPI) RespondOK

func (api *RelayAPI) RespondOK(w http.ResponseWriter, response any)

func (*RelayAPI) StartServer

func (api *RelayAPI) StartServer() (err error)

StartServer starts the HTTP server for this instance

func (*RelayAPI) StopServer

func (api *RelayAPI) StopServer() (err error)

StopServer disables sending any bids on getHeader calls, waits a few seconds to catch any remaining getPayload call, and then shuts down the webserver

type RelayAPIOpts

type RelayAPIOpts struct {
	Log *logrus.Entry

	ListenAddr  string
	BlockSimURL string

	BeaconClient beaconclient.IMultiBeaconClient
	Datastore    *datastore.Datastore
	Redis        *datastore.RedisCache
	Memcached    *datastore.Memcached
	DB           database.IDatabaseService

	SecretKey *bls.SecretKey // used to sign bids (getHeader responses)

	// Network specific variables
	EthNetDetails common.EthNetworkDetails

	// APIs to enable
	ProposerAPI     bool
	BlockBuilderAPI bool
	DataAPI         bool
	PprofAPI        bool
	InternalAPI     bool
}

RelayAPIOpts contains the options for a relay