Crate engine

Available on crate feature node-api only.
Expand description

Traits, validation methods, and helper types used to abstract over engine types.

Modules§

config
Engine tree configuration.

Structs§

BeaconConsensusEngineHandle
A clonable sender type that can be used to send engine API messages.
ForkchoiceStateTracker
The struct that keeps track of the received forkchoice state and their status.
OnForkChoiceUpdated
Represents the outcome of forkchoice update.
TreeConfig
The configuration of the engine tree.

Enums§

BeaconConsensusEngineEvent
Events emitted by the consensus engine.
BeaconEngineMessage
A message for the beacon engine from other components of the node (engine RPC API invoked by the consensus layer).
BeaconForkChoiceUpdateError
Represents error cases for an applied forkchoice update.
BeaconOnNewPayloadError
Represents all error cases when handling a new payload.
ConsensusEngineLiveSyncProgress
Progress of the consensus engine during live sync.
ForkchoiceStateHash
A helper type to check represent hashes of a [ForkchoiceState]
ForkchoiceStatus
A simplified representation of [PayloadStatusEnum] specifically for FCU.

Constants§

DEFAULT_MEMORY_BLOCK_BUFFER_TARGET
How close to the canonical head we persist blocks.
DEFAULT_PERSISTENCE_THRESHOLD
Triggers persistence when the number of canonical blocks in memory exceeds this threshold.

Traits§

EngineTypes
This type defines the versioned types of the engine API.
EngineValidator
Type that validates the payloads processed by the engine.
ExecutionPayload
An execution payload.
InvalidBlockHook
An invalid block hook.
PayloadValidator
Type that validates an ExecutionPayload.

Functions§

has_enough_parallelism
Determines if the host has enough parallelism to run the payload processor.