Skip to content

FuelLabs/fuels-ts

Fuels-ts SDK logo

fuels-tsis a library for interacting withFuel v2.

test npm docs discord

Resources

Thedocumentationsite is your main stop for resources.

Install

npm install fuels --save

If you are a Windows user, you will need to be running Windows Subsystem for Linux (WSL) to install and use the Fuel toolchain, including the TypeScript SDK. We don't support Windows natively at this time.

Import

Simple example usages.

import{Wallet}from"fuels";

// Random Wallet
console.log(Wallet.generate());

// Using privateKey Wallet
console.log(newWallet("0x0000...0000"));

CLI

Fuels include some utility commands via built-in CLI tool.

Check thedocsfor more info.

$npm add fuels
$npx fuels --help
Usage: fuels [options] [command]

Options:
-D, --debug Enables verbose logging (default: false)
-S, --silent Omit output messages (default: false)
-v, --version Output the version number
-h, --help Display help

Commands:
init [options] Create a sample `fuel.config.ts` file
node [options] Start a Fuel node
dev [options] Start a Fuel node and run build + deploy on every file change
build [options] Build Sway programs and generate Typescript for them
deploy [options] Deploy contracts to the Fuel network
typegen [options] Generate Typescript from Sway ABI JSON files
versions Check for version incompatibilities
help [command] Display help for command

The Fuel Ecosystem

Learn more about the Fuel Ecosystem.

License

The primary license for this repo isApache 2.0,seeLICENSE.