Description

• This is a generated Substreams-powered-Subgraph

Dependencies

Get Substreams CLI (optional)

To try the Substreams directly, you need to install the substreams CLI (v1.7.2 or above).

You have many options as explained in this installation guide.

Check if substreams was installed successfully, you can run the following command:

substreams --version
> substreams version ...

Get Substreams API Token

To try the Substreams directly or to run a local graph-node instance, you will need to get a Substreams API token. Follow the instructions on the authentification section in the StreamingFast documentation.

Install Docker

To run a local graph-node instance, you will need to install Docker. You can do it by following the instructions on the official Docker website.

Install buf cli

To run the proto assembly script bindings, you will need to install the buf cli.

Run the entire stack with the run-local.sh script

You can run the entire stack (docker, npm installations and graph creation with deployment) by running the below script

./run-local.sh

However, if you want to run each commen individually, follow the instructions below:

Install npm and nodeJS packages

Run the following command in the root of the repository:

npm install

Generate proto assembly script bindings

npm run generate

Generate subgraph mapping types

npm run codegen

Deploy a subgraph

On a local dev environment

Launch docker-compose environment

To deploy your subgraph locally, you need to run a local graph-node instance. To do so, export your SUBSTREAMS_API_TOKEN and use the launch-graph-node script :

docker compose -f dev-environment/docker-compose.yml up -d --wait

This script is running docker compose to create all necessary instances to launch properly the node locally, connecting to Streamingfast Substreams API.

Deploy locally

Then, from another terminal:

export SUBSTREAMS_API_TOKEN = "YOUR_TOKEN"
npm run create-local
npm run deploy-local
npm run remove-local

Query a subgraph

Once you subgraph is deployed, you can query it! To do so, you can directly write your query locally on http://localhost:8000/subgraphs/name/{name_of_your_subgraph}/