Substreams-Powered Subgraphs
Last updated
Was this helpful?
Last updated
Was this helpful?
Boost your Subgraph’s efficiency and scalability by using Substreams to stream pre-indexed blockchain data.
Use a Substreams package (.spkg
) as a data source to give your Subgraph access to a stream of pre-indexed blockchain data. This enables more efficient and scalable data handling, especially with large or complex blockchain networks.
Enable Substreams-Powered Subgraphs for a blockchain network in Graph Node. See .
All commands should be executed as the root user to ensure proper installation and permissions.
Nodejs is required for dependency management and build steps in the subgraph process.
The Substreams CLI is used for connecting to blockchain endpoints, streaming real-time data, and packaging custom modules.
Buf is used to generate typed structures from Protobuf definitions, simplifying integration across various languages.
An internet connection is required for generating Rust bindings.
Direct Download
Using npm
A complete Rust environment is necessary for developing Substreams modules.
There are two methods of creating Substreams-Powered Subgraphs:
You can choose where to place your logic, either in the Subgraph or Substreams. However, consider what aligns with your data needs, as Substreams has a parallelized model, and triggers are consumed linearly.
Before deploying a substream-powered subgraph, ensure substream are enabled for the blockchain network in Graph Node.
Add Rust Target
Generate Protobuf Types
This command generates types in /src/pb.
Build Substreams
This command creates a Substream package (.spkg
), which can be used as a data source for a subgraph to access pre-indexed blockchain data streams.
Generate Subgraph Project
Navigate to the Subgraph Directory
Edit the following files as needed:
mappings.ts
schema.graphql
subgraph.yaml
Install Dependencies
Generate AssemblyScript & Protobuf Bindings
Build Subgraph
Using Substreams : Consume from any Substreams module by importing the Protobuf model through a Subgraph handler and move all your logic into a Subgraph. This method creates the Subgraph entities directly in the Subgraph.
Using : By writing more of the logic into Substreams, you can consume the module’s output directly into Subgraph. In Subgraph you can use the Substreams data to create your Subgraph entities.
The final step is to deploy the subgraph using the deployment command. See