fuel-core

# Fuel Client

[![build](https://github.com/FuelLabs/fuel-core/actions/workflows/ci.yml/badge.svg)](https://github.com/FuelLabs/fuel-core/actions/workflows/ci.yml)
[![deepwiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/FuelLabs/fuel-core)
[![crates.io](https://img.shields.io/crates/v/fuel-core?label=latest)](https://crates.io/crates/fuel-core)
[![docs](https://docs.rs/fuel-core/badge.svg)](https://docs.rs/fuel-core/)
[![discord](https://img.shields.io/badge/chat%20on-discord-orange?&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2)](https://discord.gg/xfpK4Pe)
[![twitter](https://img.shields.io/twitter/follow/fuel_network)](https://x.com/fuel_network)

Fuel client implementation.

## Versions currently used in networks

| Network  | Version |
|----------|---------|
| Fuel Ignition | 0.48.1 |
| Testnet | 0.48.1 |
| Devnet | 0.48.1 |

## Contributing

If you are interested in contributing to Fuel, see our [CONTRIBUTING.md](CONTRIBUTING.md) guidelines for coding standards and review process.

Before pushing any changes or creating pull request please run `source ci_checks.sh`.

## Building

If you plan to use already pre-compiled binaries you can directly go to [Running a Ignition node](#running-a-ignition-node).

### System Requirements

There are several system requirements including clang.

#### MacOS

```bash
brew update
brew install cmake
```

#### Debian

```bash
apt update
apt install -y cmake pkg-config build-essential git clang libclang-dev
```

#### Arch

```bash
pacman -Syu --needed --noconfirm cmake gcc pkgconf git clang
```

### Rust setup

You'll need `wasm32-unknown-unknown` target installed.

```bash
rustup target add wasm32-unknown-unknown
```


## Running a Ignition node

If you want to participate in the Ignition network with your own node you can launch it following these simple commands.

### From pre-compiled binaries

Follow : https://docs.fuel.network/docs/node-operator/fuel-ignition/mainnet-node/

### From source

Clone the `fuel-core` repository : 
```
git clone https://github.com/FuelLabs/fuel-core.git
```

Go to the latest release tag for ignition on the `fuel-core` repository :
```
git checkout v0.45.1
```

Build your node binary:
```bash
make build
```

To run the node follow : https://docs.fuel.network/docs/node-operator/fuel-ignition/mainnet-node/

## Running a Local network from source

Clone the `fuel-core` repository : 
```
git clone https://github.com/FuelLabs/fuel-core.git
```

Build your node binary:
```bash
make build
```

To run the node follow : https://docs.fuel.network/docs/node-operator/fuel-ignition/local-node/

## Setup to make contributions

### Compiling

We recommend using `xtask` to build fuel-core for development:

```sh
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.

### Testing

The [ci_checks.sh](ci_checks.sh) script file can be used to run all CI checks,
includin