Add permit flashtestations tx calls from builder

Author: avalonche

crates/op-rbuilder/src/builders/builder_tx.rs

@@ -55,6 +55,9 @@ pub enum BuilderTransactionError {
     /// Signature signing fails
     #[error("failed to sign transaction: {0}")]
     SigningError(secp256k1::Error),
+    /// Invalid contract data returned
+    #[error("invalid contract data returned {0}")]
+    InvalidContract(Address),
     /// Invalid tx errors during evm execution.
     #[error("invalid transaction error {0}")]
     InvalidTransactionError(Box<dyn core::error::Error + Send + Sync>),
@@ -98,16 +101,17 @@ impl BuilderTransactionError {
     }
 }
 
-pub trait BuilderTransactions<ExtraCtx: Debug + Default = ()>: Debug {
-    fn simulate_builder_txs<Extra: Debug + Default>(
+pub trait BuilderTransactions<ExtraCtx: Debug + Default = (), Extra: Debug + Default = ()> {
+    fn simulate_builder_txs(
         &self,
         state_provider: impl StateProvider + Clone,
         info: &mut ExecutionInfo<Extra>,
         ctx: &OpPayloadBuilderCtx<ExtraCtx>,
         db: &mut State<impl Database>,
+        top_of_block: bool,
     ) -> Result<Vec<BuilderTransactionCtx>, BuilderTransactionError>;
 
-    fn add_builder_txs<Extra: Debug + Default>(
+    fn add_builder_txs(
         &self,
         state_provider: impl StateProvider + Clone,
         info: &mut ExecutionInfo<Extra>,
@@ -122,8 +126,13 @@ pub trait BuilderTransactions<ExtraCtx: Debug + Default = ()>: Debug {
 
             let mut invalid: HashSet<Address> = HashSet::new();
 
-            let builder_txs =
-                self.simulate_builder_txs(state_provider, info, builder_ctx, evm.db_mut())?;
+            let builder_txs = self.simulate_builder_txs(
+                state_provider,
+                info,
+                builder_ctx,
+                evm.db_mut(),
+                top_of_block,
+            )?;
             for builder_tx in builder_txs.iter() {
                 if builder_tx.is_top_of_block != top_of_block {
                     // don't commit tx if the buidler tx is not being added in the intended
@@ -140,7 +149,7 @@ pub trait BuilderTransactions<ExtraCtx: Debug + Default = ()>: Debug {
                     .map_err(|err| BuilderTransactionError::EvmExecutionError(Box::new(err)))?;
 
                 if !result.is_success() {
-                    warn!(target: "payload_builder", tx_hash = ?builder_tx.signed_tx.tx_hash(), "builder tx reverted");
+                    warn!(target: "payload_builder", tx_hash = ?builder_tx.signed_tx.tx_hash(), result = ?result, "builder tx reverted");
                     invalid.insert(builder_tx.signed_tx.signer());
                     continue;
                 }
@@ -174,7 +183,7 @@ pub trait BuilderTransactions<ExtraCtx: Debug + Default = ()>: Debug {
         }
     }
 
-    fn simulate_builder_txs_state<Extra: Debug + Default>(
+    fn simulate_builder_txs_state(
         &self,
         state_provider: impl StateProvider + Clone,
         builder_txs: Vec<&BuilderTransactionCtx>,
@@ -204,16 +213,20 @@ pub trait BuilderTransactions<ExtraCtx: Debug + Default = ()>: Debug {
 }
 
 #[derive(Debug, Clone)]
-pub(super) struct BuilderTxBase {
+pub(super) struct BuilderTxBase<ExtraCtx = ()> {
     pub signer: Option<Signer>,
+    _marker: std::marker::PhantomData<ExtraCtx>,
 }
 
-impl BuilderTxBase {
+impl<ExtraCtx: Debug + Default> BuilderTxBase<ExtraCtx> {
     pub(super) fn new(signer: Option<Signer>) -> Self {
-        Self { signer }
+        Self {
+            signer,
+            _marker: std::marker::PhantomData,
+        }
     }
 
-    pub(super) fn simulate_builder_tx<ExtraCtx: Debug + Default>(
+    pub(super) fn simulate_builder_tx(
         &self,
         ctx: &OpPayloadBuilderCtx<ExtraCtx>,
         db: &mut State<impl Database>,
@@ -258,7 +271,7 @@ impl BuilderTxBase {
         std::cmp::max(zero_cost + nonzero_cost + 21_000, floor_gas)
     }
 
-    fn signed_builder_tx<ExtraCtx: Debug + Default>(
+    fn signed_builder_tx(
         &self,
         ctx: &OpPayloadBuilderCtx<ExtraCtx>,
         db: &mut State<impl Database>,

crates/op-rbuilder/src/builders/flashblocks/builder_tx.rs

@@ -23,7 +23,7 @@ use crate::{
         BuilderTransactionCtx, BuilderTransactionError, BuilderTransactions,
         builder_tx::{BuilderTxBase, get_nonce, log_exists},
         context::OpPayloadBuilderCtx,
-        flashblocks::payload::FlashblocksExtraCtx,
+        flashblocks::payload::{FlashblocksExecutionInfo, FlashblocksExtraCtx},
     },
     flashtestations::builder_tx::FlashtestationsBuilderTx,
     primitives::reth::ExecutionInfo,
@@ -64,14 +64,17 @@ pub(super) enum FlashblockNumberError {
 // This will be the end of block transaction of a regular block
 #[derive(Debug, Clone)]
 pub(super) struct FlashblocksBuilderTx {
-    pub base_builder_tx: BuilderTxBase,
-    pub flashtestations_builder_tx: Option<FlashtestationsBuilderTx>,
+    pub base_builder_tx: BuilderTxBase<FlashblocksExtraCtx>,
+    pub flashtestations_builder_tx:
+        Option<FlashtestationsBuilderTx<FlashblocksExtraCtx, FlashblocksExecutionInfo>>,
 }
 
 impl FlashblocksBuilderTx {
     pub(super) fn new(
         signer: Option<Signer>,
-        flashtestations_builder_tx: Option<FlashtestationsBuilderTx>,
+        flashtestations_builder_tx: Option<
+            FlashtestationsBuilderTx<FlashblocksExtraCtx, FlashblocksExecutionInfo>,
+        >,
     ) -> Self {
         let base_builder_tx = BuilderTxBase::new(signer);
         Self {
@@ -81,13 +84,14 @@ impl FlashblocksBuilderTx {
     }
 }
 
-impl BuilderTransactions<FlashblocksExtraCtx> for FlashblocksBuilderTx {
-    fn simulate_builder_txs<Extra: Debug + Default>(
+impl BuilderTransactions<FlashblocksExtraCtx, FlashblocksExecutionInfo> for FlashblocksBuilderTx {
+    fn simulate_builder_txs(
         &self,
         state_provider: impl StateProvider + Clone,
-        info: &mut ExecutionInfo<Extra>,
+        info: &mut ExecutionInfo<FlashblocksExecutionInfo>,
         ctx: &OpPayloadBuilderCtx<FlashblocksExtraCtx>,
         db: &mut State<impl Database>,
+        top_of_block: bool,
     ) -> Result<Vec<BuilderTransactionCtx>, BuilderTransactionError> {
         let mut builder_txs = Vec::<BuilderTransactionCtx>::new();
 
@@ -102,19 +106,30 @@ impl BuilderTransactions<FlashblocksExtraCtx> for FlashblocksBuilderTx {
 
             if let Some(flashtestations_builder_tx) = &self.flashtestations_builder_tx {
                 // We only include flashtestations txs in the last flashblock
-                let mut simulation_state = self.simulate_builder_txs_state::<FlashblocksExtraCtx>(
+                let mut simulation_state = self.simulate_builder_txs_state(
                     state_provider.clone(),
-                    base_tx.iter().collect(),
+                    base_tx
+                        .iter()
+                        .filter(|tx| tx.is_top_of_block == top_of_block)
+                        .collect(),
                     ctx,
                     db,
                 )?;
-                let flashtestations_builder_txs = flashtestations_builder_tx.simulate_builder_txs(
+                // We only include flashtestations txs in the last flashblock
+                match flashtestations_builder_tx.simulate_builder_txs(
                     state_provider,
                     info,
                     ctx,
                     &mut simulation_state,
-                )?;
-                builder_txs.extend(flashtestations_builder_txs);
+                    top_of_block,
+                ) {
+                    Ok(flashtestations_builder_txs) => {
+                        builder_txs.extend(flashtestations_builder_txs)
+                    }
+                    Err(e) => {
+                        warn!(target: "flashtestations", error = ?e, "failed to add flashtestations builder tx")
+                    }
+                }
             }
         }
         Ok(builder_txs)
@@ -126,15 +141,18 @@ impl BuilderTransactions<FlashblocksExtraCtx> for FlashblocksBuilderTx {
 pub(super) struct FlashblocksNumberBuilderTx {
     pub signer: Option<Signer>,
     pub flashblock_number_address: Address,
-    pub base_builder_tx: BuilderTxBase,
-    pub flashtestations_builder_tx: Option<FlashtestationsBuilderTx>,
+    pub base_builder_tx: BuilderTxBase<FlashblocksExtraCtx>,
+    pub flashtestations_builder_tx:
+        Option<FlashtestationsBuilderTx<FlashblocksExtraCtx, FlashblocksExecutionInfo>>,
 }
 
 impl FlashblocksNumberBuilderTx {
     pub(super) fn new(
         signer: Option<Signer>,
         flashblock_number_address: Address,
-        flashtestations_builder_tx: Option<FlashtestationsBuilderTx>,
+        flashtestations_builder_tx: Option<
+            FlashtestationsBuilderTx<FlashblocksExtraCtx, FlashblocksExecutionInfo>,
+        >,
     ) -> Self {
         let base_builder_tx = BuilderTxBase::new(signer);
         Self {
@@ -213,13 +231,16 @@ impl FlashblocksNumberBuilderTx {
     }
 }
 
-impl BuilderTransactions<FlashblocksExtraCtx> for FlashblocksNumberBuilderTx {
-    fn simulate_builder_txs<Extra: Debug + Default>(
+impl BuilderTransactions<FlashblocksExtraCtx, FlashblocksExecutionInfo>
+    for FlashblocksNumberBuilderTx
+{
+    fn simulate_builder_txs(
         &self,
         state_provider: impl StateProvider + Clone,
-        info: &mut ExecutionInfo<Extra>,
+        info: &mut ExecutionInfo<FlashblocksExecutionInfo>,
         ctx: &OpPayloadBuilderCtx<FlashblocksExtraCtx>,
         db: &mut State<impl Database>,
+        top_of_block: bool,
     ) -> Result<Vec<BuilderTransactionCtx>, BuilderTransactionError> {
         let mut builder_txs = Vec::<BuilderTransactionCtx>::new();
         let state = StateProviderDatabase::new(state_provider.clone());
@@ -280,20 +301,30 @@ impl BuilderTransactions<FlashblocksExtraCtx> for FlashblocksNumberBuilderTx {
         if ctx.is_last_flashblock() {
             if let Some(flashtestations_builder_tx) = &self.flashtestations_builder_tx {
                 let flashblocks_builder_txs = builder_txs.clone();
-                let mut simulation_state = self.simulate_builder_txs_state::<FlashblocksExtraCtx>(
+                let mut simulation_state = self.simulate_builder_txs_state(
                     state_provider.clone(),
-                    flashblocks_builder_txs.iter().collect(),
+                    flashblocks_builder_txs
+                        .iter()
+                        .filter(|tx| tx.is_top_of_block == top_of_block)
+                        .collect(),
                     ctx,
                     db,
                 )?;
                 // We only include flashtestations txs in the last flashblock
-                let flashtestations_builder_txs = flashtestations_builder_tx.simulate_builder_txs(
+                match flashtestations_builder_tx.simulate_builder_txs(
                     state_provider,
                     info,
                     ctx,
                     &mut simulation_state,
-                )?;
-                builder_txs.extend(flashtestations_builder_txs);
+                    top_of_block,
+                ) {
+                    Ok(flashtestations_builder_txs) => {
+                        builder_txs.extend(flashtestations_builder_txs)
+                    }
+                    Err(e) => {
+                        warn!(target: "flashtestations", error = ?e, "failed to add flashtestations builder tx")
+                    }
+                }
             }
         }
 

crates/op-rbuilder/src/builders/flashblocks/payload.rs

@@ -67,13 +67,13 @@ type NextBestFlashblocksTxs<Pool> = BestFlashblocksTxs<
     >,
 >;
 
-#[derive(Debug, Default)]
-struct ExtraExecutionInfo {
+#[derive(Debug, Default, Clone)]
+pub(super) struct FlashblocksExecutionInfo {
     /// Index of the last consumed flashblock
     pub last_flashblock_index: usize,
 }
 
-#[derive(Debug, Default)]
+#[derive(Debug, Default, Clone)]
 pub struct FlashblocksExtraCtx {
     /// Current flashblock index
     flashblock_index: u64,
@@ -211,7 +211,7 @@ impl<Pool, Client, BuilderTx> OpPayloadBuilder<Pool, Client, BuilderTx>
 where
     Pool: PoolBounds,
     Client: ClientBounds,
-    BuilderTx: BuilderTransactions<FlashblocksExtraCtx> + Send + Sync,
+    BuilderTx: BuilderTransactions<FlashblocksExtraCtx, FlashblocksExecutionInfo> + Send + Sync,
 {
     /// Constructs an Optimism payload from the transactions sent via the
     /// Payload attributes by the sequencer. If the `no_tx_pool` argument is passed in
@@ -542,7 +542,7 @@ where
     >(
         &self,
         ctx: &mut OpPayloadBuilderCtx<FlashblocksExtraCtx>,
-        info: &mut ExecutionInfo<ExtraExecutionInfo>,
+        info: &mut ExecutionInfo<FlashblocksExecutionInfo>,
         state: &mut State<DB>,
         state_provider: impl reth::providers::StateProvider + Clone,
         best_txs: &mut NextBestFlashblocksTxs<Pool>,
@@ -756,7 +756,7 @@ where
     fn record_flashblocks_metrics(
         &self,
         ctx: &OpPayloadBuilderCtx<FlashblocksExtraCtx>,
-        info: &ExecutionInfo<ExtraExecutionInfo>,
+        info: &ExecutionInfo<FlashblocksExecutionInfo>,
         flashblocks_per_block: u64,
         span: &tracing::Span,
         message: &str,
@@ -872,7 +872,8 @@ impl<Pool, Client, BuilderTx> PayloadBuilder for OpPayloadBuilder<Pool, Client,
 where
     Pool: PoolBounds,
     Client: ClientBounds,
-    BuilderTx: BuilderTransactions<FlashblocksExtraCtx> + Clone + Send + Sync,
+    BuilderTx:
+        BuilderTransactions<FlashblocksExtraCtx, FlashblocksExecutionInfo> + Clone + Send + Sync,
 {
     type Attributes = OpPayloadBuilderAttributes<OpTransactionSigned>;
     type BuiltPayload = OpBuiltPayload;
@@ -896,7 +897,7 @@ struct FlashblocksMetadata {
 fn execute_pre_steps<DB, ExtraCtx>(
     state: &mut State<DB>,
     ctx: &OpPayloadBuilderCtx<ExtraCtx>,
-) -> Result<ExecutionInfo<ExtraExecutionInfo>, PayloadBuilderError>
+) -> Result<ExecutionInfo<FlashblocksExecutionInfo>, PayloadBuilderError>
 where
     DB: Database<Error = ProviderError> + std::fmt::Debug,
     ExtraCtx: std::fmt::Debug + Default,
@@ -916,7 +917,7 @@ where
 fn build_block<DB, P, ExtraCtx>(
     state: &mut State<DB>,
     ctx: &OpPayloadBuilderCtx<ExtraCtx>,
-    info: &mut ExecutionInfo<ExtraExecutionInfo>,
+    info: &mut ExecutionInfo<FlashblocksExecutionInfo>,
     calculate_state_root: bool,
 ) -> Result<(OpBuiltPayload, FlashblocksPayloadV1), PayloadBuilderError>
 where

crates/op-rbuilder/src/builders/flashblocks/service.rs

@@ -5,7 +5,7 @@ use crate::{
         builder_tx::BuilderTransactions,
         flashblocks::{
             builder_tx::{FlashblocksBuilderTx, FlashblocksNumberBuilderTx},
-            payload::FlashblocksExtraCtx,
+            payload::{FlashblocksExecutionInfo, FlashblocksExtraCtx},
         },
         generator::BlockPayloadJobGenerator,
     },
@@ -32,7 +32,12 @@ impl FlashblocksServiceBuilder {
     where
         Node: NodeBounds,
         Pool: PoolBounds,
-        BuilderTx: BuilderTransactions<FlashblocksExtraCtx> + Unpin + Clone + Send + Sync + 'static,
+        BuilderTx: BuilderTransactions<FlashblocksExtraCtx, FlashblocksExecutionInfo>
+            + Unpin
+            + Clone
+            + Send
+            + Sync
+            + 'static,
     {
         let once_lock = Arc::new(std::sync::OnceLock::new());
 
@@ -84,8 +89,12 @@ where
         _: OpEvmConfig,
     ) -> eyre::Result<PayloadBuilderHandle<<Node::Types as NodeTypes>::Payload>> {
         let signer = self.0.builder_signer;
-        let flashtestations_builder_tx = if self.0.flashtestations_config.flashtestations_enabled {
-            match bootstrap_flashtestations(self.0.flashtestations_config.clone(), ctx).await {
+        let flashtestations_builder_tx = if let Some(builder_key) = signer
+            && self.0.flashtestations_config.flashtestations_enabled
+        {
+            match bootstrap_flashtestations(self.0.flashtestations_config.clone(), builder_key, ctx)
+                .await
+            {
                 Ok(builder_tx) => Some(builder_tx),
                 Err(e) => {
                     tracing::warn!(error = %e, "Failed to bootstrap flashtestations, builder will not include flashtestations txs");