Crate reth_node_api

Standalone crate for Reth configuration traits and builder types.

Re-exports

• pub use reth_engine_primitives as engine;
• pub use reth_payload_primitives as payload;
• pub use reth_payload_builder_primitives as payload_builder;
• pub use node::*;

Modules

• node
  Traits for configuring a node.

Structs

• AnyNodeTypes
  A NodeTypes type builder.
• AnyNodeTypesWithEngine
  A NodeTypesWithEngine type builder.
• ForkchoiceStateTracker
  The struct that keeps track of the received forkchoice state and their status.
• NextBlockEnvAttributes
  Traits and helper types used to abstract over EVM methods and types. Represents additional attributes required to configure the next block. This is used to configure the next block’s environment ConfigureEvmEnv::next_cfg_and_block_env and contains fields that can’t be derived from the parent header alone (attributes that are determined by the CL.)
• NodeTypesWithDBAdapter
  An adapter type combining NodeTypes and db into NodeTypesWithDB.
• OnForkChoiceUpdated
  Represents the outcome of forkchoice update.
• PayloadEvents
  Represents a receiver for various payload events.

Enums

• BeaconEngineMessage
  A message for the beacon engine from other components of the node (engine RPC API invoked by the consensus layer).
• BeaconOnNewPayloadError
  Represents all error cases when handling a new payload.
• EngineApiMessageVersion
  The version of Engine API message.
• EngineObjectValidationError
  Thrown when the payload or attributes are known to be invalid before processing.
• Events
  Payload builder events.
• ForkchoiceStateHash
  A helper type to check represent hashes of a [ForkchoiceState]
• ForkchoiceStatus
  A simplified representation of [PayloadStatusEnum] specifically for FCU.
• InvalidPayloadAttributesError
  Thrown when validating the correctness of a payloadattributes object.
• MessageValidationKind
  A type that represents whether or not we are validating a payload or payload attributes.
• PayloadBuilderError
  Possible error variants during payload building.
• PayloadKind
  Determines how we should choose the payload to return.
• PayloadOrAttributes
  Either an [ExecutionPayload] or a types that implements the PayloadAttributes trait.
• VersionSpecificValidationError
  Thrown when validating an execution payload OR payload attributes fails due to:

Traits

• Block
  Abstraction of block data type.
• BlockBody
  Abstraction for block’s body.
• BuiltPayload
  Represents a built payload type that contains a built [SealedBlock] and can be converted into engine API execution payloads.
• ConfigureEvm
  Traits and helper types used to abstract over EVM methods and types. Trait for configuring the EVM for executing full blocks.
• ConfigureEvmEnv
  Traits and helper types used to abstract over EVM methods and types. This represents the set of methods used to configure the EVM’s environment before block execution.
• EngineTypes
  This type defines the versioned types of the engine API.
• EngineValidator
  Type that validates the payloads processed by the engine.
• FullBlock
  Helper trait that unifies all behaviour required by block to support full node operations.
• FullNodePrimitives
  Helper trait that sets trait bounds on NodePrimitives.
• FullProvider
  Helper trait to unify all provider traits for simplicity.
• FullReceipt
  Helper trait that unifies all behaviour required by receipt to support full node operations.
• FullSignedTx
  Helper trait that unifies all behaviour required by block to support full node operations.
• InvalidBlockHook
  An invalid block hook.
• NodePrimitives
  Configures all the primitive types of the node.
• NodeTypes
  The type that configures the essential types of an Ethereum-like node.
• NodeTypesWithDB
  A helper trait that is downstream of the NodeTypesWithEngine trait and adds database to the node.
• NodeTypesWithEngine
  The type that configures an Ethereum-like node with an engine for consensus.
• PayloadAttributes
  The execution payload attribute type the CL node emits via the engine API. This trait should be implemented by types that could be used to spawn a payload job.
• PayloadAttributesBuilder
  A builder that can return the current payload attribute.
• PayloadBuilder
  A type that can request, subscribe to and resolve payloads.
• PayloadBuilderAttributes
  This can be implemented by types that describe a currently running payload job.
• PayloadStoreExt
  A helper trait for internal usage to retrieve and resolve payloads.
• PayloadTypes
  The types that are used by the engine API.
• PayloadValidator
  Type that validates an [ExecutionPayload].

Functions

• validate_parent_beacon_block_root_presence
  Validate the presence of the parentBeaconBlockRoot field according to the given timestamp. This method is meant to be used with either a payloadAttributes field or a full payload, with the engine_forkchoiceUpdated and engine_newPayload methods respectively.
• validate_payload_timestamp
  Validates the timestamp depending on the version called:
• validate_version_specific_fields
  Validates the presence or exclusion of fork-specific fields based on the ethereum execution payload, or payload attributes, and the message version.
• validate_withdrawals_presence
  Validates the presence of the withdrawals field according to the payload timestamp. After Shanghai, withdrawals field must be Some. Before Shanghai, withdrawals field must be None;

Type Aliases

• BlockTy
  Helper adapter type for accessing NodePrimitives::Block on NodeTypes.
• BodyTy
  Helper adapter type for accessing NodePrimitives::BlockBody on NodeTypes.
• HeaderTy
  Helper adapter type for accessing NodePrimitives::BlockHeader on NodeTypes.
• ReceiptTy
  Helper adapter type for accessing NodePrimitives::Receipt on NodeTypes.
• TxTy
  Helper adapter type for accessing NodePrimitives::SignedTx on NodeTypes.