feat!: add support for dynamic configurables

.github/workflows/ci.yml

@@ -21,7 +21,7 @@ env:
   FUEL_CORE_PATCH_REVISION: ""
   RUST_VERSION: 1.85.0
   FORC_VERSION: 0.68.0
-  FORC_PATCH_BRANCH: "ironcev/error-codes-in-abi-json"
+  FORC_PATCH_BRANCH: "xunilrj/dynamic-types-configurables"
   FORC_PATCH_REVISION: ""
   NEXTEST_HIDE_PROGRESS_BAR: "true"
   NEXTEST_STATUS_LEVEL: "fail"

Cargo.toml

@@ -15,6 +15,7 @@ members = [
   "examples/predicates",
   "examples/providers",
   "examples/rust_bindings",
+  "examples/scripts",
   "examples/types",
   "examples/wallets",
   "packages/fuels",

docs/src/deploying/configurable-constants.md

@@ -9,5 +9,25 @@ In Sway, you can define `configurable` constants which can be changed during the
 Each of the configurable constants will get a dedicated `with` method in the SDK. For example, the constant `STR_4` will get the `with_STR_4` method which accepts the same type as defined in the contract code. Below is an example where we chain several `with` methods and deploy the contract with the new constants.
 
 ```rust,ignore
-{{#include ../../../e2e/tests/configurables.rs:contract_configurables}}
+{{#include ../../../examples/contracts/src/lib.rs:contract_configurables}}
 ```
+
+In addition to writing, you are able to read the configurable constants directly from the binary:
+
+```rust,ignore
+{{#include ../../../examples/contracts/src/lib.rs:contract_configurables_reader}}
+```
+
+If you need to manually read the configurable constants, you can use helper functions provided by the SDK.
+
+```rust,ignore
+{{#include ../../../e2e/tests/configurables.rs:manual_configurables}}
+```
+
+Similarly, you can read the configurable constants at runtime.
+
+```rust,ignore
+{{#include ../../../e2e/tests/configurables.rs:manual_runtime_configurables}}
+```
+
+> **Note:** when manually reading configurable constants make sure to call the appropriate method when dealing with static or dynamic configurables. For dynamic configurables use the `indirect` methods.

docs/src/predicates/index.md

@@ -54,3 +54,9 @@ Each configurable constant will get a dedicated `with` method in the SDK. For ex
 ```rust,ignore
 {{#include ../../../e2e/tests/predicates.rs:predicate_configurables}}
 ```
+
+In addition to writing, you are able to read the configurable constants directly from the binary:
+
+```rust,ignore
+{{#include ../../../examples/predicates/src/lib.rs:predicate_configurables_reader}}
+```

docs/src/running-scripts.md

@@ -65,5 +65,11 @@ Same as contracts, you can define `configurable` constants in `scripts` which ca
 Each configurable constant will get a dedicated `with` method in the SDK. For example, the constant `STR_4` will get the `with_STR_4` method which accepts the same type defined in sway. Below is an example where we chain several `with` methods and execute the script with the new constants.
 
 ```rust,ignore
-{{#include ../../e2e/tests/configurables.rs:script_configurables}}
+{{#include ../../examples/scripts/src/lib.rs:script_configurables}}
+```
+
+In addition to writing, you are able to read the configurable constants directly from the binary:
+
+```rust,ignore
+{{#include ../../examples/scripts/src/lib.rs:script_configurables_reader}}
 ```

e2e/Cargo.toml

@@ -22,6 +22,8 @@ fuel-tx = { workspace = true }
 # used in test assertions
 tai64 = { workspace = true }
 tempfile = { workspace = true }
+tokio = { workspace = true, features = ["test-util"] }
+test-case = { workspace = true }
 
 [build-dependencies]
 anyhow = { workspace = true, features = ["std"] }

e2e/Forc.toml

@@ -9,6 +9,7 @@ members = [
   'sway/contracts/auth_testing_abi',
   'sway/contracts/auth_testing_contract',
   'sway/contracts/block_timestamp',
+  'sway/contracts/dyn_configurables',
   'sway/contracts/configurables',
   'sway/contracts/contract_test',
   'sway/contracts/huge_contract',
@@ -40,6 +41,7 @@ members = [
   'sway/logs/script_with_contract_logs',
   'sway/predicates/basic_predicate',
   'sway/predicates/predicate_blobs',
+  'sway/predicates/predicate_dyn_configurables',
   'sway/predicates/predicate_configurables',
   'sway/predicates/predicate_witnesses',
   'sway/predicates/signatures',
@@ -53,6 +55,7 @@ members = [
   'sway/scripts/script_array',
   'sway/scripts/script_asserts',
   'sway/scripts/script_blobs',
+  'sway/scripts/script_dyn_configurables',
   'sway/scripts/script_configurables',
   'sway/scripts/script_enum',
   'sway/scripts/script_needs_custom_decoder',
@@ -119,5 +122,6 @@ members = [
   'sway/types/scripts/script_vectors',
 ]
 
+#TODO: [issue](https://github.com/FuelLabs/fuels-rs/issues/1610)
 [patch.'https://github.com/fuellabs/sway']
-std = { git = "https://github.com/fuellabs/sway", branch = "ironcev/error-codes-in-abi-json" }
+std = { git = "https://github.com/fuellabs/sway", branch = "xunilrj/dynamic-types-configurables" }

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

@@ -19,7 +19,7 @@ configurable {
     U64: u64 = 63,
     U256: u256 = 0x0000000000000000000000000000000000000000000000000000000000000008u256,
     B256: b256 = 0x0101010101010101010101010101010101010101010101010101010101010101,
-    STR_4: str[4] = __to_str_array("fuel"),
+    STR: str = "fuel",
     TUPLE: (u8, bool) = (8, true),
     ARRAY: [u32; 3] = [253, 254, 255],
     STRUCT: StructWithGeneric<u8> = StructWithGeneric {
@@ -31,11 +31,11 @@ configurable {
 //U128: u128 = 128, //TODO: add once https://github.com/FuelLabs/sway/issues/5356 is done
 
 abi TestContract {
-    fn return_configurables() -> (bool, u8, u16, u32, u64, u256, b256, str[4], (u8, bool), [u32; 3], StructWithGeneric<u8>, EnumWithGeneric<bool>);
+    fn return_configurables() -> (bool, u8, u16, u32, u64, u256, b256, str, (u8, bool), [u32; 3], StructWithGeneric<u8>, EnumWithGeneric<bool>);
 }
 
 impl TestContract for Contract {
-    fn return_configurables() -> (bool, u8, u16, u32, u64, u256, b256, str[4], (u8, bool), [u32; 3], StructWithGeneric<u8>, EnumWithGeneric<bool>) {
-        (BOOL, U8, U16, U32, U64, U256, B256, STR_4, TUPLE, ARRAY, STRUCT, ENUM)
+    fn return_configurables() -> (bool, u8, u16, u32, u64, u256, b256, str, (u8, bool), [u32; 3], StructWithGeneric<u8>, EnumWithGeneric<bool>) {
+        (BOOL, U8, U16, U32, U64, U256, B256, STR, TUPLE, ARRAY, STRUCT, ENUM)
     }
 }

e2e/sway/contracts/dyn_configurables/Forc.toml

@@ -0,0 +1,5 @@
+[project]
+authors = ["Fuel Labs <[email protected]>"]
+entry = "main.sw"
+license = "Apache-2.0"
+name = "dyn_configurables"

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

@@ -0,0 +1,20 @@
+contract;
+
+configurable {
+    BOOL: bool = true,
+    U8: u8 = 8,
+    STR: str = "sway",
+    STR_2: str = "forc",
+    STR_3: str = "fuel",
+    LAST_U8: u8 = 16,
+}
+
+abi TestContract {
+    fn return_configurables() -> (bool, u8, str, str, str, u8);
+}
+
+impl TestContract for Contract {
+    fn return_configurables() -> (bool, u8, str, str, str, u8) {
+        (BOOL, U8, STR, STR_2, STR_3, LAST_U8)
+    }
+}

e2e/sway/predicates/predicate_dyn_configurables/Forc.toml

@@ -0,0 +1,5 @@
+[project]
+authors = ["Fuel Labs <[email protected]>"]
+entry = "main.sw"
+license = "Apache-2.0"
+name = "predicate_dyn_configurables"

e2e/sway/predicates/predicate_dyn_configurables/src/main.sw

@@ -0,0 +1,21 @@
+predicate;
+
+configurable {
+    BOOL: bool = true,
+    U8: u8 = 8,
+    STR: str = "sway",
+    STR_2: str = "forc",
+    STR_3: str = "fuel",
+    LAST_U8: u8 = 16,
+}
+
+fn main(
+    some_bool: bool,
+    some_u8: u8,
+    some_str: str,
+    some_str_2: str,
+    some_str_3: str,
+    some_last_u8: u8,
+) -> bool {
+    some_bool == BOOL && some_u8 == U8 && some_str == STR && some_str_2 == STR_2 && some_str_3 == STR_3 && some_last_u8 == LAST_U8
+}

e2e/sway/scripts/script_dyn_configurables/Forc.toml

@@ -0,0 +1,5 @@
+[project]
+authors = ["Fuel Labs <[email protected]>"]
+entry = "main.sw"
+license = "Apache-2.0"
+name = "script_dyn_configurables"

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

@@ -0,0 +1,14 @@
+script;
+
+configurable {
+    BOOL: bool = true,
+    U8: u8 = 8,
+    STR: str = "sway",
+    STR_2: str = "forc",
+    STR_3: str = "fuel",
+    LAST_U8: u8 = 16,
+}
+
+fn main() -> (bool, u8, str, str, str, u8) {
+    (BOOL, U8, STR, STR_2, STR_3, LAST_U8)
+}

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

@@ -5,6 +5,7 @@ configurable {
         number: 10,
         boolean: true,
     },
+    A_STR: str = "fuel",
     A_NUMBER: u64 = 11,
 }
 
@@ -15,5 +16,6 @@ struct MyStruct {
 
 fn main(arg: MyStruct) -> u64 {
     let _calc = MY_STRUCT.number + A_NUMBER;
+    let _b = A_STR;
     if arg.boolean { arg.number } else { 0 }
 }