engine

Documentation

Index

• Constants
• Variables
• type DB
• type EngineAPI
  • func NewEngineAPI(b *builder.Builder, txValidator TxValidator, blockStore DB, metrics Metrics) *EngineAPI
  • func (e *EngineAPI) ForkchoiceUpdatedV1(ctx context.Context, fcs eth.ForkchoiceState, pa *eth.PayloadAttributes) (*eth.ForkchoiceUpdatedResult, error)
  • func (e *EngineAPI) ForkchoiceUpdatedV2(ctx context.Context, fcs eth.ForkchoiceState, pa *eth.PayloadAttributes) (*eth.ForkchoiceUpdatedResult, error)
  • func (e *EngineAPI) ForkchoiceUpdatedV3(ctx context.Context, fcs eth.ForkchoiceState, pa *eth.PayloadAttributes) (*eth.ForkchoiceUpdatedResult, error)
  • func (e *EngineAPI) GetPayloadV1(ctx context.Context, payloadID engine.PayloadID) (*eth.ExecutionPayloadEnvelope, error)
  • func (e *EngineAPI) GetPayloadV2(ctx context.Context, payloadID engine.PayloadID) (*eth.ExecutionPayloadEnvelope, error)
  • func (e *EngineAPI) GetPayloadV3(ctx context.Context, payloadID engine.PayloadID) (*eth.ExecutionPayloadEnvelope, error)
  • func (e *EngineAPI) NewPayloadV1(payload eth.ExecutionPayload) (*eth.PayloadStatusV1, error)
  • func (e *EngineAPI) NewPayloadV2(payload eth.ExecutionPayload) (*eth.PayloadStatusV1, error)
  • func (e *EngineAPI) NewPayloadV3(payload eth.ExecutionPayload) (*eth.PayloadStatusV1, error)
• type Metrics
  • func NewMetrics(namespace string) Metrics
  • func NewNoopMetrics() Metrics
• type TxValidator

Constants

const (
	MetricsSubsystem = "engine"

	ForkchoiceUpdatedV3MethodName = "forkchoiceUpdatedV3"
	GetPayloadV3MethodName        = "getPayloadV3"
	NewPayloadV3MethodName        = "newPayloadV3"
)

Variables

var RPCMethodDurationBucketsMicroseconds = []float64{1, 10, 50, 100, 500, 1000}

Types

type DB

type DB interface {
	HeaderByHash(hash common.Hash) (*monomer.Header, error)
	Height() (uint64, error)
	UpdateLabels(unsafe, safe, finalized common.Hash) error
	HeaderByHeight(height uint64) (*monomer.Header, error)
	HeadHeader() (*monomer.Header, error)
}

type EngineAPI

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

EngineAPI implements the Engine API. It assumes it is the sole block proposer.

func NewEngineAPI

func NewEngineAPI(
	b *builder.Builder,
	txValidator TxValidator,
	blockStore DB,
	metrics Metrics,
) *EngineAPI

func (*EngineAPI) ForkchoiceUpdatedV1

func (e *EngineAPI) ForkchoiceUpdatedV1(
	ctx context.Context,
	fcs eth.ForkchoiceState,
	pa *eth.PayloadAttributes,
) (*eth.ForkchoiceUpdatedResult, error)

func (*EngineAPI) ForkchoiceUpdatedV2

func (e *EngineAPI) ForkchoiceUpdatedV2(
	ctx context.Context,
	fcs eth.ForkchoiceState,
	pa *eth.PayloadAttributes,
) (*eth.ForkchoiceUpdatedResult, error)

func (*EngineAPI) ForkchoiceUpdatedV3

func (e *EngineAPI) ForkchoiceUpdatedV3(
	ctx context.Context,
	fcs eth.ForkchoiceState,
	pa *eth.PayloadAttributes,
) (*eth.ForkchoiceUpdatedResult, error)

func (*EngineAPI) GetPayloadV1

func (e *EngineAPI) GetPayloadV1(ctx context.Context, payloadID engine.PayloadID) (*eth.ExecutionPayloadEnvelope, error)

func (*EngineAPI) GetPayloadV2

func (e *EngineAPI) GetPayloadV2(ctx context.Context, payloadID engine.PayloadID) (*eth.ExecutionPayloadEnvelope, error)

func (*EngineAPI) GetPayloadV3

func (e *EngineAPI) GetPayloadV3(ctx context.Context, payloadID engine.PayloadID) (*eth.ExecutionPayloadEnvelope, error)

GetPayloadV3 seals a payload that is currently being built (i.e. was introduced in the PayloadAttributes from a previous ForkchoiceUpdated call).

func (*EngineAPI) NewPayloadV1

func (e *EngineAPI) NewPayloadV1(payload eth.ExecutionPayload) (*eth.PayloadStatusV1, error)

func (*EngineAPI) NewPayloadV2

func (e *EngineAPI) NewPayloadV2(payload eth.ExecutionPayload) (*eth.PayloadStatusV1, error)

func (*EngineAPI) NewPayloadV3

func (e *EngineAPI) NewPayloadV3(payload eth.ExecutionPayload) (*eth.PayloadStatusV1, error)

NewPayloadV3 ensures the payload's block hash is present in the block store.

type Metrics

type Metrics interface {
	rpcmetrics.Metrics
}

Metrics contains metrics collected from the engine package.

func NewMetrics

func NewMetrics(namespace string) Metrics

func NewNoopMetrics

func NewNoopMetrics() Metrics

type TxValidator

type TxValidator interface {
	CheckTx(context.Context, *abci.RequestCheckTx) (*abci.ResponseCheckTx, error)
}