substreams.streamingfast.io Open in urlscan Pro
2606:4700::6812:375  Public Scan

Form analysis
0 forms found in the DOM

Text Content

Search
⌃K


Substreams
Concepts & Fundamentals
Benefits and comparisons
Modules basics
Fundamentals
Getting Started
Installing the Substreams CLI
Quickstart
Developer's Guide
Overview
Dependency installation
Manifest
Protobuf schemas
Modules

Running Substreams
Parallel Execution
Sink targets

Cookbook

Reference & Specs
Chains and endpoints
Substreams CLI reference
Authentication
Manifests
Packages
Rust crates
Examples
FAQ
Release notes
Change log
Powered By GitBook


SUBSTREAMS


StreamingFast Substreams documentation
WELCOME TO SUBSTREAMS DOCUMENTATION

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 have all the benefits of StreamingFast Firehose, like low-cost
> caching and archiving of blockchain data, high throughput processing, and
> cursor-based reorgs handling.

WHERE TO START

Learn about Substreams in a short, dense 25-minute intro and understand its
impact on the blockchain ecosystem.
A walkthrough of Firehose features, Substreams modules, including a sample Rust
module and StreamingFast's vision.
Learn about the benefits of Substreams, and how it compares to otheressential
facts about Substreams through reading the Benefits and comparison.
The primary ways to use Substreams include:
Installing the substreams CLI
Going through the Quickstart

After installing Substreams and reviewing the Quickstart:
You can learn more about modules, and then study the Developer's guide.

Find pre-built Substreams by using the following resources:
The Substreams Template helps expedite the process of getting you up and
running.
A list of maintained Substreams examples

NETWORK MODEL DIAGRAM

Firehose-enabledBlockchain NodeSubstreams Service(tier1, user facing)Substreams
parallelprocessors (tier2, internal)Users in the wildSubstreams
infrastructureDatabase XSubstreamssink todatabase XUser streamingspkgTypes of
sinks:* graph-node on The Graph* Postgres* MongoDB* MySQL* Kafka* Python
program* `substreams run` CLI
You can view Substreams from two perspectives as illustrated in the high-level
visual diagram. It can be viewed through the perspective of the Substreams
engine itself and also the perspective of the end-user developer and consumer.
COMMUNITY

Substreams is an open source community effort, so feel free to suggest new
topics, report issues, and provide feedback. Contribute through GitHub pull
requests.
StreamingFast Discord
The Graph Discord
StreamingFast on Twitter
StreamingFast on YouTube

CONTRIBUTING

For additional information, refer to the general StreamingFast contribution
guide.
LICENSE

Substreams uses the Apache 2.0 license.
DISCLAIMER

The content in the Substreams documentation was created through StreamingFast's
full effort. It is up to the reader to validate the accuracy of all content
presented. Substreams is in active development and, at times, the associated
documentation becomes outdated. Contact StreamingFast to report problems or
service interruptions.
Note: The Substreams documentation uses the Google developer documentation style
guide for its style and formatting.
Next - Concepts & Fundamentals
Benefits and comparisons

Last modified 8d ago
On this page
Welcome to Substreams documentation
Where to start
Network model diagram
Community
Contributing
License
Disclaimer
Substreams
Concepts & Fundamentals
Benefits and comparisons
Modules basics
Fundamentals
Getting Started
Installing the Substreams CLI
Quickstart
Developer's Guide
Overview
Dependency installation
Manifest
Protobuf schemas
Modules

Running Substreams
Parallel Execution
Sink targets

Cookbook

Reference & Specs
Chains and endpoints
Substreams CLI reference
Authentication
Manifests
Packages
Rust crates
Examples
FAQ
Release notes
Change log
Powered By GitBook