FuelLabs · Dhaiwat10 · Dec 14, 2023 · Nov 3, 2023 · Nov 3, 2023 · Nov 3, 2023
diff --git a/.changeset/odd-kids-buy.md b/.changeset/odd-kids-buy.md
@@ -0,0 +1,2 @@
+---
+---
diff --git a/.eslintignore b/.eslintignore
@@ -4,7 +4,9 @@ dist/
 out/
 
 apps/demo-fuels/src/sway-programs-api
-apps/demo-typegen/src/generated-types
+apps/demo-typegen/src/contract-types
+apps/demo-typegen/src/script-types
+apps/demo-typegen/src/predicate-types
 apps/demo-nextjs
 apps/demo-react-cra
 apps/demo-react-vite

diff --git a/.prettierignore b/.prettierignore
@@ -8,7 +8,9 @@ apps/demo-fuels/src/sway-programs-api
 apps/demo-nextjs
 apps/demo-react-cra
 apps/demo-react-vite
-apps/demo-typegen/src/generated-types
+apps/demo-typegen/src/contract-types
+apps/demo-typegen/src/script-types
+apps/demo-typegen/src/predicate-types
 apps/docs/.vitepress/cache/
 
 packages/fuels/test/fixtures/project

diff --git a/apps/demo-typegen/.gitignore b/apps/demo-typegen/.gitignore
@@ -1,5 +1,7 @@
 node_modules
-src/generated-types
+src/contract-types
+src/predicate-types
+src/script-types
 
 # Forc
 **/out/debug/**
diff --git a/apps/demo-typegen/package.json b/apps/demo-typegen/package.json
@@ -5,8 +5,14 @@
   "author": "Fuel Labs <contact@fuel.sh> (https://fuel.network/)",
   "scripts": {
     "pretest": "run-s build:forc build:types",
-    "build:forc": "pnpm fuels-forc build -p contract",
-    "build:types": "pnpm fuels typegen -i contract/out/debug/demo-contract-abi.json -o src/generated-types"
+    "build:forc": "run-p forc:*",
+    "forc:contract": "pnpm fuels-forc build -p contract",
+    "forc:script": "pnpm fuels-forc build -p script",
+    "forc:predicate": "pnpm fuels-forc build -p predicate",
+    "build:types": "run-p types:*",
+    "types:contract": "pnpm fuels typegen -i contract/out/debug/demo-contract-abi.json -o src/contract-types",
+    "types:script": "pnpm fuels typegen -i script/out/debug/script-abi.json -o src/script-types --script",
+    "types:predicate": "pnpm fuels typegen -i predicate/out/debug/predicate-abi.json -o src/predicate-types --predicate"
   },
   "license": "Apache-2.0",
   "dependencies": {

diff --git a/apps/demo-typegen/predicate/.gitignore b/apps/demo-typegen/predicate/.gitignore
@@ -0,0 +1,2 @@
+out
+target
diff --git a/apps/demo-typegen/predicate/Forc.toml b/apps/demo-typegen/predicate/Forc.toml
@@ -0,0 +1,7 @@
+[project]
+authors = ["Dhaiwat Pandya"]
+entry = "main.sw"
+license = "Apache-2.0"
+name = "predicate"
+
+[dependencies]
diff --git a/apps/demo-typegen/predicate/src/main.sw b/apps/demo-typegen/predicate/src/main.sw
@@ -0,0 +1,7 @@
+predicate;
+
+fn main(input: u8) -> bool {
+    let answer: u8 = 10;
+
+    input == answer
+}
diff --git a/apps/demo-typegen/script/.gitignore b/apps/demo-typegen/script/.gitignore
@@ -0,0 +1,2 @@
+out
+target
diff --git a/apps/demo-typegen/script/Forc.toml b/apps/demo-typegen/script/Forc.toml
@@ -0,0 +1,7 @@
+[project]
+authors = ["Dhaiwat Pandya"]
+entry = "main.sw"
+license = "Apache-2.0"
+name = "script"
+
+[dependencies]
diff --git a/apps/demo-typegen/script/src/main.sw b/apps/demo-typegen/script/src/main.sw
@@ -0,0 +1,5 @@
+script;
+
+fn main() -> u8 {
+    10
+}
diff --git a/apps/demo-typegen/src/demo.test.ts b/apps/demo-typegen/src/demo.test.ts
@@ -4,22 +4,42 @@
 import type { BN } from 'fuels';
 import { ContractFactory, Provider, toHex, BaseAssetId, Wallet, FUEL_NETWORK_URL } from 'fuels';
 
-import { DemoContractAbi__factory } from './generated-types';
-import bytecode from './generated-types/DemoContractAbi.hex';
+import storageSlots from '../contract/out/debug/demo-contract-storage_slots.json';
+
+import { DemoContractAbi__factory } from './contract-types';
+import bytecode from './contract-types/DemoContractAbi.hex';
+import { PredicateAbi__factory } from './predicate-types';
+import { ScriptAbi__factory } from './script-types';
 
 let gasPrice: BN;
 describe('ExampleContract', () => {
   beforeAll(async () => {
     const provider = await Provider.create(FUEL_NETWORK_URL);
     ({ minGasPrice: gasPrice } = provider.getGasConfig());
   });
+  it('with imported storage slots', async () => {
+    const provider = await Provider.create(FUEL_NETWORK_URL);
+    const wallet = await generateTestWallet(provider, [[500_000, BaseAssetId]]);
+
+    // #region typegen-demo-contract-storage-slots
+    // #context import storageSlots from './contract/out/debug/demo-contract-storage_slots.json';
+
+    const contract = await DemoContractAbi__factory.deployContract(bytecode, wallet, {
+      storageSlots,
+      gasPrice,
+    });
+    // #endregion typegen-demo-contract-storage-slots
+
+    expect(contract.id).toBeTruthy();
+  });
   it('should return the input', async () => {
     const provider = await Provider.create(FUEL_NETWORK_URL);
     const wallet = await generateTestWallet(provider, [[500_000, BaseAssetId]]);
 
     // Deploy
     const factory = new ContractFactory(bytecode, DemoContractAbi__factory.abi, wallet);
     const contract = await factory.deployContract({ gasPrice });
+    const contractId = contract.id;
 
     // Call
     const { value } = await contract.functions.return_input(1337).txParams({ gasPrice }).call();
@@ -28,20 +48,29 @@
     expect(value.toHex()).toEqual(toHex(1337));
 
     // You can also make a call using the factory
-    const contractInstance = DemoContractAbi__factory.connect(contract.id, wallet);
+    // #region typegen-demo-contract-factory-connect
+    // #context import { DemoContractAbi__factory } from './types';
+
+    const contractInstance = DemoContractAbi__factory.connect(contractId, wallet);
     const { value: v2 } = await contractInstance.functions
       .return_input(1337)
       .txParams({ gasPrice })
       .call();
+    // #endregion typegen-demo-contract-factory-connect
     expect(v2.toHex()).toBe(toHex(1337));
   });
 
   it('deployContract method', async () => {
     const provider = await Provider.create(FUEL_NETWORK_URL);
     const wallet = await generateTestWallet(provider, [[500_000, BaseAssetId]]);
 
+    // #region typegen-demo-contract-factory-deploy
+    // #context import { DemoContractAbi__factory } from './types';
+    // #context import bytecode from './types/DemoContractAbi.hex';
+
     // Deploy
     const contract = await DemoContractAbi__factory.deployContract(bytecode, wallet, { gasPrice });
+    // #endregion typegen-demo-contract-factory-deploy
 
     // Call
     const { value } = await contract.functions.return_input(1337).txParams({ gasPrice }).call();
@@ -79,3 +108,45 @@
 
   expect((<Error>error).message).toMatch('not enough coins to fit the target');
 });
+
+test('Example script', async () => {
+  const provider = await Provider.create(FUEL_NETWORK_URL);
+  const wallet = await generateTestWallet(provider, [[500_000, BaseAssetId]]);
+
+  // #region typegen-demo-script
+  // #context import { ScriptAbi__factory } from './types';
+
+  const script = ScriptAbi__factory.createInstance(wallet);
+  const { value } = await script.functions
+    .main()
+    .txParams({
+      gasPrice: provider.getGasConfig().minGasPrice,
+    })
+    .call();
+  // #endregion typegen-demo-script
+  // @ts-expect-error TODO: investitage - typegen is expecting value to be a number but the value being returned is the string '0xa'
+  expect(value.toNumber()).toBe(10);
+});
+
+test('Example predicate', async () => {
+  // #region typegen-demo-predicate
+  // #context import { PredicateAbi__factory } from './types';
+  const provider = await Provider.create(FUEL_NETWORK_URL);
+  const wallet1 = await generateTestWallet(provider, [[500_000, BaseAssetId]]);
+  const wallet2 = await generateTestWallet(provider, [[500_000, BaseAssetId]]);
+
+  const predicate = PredicateAbi__factory.createInstance(provider);
+
+  const tx = await wallet1.transfer(predicate.address, 100_000, BaseAssetId, {
+    gasPrice: provider.getGasConfig().minGasPrice,
+  });
+  await tx.wait();
+
+  const tx2 = await predicate.setData(10).transfer(wallet2.address, 50_000, BaseAssetId, {
+    gasPrice: provider.getGasConfig().minGasPrice,
+  });
+  await tx2.wait();
+
+  expect((await wallet2.getBalance()).toNumber()).toEqual(550_000);
+  // #endregion typegen-demo-predicate
+});
diff --git a/apps/docs/src/guide/abi-typegen/using-generated-types.md b/apps/docs/src/guide/abi-typegen/using-generated-types.md
@@ -10,49 +10,19 @@ yarn exec fuels typegen -i ./abis/*-abi.json -o ./types
 
 We can use these files like so:
 
-<!-- TODO: stop using hardcoded snippets -->
-
-```ts
-import { Wallet } from "fuels";
-import { MyContract__factory } from "./types";
-
-const contractId = "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(1).call();
-
-console.log(transactionId, value);
-```
+<<< @/../../demo-typegen/src/demo.test.ts#typegen-demo-contract-factory-connect{ts:line-numbers}
 
 ## Contract
 
 Let's use the Contract class to deploy a contract:
 
-```ts
-import { Wallet } from "fuels";
-import { MyContract__factory } from "./types";
-import bytecode from "./types/MyContract.hex.ts";
-
-const wallet = Wallet.fromAddress("...");
-
-const contract = await MyContract__factory.deployContract(bytecode, wallet);
-
-console.log(contract.id);
-```
+<<< @/../../demo-typegen/src/demo.test.ts#typegen-demo-contract-factory-deploy{ts:line-numbers}
 
 ### Autoloading of Storage Slots
 
 Typegen tries to resolve, auto-load, and embed the [Storage Slots](../contracts//storage-slots.md) for your Contract within the `MyContract__factory` class. Still, you can override it alongside other options from [`DeployContractOptions`](https://github.com/FuelLabs/fuels-ts/blob/a64b67b9fb2d7f764ab9151a21d2266bf2df3643/packages/contract/src/contract-factory.ts#L19-L24), when calling the `deployContract` method:
 
-```ts
-import storageSlots from "../contract/out/debug/storage-slots.json";
-
-const contract = await MyContract__factory.deployContract(bytecode, wallet, {
-  storageSlots,
-});
-```
+<<< @/../../demo-typegen/src/demo.test.ts#typegen-demo-contract-storage-slots{ts:line-numbers}
 
 ## Script
 
@@ -64,58 +34,19 @@ yarn exec fuels typegen -i ./abis/*-abi.json -o ./types --script
 
 We can use these files like so:
 
-<!-- TODO: stop using hardcoded snippets -->
-
-```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 });
-```
+<<< @/../../demo-typegen/src/demo.test.ts#typegen-demo-script{ts:line-numbers}
 
 ## Predicate
 
-Consider the following predicate:
-
-<<< @/../../../packages/fuel-gauge/fixtures/forc-projects/predicate-main-args-struct/src/main.sw#Predicate-main-args{ts:line-numbers}
-
-Now, after generating types via:
+After generating types via:
 
 ```console
 yarn exec fuels typegen -i ./abis/*-abi.json -o ./types --predicate
 ```
 
 We can use these files like so:
 
-<!-- TODO: stop using hardcoded snippets -->
-
-```ts
-import { Wallet } from "fuels";
-import { MyPredicate__factory } from "./types";
-
-const wallet = Wallet.fromAddress("...");
-const predicate = MyPredicate__factory.createInstance();
-
-await predicate
-  .setData({
-    has_account: true,
-    total_complete: 100,
-  })
-  .transfer(wallet.address, <amount>);
-
-const walletBalance = await wallet.getBalance();
-const predicateBalance = await predicate.getBalance();
-
-console.log({
-  walletBalance,
-  predicateBalance,
-});
-```
+<<< @/../../demo-typegen/src/demo.test.ts#typegen-demo-predicate{ts:line-numbers}
 
 See also:
 

diff --git a/nodemon.config.json b/nodemon.config.json
@@ -10,6 +10,8 @@
     "**/Forc.lock",
     "**/getBuiltinVersions.ts",
     "**/out/debug/**",
-    "apps/demo-typegen/src/generated-types/**"
+    "apps/demo-typegen/src/contract-types/**",
+    "apps/demo-typegen/src/predicate-types/**",
+    "apps/demo-typegen/src/script-types/**"
   ]
 }