revm_handler/

post_execution.rs

use crate::FrameResult;
use context::journaled_state::account::JournaledAccountTr;
use context_interface::{
    journaled_state::JournalTr,
    result::{ExecutionResult, HaltReason, HaltReasonTr, ResultGas},
    Block, Cfg, ContextTr, Database, LocalContextTr, Transaction,
};
use interpreter::{Gas, InitialAndFloorGas, SuccessOrHalt};
use primitives::{hardfork::SpecId, U256};

/// Builds a [`ResultGas`] from the execution [`Gas`] struct and [`InitialAndFloorGas`].
pub fn build_result_gas(
    _is_halt: bool,
    gas: &Gas,
    init_and_floor_gas: InitialAndFloorGas,
) -> ResultGas {
    // `state_gas_spent` is tracked as i64 to allow a child frame's count to go
    // negative on 0→x→0 restoration; at the top level, post-reconciliation it
    // is expected to be >= 0 and is clamped defensively before combining with
    // intrinsic state gas.
    //
    // Per the spec, tx_state_gas = intrinsic_state_gas + execution_state_gas,
    // then reduced by the EIP-7702 per-authorization state-gas refund (which
    // was also added back to the reservoir budget at tx start).
    let state_gas = gas
        .state_gas_spent()
        .saturating_add_unsigned(init_and_floor_gas.initial_state_gas)
        .max(0) as u64;
    let state_gas = state_gas.saturating_sub(init_and_floor_gas.state_refund);

    ResultGas::default()
        .with_total_gas_spent(
            gas.limit()
                .saturating_sub(gas.remaining())
                .saturating_sub(gas.reservoir()),
        )
        .with_refunded(gas.refunded() as u64)
        .with_floor_gas(init_and_floor_gas.floor_gas())
        .with_state_gas_spent(state_gas)
}

/// Ensures minimum gas floor is spent according to EIP-7623.
///
/// Per EIP-8037, gas used before refund is `tx.gas - gas_left - state_gas_reservoir`.
/// The floor applies to this combined total, not just regular gas.
pub const fn eip7623_check_gas_floor(gas: &mut Gas, init_and_floor_gas: InitialAndFloorGas) {
    // EIP-7623: Increase calldata cost
    // EIP-8037: tx_gas_used_before_refund = tx.gas - gas_left - reservoir
    // The floor must apply to this combined value, not just (limit - remaining).
    let gas_used_before_refund = gas.total_gas_spent().saturating_sub(gas.reservoir());
    let gas_used_after_refund = gas_used_before_refund.saturating_sub(gas.refunded() as u64);
    if gas_used_after_refund < init_and_floor_gas.floor_gas() {
        // Match execution-specs: when the floor wins, the unused state gas
        // (reservoir) is absorbed into the floor cost rather than reimbursed
        // separately. Zeroing it keeps `reimburse_caller`'s
        // `remaining + reservoir + refunded` sum equal to `limit - floor`.
        gas.set_spent(init_and_floor_gas.floor_gas());
        gas.set_reservoir(0);
        gas.set_refund(0);
    }
}

/// Calculates and applies gas refunds based on the specification.
pub fn refund(spec: SpecId, gas: &mut Gas, eip7702_refund: i64) {
    gas.record_refund(eip7702_refund);
    // Calculate gas refund for transaction.
    // If spec is set to london, it will decrease the maximum refund amount to 5th part of
    // gas spend. (Before london it was 2th part of gas spend)
    gas.set_final_refund(spec.is_enabled_in(SpecId::LONDON));
}

/// Reimburses the caller for unused gas.
#[inline]
pub fn reimburse_caller<CTX: ContextTr>(
    context: &mut CTX,
    gas: &Gas,
    additional_refund: U256,
) -> Result<(), <CTX::Db as Database>::Error> {
    // If fee charge was disabled (e.g. eth_call simulations), no gas was
    // deducted from the caller upfront so there is nothing to reimburse.
    if context.cfg().is_fee_charge_disabled() {
        return Ok(());
    }
    let basefee = context.block().basefee() as u128;
    let caller = context.tx().caller();
    let effective_gas_price = context.tx().effective_gas_price(basefee);

    // Return balance of not spent gas.
    // Include reservoir gas (EIP-8037) which is also unused and must be reimbursed.
    let reimbursable = gas.remaining() + gas.reservoir() + gas.refunded() as u64;
    context
        .journal_mut()
        .load_account_mut(caller)?
        .incr_balance(
            U256::from(effective_gas_price.saturating_mul(reimbursable as u128))
                + additional_refund,
        );

    Ok(())
}

/// Rewards the beneficiary with transaction fees.
#[inline]
pub fn reward_beneficiary<CTX: ContextTr>(
    context: &mut CTX,
    gas: &Gas,
) -> Result<(), <CTX::Db as Database>::Error> {
    // If fee charge was disabled (e.g. eth_call simulations), the caller was
    // never charged for gas so there are no fees to transfer to the beneficiary.
    if context.cfg().is_fee_charge_disabled() {
        return Ok(());
    }
    let (block, tx, cfg, journal, _, _) = context.all_mut();
    let basefee = block.basefee() as u128;
    let effective_gas_price = tx.effective_gas_price(basefee);

    // Transfer fee to coinbase/beneficiary.
    // EIP-1559 discard basefee for coinbase transfer. Basefee amount of gas is discarded.
    let coinbase_gas_price = if cfg.spec().into().is_enabled_in(SpecId::LONDON) {
        effective_gas_price.saturating_sub(basefee)
    } else {
        effective_gas_price
    };

    // Reward beneficiary.
    // Exclude reservoir gas (EIP-8037) from the used gas — reservoir is unused and reimbursed.
    let effective_used = gas.used().saturating_sub(gas.reservoir());
    journal
        .load_account_mut(block.beneficiary())?
        .incr_balance(U256::from(coinbase_gas_price * effective_used as u128));

    Ok(())
}

/// Calculate last gas spent and transform internal reason to external.
///
/// TODO make Journal FinalOutput more generic.
pub fn output<CTX: ContextTr<Journal: JournalTr>, HALTREASON: HaltReasonTr>(
    context: &mut CTX,
    // TODO, make this more generic and nice.
    // FrameResult should be a generic that returns gas and interpreter result.
    result: FrameResult,
    result_gas: ResultGas,
) -> ExecutionResult<HALTREASON> {
    let output = result.output();
    let instruction_result = result.into_interpreter_result();

    // take logs from journal.
    let logs = context.journal_mut().take_logs();

    match SuccessOrHalt::<HALTREASON>::from(instruction_result.result) {
        SuccessOrHalt::Success(reason) => ExecutionResult::Success {
            reason,
            gas: result_gas,
            logs,
            output,
        },
        SuccessOrHalt::Revert => ExecutionResult::Revert {
            gas: result_gas,
            logs,
            output: output.into_data(),
        },
        SuccessOrHalt::Halt(reason) => {
            // Bubble up precompile errors from context when available
            if matches!(
                instruction_result.result,
                interpreter::InstructionResult::PrecompileError
            ) {
                if let Some(message) = context.local_mut().take_precompile_error_context() {
                    return ExecutionResult::Halt {
                        reason: HALTREASON::from(HaltReason::PrecompileErrorWithContext(message)),
                        gas: result_gas,
                        logs,
                    };
                }
            }
            ExecutionResult::Halt {
                reason,
                gas: result_gas,
                logs,
            }
        }
        // Only two internal return flags.
        flag @ (SuccessOrHalt::FatalExternalError | SuccessOrHalt::Internal(_)) => {
            panic!(
                "Encountered unexpected internal return flag: {flag:?} with instruction result: {instruction_result:?}"
            )
        }
    }
}