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
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
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func NewBlockScopedDataResponse ¶
func NewBlockScopedDataResponse(in *pbsubstreamsrpc.BlockScopedData) *pbsubstreamsrpc.Response
func NewSnapshotComplete ¶ added in v0.0.14
func NewSnapshotComplete() *pbsubstreamsrpc.Response
func NewSnapshotData ¶ added in v0.0.14
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 ¶ added in v0.0.14
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 ¶ added in v1.0.2
type ResponseFromAnyTier interface {
ProtoMessage()
}
type ResponseFunc ¶
type ResponseFunc func(ResponseFromAnyTier) error
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
pb
|
|
|
storage
|
|
|
bench/substreams_wasi_go/pb/google/protobuf
Package timestamppb contains generated types for google/protobuf/timestamp.proto.
|
Package timestamppb contains generated types for google/protobuf/timestamp.proto. |