fuel-core42,902
stars
+-3
1,360
forks
109
watchers
2,477
prs
1,457
issues
156
releases
32
discussions
README
fuels-ts
Typescript SDK for Fuel.
Install (docs)
console
npm install fuels --save
Connect (docs)
| Network | URL |
| --------- | --------------------------------------------------------------------------------------------------------------- |
| Mainnet | https://mainnet.fuel.network/v1/graphql |
| Testnet | https://testnet.fuel.network/v1/graphql |
| Localhost | Running a local Fuel node |
ts
import { Provider } from 'fuels';
const NETWORK_URL = 'https://mainnet.fuel.network/v1/graphql';
const provider = new Provider(NETWORK_URL);
const chainId = await provider.getChainId();
const gasConfig = await provider.getGasConfig();
const baseAssetId = await provider.getBaseAssetId();
console.log({ chainId, gasConfig, baseAssetId });
Create a new dApp (docs)
console
$ npm create fuels
◇ What is the name of your project?
│ my-fuel-project
└
⚡️ Success! Created a fullstack Fuel dapp at: my-fuel-project.
Enjoy the fuels CLI (docs)
console
$ npm install fuels --save
$ npm fuels --help
Commands:
init [options] Create a sample fuel.config.ts file
build [options] Build Sway programs and generate Typescript for them
deploy [options] Deploy contracts to the Fuel network
dev [options] Start a Fuel node with hot-reload capabilities
node [options] Start a Fuel node using project configs
typegen [options] Generate Typescript from Sway ABI JSON files
versions [options] Check for version incompatibilities
help [command] Display help for command
In-depth docs:
- fuels init — Creates a new fuels.config.ts file
- fuels build — Build forc workspace and generate Typescript types for everything
- fuels deploy — Deploy workspace contracts and save their IDs to JSON file
- fuels dev — Start a Fuel node with hot-reload capabilities
Official Docs
- Install The Fuel Toolchain — https://docs.fuel.network/guides/installation/
---
- Typescript SDK — https://docs.fuel.network/docs/fuels-ts
- Fuel Wallet SDK — https://docs.fuel.network/docs/wallet
- Rust SDK — https://docs.fuel.network/docs/fuels-rs
- GraphQL Playground — https://docs.fuel.network/docs/graphql
---
- Forc — https://docs.fuel.network/docs/forc
- Sway — https://docs.fuel.network/docs/sway
- Fuel Core — https://github.com/FuelLabs/fuel-core
- Fuel VM — https://docs.fuel.network/docs/specs/fuel-vm
- Fuel Specs — https://docs.fuel.network/docs/specs
Apps & Ecosystem
- Fuel Bridge — https://app.fuel.network/bridge
- Block Explorer — https://app.fuel.network
- Ecosystem Apps — https://app.fuel.network/ecosystem
Get in Touch
- Forum — https://forum.fuel.network
- Discord — https://discord.gg/xfpK4Pe
Contribute
- ./CONTRIBUTING.md
License
The primary license for this repo is Apache 2.Top issues
#2570Example application for React Native13 comments · 2024-06-20#3447Export the SDK as ESM Only9 comments · 2024-12-05#3241Documentation for `B512`7 comments · 2024-10-02#1952Chain Configs for the fuels CLI should be extendable off of the default one6 comments · 2024-03-26#1385SDK fails when Contract returns `String` in a `Struct` or `Tuple`6 comments · 2023-10-27#3445Add `TestCoin` helper class5 comments · 2024-12-04#3240Documentation for `B256`5 comments · 2024-10-02#3814Remove Code Deprecated During `assembleTx` Implementation4 comments · 2025-03-27
Discussions
#2792Proposal to change typegen'd predicate initialisation arguments0 comments · 2024-07-18#2679Introduce Performance Benchmarks1 comments · 2024-07-01#2678Introduce Transaction Queue Support1 comments · 2024-07-01#2676Integrate `@fuel-ts/logger` across the stack0 comments · 2024-07-01#2638Code of Conduct from `Community Standards`1 comments · 2024-06-27#2510Do we still need `FUEL_NETWORKL_URL`? 🤔3 comments · 2024-06-13#2429Re-instantiate Typedocs for `hidden` exported functions in `Account`2 comments · 2024-05-31#2424Is the "param1" of the call receipt no longer the function selector on the testnet?2 comments · 2024-05-31
Latest release
v0.103.0 v0.103.0 2026-01-30@fuel-ts/[email protected] Patch Changes - @fuel-ts/[email protected] - @fuel-ts/[email protected] - @fuel-ts/[email protected] - @fuel-ts/[email protected] - @fuel-ts/[email protected] @fuel-ts/[email protected] Patch Changes - @fuel-ts/[email protected] - @fuel-ts/[email protected] - @fuel-ts/[email protected] @fuel-ts/[email protected] Minor Changes - 014a606: feat!: Update devnet Chain ID Patch Changes - @fuel-ts/[email protected] - @fuel-ts/[email protected] - @fuel-ts/[email protected] - @fuel-ts/[email protected] - @fuel-ts/[email protected] - @fuel-ts/[email protected] - @fuel-