chore!: use release paths for sway projects (#1275)

BREAKING CHANGE: - `setup_program_test` now expects `release` paths to work ### Checklist - [ ] I have linked to any relevant issues. - [ ] I have updated the documentation. - [ ] I have added tests that prove my fix is effective or that my feature works. - [x] I have added necessary labels. - [x] I have done my best to ensure that my PR adheres to [the Fuel Labs Code Review Standards](https://github.com/FuelLabs/rfcs/blob/master/text/code-standards/external-contributors.md). - [x] I have requested a review from the relevant team or maintainers.
FuelLabs · May 3, 2024 · e898aea · e898aea
1 parent 0ddb7e8
commit e898aea
Show file tree

Hide file tree

Showing 24 changed files with 165 additions and 158 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -63,7 +63,7 @@ jobs:
         working-directory: packages/fuels
 
       - name: Build Sway test projects
-        run: forc build --terse --error-on-warnings
+        run: forc build --release --terse --error-on-warnings
         working-directory: packages/fuels
 
       - uses: actions/upload-artifact@v2
@@ -82,7 +82,7 @@ jobs:
 
       # TODO: To be removed once https://github.com/FuelLabs/fuels-rs/issues/881 is unblocked.
       - name: Build Sway test projects w type paths
-        run: forc build --terse --error-on-warnings --json-abi-with-callpaths
+        run: forc build --release --terse --error-on-warnings --json-abi-with-callpaths
         working-directory: packages/fuels
 
       - uses: actions/upload-artifact@v2

diff --git a/README.md b/README.md
@@ -41,7 +41,7 @@ See [the `fuels-rs` book](https://fuellabs.github.io/fuels-rs/latest/)
 First, build the test projects using `forc`:
 
 ```shell
-forc build --path packages/fuels
+forc build --release --path packages/fuels
 ```
 
 Then you can run the SDK tests with:
@@ -73,7 +73,7 @@ Before doing anything else, try all these commands:
 ```shell
 cargo clean
 rm Cargo.lock
-forc build --path packages/fuels
+forc build --release --path packages/fuels
 cargo test
 ```
 

diff --git a/ci_checks.sh b/ci_checks.sh
@@ -9,8 +9,8 @@
 
 cargo fmt --all -- --check &&
 forc fmt --check --path packages/fuels &&
-forc build --terse --path packages/fuels &&
-forc build --terse --json-abi-with-callpaths --path packages/fuels &&
+forc build --release --terse --path packages/fuels &&
+forc build --release --terse --json-abi-with-callpaths --path packages/fuels &&
 cargo clippy --all-targets &&
 cargo clippy --all-targets --all-features &&
 cargo test --all-targets --all-features &&

diff --git a/docs/src/abigen/the-json-abi-file.md b/docs/src/abigen/the-json-abi-file.md
@@ -24,7 +24,7 @@ impl MyContract for Contract {
 The JSON ABI file looks like this:
 
 ```json
-$ cat out/debug/my-test-abi.json
+$ cat out/release/my-test-abi.json
 [
   {
     "type": "function",

diff --git a/docs/src/deploying/the-fuelvm-binary-file.md b/docs/src/deploying/the-fuelvm-binary-file.md
@@ -19,15 +19,15 @@ impl MyContract for Contract {
 After `forc build`, will have a binary file that contains:
 
 ```terminal
-$ cat out/debug/my-test.bin
+$ cat out/release/my-test.bin
 G4]�]D`I]C�As@
            6]C�$@!QK%
 ```
 
 This seems very unreadable! But, `forc` has a nice interpreter for this bytecode: `forc parse-bytecode`, which will interpret that binary data and output the equivalent FuelVM assembly:
 
 ```terminal
-$ forc parse-bytecode out/debug/my-test.bin
+$ forc parse-bytecode out/release/my-test.bin
 half-word   byte   op                raw           notes
         0   0      JI(4)             90 00 00 04   jump to byte 16
         1   4      NOOP              47 00 00 00

diff --git a/docs/src/getting-started.md b/docs/src/getting-started.md
@@ -101,7 +101,7 @@ Another way to experience the SDK is to look at the source code. The `packages/f
 > To build these tests, run the following command:
 
 ```shell
-forc build --path packages/fuels
+forc build --release --path packages/fuels
 ```
 
 > `forc` can also be used to clean and format the test projects. Check the `help` output for more info.

diff --git a/docs/src/testing/the-setup-program-test-macro.md b/docs/src/testing/the-setup-program-test-macro.md
@@ -53,8 +53,7 @@ Abigen(
 )
 ```
 
-Description: Generates the program bindings under the name `name`. `project`
-should point to root of the `forc` project.
+Description: Generates the program bindings under the name `name`. `project` should point to root of the `forc` project. The project must be compiled in `release` mode (`--release` flag) for `Abigen` command to work.
 
 Cardinality: 0 or N.
 

diff --git a/examples/contracts/src/lib.rs b/examples/contracts/src/lib.rs
@@ -41,7 +41,7 @@ mod tests {
         // This will load and deploy your contract binary to the chain so that its ID can
         // be used to initialize the instance
         let contract_id = Contract::load_from(
-            "../../packages/fuels/tests/contracts/contract_test/out/debug/contract_test.bin",
+            "../../packages/fuels/tests/contracts/contract_test/out/release/contract_test.bin",
             LoadConfiguration::default(),
         )?
         .deploy(&wallet, TxPolicies::default())
@@ -89,13 +89,13 @@ mod tests {
 
         abigen!(Contract(
             name = "MyContract",
-            abi = "packages/fuels/tests/contracts/contract_test/out/debug/contract_test-abi.json"
+            abi = "packages/fuels/tests/contracts/contract_test/out/release/contract_test-abi.json"
         ));
 
         let wallet = launch_provider_and_get_wallet().await?;
 
         let contract_id = Contract::load_from(
-            "../../packages/fuels/tests/contracts/contract_test/out/debug/contract_test.bin",
+            "../../packages/fuels/tests/contracts/contract_test/out/release/contract_test.bin",
             LoadConfiguration::default(),
         )?
         .deploy(&wallet, TxPolicies::default())
@@ -113,7 +113,7 @@ mod tests {
             .await?;
         // ANCHOR_END: contract_call_cost_estimation
 
-        let expected_gas = 2662;
+        let expected_gas = 2206;
 
         assert_eq!(transaction_cost.gas_used, expected_gas);
 
@@ -128,7 +128,7 @@ mod tests {
         let wallet = launch_provider_and_get_wallet().await?;
 
         let contract_id_1 = Contract::load_from(
-            "../../packages/fuels/tests/contracts/contract_test/out/debug/contract_test.bin",
+            "../../packages/fuels/tests/contracts/contract_test/out/release/contract_test.bin",
             LoadConfiguration::default(),
         )?
         .deploy(&wallet, TxPolicies::default())
@@ -158,7 +158,7 @@ mod tests {
             .with_maturity(0);
 
         let contract_id_2 = Contract::load_from(
-            "../../packages/fuels/tests/contracts/contract_test/out/debug/contract_test.bin",
+            "../../packages/fuels/tests/contracts/contract_test/out/release/contract_test.bin",
             configuration,
         )?
         .deploy(&wallet, tx_policies)
@@ -176,7 +176,7 @@ mod tests {
         // ANCHOR: abigen_example
         abigen!(Contract(
             name = "MyContract",
-            abi = "packages/fuels/tests/contracts/contract_test/out/debug/contract_test-abi.json"
+            abi = "packages/fuels/tests/contracts/contract_test/out/release/contract_test-abi.json"
         ));
         // ANCHOR_END: abigen_example
 
@@ -221,14 +221,14 @@ mod tests {
 
         abigen!(Contract(
             name = "MyContract",
-            abi = "packages/fuels/tests/contracts/contract_test/out/debug/contract_test-abi.json"
+            abi = "packages/fuels/tests/contracts/contract_test/out/release/contract_test-abi.json"
         ));
 
         let wallets =
             launch_custom_provider_and_get_wallets(WalletsConfig::default(), None, None).await?;
 
         let contract_id_1 = Contract::load_from(
-            "../../packages/fuels/tests/contracts/contract_test/out/debug/contract_test.bin",
+            "../../packages/fuels/tests/contracts/contract_test/out/release/contract_test.bin",
             LoadConfiguration::default(),
         )?
         .deploy(&wallets[0], TxPolicies::default())
@@ -247,7 +247,7 @@ mod tests {
         assert_eq!(42, response.value);
 
         let contract_id_2 = Contract::load_from(
-            "../../packages/fuels/tests/contracts/contract_test/out/debug/contract_test.bin",
+            "../../packages/fuels/tests/contracts/contract_test/out/release/contract_test.bin",
             LoadConfiguration::default().with_salt([1; 32]),
         )?
         .deploy(&wallets[1], TxPolicies::default())
@@ -273,13 +273,13 @@ mod tests {
         use fuels::prelude::*;
         abigen!(Contract(
             name = "MyContract",
-            abi = "packages/fuels/tests/contracts/contract_test/out/debug/contract_test-abi.json"
+            abi = "packages/fuels/tests/contracts/contract_test/out/release/contract_test-abi.json"
         ));
 
         let wallet = launch_provider_and_get_wallet().await?;
 
         let contract_id = Contract::load_from(
-            "../../packages/fuels/tests/contracts/contract_test/out/debug/contract_test.bin",
+            "../../packages/fuels/tests/contracts/contract_test/out/release/contract_test.bin",
             LoadConfiguration::default(),
         )?
         .deploy(&wallet, TxPolicies::default())
@@ -342,13 +342,13 @@ mod tests {
         use fuels::prelude::*;
         abigen!(Contract(
             name = "MyContract",
-            abi = "packages/fuels/tests/contracts/token_ops/out/debug/token_ops-abi.json"
+            abi = "packages/fuels/tests/contracts/token_ops/out/release/token_ops-abi.json"
         ));
 
         let wallet = launch_provider_and_get_wallet().await?;
 
         let contract_id = Contract::load_from(
-            "../../packages/fuels/tests/contracts/token_ops/out/debug/token_ops\
+            "../../packages/fuels/tests/contracts/token_ops/out/release/token_ops\
         .bin",
             LoadConfiguration::default(),
         )?
@@ -382,20 +382,20 @@ mod tests {
         use fuels::prelude::*;
         abigen!(
             Contract(name="MyContract",
-            abi="packages/fuels/tests/contracts/lib_contract_caller/out/debug/lib_contract_caller-abi.json"
+            abi="packages/fuels/tests/contracts/lib_contract_caller/out/release/lib_contract_caller-abi.json"
         ));
 
         let wallet = launch_provider_and_get_wallet().await?;
 
         let called_contract_id: ContractId = Contract::load_from(
-            "../../packages/fuels/tests/contracts/lib_contract/out/debug/lib_contract.bin",
+            "../../packages/fuels/tests/contracts/lib_contract/out/release/lib_contract.bin",
             LoadConfiguration::default(),
         )?
         .deploy(&wallet, TxPolicies::default())
         .await?
         .into();
 
-        let bin_path = "../../packages/fuels/tests/contracts/lib_contract_caller/out/debug/lib_contract_caller.bin";
+        let bin_path = "../../packages/fuels/tests/contracts/lib_contract_caller/out/release/lib_contract_caller.bin";
         let caller_contract_id = Contract::load_from(bin_path, LoadConfiguration::default())?
             .deploy(&wallet, TxPolicies::default())
             .await?;
@@ -455,7 +455,7 @@ mod tests {
         abigen!(Contract(
             name = "MyContract",
             // Replace with your contract ABI.json path
-            abi = "packages/fuels/tests/contracts/contract_test/out/debug/contract_test-abi.json"
+            abi = "packages/fuels/tests/contracts/contract_test/out/release/contract_test-abi.json"
         ));
         let wallet_original = launch_provider_and_get_wallet().await?;
 
@@ -485,13 +485,13 @@ mod tests {
         use fuels::prelude::*;
         abigen!(Contract(
             name = "MyContract",
-            abi = "packages/fuels/tests/contracts/contract_test/out/debug/contract_test-abi.json"
+            abi = "packages/fuels/tests/contracts/contract_test/out/release/contract_test-abi.json"
         ));
 
         let wallet = launch_provider_and_get_wallet().await?;
 
         let contract_id = Contract::load_from(
-            "../../packages/fuels/tests/contracts/contract_test/out/debug/contract_test.bin",
+            "../../packages/fuels/tests/contracts/contract_test/out/release/contract_test.bin",
             LoadConfiguration::default(),
         )?
         .deploy(&wallet, TxPolicies::default())
@@ -523,13 +523,13 @@ mod tests {
 
         abigen!(Contract(
             name = "MyContract",
-            abi = "packages/fuels/tests/contracts/contract_test/out/debug/contract_test-abi.json"
+            abi = "packages/fuels/tests/contracts/contract_test/out/release/contract_test-abi.json"
         ));
 
         let wallet = launch_provider_and_get_wallet().await?;
 
         let contract_id = Contract::load_from(
-            "../../packages/fuels/tests/contracts/contract_test/out/debug/contract_test.bin",
+            "../../packages/fuels/tests/contracts/contract_test/out/release/contract_test.bin",
             LoadConfiguration::default(),
         )?
         .deploy(&wallet, TxPolicies::default())
@@ -579,13 +579,13 @@ mod tests {
 
         abigen!(Contract(
             name = "MyContract",
-            abi = "packages/fuels/tests/contracts/contract_test/out/debug/contract_test-abi.json"
+            abi = "packages/fuels/tests/contracts/contract_test/out/release/contract_test-abi.json"
         ));
 
         let wallet = launch_provider_and_get_wallet().await?;
 
         let contract_id = Contract::load_from(
-            "../../packages/fuels/tests/contracts/contract_test/out/debug/contract_test.bin",
+            "../../packages/fuels/tests/contracts/contract_test/out/release/contract_test.bin",
             LoadConfiguration::default(),
         )?
         .deploy(&wallet, TxPolicies::default())
@@ -610,7 +610,7 @@ mod tests {
             .await?;
         // ANCHOR_END: multi_call_cost_estimation
 
-        let expected_gas = 4152;
+        let expected_gas = 3378;
 
         assert_eq!(transaction_cost.gas_used, expected_gas);
 
@@ -623,7 +623,7 @@ mod tests {
         use fuels::prelude::*;
         abigen!(Contract(
             name = "MyContract",
-            abi = "packages/fuels/tests/contracts/contract_test/out/debug/contract_test-abi.json"
+            abi = "packages/fuels/tests/contracts/contract_test/out/release/contract_test-abi.json"
         ));
 
         let config = WalletsConfig::new(Some(2), Some(1), Some(DEFAULT_COIN_AMOUNT));
@@ -632,7 +632,7 @@ mod tests {
         let wallet_2 = wallets.pop().unwrap();
 
         let contract_id = Contract::load_from(
-            "../../packages/fuels/tests/contracts/contract_test/out/debug/contract_test.bin",
+            "../../packages/fuels/tests/contracts/contract_test/out/release/contract_test.bin",
             LoadConfiguration::default(),
         )?
         .deploy(&wallet_1, TxPolicies::default())

diff --git a/examples/cookbook/src/lib.rs b/examples/cookbook/src/lib.rs
@@ -28,7 +28,8 @@ mod tests {
         // ANCHOR: liquidity_abigen
         abigen!(Contract(
             name = "MyContract",
-            abi = "packages/fuels/tests/contracts/liquidity_pool/out/debug/liquidity_pool-abi.json"
+            abi =
+                "packages/fuels/tests/contracts/liquidity_pool/out/release/liquidity_pool-abi.json"
         ));
         // ANCHOR_END: liquidity_abigen
 
@@ -52,7 +53,7 @@ mod tests {
 
         // ANCHOR: liquidity_deploy
         let contract_id = Contract::load_from(
-            "../../packages/fuels/tests/contracts/liquidity_pool/out/debug/liquidity_pool.bin",
+            "../../packages/fuels/tests/contracts/liquidity_pool/out/release/liquidity_pool.bin",
             LoadConfiguration::default(),
         )?
         .deploy(wallet, TxPolicies::default())
@@ -225,7 +226,7 @@ mod tests {
         let mut hot_wallet = WalletUnlocked::new_random(None);
         let mut cold_wallet = WalletUnlocked::new_random(None);
 
-        let code_path = "../../packages/fuels/tests/predicates/swap/out/debug/swap.bin";
+        let code_path = "../../packages/fuels/tests/predicates/swap/out/release/swap.bin";
         let mut predicate = Predicate::load_from(code_path)?;
 
         let num_coins = 5;

diff --git a/examples/debugging/src/lib.rs b/examples/debugging/src/lib.rs
@@ -30,11 +30,11 @@ mod tests {
     fn decoded_debug_matches_rust_debug() -> Result<()> {
         abigen!(Contract(
             name = "MyContract",
-            abi = "packages/fuels/tests/types/contracts/generics/out/debug/generics-abi.json"
+            abi = "packages/fuels/tests/types/contracts/generics/out/release/generics-abi.json"
         ));
 
         let json_abi_file =
-            "../../packages/fuels/tests/types/contracts/generics/out/debug/generics-abi.json";
+            "../../packages/fuels/tests/types/contracts/generics/out/release/generics-abi.json";
         let abi_file_contents = std::fs::read_to_string(json_abi_file)?;
 
         let parsed_abi: ProgramABI = serde_json::from_str(&abi_file_contents)?;

diff --git a/examples/macros/src/lib.rs b/examples/macros/src/lib.rs
@@ -8,10 +8,10 @@ mod tests {
     fn example_of_abigen_usage() {
         // ANCHOR: multiple_abigen_program_types
         abigen!(
-            Contract(name="ContractA", abi="packages/fuels/tests/bindings/sharing_types/contract_a/out/debug/contract_a-abi.json"),
-            Contract(name="ContractB", abi="packages/fuels/tests/bindings/sharing_types/contract_b/out/debug/contract_b-abi.json"),
-            Script(name="MyScript", abi="packages/fuels/tests/scripts/arguments/out/debug/arguments-abi.json"),
-            Predicate(name="MyPredicateEncoder", abi="packages/fuels/tests/predicates/basic_predicate/out/debug/basic_predicate-abi.json"),
+            Contract(name="ContractA", abi="packages/fuels/tests/bindings/sharing_types/contract_a/out/release/contract_a-abi.json"),
+            Contract(name="ContractB", abi="packages/fuels/tests/bindings/sharing_types/contract_b/out/release/contract_b-abi.json"),
+            Script(name="MyScript", abi="packages/fuels/tests/scripts/arguments/out/release/arguments-abi.json"),
+            Predicate(name="MyPredicateEncoder", abi="packages/fuels/tests/predicates/basic_predicate/out/release/basic_predicate-abi.json"),
         );
         // ANCHOR_END: multiple_abigen_program_types
     }