Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fuellabs/fuels-ts
Fuel Network Typescript SDK
https://github.com/fuellabs/fuels-ts
fuel typescript
Last synced: 2 days ago
JSON representation
Fuel Network Typescript SDK
- Host: GitHub
- URL: https://github.com/fuellabs/fuels-ts
- Owner: FuelLabs
- License: apache-2.0
- Created: 2021-09-03T18:11:03.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-10-29T09:59:08.000Z (3 months ago)
- Last Synced: 2024-10-29T11:37:54.086Z (3 months ago)
- Topics: fuel, typescript
- Language: TypeScript
- Homepage: https://docs.fuel.network/docs/fuels-ts/
- Size: 44.4 MB
- Stars: 44,092
- Watchers: 121
- Forks: 1,344
- Open Issues: 146
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
README
# fuels-ts
Typescript SDK for Fuel.
[](https://github.com/FuelLabs/fuels-ts/actions/workflows/test.yaml)
[](https://docs.fuel.network/docs/fuels-ts/)
[](https://www.npmjs.com/package/fuels)
[](https://discord.gg/xfpK4Pe)
# Install ([docs](https://docs.fuel.network/docs/fuels-ts/getting-started/installation))
```console
npm install fuels --save
```
# Connect ([docs](https://docs.fuel.network/docs/fuels-ts/getting-started/connecting-to-the-network/))
| Network | URL |
| --------- | --------------------------------------------------------------------------------------------------------------- |
| Mainnet | `https://mainnet.fuel.network/v1/graphql` |
| Testnet | `https://testnet.fuel.network/v1/graphql` |
| Localhost | [Running a local Fuel node](https://docs.fuel.network/docs/fuels-ts/getting-started/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](https://docs.fuel.network/docs/fuels-ts/creating-a-fuel-dapp/))
```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](https://docs.fuel.network/docs/fuels-ts/fuels-cli/))
```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`](https://docs.fuel.network/docs/fuels-ts/fuels-cli/commands#fuels-init) — Creates a new `fuels.config.ts` file
- [`fuels build`](https://docs.fuel.network/docs/fuels-ts/fuels-cli/commands#fuels-build) — Build `forc` workspace and generate Typescript types for everything
- [`fuels deploy`](https://docs.fuel.network/docs/fuels-ts/fuels-cli/commands#fuels-deploy) — Deploy workspace contracts and save their IDs to JSON file
- [`fuels dev`](https://docs.fuel.network/docs/fuels-ts/fuels-cli/commands#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](https://github.com/FuelLabs/fuels-ts/blob/master/CONTRIBUTING.md)
# License
The primary license for this repo is `Apache 2.0`, see [`LICENSE`](https://github.com/FuelLabs/fuels-ts/blob/master/LICENSE).