Crate kona_engine

Source
Expand description

§kona-engine

CI Kona Engine License Codecov

An extensible implementation of the OP Stack rollup node engine client.

Structs§

BuildTask
The BuildTask is responsible for building new blocks and importing them via the engine API.
ConsolidateTask
The ConsolidateTask attempts to consolidate the engine state using the specified payload attributes and the oldest unsafe head.
Engine
The Engine task queue.
EngineClient
An external engine api client
EngineState
The chain state viewed by the engine controller.
EngineSyncState
The sync state of the engine.
EngineSyncStateUpdate
Specifies how to update the sync state of the engine.
FinalizeTask
The FinalizeTask fetches the L2BlockInfo at block_number, updates the EngineState, and dispatches a forkchoice update to finalize the block.
ForkchoiceTask
The ForkchoiceTask executes an engine_forkchoiceUpdated call with the current EngineState’s forkchoice, and no payload attributes.
InsertTask
The task to insert a payload into the execution engine.
Metrics
Container for metrics.

Enums§

AttributesMatch
Represents whether the attributes match the block or not.
AttributesMismatch
An enum over the type of mismatch between OpAttributesWithParent and a Block.
BuildTaskError
An error that occurs when running the crate::ForkchoiceTask.
ConsolidateTaskError
An error that occurs when running the crate::ConsolidateTask.
EngineClientError
An error that occurred in the EngineClient.
EngineForkchoiceVersion
The method version for the engine_forkchoiceUpdated api.
EngineGetPayloadVersion
The method version for the engine_getPayload api.
EngineKind
The engine kind identifies the engine client’s kind, used to control the behavior of optimism in different engine clients.
EngineNewPayloadVersion
The method version for the engine_newPayload api.
EngineQueries
Returns the full engine state.
EngineQueriesError
An error that can occur when querying the engine.
EngineResetError
An error occurred while attempting to reset the Engine.
EngineTask
Tasks that may be inserted into and executed by the Engine.
EngineTaskErrorSeverity
The severity of an engine task error.
EngineTaskErrors
An error that may occur during an EngineTask’s execution.
FinalizeTaskError
An error that occurs when running the crate::FinalizeTask.
ForkchoiceTaskError
An error that occurs when running the crate::ForkchoiceTask.
InsertTaskError
An error that occurs when running the InsertTask.

Traits§

EngineTaskError
The interface for an engine task error.
EngineTaskExt
The interface for an engine task.

Type Aliases§

EngineQuerySender
The type of data that can be requested from the engine.