feat: add assert_ne and revert_with_log revert signals (#1548)

# Summary

Adds `assert_ne` and `revert_with_log` log decoding for reverted
transactions.

- added test for both `assert_ne` and `revert_with_log`
- bumped `forc` to `0.66.5`

.github/workflows/ci.yml

@@ -20,7 +20,7 @@ env:
   FUEL_CORE_PATCH_BRANCH: ""
   FUEL_CORE_PATCH_REVISION: ""
   RUST_VERSION: 1.79.0
-  FORC_VERSION: 0.66.4
+  FORC_VERSION: 0.66.5
   FORC_PATCH_BRANCH: ""
   FORC_PATCH_REVISION: ""
   NEXTEST_HIDE_PROGRESS_BAR: "true"

Cargo.toml

@@ -52,7 +52,7 @@ cynic = { version = "2.2", default-features = false }
 elliptic-curve = { version = "0.13.8", default-features = false }
 eth-keystore = "0.5.0"
 flate2 = { version = "1.0", default-features = false }
-fuel-abi-types = "0.7.0"
+fuel-abi-types = "0.8.0"
 futures = "0.3.29"
 hex = { version = "0.4.3", default-features = false }
 itertools = "0.12.0"

e2e/Forc.toml

@@ -24,7 +24,7 @@ members = [
   'sway/contracts/needs_custom_decoder',
   'sway/contracts/payable_annotation',
   'sway/contracts/proxy',
-  'sway/contracts/require',
+  'sway/contracts/revert_logs',
   'sway/contracts/revert_transaction_error',
   'sway/contracts/storage',
   'sway/contracts/token_ops',
@@ -55,7 +55,7 @@ members = [
   'sway/scripts/script_enum',
   'sway/scripts/script_needs_custom_decoder',
   'sway/scripts/script_proxy',
-  'sway/scripts/script_require',
+  'sway/scripts/script_revert_logs',
   'sway/scripts/script_struct',
   'sway/scripts/transfer_script',
   'sway/types/contracts/b256',

e2e/sway/contracts/asserts/src/main.sw

@@ -29,9 +29,14 @@ impl Eq for TestEnum {
 
 abi TestContract {
     fn assert_primitive(a: u64, b: u64);
+
     fn assert_eq_primitive(a: u64, b: u64);
     fn assert_eq_struct(test_struct: TestStruct, test_struct2: TestStruct);
     fn assert_eq_enum(test_enum: TestEnum, test_enum2: TestEnum);
+
+    fn assert_ne_primitive(a: u64, b: u64);
+    fn assert_ne_struct(test_struct: TestStruct, test_struct2: TestStruct);
+    fn assert_ne_enum(test_enum: TestEnum, test_enum2: TestEnum);
 }
 
 impl TestContract for Contract {
@@ -42,12 +47,20 @@ impl TestContract for Contract {
     fn assert_eq_primitive(a: u64, b: u64) {
         assert_eq(a, b);
     }
-
     fn assert_eq_struct(test_struct: TestStruct, test_struct2: TestStruct) {
         assert_eq(test_struct, test_struct2);
     }
-
     fn assert_eq_enum(test_enum: TestEnum, test_enum2: TestEnum) {
         assert_eq(test_enum, test_enum2);
     }
+
+    fn assert_ne_primitive(a: u64, b: u64) {
+        assert_ne(a, b);
+    }
+    fn assert_ne_struct(test_struct: TestStruct, test_struct2: TestStruct) {
+        assert_ne(test_struct, test_struct2);
+    }
+    fn assert_ne_enum(test_enum: TestEnum, test_enum2: TestEnum) {
+        assert_ne(test_enum, test_enum2);
+    }
 }

e2e/sway/contracts/require/Forc.toml → e2e/sway/contracts/revert_logs/Forc.toml

@@ -2,4 +2,4 @@
 authors = ["Fuel Labs <[email protected]>"]
 entry = "main.sw"
 license = "Apache-2.0"
-name = "require"
+name = "revert_logs"

e2e/sway/contracts/require/src/main.sw → e2e/sway/contracts/revert_logs/src/main.sw

@@ -25,6 +25,10 @@ abi TestContract {
     fn require_string();
     fn require_custom_generic();
     fn require_with_additional_logs();
+
+    fn rev_w_log_primitive();
+    fn rev_w_log_string();
+    fn rev_w_log_custom_generic();
 }
 
 impl TestContract for Contract {
@@ -57,4 +61,28 @@ impl TestContract for Contract {
         log(__to_str_array("fuel"));
         require(false, 64);
     }
+
+    fn rev_w_log_primitive() {
+        revert_with_log(42);
+    }
+
+    fn rev_w_log_string() {
+        revert_with_log(__to_str_array("fuel"));
+    }
+
+    fn rev_w_log_custom_generic() {
+        let l: [u8; 3] = [1u8, 2u8, 3u8];
+
+        let test_enum = EnumWithGeneric::VariantOne(l);
+        let test_struct_nested = StructWithNestedGeneric {
+            field_1: test_enum,
+            field_2: 64,
+        };
+        let test_deeply_nested_generic = StructDeeplyNestedGeneric {
+            field_1: test_struct_nested,
+            field_2: 64,
+        };
+
+        revert_with_log(test_deeply_nested_generic);
+    }
 }

e2e/sway/scripts/script_asserts/src/main.sw

@@ -33,6 +33,9 @@ enum MatchEnum {
     AssertEqPrimitive: (u64, u64),
     AssertEqStruct: (TestStruct, TestStruct),
     AssertEqEnum: (TestEnum, TestEnum),
+    AssertNePrimitive: (u64, u64),
+    AssertNeStruct: (TestStruct, TestStruct),
+    AssertNeEnum: (TestEnum, TestEnum),
 }
 
 fn main(match_enum: MatchEnum) {
@@ -46,5 +49,13 @@ fn main(match_enum: MatchEnum) {
     } else if let MatchEnum::AssertEqEnum((test_enum, test_enum2)) = match_enum
     {
         assert_eq(test_enum, test_enum2);
+    } else if let MatchEnum::AssertNePrimitive((a, b)) = match_enum {
+        assert_ne(a, b);
+    } else if let MatchEnum::AssertNeStruct((test_struct, test_struct2)) = match_enum
+    {
+        assert_ne(test_struct, test_struct2);
+    } else if let MatchEnum::AssertNeEnum((test_enum, test_enum2)) = match_enum
+    {
+        assert_ne(test_enum, test_enum2);
     }
 }

e2e/sway/scripts/script_require/Forc.toml → e2e/sway/scripts/script_revert_logs/Forc.toml

@@ -2,4 +2,4 @@
 authors = ["Fuel Labs <[email protected]>"]
 entry = "main.sw"
 license = "Apache-2.0"
-name = "script_require"
+name = "script_revert_logs"

e2e/sway/scripts/script_require/src/main.sw → e2e/sway/scripts/script_revert_logs/src/main.sw

@@ -26,6 +26,9 @@ enum MatchEnum {
     RequireString: (),
     RequireCustomGeneric: (),
     RequireWithAdditionalLogs: (),
+    RevWLogPrimitive: (),
+    RevWLogString: (),
+    RevWLogCustomGeneric: (),
 }
 
 fn main(match_enum: MatchEnum) {
@@ -51,5 +54,23 @@ fn main(match_enum: MatchEnum) {
         log(42);
         log(__to_str_array("fuel"));
         require(false, 64);
+    } else if let MatchEnum::RevWLogPrimitive = match_enum {
+        revert_with_log(42);
+    } else if let MatchEnum::RevWLogString = match_enum {
+        revert_with_log(__to_str_array("fuel"));
+    } else if let MatchEnum::RevWLogCustomGeneric = match_enum {
+        let l: [u8; 3] = [1u8, 2u8, 3u8];
+
+        let test_enum = EnumWithGeneric::VariantOne(l);
+        let test_struct_nested = StructWithNestedGeneric {
+            field_1: test_enum,
+            field_2: 64,
+        };
+        let test_deeply_nested_generic = StructDeeplyNestedGeneric {
+            field_1: test_struct_nested,
+            field_2: 64,
+        };
+
+        revert_with_log(test_deeply_nested_generic);
     }
 }

e2e/sway/types/contracts/vectors/src/main.sw

@@ -1,6 +1,6 @@
 contract;
 
-mod data_structures;
+pub mod data_structures;
 mod eq_impls;
 mod utils;
 

e2e/sway/types/scripts/script_vectors/src/main.sw

@@ -1,6 +1,6 @@
 script;
 
-mod data_structures;
+pub mod data_structures;
 mod eq_impls;
 mod utils;