v1.0.0

• Bump to major release firehose-core v1.0.0

Operators

Important

When upgrading your stack to this release, be sure to upgrade all components simultaneously because the block encapsulation format has changed.
Blocks that are merged using the new merger will not be readable by previous versions.
There is no simple way to revert, except by deleting the all the one-blocks and merged-blocks that were produced with this version.

Changed

• Blocks files (one-blocks and merged) are now stored with a new format using google.protobuf.any format. Previous blocks can still be read and processed.

Added

• Added RPC pollers for Silkworm

v0.6.3

Fixed

• Fixed SF_TRACING feature (regression broke the ability to specify a tracing endpoint)
• Firehose connections rate-limiting will now force a delay of between 1 and 4 seconds (random value) before refusing a connection when under heavy load
• Fixed substreams GRPC/Connect error codes not propagating correctly

v0.6.2

Fixed

• fixed typo in check-merged-blocks preventing its proper display of missing ranges

v0.6.1

Added

• Firehose logs now include auth information (userID, keyID, realIP) along with blocks + egress bytes sent.

Fixed

• Filesource validation of block order in merged-blocks now works correctly when using indexes in firehose Blocks queries

Removed

• Flag substreams-rpc-endpoints removed, this was present by mistake and unused actually.
• Flag substreams-rpc-cache-store-url removed, this was present by mistake and unused actually.
• Flag substreams-rpc-cache-chunk-size removed, this was present by mistake and unused actually.

v0.6.0

Operators

Important

We have had reports of older versions of this software creating corrupted merged-blocks-files (with duplicate or extra out-of-bound blocks)
This release adds additional validation of merged-blocks to prevent serving duplicate blocks from the firehose or substreams service.
This may cause service outage if you have produced those blocks or downloaded them from another party who was affected by this bug.

• Find the affected files by running the following command (can be run multiple times in parallel, over smaller ranges)

tools check merged-blocks-batch <merged-blocks-store> <start> <stop>

• If you see any affected range, produce fixed merged-blocks files with the following command, on each range:

tools fix-bloated-merged-blocks <merged-blocks-store> <output-store> <start>:<stop>

• Copy the merged-blocks files created in output-store over to the your merged-blocks-store, replacing the corrupted files.

Removed

• Breaking The reader-node-log-to-zap flag has been removed. This was a source of confusion for operators reporting Firehose on bugs because the node's logs where merged within normal Firehose on logs and it was not super obvious.

  Now, logs from the node will be printed to stdout unformatted exactly like presented by the chain. Filtering of such logs must now be delegated to the node's implementation and how it deals depends on the node's binary. Refer to it to determine how you can tweak the logging verbosity emitted by the node.

Fixed

• Fixed an issue where firehose-antelope would panic when decoding some blocks on Waxtest
• Fixed a few false positives on tools check merged-blocks-batch
• Fixed tools print merged-blocks to print correctly a single block if specified.
• Bumped bstream: the filesource will now refuse to read blocks from a merged-files if they are not ordered or if there are any duplicate.
• The command tools download-from-firehose will now fail if it is being served blocks "out of order", to prevent any corrupted merged-blocks from being created.
• The command tools print merged-blocks did not print the whole merged-blocks file, the arguments were confusing: now it will parse <start_block> as a uint64.
• The command tools unmerge-blocks did not cover the whole given range, now fixed

Added

• Added support -o jsonl in tools print merged-blocks and tools print one-block.

• Added support for block range in tools print merged-blocks.

  [!NOTE]
  For now the range is restricted to a single "merged-blocks" file!

• Added retry loop for merger when walking one block files. Some use-cases where the bundle reader was sending files too fast and the merger was not waiting to accumulate enough files to start bundling merged files

• Added the command tools fix-bloated-merged-blocks to try to fix merged-blocks that contain duplicates and blocks outside of their range.

• Command tools print one-block and merged-blocks now supports a new --output-format jsonl format.
  Bytes data can now printed as hex or base58 string instead of base64 string.

Changed

• Changed tools check merged-blocks-batch argument syntax: the output-to-store is now optional.

v0.5.5

Added

• Added tools check merged-blocks-batch to simplify checking blocks continuity in batched mode, writing results to a store

Fixed

• Bumped substreams to v1.1.20 with a fix for some minor bug fixes related to start block processing

v0.5.4

Fixed

• Bumped substreams to v1.1.18 with a regression fix for when a substreams has a start block in the reversible segment

v0.5.3

Fixed

• fixed a rare case where a block couldn't be marshalled due to invalid utf-8

v0.5.2

Added

The --common-auth-plugin got back the ability to use secret://<expected_secret>?[user_id=<user_id>]&[api_key_id=<api_key_id>] in which case request are authenticated based on the Authorization: Bearer <actual_secret> and continue only if <actual_secret> == <expected_secret>.

Changed

• Bumped substreams to v1.1.17 with provider new metrics substreams_active_requests and substreams_counter

v0.5.1

Fixed

• first streamable block is missing a default value