Skip to content

Add permit flashtestations tx calls from builder #285

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: add-flashtestation-integration-tests
Choose a base branch
from
Open

Add permit flashtestations tx calls from builder #285

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
526d171
Add permit flashtestations tx calls from builder
avalonche Oct 3, 2025
75e520c
move simumlation calls to builder tx
avalonche Oct 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
167 changes: 141 additions & 26 deletions crates/op-rbuilder/src/builders/builder_tx.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,29 +1,42 @@
use alloy_consensus::TxEip1559;
use alloy_consensus::{Transaction, TxEip1559};
use alloy_eips::{Encodable2718, eip7623::TOTAL_COST_FLOOR_PER_TOKEN};
use alloy_evm::Database;
use alloy_op_evm::OpEvm;
use alloy_primitives::{
Address, B256, Log, TxKind, U256,
map::foldhash::{HashSet, HashSetExt},
Address, B256, Bytes, TxKind, U256,
map::foldhash::{HashMap, HashSet, HashSetExt},
};
use core::fmt::Debug;
use op_alloy_consensus::OpTypedTransaction;
use op_revm::OpTransactionError;
use reth_evm::{ConfigureEvm, Evm, eth::receipt_builder::ReceiptBuilderCtx};
use op_revm::{OpHaltReason, OpTransactionError};
use reth_evm::{
ConfigureEvm, Evm, EvmError, eth::receipt_builder::ReceiptBuilderCtx,
precompiles::PrecompilesMap,
};
use reth_node_api::PayloadBuilderError;
use reth_optimism_primitives::OpTransactionSigned;
use reth_primitives::Recovered;
use reth_provider::{ProviderError, StateProvider};
use reth_revm::{State, database::StateProviderDatabase};
use revm::{
DatabaseCommit,
context::result::{EVMError, ResultAndState},
context::result::{EVMError, ExecutionResult, ResultAndState},
inspector::NoOpInspector,
state::Account,
};
use tracing::warn;

use crate::{
builders::context::OpPayloadBuilderCtx, primitives::reth::ExecutionInfo, tx_signer::Signer,
};

#[derive(Debug, Default)]
pub struct SimulationSuccessResult {
pub gas_used: u64,
pub output: Bytes,
pub state_changes: HashMap<Address, Account>,
}

#[derive(Debug, Clone)]
pub struct BuilderTransactionCtx {
pub gas_used: u64,
Expand All @@ -46,6 +59,14 @@ impl BuilderTransactionCtx {
}
}

#[derive(Debug, thiserror::Error)]
pub enum InvalidContractDataError {
#[error("did not find expected log {0:?} in emitted logs")]
InvalidLogs(B256),
#[error("could not decode output from contract call")]
OutputAbiDecodeError,
}

/// Possible error variants during construction of builder txs.
#[derive(Debug, thiserror::Error)]
pub enum BuilderTransactionError {
Expand All @@ -55,6 +76,15 @@ pub enum BuilderTransactionError {
/// Signature signing fails
#[error("failed to sign transaction: {0}")]
SigningError(secp256k1::Error),
/// Invalid contract errors indicating the contract is incorrect
#[error("contract {0} may be incorrect, invalid contract data: {1}")]
InvalidContract(Address, InvalidContractDataError),
/// Transaction halted execution
#[error("transaction halted {0:?}")]
TransactionHalted(OpHaltReason),
/// Transaction reverted
#[error("transaction reverted {0}")]
TransactionReverted(Box<dyn core::error::Error + Send + Sync>),
/// Invalid tx errors during evm execution.
#[error("invalid transaction error {0}")]
InvalidTransactionError(Box<dyn core::error::Error + Send + Sync>),
Expand Down Expand Up @@ -90,24 +120,26 @@ impl From<BuilderTransactionError> for PayloadBuilderError {
}

impl BuilderTransactionError {
pub fn other<E>(error: E) -> Self
where
E: core::error::Error + Send + Sync + 'static,
{
pub fn other(error: impl core::error::Error + Send + Sync + 'static) -> Self {
BuilderTransactionError::Other(Box::new(error))
}

pub fn msg(msg: impl core::fmt::Display) -> Self {
Self::Other(msg.to_string().into())
}
}

pub trait BuilderTransactions<ExtraCtx: Debug + Default = ()>: Debug {
fn simulate_builder_txs<Extra: Debug + Default>(
pub trait BuilderTransactions<ExtraCtx: Debug + Default = (), Extra: Debug + Default = ()> {
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it starts to look scary :)

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we can move Extra fields to ExtraCtx :)

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>,
Expand All @@ -122,8 +154,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
Expand All @@ -140,7 +177,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;
}
Expand Down Expand Up @@ -174,7 +211,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>,
Expand All @@ -201,19 +238,101 @@ pub trait BuilderTransactions<ExtraCtx: Debug + Default = ()>: Debug {

Ok(simulation_state)
}

fn sign_tx(
&self,
to: Address,
from: Signer,
gas_used: Option<u64>,
calldata: Bytes,
ctx: &OpPayloadBuilderCtx<ExtraCtx>,
db: &mut State<impl Database>,
) -> Result<Recovered<OpTransactionSigned>, BuilderTransactionError> {
let nonce = get_nonce(db, from.address)?;
// Create the EIP-1559 transaction
let tx = OpTypedTransaction::Eip1559(TxEip1559 {
chain_id: ctx.chain_id(),
nonce,
// Due to EIP-150, 63/64 of available gas is forwarded to external calls so need to add a buffer
gas_limit: gas_used
.map(|gas| gas * 64 / 63)
.unwrap_or(ctx.block_gas_limit()),
max_fee_per_gas: ctx.base_fee().into(),
to: TxKind::Call(to),
input: calldata,
..Default::default()
});
Ok(from.sign_tx(tx)?)
}

fn simulate_call(
&self,
signed_tx: Recovered<OpTransactionSigned>,
expected_topic: Option<B256>,
revert_handler: impl FnOnce(Bytes) -> BuilderTransactionError,
evm: &mut OpEvm<
&mut State<StateProviderDatabase<impl StateProvider>>,
NoOpInspector,
PrecompilesMap,
>,
) -> Result<SimulationSuccessResult, BuilderTransactionError> {
let ResultAndState { result, state } = match evm.transact(&signed_tx) {
Ok(res) => res,
Err(err) => {
if err.is_invalid_tx_err() {
return Err(BuilderTransactionError::InvalidTransactionError(Box::new(
err,
)));
} else {
return Err(BuilderTransactionError::EvmExecutionError(Box::new(err)));
}
}
};

match result {
ExecutionResult::Success {
logs,
gas_used,
output,
..
} => {
if let Some(topic) = expected_topic
&& !logs.iter().any(|log| log.topics().first() == Some(&topic))
{
return Err(BuilderTransactionError::InvalidContract(
signed_tx.to().unwrap_or_default(),
InvalidContractDataError::InvalidLogs(topic),
));
}
Ok(SimulationSuccessResult {
gas_used,
output: output.into_data(),
state_changes: state,
})
}
ExecutionResult::Revert { output, .. } => Err(revert_handler(output)),
ExecutionResult::Halt { reason, .. } => Err(BuilderTransactionError::other(
BuilderTransactionError::TransactionHalted(reason),
)),
}
}
}

#[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>,
Expand Down Expand Up @@ -258,7 +377,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>,
Expand Down Expand Up @@ -309,7 +428,3 @@ pub fn get_balance(
.map(|acc| acc.account_info().unwrap_or_default().balance)
.map_err(|_| BuilderTransactionError::AccountLoadFailed(address))
}

pub fn log_exists(logs: &[Log], topic: &B256) -> bool {
logs.iter().any(|log| log.topics().first() == Some(topic))
}
Loading
Loading