Receipt Error Improvements (#99)

* make panic receipt more transparent, make script result handle reverts

fuel-tx/src/lib.rs

@@ -28,7 +28,7 @@ mod transaction;
 pub use builder::TransactionBuilder;
 
 #[cfg(feature = "alloc")]
-pub use receipt::Receipt;
+pub use receipt::{Receipt, ScriptExecutionResult};
 
 #[cfg(feature = "alloc")]
 pub use transaction::{

fuel-tx/src/receipt.rs

@@ -8,9 +8,12 @@ use alloc::vec::Vec;
 mod receipt_std;
 
 mod receipt_repr;
+mod script_result;
 
 use receipt_repr::ReceiptRepr;
 
+pub use script_result::ScriptExecutionResult;
+
 #[derive(Debug, Clone, PartialEq, Eq, Hash)]
 #[cfg_attr(
     feature = "serde-types-minimal",
@@ -48,7 +51,7 @@ pub enum Receipt {
 
     Panic {
         id: ContractId,
-        reason: Word,
+        reason: InstructionResult,
         pc: Word,
         is: Word,
     },
@@ -101,7 +104,7 @@ pub enum Receipt {
     },
 
     ScriptResult {
-        result: InstructionResult,
+        result: ScriptExecutionResult,
         gas_used: Word,
     },
 }
@@ -156,7 +159,7 @@ impl Receipt {
         }
     }
 
-    pub const fn panic(id: ContractId, reason: Word, pc: Word, is: Word) -> Self {
+    pub const fn panic(id: ContractId, reason: InstructionResult, pc: Word, is: Word) -> Self {
         Self::Panic { id, reason, pc, is }
     }
 
@@ -244,7 +247,7 @@ impl Receipt {
         }
     }
 
-    pub const fn script_result(result: InstructionResult, gas_used: Word) -> Self {
+    pub const fn script_result(result: ScriptExecutionResult, gas_used: Word) -> Self {
         Self::ScriptResult { result, gas_used }
     }
 
@@ -394,7 +397,7 @@ impl Receipt {
         }
     }
 
-    pub const fn reason(&self) -> Option<Word> {
+    pub const fn reason(&self) -> Option<InstructionResult> {
         match self {
             Self::Panic { reason, .. } => Some(*reason),
             _ => None,
@@ -432,7 +435,7 @@ impl Receipt {
         }
     }
 
-    pub const fn result(&self) -> Option<&InstructionResult> {
+    pub const fn result(&self) -> Option<&ScriptExecutionResult> {
         match self {
             Self::ScriptResult { result, .. } => Some(result),
             _ => None,

fuel-tx/src/receipt/receipt_std.rs

@@ -4,6 +4,7 @@ use fuel_asm::InstructionResult;
 use fuel_types::bytes::{self, SizedBytes, WORD_SIZE};
 use fuel_types::Word;
 
+use crate::receipt::script_result::ScriptExecutionResult;
 use std::io::{self, Write};
 
 impl io::Read for Receipt {
@@ -258,7 +259,7 @@ impl io::Write for Receipt {
 
                 let id = id.into();
 
-                *self = Self::panic(id, reason, pc, is);
+                *self = Self::panic(id, InstructionResult::from(reason), pc, is);
             }
 
             ReceiptRepr::Revert => {
@@ -344,7 +345,7 @@ impl io::Write for Receipt {
                 let (result, buf) = unsafe { bytes::restore_word_unchecked(buf) };
                 let (gas_used, _) = unsafe { bytes::restore_word_unchecked(buf) };
 
-                let result = InstructionResult::from(result);
+                let result = ScriptExecutionResult::from(result);
 
                 *self = Self::script_result(result, gas_used);
             }

fuel-tx/src/receipt/script_result.rs

@@ -0,0 +1,36 @@
+use fuel_types::Word;
+
+#[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
+#[cfg_attr(
+    feature = "serde-types-minimal",
+    derive(serde::Serialize, serde::Deserialize)
+)]
+pub enum ScriptExecutionResult {
+    Success,
+    Revert,
+    Panic,
+    // Generic failure case since any u64 is valid here
+    GenericFailure(u64),
+}
+
+impl From<ScriptExecutionResult> for Word {
+    fn from(result: ScriptExecutionResult) -> Self {
+        match result {
+            ScriptExecutionResult::Success => 0x00,
+            ScriptExecutionResult::Revert => 0x01,
+            ScriptExecutionResult::Panic => 0x02,
+            ScriptExecutionResult::GenericFailure(value) => value,
+        }
+    }
+}
+
+impl From<Word> for ScriptExecutionResult {
+    fn from(value: u64) -> Self {
+        match value {
+            0x00 => Self::Success,
+            0x01 => Self::Revert,
+            0x02 => Self::Panic,
+            value => Self::GenericFailure(value),
+        }
+    }
+}