pub struct TxProcessor {
pub poster_fee: U256,
pub poster_gas: u64,
pub compute_hold_gas: u64,
pub delayed_inbox: bool,
pub top_tx_type: Option<u8>,
pub current_retryable: Option<B256>,
pub current_refund_to: Option<Address>,
pub scheduled_txs: Vec<Vec<u8>>,
pub programs_depth: HashMap<Address, usize>,
}Expand description
Per-transaction state for processing Arbitrum transactions.
Created and freed for every L2 transaction. Tracks ArbOS state that influences transaction processing. In reth, this is used by the block executor’s per-transaction logic.
Fields§
§poster_fee: U256The poster’s fee contribution (L1 calldata cost expressed in ETH).
poster_gas: u64Gas reserved for L1 posting costs.
compute_hold_gas: u64Gas temporarily held to prevent compute from exceeding the gas limit.
delayed_inbox: boolWhether this tx was submitted through the delayed inbox.
top_tx_type: Option<u8>The top-level tx type byte, set in StartTxHook.
current_retryable: Option<B256>The current retryable ticket being redeemed (if any).
current_refund_to: Option<Address>The refund-to address for retryable redeems.
scheduled_txs: Vec<Vec<u8>>Scheduled transactions (e.g., retryable auto-redeems).
programs_depth: HashMap<Address, usize>Count of open Stylus program contexts per contract address. Used to detect reentrance.
Implementations§
Source§impl TxProcessor
impl TxProcessor
Sourcepub fn new(coinbase: Address) -> Self
pub fn new(coinbase: Address) -> Self
Create a new TxProcessor. The delayed_inbox flag indicates whether the
coinbase differs from the batch poster address.
Sourcepub fn nonrefundable_gas(&self) -> u64
pub fn nonrefundable_gas(&self) -> u64
Gas that should not be refundable (the poster’s L1 cost component).
Sourcepub fn held_gas(&self) -> u64
pub fn held_gas(&self) -> u64
Gas held back to limit computation; must be refunded after computation completes.
Sourcepub fn drop_tip(&self, arbos_version: u64) -> bool
pub fn drop_tip(&self, arbos_version: u64) -> bool
Whether the tip should be dropped (version-gated behavior).
Sourcepub fn get_paid_gas_price(
&self,
arbos_version: u64,
base_fee: U256,
gas_price: U256,
) -> U256
pub fn get_paid_gas_price( &self, arbos_version: u64, base_fee: U256, gas_price: U256, ) -> U256
Get the effective gas price paid.
Sourcepub fn gas_price_op(
&self,
arbos_version: u64,
base_fee: U256,
gas_price: U256,
) -> U256
pub fn gas_price_op( &self, arbos_version: u64, base_fee: U256, gas_price: U256, ) -> U256
The GASPRICE opcode return value.
Sourcepub fn fill_receipt_gas_used_for_l1(&self) -> u64
pub fn fill_receipt_gas_used_for_l1(&self) -> u64
Fill receipt info with the poster gas used for L1.
Sourcepub fn push_program(&mut self, addr: Address)
pub fn push_program(&mut self, addr: Address)
Record entering a Stylus program context for a contract address.
Sourcepub fn pop_program(&mut self, addr: Address)
pub fn pop_program(&mut self, addr: Address)
Record leaving a Stylus program context for a contract address.
Sourcepub fn is_reentrant(&self, addr: &Address) -> bool
pub fn is_reentrant(&self, addr: &Address) -> bool
Whether the given address has a reentrant Stylus call.
Sourcepub fn reverted_tx_hook(
&self,
tx_hash: Option<B256>,
pre_recorded_gas: Option<u64>,
is_filtered: bool,
) -> RevertedTxAction
pub fn reverted_tx_hook( &self, tx_hash: Option<B256>, pre_recorded_gas: Option<u64>, is_filtered: bool, ) -> RevertedTxAction
Check for pre-recorded reverted or filtered transactions.
Returns an action describing how the caller should handle this tx before normal execution. The caller should:
None: proceed with normal executionPreRecordedRevert: increment sender nonce, deductgas_to_consumefrom gas remaining, and return execution-reverted errorFilteredTx: increment sender nonce, consume ALL remaining gas, and return filtered-tx error
Sourcepub fn set_tx_type(&mut self, tx_type: u8)
pub fn set_tx_type(&mut self, tx_type: u8)
Set the top-level transaction type for this tx.
Sourcepub fn prepare_retry_tx(&mut self, ticket_id: B256, refund_to: Address)
pub fn prepare_retry_tx(&mut self, ticket_id: B256, refund_to: Address)
Set up state for processing a retry transaction.
The caller should:
- Verify the retryable exists (via
RetryableState::open_retryable) - Transfer call value from escrow to
from - Mint prepaid gas (
base_fee * gas) tofrom - Continue to gas charging and EVM execution
Sourcepub fn gas_charging_hook(
&mut self,
gas_remaining: &mut u64,
intrinsic_gas: u64,
params: &GasChargingParams,
) -> Result<(), GasChargingError>
pub fn gas_charging_hook( &mut self, gas_remaining: &mut u64, intrinsic_gas: u64, params: &GasChargingParams, ) -> Result<(), GasChargingError>
Compute poster gas and held compute gas.
Charges poster data cost from the remaining gas and holds excess
compute gas to enforce per-block/per-tx limits. After calling,
poster_gas, poster_fee, and compute_hold_gas are set.
Sourcepub fn compute_end_tx_fee_distribution(
&self,
params: &EndTxNormalParams,
) -> EndTxFeeDistribution
pub fn compute_end_tx_fee_distribution( &self, params: &EndTxNormalParams, ) -> EndTxFeeDistribution
Compute fee distribution for a normal (non-retryable) transaction.
Returns the amounts to mint to each fee account and the gas to add to the backlog. The caller executes the balance operations.
Sourcepub fn end_tx_retryable<F>(
&self,
params: &EndTxRetryableParams,
burn_fn: impl FnMut(Address, U256),
transfer_fn: F,
) -> EndTxRetryableResult
pub fn end_tx_retryable<F>( &self, params: &EndTxRetryableParams, burn_fn: impl FnMut(Address, U256), transfer_fn: F, ) -> EndTxRetryableResult
Process end-of-tx for a retryable redemption.
Handles undoing geth’s gas refund, distributing refunds between the refund-to address and the sender, and determining whether to delete the retryable or return value to escrow.
Trait Implementations§
Source§impl Debug for TxProcessor
impl Debug for TxProcessor
Auto Trait Implementations§
impl Freeze for TxProcessor
impl RefUnwindSafe for TxProcessor
impl Send for TxProcessor
impl Sync for TxProcessor
impl Unpin for TxProcessor
impl UnwindSafe for TxProcessor
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
§impl<T> Conv for T
impl<T> Conv for T
§impl<T> FmtForward for T
impl<T> FmtForward for T
§fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
self to use its Binary implementation when Debug-formatted.§fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
self to use its Display implementation when
Debug-formatted.§fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
self to use its LowerExp implementation when
Debug-formatted.§fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
self to use its LowerHex implementation when
Debug-formatted.§fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
self to use its Octal implementation when Debug-formatted.§fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
self to use its Pointer implementation when
Debug-formatted.§fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
self to use its UpperExp implementation when
Debug-formatted.§fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
self to use its UpperHex implementation when
Debug-formatted.§fn fmt_list(self) -> FmtList<Self>where
&'a Self: for<'a> IntoIterator,
fn fmt_list(self) -> FmtList<Self>where
&'a Self: for<'a> IntoIterator,
§impl<TxEnv, T> FromRecoveredTx<&T> for TxEnvwhere
TxEnv: FromRecoveredTx<T>,
impl<TxEnv, T> FromRecoveredTx<&T> for TxEnvwhere
TxEnv: FromRecoveredTx<T>,
§fn from_recovered_tx(tx: &&T, sender: Address) -> TxEnv
fn from_recovered_tx(tx: &&T, sender: Address) -> TxEnv
TxEnv] from a transaction and a sender address.§impl<TxEnv, T> FromTxWithEncoded<&T> for TxEnvwhere
TxEnv: FromTxWithEncoded<T>,
impl<TxEnv, T> FromTxWithEncoded<&T> for TxEnvwhere
TxEnv: FromTxWithEncoded<T>,
§fn from_encoded_tx(tx: &&T, sender: Address, encoded: Bytes) -> TxEnv
fn from_encoded_tx(tx: &&T, sender: Address, encoded: Bytes) -> TxEnv
TxEnv] from a transaction, its sender, and encoded transaction bytes.§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read more§impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere
T: ?Sized,
§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
self and passes that borrow into the pipe function. Read more§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
self and passes that borrow into the pipe function. Read more§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R,
) -> R
fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
self, then passes self.as_ref() into the pipe function.§fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
self, then passes self.as_mut() into the pipe
function.§fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
self, then passes self.deref() into the pipe function.§impl<T> Pointable for T
impl<T> Pointable for T
§impl<T> Tap for T
impl<T> Tap for T
§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
Borrow<B> of a value. Read more§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
BorrowMut<B> of a value. Read more§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
AsRef<R> view of a value. Read more§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
AsMut<R> view of a value. Read more§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
Deref::Target of a value. Read more§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
Deref::Target of a value. Read more§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
.tap() only in debug builds, and is erased in release builds.§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
.tap_mut() only in debug builds, and is erased in release
builds.§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
.tap_borrow() only in debug builds, and is erased in release
builds.§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
.tap_borrow_mut() only in debug builds, and is erased in release
builds.§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
.tap_ref() only in debug builds, and is erased in release
builds.§fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
.tap_ref_mut() only in debug builds, and is erased in release
builds.§fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
.tap_deref() only in debug builds, and is erased in release
builds.