Skip to content

CHANGELOG.md

Latest commit

 

History

History
67 lines (46 loc) · 4.01 KB

CHANGELOG.md

File metadata and controls

67 lines (46 loc) · 4.01 KB

Changelog

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

2023-12-08

Major Refactoring

  • BREAKING Removed the bstream.Block object completely: the pbbstream.Block takes its place.
  • BREAKING Moved the pbbstream package from github.com/streamingfast/pbgo to here, under sf.bstream.v1.Block

2023-11-08

Removed

  • BREAKING Removed bstream.Block.PreviousRef method as it was invalid since it was assuming that the previous number is always minus one the current block num which is not true on a lot of supported chains (Solana and NEAR for example).

Fixed

  • BREAKING we now enforce block continuity in filesource while reading merged-blocks: before, a corrupted merged-block-file would have been read as-is and serve wrong blocks.

Added

  • Added FileSourceWithSecondaryBlocksStores Option to allow a fallback location
  • .SetNearBlocksCount(count) and .Clone() on Tracker object.
  • Tracker object to streamline queries about different targets (like network head, database lib, relayer blockstream head, whatever other BlockRef tags), ask the question about them being near one another (to select between live mode or catch-up mode). Also streamlines the requests of a start block, with a bunch of different backend implementations that can answer to the questions regarding where to start.
  • JoiningSourceWithTracker to avoid joining to live when live and file sources are very far apart.
  • HeadBlockRefGetter and LIBBlockRefGetter that targets a HeadInfo service, and satisfies the Tracker BlockRefGetter func signature.

Changed

  • StreamGetter now requires a boolean param to know if it must decode the block
  • BREAKING blockstream/v2 server now takes an array of blocksStores, to give the filesource as secondaryBlocksStores option
  • Renamed HeadBlockRefGetter to StreamHeadBlockRefGetter and NetworkHeadBlockRefGetter. Choose what you need.
  • Renamed LIBBlockRefGetter to StreamLIBBlockRefGetter and NetworkLIBBlockRefGetter. Choose what you need.
  • Renamed Tracker.ResolveRelativeBlock to Tracker.GetRelativeBlock, to avoid confusion with the AddResolver function, which has nothing to do with GetRelativeBlock (which uses Get() and the Getters only).
  • Greatly improve logging behavior of the various source implementations, this should greatly improved debuggability of the library.
  • BREAKING All Source must now implement a SetLogger(logger *zap.Logger) method.
  • BREAKING Removed all Name, SetName, and *Name options on all source and across bstream. Replaced by a proper *zap.Logger instance instead. Re-configure using the logger, you can use SetLogger(zlog.With("name", "my-source-name")) to emulate the old behavior.

[v0.0.1] - 2020-06-22

Added

  • StartBlockResolver: interface for quickly finding out from which block to start (to cover all possible forks before your required start block)
  • ParallelStartResolver: implementation of StartBlockResolver to interrogate multiple StartBlockResolvers at once, useful when all dfuse components are not "up" yet.
  • SetHeadInfo on BlockStream to allow using GetHeadInfo() before stream actually starts
  • WithName option on NewForkable for better logging
  • License changed to Apache 2.0

Changed

  • BREAKING CHANGE: JoiningSourceRateLimit now takes a time.Duration as a second argument, instead of an int amount of milliseconds.

(before dfuse-for-EOSIO)

Changed

  • forkable.NewWithLIB(...) replaced by forkable.New(forkable.WithExclusiveLIB(...))
  • Forkable.SetFilters() replaced by the forkable.WithFilters() Option, to bassed to New().
  • Forkable.EnsureBlockFlows() replaced by the forkable.EnsureBlockFlows() Option.
  • Forkable.EnsureAllBlocksTriggerLongestChain() replaced by the forkable.EnsureAllBlocksTriggerLongestChain() Option.

Added

  • forkable.WithInclusiveLIB() as an Option to forkable.New()