substreams

README

Substreams

Developer preview

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

Substreams enables developers 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.

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

Documentation

Full documentation for installing, running and working with Substreams is available at: https://substreams.streamingfast.io.

Contributing

Please first refer to the general StreamingFast contribution guide, if you wish to contribute to this code base.

License

Apache 2.0

Documentation

Index

• func NewBlockScopedDataResponse(in *pbsubstreamsrpc.BlockScopedData) *pbsubstreamsrpc.Response
• func NewSnapshotComplete() *pbsubstreamsrpc.Response
• func NewSnapshotData(in *pbsubstreamsrpc.InitialSnapshotData) *pbsubstreamsrpc.Response
• type BlockHook
• type GrpcClientFactory
• type PostJobHook
• type ResponseFromAnyTier
• type ResponseFunc

Functions

func NewBlockScopedDataResponse

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

func NewSnapshotComplete

func NewSnapshotComplete() *pbsubstreamsrpc.Response

func NewSnapshotData

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

Types

type BlockHook

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

BlockHooks will always be called with a valid clock

type GrpcClientFactory

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

type PostJobHook

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

PostJobHooks will be called at the end of a job. The clock can be `nil` in some circumstances, or it can be >= job.StopBlock

type ResponseFromAnyTier

type ResponseFromAnyTier interface {
	ProtoMessage()
}

type ResponseFunc

type ResponseFunc func(ResponseFromAnyTier) error