feat: ABI refactor

.changeset/flat-roses-lie.md

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

.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/errors/index.md

@@ -18,6 +18,12 @@ When the arguments supplied to the function do not match the minimum required in
 
 Check that the arguments supplied to the function match the required type.
 
+### `ABI_SPECIFICATION_INVALID`
+
+When the ABI specification provided is invalid.
+
+Check that the ABI specification is valid.
+
 ### `ACCOUNT_REQUIRED`
 
 When an [`Account`](https://fuels-ts-docs-api.vercel.app/classes/_fuel_ts_account.Account.html) is required for an operation. This will usually be in the form of a [`Wallet`](../wallets/index.md).
@@ -324,6 +330,12 @@ In cases where the error hasn't been mapped yet, this code will be used.
 
 If you believe you found a bug, please report the [issue](https://github.com/FuelLabs/fuels-ts/issues/new/choose) to the team.
 
+### `MATCHER_NOT_FOUND`
+
+When a matcher is not found for a given Sway type.
+
+Check that the Sway type is correct and exists in the ABI.
+
 ### `MAX_INPUTS_EXCEEDED`
 
 When the number of transaction inputs exceeds the maximum limit allowed by the blockchain.

apps/docs/src/guide/fuels-cli/commands.md

@@ -79,7 +79,7 @@ npx fuels@{{fuels}} build
 ```
 
 1.  Build all Sway programs under your `workspace` using `forc` <sup>[1](https://docs.fuel.network/docs/forc/commands/forc_build/)</sup>
-1.  Generate types for them using `fuels-typegen` <sup>[2](#fuels-typegen)</sup>
+1.  Generate types for them using `fuels typegen` <sup>[2](#fuels-typegen)</sup>
 
 ```console-vue
 npx fuels@{{fuels}} build --deploy
@@ -167,9 +167,6 @@ npx fuels@{{fuels}} help typegen
 Options:
   -i, --inputs <path|glob...>  Input paths/globals to your Abi JSON files
   -o, --output <dir>           Directory path for generated files
-  -c, --contract               Generate types for Contracts [default]
-  -s, --script                 Generate types for Scripts
-  -p, --predicate              Generate types for Predicates
   -S, --silent                 Omit output messages
 ```
 

apps/docs/src/guide/fuels-cli/generating-types.md

@@ -27,18 +27,15 @@ Generate Typescript from Sway ABI JSON files
 Options:
   -i, --inputs <path|glob...>  Input paths/globals to your ABI JSON files
   -o, --output <dir>           Directory path for generated files
-  -c, --contract               Generate types for Contracts [default]
-  -s, --script                 Generate types for Scripts
-  -p, --predicate              Generate types for Predicates
   -S, --silent                 Omit output messages
   -h, --help                   Display help
 ```
 
-## Generating Types for Contracts
+## Generating Types
 
-You can generate types for a Sway contract using the command below:
+You can generate types for a Sway program using the command below:
 
-<!-- This section should have the command to generate types for a Sway contract -->
+<!-- This section should have the command to generate types for a Sway program -->
 <!-- gen_types:example:start -->
 
 ```console
@@ -50,30 +47,15 @@ pnpm fuels typegen -i ./abis/*-abi.json -o ./types
 <!-- This section should explain the flags used in the typegen command -->
 <!-- flags:example:start -->
 
-The path after the input flag `-i` should point to the file ending in `-abi.json` produced when the contract was built.
+The path after the input flag `-i` should point to the file ending in `-abi.json` produced when the Sway program was built.
 
-The path after the output flag `-o` will be the output directory for the generated types.
+- For scripts and predicates, you'll need the bytecode of the program to be in the same folder for the command to work.
+- For contracts, the command will work without the bytecode but the corresponding `ContractFactory` file won't be generated as factories need the bytecode to operate.
 
-You can omit the `--contract` option here since it's the default.
+The path after the output flag `-o` will be the output directory for the generated types.
 
 <!-- flags:example:end -->
 
-## Generating Types for Scripts
-
-To generate types for a Sway script, use the `--script` flag:
-
-```console
-pnpm fuels typegen -i ./abis/*-abi.json -o ./types --script
-```
-
-## Generating Types for Predicates
-
-To generate types for a Sway predicate, use the `--predicate` flag:
-
-```console
-pnpm fuels typegen -i ./abis/*-abi.json -o ./types --predicate
-```
-
 ---
 
 See also:

apps/docs/src/guide/fuels-cli/using-generated-types.md

@@ -29,7 +29,7 @@ Typegen tries to resolve, auto-load, and embed the [Storage Slots](../contracts/
 After generating types via:
 
 ```console
-pnpm fuels typegen -i ./abis/*-abi.json -o ./types --script
+pnpm fuels typegen -i ./abis/*-abi.json -o ./types
 ```
 
 We can use these files like so:
@@ -41,7 +41,7 @@ We can use these files like so:
 After generating types via:
 
 ```console
-pnpm fuels typegen -i ./abis/*-abi.json -o ./types --predicate
+pnpm fuels typegen -i ./abis/*-abi.json -o ./types
 ```
 
 We can use these files like so:

apps/docs/src/guide/types/snippets/enums/using-enums-of-enums-1.ts

@@ -2,15 +2,15 @@ import { Provider, Wallet } from 'fuels';
 
 import { LOCAL_NETWORK_URL, WALLET_PVT_KEY } from '../../../../env';
 import { EchoEnumFactory } from '../../../../typegend';
-import { UserErrorInput } from '../../../../typegend/contracts/EchoEnum';
+import { UserError } from '../../../../typegend/contracts/EchoEnum';
 
 const provider = new Provider(LOCAL_NETWORK_URL);
 const wallet = Wallet.fromPrivateKey(WALLET_PVT_KEY, provider);
 const deploy = await EchoEnumFactory.deploy(wallet);
 const { contract } = await deploy.waitForResult();
 
 // #region snippet-1
-const enumParam = { UserError: UserErrorInput.InsufficientPermissions };
+const enumParam = { UserError: UserError.InsufficientPermissions };
 
 const { value } = await contract.functions.echo_error_enum(enumParam).get();
 

apps/docs/src/guide/types/snippets/enums/using-enums-of-enums-2.ts

@@ -2,15 +2,15 @@ import { Provider, Wallet } from 'fuels';
 
 import { LOCAL_NETWORK_URL, WALLET_PVT_KEY } from '../../../../env';
 import { EchoEnumFactory } from '../../../../typegend';
-import { StateErrorInput } from '../../../../typegend/contracts/EchoEnum';
+import { StateError } from '../../../../typegend/contracts/EchoEnum';
 
 const provider = new Provider(LOCAL_NETWORK_URL);
 const wallet = Wallet.fromPrivateKey(WALLET_PVT_KEY, provider);
 const deploy = await EchoEnumFactory.deploy(wallet);
 const { contract } = await deploy.waitForResult();
 
 // #region snippet-1
-const enumParam = { StateError: StateErrorInput.Completed };
+const enumParam = { StateError: StateError.Completed };
 
 const { value } = await contract.functions.echo_error_enum(enumParam).get();
 

apps/docs/src/guide/types/snippets/enums/using-sway-enums.ts

@@ -3,14 +3,14 @@ import { Provider, Wallet } from 'fuels';
 
 import { LOCAL_NETWORK_URL, WALLET_PVT_KEY } from '../../../../env';
 import { EchoEnumFactory } from '../../../../typegend';
-import { StateErrorInput } from '../../../../typegend/contracts/EchoEnum';
+import { StateError } from '../../../../typegend/contracts/EchoEnum';
 
 const provider = new Provider(LOCAL_NETWORK_URL);
 const wallet = Wallet.fromPrivateKey(WALLET_PVT_KEY, provider);
 const deploy = await EchoEnumFactory.deploy(wallet);
 const { contract } = await deploy.waitForResult();
 
-const enumParam = StateErrorInput.Completed;
+const enumParam = StateError.Completed;
 
 const { value } = await contract.functions
   .echo_state_error_enum(enumParam)

internal/check-imports/src/references.ts

@@ -37,10 +37,16 @@ import {
   arrayify,
   hexlify,
   createConfig,
+  AbiParser,
 } from 'fuels';
 
 const { log } = console;
 
+/**
+ * abi
+ */
+log(AbiParser);
+
 /**
  * abi-coder
  */

packages/abi-typegen/package.json

@@ -3,9 +3,6 @@
   "version": "0.98.0",
   "description": "Generates Typescript definitions from Sway ABI Json files",
   "author": "Fuel Labs <[email protected]> (https://fuel.network/)",
-  "bin": {
-    "fuels-typegen": "typegen.js"
-  },
   "main": "dist/index.js",
   "module": "dist/index.mjs",
   "types": "dist/index.d.ts",