1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167
use core::fmt;
macro_rules! enum_from {
(
$(#[$meta:meta])* $vis:vis enum $name:ident {
$($(#[$vmeta:meta])* $vname:ident $(= $val:expr)?,)*
}
) => {
$(#[$meta])*
$vis enum $name {
$($(#[$vmeta])* $vname $(= $val)?,)*
}
impl From<u8> for $name {
fn from(v: u8) -> Self {
match v {
$(x if x == $name::$vname as u8 => $name::$vname,)*
_ => $name::UnknownPanicReason,
}
}
}
}
}
enum_from! {
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, strum::EnumIter)]
#[cfg_attr(feature = "typescript", wasm_bindgen::prelude::wasm_bindgen)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[derive(fuel_types::canonical::Serialize, fuel_types::canonical::Deserialize)]
#[cfg_attr(feature = "arbitrary", derive(arbitrary::Arbitrary))]
#[repr(u8)]
#[non_exhaustive]
/// Panic reason representation for the interpreter.
pub enum PanicReason {
/// The byte can't be mapped to any known `PanicReason`.
UnknownPanicReason = 0x00,
/// Found `RVRT` instruction.
Revert = 0x01,
/// Execution ran out of gas.
OutOfGas = 0x02,
/// The transaction validity is violated.
TransactionValidity = 0x03,
/// Attempt to write outside interpreter memory boundaries.
MemoryOverflow = 0x04,
/// Overflow while executing arithmetic operation.
/// These errors are ignored using the WRAPPING flag.
ArithmeticOverflow = 0x05,
/// Designed contract was not found in the storage.
ContractNotFound = 0x06,
/// Memory ownership rules are violated.
MemoryOwnership = 0x07,
/// The asset ID balance isn't enough for the instruction.
NotEnoughBalance = 0x08,
/// The interpreter is expected to be in internal context.
ExpectedInternalContext = 0x09,
/// The queried asset ID was not found in the state.
AssetIdNotFound = 0x0a,
/// The provided input is not found in the transaction.
InputNotFound = 0x0b,
/// The provided output is not found in the transaction.
OutputNotFound = 0x0c,
/// The provided witness is not found in the transaction.
WitnessNotFound = 0x0d,
/// The transaction maturity is not valid for this request.
TransactionMaturity = 0x0e,
/// The metadata identifier is invalid.
InvalidMetadataIdentifier = 0x0f,
/// The call structure is not valid.
MalformedCallStructure = 0x10,
/// The provided register does not allow write operations.
ReservedRegisterNotWritable = 0x11,
/// The execution resulted in an erroneous state of the interpreter.
ErrorFlag = 0x12,
/// The provided immediate value is not valid for this instruction.
InvalidImmediateValue = 0x13,
/// The provided transaction input is not of type `Coin`.
ExpectedCoinInput = 0x14,
/// This entry is no longer used, and can be repurposed.
Unused0x15 = 0x15,
/// Two segments of the interpreter memory should not intersect for write operations.
MemoryWriteOverlap = 0x16,
/// The requested contract is not listed in the transaction inputs.
ContractNotInInputs = 0x17,
/// The internal asset ID balance overflowed with the provided instruction.
InternalBalanceOverflow = 0x18,
/// The maximum allowed contract size is violated.
ContractMaxSize = 0x19,
/// This instruction expects the stack area to be unallocated for this call.
ExpectedUnallocatedStack = 0x1a,
/// The maximum allowed number of static contracts was reached for this transaction.
MaxStaticContractsReached = 0x1b,
/// The requested transfer amount cannot be zero.
TransferAmountCannotBeZero = 0x1c,
/// The provided transaction output should be of type `Variable`.
ExpectedOutputVariable = 0x1d,
/// The expected context of the stack parent is internal.
ExpectedParentInternalContext = 0x1e,
/// The jump instruction cannot move backwards in predicate verification.
IllegalJump = 0x1f,
/// The contract ID is already deployed and can't be overwritten.
ContractIdAlreadyDeployed = 0x20,
/// The loaded contract mismatch expectations.
ContractMismatch = 0x21,
/// Attempting to send message data longer than `MAX_MESSAGE_DATA_LENGTH`
MessageDataTooLong = 0x22,
/// Mathimatically invalid arguments where given to an arithmetic instruction.
/// For instance, division by zero produces this.
/// These errors are ignored using the UNSAFEMATH flag.
ArithmeticError = 0x23,
/// The contract instruction is not allowed in predicates.
ContractInstructionNotAllowed = 0x24,
/// Transfer of zero coins is not allowed.
TransferZeroCoins = 0x25,
}
}
impl fmt::Display for PanicReason {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
write!(f, "{self:?}")
}
}
#[cfg(feature = "std")]
impl std::error::Error for PanicReason {
fn source(&self) -> Option<&(dyn std::error::Error + 'static)> {
None
}
}
#[cfg(feature = "std")]
impl From<PanicReason> for std::io::Error {
fn from(reason: PanicReason) -> Self {
use std::io;
io::Error::new(io::ErrorKind::Other, reason)
}
}
impl From<core::array::TryFromSliceError> for PanicReason {
fn from(_: core::array::TryFromSliceError) -> Self {
Self::MemoryOverflow
}
}
#[cfg(test)]
mod tests {
use super::*;
use strum::IntoEnumIterator;
#[test]
fn test_u8_panic_reason_round_trip() {
let last_known_panic_reason: u8 = PanicReason::iter().last().unwrap() as u8 + 1;
let reason = PanicReason::from(0);
assert_eq!(reason, PanicReason::UnknownPanicReason);
for i in 1..last_known_panic_reason {
let reason = PanicReason::try_from(i).unwrap();
let i2 = reason as u8;
assert_eq!(i, i2);
}
for i in last_known_panic_reason..=255 {
let reason = PanicReason::from(i);
let i2 = reason as u8;
assert_eq!(PanicReason::UnknownPanicReason as u8, i2);
}
}
}