feat: ABI refactor

.changeset/flat-roses-lie.md

@@ -0,0 +1,4 @@
+---
+---
+
+feat: ABI refactor

.changeset/nice-books-tease.md

@@ -0,0 +1,2 @@
+---
+---

.changeset/poor-years-hang.md

@@ -0,0 +1,6 @@
+---
+"@fuel-ts/abi": minor
+"fuels": minor
+---
+
+feat!: ABI Gen

.changeset/tender-tigers-fry.md

@@ -0,0 +1,7 @@
+---
+"@fuel-ts/abi": patch
+"fuels": patch
+"@fuel-ts/errors": patch
+---
+
+feat: ABI parser

.github/actions/test-setup/action.yaml

@@ -39,6 +39,12 @@ runs:
       with:
         bun-version: ${{ inputs.bun-version }}
 
+    - name: Set forc and fuel-core paths
+      shell: bash
+      run: |
+        echo "$GITHUB_WORKSPACE/internal/forc/forc-binaries" >> $GITHUB_PATH
+        echo "$GITHUB_WORKSPACE/internal/fuel-core/fuel-core-binaries" >> $GITHUB_PATH
+
     - name: Build
       run: pnpm build
       shell: bash

.github/workflows/test.yaml

@@ -92,6 +92,7 @@ jobs:
           PUBLISHED_NPM_TAG: next
 
   e2e:
+    if: false
     runs-on: ubuntu-latest
     timeout-minutes: 25
     needs: [environments]

.knip.json

@@ -8,7 +8,7 @@
     "fuels",
     "bun",
     "@types/rimraf",
-    "@fuel-ts/abi-typegen",
+    "@fuel-ts/abi",
     "@internal/fuel-core",
     "get-graphql-schema",
     "events",

apps/demo-typegen/package.json

@@ -11,8 +11,8 @@
     "forc:predicate": "pnpm fuels-forc build -p demo-predicate --release",
     "build:types": "run-p types:*",
     "types:contract": "pnpm fuels typegen -i demo-contract/out/release/demo-contract-abi.json -o src/contract-types",
-    "types:script": "pnpm fuels typegen -i demo-script/out/release/demo-script-abi.json -o src/script-types --script",
-    "types:predicate": "pnpm fuels typegen -i demo-predicate/out/release/demo-predicate-abi.json -o src/predicate-types --predicate"
+    "types:script": "pnpm fuels typegen -i demo-script/out/release/demo-script-abi.json -o src/script-types",
+    "types:predicate": "pnpm fuels typegen -i demo-predicate/out/release/demo-predicate-abi.json -o src/predicate-types"
   },
   "license": "Apache-2.0",
   "dependencies": {

apps/demo-typegen/src/demo.test.ts

@@ -2,11 +2,9 @@
 import { toHex, Address, Wallet, FuelError, ErrorCode } from 'fuels';
 import { expectToThrowFuelError, launchTestNode } from 'fuels/test-utils';
 
-import storageSlots from '../demo-contract/out/release/demo-contract-storage_slots.json';
-
 import { DemoContract, DemoContractFactory } from './contract-types';
 import { DemoPredicate } from './predicate-types';
-import type { DemoPredicateInputs } from './predicate-types/DemoPredicate';
+import type { DemoPredicateInputs } from './predicate-types/predicates/DemoPredicate';
 import { DemoScript } from './script-types';
 
 /**
@@ -25,7 +23,7 @@ describe('ExampleContract', () => {
     // #context import { DemoContractFactory } from './sway-programs-api';
 
     const { waitForResult } = await DemoContractFactory.deploy(wallet, {
-      storageSlots,
+      storageSlots: DemoContractFactory.storageSlots,
     });
 
     const { contract } = await waitForResult();

apps/docs-api/index.md

@@ -12,6 +12,9 @@
 
 # Modules
 
+<!-- TODO: uncomment once deployed -->
+<!-- - [abi](https://fuels-ts-docs-api.vercel.app/modules/_fuel_ts_abi.html) -->
+
 - [abi-coder](https://fuels-ts-docs-api.vercel.app/modules/_fuel_ts_abi_coder.html)
 - [abi-typegen](https://fuels-ts-docs-api.vercel.app/modules/_fuel_ts_abi_typegen.html)
 - [account](https://fuels-ts-docs-api.vercel.app/modules/_fuel_ts_account.html)

apps/docs-api/typedoc.json

@@ -2,6 +2,7 @@
   "$schema": "https://typedoc.org/schema.json",
   "entryPointStrategy": "packages",
   "entryPoints": [
+    "../../packages/abi",
     "../../packages/abi-coder",
     "../../packages/abi-typegen",
     "../../packages/address",

apps/docs/.vitepress/config.ts

@@ -441,6 +441,10 @@ export default defineConfig({
                 text: 'Optimized React Example',
                 link: '/guide/cookbook/optimized-react-example',
               },
+              {
+                text: 'Working with the ABI',
+                link: '/guide/cookbook/working-with-the-abi',
+              },
             ],
           },
           {

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

@@ -343,4 +343,5 @@ Workspaces
 WSL
 XOR
 XORs
-YAML
+YAML
+matcher

apps/docs/src/guide/contracts/snippets/proxy-contracts.ts

@@ -1,10 +1,5 @@
 // #region proxy-2
-import {
-  Provider,
-  Wallet,
-  Src14OwnedProxy,
-  Src14OwnedProxyFactory,
-} from 'fuels';
+import { Provider, Wallet, Src14OwnedProxyFactory } from 'fuels';
 
 import { LOCAL_NETWORK_URL, WALLET_PVT_KEY } from '../../../env';
 import {
@@ -28,7 +23,7 @@ const { contract: counterContract } = await deploy.waitForResult();
  * initialize the storage slots.
  */
 const storageSlots = counterContractFactory.storageSlots.concat(
-  Src14OwnedProxy.storageSlots
+  Src14OwnedProxyFactory.storageSlots
 );
 /**
  * These configurables are specific to our recommended SRC14 compliant

apps/docs/src/guide/contracts/snippets/storage-slots/override-storage-slots.ts

@@ -2,16 +2,13 @@
 import { Provider, Wallet } from 'fuels';
 
 import { LOCAL_NETWORK_URL, WALLET_PVT_KEY } from '../../../../env';
-import {
-  StorageTestContract,
-  StorageTestContractFactory,
-} from '../../../../typegend';
+import { StorageTestContractFactory } from '../../../../typegend';
 
 const provider = new Provider(LOCAL_NETWORK_URL);
 const deployer = Wallet.fromPrivateKey(WALLET_PVT_KEY, provider);
 
 const deploymentTx = await StorageTestContractFactory.deploy(deployer, {
-  storageSlots: StorageTestContract.storageSlots,
+  storageSlots: StorageTestContractFactory.storageSlots,
 });
 
 await deploymentTx.waitForResult();

apps/docs/src/guide/cookbook/snippets/parsing-the-abi.ts

@@ -0,0 +1,9 @@
+// #region full
+import { AbiParser } from 'fuels';
+import type { Abi, AbiSpecificationV1 } from 'fuels';
+
+import { Counter } from '../../../typegend';
+
+const parsedAbi: Abi = AbiParser.parse(Counter.abi as AbiSpecificationV1);
+// #endregion full
+console.log('Parsed ABI:', parsedAbi);

apps/docs/src/guide/cookbook/working-with-the-abi.md

@@ -0,0 +1,11 @@
+# Working with the ABI
+
+Building a Sway program with `forc build` outputs multiple files, one of which is a JSON representation of the program's ABI. Because ABI specifications can change from one `forc` version to another, working directly with the ABI is cumbersome due to having to manage all ABI specification versions in order to ensure proper functionality.
+
+<!-- TODO: fix links once it's live -->
+<!-- AbiParser:  https://fuels-ts-docs-api.vercel.app/classes/_fuel_ts_abi.AbiParser.html-->
+<!-- ABI: https://fuels-ts-docs-api.vercel.app/interfaces/_fuel_ts_abi.Abi.html -->
+
+To mitigate this, The SDK provides [`AbiParser`](#working-with-the-abi) which can parse all ABI specification versions and output an object that conforms to the [`Abi`](#working-with-the-abi) interface. The SDK also internally uses this `Abi` interface for implementing its encoding/decoding and TS type generation.
+
+<<< @./snippets/parsing-the-abi.ts#full{ts:line-numbers}

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

@@ -1,13 +1,13 @@
 # Encode and Decode
 
-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.
+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 `AbiCoder` class to encode and decode data.
 
-The relevant methods of `Interface` are:
+To encode and decode types, the `AbiCoder` class provides the `getType` method which returns a `AbiCoderType` instance that provides the following methods:
 
-- `encodeType`
-- `decodeType`
+- `encode`
+- `decode`
 
-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.
+The `AbiCoder` 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:
 
@@ -23,7 +23,7 @@ It will produce the following ABI:
 
 <<< @./snippets/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 `Interface`.
+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`.
 
 First, let's prepare the transaction:
 

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

@@ -1,12 +1,15 @@
 /* eslint-disable @typescript-eslint/no-unused-vars */
 // #region full
-import type { JsonAbi, TransactionResultReturnDataReceipt } from 'fuels';
+import type {
+  AbiSpecification,
+  TransactionResultReturnDataReceipt,
+} from 'fuels';
 import {
   buildFunctionResult,
   ReceiptType,
   arrayify,
   Script,
-  Interface,
+  AbiCoder,
   Provider,
   Wallet,
 } from 'fuels';
@@ -20,7 +23,7 @@ const wallet = Wallet.fromPrivateKey(WALLET_PVT_KEY, provider);
 
 // 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 = ScriptSum.abi;
+const abi: AbiSpecification = ScriptSum.abi;
 const bytecode = ScriptSum.bytecode;
 
 // Create the invocation scope for the script call, passing the initial
@@ -43,13 +46,13 @@ const argument = abi.functions
   .find((f) => f.name === 'main')
   ?.inputs.find((i) => i.name === 'inputted_amount')?.concreteTypeId as string;
 
-// The `Interface` class (imported from `fuels`) 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.
+// The `AbiCoder` class (imported from `fuels`) is the entry point for encoding and decoding all things abi-related.
+// We will use its `getType` method to get the coder for the argument and then call its `encode` method to
+// create the encoding required for a u32 which takes 4 bytes up of property space.
 
-const abiInterface = new Interface(abi);
+const abiCoder = AbiCoder.fromAbi(abi);
 const argumentToAdd = 10;
-const encodedArguments = abiInterface.encodeType(argument, [argumentToAdd]);
+const encodedArguments = abiCoder.getType(argument).encode([argumentToAdd]);
 // Therefore the value of 10 will be encoded to:
 // Uint8Array([0, 0, 0, 10]
 
@@ -91,10 +94,13 @@ const returnData = arrayify(returnDataReceipt.data);
 // 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 `Interface`
-const [decodedReturnData] = abiInterface.decodeType(argument, returnData);
+// encoded, via the `AbiCoder`
+const decodedReturnData = abiCoder.getType(argument).decode(returnData);
 // 20
 
 const totalValue = argumentToAdd + initialValue;
 // #endregion encode-and-decode-5
 // #endregion full
+
+console.log('decodedReturnData should be 20', decodedReturnData === 20);
+console.log('totalValue should be 20', totalValue === 20);