Skip to content


Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?

Latest commit

Related issues:
- Closes #1121

This PR update the `FuelClient` API to use ID types in place of string
serialized IDs. Now, consumers of the API must directly pass a client
type when performing a method call. Internally, these ID types are then
converted to GraphQL types to be used in the GraphQL API. This API
update represents a breaking change.

Git stats


Failed to load latest commit information.
Latest commit message
Commit time

Fuel Client

build docs discord

Fuel client implementation.


If you are interested in contributing to Fuel, see our guidelines for coding standards and review process.

Before pushing any changes or creating pull request please run source


System Requirements

There are several system requirements including clang.

brew update
brew install cmake
brew install protobuf
apt update
apt install -y cmake pkg-config build-essential git clang libclang-dev protobuf-compiler
pacman -Syu --needed --noconfirm cmake gcc pkgconf git clang protobuf-compiler


We recommend using xtask to build fuel-core:

cargo xtask build

This will run cargo build as well as any other custom build processes we have such as re-generating a GraphQL schema for the client.


The service can be launched by executing fuel-core run. The list of options for running can be accessed via the help option:

$ ./target/debug/fuel-core run --help

    fuel-core run [OPTIONS]

        --chain <CHAIN_CONFIG>
            Specify either an alias to a built-in configuration or filepath to a JSON file [default:

For many development puposes it is useful to have a state that won't persist and the db-type option can be set to in-memory as in the following example.


$ ./target/debug/fuel-core run --db-type in-memory
Jul 12 23:28:47.238  INFO fuel_core: Binding GraphQL provider to

To disable block production on your local node, set --poa-instant=false


$ ./target/debug/fuel-core run --poa-instant=false
2023-01-23T02:25:18.787401Z  INFO fuel_core::cli::run: 173: Block production disabled.



We use publish-crates action for automatic publishing of all crates.

If you have problems with publishing, you can troubleshoot it locally with act.

act release -s GITHUB_TOKEN=<YOUR_GITHUB_TOKEN> -j publish-crates-check --container-architecture linux/amd64 --reuse

It requires GitHubToken to do request to the GitHub. You can create it with this instruction.

Outdated database

If you encounter an error such as

thread 'main' panicked at 'unable to open database: DatabaseError(Error { message: "Invalid argument: Column families not opened: column-11, column-10, column-9, column-8, column-7, column-6, column-5, column-4, column-3, column-2, column-1, column-0" })', fuel-core/src/

Clear your local database using: rm -rf ~/.fuel/db

File descriptor limits

On some macOS versions the default file descriptor limit is quite low, which can lead to IO errors with messages like Too many open files or even fatal runtime error: Rust cannot catch foreign exceptions when RocksDB encounters these issues. Use the following command to increase the open file limit. Note that this only affects the current shell session, so consider adding it to ~/.zshrc.

ulimit -n 10240

Log level

The service relies on the environment variable RUST_LOG. For more information, check the EnvFilter examples crate.

Human logging can be disabled with the environment variable HUMAN_LOGGING=false

Docker & Kubernetes

# Create Docker Image
docker build -t fuel-core . -f deployment/Dockerfile

# Delete Docker Image
docker image rm fuel-core

# Create Kubernetes Volume, Deployment & Service
kubectl create -f deployment/fuel-core.yml

# Delete Kubernetes Volume, Deployment & Service
kubectl delete -f deployment/fuel-core.yml

GraphQL service

The client functionality is available through a service endpoint that expect GraphQL queries.

Transaction executor

The transaction executor currently performs instant block production. Changes are persisted to RocksDB by default.

  • Service endpoint: /graphql
  • Schema (available after building): fuel-client/assets/schema.sdl

The service expects a mutation defined as submit that receives a Transaction in hex encoded binary format, as specified here.

cURL example

This example will execute a script that represents the following sequence of ASM:

ADDI(0x10, RegId::ZERO, 0xca),
ADDI(0x11, RegId::ZERO, 0xba),
LOG(0x10, 0x11, RegId::ZERO, RegId::ZERO),
$ cargo run --bin fuel-core-client -- transaction submit \