jimyacton / fuel-subgraph

Fuel-Subgraph Setup Documentation

Prerequisites

To build and run this project you need to have the following installed on your system:

• Rust (latest stable) – How to install Rust
  • Note that rustfmt, which is part of the default Rust installation, is a build-time requirement.
• PostgreSQL – PostgreSQL Downloads
• IPFS – Installing IPFS
• Profobuf Compiler - Installing Protobuf

1. Run IPFS

Open the terminal and run the following commands:

ipfs init
ipfs daemon

2. Configure PostgreSQL

After installing PostgreSQL run the following commands in the terminal:

initdb -D .postgres -E UTF8 --locale=C
pg_ctl -D .postgres -l logfile start
createdb graph-node

Note: In case of issues, restart the database by deleting it and then starting it again

3. Build Firehose-Extract

Navigate to firehose-extract folder and run the following command in the terminal:

cargo build

4. Start Fuel-Firehose

Navigate to firehose-fuel folder and run the following command in the terminal:

./devel/fuelfire/start.sh

5. Run Fuel-Graph-Node

Navigate to fuel-graph-node folder and run the following command in the terminal:

cargo run --bin graph-node -- --config fuel_config.toml --ipfs http://127.0.0.1:5001 --node-id fuel-node-indexer

Working with Fuel-Subgraphs

1. Install and Build Fuel-Graph-Tooling

Navigate to fuel-graph-tooling folder and run:

pnpm install
pnpm build

2. Building and Deploying Fuel-Subgraphs

To initialize a new Fuel Subgraph, use the provided Subgraph Manifest file subgraph.yaml. Navigate to the Subgraph folder and execute the following commands:

./../fuel-graph-tooling/packages/cli/bin/run codegen
./../fuel-graph-tooling/packages/cli/bin/run build
./../fuel-graph-tooling/packages/cli/bin/run create my/new_sub --node http://localhost:8020/
./../fuel-graph-tooling/packages/cli/bin/run deploy -l v0.1.0 --node http://localhost:8020/ --ipfs http://localhost:5001 my/new_sub deploy -l v0.1.0 --node http://localhost:8020/ --ipfs http://localhost:5001 my/new_sub

For more information on initializing a subgraph, you can refer to The Graph documentation.

For additional information, refer to the following documentation:

• firehose
• graph-node
• graph-tooling

License

The primary license for this repo is Apache 2.0, see LICENSE.