feat!: ABI Gen

.changeset/poor-years-hang.md

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

.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

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/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 = await Provider.create(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/fuels-cli/commands.md

@@ -73,7 +73,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
@@ -157,9 +157,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 = await Provider.create(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 = await Provider.create(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 = await Provider.create(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)

packages/abi-typegen/package.json

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

packages/abi/package.json

@@ -11,11 +11,26 @@
   "engines": {
     "node": "^18.20.3 || ^20.0.0 || ^22.0.0"
   },
+  "bin": {
+    "fuels-typegen": "typegen.js"
+  },
   "exports": {
     ".": {
       "require": "./dist/index.js",
       "import": "./dist/index.mjs",
       "types": "./dist/index.d.ts"
+    },
+    "./cli": {
+      "types": "./dist/cli.d.ts",
+      "require": "./dist/cli.js",
+      "import": "./dist/cli.mjs"
+    }
+  },
+  "typesVersions": {
+    "*": {
+      "cli": [
+        "./dist/cli.d.ts"
+      ]
     }
   },
   "files": [
@@ -27,7 +42,11 @@
   },
   "dependencies": {
     "@fuel-ts/errors": "workspace:*",
-    "@fuel-ts/utils": "workspace:*"
+    "@fuel-ts/utils": "workspace:*",
+    "@fuel-ts/versions": "workspace:*",
+    "handlebars": "^4.7.8",
+    "commander": "12.1.0",
+    "glob": "^10.4.5"
   },
   "devDependencies": {}
 }

packages/abi/src/bin.ts

@@ -0,0 +1,15 @@
+import { getBinaryVersions } from '@fuel-ts/versions/cli';
+import { Command } from 'commander';
+
+import { configureTypegenCliOptions } from './cli';
+
+const program = new Command();
+
+program.name('fuels-typegen');
+program.version(getBinaryVersions().FUELS);
+program.usage(`-i ../out/*-abi.json -o ./generated/`);
+program.option('-S, --silent', 'Omit output messages', false);
+
+configureTypegenCliOptions(program);
+
+program.parse(process.argv);

packages/abi/src/cli.ts

@@ -0,0 +1 @@
+export * from './gen/cli';

packages/abi/src/gen/abi-gen-types.ts

@@ -1 +1,55 @@
-// Placeholder
+import type { BinaryVersions } from '@fuel-ts/versions';
+
+import type { Abi } from '../parser';
+
+export interface AbiGenInput {
+  /**
+   * The details of the program to generate the files for.
+   */
+  programDetails: ProgramDetails[];
+  /**
+   * The versions of the binaries used to generate the files.
+   */
+  versions: BinaryVersions;
+  /**
+   * The mode to generate the files in.
+   * Defaults to 'ts' which generates typescript files.
+   */
+  mode?: 'ts';
+}
+
+export interface AbiGenResult {
+  /**
+   * The filename of the generated file.
+   */
+  filename: string;
+  /**
+   * The content of the generated file.
+   */
+  content: string;
+}
+
+export interface ProgramDetails {
+  /**
+   * The name of the program to generate files for.
+   * This will be used to name the generated files,
+   * as well as throughout the generated code.
+   */
+  name: string;
+  /**
+   * The compressed bytecode of the program in base64 format.
+   */
+  binCompressed?: string;
+  /**
+   * The abi of the program in the format returned via `AbiParser`.
+   */
+  abi: Abi;
+  /**
+   * The original abi contents in string format.
+   */
+  abiContents: string;
+  /**
+   * The storage slots, if working with a contract.
+   */
+  storageSlots?: string;
+}

packages/abi/src/gen/abi-gen.ts

@@ -1 +1,19 @@
-export class AbiGen {}
+import type { AbiGenInput, AbiGenResult } from './abi-gen-types';
+import { getRenderer } from './renderers/getRenderer';
+
+/**
+ * The main class to generate files for given sway programs.
+ * These contents of these generated files make it easier to interact
+ * with the sway programs, because type definitions are added,
+ * as well as some automatic loading is done for the user.
+ */
+export class AbiGen {
+  /**
+   * @returns an array of generated files for the given program details.
+   * They can be saved to disk as-is or further processed.
+   */
+  public static generate({ programDetails, mode, versions }: AbiGenInput): AbiGenResult[] {
+    const render = getRenderer(mode);
+    return render(programDetails, versions);
+  }
+}

packages/abi/src/gen/cli/index.ts

@@ -0,0 +1 @@
+export { configureTypegenCliOptions, runTypegen } from './run';