Fuel TS SDK

Icon HelpCircleForumIcon Link

⌘K

Icon HelpCircleForumIcon Link

Docs /

Nightly /

Fuels Ts /

Fuels CLI /

Using Generated Types

Icon LinkUsing Generated Types

After generating types via:

pnpm fuels typegen -i ./abis/*-abi.json -o ./types

We can use these files like so:

import { DemoContract } from './sway-programs-api';
 
const contractInstance = new DemoContract(contractId, wallet);
const call2 = await contractInstance.functions.return_input(1337).call();
const { value: v2 } = await call2.waitForResult();

Icon LinkContract

Let's use the Contract class to deploy a contract:

import { DemoContract } from './sway-programs-api';
 
// Deploy
const deploy = await DemoContractFactory.deploy(wallet);
const { contract } = await deploy.waitForResult();

Icon LinkAutoloading of Storage Slots

Typegen tries to resolve, auto-load, and embed the Storage Slots for your Contract within the MyContract class. Still, you can override it alongside other options from DeployContractOptions Icon Link, when calling the deploy method:

import { DemoContractFactory } from './sway-programs-api';
 
const { waitForResult } = await DemoContractFactory.deploy(wallet, {
  storageSlots,
});
 
const { contract } = await waitForResult();

Icon LinkScript

After generating types via:

pnpm fuels typegen -i ./abis/*-abi.json -o ./types --script

We can use these files like so:

import { Script } from './sway-programs-api';
 
const script = new DemoScript(wallet);
const { waitForResult } = await script.functions.main().call();
const { value } = await waitForResult();

Icon LinkPredicate

After generating types via:

pnpm fuels typegen -i ./abis/*-abi.json -o ./types --predicate

We can use these files like so:

import type { PredicateInputs } from './sway-programs-api';
import { Predicate } from './sway-programs-api';
 
// In this exchange, we are first transferring some coins to the predicate
using launched = await launchTestNode();
 
const {
  provider,
  wallets: [wallet],
} = launched;
 
const receiver = Wallet.fromAddress(Address.fromRandom(), provider);
 
const predicateData: DemoPredicateInputs = [];
const predicate = new DemoPredicate({
  provider,
  data: predicateData,
});
 
const tx = await wallet.transfer(predicate.address, 200_000, provider.getBaseAssetId());
const { isStatusSuccess } = await tx.wait();
 
// Then we are transferring some coins from the predicate to a random address (receiver)
const tx2 = await predicate.transfer(receiver.address, 50_000, provider.getBaseAssetId());
await tx2.wait();
 
expect((await receiver.getBalance()).toNumber()).toEqual(50_000);
expect(isStatusSuccess).toBeTruthy();