Enum SimError 

pub enum SimError {
    Revert(Box<SimulationError>),
    Halt {
        reason: String,
        gas_used: u64,
    },
    Other(SimHostError),
}

Error returned by simulation entry points.

Distinguishes the three outcomes a caller must branch on: a transaction-level Revert (with a decoded reason), an EVM Halt (e.g. out of gas), and a host-side Other failure (RPC, database, ABI encoding).

Note that when a revert decodes to RevertReason::Panic, panic codes exceeding u64::MAX are dropped to None and so surface as RevertReason::Unknown rather than Panic. This is benign: real compiler-emitted panic codes are single-byte constants.

Variants

Revert(Box<SimulationError>)

The transaction reverted; carries the decoded revert.

Halt

The EVM halted without returning revert data (e.g. out of gas, stack overflow). reason is the debug rendering of revm’s halt reason.

Fields

reason: String

Debug rendering of the EVM halt reason.

gas_used: u64

Gas consumed before the halt.

Other(SimHostError)

An unexpected host-side error (RPC, database, ABI encoding).

Implementations

impl SimError

pub fn is_revert(&self) -> bool

true if this is a transaction-level revert, i.e. the Revert variant.

pub fn is_halt(&self) -> bool

true if the EVM halted without returning revert data (e.g. out of gas), i.e. the Halt variant.

pub fn as_revert(&self) -> Option<&SimulationError>

The decoded SimulationError if this is a Revert, or None for a Halt or Other error.

Trait Implementations

impl Debug for SimError

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for SimError

fn fmt(&self, __formatter: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Error for SimError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl From<CacheError> for SimError

fn from(e: CacheError) -> Self

Converts to this type from the input type.

impl From<OverlayError> for SimError

fn from(e: OverlayError) -> Self

Converts to this type from the input type.

impl From<SimHostError> for SimError

fn from(e: SimHostError) -> Self

Converts to this type from the input type.

impl From<SimulationError> for SimError

fn from(e: SimulationError) -> Self

Converts to this type from the input type.