LogoLogo
Package RegistryThe Graph
  • Introduction
  • Getting Started
  • Tutorials
    • Develop Your First Substreams
      • on EVM
      • on Solana
        • Transactions & Instructions
        • Account Changes
      • on Cosmos
        • Injective
        • MANTRA
      • on Starknet
      • on Stellar
    • Publishing a Substreams Package
  • How-To Guides
    • Developing Substreams
      • on EVM
        • Exploring Ethereum
          • Mapping Blocks
          • Filter Transactions
          • Retrieve Events of a Smart Contract
      • on Solana
        • Explore Solana
          • Filter Instructions
          • Filter Transactions
        • SPL Token Tracker
        • NFT Trades
        • DEX Trades
      • on Cosmos
        • Injective
          • Simple Substreams Example
          • Foundational Modules
          • Dojo DEX USDT Volume Subgraph Example
    • Using a Substreams Sink
      • Substreams:SQL
      • Substreams:Subgraph
        • Triggers
        • Graph Out
      • Substreams:Stream
        • JavaScript
        • Go
      • Substreams:PubSub
      • Community Sinks
        • MongoDB
        • Files
        • Key-Value Store
        • Prometheus
    • EVM Extensions
      • Making eth_calls
    • Getting Started Using Rust and Protobuf
      • Rust
        • Option struct
        • Result struct
      • Protobuf Schemas
    • From Yellowstone to Substreams
  • Reference Material
    • Chains and endpoints
      • Ethereum Data Model
    • Never Miss Data
    • Development Container Reference
    • Substreams CLI
      • Install the CLI
      • Authentication
      • Substreams CLI reference
    • Substreams Components
      • Packages
      • Modules
        • Module types
        • Inputs
        • Output
        • Module handlers
        • Module handler creation
        • Indexes
        • Keys in stores
        • Dynamic data sources
        • Aggregation Windows
        • Parameterized Modules
      • Manifests Reference
    • Substreams Architecture
    • Graph-Node
      • Local Development
      • Publish to The Graph Network
    • Indexer Reference
      • Test Substreams Locally
    • Logging, Debugging & Testing
    • Change log
    • FAQ
  • Decentralized Indexing
    • What is The Graph?
Powered by GitBook
On this page
  • Substreams FAQ overview
  • What is Substreams?
  • Do I need Firehose to use Substreams?
  • Is it possible to use Substreams in my subgraph?
  • Is it possible to use Substreams for production deployments?
  • What's in the Substreams name?
  • What is the substreams CLI?
  • How do I get a Substreams authentication token?
  • My Substreams authentication token isn’t working, what do I do?
  • How do I create a Substreams module?
  • What is Substreams used for?
  • Is Substreams free?
  • How does a developer reach the information returned from a call to Substreams from a web-based UI?
  • Is it possible to listen for new blocks?
  • Does StreamingFast have a Discord?
  • Is StreamingFast on Twitter?
  • Is StreamingFast on YouTube?
  • Who is dfuse?
  • What is Sparkle?
  • Who is StreamingFast?
  • Why the wasm32-unknown-unknown target?
  • Why does the output show "@unknown" instead of "@type" and the decoding failed only showing "@str" and "@bytes"
  • Can I retrieve Mempool data with Substreams?

Was this helpful?

Edit on GitHub
  1. Reference Material

FAQ

StreamingFast Substreams frequently asked questions

PreviousChange log

Last updated 9 days ago

Was this helpful?

Substreams FAQ overview

You can find answers to common Substreams questions in the FAQ documentation. If the answer you're looking for is not included through Discord to get help.

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 use Substreams. StreamingFast provides a public Firehose endpoint made available to developers.

Is it possible to use Substreams in my subgraph?

Yes, Substreams compliments and extend the capabilities and functionalities of subgraphs. Additional information is available in the .

Is it possible to use Substreams for production deployments?

Yes. Substreams is and used in production at multiple outlets.

What's in the Substreams name?

Substreams is the name of the engine, and of the product. It is to be capitalized and kept plural. One can speak of an individual module or individual stream but in general, when speaking about the engine, you would use the word "Substreams".

What is the substreams CLI?

How do I get a Substreams authentication token?

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

How do I create a Substreams module?

What is Substreams used for?

Substreams and Firehose work together to index and process blockchain data. Substreams is used for transforming rich blockchain data and exposing it to the needs of application developers.

Is Substreams free?

Yes, Substreams is an open-source project and there are free (albeit rate-limited) endpoints available.

How does a developer reach the information returned from a call to Substreams from a web-based UI?

Substreams is not meant to be piped to a web UI, it’s a data transformation layer. Substreams reaches Subgraphs, as a data source, and makes GraphQL available for web consumption. Other sinks might expose APIs for web browsers, however, it's not the responsibility of Substreams.

Is it possible to listen for new blocks?

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

Does StreamingFast have a Discord?

Is StreamingFast on Twitter?

Is StreamingFast on YouTube?

Who is dfuse?

StreamingFast was originally called dfuse. The company changed its name and is in the process of rebranding.

What is Sparkle?

Who is StreamingFast?

StreamingFast is a protocol infrastructure company providing 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 you are compiling on, and the second is the system you are targeting.

“Compile on almost any machine, run on almost any machine.”

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

Check to make sure the module's output type matches the protobuf definition. In some cases, the renamed protobuf package isn't updated in the substreams.yaml manifest file's module.output.type field, creating an incompatibility.

Can I retrieve Mempool data with Substreams?

No, it is currently NOT possible to retrieve Mempool data with Substreams.

The is the main tool developers use to use the Substreams engine. The provides a range of features, commands, and flags. Additional information for the is available in the Substreams documentation.

Authentication tokens are required to use Substreams and connect to the public Firehose endpoint. Full are available in the Substreams documentation.

The StreamingFast team is related to obtaining or by using authentication tokens.

The Substreams documentation also tokens.

Developers create their own Substreams implementations in a variety of ways. Use these as a reference and starting point.

The Substreams documentation to assist you to understand and use Substreams.

Yes, .

Yes, .

Yes, .

Substreams is the successor of . Substreams enables greater composability, and provides similar parallelization capabilities. Sparkle is deprecated.

Additional information .

contact the StreamingFast team
Substreams documentation for graph-node and subgraphs
generally available
substreams command line interface (CLI)
substreams CLI
substreams CLI
instructions for obtaining a StreamingFast authentication token
available on Discord to resolve problems
provides general instructions surrounding authentication
examples
provides a Developer's guide
join the StreamingFast Discord
find StreamingFast on their official Twitter account
find StreamingFast on their official YouTube account
StreamingFast Sparkle
is available in the Github issue for WASM-bindgen