Crate engine

Expand description

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

Modules§

ConsensusEngineHandle: A cloneable 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.
InvalidBlockHooks: Multiple InvalidBlockHooks that are executed in order.
NoopInvalidBlockHook: A no-op InvalidBlockHook that does nothing.
OnForkChoiceUpdated: Represents the outcome of forkchoice update.
TreeConfig: The configuration of the engine tree.

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.
ConsensusEngineEvent: Events emitted by the consensus engine.
ForkchoiceStateHash: A helper type to check represent hashes of a ForkchoiceState
ForkchoiceStatus: A simplified representation of PayloadStatusEnum specifically for FCU.

DEFAULT_MEMORY_BLOCK_BUFFER_TARGET: How close to the canonical head we persist blocks.
DEFAULT_MULTIPROOF_TASK_CHUNK_SIZE: The size of proof targets chunk to spawn in one multiproof calculation.
DEFAULT_MULTIPROOF_TASK_CHUNK_SIZE_V2: The size of proof targets chunk to spawn in one multiproof calculation when V2 proofs are enabled. This is 4x the default chunk size to take advantage of more efficient V2 proof computation.
DEFAULT_PERSISTENCE_THRESHOLD: Triggers persistence when the number of canonical blocks in memory exceeds this threshold.
DEFAULT_PREWARM_MAX_CONCURRENCY: Default maximum concurrency for prewarm task.
DEFAULT_RESERVED_CPU_CORES: Default number of reserved CPU cores for non-reth processes.
MIN_WORKER_COUNT: Minimum number of workers we allow configuring explicitly.

ConfigureEngineEvm: ConfigureEvm extension providing methods for executing payloads.
EngineApiValidator: Type that validates the payloads processed by the engine API.
EngineTypes: This type defines the versioned types of the engine API based on the ethereum engine API.
ExecutableTxIterator: Iterator over executable transactions.
ExecutableTxTuple: A helper trait representing a pair of a “raw” transactions iterator and a closure that can be used to convert them to an executable transaction. This tuple is used in the engine to parallelize heavy work like decoding or recovery.
ExecutionPayload: Represents the core data structure of an execution payload.
InvalidBlockHook: An invalid block hook.
PayloadValidator: Type that validates an ExecutionPayload.

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