feat: introduce payload types (paradigmxyz#8756)

Co-authored-by: Matthias Seitz <[email protected]>

crates/e2e-test-utils/src/node.rs

@@ -9,6 +9,7 @@ use futures_util::Future;
 use reth::{
     api::{BuiltPayload, EngineTypes, FullNodeComponents, PayloadBuilderAttributes},
     builder::FullNode,
+    payload::PayloadTypes,
     providers::{BlockReader, BlockReaderIdExt, CanonStateSubscriptions, StageCheckpointReader},
     rpc::types::engine::PayloadStatusEnum,
 };
@@ -65,12 +66,12 @@ where
         &mut self,
         length: u64,
         tx_generator: impl Fn(u64) -> Pin<Box<dyn Future<Output = Bytes>>>,
-        attributes_generator: impl Fn(u64) -> <Node::Engine as EngineTypes>::PayloadBuilderAttributes
+        attributes_generator: impl Fn(u64) -> <Node::Engine as PayloadTypes>::PayloadBuilderAttributes
             + Copy,
     ) -> eyre::Result<
         Vec<(
             <Node::Engine as EngineTypes>::BuiltPayload,
-            <Node::Engine as EngineTypes>::PayloadBuilderAttributes,
+            <Node::Engine as PayloadTypes>::PayloadBuilderAttributes,
         )>,
     >
     where
@@ -96,10 +97,10 @@ where
     /// It triggers the resolve payload via engine api and expects the built payload event.
     pub async fn new_payload(
         &mut self,
-        attributes_generator: impl Fn(u64) -> <Node::Engine as EngineTypes>::PayloadBuilderAttributes,
+        attributes_generator: impl Fn(u64) -> <Node::Engine as PayloadTypes>::PayloadBuilderAttributes,
     ) -> eyre::Result<(
         <<Node as NodeTypes>::Engine as EngineTypes>::BuiltPayload,
-        <<Node as NodeTypes>::Engine as EngineTypes>::PayloadBuilderAttributes,
+        <<Node as NodeTypes>::Engine as PayloadTypes>::PayloadBuilderAttributes,
     )>
     where
         <Node::Engine as EngineTypes>::ExecutionPayloadV3:
@@ -121,10 +122,10 @@ where
     pub async fn advance_block(
         &mut self,
         versioned_hashes: Vec<B256>,
-        attributes_generator: impl Fn(u64) -> <Node::Engine as EngineTypes>::PayloadBuilderAttributes,
+        attributes_generator: impl Fn(u64) -> <Node::Engine as PayloadTypes>::PayloadBuilderAttributes,
     ) -> eyre::Result<(
         <Node::Engine as EngineTypes>::BuiltPayload,
-        <<Node as NodeTypes>::Engine as EngineTypes>::PayloadBuilderAttributes,
+        <<Node as NodeTypes>::Engine as PayloadTypes>::PayloadBuilderAttributes,
     )>
     where
         <Node::Engine as EngineTypes>::ExecutionPayloadV3:

crates/engine-primitives/src/lib.rs

@@ -9,26 +9,17 @@
 #![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))]
 
 use core::fmt;
-use reth_primitives::ChainSpec;
-
 use reth_payload_primitives::{
-    BuiltPayload, EngineApiMessageVersion, EngineObjectValidationError, PayloadAttributes,
-    PayloadBuilderAttributes, PayloadOrAttributes,
+    BuiltPayload, EngineApiMessageVersion, EngineObjectValidationError, PayloadOrAttributes,
+    PayloadTypes,
 };
-
+use reth_primitives::ChainSpec;
 use serde::{de::DeserializeOwned, ser::Serialize};
+
 /// The types that are used by the engine API.
 pub trait EngineTypes:
-    DeserializeOwned + Serialize + fmt::Debug + Unpin + Send + Sync + Clone
+    PayloadTypes + DeserializeOwned + Serialize + fmt::Debug + Unpin + Send + Sync + Clone
 {
-    /// The RPC payload attributes type the CL node emits via the engine API.
-    type PayloadAttributes: PayloadAttributes + Unpin;
-
-    /// The payload attributes type that contains information about a running payload job.
-    type PayloadBuilderAttributes: PayloadBuilderAttributes<RpcPayloadAttributes = Self::PayloadAttributes>
-        + Clone
-        + Unpin;
-
     /// The built payload type.
     type BuiltPayload: BuiltPayload
         + Clone

crates/ethereum/engine-primitives/src/lib.rs

@@ -14,7 +14,7 @@ pub use payload::{EthBuiltPayload, EthPayloadBuilderAttributes};
 use reth_engine_primitives::EngineTypes;
 use reth_payload_primitives::{
     validate_version_specific_fields, EngineApiMessageVersion, EngineObjectValidationError,
-    PayloadOrAttributes,
+    PayloadOrAttributes, PayloadTypes,
 };
 use reth_primitives::ChainSpec;
 use reth_rpc_types::{
@@ -30,9 +30,12 @@ use reth_rpc_types::{
 #[non_exhaustive]
 pub struct EthEngineTypes;
 
-impl EngineTypes for EthEngineTypes {
+impl PayloadTypes for EthEngineTypes {
     type PayloadAttributes = EthPayloadAttributes;
     type PayloadBuilderAttributes = EthPayloadBuilderAttributes;
+}
+
+impl EngineTypes for EthEngineTypes {
     type BuiltPayload = EthBuiltPayload;
     type ExecutionPayloadV1 = ExecutionPayloadV1;
     type ExecutionPayloadV2 = ExecutionPayloadEnvelopeV2;

crates/optimism/node/src/engine.rs

@@ -1,7 +1,7 @@
 use reth_node_api::{
     payload::{
         validate_parent_beacon_block_root_presence, EngineApiMessageVersion,
-        EngineObjectValidationError, MessageValidationKind, PayloadOrAttributes,
+        EngineObjectValidationError, MessageValidationKind, PayloadOrAttributes, PayloadTypes,
         VersionSpecificValidationError,
     },
     EngineTypes,
@@ -21,9 +21,12 @@ use reth_rpc_types::{
 #[non_exhaustive]
 pub struct OptimismEngineTypes;
 
-impl EngineTypes for OptimismEngineTypes {
+impl PayloadTypes for OptimismEngineTypes {
     type PayloadAttributes = OptimismPayloadAttributes;
     type PayloadBuilderAttributes = OptimismPayloadBuilderAttributes;
+}
+
+impl EngineTypes for OptimismEngineTypes {
     type BuiltPayload = OptimismBuiltPayload;
     type ExecutionPayloadV1 = ExecutionPayloadV1;
     type ExecutionPayloadV2 = ExecutionPayloadEnvelopeV2;

crates/payload/primitives/src/lib.rs

@@ -22,6 +22,17 @@ pub use payload::PayloadOrAttributes;
 use reth_primitives::ChainSpec;
 use std::fmt::Debug;
 
+/// The types that are used by the engine API.
+pub trait PayloadTypes: Send + Sync + Unpin {
+    /// The RPC payload attributes type the CL node emits via the engine API.
+    type PayloadAttributes: PayloadAttributes + Unpin;
+
+    /// The payload attributes type that contains information about a running payload job.
+    type PayloadBuilderAttributes: PayloadBuilderAttributes<RpcPayloadAttributes = Self::PayloadAttributes>
+        + Clone
+        + Unpin;
+}
+
 /// Validates the timestamp depending on the version called:
 ///
 /// * If V2, this ensures that the payload timestamp is pre-Cancun.

examples/custom-engine-types/src/main.rs

@@ -23,6 +23,7 @@ use serde::{Deserialize, Serialize};
 use thiserror::Error;
 
 use reth::{
+    api::PayloadTypes,
     builder::{
         components::{ComponentsBuilder, PayloadServiceBuilder},
         node::NodeTypes,
@@ -162,9 +163,12 @@ impl PayloadBuilderAttributes for CustomPayloadBuilderAttributes {
 #[non_exhaustive]
 pub struct CustomEngineTypes;
 
-impl EngineTypes for CustomEngineTypes {
+impl PayloadTypes for CustomEngineTypes {
     type PayloadAttributes = CustomPayloadAttributes;
     type PayloadBuilderAttributes = CustomPayloadBuilderAttributes;
+}
+
+impl EngineTypes for CustomEngineTypes {
     type BuiltPayload = EthBuiltPayload;
     type ExecutionPayloadV1 = ExecutionPayloadV1;
     type ExecutionPayloadV2 = ExecutionPayloadEnvelopeV2;