Substreams

Substreams is a powerful blockchain indexing technology, developed for The Graph Network.

It enables you to write Rust modules, composing data streams alongside the community, and provides extremely high performance indexing by virtue of parallelization, in a streaming-first fashion.

It has all the benefits of the Firehose, like low-cost caching and archiving of blockchain data, high throughput processing, and cursor-based reorgs handling.

Documentation

Full documentation is accessible at https://docs.substreams.dev.

Getting Started

• Your First Stream

Concept & Fundamentals

• Definition
• Comparison
• Modules
  • Inputs
  • Outputs

Developer Guide

• Overview
• Installation
• Creating your Manifest
• Creating Protobuf Schemas
• Setting Up Handlers
• Writing Module Handlers
• Running Your Substreams

Development

Release

sfreleaser release

Follow instructions the CLI is asking, the process is now automatic and version bump and Substreams package building is now all done automatically.

Protobuf Generation

buf generate buf.build/streamingfast/substreams-foundational-store