KramPiotr/fuels-ts

Fuel Network Typescript SDK

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

Resources

The documentation site is your main stop for resources.

• Quickstart
• Documentation
  • Wallets
  • Contracts
  • Scripts
  • Predicates
  • ABI Typegen
• Contributing
• The Fuel Forum
• The Fuel Ecosystem

Install

npm install fuels --save

Import

Simple example usages.

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.

Check the docs for 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
  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
  core               Wrapper around Fuel Core binary
  forc               Wrapper around Forc binary
  help [command]     Display help for command

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
• 💼 Fuels Wallet — The Official Fuels Wallet
• 🦀 Rust SDK — A robust SDK in rust
• ⚡ Fuel Network — The project
• 📚 The Fuel Forum — Ask questions, get updates, and contribute to a modular future

License

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