revm_context_interface/
result.rs

1//! Result of the EVM execution. Containing both execution result, state and errors.
2//!
3//! [`ExecutionResult`] is the result of the EVM execution.
4//!
5//! [`InvalidTransaction`] is the error that is returned when the transaction is invalid.
6//!
7//! [`InvalidHeader`] is the error that is returned when the header is invalid.
8//!
9//! [`SuccessReason`] is the reason that the transaction successfully completed.
10use crate::{context::ContextError, transaction::TransactionError};
11use core::fmt::{self, Debug};
12use database_interface::DBErrorMarker;
13use primitives::{Address, Bytes, Log, U256};
14use state::EvmState;
15use std::{boxed::Box, string::String, vec::Vec};
16
17/// Trait for the halt reason.
18pub trait HaltReasonTr: Clone + Debug + PartialEq + Eq + From<HaltReason> {}
19
20impl<T> HaltReasonTr for T where T: Clone + Debug + PartialEq + Eq + From<HaltReason> {}
21
22/// Tuple containing evm execution result and state.s
23#[derive(Clone, Debug, PartialEq, Eq, Hash)]
24#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
25pub struct ExecResultAndState<R, S = EvmState> {
26    /// Execution result
27    pub result: R,
28    /// Output State.
29    pub state: S,
30}
31
32/// Type alias for backwards compatibility.
33pub type ResultAndState<H = HaltReason, S = EvmState> = ExecResultAndState<ExecutionResult<H>, S>;
34
35/// Tuple containing multiple execution results and state.
36pub type ResultVecAndState<R, S> = ExecResultAndState<Vec<R>, S>;
37
38impl<R, S> ExecResultAndState<R, S> {
39    /// Creates new ResultAndState.
40    pub fn new(result: R, state: S) -> Self {
41        Self { result, state }
42    }
43}
44
45/// Result of a transaction execution
46#[derive(Clone, Debug, PartialEq, Eq, Hash)]
47#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
48pub enum ExecutionResult<HaltReasonTy = HaltReason> {
49    /// Returned successfully
50    Success {
51        /// Reason for the success.
52        reason: SuccessReason,
53        /// Gas used by the transaction.s
54        gas_used: u64,
55        /// Gas refunded by the transaction.
56        gas_refunded: u64,
57        /// Logs emitted by the transaction.
58        logs: Vec<Log>,
59        /// Output of the transaction.
60        output: Output,
61    },
62    /// Reverted by `REVERT` opcode that doesn't spend all gas
63    Revert {
64        /// Gas used by the transaction.
65        gas_used: u64,
66        /// Output of the transaction.
67        output: Bytes,
68    },
69    /// Reverted for various reasons and spend all gas
70    Halt {
71        /// Reason for the halt.
72        reason: HaltReasonTy,
73        /// Gas used by the transaction.
74        ///
75        /// Halting will spend all the gas, and will be equal to gas_limit.
76        gas_used: u64,
77    },
78}
79
80impl<HaltReasonTy> ExecutionResult<HaltReasonTy> {
81    /// Returns if transaction execution is successful.
82    ///
83    /// 1 indicates success, 0 indicates revert.
84    ///
85    /// <https://eips.ethereum.org/EIPS/eip-658>
86    pub fn is_success(&self) -> bool {
87        matches!(self, Self::Success { .. })
88    }
89
90    /// Maps a `DBError` to a new error type using the provided closure, leaving other variants unchanged.
91    pub fn map_haltreason<F, OHR>(self, op: F) -> ExecutionResult<OHR>
92    where
93        F: FnOnce(HaltReasonTy) -> OHR,
94    {
95        match self {
96            Self::Success {
97                reason,
98                gas_used,
99                gas_refunded,
100                logs,
101                output,
102            } => ExecutionResult::Success {
103                reason,
104                gas_used,
105                gas_refunded,
106                logs,
107                output,
108            },
109            Self::Revert { gas_used, output } => ExecutionResult::Revert { gas_used, output },
110            Self::Halt { reason, gas_used } => ExecutionResult::Halt {
111                reason: op(reason),
112                gas_used,
113            },
114        }
115    }
116
117    /// Returns created address if execution is Create transaction
118    /// and Contract was created.
119    pub fn created_address(&self) -> Option<Address> {
120        match self {
121            Self::Success { output, .. } => output.address().cloned(),
122            _ => None,
123        }
124    }
125
126    /// Returns true if execution result is a Halt.
127    pub fn is_halt(&self) -> bool {
128        matches!(self, Self::Halt { .. })
129    }
130
131    /// Returns the output data of the execution.
132    ///
133    /// Returns [`None`] if the execution was halted.
134    pub fn output(&self) -> Option<&Bytes> {
135        match self {
136            Self::Success { output, .. } => Some(output.data()),
137            Self::Revert { output, .. } => Some(output),
138            _ => None,
139        }
140    }
141
142    /// Consumes the type and returns the output data of the execution.
143    ///
144    /// Returns [`None`] if the execution was halted.
145    pub fn into_output(self) -> Option<Bytes> {
146        match self {
147            Self::Success { output, .. } => Some(output.into_data()),
148            Self::Revert { output, .. } => Some(output),
149            _ => None,
150        }
151    }
152
153    /// Returns the logs if execution is successful, or an empty list otherwise.
154    pub fn logs(&self) -> &[Log] {
155        match self {
156            Self::Success { logs, .. } => logs.as_slice(),
157            _ => &[],
158        }
159    }
160
161    /// Consumes [`self`] and returns the logs if execution is successful, or an empty list otherwise.
162    pub fn into_logs(self) -> Vec<Log> {
163        match self {
164            Self::Success { logs, .. } => logs,
165            _ => Vec::new(),
166        }
167    }
168
169    /// Returns the gas used.
170    pub fn gas_used(&self) -> u64 {
171        match *self {
172            Self::Success { gas_used, .. }
173            | Self::Revert { gas_used, .. }
174            | Self::Halt { gas_used, .. } => gas_used,
175        }
176    }
177}
178
179/// Output of a transaction execution
180#[derive(Debug, Clone, PartialEq, Eq, Hash)]
181#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
182pub enum Output {
183    /// Output of a call.
184    Call(Bytes),
185    /// Output of a create.
186    Create(Bytes, Option<Address>),
187}
188
189impl Output {
190    /// Returns the output data of the execution output.
191    pub fn into_data(self) -> Bytes {
192        match self {
193            Output::Call(data) => data,
194            Output::Create(data, _) => data,
195        }
196    }
197
198    /// Returns the output data of the execution output.
199    pub fn data(&self) -> &Bytes {
200        match self {
201            Output::Call(data) => data,
202            Output::Create(data, _) => data,
203        }
204    }
205
206    /// Returns the created address, if any.
207    pub fn address(&self) -> Option<&Address> {
208        match self {
209            Output::Call(_) => None,
210            Output::Create(_, address) => address.as_ref(),
211        }
212    }
213}
214
215/// Main EVM error
216#[derive(Debug, Clone, PartialEq, Eq)]
217#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
218pub enum EVMError<DBError, TransactionError = InvalidTransaction> {
219    /// Transaction validation error
220    Transaction(TransactionError),
221    /// Header validation error
222    Header(InvalidHeader),
223    /// Database error
224    Database(DBError),
225    /// Custom error
226    ///
227    /// Useful for handler registers where custom logic would want to return their own custom error.
228    Custom(String),
229}
230
231impl<DBError, TransactionValidationErrorT> From<ContextError<DBError>>
232    for EVMError<DBError, TransactionValidationErrorT>
233{
234    fn from(value: ContextError<DBError>) -> Self {
235        match value {
236            ContextError::Db(e) => Self::Database(e),
237            ContextError::Custom(e) => Self::Custom(e),
238        }
239    }
240}
241
242impl<DBError: DBErrorMarker, TX> From<DBError> for EVMError<DBError, TX> {
243    fn from(value: DBError) -> Self {
244        Self::Database(value)
245    }
246}
247
248/// Trait for converting a string to an [`EVMError::Custom`] error.
249pub trait FromStringError {
250    /// Converts a string to an [`EVMError::Custom`] error.
251    fn from_string(value: String) -> Self;
252}
253
254impl<DB, TX> FromStringError for EVMError<DB, TX> {
255    fn from_string(value: String) -> Self {
256        Self::Custom(value)
257    }
258}
259
260impl<DB, TXE: From<InvalidTransaction>> From<InvalidTransaction> for EVMError<DB, TXE> {
261    fn from(value: InvalidTransaction) -> Self {
262        Self::Transaction(TXE::from(value))
263    }
264}
265
266impl<DBError, TransactionValidationErrorT> EVMError<DBError, TransactionValidationErrorT> {
267    /// Maps a `DBError` to a new error type using the provided closure, leaving other variants unchanged.
268    pub fn map_db_err<F, E>(self, op: F) -> EVMError<E, TransactionValidationErrorT>
269    where
270        F: FnOnce(DBError) -> E,
271    {
272        match self {
273            Self::Transaction(e) => EVMError::Transaction(e),
274            Self::Header(e) => EVMError::Header(e),
275            Self::Database(e) => EVMError::Database(op(e)),
276            Self::Custom(e) => EVMError::Custom(e),
277        }
278    }
279}
280
281impl<DBError, TransactionValidationErrorT> core::error::Error
282    for EVMError<DBError, TransactionValidationErrorT>
283where
284    DBError: core::error::Error + 'static,
285    TransactionValidationErrorT: core::error::Error + 'static,
286{
287    fn source(&self) -> Option<&(dyn core::error::Error + 'static)> {
288        match self {
289            Self::Transaction(e) => Some(e),
290            Self::Header(e) => Some(e),
291            Self::Database(e) => Some(e),
292            Self::Custom(_) => None,
293        }
294    }
295}
296
297impl<DBError, TransactionValidationErrorT> fmt::Display
298    for EVMError<DBError, TransactionValidationErrorT>
299where
300    DBError: fmt::Display,
301    TransactionValidationErrorT: fmt::Display,
302{
303    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
304        match self {
305            Self::Transaction(e) => write!(f, "transaction validation error: {e}"),
306            Self::Header(e) => write!(f, "header validation error: {e}"),
307            Self::Database(e) => write!(f, "database error: {e}"),
308            Self::Custom(e) => f.write_str(e),
309        }
310    }
311}
312
313impl<DBError, TransactionValidationErrorT> From<InvalidHeader>
314    for EVMError<DBError, TransactionValidationErrorT>
315{
316    fn from(value: InvalidHeader) -> Self {
317        Self::Header(value)
318    }
319}
320
321/// Transaction validation error.
322#[derive(Debug, Clone, PartialEq, Eq, Hash)]
323#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
324pub enum InvalidTransaction {
325    /// When using the EIP-1559 fee model introduced in the London upgrade, transactions specify two primary fee fields:
326    /// - `gas_max_fee`: The maximum total fee a user is willing to pay, inclusive of both base fee and priority fee.
327    /// - `gas_priority_fee`: The extra amount a user is willing to give directly to the miner, often referred to as the "tip".
328    ///
329    /// Provided `gas_priority_fee` exceeds the total `gas_max_fee`.
330    PriorityFeeGreaterThanMaxFee,
331    /// EIP-1559: `gas_price` is less than `basefee`.
332    GasPriceLessThanBasefee,
333    /// `gas_limit` in the tx is bigger than `block_gas_limit`.
334    CallerGasLimitMoreThanBlock,
335    /// Initial gas for a Call is bigger than `gas_limit`.
336    ///
337    /// Initial gas for a Call contains:
338    /// - initial stipend gas
339    /// - gas for access list and input data
340    CallGasCostMoreThanGasLimit {
341        /// Initial gas for a Call.
342        initial_gas: u64,
343        /// Gas limit for the transaction.
344        gas_limit: u64,
345    },
346    /// Gas floor calculated from EIP-7623 Increase calldata cost
347    /// is more than the gas limit.
348    ///
349    /// Tx data is too large to be executed.
350    GasFloorMoreThanGasLimit {
351        /// Gas floor calculated from EIP-7623 Increase calldata cost.
352        gas_floor: u64,
353        /// Gas limit for the transaction.
354        gas_limit: u64,
355    },
356    /// EIP-3607 Reject transactions from senders with deployed code
357    RejectCallerWithCode,
358    /// Transaction account does not have enough amount of ether to cover transferred value and gas_limit*gas_price.
359    LackOfFundForMaxFee {
360        /// Fee for the transaction.
361        fee: Box<U256>,
362        /// Balance of the sender.
363        balance: Box<U256>,
364    },
365    /// Overflow payment in transaction.
366    OverflowPaymentInTransaction,
367    /// Nonce overflows in transaction.
368    NonceOverflowInTransaction,
369    /// Nonce is too high.
370    NonceTooHigh {
371        /// Nonce of the transaction.
372        tx: u64,
373        /// Nonce of the state.
374        state: u64,
375    },
376    /// Nonce is too low.
377    NonceTooLow {
378        /// Nonce of the transaction.
379        tx: u64,
380        /// Nonce of the state.
381        state: u64,
382    },
383    /// EIP-3860: Limit and meter initcode
384    CreateInitCodeSizeLimit,
385    /// Transaction chain id does not match the config chain id.
386    InvalidChainId,
387    /// Missing chain id.
388    MissingChainId,
389    /// Transaction gas limit is greater than the cap.
390    TxGasLimitGreaterThanCap {
391        /// Transaction gas limit.
392        gas_limit: u64,
393        /// Gas limit cap.
394        cap: u64,
395    },
396    /// Access list is not supported for blocks before the Berlin hardfork.
397    AccessListNotSupported,
398    /// `max_fee_per_blob_gas` is not supported for blocks before the Cancun hardfork.
399    MaxFeePerBlobGasNotSupported,
400    /// `blob_hashes`/`blob_versioned_hashes` is not supported for blocks before the Cancun hardfork.
401    BlobVersionedHashesNotSupported,
402    /// Block `blob_gas_price` is greater than tx-specified `max_fee_per_blob_gas` after Cancun.
403    BlobGasPriceGreaterThanMax {
404        /// Block `blob_gas_price`.
405        block_blob_gas_price: u128,
406        /// Tx-specified `max_fee_per_blob_gas`.
407        tx_max_fee_per_blob_gas: u128,
408    },
409    /// There should be at least one blob in Blob transaction.
410    EmptyBlobs,
411    /// Blob transaction can't be a create transaction.
412    ///
413    /// `to` must be present
414    BlobCreateTransaction,
415    /// Transaction has more then `max` blobs
416    TooManyBlobs {
417        /// Maximum number of blobs allowed.
418        max: usize,
419        /// Number of blobs in the transaction.
420        have: usize,
421    },
422    /// Blob transaction contains a versioned hash with an incorrect version
423    BlobVersionNotSupported,
424    /// EIP-7702 is not enabled.
425    AuthorizationListNotSupported,
426    /// EIP-7702 transaction has invalid fields set.
427    AuthorizationListInvalidFields,
428    /// Empty Authorization List is not allowed.
429    EmptyAuthorizationList,
430    /// EIP-2930 is not supported.
431    Eip2930NotSupported,
432    /// EIP-1559 is not supported.
433    Eip1559NotSupported,
434    /// EIP-4844 is not supported.
435    Eip4844NotSupported,
436    /// EIP-7702 is not supported.
437    Eip7702NotSupported,
438    /// EIP-7873 is not supported.
439    Eip7873NotSupported,
440    /// EIP-7873 initcode transaction should have `to` address.
441    Eip7873MissingTarget,
442}
443
444impl TransactionError for InvalidTransaction {}
445
446impl core::error::Error for InvalidTransaction {}
447
448impl fmt::Display for InvalidTransaction {
449    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
450        match self {
451            Self::PriorityFeeGreaterThanMaxFee => {
452                write!(f, "priority fee is greater than max fee")
453            }
454            Self::GasPriceLessThanBasefee => {
455                write!(f, "gas price is less than basefee")
456            }
457            Self::CallerGasLimitMoreThanBlock => {
458                write!(f, "caller gas limit exceeds the block gas limit")
459            }
460            Self::TxGasLimitGreaterThanCap { gas_limit, cap } => {
461                write!(
462                    f,
463                    "transaction gas limit ({gas_limit}) is greater than the cap ({cap})"
464                )
465            }
466            Self::CallGasCostMoreThanGasLimit {
467                initial_gas,
468                gas_limit,
469            } => {
470                write!(
471                    f,
472                    "call gas cost ({initial_gas}) exceeds the gas limit ({gas_limit})"
473                )
474            }
475            Self::GasFloorMoreThanGasLimit {
476                gas_floor,
477                gas_limit,
478            } => {
479                write!(
480                    f,
481                    "gas floor ({gas_floor}) exceeds the gas limit ({gas_limit})"
482                )
483            }
484            Self::RejectCallerWithCode => {
485                write!(f, "reject transactions from senders with deployed code")
486            }
487            Self::LackOfFundForMaxFee { fee, balance } => {
488                write!(f, "lack of funds ({balance}) for max fee ({fee})")
489            }
490            Self::OverflowPaymentInTransaction => {
491                write!(f, "overflow payment in transaction")
492            }
493            Self::NonceOverflowInTransaction => {
494                write!(f, "nonce overflow in transaction")
495            }
496            Self::NonceTooHigh { tx, state } => {
497                write!(f, "nonce {tx} too high, expected {state}")
498            }
499            Self::NonceTooLow { tx, state } => {
500                write!(f, "nonce {tx} too low, expected {state}")
501            }
502            Self::CreateInitCodeSizeLimit => {
503                write!(f, "create initcode size limit")
504            }
505            Self::InvalidChainId => write!(f, "invalid chain ID"),
506            Self::MissingChainId => write!(f, "missing chain ID"),
507            Self::AccessListNotSupported => write!(f, "access list not supported"),
508            Self::MaxFeePerBlobGasNotSupported => {
509                write!(f, "max fee per blob gas not supported")
510            }
511            Self::BlobVersionedHashesNotSupported => {
512                write!(f, "blob versioned hashes not supported")
513            }
514            Self::BlobGasPriceGreaterThanMax {
515                block_blob_gas_price,
516                tx_max_fee_per_blob_gas,
517            } => {
518                write!(
519                    f,
520                    "blob gas price ({block_blob_gas_price}) is greater than max fee per blob gas ({tx_max_fee_per_blob_gas})"
521                )
522            }
523            Self::EmptyBlobs => write!(f, "empty blobs"),
524            Self::BlobCreateTransaction => write!(f, "blob create transaction"),
525            Self::TooManyBlobs { max, have } => {
526                write!(f, "too many blobs, have {have}, max {max}")
527            }
528            Self::BlobVersionNotSupported => write!(f, "blob version not supported"),
529            Self::AuthorizationListNotSupported => write!(f, "authorization list not supported"),
530            Self::AuthorizationListInvalidFields => {
531                write!(f, "authorization list tx has invalid fields")
532            }
533            Self::EmptyAuthorizationList => write!(f, "empty authorization list"),
534            Self::Eip2930NotSupported => write!(f, "Eip2930 is not supported"),
535            Self::Eip1559NotSupported => write!(f, "Eip1559 is not supported"),
536            Self::Eip4844NotSupported => write!(f, "Eip4844 is not supported"),
537            Self::Eip7702NotSupported => write!(f, "Eip7702 is not supported"),
538            Self::Eip7873NotSupported => write!(f, "Eip7873 is not supported"),
539            Self::Eip7873MissingTarget => {
540                write!(f, "Eip7873 initcode transaction should have `to` address")
541            }
542        }
543    }
544}
545
546/// Errors related to misconfiguration of a [`crate::Block`].
547#[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
548#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
549pub enum InvalidHeader {
550    /// `prevrandao` is not set for Merge and above.
551    PrevrandaoNotSet,
552    /// `excess_blob_gas` is not set for Cancun and above.
553    ExcessBlobGasNotSet,
554}
555
556impl core::error::Error for InvalidHeader {}
557
558impl fmt::Display for InvalidHeader {
559    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
560        match self {
561            Self::PrevrandaoNotSet => write!(f, "`prevrandao` not set"),
562            Self::ExcessBlobGasNotSet => write!(f, "`excess_blob_gas` not set"),
563        }
564    }
565}
566
567/// Reason a transaction successfully completed.
568#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
569#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
570pub enum SuccessReason {
571    /// Stop [`state::bytecode::opcode::STOP`] opcode.
572    Stop,
573    /// Return [`state::bytecode::opcode::RETURN`] opcode.
574    Return,
575    /// Self destruct opcode.
576    SelfDestruct,
577}
578
579/// Indicates that the EVM has experienced an exceptional halt.
580///
581/// This causes execution to immediately end with all gas being consumed.
582#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
583#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
584pub enum HaltReason {
585    /// Out of gas error.
586    OutOfGas(OutOfGasError),
587    /// Opcode not found error.
588    OpcodeNotFound,
589    /// Invalid FE opcode error.
590    InvalidFEOpcode,
591    /// Invalid jump destination.
592    InvalidJump,
593    /// The feature or opcode is not activated in hardfork.
594    NotActivated,
595    /// Attempting to pop a value from an empty stack.
596    StackUnderflow,
597    /// Attempting to push a value onto a full stack.
598    StackOverflow,
599    /// Invalid memory or storage offset for [`state::bytecode::opcode::RETURNDATACOPY`].
600    OutOfOffset,
601    /// Address collision during contract creation.
602    CreateCollision,
603    /// Precompile error.
604    PrecompileError,
605    /// Nonce overflow.
606    NonceOverflow,
607    /// Create init code size exceeds limit (runtime).
608    CreateContractSizeLimit,
609    /// Error on created contract that begins with EF
610    CreateContractStartingWithEF,
611    /// EIP-3860: Limit and meter initcode. Initcode size limit exceeded.
612    CreateInitCodeSizeLimit,
613
614    /* Internal Halts that can be only found inside Inspector */
615    /// Overflow payment. Not possible to happen on mainnet.
616    OverflowPayment,
617    /// State change during static call.
618    StateChangeDuringStaticCall,
619    /// Call not allowed inside static call.
620    CallNotAllowedInsideStatic,
621    /// Out of funds to pay for the call.
622    OutOfFunds,
623    /// Call is too deep.
624    CallTooDeep,
625}
626
627/// Out of gas errors.
628#[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
629#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
630pub enum OutOfGasError {
631    /// Basic OOG error. Not enough gas to execute the opcode.
632    Basic,
633    /// Tried to expand past memory limit.
634    MemoryLimit,
635    /// Basic OOG error from memory expansion
636    Memory,
637    /// Precompile threw OOG error
638    Precompile,
639    /// When performing something that takes a U256 and casts down to a u64, if its too large this would fire
640    /// i.e. in `as_usize_or_fail`
641    InvalidOperand,
642    /// When performing SSTORE the gasleft is less than or equal to 2300
643    ReentrancySentry,
644}
revm_context_interface/result.rs

revm_context_interface/
result.rs
