➡️ Read the Quickstart! ➡️
What is the Fuel indexer?
The Fuel indexer is a standalone service that can be used to index various components of the blockchain. These indexable components include blocks, transactions, receipts, and state within the Fuel network, allowing for high-performance read-only access to the blockchain for advanced dApp use-cases.
TLDR: It's Infrastructure as a service (IaaS) for Web3 dApp backends.
Install
Fuel's indexer supports Linux (x64 & arm64) and macOS (x64 & Apple Silicon).
If you don't want to deal with dependency issues we recommend just using Fuel's indexer with Docker, via the included docker-compose file.
Install Fuel's toolchain manager - fuelup.
curl --proto '=https' --tlsv1.2 -sSf https://install.fuel.network/fuelup-init.sh | shThe
fuel-indexerandforc-indexbinaries should now be available in your$PATH
Usage
For development, users will primarily use the forc index command line utility made available after installing fuelup.
forc index --helpforc index 0.0.0
Fuel Indexer Orchestrator
USAGE:
forc-index <SUBCOMMAND>
OPTIONS:
-h, --help Print help information
-V, --version Print version information
SUBCOMMANDS:
auth Authenticate against an indexer service
build Build an indexer
check Check for Fuel indexer components
deploy Deploy an indexer to an indexer service
help Print this message or the help of the given subcommand(s)
kill Kill the indexer process. Note that this command will kill any process
listening on the default indexer port or the port specified by the `--port`
flag
new Create a new indexer project in a new directory
postgres Fuel Postgres Orchestrator
remove Stop and remove a running indexer
start Standalone binary for the Fuel indexer service
status Check the status of a registered indexer
➡️ For more details on how to build Fuel indexers, read the docs! ➡️
Contributing
If you're interested in contributing PRs to make the Fuel indexer a better project, feel free to read our contributors document.