StreamingFast Substreams packages reference
A Substreams package is a single file containing all necessary dependencies including:
- Protobuf definitions as FileDescriptors
- Compiled WASM code
- Module DAG definition
Substreams packages are protobuf-serialized files. The standard extension for Substreams packages is
Tip: Packages expedite the use of Substreams and allow developers to begin streaming immediately.
Substreams packages conform to Buf images and the standard protobuf FileDescriptorSet message layout. They therefore can be used with multiple code generation tools as a replacement for raw
.protofiles. They implement a pattern called Self-describing Messages.
substreams pack ./substreams.yaml
Developers can use modules and protobuf definitions from other Substreams packages when
importsis defined in the manifest.
Important: To avoid potential naming collisions select unique
.protofilenames and namespaces specifying fully qualified paths.
Local protobuf filenames take precedence over the imported package's proto files.