fuels-ts README

The project's README from github.com/FuelLabs/fuels-ts. As one markdown file: README.md.

fuels-ts

Typescript SDK for Fuel.

test docs npm discord

Install (docs)

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 
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)

$ 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)

$ 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:

Official Docs

Apps & Ecosystem

Get in Touch

Contribute

License

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

fuels-ts (FuelLabs/fuels-ts)

Searching Database…

42.9K ·GitHub
Fuels-ts
这是什么？fuels-ts 是 Fuel Network 官方的 TypeScript SDK，开发者可以用它构建 dApp、与 Sway 智能合约交互，并从 JavaScript/TypeScript 连接 Fuel 节点。
它是一个库，还是自带命令行工具？两者兼有：一方面是可以导入应用中的 TypeScript 库，另一方面是附带的 'fuels' 命令行工具，用于搭建、构建和部署项目。
我该怎么用它开始一个新的 dApp？先安装 SDK，然后使用 fuels 命令行工具创建新的 dApp，并为项目生成 fuels.config.ts 文件。
我还需要安装 Fuel 工具链吗？需要。你需要另外单独安装 Fuel 工具链（其中包含 Forc，即 Sway 编译器），因为命令行工具会把 Forc 工作区构建为 TypeScript 类型。
它需要哪个版本的 Node.js？需要 Node.js 20、22 或 24，并需要 pnpm 9.4 或更高版本作为单体仓库的包管理器。
我可以连接哪些网络？你可以连接到 Fuel 主网、测试网，或你自己运行的 Localhost 节点。
我能用这个命令行工具在本地运行 Fuel 节点来开发吗？可以，'fuels dev' 命令会启动一个支持热重载的 Fuel 节点，适合本地开发。
我该怎么部署我的 Sway 合约？使用 'fuels deploy' 部署你工作区中的合约，并自动将其合约 ID 保存到一个 JSON 文件中，供你的应用使用。
有没有和 Fuel 相关的钱包 SDK？有。Fuel 官方维护着一个独立的 Fuel Wallet SDK，与这个 TypeScript SDK、Rust SDK 以及 Forc、Fuel Core 等其他生态工具并行存在。
What are similar projects?Paxeer-X-Network, fuels-rs, cpp-sdk, nuvex, sway, fuel-core, linera-protocol, metamask-extension
Which topics is it in?wallet, network, smart-contracts, web3, graphql, blockchain, monorepo, sdk, command-line-tool, apache-2.0, typescript, cli
Creator
FuelLabs
Size
112.4 MB
Stars
42.9K
Updated
CommitJan 30Releasev0.103.0Jan 30
Age
5y
Commits · 90 Days