dabit3 / fuels-ts

Fuel v2 TypeScript SDK

fuels-ts is a library for interacting with Fuel v2.

Table of contents

• Quickstart
• Documentation
• Install
• Import
• Interacting with Contracts
• Generate Contract Types from ABI
  • Using Generated Types
• Deploying Contracts
• CLI
• Contributing
• License

Quickstart

We recommend starting with the Quickstart to speed-up and build your first DApp using Fuel.

• Other example projects

Documentation

You can find in-depth usage and examples in our Guide, or deep-dive into the internals with our detailed SDK Documentation.

The Fuel Ecosystem

Learn more about the Fuel Ecosystem.

• 🌴 Sway the new language. Empowering everyone to build reliable and efficient smart contracts.
• 🧰 Forc the Fuel toolbox. Build, deploy and manage your sway projects.
• ⚙️ Fuel Core the new FuelVM, a blazingly fast blockchain VM.
• 🔗 Fuel Specs the Fuel protocol specifications.
• 🦀 RUST SDK a robust SDK in rust.
• ⚡ Fuel Network the project.

Install

YARN

yarn add fuels

NPM

npm install fuels --save

Import

import { Wallet } from "fuels";

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

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

CLI

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

$ yarn add fuels
$ yarn exec fuels -h
Usage: fuels [options] [command]

Options:
  -V, --version      output the version number
  -h, --help         display help for command

Commands:
  versions           check for version incompatibilities
  typegen [options]  generate typescript from contract abi json files
  help [command]     display help for command

License

The primary license for this repo is Apache 2.0, see LICENSE.