feat: add Script ABIs support to Typegen

.changeset/wicked-files-thank.md

@@ -0,0 +1,5 @@
+---
+"@fuel-ts/abi-typegen": minor
+---
+
+Adding support for generating types from Script ABIs

README.md

@@ -17,7 +17,7 @@
 - [Install](#install)
 - [Import](#import)
 - [Interacting with Contracts](https://fuellabs.github.io/fuels-ts/guide/contracts/interacting-with-contracts.html)
-- [Generate Contract Types from ABI](https://fuellabs.github.io/fuels-ts/guide/abi-typegen/generate-contract-types-from-abi.html)
+- [Generate Types from ABI](https://fuellabs.github.io/fuels-ts/guide/abi-typegen/generating-types-from-abi.html)
   - [Using Generated Types](https://fuellabs.github.io/fuels-ts/guide/abi-typegen/using-generated-types.html)
 - [Deploying Contracts](https://fuellabs.github.io/fuels-ts/guide/contracts/deploying-contracts)
 - [CLI](#cli)

docs/_guide/abi-typegen/generating-types-from-abi.md

@@ -0,0 +1,64 @@
+[nav_order: 0]
+
+# Generating Types from ABI
+
+## Installation
+
+First we install `fuels` to our project:
+
+```sh
+yarn add fuels
+```
+
+## Help
+
+A first glance at the docs:
+
+```console
+$ yarn exec fuels typegen -h
+
+Usage: fuels typegen [options]
+
+generate typescript from contract 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 code for contracts [default]
+  -s, --script                 generate code for scripts
+  --silent                     omit output messages
+  -h, --help                   display help for command
+```
+
+## Generating Types for Contracts
+
+We can omit the `--contract` option here; its the default:
+
+```console
+yarn exec fuels -i ./abis/*-abi.json -o ./types
+```
+
+**Notes**
+
+- `-i`: the relative path/global to the ABI JSON file(s)
+- `-o`: the output directory for the generated types
+- `-c, --contract`: tells we want to generate types for contracts _(default, can be omitted)_
+
+## Generating Types for Scripts
+
+Note how we make use of the option `--script` in this case:
+
+```console
+yarn exec fuels -i ./abis/*-abi.json -o ./types --script
+```
+
+**Notes**
+
+- `-s, --script`: Tells we want to generate types for scripts
+
+---
+
+See also:
+
+- [Using Generated Contract Types](./using-generated-types.md#using-generated-contract-types)
+- [Using Generated Script Types](./using-generated-types.md#using-generated-script-types)

docs/_guide/abi-typegen/index.md

@@ -4,9 +4,11 @@
 
 ## The JSON ABI file
 
-Whether you want to deploy or connect to a pre-existing smart contract, the JSON ABI file is extremely important: it's what tells the SDK about the [ABI methods](https://fuellabs.github.io/sway/v{{site.data.versions.sway}}/book/introduction/sway_quickstart.html?highlight=abi#abi) in your smart contracts.
+Whether you want to deploy or connect to a pre-existing smart contract, the [JSON ABI](https://fuellabs.github.io/sway/v{{site.data.versions.sway}}/book/introduction/sway_quickstart.html?highlight=abi#abi) file is what makes it possible.
 
-For the same example Sway code as above:
+It tells the SDK about the [ABI methods](https://fuellabs.github.io/sway/v{{site.data.versions.sway}}/book/introduction/sway_quickstart.html?highlight=abi#abi) in your [Smart Contracts](https://fuellabs.github.io/sway/vv{{site.data.versions.sway}}/book/sway-program-types/smart_contracts.html) and [Scripts](https://fuellabs.github.io/sway/vv{{site.data.versions.sway}}/book/sway-program-types/scripts.html).
+
+Given the following Sway smart contract:
 
 ```rust
 contract;
@@ -22,7 +24,7 @@ impl MyContract for Contract {
 }
 ```
 
-The JSON ABI file looks like this:
+The JSON ABI file would look something like this:
 
 ```json
 $ cat out/debug/my-test-abi.json
@@ -42,4 +44,7 @@ $ cat out/debug/my-test-abi.json
 ]
 ```
 
-The Fuel TypeScript SDK will take this file as input and generate equivalent methods (and custom types if applicable) that you can call from your TypeScript code.
+See also:
+
+- [Generating Contract Types](./generating-types-from-abi.md)
+- [Generating Contract Types](./generating-types-from-abi.md)

docs/_guide/abi-typegen/using-generated-types.md

@@ -2,17 +2,51 @@
 
 # Using Generated Types
 
-See also [Generate Contract Types from ABI](./generate-contract-types-from-abi.md).
+After generating types via:
+
+```console
+yarn exec fuels -i ./abis/*-abi.json -o ./types
+```
+
+We can use these files like so:
 
 ```ts
 import { Wallet } from "fuels";
 import { MyContract__factory } from "./types";
 
 const contractId = "0x...";
-const wallet = new Wallet("0x...");
+const wallet = Wallet.fromAddress("...");
 const contract = MyContract__factory.connect(contractId, wallet);
 
 // All contract methods are available under functions with the correct types
-const { transactionId, value } = await contract.functions.my_fn(1n).call();
+const { transactionId, value } = await contract.functions.my_fn(1).call();
+
 console.log(transactionId, value);
 ```
+
+# Using Generated Script Types
+
+After generating types via:
+
+```console
+yarn exec fuels -i ./abis/*-abi.json -o ./types --script
+```
+
+We can use these files like so:
+
+```ts
+import { Wallet } from "fuels";
+import { MyScript__factory } from "./types";
+
+const wallet = Wallet.fromAddress("...");
+const script = ScriptAbi__factory.createInstance(wallet);
+
+const { value, logs } = await script.functions.main(1).call();
+
+console.log({ value, logs });
+```
+
+See also:
+
+- [Generating Types for Contracts](./generating-types-from-abi.md#generating-types-for-contracts)
+- [Generating Types for Scripts](./generating-types-from-abi.md#generating-types-for-scripts)

jest.config.ts

@@ -9,7 +9,7 @@ const config: Config.InitialOptions = {
   coveragePathIgnorePatterns: ['/dist/', '/test/', '.test.ts', '.d.ts'],
   testTimeout: 15000,
   transform: {
-    '\\.hbs': 'jest-text-transformer',
+    '\\.hbs$': 'jest-text-transformer',
   },
 };
 

packages/abi-typegen/README.md

@@ -31,13 +31,16 @@ npm add @fuel-ts/abi-typegen
 
 ```console
 $ fuels-typegen -h
-Usage: fuels-typegen -i ../out/*-abi.json -o ./generated/
+Usage: fuels-typegen [options]
+
+generate typescript from contract abi json files
 
 Options:
-  -V, --version                output the version number
   -i, --inputs <path|glob...>  input paths/globals to your abi json files
   -o, --output <dir>           directory path for generated files
-  -s, --silent                 omit output messages
+  -c, --contract               generate types for contracts [default]
+  -s, --script                 generate types for scripts
+  --silent                     omit output messages
   -h, --help                   display help for command
 ```
 
@@ -49,21 +52,22 @@ When using the package in a standalone fashion, its bin is prefixed with `fuels-
 npx fuels-typegen -i ./out/debug/*-abi.json -o ./src/contracts
 ```
 
-## Programatic API
+## Programmatic API
 
 ```ts
-import { runTypegen } from "@fuel-ts/abi-typegen";
+import { CategoryEnum, runTypegen } from "@fuel-ts/abi-typegen";
 
   const cwd = process.cwd();
   const input = './abis/**-abi.json'
   const output = './types'
   const filepaths = [ './abis/a-abi.json', './abis/b-abi.json' ]
+  const category = CategoryEnum.CONTRACT;
 
   // using input global
-  await runTypegen({ cwd, input, output });
+  await runTypegen({ cwd, input, output, category });
 
   // using filepaths' array
-  await runTypegen({ cwd, filepaths, output });
+  await runTypegen({ cwd, filepaths, output, category });
 }
 ```
 

packages/abi-typegen/package.json

@@ -33,16 +33,19 @@
   ],
   "license": "Apache-2.0",
   "dependencies": {
+    "@ethersproject/bytes": "^5.7.0",
     "@fuel-ts/versions": "workspace:*",
     "commander": "^9.4.1",
     "glob": "^8.0.3",
     "handlebars": "^4.7.7",
+    "lodash.uniq": "^4.5.0",
     "lodash.upperfirst": "^4.3.1",
     "mkdirp": "^1.0.4",
     "rimraf": "^3.0.2"
   },
   "devDependencies": {
     "@types/glob": "^8.0.0",
+    "@types/lodash.uniq": "^4.5.7",
     "@types/lodash.upperfirst": "^4.3.7",
     "@types/mkdirp": "^1.0.2",
     "@types/rimraf": "^3.0.2",