@fuel-ts/abi-typegen
生成类型脚本绑定 摇摆 智能合约.
参见 ABI- spec 这里。 。 。 .
目录
文档
见 文档
安装
pnpm add @fuel-ts/abi-typegen
# or
npm add @fuel-ts/abi-typegen
帮助
$ fuels-typegen -h
Generate Typescript from Sway ABI JSON files
Usage: fuels-typegen [options]
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
-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 for command
生成类型
当以独立方式使用软件包时,其本位前缀为 fuels-。 。 。 .
npx fuels-typegen -i ./out/debug/*-abi.json -o ./src/contracts
程序化 API
import { ProgramTypeEnum, 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 programType = ProgramTypeEnum.CONTRACT;
// using input global
await runTypegen({ cwd, input, output, programType });
// using filepaths' array
await runTypegen({ cwd, filepaths, output, programType });
}
全部 SDK 安装
或者,我们建议你安装 完整 SDK 使用伞包:
pnpm add fuels
# or
npm add fuels
注意,在此例子中,我们将与 fuels 直接输入.
我们只需要叫它与 typegen 指挥,其余的也一样.
npx fuels typegen -i ./out/debug/*-abi.json -o ./src/contracts
类型转换表
下表描述了斯威类型如何从/到Typescript.
| 摇摆 | 示例 | TS: 输入 | TS:产出 |
|---|---|---|---|
| 区域8 | 255 | BigNumberish | number |
| 16号 | 65535 | BigNumberish | number |
| ư: 32 | 4294967295 | BigNumberish | number |
| u64 | 0xFFFFFFFFFFFFFFFF | BigNumberish | BN |
| 字符串 | anything | string | string |
| 嘘 | true | boolean | boolean |
| b256 (韩语) | 0x000... | string | string |
| b512 (中文(简体) ) | fuel1a7r... | string | string |
| tu | (单位:千美元)MyType, (中文(简体) ), MyType(中文(简体) ) | [MyType, (中文(简体) ), MyType[ . ] | [MyType, (中文(简体) ), MyType[ . ] |
| 语句 | 语句 MyEnum {y: (), n: ()}(})} | MyEnum =: Enum<{: [],n: []] | MyEnum =: Enum<{: [],n: []] |
| 结构 | MyStruct {a: u8,b: u16} (中文(简体) ) | MyStruct | MyStruct |
| 向量 | 维克 <MyType> 翻译: | MyType[ | MyType[ |
| 选项 | 选项 <MyType> 翻译: | Option<MyType> | Option<MyType> |
| 原始无类型 ptr | 123 | BigNumberish | BN |
关于Sway类型的更多信息,请点击 这里
捐款
为了促进 @fuel-ts/abi-typegen请看主 燃料吨 单相机.
更改日志
这个 @fuel-ts/abi-typegen 更改日志可见于 变化。 。 。 .
许可证
主要许可证: @fuel-ts/abi-typegen 实值 Apache 2.0,参见 自由主义。 。 。 .