Search…
⌃K

FAQ

StreamingFast Substreams frequently asked questions

What is Substreams?

Substreams is an exceptionally powerful processing engine capable of consuming streams of rich blockchain data. Substreams refines and shapes the data for painless digestion by end-user applications, such as decentralized exchanges.

Do I need Firehose to use Substreams?

Developers do not need a dedicated installation of Firehose to work with Substreams. StreamingFast provides a public Firehose endpoint made available to developers.

Can I use Substreams in my subgraph?

Yes, Substreams compliments and extend the capabilities and functionalities of subgraphs. Additional information is available in the Substreams documentation for working with Graph Node and subgraphs.

Can I use Substreams for production deployments?

Substreams is provided as a developer preview at this point in time. StreamingFast is working to enable a fully production-ready solution in the very near future.

What is the Substreams CLI?

The Substreams command line interface, or CLI, is the central access point that developers use to interact with the Substreams engine. The Substreams CLI provides a range of features, commands, and flags. Additional information for working with the CLI is available in the Substreams documentation.

How do I get a Substreams authentication token?

Authentication tokens are required to work with Substreams and connect to the public Firehose endpoint. Full instructions for obtaining a StreamingFast authentication token are available in the Substreams documentation.

My Substreams authentication token isn’t working, what do I do?

The StreamingFast team is available in Discord to assist with problems related to obtaining or using authentication tokens.
The Substreams documentation also provides general instructions surrounding authentication tokens.

How do I create a Substreams implementation?

Developers can create their own Substreams implementations in a variety of ways. StreamingFast provides the Substreams Playground that has examples to use as a reference and starting point.
The Substreams documentation also provides a Developer Guide to assist with understanding and working with Substreams.

What is Substreams for?

Substreams works in conjunction with StreamingFast Firehose to enable extremely fast access and processing capabilities of blockchain data. Substreams is used for transforming rich blockchain data and exposing it to the needs of application developers.
Additional information is available on the What is Substreams page in the documentation.

Is Substreams free?

Yes, Substreams is an open-source project and available to the public for free.

How would a developer access the information returned from a call to Substreams from a web-based UI?

Right now, it’s only command line. Substreams is not meant to be piped to a web UI, it’s a data transformation layer. Eventually, Substreams will reach Subgraphs (as a data source), and at that point, Subgraphs makes a GraphQL available for web consumption. Also, other sinks might expose APIs for web browsers. It’s just not Substreams’ responsibility.

Is it possible to continuously listen for new blocks with Substreams?

Specifying a stop block value of zero (0), the default, enables transparent handoff from historical to real-time blocks.

Does StreamingFast have a Discord?

Yes! Join the StreamingFast Discord by clicking the link below.

Is StreamingFast on Twitter?

Yes! Find StreamingFast on their official Twitter account.

Is StreamingFast on YouTube?

Yes! Find StreamingFast on their official YouTube account.

Who is dfuse?

StreamingFast was originally called dfuse. The company changed the name and is in the process of phasing the old brand out.

Who is StreamingFast?

StreamingFast is a protocol infrastructure company that provides a massively scalable architecture for streaming blockchain data. StreamingFast is one of the core developers working alongside The Graph Foundation.

Why the wasm32-unknown-unknown target?

The first unknown is the system that you are compiling on, and the second is the system you are targeting.
“Compile on almost any machine, run on almost any machine.”
Additional information is available at the following link.

Why does the output show "@unknown" instead of "@type" and the decoding failed only showing "@str" and "@bytes"

Check that the module's output type fits with the protobuf definition. Sometimes the renamed the protobuf package isn't updated in the substreams.yaml manifest's module.output.type field for correct alignment.