feat!: adding abi transpiler

.changeset/odd-horses-cheer.md

@@ -0,0 +1,9 @@
+---
+"@fuel-ts/abi-coder": minor
+"@fuel-ts/abi-typegen": minor
+"@fuel-ts/versions": minor
+"@internal/forc": minor
+"create-fuels": minor
+---
+
+feat!: adding `abi` transpiler

apps/docs-snippets/src/guide/encoding/encode-and-decode.test.ts

@@ -1,7 +1,9 @@
-import { AbiCoder, Script, ReceiptType, arrayify, buildFunctionResult } from 'fuels';
-import type { JsonAbi, JsonAbiArgument, TransactionResultReturnDataReceipt } from 'fuels';
+import type { JsonAbi, TransactionResultReturnDataReceipt } from 'fuels';
+import { buildFunctionResult, ReceiptType, arrayify, Script, Interface } from 'fuels';
 import { launchTestNode } from 'fuels/test-utils';
 
+// eslint-disable-next-line @typescript-eslint/ban-ts-comment
+// @ts-ignore JSONC extension requires mapping but behaves fine
 import abiSnippet from '../../../test/fixtures/abi/encode-and-decode.jsonc';
 import { SumScript as factory } from '../../../test/typegen/scripts/SumScript';
 
@@ -27,7 +29,7 @@ describe('encode and decode', () => {
     // First we need to build out the transaction via the script that we want to encode.
     // For that we'll need the ABI and the bytecode of the script
     const abi: JsonAbi = factory.abi;
-    const bytecode: string = factory.bytecode;
+    const bytecode = factory.bytecode;
 
     // Create the invocation scope for the script call, passing the initial
     // value for the configurable constant
@@ -42,18 +44,21 @@ describe('encode and decode', () => {
     // #endregion encode-and-decode-3
 
     // #region encode-and-decode-4
-    // #import { JsonAbiArgument, AbiCoder};
+    // #import { Interface };
 
     // Now we can encode the argument we want to pass to the function. The argument is required
-    // as a function parameter for all `AbiCoder` functions and we can extract it from the ABI itself
-    const argument: JsonAbiArgument = abi.functions
+    // as a function parameter for all abi functions and we can extract it from the ABI itself
+    const argument = abi.functions
       .find((f) => f.name === 'main')
-      ?.inputs.find((i) => i.name === 'inputted_amount') as JsonAbiArgument;
+      ?.inputs.find((i) => i.name === 'inputted_amount')?.concreteTypeId as string;
 
-    // Using the `AbiCoder`'s `encode` method,  we can now create the encoding required for
-    // a u32 which takes 4 bytes up of property space
+    // The `Interface` class is the entry point for encoding and decoding all things abi-related.
+    // We will use its `encodeType` method and create the encoding required for
+    // a u32 which takes 4 bytes up of property space.
+
+    const abiInterface = new Interface(abi);
     const argumentToAdd = 10;
-    const encodedArguments = AbiCoder.encode(abi, argument, [argumentToAdd]);
+    const encodedArguments = abiInterface.encodeType(argument, [argumentToAdd]);
     // Therefore the value of 10 will be encoded to:
     // Uint8Array([0, 0, 0, 10]
 
@@ -72,7 +77,7 @@ describe('encode and decode', () => {
     // #endregion encode-and-decode-4
 
     // #region encode-and-decode-5
-    // #import { AbiCoder, ReceiptType, TransactionResultReturnDataReceipt, arrayify, buildFunctionResult };
+    // #import { ReceiptType, TransactionResultReturnDataReceipt, arrayify, buildFunctionResult };
 
     // Get result of the transaction, including the contract call result. For this we'll need
     // the previously created invocation scope, the transaction response and the script
@@ -99,8 +104,8 @@ describe('encode and decode', () => {
     // returnData = new Uint8Array([0, 0, 0, 20]
 
     // And now we can decode the returned bytes in a similar fashion to how they were
-    // encoded, via the `AbiCoder`
-    const [decodedReturnData] = AbiCoder.decode(abi, argument, returnData, 0);
+    // encoded, via the `Interface`
+    const [decodedReturnData] = abiInterface.decodeType(argument, returnData);
     // 20
     // #endregion encode-and-decode-5
 

apps/docs-snippets/src/guide/transactions/transaction-request.test.ts

@@ -210,7 +210,7 @@ describe('Transaction Request', () => {
     // #endregion transaction-request-7
 
     expect(transactionId).toBe(
-      '0x5e12f588de0cbf2ec0f085078880d5eeb3e18cd239a288d4a06ee4247a97e4f2'
+      '0xf62e682e05fa17455999758d00875449bd6f06cdbe003a6431aa944f2d652642'
     );
   });
 });

apps/docs-snippets/test/fixtures/abi/encode-and-decode.jsonc

@@ -1,29 +1,25 @@
 // #region encode-and-decode-2
 {
-  "encoding": "1",
-  "types": [
+  "programType": "script",
+  "specVersion": "1",
+  "encodingVersion": "1",
+  "concreteTypes": [
     {
-      "typeId": 0,
       "type": "u32",
-      "components": null,
-      "typeParameters": null,
+      "concreteTypeId": "d7649d428b9ff33d188ecbf38a7e4d8fd167fa01b2e10fe9a8f9308e52f1d7cc",
     },
   ],
+  "metadataTypes": [],
   "functions": [
     {
       "inputs": [
         {
           "name": "inputted_amount",
-          "type": 0,
-          "typeArguments": null,
+          "concreteTypeId": "d7649d428b9ff33d188ecbf38a7e4d8fd167fa01b2e10fe9a8f9308e52f1d7cc",
         },
       ],
       "name": "main",
-      "output": {
-        "name": "",
-        "type": 0,
-        "typeArguments": null,
-      },
+      "output": "d7649d428b9ff33d188ecbf38a7e4d8fd167fa01b2e10fe9a8f9308e52f1d7cc",
       "attributes": null,
     },
   ],
@@ -32,14 +28,9 @@
   "configurables": [
     {
       "name": "AMOUNT",
-      "configurableType": {
-        "name": "",
-        "type": 0,
-        "typeArguments": null,
-      },
-      "offset": 856,
+      "concreteTypeId": "d7649d428b9ff33d188ecbf38a7e4d8fd167fa01b2e10fe9a8f9308e52f1d7cc",
+      "offset": 920,
     },
   ],
 }
-
 // #endregion encode-and-decode-2

apps/docs-snippets/test/fixtures/forc-projects/predicate-signing/src/main.sw

@@ -4,7 +4,7 @@ predicate;
 use std::{b512::B512, ecr::ec_recover_address, tx::{tx_id, tx_witness_data}};
 
 fn main(signer: b256) -> bool {
-    let witness_data: B512 = tx_witness_data(1);
+    let witness_data: B512 = tx_witness_data(1).unwrap();
     let address: b256 = ec_recover_address(witness_data, tx_id()).unwrap().bits();
     return address == signer;
 }

apps/docs-snippets/test/fixtures/forc-projects/script-signing/src/main.sw

@@ -4,7 +4,7 @@ script;
 use std::{b512::B512, ecr::ec_recover_address, tx::{tx_id, tx_witness_data}};
 
 fn main(signer: b256) -> bool {
-    let witness_data: B512 = tx_witness_data(1);
+    let witness_data: B512 = tx_witness_data(1).unwrap();
     let address: b256 = ec_recover_address(witness_data, tx_id()).unwrap().bits();
     return address == signer;
 }

apps/docs/spell-check-custom-words.txt

@@ -1,5 +1,6 @@
 ABI
 ABIs
+ABI's
 ASM
 AssetId
 IDE

apps/docs/src/guide/encoding/encode-and-decode.md

@@ -1,16 +1,13 @@
 # Encode and Decode
 
-In order to interact with the FuelVM, types must be encoded and decoded as per the [argument encoding specification](https://docs.fuel.network/docs/specs/abi/argument-encoding/). The SDK provides the `AbiCoder` class to encode and decode data.
+To interact with the FuelVM, types must be encoded and decoded per the [argument encoding specification](https://docs.fuel.network/docs/specs/abi/argument-encoding/). The SDK provides the `Interface` class to encode and decode data.
 
-It has three static methods:
+The relevant methods of `Interface` are:
 
-- `encode`
-- `decode`
-- `getCoder`
+- `encodeType`
+- `decodeType`
 
-The methods `encode` and `decode` describe the aforementioned process, while `getCoder` returns an instance of the internal coder required to serialize the passed type. This coder is then used internally by the `encode` and `decode` methods.
-
-All methods expect you to pass the [ABI](https://docs.fuel.network/docs/specs/abi/json-abi-format/) and ABI Argument as function parameters to deduce the specific type coders that will be required to parse the data.
+The `Interface` class requires you to pass the [ABI](https://docs.fuel.network/docs/specs/abi/json-abi-format/) on initialization. Both methods accept a `concreteTypeId`, which must exist in the ABI's `concreteTypes` array. After that, a suitable coder will be assigned to encode/decode that type.
 
 Imagine we are working with the following script that returns the sum of two `u32` integers:
 
@@ -26,7 +23,7 @@ It will produce the following ABI:
 
 <<< @/../../docs-snippets/test/fixtures/abi/encode-and-decode.jsonc#encode-and-decode-2{json:line-numbers}
 
-Now, let's prepare some data to pass to the `main` function to retrieve the combined integer. The function expects and returns a `u32` integer. So here, we will encode the `u32` to pass it to the function and receive the same `u32` back, as bytes, that we'll use for decoding. We can do both of these with the `AbiCoder`.
+Now, let's prepare some data to pass to the `main` function to retrieve the combined integer. The function expects and returns a `u32` integer. So here, we will encode the `u32` to pass it to the function and receive the same `u32` back, as bytes, that we'll use for decoding. We can do both of these with the `Interface`.
 
 First, let's prepare the transaction:
 

internal/forc/VERSION

@@ -1 +1 @@
-0.62.0
+0.63.1

internal/forc/lib/shared.js

@@ -52,18 +52,27 @@ const swayRepoUrl = 'https://github.com/fuellabs/sway.git';
 
 export const buildFromGitBranch = (branchName) => {
   const swayRepoDir = join(__dirname, '..', 'sway-repo');
-  const swayRepoDebugDir = join(swayRepoDir, 'target', 'debug');
+  const swayRepoReleaseDir = join(swayRepoDir, 'target', 'release');
   const stdioOpts = { stdio: 'inherit' };
 
   if (existsSync(swayRepoDir)) {
-    execSync(`cd ${swayRepoDir} && git fetch origin && git checkout ${branchName}`, stdioOpts);
-    execSync(`cd ${swayRepoDir} && cargo build`, stdioOpts);
+    execSync(
+      [
+        `cd ${swayRepoDir}`,
+        `git fetch origin`,
+        `git checkout ${branchName}`,
+        `git pull origin ${branchName}`,
+      ].join('&&'),
+      stdioOpts
+    );
+
+    execSync(`cd ${swayRepoDir} && cargo build --release`, stdioOpts);
   } else {
     execSync(`git clone --branch ${branchName} ${swayRepoUrl} ${swayRepoDir}`, stdioOpts);
-    execSync(`cd ${swayRepoDir} && cargo build`, stdioOpts);
+    execSync(`cd ${swayRepoDir} && cargo build --release`, stdioOpts);
   }
 
-  const [from, to] = [swayRepoDebugDir, forcBinDirPath];
+  const [from, to] = [swayRepoReleaseDir, forcBinDirPath];
 
   rmSync(to, { recursive: true, force: true });
   mkdirSync(to, { recursive: true });

internal/fuel-core/lib/shared.js

@@ -51,23 +51,23 @@ const fuelCoreRepoUrl = 'https://github.com/fuellabs/fuel-core.git';
 
 export const buildFromGitBranch = (branchName) => {
   const fuelCoreRepoDir = join(__dirname, '..', 'fuel-core-repo');
-  const fuelCoreRepoDebugDir = join(fuelCoreRepoDir, 'target', 'debug');
+  const fuelCoreRepoReleaseDir = join(fuelCoreRepoDir, 'target', 'release');
   const stdioOpts = { stdio: 'inherit' };
 
   if (existsSync(fuelCoreRepoDir)) {
-    spawnSync('git', ['pull'], { cwd: fuelCoreRepoDir, ...stdioOpts });
     spawnSync('git', ['checkout', branchName], { cwd: fuelCoreRepoDir, ...stdioOpts });
-    spawnSync('cargo', ['build'], { cwd: fuelCoreRepoDir, ...stdioOpts });
+    spawnSync('git', ['pull'], { cwd: fuelCoreRepoDir, ...stdioOpts });
+    spawnSync('cargo', ['build', '--release'], { cwd: fuelCoreRepoDir, ...stdioOpts });
   } else {
     spawnSync(
       'git',
       ['clone', '--branch', branchName, fuelCoreRepoUrl, fuelCoreRepoDir],
       stdioOpts
     );
-    spawnSync('cargo', ['build'], { cwd: fuelCoreRepoDir, ...stdioOpts });
+    spawnSync('cargo', ['build', '--release'], { cwd: fuelCoreRepoDir, ...stdioOpts });
   }
 
-  const [from, to] = [fuelCoreRepoDebugDir, fuelCoreBinDirPath];
+  const [from, to] = [fuelCoreRepoReleaseDir, fuelCoreBinDirPath];
 
   rmSync(to, { recursive: true, force: true });
   mkdirSync(to, { recursive: true });

packages/abi-coder/src/AbiCoder.ts

@@ -2,11 +2,11 @@ import { ResolvedAbiType } from './ResolvedAbiType';
 import type { DecodedValue, InputValue, Coder } from './encoding/coders/AbstractCoder';
 import { getCoderForEncoding } from './encoding/strategies/getCoderForEncoding';
 import type { EncodingOptions } from './types/EncodingOptions';
-import type { JsonAbi, JsonAbiArgument } from './types/JsonAbi';
+import type { JsonAbiOld, JsonAbiArgument } from './types/JsonAbi';
 
 export abstract class AbiCoder {
   static getCoder(
-    abi: JsonAbi,
+    abi: JsonAbiOld,
     argument: JsonAbiArgument,
     options: EncodingOptions = {
       padToWordSize: false,
@@ -17,7 +17,7 @@ export abstract class AbiCoder {
   }
 
   static encode(
-    abi: JsonAbi,
+    abi: JsonAbiOld,
     argument: JsonAbiArgument,
     value: InputValue,
     options?: EncodingOptions
@@ -26,7 +26,7 @@ export abstract class AbiCoder {
   }
 
   static decode(
-    abi: JsonAbi,
+    abi: JsonAbiOld,
     argument: JsonAbiArgument,
     data: Uint8Array,
     offset: number,