Change log
Last updated
Was this helpful?
Last updated
Was this helpful?
All notable changes to this project will be documented in this file.
The format is based on , and this project adheres to .
Catch "store errors" as deterministic (ex: invalid operation, store too big...), writing them to the module cache as well as errors that happen directly in the WASM code.
Ensure the 'error cache' is effective even when the "stop block" is unset (0)
Fix 'SUBSTREAMS_WORKERS_RAMPUP_TIME' environment variable that was not being honored
substreams init: fix project creation when using the --force-download-cwd flag.
Fix quicksave feature (incorrect block hash on quicksave)
Fix logging of wasm external calls in substreams request stats (previously missing in wasmtime engine)
Save deterministic failures in WASM in the module cache (under a file named errors.0123456789.zst at the failed block number), so further requests depending on this module at the same block can return the error immediately without re-executing the module.
substreams init: add Stellar to the list of supported grouped chains (this will require everyone to upgrade the CLI version to use codegen)
substreams init: create project in a new directory, not in the current directory of the user.
-- substreams init: new Protobuf field to enforce versions with the codegen.
Tier2 now returns GRPC error codes for DeadlineExceeded when it times out, and ResourceExhausted when a request is rejected due to overload
Tier1 now correctly reports tier2 job outcomes in the substreams request stats
Added jitter in "retry" logic to prevent all workers from retrying at the same time when tier2 are overloaded
Fix panic on tier2 when hitting a timeout for requests running from pre-cached module outputs
Add environment variables to control retry behavior, "SUBSTREAMS_WORKER_MAX_RETRIES" (default 10) and "SUBSTREAMS_WORKER_MAX_TIMEOUT_RETRIES" (default 2), changing from previous defaults (720 and 3) The worker_max_timeout_retries is the number of retries specifically applied to block execution timing out (ex: because of external calls)
The mechanism to slow down processing segments "ahead of blocks being sent to user" has been disabled on "noop-mode" requests, since these requests are used to pre-cache data and should not be slowed down.
The "number of segments ahead" in this mechanism has been increased from >number of parallel workers> to <number of parallel workers> * 1.5
Bugfix on server: fix panic on requests disconnecting before the resolvedStartBlock is set.
Properly reject requests with a stop-block below the "resolved" StartBlock (caused by module initialBlocks or a chain's firstStreamableBlock)
Added the resolved-start-block to the substreams request stats log
fix the 'Hint' when --limit-processed-blocks is too low, sometimes suggesting "0 or 0" and some typos
The substreams gui flag --debug-modules-output has been removed, it had zero effect.
The substreams run flag --debug-modules-output now accepts regular expressions like substreams run --debug-modules-output=".*".
Fixed --skip-package-validation to also skip sub packages being imported.
Added --limit-processed-blocks flag to substreams run and substreams gui to set the limit_processed_blocks field in the request
The information messages in 'substreams run' now print to STDERR instead of STDOUT.
Added a mechanism to slow down processing "ahead of blocks being sent to user" for 'production-mode' requests. The tier1 will not schedule tier2 jobs over { max_parallel_subrequests } segments above the current block being streamed to the user. This will ensure that a user slowly reading blocks 1, 2, 3... will not trigger a flood of tier2 jobs for higher blocks, let's say 300_000_000, that might never get read.
Added a validation on a module for the existence of 'triggering' inputs: the server will now fail with a clear error message when the only available inputs are stores used with mode 'get' (not 'deltas'), instead of silenlty skipping the module on every block.
Fixed runtime error: slice bounds out of range error on heavy memory usage with wasmtime engin
Added information about the number of blocks that need to be processed for a given request in the sf.substreams.rpc.v2.SessionInit message
Added an optional field limit_processed_blocks to the sf.substreams.rpc.v2.Request. When set to a non-zero value, the server will reject a request that would process more blocks than the given value with the FailedPrecondition GRPC error code.
Improved error messages when a module execution is timing out on a block (ex: due to a slow external call) and now return a DeadlineExceeded Connect/GRPC error code instead of a Internal. Removed 'panic' from wording.
Improved connection draining on shutdown: Now waits for the end of the 'shutdown-delay' before draining and refusing new connections, then waits for 'quicksaves' and successful signaling of clients, up to a max of 30 sec.
In substreams request stats log, add fields: remote_jobs_completed, remote_blocks_processed and total_uncompressed_read_bytes
Fix a bug where a 'worker pool' could incorrectly get exhausted
Fix another cannot resolve 'old cursor' from files in passthrough mode -- not implemented bug when receiving a request in production-mode with a cursor that is below the "linear handoff" block
This release brings performance improvements to the substreams engine, through the introduction of a new "QuickSave" feature, and a switch to wasmtime as the default runtime for Rust modules.
Implement "QuickSave" feature to save the state of "live running" substreams stores when shutting down, and then resume processing from that point if the cursor matches.
enabled if the "QuickSaveStoreURL" attribute is not empty in the tier1 config
requires the "CheckPendingShutdown" module to be passed to the app via NewTier1()
Rust modules will now be executed with wasmtime by default instead of wazero.
Prevents the whole server from stalling in certain memory-intensive operations in wazero.
Speed improvement: cuts the execution time in half in some circumstances.
Wazero is still used for modules with wbindgen and modules compiled with tinygo.
Set env var SUBSTREAMS_WASM_RUNTIME=wazero to revert to previous behavior.
Fixed --skip-package-validation to also skip sub packages being imported.
Trim down packages when using 'imports': only the modules explicitly defined in the YAML manifest and their dependencies will end up in the final spkg.
Added GlobalRequestPool to the Tier1Modules struct in app/tier1.go and integrated it into the Run method to enhance request lifecycle management.
When set, the GlobalRequestPool will manage the borrowing, quotas, and keep-alive mechanisms for user requests via requests to a GRPC remote server.
Added WorkerPoolFactory to the Tier1Modules struct in app/tier1.go and integrated it into the Run method to enhance worker lifecycle management.
When set, the WorkerPool will manage the borrowing, quotas, and keep-alive mechanisms for worker subrequests on tier2, via requests to a GRPC remote server.
Added 'shared cache' on tier1: execution of modules near the HEAD of the chain will be done once for a given module hash and the result shared between requests. This will reduce CPU usage and increase performance when many requests are using the same modules (ex: foundational modules)
Improved "time to first block" when a lot of cached files exist on dependency substreams modules by skipping reads segments that won't be used and assuming stores "full KVs" are always filled sequentially (since they are!)
Limit parallel execution of a stage's layer.
Previously, the engine was executing modules in a stage's layer all in parallel. We now change that behavior, development mode will from now on execute every sequentially and when in production mode will limit parallelism to 2 (hard-coded) for now.
The auth plugin can control that value dynamically by providing a trusted header X-Sf-Substreams-Stage-Layer-Parallel-Executor-Max-Count.
Fixed a regression since "v1.12.2" where the SkipEmptyOutput instruction was ignored in substreams mappers
Removed enforcement of BUFBUILD_AUTH_TOKEN environment variable when using descriptor sets. It appears there is now a public free tier to query those which should work in most cases.
When running Solana package, set base58 encoding by default in the GUI.
Add Sei Mainnet to the ChainConfigByID map.
Fix log regression on 'substreams request stats' (bad value for production_mode/tier)
Added WorkerPoolFactory to Tier1Modules and RemoteWorkerClient to Tier2Modules to support enhanced worker pool management.
Introduced WorkerKeepAliveDelay in Tier1Config to manage worker pool keep-alive settings.
Updated Tier1App and Tier2App to utilize the new worker pool components in their Run methods.
Refactored the orchestrator loop package to introduce a new Msg interface and associated message types, enhancing the message handling mechanism.
Modified the Scheduler and ParallelProcessor to integrate with the new worker pool interface and handle job scheduling more effectively.
Introduce loop.IsMsg interface to ensure proper message handling.
Improve noop-mode: will now only send one signal per bundle, without any data.
Improve logging.
Add --noop-mode flag to substreams run as a simple way to force the server to generate caches in production-mode.
Add Stellar Mainnet and Testnet to the HardcodedEndpoints map.
Fix a panic when a substreams was using an index as an input which contained empty output
Fixed tier2 app not setting itself as ready on startup
Added extra ad-hoc prometheus labels 'tools prometheus-explorer' as query params to each endpoint.
Fix a thread leak in cursor resolution resulting in a bad value for active_connections metric
Fix detection of accepted gzip compression when multiple values are sent in the Grpc-Accept-Encoding header (ex: Python library)
Properly accept and compress responses with gzip for browser HTTP clients using ConnectWeb with Accept-Encoding header
Allow setting subscription channel max capacity via SOURCE_CHAN_SIZE env var (default: 100)
Added tier1 app configuration option to limit max active requests a single instance can accept before starting to reject them with 'Unavailable' gRPC code.
Added tier1 & tier2 app new Prometheus metric substreams_{tier1,tier2}_rejected_request_counter, to track rejected request, especially when hard limit is reached.
improvements to 'tools prometheus-explorer'
change flags lookup_interval and lookup_timeout to --interval and --timeout
now support relative block (default is now: -1) and does not use 'final-blocks-only' flag on request
add --max-freshness flag to check for block age (when using relative block)
add substreams_healthcheck_block_age_ms prometheus metric
--block-height is now a flag instead of a positional argument
improve logging
removed "3 retries" that were built in and causing more confusion
add User-Agent headers depending on the client command
Fixed: detection of gzip compression on 'connect' protocol (js/ts clients)
Added: tier1.Config EnforceCompression to refuse incoming connections that do not support GZIP compression (default: false)
Fix too many memory allocations impacting performance when stores are used
Force topological ordering of protobuf descriptors when 'packing' an spkg (affecting current substreams-js clients)
Allow substreams pack to be able to do a "re-packing" of an existing spkg file. Useful to apply the protobuf descriptor ordering fix.
Rebuilt of v1.11.1 to generate Docker latest tag with revamp Docker image building.
Substreams CLI is now built with using Ubuntu 22, previous releases were built using Ubuntu 20.
Substreams Docker image is now using ubuntu:22 as its base, previous releases were built using ubuntu:20.04.
Fix the gui breaking when the network field is not set in the spkg
Fixed SUBSTREAMS_REGISTRY_TOKEN environment variable not taking precedence over the registry-token file.
Commands run, gui and info now accept the new standard package definition (ex: ethereum-common@latest) to reference an spkg file from https://substreams.dev.
Changed substreams run: the two positional parameters now align with gui: [package [module_name]]. The syntax substreams run <module_name> is not accepted anymore.
Added substreams publish to publish a package on the substreams registry (check on https://substreams.dev).
Added substreams registry to login and publish on the substreams registry (check on https://substreams.dev).
Added substreams tools extract-wasm to extract a wasm file from a substreams package.
Add avalanche-mainnet to the CLI.
Fix substreams gui selecting the wrong module in the 'outputs' view if there is no output the selected output_module.
Add the block 'age' printed clock headers in thesubstreams run command.
Add Mantra Mainnet and Testnet to the HardcodedEndpoints map.
Add Vara Mainnet and Testnet to the HardcodedEndpoints map.
Fix substreams gui command downloading spkg twice which would cause some issues with spkg that are very big.
Add base58 decoding in the output view for the substreams gui
Note All caches for stores using the updatePolicy
set_sum(added in substreams v1.7.0) and modules that depend on them will need to be deleted, since they may contain bad data.
Fix bad data in stores using set_sum policy: squashing of store segments incorrectly "summed" some values that should have been "set" if the last event for a key on this segment was a "sum"
Fix panic in initialization (metrics sender not set)
Fix small bug making some requests in development-mode slow to start (when starting close to the module initialBlock with a store that doesn't start on a boundary)
Fixed substreams build creating a buf.gen.yaml file with absolute paths (should be relative)
Removed --show-generated-buf-gen flag to substreams protogen
Bumped neoeinstein-prost version in auto-generated buf.gen.yaml file when using substreams protogen or substreams build (compatible with new substreams-0.6 and prost-0.13)
Fixed substreams gui panic (regression appeared in v1.10.3)
Fixed an(other) issue where multiple stores running on the same stage with different initialBlocks will fail to proress (and hang)
Fix bug where some invalid cursors may be sent (with 'LIB' being above the block being sent) and add safeguard/loggin if the bug appears again
Fix panic in the whole tier2 process when stores go above the size limit while being read from "kvops" cached changes
Add -o cursor output type to substreams run for debugging purposes
Fix "cannot resolve 'old cursor' from files in passthrough mode" error on some requests with an old cursor
Fix handling of 'special case' substreams module with only "params" as its input: should not skip this execution (used in graph-node for head tracking)
-> empty files in module cache with hash d3b1920483180cbcd2fd10abcabbee431146f4c8 should be deleted for consistency
Add substreams tools default-endpoint {network-name} to help with auto-configuration tools
Bump substreams init protocol version to "1" to be compatible with new codegen endpoint
substreams gui: fix panic in some conditions when streaming from block 0
Note Since a bug that affected substreams with "skipping blocks" was corrected in this release, any previously produced substreams cache should be considered as possibly corrupted and be eventually replaced
Fix handling of modules that receive both filtered AND unfiltered data as their inputs -> some "repeated entries" could appear where no data should have showed up
Fix stalling on substreams with both map and store with different initialBlocks on the same stage
Fix: prevent execution of modules that should be skipped when running live or dev mode (different outputs than when running in batch mode on tier2)
substreams gui fixed a panic occuring if the given package path doesn't exist
substreams init must now be called from within your project folder (it no longer downloads file in a subdirectory)
(since v1.10.0) substreams gui no longer accepts "output_module" as a single argument. It either receives nothing, the package, or the package followed by the output_module
Add sf.substreams.rpc.v2.EndpointInfo/Info endpoint (if the infoserver is given as a module, i.e. from firehose-core)
Add an execution timeout of 3 minutes per block by default (can be overriden in tier1/tier2 Configs) -- this is useful when an external (eth_call) is stuck on a forked block hash.
Revert 'initialBlocks' changes from v1.9.1 because a 'changing module hash' causes more trouble.
Wazero: bump v1.8.0 and activate caching of precompiled wasm modules in /tmp/wazero to decrease compilation time
Metering update: more detailed metering with addition of new metrics (live_uncompressed_read_bytes, live_uncompressed_read_forked_bytes, file_uncompressed_read_bytes, file_uncompressed_read_forked_bytes, file_compressed_read_forked_bytes, file_compressed_read_bytes, file_uncompressed_write_bytes, file_compressed_write_bytes). DEPRECATION WARNING: bytes_read and bytes_written metrics will be removed in the future, please use the new metrics for metering instead.
Manifest reader: increase timeout of remote spkg fetch to 5 minutes, up from 30 seconds
Add substreams auth command, to authenticate via thegraph.market and to get a dev API Key.
Rename --discovery-endpoint into codegen-endpoint in substreams init command.
Add substreams codegen subgraph command that takes a substreams module and an spkg and that generates a simple subgraph from the module output.
On substreams init command, if flag --state-file is provided, the state file is used by default for project generation.
In substreams init command, the state file is named using a Date format and not using Unix anymore.
Tools->prometheus: added the possibility to override the start-block on an endpoint
substreams gui no longer accepts "output_module" as a single argument. It either receives nothing, the package, or the package followed by the output_module
Fixed error handling issue in 'backprocessing' causing high CPU usage in tier1 servers
Fixed handling of packages referenced by ipfs:// URL (now simply using /api/v0/cat?arg=...)
Added --used-modules-only flag to substreams info to only show modules that are in execution tree for the given output_module
Added support for directly reading spkg file that is compressed with zstd (from http, gs, s3, azure or local)
Prevent Noop handler from sending outputs with 'Stalled' step in cursor (which breaks substreams-sink-kv)
Fixed substreams hanging in production-mode on chains with a 'first-streamable-block' higher than 0:
all initialBlocks will be 'bumped' to the first-streamable-block if it is higher
this will affect the module hashes: use substreams info --first-streamable-block=<block_num> to see how a value will affect your modules
modules with initialBlocks higher than the first-streamable-block of a chain will be unaffected.
Fix a bug introduced in v1.6.0 that could result in corrupted store "state" file if all the "outputs" were already cached for a module in a given segment (rare occurence)
We recommend clearing your substreams cache after this upgrade and re-processing or validating your data if you use stores.
substreams 'tools decode state' now correctly prints the kvops when pointing to store output files
Expose a new intrinsic to modules: skip_empty_output, which causes the module output to be skipped if it has zero bytes. (Watch out, a protobuf object with all its default values will have zero bytes)
Improve schedule order (faster time to first block) for substreams with multiple stages when starting mid-chain
substreams init (code generation): fix displaying of saved path in filenames
Add a NoopMode to the Tier1 enabling to avoid sending data back to requester while processing live.
Add 'compressed' boolean field to the 'incoming request' log
Add a substreams live back filler, so a request running close to HEAD in production-mode on tier1 will trigger jobs on tier2 when boundaries are passed by final blocks, backfilling the cache. These jobs will be "unmetered".
Fixed Substreams tier1 active worker request metrics that was not decrementing correctly.
Truncate error messages log lines to 18k characters to prevent them from disappearing through some load balancers.
Removed local ethereum code generation from init command.
Faster bootstrapping through bstream improvements, now only loads and keeps 200 blocks below LIB to link with merged blocks.
Fixed delay in serving requests close to chain HEAD when using production-mode
use attributeIf module with use attribute has not inputs at all, inputs are replaced by used module inputs
If module with use attribute has no blockFilter, it's replaced by used module blockFilter
If blockFilter is set to {}, it will be considered as nil in the spkg, enabling module with use
attribute to override the blockFilter by a nil one
Substreams engine is now able run Rust code that depends on solana_program in Solana land to decode and alloy/ether-rs in Ethereum land
solana_program or alloy/ether-rsThe Substreams engine is now able to "shims" those wasmbindgen imports enabling you to run code that depends libraries like solana_program and alloy/ether-rs which are known to pull those wasmbindgen imports. This is going to work as long as you do not actually call those special imports. Normal usage of those libraries don't accidentally call those methods normally. If they are called, the WASM module will fail at runtime and stall the Substreams module from going forward.
To enable this feature, you need to explicitly opt-in by appending a +wasm-bindgen-shims at the end of the binary's type in your Substreams manifest:
to become
substreams.yaml now supports localPath attribute under protobuf.descriptorSets, so you can pre-build a descriptor set using buf build --as-file-descriptor-set -o myfile.binpb and add it directly to your substreams package.
Substreams clients now enable gzip compression over the network (already supported by servers).
Substreams binary type can now be optionally composed of runtime extensions by appending a +<extension>,[<extesions...>] at the end of the binary type. Extensions are key[=value] that are runtime specifics.
[!NOTE] If you were a library author and parsing generic Substreams manifest(s), you will now need to handle that possibility in the binary type. If you were reading the field without any processing, you don't have to change nothing.
Fixed a failure in protogen where duplicate files would "appear multiple times" and fail.
Fixed bug with block rate underflow in gui.
Added store with update policy set_sum which allows the store to either sum a numerical value, or set it to a new value.
Re-added Ethereum Sepolia support in substreams init.
Fixed a bug with the new descriptorSets feature that wasn't ordered properly to correctly generate Protobuf bindings.
execout: preload only one file instead of two, log if undeleted caches found
execout: add environment variable SUBSTREAMS_DISABLE_PRELOAD_EXEC_FILES to disable file preloading
Revert sanity check to support the special case of a substreams with only 'params' as input. This allows a chain-agnostic event to be sent, along with the clock.
Fix error handling when resolved start-block == stop-block and stop-block is defined as non-zero
Note Upgrading to v1.6.0 will require changing the tier1 and tier2 versions concurrently, as the internal protocol has changed.
Index Modules and Block Filter can now be used to speed up processing and reduce the amount of parsed data.
When indexes are used along with the BlockFilter attribute on a mapper, blocks can be skipped completely: they will not be run in downstreams modules or sent in the output stream, except in live segment or in dev-mode, where an empty 'clock' is still sent.
Blocks that are skipped will still appear in the metering as "read bytes" (unless a full segment is skipped), but the index stores themselves are not "metered"
The scheduler no longer duplicates work in the first segments of a request with multiple stages.
Fix all issues with running a substreams where modules have different "initial blocks"
Maximum Tier1 output speed improved for data that is already processed
Tier1 'FileWalker' now polls more aggressively on local filesystem to prevent extra seconds of wait time.
Fix a bug in the gui that would crash when trying to restart the stream.
fix total read bytes in case data already cache
New environment variable SUBSTREAMS_WORKERS_RAMPUP_TIME can specify the initial delay before tier1 will reach the number of tier2 concurrent requests.
Add 'clock' output to substreams run command, useful mostly for performance testing or pre-caching
(alpha) Introduce the wasip1/tinygo-v1 binary type.
Disabled otelcol:// tracing protocol, its mere presence affected performance.
Previous value for SUBSTREAMS_WORKERS_RAMPUP_TIME was 4s, now set to 0, disabling the mechanism by default.
Fix bug where substreams tier2 would sometimes write outputs with the wrong tag (leaked from another tier1 request)
Removed MaxWasmFuel since it is not supported in Wazero
bump wazero execution to fix issue with certain substreams causing the server process to freeze
Allow unordered ordinals to be applied from the substreams (automatic ordering before flushing to stores)
add substreams_tier1_worker_retry_counter metric to count all worker errors returned by tier2
add substreams_tier1_worker_rejected_overloaded_counter metric to count only worker errors with string "service currently overloaded"
add google/protobuf/duration.proto to system proto files
Support for buf build urls in substreams manifest. Ex.:
fix a possible panic() when an request is interrupted during the file loading phase of a squashing operation.
fix a rare possibility of stalling if only some fullkv stores caches were deleted, but further segments were still present.
fix stats counters for store operations time
Performance, memory leak and bug fixes
fix memory leak on substreams execution (by bumping wazero dependency)
prevent substreams-tier1 stopping if blocktype auto-detection times out
allow specifying blocktype directly in Tier1 config to skip auto-detection
fix missing error handling when writing output data to files. This could result in tier1 request just "hanging" waiting for the file never produced by tier2.
fix handling of dstore error in tier1 'execout walker' causing stalling issues on S3 or on unexpected storage errors
increase number of retries on storage when writing states or execouts (5 -> 10)
prevent slow squashing when loading each segment from full KV store (can happen when a stage contains multiple stores)
prevent 'gui' command from crashing on 'incomplete' spkgs without moduledocs (when using --skip-package-validation)
Fix a context leak causing tier1 responses to slow down progressively
Fix a panic on tier2 when not using any wasm extension.
Fix a thread leak on metering GRPC emitter
Rollback scheduler optimisation: different stages can run concurrently if they are schedulable. This will prevent taking much time to execute when restarting close to HEAD.
Add substreams_tier2_active_requests and substreams_tier2_request_counter prometheus metrics
Fix the tools tier2call method to make it work with the new 'generic' tier2 (added necessary flags)
A single substreams-tier2 instance can now serve requests for multiple chains or networks. All network-specific parameters are now passed from Tier1 to Tier2 in the internal ProcessRange request.
[!IMPORTANT] Since the
tier2services will now get the network information from thetier1request, you must make sure that the file paths and network addresses will be the same for both tiers.
[!TIP] The cached 'partial' files no longer contain the "trace ID" in their filename, preventing accumulation of "unsquashed" partial store files. The system will delete files under '{modulehash}/state' named in this format
{blocknumber}-{blocknumber}.{hexadecimal}.partial.zstwhen it runs into them.
Fix panic when using '--header (-H)' flag on gui command
When packing substreams, pick up docs from the README.md or README in the same directory as the manifest, when top-level package.doc is empty
Added "Total read bytes" summary at the end of 'substreams run' command
Some redundant reprocessing has been removed, along with a better usage of caches to reduce reading the blocks multiple times when it can be avoided. Concurrent requests may benefit the other's work to a certain extent (up to 75%)
All module outputs are now cached. (previously, only the last module was cached, along with the "store snapshots", to allow parallel processing). (this will increase disk usage, there is no automatic removal of old module caches)
Tier2 will now read back mapper outputs (if they exist) to prevent running them again. Additionally, it will not read back the full blocks if its inputs can be satisfied from existing cached mapper outputs.
Tier2 will skip processing completely if it's processing the last stage and the output_module is a mapper that has already been processed (ex: when multiple requests are indexing the same data at the same time)
Tier2 will skip processing completely if it's processing a stage that is not the last, but all the stores and outputs have been processed and cached.
The "partial" store outputs no longer contain the trace ID in the filename, allowing them to be reused. If many requests point to the same modules being squashed, the squasher will detect if another Tier1 has squashed its file and reload the store from the produced full KV.
Scheduler modification: a stage now waits for the previous stage to have completed the same segment before running, to take advantage of the cached intermediate layers.
Improved file listing performance for Google Storage backends by 25%
Tier2 service now supports a maximum concurrent requests limit. Default set to 0 (unlimited).
Readiness metric for Substreams tier1 app is now named substreams_tier1 (was mistakenly called firehose before).
Added back readiness metric for Substreams tiere app (named substreams_tier2).
Added metric substreams_tier1_active_worker_requests which gives the number of active Substreams worker requests a tier1 app is currently doing against tier2 nodes.
Added metric substreams_tier1_worker_request_counter which gives the total Substreams worker requests a tier1 app made against tier2 nodes.
Fixed substreams init generated The Graph GraphQL regarding wrong Bool types.
The substreams init command can now be used on Arbitrum Mainnet network.
This release brings important server-side improvements regarding performance, especially while processing over historical blocks in production-mode.
Performance: prevent reprocessing jobs when there is only a mapper in production mode and everything is already cached
Performance: prevent "UpdateStats" from running too often and stalling other operations when running with a high parallel jobs count
Performance: fixed bug in scheduler ramp-up function sometimes waiting before raising the number of workers
Added support for authentication using api keys. The env variable can be specified with --substreams-api-key-envvar and defaults to SUBSTREAMS_API_KEY.
Added the output module's hash to the "incoming request"
Added trace_id in grpc authentication calls
Bumped connect-go library to new "connectrpc.com/connect" location
Enable gRPC reflection API on tier1 substreams service
Added substreams init support for creating a substreams with data from fully-decoded Calls instead of only extracting events.
Added substreams init support for creating a substreams with the "Dynamic DataSources" pattern (ex: a Factory contract creating pool contracts through the PoolCreated event)
Changed substreams init to always add prefixes the tables and entities with the project name
Fixed substreams init support for unnamed params and topics on log events
Fixed substreams init generated code when dealing with Ethereum ABI events containing array types.
[!NOTE] For now, the generated code only works with Postgres, an upcoming revision is going to lift that constraint.
Fixed store.has_at Wazero signature which was defined as has_at(storeIdx: i32, ord: i32, key_ptr: i32, key_len: i32) but should have been has_at(storeIdx: i32, ord: i64, key_ptr: i32, key_len: i32).
Fixed the local substreams alpha service serve ClickHouse deployment which was failing with a message regarding fork handling.
Catch more cases of WASM deterministic errors as InvalidArgument.
Added some output-stream info to logs.
Fixed error-passing between tier2 and tier1 (tier1 will not retry sending requests that fail deterministicly to tier2)
Tier1 will now schedule a single job on tier2, quickly ramping up to the requested number of workers after 4 seconds of delay, to catch early exceptions
"store became too big" is now considered a deterministic error and returns code "InvalidArgument"
Support new networks configuration block in substreams.yaml to override modules' params and initial_block. Network can be specified at run-time, avoiding the need for separate spkg files for each chain.
[BREAKING CHANGE] Remove the support for the deriveFrom overrides. The imports, along with the new networks feature, should provide a better mechanism to cover the use cases that deriveFrom tried to address.
The networks params and `initialBlock`` overrides for the chosen network are applied to the module directly before being sent to the server. All network configurations are kept when packing an .spkg file.
Added the --network flag for choosing the network on run, gui and alpha service deploy commands. Default behavior is to use the one defined as network in the manifest.
Added the --endpoint flag to substreams alpha service serve to specify substreams endpoint to connect to
Added endpoints for Antelope chains
Command 'substreams info' now shows the params
Removed the handling of the DeriveFrom keyword in manifest, this override feature is going away.
Removed the `--skip-package-validation`` option only on run/gui/inspect/info
Added the --params flag to alpha service deploy to apply per-module parameters to the substreams before pushing it.
Renamed the --parameters flag to --deployment-params in alpha service deploy, to clarify the intent of those parameters (given to the endpoint, not applied to the substreams modules)
Small improvement on substreams gui command: no longer reads the .spkg multiple times with different behavior during its process.
Fixed bug in substreams init with numbers in ABI types
Return the correct GRPC code instead of wrapping it under an "Unknown" error. "Clean shutdown" now returns CodeUnavailable. This is compatible with previous substreams clients like substreams-sql which should retry automatically.
Upgraded components to manage the new block encapsulation format in merged-blocks and on the wire required for firehose-core v1.0.0
Fix fuzzy matching when endpoint require auth headers
Fix panic in "serve" when trying to delete a non-existing deployment
Add validation check of substreams package before sending deploy request to server
Codegen: substreams-database-change to v1.3, properly generates primary key to support chain reorgs in postgres sink.
Sink server commands all moved from substreams alpha sink-* to substreams alpha service *
Sink server: support for deploying sinks with DBT configuration, so that users can deploy their own DBT models (supported on postgres and clickhouse sinks). Example manifest file segment:
where "./dbt" is a folder containing the dbt project.
Sink server: added REST interface support for clickhouse sinks. Example manifest file segment:
Fix substreams info cli doc field which wasn't printing any doc output
Optimized start of output stream in developer mode when start block is in reversible segment and output module does not have any stores in its dependencies.
Fixed bug where the first streamable block of a chain was not processed correctly when the start block was set to the default zero value.
Codegen: Now generates separate substreams.{target}.yaml files for sql, clickhouse and graphql sink targets.
Codegen: Added support for clickhouse in schema.sql
Fixed metrics for time spent in eth_calls within modules stats (server and GUI)
Fixed undo json message in 'run' command
Fixed stream ending immediately in dev mode when start/end blocks are both 0.
Sink-serve: fix missing output details on docker-compose apply errors
Codegen: Fixed pluralized entity created for db_out and graph_out
Fixed a regression where start block was not resolved correctly when it was in the reversible segment of the chain, causing the substreams to reprocess a segment in tier 2 instead of linearly in tier 1.
Missing decrement on metrics substreams_active_requests
substreams_active_requests and substreams_counter metrics to substreams-tier1
evt_block_time in ms to timestamp in lib.rs, proto definition and schema.sql
Sink configs can now use protobuf annotations (aka Field Options) to determine how the field will be interpreted in substreams.yaml:
load_from_file will put the content of the file directly in the field (string and bytes contents are supported).
zip_from_folder will create a zip archive and put its content in the field (field type must be bytes).
Example protobuf definition:
Example manifest file:
substreams info command now properly displays the content of sink configs, optionally writing the fields that were bundled from files to disk with --output-sinkconfig-files-path=</some/path>
substreams alpha init renamed to substreams init. It now includes db_out module and schema.sql to support the substreams-sql-sink directly.
The override feature has been overhauled. Users may now override an existing substreams by pointing to an override file in run or gui command. This override manifest will have a deriveFrom field which points to the original substreams which is to be overriden. This is useful to port a substreams to one network to another. Example of an override manifest:
The substreams run and substreams gui commands now determine the endpoint from the 'network' field in the manifest if no value is passed in the --substreams-endpoint flag.
The endpoint for each network can be set by using an environment variable SUBSTREAMS_ENDPOINTS_CONFIG_<network_name>, ex: SUBSTREAMS_ENDPOINTS_CONFIG_MAINNET=my-endpoint:443
The substreams alpha init has been moved to substreams init
fixed the substreams gui command to correctly compute the stop-block when given a relative value (ex: '-t +10')
Fixed (bumped) substreams protobuf definitions that get embedded in spkg to match the new progress messages from v1.1.12.
Regression fix: fixed a bug where negative start blocks would not be resolved correctly when using substreams run or substreams gui.
In the request plan, the process previously panicked when errors related to block number validation occurred. Now the error will be returned to the client.
If the initial block or start block is less than the first block in the chain, the substreams will now start from the first block in the chain. Previously, setting the initial block to a block before the first block in the chain would cause the substreams to hang.
Fixed a bug where the substreams would fail if the start block was set to a future block. The substreams will now wait for the block to be produced before starting.
Complete redesign of the progress messages:
Tier2 internal stats are aggregated on Tier1 and sent out every 500ms (no more bursts)
No need to collect events on client: a single message now represents the current state
Message now includes list of running jobs and information about execution stages
Performance metrics has been added to show which modules are executing slowly and where the time is spent (eth calls, store operations, etc.)
[!IMPORTANT] The client and servers will both need to be upgraded at the same time for the new progress messages to be parsed:
The new Substreams servers will NOT send the old
modulesfield as part of itsprogressmessage, only the newrunning_jobs,modules_stats,stages.The new Substreams clients will NOT be able to decode the old progress information when connecting to older servers.
However, the actual data (and cursor) will work correctly between versions. Only incompatible progress information will be ignored.
Bumped substreams and substreams-ethereum to latest in substreams alpha init.
Improved error message when <module_name> is not received, previously this would lead to weird error message, now, if the input is likely a manifest, the error message will be super clear.
Fixed compilation errors when tracking some contracts when using substreams alpha init.
substreams info now takes an optional second parameter <output-module> to show how the substreams modules can be divided into stages
Pack command: added -c flag to allow overriding of certain substreams.yaml values by passing in the path of a yaml file. example yaml contents:
Removed Config.RequestStats, stats are now always enabled.
Added metering of live blocks
Fixed/Removed: jobs would hang when config parameter StateBundleSize was different from SubrequestsSize. The latter has been removed completely: Subrequests size will now always be aligned with bundle size.
Auth: added support for continuous authentication via the grpc auth plugin (allowing cutoff triggered by the auth system).
Fixed params handling in gui mode
Massive refactoring of the scheduler: prevent excessive splitting of jobs, grouping them into stages when they have the same dependencies. This should reduce the required number of tier2 workers (2x to 3x, depending on the substreams).
The tier1 and tier2 config have a new configuration StateStoreDefaultTag, will be appended to the StateStoreURL value to form the final state store URL, ex: StateStoreURL="/data/states" and StateStoreDefaultTag="v2" will make /data/states/v2 the default state store location, while allowing users to provide a X-Sf-Substreams-Cache-Tag header (gated by auth module) to point to /data/states/v1, and so on.
Authentication plugin trust can now specify an exclusive list of allowed headers (all lowercase), ex: trust://?allowed=x-sf-user-id,x-sf-api-key-id,x-real-ip,x-sf-substreams-cache-tag
The tier2 app no longer has customizable auth plugin (or any Modules), trust will always be used, so that tier can pass down its headers (e.g. X-Sf-Substreams-Cache-Tag). The tier2 instances should not be accessible publicly.
Color theme is now adapted to the terminal background (fixes readability on 'light' background)
Provided parameters are now shown in the 'Request' tab.
alpha init command: replace initialBlock for generated manifest based on contract creation block.
alpha init prompt Ethereum chain. Added: Mainnet, BNB, Polygon, Goerli, Mumbai.
alpha init reports better progress specially when performing ABI & creation block retrieval.
alpha init command without contracts fixed Protogen command invocation.
Max-subrequests can now be overridden by auth header X-Sf-Substreams-Parallel-Jobs (note: if your auth plugin is 'trust', make sure that you filter out this header from public access
Request Stats logging. When enable it will log metrics associated to a Tier1 and Tier2 request
On request, save "substreams.partial.spkg" file to the state cache for debugging purposes.
Manifest reader can now read 'partial' spkg files (without protobuf and metadata) with an option.
Fixed a bug which caused "live" blocks to be sent while the stream previously received block(s) were historic.
In GUI, module output now shows fields with default values, i.e. 0, "", false
Now using plugin: buf.build/community/neoeinstein-prost-crate:v0.3.1 when generating the Protobuf Rust mod.rs which fixes the warning that remote plugins are deprecated.
The net effect of this is that if you don't update your Substreams CLI to 1.1.7, on July 10th 2023 and after, the substreams protogen will not work anymore.
substreams-tier1 and substreams-tier2 are now standalone Apps, to be used as such by server implementations (firehose-ethereum, etc.)
The tier2 logs no longer show a parent_trace_id: the trace_id is now the same as tier1 jobs. Unique tier2 jobs can be distinguished by their stage and segment, corresponding to the output_module_name and startblock:stopblock
The substreams protogen command no longer generate the FILE_DESCRIPTOR_SET constant which generates an unsued warning in Rust. We don't think nobody relied on having the FILE_DESCRIPTOR_SET constant generated, but if it's the case, you can provide your own buf.gen.yaml that will be used instead of the generated one when doing substreams protogen.
Added -H flag on the substreams run command, to set HTTP Headers in the Substreams request.
Fixed generated buf.gen.yaml not being deleted when an error occurs while generating the Rust code.
This release fixes data determinism issues. This comes at a 20% performance cost but is necessary for integration with The Graph ecosystem.
When upgrading a substreams server to this version, you should delete all existing module caches to benefit from deterministic output
Tier1 now records deterministic failures in wasm, "blacklists" identical requests for 10 minutes (by serving them the same InvalidArgument error) with a forced incremental backoff. This prevents accidental bad actors from hogging tier2 resources when their substreams cannot go passed a certain block.
Tier1 now sends the ResolvedStartBlock, LinearHandoffBlock and MaxJobWorkers in SessionInit message for the client and gui to show
Substreams CLI can now read manifests/spkg directly from an IPFS address (subgraph deployment or the spkg itself), using ipfs://Qm... notation
When talking to an updated server, the gui will not overflow on a negative start block, using the newly available resolvedStartBlock instead.
When running in development mode with a start-block in the future on a cold cache, you would sometimes get invalid "updates" from the store passed down to your modules that depend on them. It did not impact the caches but caused invalid output.
The WASM engine was incorrectly reusing memory, preventing deterministic output. It made things go faster, but at the cost of determinism. Memory is now reset between WASM executions on each block.
The GUI no longer panics when an invalid output-module is given as argument
Changed default WASM engine from wasmtime to wazero, use SUBSTREAMS_WASM_RUNTIME=wasmtime to revert to prior engine. Note that wasmtime will now run a lot slower than before because resetting the memory in wasmtime is more expensive than in wazero.
Execution of modules is now done in parallel within a single instance, based on a tree of module dependencies.
The substreams gui and substreams run now accept commas inside a param value. For example: substreams run --param=p1=bar,baz,qux --param=p2=foo,baz. However, you can no longer pass multiple parameters using an ENV variable, or a .yaml config file.
Module hashing changed to fix cache reuse on substreams use imported modules
Memory leak fixed on rpc-enabled servers
GUI more responsive
BREAKING: The module hashing algorithm wrongfully changed the hash for imported modules, which made it impossible to leverage caches when composing new substreams off of imported ones.
Operationally, if you want to keep your caches, you will need to copy or move the old hashes to the new ones.
You can obtain the prior hashes for a given spkg with: substreams info my.spkg, using a prior release of the substreams
With a more recent substreams release, you can obtain the new hashes with the same command.
You can then cp or mv the caches for each module hash.
You can also ignore this change. This will simply invalidate your cache.
Fixed a memory leak where "PostJobHooks" were not always called. These are used to hook in rpc calls in Ethereum chain. They are now always called, even if no block has been processed (can be called with nil value for the clock)
Jobs that fail deterministically (during WASM execution) on tier2 will fail faster, without retries from tier1.
substreams gui command now handles params flag (it was ignored)
Substeams GUI responsiveness improved significantly when handling large payloads
This release contains fixes for race conditions that happen when multiple request tries to sync the same range using the same .spkg. Those fixes will avoid weird state error at the cost of duplicating work in some circumstances. A future refactor of the Substreams engine scheduler will come later to fix those inefficiencies.
Operators, please read the operators section for upgrade instructions.
Note This upgrade procedure is applies if your Substreams deployment topology includes both
tier1andtier2processes. If you have defined somewhere the config valuesubstreams-tier2: true, then this applies to you, otherwise, if you can ignore the upgrade procedure.
This release includes a small change in the internal RPC layer between tier1 processes and tier2 processes. This change requires an ordered upgrade of the processes to avoid errors.
The components should be deployed in this order:
Deploy and roll out tier1 processes first
Deploy and roll out tier2 processes in second
If you upgrade in the wrong order or if somehow tier2 processes start using the new protocol without tier1 being aware, user will end up with backend error(s) saying that some partial file are not found. Those will be resolved only when tier1 processes have been upgraded successfully.
Fixed a race when multiple Substreams request execute on the same .spkg, it was causing races between the two executors.
GUI: fixed an issue which would slow down message consumption when progress page was shown in ascii art "bars" mode
GUI: fixed the display of blocks per second to represent actual blocks, not messages count
[binary]: Commands substreams <...> that fails now correctly return an exit code 1.
[library]: The manifest.NewReader signature changed and will now return a *Reader, error (previously *Reader).
[library]: The manifest.Reader gained the ability to infer the path if provided with input "" based on the current working directory.
[library]: The manifest.Reader gained the ability to infer the path if provided with input that is a directory.
This release contains bug fixes and speed/scaling improvements around the Substreams engine. It also contains few small enhancements for substreams gui.
This release contains an important bug that could have generated corrupted store state files. This is important for developers and operators.
The store state files will be fully deleted on the Substreams server to start fresh again. The impact for you as a developer is that Substreams that were fully synced will now need to re-generate from initial block the store's state. So you might see long delays before getting a new block data while the Substreams engine is re-computing the store states from scratch.
You need to clear the state store and remove all the files that are stored under substreams-state-store-url flag. You can also make it point to a brand new folder and delete the old one after the rollout.
Fix a bug where not all extra modules would be sent back on debug mode
Fixed a bug in tier1 that could result in corrupted state files when getting close to chain HEAD
Fixed some performance and stalling issues when using GCS for blocks
Fixed storage logs not being shown properly
GUI: Fixed panic race condition
GUI: Cosmetic changes
GUI: Added traceID
This release introduces a new RPC protocol and the old one has been removed. The new RPC protocol is in a new Protobuf package sf.substreams.rpc.v2 and it drastically changes how chain re-orgs are signaled to the user. Here the highlights of this release:
Getting rid of undo payload during re-org
substreams gui Improvements
Substreams integration testing
Substreams Protobuf definitions updated
undo payload during re-orgPreviously, the GRPC endpoint sf.substreams.v1.Stream/Blocks would send a payload with the corresponding "step", NEW or UNDO.
Unfortunately, this led to some cases where the payload could not be deterministically generated for old blocks that had been forked out, resulting in a stalling request, a failure, or in some worst cases, incomplete data.
The new design, under sf.substreams.rpc.v2.Stream/Blocks, takes care of these situations by removing the 'step' component and using these two messages types:
sf.substreams.rpc.v2.BlockScopedData when chain progresses, with the payload
sf.substreams.rpc.v2.BlockUndoSignal during a reorg, with the last valid block number + block hash
The client now has the burden of keeping the necessary means of performing the undo actions (ex: a map of previous values for each block). The BlockScopedData message now includes the final_block_height to let you know when this "undo data" can be discarded.
With these changes, a substreams server can even handle a cursor for a block that it has never seen, provided that it is a valid cursor, by signaling the client to revert up to the last known final block, trading efficiency for resilience in these extreme cases.
substreams gui ImprovementsAdded key 'f' shortcut for changing display encoding of bytes value (hex, pruned string, base64)
Added jq search mode (hit / twice). Filters the output with the jq expression, and applies the search to match all blocks.
Added search history (with up/down), similar to less.
Running a search now applies it to all blocks, and highlights the matching ones in the blocks bar (in red).
Added O and P, to jump to prev/next block with matching search results.
Added module search with m, to quickly switch from module to module.
Added a basic Substreams testing framework that validates module outputs against expected values. The testing framework currently runs on substreams run command, where you can specify the following flags:
test-file Points to a file that contains your test specs
test-verbose Enables verbose mode while testing.
The test file, specifies the expected output for a given substreams module at a given block.
We changed the Substreams Protobuf definitions making a major overhaul of the RPC communication. This is a breaking change for those consuming Substreams through gRPC.
Note The is no breaking changes for Substreams developers regarding your Rust code, Substreams manifest and Substreams package.
Removed the Request and Response messages (and related) from sf.substreams.v1, they have been moved to sf.substreams.rpc.v2. You will need to update your usage if you were consuming Substreams through gRPC.
The new Request excludes fields and usages that were already deprecated, like using multiple module_outputs.
The Response now contains a single module output
In development mode, the additional modules output can be inspected under debug_map_outputs and debug_store_outputs.
Separating Tier1 vs Tier2 gRPC protocol (for Substreams server operators)
Now that the Blocks request has been moved from sf.substreams.v1 to sf.substreams.rpc.v2, the communication between a substreams instance acting as tier1 and a tier2 instance that performs the background processing has also been reworked, and put under sf.substreams.internal.v2.Stream/ProcessRange. It has also been stripped of parameters that were not used for that level of communication (ex: cursor, logs...)
The final_blocks_only: true on the Request was not honored on the server. It now correctly sends only blocks that are final/irreversible (according to Firehose rules).
Prevent substreams panic when requested module has unknown value for "type"
The substreams run command now has flag --final-blocks-only
This should be the last release before a breaking change in the API and handling of the reorgs and UNDO messages.
Added support for resolving a negative start-block on server
CHANGED: The run command now resolves a start-block=-1 from the head of the chain (as supported by the servers now). Prior to this change, the -1 value meant the 'initialBlock' of the requested module. The empty string is now used for this purpose,
GUI: Added support for search, similar to less, with /.
GUI: Search and output offset is conserved when switching module/block number in the "Output" tab.
Library: protobuf message descriptors now exposed in the manifest/ package. This is something useful to any sink that would need to interpret the protobuf messages inside a Package.
Added support for resolving a negative start-block on server (also added to run command)
The run and gui command no longer resolve a start-block=-1 to the 'initialBlock' of the requested module. To get this behavior, simply assign an empty string value to the flag start-block instead.
Added support for search within the Substreams gui output view. Usage of search within output behaves similar to the less command, and can be toggled with "/".
Fixed "undo" messages incorrectly contained too many module outputs (all modules, with some duplicates).
Fixed status bar message cutoff bug
Fixed substreams run when manifest contains unknown attributes
Fixed bubble tea program error when existing the run command
Added command substreams gui, providing a terminal-based GUI to inspect the streamed data. Also adds --replay support, to save a stream to replay.log and load it back in the UI later. You can use it as you would substreams run. Feedback welcome.
Modified command substreams protogen, defaulting to generating the mod.rs file alongside the rust bindings. Also added --generate-mod-rs flag to toggle mod.rs generation.
Added support for module parameterization. Defined in the manifest as:
and on the command-line as:
substreams run -p module=value -p "module2=other value" ...
Servers need to be updated for packages to be able to be consumed this way.
This change keeps backwards compatibility. Old Substreams Packages will still work the same, with no changes to module hashes.
Added support for {version} template in --output-file flag value on substreams pack.
Added fuel limit to wasm execution as a server-side option, preventing wasm process from running forever.
Added 'Network' and 'Sink{Type, Module, Config}' fields in the manifest and protobuf definition for future bundling of substreams sink definitions within a substreams package.
Improved execution speed and module loading speed by bumping to WASM Time to version 4.0.
Improved developer experience on the CLI by making the <manifest> argument optional.
The CLI when <manifest> argument is not provided will now look in the current directory for a substreams.yaml file and is going to use it if present. So if you are in your Substreams project and your file is named substreams.yaml, you can simply do substreams pack, substreams protogen, etc.
Moreover, we added to possibility to pass a directory containing a substreams.yaml directly so substreams pack path/to/project would work as long as path/to/project contains a file named substreams.yaml.
Fixed a bug that was preventing production mode to complete properly when using a bounded block range.
Improved overall stability of the Substreams engine.
Breaking Config values substreams-stores-save-interval and substreams-output-cache-save-interval have been merged together into substreams-cache-save-interval in the firehose-<chain> repositories. Refer to chain specific firehose-<chain> repository for further details.
The <manifest> can point to a directory that contains a substreams.yaml file instead of having to point to the file directly.
The <manifest> parameter is now optional in all commands requiring it.
Fixed valuetype mismatch for stores
Fixed production mode not completing when block range was specified
Fixed tier1 crashing due to missing context canceled check.
Fixed some code paths where locking could have happened due to incorrect checking of context cancellation.
Request validation for blockchain's input type is now made only against the requested module it's transitive dependencies.
Updated WASM Time library to 4.0.0 leading to improved execution speed.
Remove distinction between output-save-interval and store-save-interval.
substreams init has been moved under substreams alpha init as this is a feature included by mistake in latest release that should not have been displayed in the main list of commands.
substreams codegen has been moved under substreams alpha codegen as this is a feature included by mistake in latest release that should not have been displayed in the main list of commands.
This upcoming release is going to bring significant changes on how Substreams are developed, consumed and speed of execution. Note that there is no breaking changes related to your Substreams' Rust code, only breaking changes will be about how Substreams are run and available features/flags.
Here the highlights of elements that will change in next release:
In this rest of this post, we are going to go through each of them in greater details and the implications they have for you. Full changelog is available after.
We introduce an execution mode when running Substreams, either production mode or development mode. The execution mode impacts how the Substreams get executed, specifically:
The time to first byte
The module logs and outputs sent back to the client
How parallel execution is applied through the requested range
The difference between the modes are:
In development mode, the client will receive all the logs of the executed modules. In production mode, logs are not available at all.
In development mode, module's are always re-executed from request's start block meaning now that logs will always be visible to the user. In production mode, if a module's output is found in cache, module execution is skipped completely and data is returned directly.
In development mode, every module's output is returned back in the response but only root module is displayed by default in substreams CLI (configurable via a flag). In production mode, only root module's output is returned.
In development mode, you may request specific store snapshot that are in the execution tree via the substreams CLI --debug-modules-initial-snapshots flag. In production mode, this feature is not available.
The execution mode is specified at that gRPC request level and is the default mode is development. The substreams CLI tool being a development tool foremost, we do not expect people to activate production mode (-p) when using it outside for maybe testing purposes.
Final note, we recommend to run the production mode against a compiled .spkg file that should ideally be released and versioned. This is to ensure stable modules' hashes and leverage cached output properly.
We now only support 1 output module when running a Substreams, while prior this release, it was possible to have multiple ones.
Only a single module can now be requested, previous version allowed to request N modules.
Only map module can now be requested, previous version allowed map and store to be requested.
InitialSnapshots is now forbidden in production mode and still allowed in development mode.
In development mode, the server sends back output for all executed modules (by default the CLI displays only requested module's output).
Note We added
output_moduleto the Substreams request and keptoutput_modulesto remain backwards compatible for a while. If anoutput_moduleis specified we will honor that module. If not we will checkoutput_modulesto ensure there is only 1 output module. In a future release, we are going to removeoutput_modulesaltogether.
With the introduction of development vs production mode, we added a change in behavior to reduce frictions this changes has on debugging. Indeed, in development mode, all executed modules's output will be sent be to the user. This includes the requested output module as well as all its dependencies. The substreams CLI has been adjusted to show only the output of the requested output module by default. The new substreams CLI flag -debug-modules-output can be used to control which modules' output is actually displayed by the CLI.
Migration Path If you are currently requesting more than one module, refactor your Substreams code so that a single
mapmodule aggregates all the required information from your different dependencies in one output.
mapIt is now forbidden to request a store module as the output module of the Substreams request, the requested output module must now be of kind map. Different factors have motivated this change:
Recently we have seen incorrect usage of store module. A store module was not intended to be used as a persistent long term storage, store modules were conceived as a place to aggregate data for later steps in computation. Using it as a persistent storage make the store unmanageable.
We had always expected users to consume a map module which would return data formatted according to a final sink spec which will then permanently store the extracted data. We never envisioned store to act as long term storage.
Forward parallel execution does not support a store as its last step.
Migration Path If you are currently using a
storemodule as your output store. You will need to create amapmodule that will have as input thedeltasof saidstoremodule, and return the deltas.
Let's assume a Substreams with these dependencies: [block] --> [map_pools] --> [store_pools] --> [map_transfers]
Running substreams run substreams.yaml map_transfers will only print the outputs and logs from the map_transfers module.
Running substreams run substreams.yaml map_transfers --debug-modules-output=map_pools,map_transfers,store_pools will print the outputs of those 3 modules.
InitialSnapshots is now a development mode feature onlyNow that a store cannot be requested as the output module, the InitialSnapshots did not make sense anymore to be available. Moreover, we have seen people using it to retrieve the initial state and then continue syncing. While it's a fair use case, we always wanted people to perform the synchronization using the streaming primitive and not by using store as long term storage.
However, the InitialSnapshots is a useful tool for debugging what a store contains at a given block. So we decided to keep it in development mode only where you can request the snapshot of a store module when doing your request. In the Substreams' request/response, initial_store_snapshot_for_modules has been renamed to debug_initial_store_snapshot_for_modules, snapshot_data to debug_snapshot_data and snapshot_complete to debug_snapshot_complete.
Migration Path If you were relying on
InitialSnapshotsfeature in production. You will need to create amapmodule that will have as input thedeltasof saidstoremodule, and then synchronize the full state on the consuming side.
Let's assume a Substreams with these dependencies: [block] --> [map_pools] --> [store_pools] --> [map_transfers]
Running substreams run substreams.yaml map_transfers -s 1000 -t +5 --debug-modules-initial-snapshot=store_pools will print all the entries in store_pools at block 999, then continue with outputs and logs from map_transfers in blocks 1000 to 1004.
There are 2 ways parallel execution can happen either backward or forward.
Backward parallel execution consists of executing in parallel block ranges from the module's start block up to the start block of the request. If the start block of the request matches module's start block, there is no backward parallel execution to perform. Also, this is happening only for dependencies of type store which means that if you depends only on other map modules, no backward parallel execution happens.
Forward parallel execution consists of executing in parallel block ranges from the start block of the request up to last known final block (a.k.a the irreversible block) or the stop block of the request, depending on which is smaller. Forward parallel execution significantly improves the performance of the Substreams as we execute your module in advanced through the chain history in parallel. What we stream you back is the cached output of your module's execution which means essentially that we stream back to you data written in flat files. This gives a major performance boost because in almost all cases, the data will be already for you to consume.
Forward parallel execution happens only in production mode is always disabled when in development mode. Moreover, since we read back data from cache, it means that logs of your modules will never be accessible as we do not store them.
Backward parallel execution still occurs in development and production mode. The diagram below gives details about when parallel execution happen.
You can see that in production mode, parallel execution happens before the Substreams request range as well as within the requested range. While in development mode, we can see that parallel execution happens only before the Substreams request range, so between module's start block and start block of requested range (backward parallel execution only).
The state output format for map and store modules has changed internally to be more compact in Protobuf format. When deploying this new version, previous existing state files should be deleted or deployment updated to point to a new store location. The state output store is defined by the flag --substreams-state-store-url flag parameter on chain specific binary (i.e. fireeth).
Added production_mode to Substreams Request
Added output_module to Substreams Request
Fixed Ctrl-C not working directly when in TUI mode.
Added Trace ID printing once available.
Added command substreams tools analytics store-stats to get statistic for a given store.
Added --debug-modules-output (comma-separated module names) (unavailable in production mode).
Breaking Renamed flag --initial-snapshots to --debug-modules-initial-snapshots (comma-separated module names) (unavailable in production mode).
Moved Rust modules to github.com/streamingfast/substreams-rs
Added XDS support for tier 2s
Added intrinsic support for type bigdecimal, will deprecate bigfloat
Significant improvements in code-coverage and full integration tests.
Added substreams tools proxy <package> subcommand to allow calling substreams with a pre-defined package easily from a web browser using bufbuild/connect-web
Lowered GRPC client keep alive frequency, to prevent "Too Many Pings" disconnection issue.
Added a fast failure when attempting to connect to an unreachable substreams endpoint.
Command substreams pack is now restricted to local manifest file.
Added command substreams tools module to introspect a store state in storage.
Made changes to allow for substreams CLI to run on Windows OS (thanks @robinbernon).
Added flag --output-file <template> to substreams pack command to control where the .skpg is written, {manifestDir} and {spkgDefaultName} can be used in the template value where {manifestDir} resolves to manifest's directory and {spkgDefaultName} is the pre-computed default name in the form <name>-<version> where <name> is the manifest's "package.name" value (_ values in the name are replaced by -) and <version> is package.version value.
Fixed relative path not resolved correctly against manifest's location in protobuf.files list.
Fixed relative path not resolved correctly against manifest's location in binaries list.
substreams protogen <package> --output-path <path> flag is now relative to <package> if <package> is a local manifest file ending with .yaml.
Endpoint's port is now validated otherwise when unspecified, it creates an infinite 'Connecting...' message that will never resolves.
Fixed error when importing http/https .spkg files in imports section.
New updatePolicy append, allows one to build a store that concatenates values and supports parallelism. This affects the server, the manifest format (additive only), the substreams crate and the generated code therein.
Store APIs methods now accept key of type AsRef<str> which means for example that both String an &str are accepted as inputs in:
StoreSet::set
StoreSet::set_many
StoreSet::set_if_not_exists
StoreSet::set_if_not_exists_many
StoreAddInt64::add
StoreAddInt64::add_many
StoreAddFloat64::add
StoreAddFloat64::add_many
StoreAddBigFloat::add
StoreAddBigFloat::add_many
StoreAddBigInt::add
StoreAddBigInt::add_many
StoreMaxInt64::max
StoreMaxFloat64::max
StoreMaxBigInt::max
StoreMaxBigFloat::max
StoreMinInt64::min
StoreMinFloat64::min
StoreMinBigInt::min
StoreMinBigFloat::min
StoreAppend::append
StoreAppend::append_bytes
StoreGet::get_at
StoreGet::get_last
StoreGet::get_first
Low-level state methods now accept key of type AsRef<str> which means for example that both String an &str are accepted as inputs in:
state::get_at
state::get_last
state::get_first
state::set
state::set_if_not_exists
state::append
state::delete_prefix
state::add_bigint
state::add_int64
state::add_float64
state::add_bigfloat
state::set_min_int64
state::set_min_bigint
state::set_min_float64
state::set_min_bigfloat
state::set_max_int64
state::set_max_bigint
state::set_max_float64
state::set_max_bigfloat
Bumped prost (and related dependencies) to ^0.11.0
Environment variables are now accepted in manifest's imports list.
Environment variables are now accepted in manifest's protobuf.importPaths list.
Fixed relative path not resolved correctly against manifest's location in imports list.
Changed the output modes: module-* modes are gone and become the format for jsonl and json. This means all printed outputs are wrapped to provide the module name, and other metadata.
Added --initial-snapshots (or -i) to the run command, which will dump the stores specified as output modules.
Added color for ui output mode under a tty.
Added some request validation on both client and server (validate that output modules are present in the modules graph)
Added support to serve the initial snapshot
Changed substreams manifest info -> substreams info
Changed substreams manifest graph -> substreams graph
Updated usage
Multiple fixes to boundaries
substreams serverVarious bug fixes around store and parallel execution.
substreams CLIFix null pointer exception at the end of CLI run in some cases.
Do log last error when the CLI exit with an error has the error is already printed to the user and it creates a weird behavior.
substreams DockerEnsure arguments can be passed to Docker built image.
substreams serverVarious bug fixes around store and parallel execution.
Fixed logs being repeated on module with inputs that was receiving nothing.
substreams crateAdded substreams::hex wrapper around hex_literal::hex macro
substreams CLIAdded substreams run -o ui|json|jsonl|module-json|module-jsonl.
Fixed a whole bunch of issues, in parallel processing. More stable caching. See chain-specific releases.
Fixed substreams crate usage from tagged version published on crates.io.
code: is now defined in the binaries section of the manifest, instead of in each module. A module can select which binary with the binary: field on the Module definition.
Added substreams inspect ./substreams.yaml or inspect some.spkg to see what's inside. Requires protoc to be installed (which you should have anyway).
Added command substreams protogen that writes a temporary buf.gen.yaml and generates Rust structs based on the contents of the provided manifest or package.
Added substreams::handlers macros to reduce boilerplate when create substream modules.
substreams::handlers::map is used for the handlers corresponding to modules of type map. Modules of type map should return a Result where the error is of type Error
substreams::handlers::store is used for the handlers corresponding to modules of type store. Modules of type store should have no return value.
Added substreams::Hex wrapper type to more easily deal with printing and encoding bytes to hexadecimal string.
Added substreams::log::info!(...) and substreams::log::debug!(...) supporting formatting arguments (acts like println!() macro).
Added new field logs_truncated that can be used to determined if logs were truncated.
Augmented logs truncation limit to 128 KiB per module per block.
Updated substreams run to properly report module progress error.
When a module WASM execution error out, progress with failure logs is now returned before closing the substreams connection.
The API token is not passed anymore if the connection is using plain text option --plaintext.
The -c (or --compact-output) can be used to print JSON as a single compact line.
The --stop-block flag on substream run can be defined as +1000 to stream from start block + 1000.
Added Dockerfile support.
Improved defaults for --proto-path and --proto, using globs.
WASM file paths in substreams.yaml manifests now resolve relative to the location of the yaml file.
Added substreams manifest package to create .pb packages to simplify querying using other languages. See the python example.
Added substreams manifest graph to show the Mermaid graph alone.
Improved mermaid graph layout.
Removed native Go code support for now.
Always writes store snapshots, each 10,000 blocks.
A few tools to manage partial snapshots under substreams tools
First chain-agnostic release. THIS IS BETA SOFTWARE. USE AT YOUR OWN RISK. WE PROVIDE NO BACKWARDS COMPATIBILITY GUARANTEES FOR THIS RELEASE.
Removed local command. See README.md for instructions on how to run locally now. Build sfeth from source for now.
Changed the remote command to run.
Changed run command's --substreams-api-key-envvar flag to --substreams-api-token-envvar, and its default value is changed from SUBSTREAMS_API_KEY to SUBSTREAMS_API_TOKEN. See README.md to learn how to obtain such tokens.
The substreams init command now fetches a list of available 'code generators' to "".
Upon selection of a code generator, it launches an interactive session to gather the information necessary to build your substreams.
This allows flexibility and getting anything from "skeleton" of a substreams for a given chain up to a fully built .spkg file with subgraph bindings.
Those libraries when used in a wasm32-unknown-unknown context creates in a bunch of imports in the resulting Substreams Rust code, imports that led to runtime errors because Substreams engine didn't know about those special imports until today.
See for an example implementation
Implement a use feature, enabling a module to use an existing module by overriding its inputs or initial block. (Inputs should have the same output type than override module's inputs).
Check a usage of this new feature on the repository.
Added networks field at the top level of the manifest definition, with initialBlock and params overrides for each module. See the substreams.yaml.example file in the repository or for more details and example usage.
This release brings the substreams init command out of alpha! You can quickly generate a Substreams from an Ethereum ABI:
New Alpha feature: deploy your Substreams Sink as a deployable unit to a local docker environment!
See those two new features in action in this
Previously we were using remote: buf.build/prost/plugins/crate:v0.3.1-1. But remote plugins when using (which we use to generate the Protobuf) are now deprecated and will cease to function on July 10th, 2023.
substreams-tier1 now listens to protocol, enabling browser-based substreams clients
Authentication has been overhauled to take advantage of , allowing the use of a GRPC-based sidecar or reverse-proxy to provide authentication.
Metering has been overhauled to take advantage of plugins, allowing the use of a GRPC sidecar or logs to expose usage metrics.
The substreams protogen command now uses this Buf plugin to generate the Rust code for your Substreams definitions.
Added Tracing capabilities, using . See repository for details on how to enable.
If the cached substreams states are missing a 'full-kv' file in its sequence (not a normal scenario), requests will fail with opening file: not found
Release was retracted because it contained the refactoring expected for 1.1.0 by mistake, check instead.
Warning Operators, refer to section for specific instructions of deploying this new version.
In development mode, only backward parallel execution can be effective. In production mode, both backward parallel execution and forward parallel execution can be effective. See section for further details about parallel execution.
If today's you have sink code making the gRPC request yourself and are using that for production consumption, ensure that field production_mode in your Substreams request is set to true. StreamingFast provided sink like , and others have already been updated to use production_mode by default.
Gained significant execution time improvement when saving and loading stores, during the squashing process by leveraging
CLI is now able to read .spkg from gs://, s3:// and az:// URLs, the URL format must be supported by our library).
Changed startBlock to initialBlock in substreams.yaml .
Implemented .
See for usage docs..
