feat(payload): add support for stack of payload builders (#11004)

Co-authored-by: Matthias Seitz <matthias.seitz@outlook.de>

crates/payload/basic/src/lib.rs

@@ -42,6 +42,9 @@ use tokio::{
 use tracing::{debug, trace, warn};
 
 mod metrics;
+mod stack;
+
+pub use stack::PayloadBuilderStack;
 
 /// The [`PayloadJobGenerator`] that creates [`BasicPayloadJob`]s.
 #[derive(Debug)]
@@ -783,6 +786,21 @@ impl<Payload> BuildOutcome<Payload> {
     pub const fn is_cancelled(&self) -> bool {
         matches!(self, Self::Cancelled)
     }
+
+    /// Applies a fn on the current payload.
+    pub(crate) fn map_payload<F, P>(self, f: F) -> BuildOutcome<P>
+    where
+        F: FnOnce(Payload) -> P,
+    {
+        match self {
+            Self::Better { payload, cached_reads } => {
+                BuildOutcome::Better { payload: f(payload), cached_reads }
+            }
+            Self::Aborted { fees, cached_reads } => BuildOutcome::Aborted { fees, cached_reads },
+            Self::Cancelled => BuildOutcome::Cancelled,
+            Self::Freeze(payload) => BuildOutcome::Freeze(f(payload)),
+        }
+    }
 }
 
 /// The possible outcomes of a payload building attempt without reused [`CachedReads`]

crates/payload/basic/src/stack.rs

@@ -0,0 +1,270 @@
+use crate::{
+    BuildArguments, BuildOutcome, PayloadBuilder, PayloadBuilderAttributes, PayloadBuilderError,
+    PayloadConfig,
+};
+
+use alloy_primitives::{Address, B256, U256};
+use reth_payload_builder::PayloadId;
+use reth_payload_primitives::BuiltPayload;
+use reth_primitives::{SealedBlock, Withdrawals};
+
+use alloy_eips::eip7685::Requests;
+use std::{error::Error, fmt};
+
+/// hand rolled Either enum to handle two builder types
+#[derive(Debug, Clone)]
+pub enum Either<L, R> {
+    /// left variant
+    Left(L),
+    /// right variant
+    Right(R),
+}
+
+impl<L, R> fmt::Display for Either<L, R>
+where
+    L: fmt::Display,
+    R: fmt::Display,
+{
+    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+        match self {
+            Self::Left(l) => write!(f, "Left: {}", l),
+            Self::Right(r) => write!(f, "Right: {}", r),
+        }
+    }
+}
+
+impl<L, R> Error for Either<L, R>
+where
+    L: Error + 'static,
+    R: Error + 'static,
+{
+    fn source(&self) -> Option<&(dyn Error + 'static)> {
+        match self {
+            Self::Left(l) => Some(l),
+            Self::Right(r) => Some(r),
+        }
+    }
+}
+
+impl<L, R> PayloadBuilderAttributes for Either<L, R>
+where
+    L: PayloadBuilderAttributes,
+    R: PayloadBuilderAttributes,
+    L::Error: Error + 'static,
+    R::Error: Error + 'static,
+{
+    type RpcPayloadAttributes = Either<L::RpcPayloadAttributes, R::RpcPayloadAttributes>;
+    type Error = Either<L::Error, R::Error>;
+
+    fn try_new(
+        parent: B256,
+        rpc_payload_attributes: Self::RpcPayloadAttributes,
+        version: u8,
+    ) -> Result<Self, Self::Error> {
+        match rpc_payload_attributes {
+            Either::Left(attr) => {
+                L::try_new(parent, attr, version).map(Either::Left).map_err(Either::Left)
+            }
+            Either::Right(attr) => {
+                R::try_new(parent, attr, version).map(Either::Right).map_err(Either::Right)
+            }
+        }
+    }
+
+    fn payload_id(&self) -> PayloadId {
+        match self {
+            Self::Left(l) => l.payload_id(),
+            Self::Right(r) => r.payload_id(),
+        }
+    }
+
+    fn parent(&self) -> B256 {
+        match self {
+            Self::Left(l) => l.parent(),
+            Self::Right(r) => r.parent(),
+        }
+    }
+
+    fn timestamp(&self) -> u64 {
+        match self {
+            Self::Left(l) => l.timestamp(),
+            Self::Right(r) => r.timestamp(),
+        }
+    }
+
+    fn parent_beacon_block_root(&self) -> Option<B256> {
+        match self {
+            Self::Left(l) => l.parent_beacon_block_root(),
+            Self::Right(r) => r.parent_beacon_block_root(),
+        }
+    }
+
+    fn suggested_fee_recipient(&self) -> Address {
+        match self {
+            Self::Left(l) => l.suggested_fee_recipient(),
+            Self::Right(r) => r.suggested_fee_recipient(),
+        }
+    }
+
+    fn prev_randao(&self) -> B256 {
+        match self {
+            Self::Left(l) => l.prev_randao(),
+            Self::Right(r) => r.prev_randao(),
+        }
+    }
+
+    fn withdrawals(&self) -> &Withdrawals {
+        match self {
+            Self::Left(l) => l.withdrawals(),
+            Self::Right(r) => r.withdrawals(),
+        }
+    }
+}
+
+/// this structure enables the chaining of multiple `PayloadBuilder` implementations,
+/// creating a hierarchical fallback system. It's designed to be nestable, allowing
+/// for complex builder arrangements like `Stack<Stack<A, B>, C>` with different
+#[derive(Debug)]
+pub struct PayloadBuilderStack<L, R> {
+    left: L,
+    right: R,
+}
+
+impl<L, R> PayloadBuilderStack<L, R> {
+    /// Creates a new `PayloadBuilderStack` with the given left and right builders.
+    pub const fn new(left: L, right: R) -> Self {
+        Self { left, right }
+    }
+}
+
+impl<L, R> Clone for PayloadBuilderStack<L, R>
+where
+    L: Clone,
+    R: Clone,
+{
+    fn clone(&self) -> Self {
+        Self::new(self.left.clone(), self.right.clone())
+    }
+}
+
+impl<L, R> BuiltPayload for Either<L, R>
+where
+    L: BuiltPayload,
+    R: BuiltPayload,
+{
+    fn block(&self) -> &SealedBlock {
+        match self {
+            Self::Left(l) => l.block(),
+            Self::Right(r) => r.block(),
+        }
+    }
+
+    fn fees(&self) -> U256 {
+        match self {
+            Self::Left(l) => l.fees(),
+            Self::Right(r) => r.fees(),
+        }
+    }
+
+    fn requests(&self) -> Option<Requests> {
+        match self {
+            Self::Left(l) => l.requests(),
+            Self::Right(r) => r.requests(),
+        }
+    }
+}
+
+impl<L, R, Pool, Client> PayloadBuilder<Pool, Client> for PayloadBuilderStack<L, R>
+where
+    L: PayloadBuilder<Pool, Client> + Unpin + 'static,
+    R: PayloadBuilder<Pool, Client> + Unpin + 'static,
+    Client: Clone,
+    Pool: Clone,
+    L::Attributes: Unpin + Clone,
+    R::Attributes: Unpin + Clone,
+    L::BuiltPayload: Unpin + Clone,
+    R::BuiltPayload: Unpin + Clone,
+    <<L as PayloadBuilder<Pool, Client>>::Attributes as PayloadBuilderAttributes>::Error: 'static,
+    <<R as PayloadBuilder<Pool, Client>>::Attributes as PayloadBuilderAttributes>::Error: 'static,
+{
+    type Attributes = Either<L::Attributes, R::Attributes>;
+    type BuiltPayload = Either<L::BuiltPayload, R::BuiltPayload>;
+
+    fn try_build(
+        &self,
+        args: BuildArguments<Pool, Client, Self::Attributes, Self::BuiltPayload>,
+    ) -> Result<BuildOutcome<Self::BuiltPayload>, PayloadBuilderError> {
+        match args.config.attributes {
+            Either::Left(ref left_attr) => {
+                let left_args: BuildArguments<Pool, Client, L::Attributes, L::BuiltPayload> =
+                    BuildArguments {
+                        client: args.client.clone(),
+                        pool: args.pool.clone(),
+                        cached_reads: args.cached_reads.clone(),
+                        config: PayloadConfig {
+                            parent_header: args.config.parent_header.clone(),
+                            extra_data: args.config.extra_data.clone(),
+                            attributes: left_attr.clone(),
+                        },
+                        cancel: args.cancel.clone(),
+                        best_payload: args.best_payload.clone().and_then(|payload| {
+                            if let Either::Left(p) = payload {
+                                Some(p)
+                            } else {
+                                None
+                            }
+                        }),
+                    };
+
+                self.left.try_build(left_args).map(|out| out.map_payload(Either::Left))
+            }
+            Either::Right(ref right_attr) => {
+                let right_args = BuildArguments {
+                    client: args.client.clone(),
+                    pool: args.pool.clone(),
+                    cached_reads: args.cached_reads.clone(),
+                    config: PayloadConfig {
+                        parent_header: args.config.parent_header.clone(),
+                        extra_data: args.config.extra_data.clone(),
+                        attributes: right_attr.clone(),
+                    },
+                    cancel: args.cancel.clone(),
+                    best_payload: args.best_payload.clone().and_then(|payload| {
+                        if let Either::Right(p) = payload {
+                            Some(p)
+                        } else {
+                            None
+                        }
+                    }),
+                };
+
+                self.right.try_build(right_args).map(|out| out.map_payload(Either::Right))
+            }
+        }
+    }
+
+    fn build_empty_payload(
+        &self,
+        client: &Client,
+        config: PayloadConfig<Self::Attributes>,
+    ) -> Result<Self::BuiltPayload, PayloadBuilderError> {
+        match config.attributes {
+            Either::Left(left_attr) => {
+                let left_config = PayloadConfig {
+                    attributes: left_attr,
+                    parent_header: config.parent_header.clone(),
+                    extra_data: config.extra_data.clone(),
+                };
+                self.left.build_empty_payload(client, left_config).map(Either::Left)
+            }
+            Either::Right(right_attr) => {
+                let right_config = PayloadConfig {
+                    parent_header: config.parent_header.clone(),
+                    extra_data: config.extra_data.clone(),
+                    attributes: right_attr,
+                };
+                self.right.build_empty_payload(client, right_config).map(Either::Right)
+            }
+        }
+    }
+}