substreams

README

Substreams

Developer preview

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. This iteration enables greater composability, provides similar powers of parallelization, and is a much simpler model to work with.

Documentation

Full documentation is accessible at https://substreams.streamingfast.io.

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

Documentation

Index

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

Functions

func NewBlockScopedDataResponse

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

func NewModulesProgressResponse

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

func NewSnapshotComplete

func NewSnapshotComplete() *pbsubstreams.Response

func NewSnapshotData

func NewSnapshotData(in *pbsubstreams.InitialSnapshotData) *pbsubstreams.Response

Types

type BlockHook

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

type GrpcClientFactory

type GrpcClientFactory func(context.Context) (streamClient pbsubstreams.StreamClient, closeFunc func() error, opts []grpc.CallOption, err error)

type PostJobHook

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

type ResponseFunc

type ResponseFunc func(resp *pbsubstreams.Response) error