# AGENTS.md

Rust full node implementation of the Fuel v2 protocol.

## Setup

```
cargo build
```

## Commands

```
make help
make build       # produce a build
make debug
make fmt
make test        # run the test suite, must pass before any commit
make ci-checks
```

## Layout

- `crates/`                629 source files
- `tests/`                 65 source files
- `bin/`                   39 source files
- `benches/`               34 source files
- `version-compatibility/` 6 source files
- `xtask/`                 4 source files

## Conventions

- Tests live alongside the code they cover, following `.github/workflows/chaos-test.yml`.
- CI defines what passing means. See `.github/workflows/chaos-test.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- `crates/fuel-core/src/service/adapters/consensus_module/poa.rs` is 187KB. It will not fit comfortably in context, so read it in parts.

---

Drafted by agentreadme.com from what is in this repository. Everything marked TODO
needs a human. Check it in as AGENTS.md at the root.