Skip to content

Latest commit

 

History

History
93 lines (69 loc) · 4 KB

README.md

File metadata and controls

93 lines (69 loc) · 4 KB
Fuels-ts SDK logo

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

test npm docs discord

Resources

The documentation site 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(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
  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 is Apache 2.0, see LICENSE.