Merge branch 'master' into esdrubal/6339

docs/book/src/forc/plugins/forc_client/index.md

@@ -1,14 +1,16 @@
 # `forc-client`
 
-Forc plugin for interacting with a Fuel node. Since transactions are going to require some gas, you need to sign them with an account that has enough tokens to pay for them.
+The forc plugin for interacting with a Fuel node.
+
+Since transactions are going to require some gas, you need to sign them with an account that has enough coins to pay for them.
 
 We offer multiple ways to sign the transaction:
 
   1. Sign the transaction via your local wallet using `forc-client` which integrates with our CLI wallet, `forc-wallet`.
   2. Use the default signer to deploy to a local node
   3. Use `forc-wallet` to manually sign transactions, and copy the signed transaction back to `forc-client`.
 
-The easiest and recommended way to interact with deployed networks such as our testnets is option 1, using `forc-client` to sign your transactions which reads your default `forc-wallet` vault. For interacting with local node, we recommend using the second option, which leads `forc-client` to sign transactions with the a private key that comes pre-funded in local environments.
+The easiest and recommended way to interact with deployed networks such as our testnets is option 1, using `forc-client` to sign your transactions which reads your default `forc-wallet` vault. For interacting with local node, we recommend using the second option, which leads `forc-client` to sign transactions with the private key that comes pre-funded in local environments.
 
 ## Option 1: Sign transactions via forc-client using your local forc-wallet vault
 
@@ -37,7 +39,7 @@ As it can be seen from the example, `forc-client` asks for your password to decr
 
 ## Option 2: Using default signer
 
-If you are not interacting with a deployed network, such as testnets, your local `fuel-core` environment can be structured such that it funds an account by default. Using `--default-signer` flag with `forc-client` binaries (run, deploy) will instruct `forc-client` to sign transactions with this pre-funded account. Which makes it a useful command while working against a local node.
+If you are not interacting with a deployed network, such as testnets, your local `fuel-core` environment can be structured such that it funds an account by default. Using `--default-signer` flag with `forc-client` binaries (run, deploy) will instruct `forc-client` to sign transactions with this pre-funded account. This makes it a useful command while working against a local node.
 
 Example:
 
@@ -54,7 +56,7 @@ Example:
 
 ## Option 3: Manually signing through forc-wallet (Deprecated)
 
-This option is for creating the transaction first, signing it manually and supplying the signed transaction back to forc-client. Since it requires multiple steps, it is more error-prone and not recommended for general use case. Also this will be deprecated soon.
+This option is for creating the transaction first, signing it manually, and supplying the signed transaction back to forc-client. Since it requires multiple steps, it is more error-prone and not recommended for general use cases. Also this will be deprecated soon.
 
 1. Construct the transaction by using either `forc deploy` or `forc run`. To do so simply run `forc deploy --manual-sign` or `forc run --manual-sign` with your desired parameters. For a list of parameters please refer to the [forc-deploy](./forc_deploy.md) or [forc-run](./forc_run.md) section of the book. Once you run either command you will be asked the address of the wallet you are going to be signing with. After the address is given the transaction will be generated and you will be given a transaction ID. At this point CLI will actively wait for you to insert the signature.
 2. Take the transaction ID generated in the first step and sign it with `forc wallet sign --account <account_index> tx-id <transaction_id>`. This will generate a signature.
@@ -144,9 +146,9 @@ implicit-std = false
 enabled = true
 ```
 
-If there is no `address` field present under the proxy table, like the example above, `forc` will automatically create a proxy contract based on the [SRC-14](https://github.com/FuelLabs/sway-standards/blob/master/docs/src/src-14-simple-upgradeable-proxies.md) implementation from [sway-standards](https://github.com/FuelLabs/sway-standards). After generating and deploying the proxy contract, the target is set to the current contract, and owner of the proxy is set to the account that is signing the transaction for deployment.
+If there is no `address` field present under the proxy table, like the example above, `forc` will automatically create a proxy contract based on the [SRC-14](https://github.com/FuelLabs/sway-standards/blob/master/docs/src/src-14-simple-upgradeable-proxies.md) implementation from [sway-standards](https://github.com/FuelLabs/sway-standards). After generating and deploying the proxy contract, the target is set to the current contract, and the owner of the proxy is set to the account that is signing the transaction for deployment.
 
-This means that if you simply enable proxy in the `Forc.toml`, forc will automatically deploy a proxy contract for you and you do not need to do anything manually aside from signing the deployment transactions for the proxy contract. After deploying the proxy contract, the its address is added into the `address` field of the proxy table.
+This means that if you simply enable proxy in the `Forc.toml`, forc will automatically deploy a proxy contract for you and you do not need to do anything manually aside from signing the deployment transactions for the proxy contract. After deploying the proxy contract, the address is added into the `address` field of the proxy table.
 
 If you want to update the target of an [SRC-14](https://github.com/FuelLabs/sway-standards/blob/master/docs/src/src-14-simple-upgradeable-proxies.md) compliant proxy contract rather than deploying a new one, simply add its `address` in the `address` field, like the following example:
 

sway-core/src/ir_generation/compile.rs

@@ -322,11 +322,23 @@ pub(crate) fn compile_configurables(
             let opt_metadata = md_mgr.span_to_md(context, &decl.span);
 
             if context.experimental.new_encoding {
-                let encoded_bytes = match constant.value {
+                let mut encoded_bytes = match constant.value {
                     ConstantValue::RawUntypedSlice(bytes) => bytes,
                     _ => unreachable!(),
                 };
 
+                let config_type_info = engines.te().get(decl.type_ascription.type_id);
+                let buffer_size = match config_type_info.abi_encode_size_hint(engines) {
+                    crate::AbiEncodeSizeHint::Exact(len) => len,
+                    crate::AbiEncodeSizeHint::Range(_, len) => len,
+                    _ => unreachable!("unexpected type accepted as configurable"),
+                };
+
+                if buffer_size > encoded_bytes.len() {
+                    encoded_bytes.extend([0].repeat(buffer_size - encoded_bytes.len()));
+                }
+                assert!(encoded_bytes.len() == buffer_size);
+
                 let decode_fn = engines.de().get(decl.decode_fn.as_ref().unwrap().id());
                 let decode_fn = cache.ty_function_decl_to_unique_function(
                     engines,

test/src/e2e_vm_tests/mod.rs

@@ -16,7 +16,7 @@ use fuel_vm::fuel_tx;
 use fuel_vm::fuel_types::canonical::Input;
 use fuel_vm::prelude::*;
 use regex::Regex;
-use std::collections::HashSet;
+use std::collections::{BTreeMap, HashSet};
 use std::io::stdout;
 use std::io::Write;
 use std::str::FromStr;
@@ -336,6 +336,41 @@ impl TestContext {
                     run_and_capture_output(|| harness::compile_to_bytes(&name, &run_config)).await;
                 *output = out;
 
+                if let Ok(result) = result.as_ref() {
+                    let packages = match result {
+                        forc_pkg::Built::Package(p) => [p.clone()].to_vec(),
+                        forc_pkg::Built::Workspace(p) => p.clone(),
+                    };
+
+                    for p in packages {
+                        let bytecode_len = p.bytecode.bytes.len();
+
+                        let configurables = match &p.program_abi {
+                            sway_core::asm_generation::ProgramABI::Fuel(abi) => {
+                                abi.configurables.as_ref().cloned().unwrap_or_default()
+                            }
+                            sway_core::asm_generation::ProgramABI::Evm(_)
+                            | sway_core::asm_generation::ProgramABI::MidenVM(_) => vec![],
+                        }
+                        .into_iter()
+                        .map(|x| (x.offset, x.name))
+                        .collect::<BTreeMap<u64, String>>();
+
+                        let mut items = configurables.iter().peekable();
+                        while let Some(current) = items.next() {
+                            let next_offset = match items.peek() {
+                                Some(next) => *next.0,
+                                None => bytecode_len as u64,
+                            };
+                            let size = next_offset - current.0;
+                            output.push_str(&format!(
+                                "Configurable Encoded Bytes Buffer Size: {} {}\n",
+                                current.1, size
+                            ));
+                        }
+                    }
+                }
+
                 check_file_checker(checker, &name, output)?;
 
                 let compiled = result?;
@@ -913,7 +948,7 @@ fn parse_test_toml(path: &Path, run_config: &RunConfig) -> Result<TestDescriptio
     }
 
     // if new encoding is on, allow a "category_new_encoding"
-    // for tests that should have difference categories
+    // for tests that should have different categories
     let category = if run_config.experimental.new_encoding {
         toml_content
             .get("category_new_encoding")
@@ -956,7 +991,9 @@ fn parse_test_toml(path: &Path, run_config: &RunConfig) -> Result<TestDescriptio
     }
 
     // To allow different configs, we must ignore file check if it is not fail
-    if category != TestCategory::FailsToCompile {
+    if toml_content.get("category_new_encoding").is_some()
+        && category != TestCategory::FailsToCompile
+    {
         file_check = FileCheck("".into());
     }
 

test/src/e2e_vm_tests/test_programs/should_pass/language/configurable_consts/json_abi_oracle_new_encoding.json

@@ -7,7 +7,7 @@
         "typeArguments": null
       },
       "name": "BOOL",
-      "offset": 6968
+      "offset": 7184
     },
     {
       "configurableType": {
@@ -16,7 +16,7 @@
         "typeArguments": null
       },
       "name": "U8",
-      "offset": 7112
+      "offset": 7376
     },
     {
       "configurableType": {
@@ -25,7 +25,7 @@
         "typeArguments": null
       },
       "name": "ANOTHER_U8",
-      "offset": 6896
+      "offset": 7112
     },
     {
       "configurableType": {
@@ -34,7 +34,7 @@
         "typeArguments": null
       },
       "name": "U16",
-      "offset": 7056
+      "offset": 7320
     },
     {
       "configurableType": {
@@ -43,7 +43,7 @@
         "typeArguments": null
       },
       "name": "U32",
-      "offset": 7096
+      "offset": 7360
     },
     {
       "configurableType": {
@@ -52,7 +52,7 @@
         "typeArguments": null
       },
       "name": "U64",
-      "offset": 7104
+      "offset": 7368
     },
     {
       "configurableType": {
@@ -61,7 +61,7 @@
         "typeArguments": null
       },
       "name": "U256",
-      "offset": 7064
+      "offset": 7328
     },
     {
       "configurableType": {
@@ -70,7 +70,7 @@
         "typeArguments": null
       },
       "name": "B256",
-      "offset": 6936
+      "offset": 7152
     },
     {
       "configurableType": {
@@ -79,7 +79,7 @@
         "typeArguments": []
       },
       "name": "CONFIGURABLE_STRUCT",
-      "offset": 7008
+      "offset": 7272
     },
     {
       "configurableType": {
@@ -88,7 +88,7 @@
         "typeArguments": []
       },
       "name": "CONFIGURABLE_ENUM_A",
-      "offset": 6976
+      "offset": 7192
     },
     {
       "configurableType": {
@@ -97,7 +97,7 @@
         "typeArguments": []
       },
       "name": "CONFIGURABLE_ENUM_B",
-      "offset": 6992
+      "offset": 7232
     },
     {
       "configurableType": {
@@ -106,7 +106,7 @@
         "typeArguments": null
       },
       "name": "ARRAY_BOOL",
-      "offset": 6904
+      "offset": 7120
     },
     {
       "configurableType": {
@@ -115,7 +115,7 @@
         "typeArguments": null
       },
       "name": "ARRAY_U64",
-      "offset": 6912
+      "offset": 7128
     },
     {
       "configurableType": {
@@ -124,7 +124,7 @@
         "typeArguments": null
       },
       "name": "TUPLE_BOOL_U64",
-      "offset": 7040
+      "offset": 7304
     },
     {
       "configurableType": {
@@ -133,7 +133,7 @@
         "typeArguments": null
       },
       "name": "STR_4",
-      "offset": 7032
+      "offset": 7296
     },
     {
       "configurableType": {
@@ -142,7 +142,7 @@
         "typeArguments": null
       },
       "name": "NOT_USED",
-      "offset": 7024
+      "offset": 7288
     }
   ],
   "encoding": "1",
@@ -231,6 +231,11 @@
           "name": "B",
           "type": 12,
           "typeArguments": null
+        },
+        {
+          "name": "C",
+          "type": 4,
+          "typeArguments": null
         }
       ],
       "type": "enum ConfigurableEnum",

test/src/e2e_vm_tests/test_programs/should_pass/language/configurable_consts/src/main.sw

@@ -10,6 +10,7 @@ struct ConfigurableStruct {
 enum ConfigurableEnum {
     A: bool,
     B: u64,
+    C: b256
 }
 
 impl core::ops::Eq for ConfigurableEnum {

test/src/e2e_vm_tests/test_programs/should_pass/language/configurable_consts/test.toml

@@ -4,3 +4,19 @@ expected_result_new_encoding = { action = "return_data", value = "" }
 validate_abi = true
 expected_warnings = 1
 unsupported_profiles = ["debug"]
+
+# check: $()ANOTHER_U8 8
+# check: $()ARRAY_BOOL 8
+# check: $()ARRAY_U64 24
+# check: $()B256 32
+# check: $()BOOL 8
+# check: $()CONFIGURABLE_ENUM_A 40
+# check: $()CONFIGURABLE_ENUM_B 40
+# check: $()CONFIGURABLE_STRUCT 16
+# check: $()NOT_USED 8
+# check: $()STR_4 8
+# check: $()TUPLE_BOOL_U64 16
+# check: $()U16 8
+# check: $()U256 32
+# check: $()U32 8
+# check: $()U64 8

test/src/e2e_vm_tests/test_programs/should_pass/language/deprecated_attribute/test.toml

@@ -1,12 +1,3 @@
 category = "compile"
 
-# check: $()#[namespace(my_namespace)]
-# nextln: $()Attribute namespace is deprecated.
-# nextln: $()You can use namespaces inside storage:
-# nextln: $()storage {
-# nextln: $()my_storage_namespace {
-# nextln: $()field: u64 = 1,
-# nextln: $()}
-# nextln: $()}
-
 expected_warnings = 2