@fuel-ts/abi-typegen v0.77.0
@fuel-ts/abi-typegen
Generate TypeScript bindings for Sway smart contracts.
See the full ABI-spec here.
Table of contents
Documentation
Installation
yarn add @fuel-ts/abi-typegen
# or
npm add @fuel-ts/abi-typegen
Help
$ fuels-typegen -h
Usage: fuels-typegen -i ../out/*-abi.json -o ./generated/
Options:
-V, --version output the version number
-i, --input <path|glob> input path/global to your abi json files
-o, --output <dir> directory path for generated files
-s, --silent omit output messages
-h, --help display help for command
Generating types
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
import { 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' ]
// using input global
await runTypegen({ cwd, input, output });
// using filepaths' array
await runTypegen({ cwd, filepaths, output });
}
Full SDK Installation
Alternatively, we recommend you install the complete SDK using the umbrella package:
yarn add fuels
# or
npm add fuels
Note that in this example we will interact with the fuels
bin directly.
We just need to call it with the typegen
command, and the rest feels the same.
npx fuels typegen -i ./out/debug/*-abi.json -o ./src/contracts
Type's Conversion Table
The table below describes how Sway types are converted from/to Typescript.
Sway | Example | TS:input | TS:output |
---|---|---|---|
u8 | 255 | BigNumberish | number |
u16 | 65535 | BigNumberish | number |
u32 | 4294967295 | BigNumberish | number |
u64 | 0xFFFFFFFFFFFFFFFF | BigNumberish | BN |
str | anything | string | string |
bool | true | boolean | boolean |
b256 | 0x000... | string | string |
b512 | fuel1a7r... | string | string |
tuples | (MyType , MyType ) | MyType , MyType | MyType , MyType |
enums | enum MyEnum { y: (), n: () } | MyEnum = Enum <{ y: [], n: [] }> | MyEnum = Enum <{ y: [], n: [] }> |
structs | MyStruct { a: u8, b: u16 } | MyStruct | MyStruct |
vectors | Vec<MyType > | MyType [] | MyType [] |
options | Option<MyType > | Option<MyType> | Option<MyType> |
raw untyped ptr | 123 | BigNumberish | number |
For more info on Sway types, click here
Contributing
In order to contribute to @fuel-ts/abi-typegen
, please see the main fuels-ts monorepo.
Changelog
The @fuel-ts/abi-typegen
changelog can be found at CHANGELOG.
License
The primary license for @fuel-ts/abi-typegen
is Apache 2.0
, see LICENSE.
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
4 months ago
3 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
7 months ago
6 months ago
7 months ago
7 months ago
9 months ago
6 months ago
7 months ago
6 months ago
9 months ago
9 months ago
8 months ago
8 months ago
9 months ago
8 months ago
7 months ago
6 months ago
7 months ago
5 months ago
6 months ago
7 months ago
7 months ago
7 months ago
6 months ago
8 months ago
6 months ago
10 months ago
10 months ago
5 months ago
9 months ago
7 months ago
5 months ago
10 months ago
7 months ago
7 months ago
8 months ago
8 months ago
10 months ago
6 months ago
8 months ago
6 months ago
10 months ago
8 months ago
7 months ago
5 months ago
9 months ago
10 months ago
10 months ago
7 months ago
7 months ago
7 months ago
7 months ago
7 months ago
7 months ago
7 months ago
8 months ago
8 months ago
5 months ago
5 months ago
7 months ago
9 months ago
7 months ago
9 months ago
7 months ago
8 months ago
6 months ago
7 months ago
7 months ago
7 months ago
9 months ago
7 months ago
9 months ago
6 months ago
6 months ago
6 months ago
6 months ago
10 months ago
8 months ago
10 months ago
10 months ago
10 months ago
7 months ago
7 months ago
10 months ago
7 months ago
6 months ago
7 months ago
8 months ago
6 months ago
8 months ago
8 months ago
7 months ago
9 months ago
6 months ago
6 months ago
7 months ago
8 months ago
7 months ago
6 months ago
8 months ago
8 months ago
6 months ago
7 months ago
6 months ago
7 months ago
7 months ago
6 months ago
9 months ago
10 months ago
10 months ago
10 months ago
7 months ago
10 months ago
5 months ago
6 months ago
10 months ago
5 months ago
8 months ago
9 months ago
7 months ago
9 months ago
6 months ago
6 months ago
6 months ago
9 months ago
9 months ago
10 months ago
6 months ago
6 months ago
6 months ago
7 months ago
7 months ago
7 months ago
7 months ago
8 months ago
6 months ago
7 months ago
7 months ago
6 months ago
10 months ago
8 months ago
10 months ago
10 months ago
10 months ago
5 months ago
10 months ago
5 months ago
8 months ago
10 months ago
5 months ago
7 months ago
9 months ago
9 months ago
7 months ago
6 months ago
5 months ago
7 months ago
8 months ago
6 months ago
8 months ago
5 months ago
6 months ago
9 months ago
6 months ago
10 months ago
7 months ago
10 months ago
6 months ago
7 months ago
7 months ago
6 months ago
8 months ago
7 months ago
7 months ago
10 months ago
7 months ago
7 months ago
8 months ago
6 months ago
7 months ago
7 months ago
7 months ago
6 months ago
6 months ago
8 months ago
7 months ago
6 months ago
7 months ago
10 months ago
9 months ago
6 months ago
9 months ago
7 months ago
7 months ago
7 months ago
7 months ago
8 months ago
6 months ago
6 months ago
6 months ago
7 months ago
7 months ago
10 months ago
7 months ago
7 months ago
7 months ago
5 months ago
9 months ago
10 months ago
6 months ago
10 months ago
9 months ago
8 months ago
6 months ago
8 months ago
6 months ago
7 months ago
6 months ago
7 months ago
9 months ago
9 months ago
7 months ago
6 months ago
8 months ago
7 months ago
8 months ago
5 months ago
6 months ago
6 months ago
6 months ago
6 months ago
5 months ago
7 months ago
7 months ago
10 months ago
6 months ago
6 months ago
7 months ago
7 months ago
7 months ago
7 months ago
6 months ago
7 months ago
10 months ago
10 months ago
7 months ago
9 months ago
5 months ago
10 months ago
7 months ago
9 months ago
5 months ago
7 months ago
6 months ago
6 months ago
8 months ago
6 months ago
6 months ago
10 months ago
6 months ago
7 months ago
7 months ago
7 months ago
7 months ago
6 months ago
6 months ago
6 months ago
5 months ago
9 months ago
6 months ago
7 months ago
9 months ago
7 months ago
8 months ago
7 months ago
7 months ago
5 months ago
7 months ago
7 months ago
11 months ago
7 months ago
7 months ago
7 months ago
8 months ago
6 months ago
6 months ago
7 months ago
10 months ago
7 months ago
6 months ago
6 months ago
8 months ago
10 months ago
5 months ago
7 months ago
6 months ago
7 months ago
8 months ago
6 months ago
6 months ago
8 months ago
6 months ago
7 months ago
6 months ago
9 months ago
9 months ago
6 months ago
8 months ago
7 months ago
5 months ago
7 months ago
6 months ago
9 months ago
7 months ago
7 months ago
10 months ago
7 months ago
6 months ago
6 months ago
7 months ago
6 months ago
7 months ago
7 months ago
8 months ago
6 months ago
5 months ago
7 months ago
10 months ago
7 months ago
9 months ago
7 months ago
5 months ago
6 months ago
10 months ago
7 months ago
7 months ago
10 months ago
5 months ago
7 months ago
7 months ago
7 months ago
7 months ago
9 months ago
6 months ago
5 months ago
9 months ago
10 months ago
5 months ago
6 months ago
5 months ago
6 months ago
6 months ago
7 months ago
9 months ago
6 months ago
10 months ago
9 months ago
6 months ago
9 months ago
8 months ago
5 months ago
8 months ago
6 months ago
10 months ago
6 months ago
5 months ago
8 months ago
6 months ago
7 months ago
7 months ago
7 months ago
5 months ago
5 months ago
9 months ago
7 months ago
8 months ago
7 months ago
5 months ago
6 months ago
6 months ago
7 months ago
8 months ago
10 months ago
6 months ago
10 months ago
7 months ago
6 months ago
10 months ago
7 months ago
6 months ago
5 months ago
7 months ago
6 months ago
9 months ago
7 months ago
6 months ago
8 months ago
7 months ago
10 months ago
5 months ago
6 months ago
10 months ago
7 months ago
10 months ago
6 months ago
8 months ago
8 months ago
8 months ago
5 months ago
6 months ago
7 months ago
9 months ago
7 months ago
7 months ago
9 months ago
8 months ago
8 months ago
9 months ago
6 months ago
10 months ago
9 months ago
9 months ago
11 months ago
5 months ago
6 months ago
6 months ago
8 months ago
6 months ago
6 months ago
8 months ago
9 months ago
6 months ago
7 months ago
7 months ago
5 months ago
6 months ago
7 months ago
8 months ago
10 months ago
9 months ago
10 months ago
7 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
12 months ago
1 year ago
1 year ago
1 year ago
1 year ago
12 months ago
12 months ago
1 year ago
11 months ago
1 year ago
1 year ago
1 year ago
1 year ago
11 months ago
1 year ago
11 months ago
1 year ago
1 year ago
1 year ago
12 months ago
1 year ago
1 year ago
1 year ago
1 year ago
11 months ago
1 year ago
12 months ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
11 months ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
12 months ago
1 year ago
1 year ago
12 months ago
1 year ago
12 months ago
1 year ago
12 months ago
1 year ago
1 year ago
1 year ago
1 year ago
12 months ago
1 year ago
12 months ago
1 year ago
1 year ago
12 months ago
1 year ago
1 year ago
12 months ago
1 year ago
1 year ago
12 months ago
1 year ago
1 year ago
12 months ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
12 months ago
1 year ago
12 months ago
1 year ago
12 months ago
12 months ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
12 months ago
1 year ago
12 months ago
1 year ago
1 year ago
1 year ago
1 year ago
12 months ago
11 months ago
11 months ago
12 months ago
12 months ago
11 months ago
1 year ago
1 year ago
12 months ago
12 months ago
12 months ago
1 year ago
11 months ago
1 year ago
1 year ago
12 months ago
1 year ago
1 year ago
11 months ago
12 months ago
1 year ago
12 months ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago