substreams

README

---

description: A streaming data engine for The Graph - by StreamingFast

Substreams

DEVELOPER PREVIEW OF 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.

Substreams is the successor of https://github.com/streamingfast/sparkle, enabling greater composability, yet similar powers of parallelization, and a much simpler model to work with.

Getting Started

Installing the Substreams command-line tool

The substreams CLI allows you to interact with Substreams endpoints, stream data in real-time, as well as package your own Substreams modules.

From brew (for Max OS)

brew install streamingfast/tap/substreams

From pre-compiled binary

Download the binary

# Use correct binary for your platform
wget https://github.com/streamingfast/substreams/releases/download/v0.0.5-beta3/substreams_0.0.5-beta3_linux_x86_64.tar.gz
tar -xzvf substreams_0.0.5-beta3_linux_x86_64.tar.gz
export PATH="`pwd`:$PATH"

{% hint style="info" %} Check https://github.com/streamingfast/substreams/releases and use the latest release available {% endhint %}

From Source

git clone git@github.com:streamingfast/substreams
cd substreams
go install -v ./cmd/substreams

Validation

Ensure that substreams CLI works as expected:

substreams -v
version 0.0.5-beta3 (Commit 61cc596, Built 2022-05-09T19:35:11Z)

Ressources

• Checkout our Getting Started Guide
• Take a look at the Subtreams Template repository for a sample Substreams
• Take a look at the Substreams Playground repository for more learnings and examples

Community

Need any help? Reach out!

• StreamingFast Discord
• The Graph Discord

License

Apache 2.0

Documentation

Index

• func NewBlockScopedDataResponse(in *pbsubstreams.BlockScopedData) *pbsubstreams.Response
• func NewModulesProgressResponse(in []*pbsubstreams.ModuleProgress) *pbsubstreams.Response
• type BlockHook
• type PostJobHook
• type ResponseFunc

Functions

func NewBlockScopedDataResponse

func NewBlockScopedDataResponse(in *pbsubstreams.BlockScopedData) *pbsubstreams.Response

func NewModulesProgressResponse

func NewModulesProgressResponse(in []*pbsubstreams.ModuleProgress) *pbsubstreams.Response

Types

type BlockHook

type BlockHook func(ctx context.Context, clock *pbsubstreams.Clock) error

type PostJobHook

type PostJobHook func(ctx context.Context, clock *pbsubstreams.Clock) error

type ResponseFunc

type ResponseFunc func(resp *pbsubstreams.Response) error