CHANGELOG.md

1.0.0 (2022-05-10)

⚠ BREAKING CHANGES

• the output of this module is now ESM-only by @achingbrain in ChainSafe#236
• Tiddy Gossipsub API and comments by @dapplion in ChainSafe#227

Bug Fixes

• Fix rpc.control metrics and reduce object creation by @dapplion in ChainSafe#230
• Remove duplicate record of msgReceivedPreValidation metric by @tuyennhv in ChainSafe#228

Miscellaneous

• chore: update cd action by @mpetrunic in ChainSafe#245

4.1.1 (2022-08-24)

Bug Fixes

• catch errored push of rpc (#334) (64cf477)

4.1.0 (2022-08-24)

Features

• add option to limit OutboundStream buffer size (#325) (ce9b671)

Bug Fixes

• skip heartbeat only if it's close to the next heartbeat (#332) (0c6c42b)

4.0.0 (2022-08-11)

⚠ BREAKING CHANGES

Miscellaneous

• update dependencies (#322) (891c6fd)

3.5.1 (2022-08-11)

Bug Fixes

• freeze libp2p dependencies to get through build errors (#316) (5e6ce1f)
• handle closing outbound stream (#314) (74c08b1)

Miscellaneous

• benchmark protobuf (#320) (af51f36)
• migrate to it-length-prefixed 8.0.2 (#312) (90c2a0b)

3.5.0 (2022-08-02)

Features

• switch back to protobufjs (#310) (64b40fc)

3.4.0 (2022-07-22)

Features

• allow configuring stream limits (#293) (e0d3a7d)

3.3.0 (2022-07-20)

Features

• remove unnecessary direct dependency (#303) (77baa6e)

3.2.0 (2022-07-19)

Features

• allow usage of custom codecs (#288) (0e76f49)

3.1.0 (2022-07-11)

Features

• tweak stream handling (#298) (7eda34b)

3.0.2 (2022-06-30)

Bug Fixes

• allow publish of no-sign messages (#296) (40dadb8)

3.0.1 (2022-06-29)

Bug Fixes

• unblock strict no sign messages (#294) (9e964cc)

3.0.0 (2022-06-29)

⚠ BREAKING CHANGES

• connection interface updated

Miscellaneous

• fix link to interface doc (#290) (4801f19)
• update interface dependencies (#291) (6399072)

2.0.0 (2022-06-15)

⚠ BREAKING CHANGES

• uses new single-issue libp2p interface modules

Features

• update libp2p interfaces (#284) (0b69109)

1.2.0 (2022-06-15)

Features

• add msgIdToStrFn option (#270) (7f475c5)
• improve heartbeat performance (#268) (840883d)
• remove messageIdFromString (#274) (43faf93)

Bug Fixes

• finding outbound peers in heartbeat (#266) (17c25a1)
• only gossip validated messages (#277) (c8784c7)

Miscellaneous

• add linting to tests (#279) (4b9b040)
• add missing release token (#280) (fd75b2a)
• remove gossipIncoming param (#281) (d327999)
• update aegir (#285) (e487d08)

1.1.2 (2022-06-03)

Bug Fixes

• fix typesVersions (#264) (8a4e6a8)

1.1.1 (2022-06-03)

Bug Fixes

• fix subpath exports (#261) (281608e)

1.1.0 (2022-06-03)

Features

• add subpath exports (#255) (998fa79)

Bug Fixes

• opportunistic graft (#257) (035314c)

Miscellaneous

• separate e2e tests (#259) (e84a7fd)

1.0.1 (2022-05-23)

Miscellaneous

• move ts/ to src/ (#250) (6bf0693)
• update interface deps (#254) (01b28fd)

0.14.0 (2022-04-05)

• New gossipsub implementation: better performance, async validation flow, improved peer scores significantly, add a lot of metrics

0.13.2 (2022-03-25)

• Do not apply P3 penalty if peers are pruned from topic mesh
• Fix flood publish behavior
• Increase the default for seenTTL to match that of go-libp2p
• _publish: Only compute score if peer stream has FloodsubID protocol
• Migrate tests to Typescript
• Prettier
• Apply strict-boolean-expression eslint rule

0.13.1 (2022-02-14)

• Fix async getFastMsgIdStr function

0.13.0 (2022-01-20)

0.12.2 (2022-01-20)

Features

• async peerstore (5c3491c)

BREAKING CHANGES

• peerstore methods and pubsub start/stop are now all async

Features

• Add optional fast message id cache via the fastMsgIdFn option
  • In certain applications, computing the message id (getMsgId) is relatively expensive. This addition allows for an application to optionally define a "fast" message id function that will be used internally.
• Add optional cached message id function via getCachedMsgIdStr method override
  • Applications can maintain their own cache of message ids

0.12.1 (2021-12-03)

0.12.0 (2021-12-02)

chore

• update peer-id (#173) (e61668e)

BREAKING CHANGES

• requires node 15+

0.11.4 (2021-09-20)

Bug Fixes

• hearbeat tick handler rounding issue (#166) (a6d24de)
• ignore yarn lock (b804758)
• remove yarn.lock (10e5dfe)

Features

• add more configuration options (#165) (ff67106)

0.11.3 (2021-09-03)

0.11.2 (2021-09-02)

0.11.1 (2021-08-24)

0.11.0 (2021-07-09)

chore

• update deps (#155) (df69a90)

BREAKING CHANGES

• the new peer-id module uses the new CID class and not the old one

0.10.0 (2021-05-28)

0.9.2 (2021-05-28)

Reverts

• Revert "chore: update pubsub interface to run subsystem tests (#148)" (87607fb), closes #148

0.9.1 (2021-05-28)

0.9.0 (2021-04-28)

0.8.0 (2020-12-19)

0.7.0 (2020-11-13)

0.6.6 (2020-11-13)

0.6.5 (2020-11-12)

0.6.4 (2020-10-22)

0.6.3 (2020-10-05)

0.6.2 (2020-09-22)

0.6.1 (2020-09-03)

0.6.0 (2020-08-25)

Bug Fixes

• pick uintarrays commit (be47b50)

Features

• add _acceptFrom filter (1ff5816)
• add adaptive gossip (0c56763)
• add direct peer connections (7103b83)
• add extended topic validators (a1208b6)
• add flood publishing (5854d26)
• add invalid message spam protection (27fe567)
• add iwant request tracking (b3942e4)
• add opportunistic grafting (cbee3a2)
• add outbound mesh quota (47bc4a7)
• add peer exchange (a0a691b)
• add prune backoff (4eb492c)
• libp2p as gossipsub parameter (02dff12)
• track ihave/iwant counts (8e04a11)

BREAKING CHANGES

• Gossipsub default export parameter changed, now accepts (libp2p, options)

0.5.0 (2020-08-12)

Bug Fixes

• replace node buffers with uint8arrays (#118) (2f50108)

BREAKING CHANGES

• • The .data and .seq properties of messages used to be node Buffers, now they are Uint8Arrays

• All deps of this module now use Uint8Arrays instead of Buffers

• chore: remove gh url from dep version

0.4.6 (2020-07-07)

Bug Fixes

• connected with a subscriber before a mesh is created should send messages (060346a)

0.4.5 (2020-06-04)

Bug Fixes

• use unidirectional streams (#78) (8118894)

0.4.4 (2020-06-03)

Bug Fixes

• add static member for multicodec (#81) (dd86739)

0.4.3 (2020-06-03)

0.4.2 (2020-05-27)

Features

• add topic validators to pubsub (5712fd1)

0.4.1 (2020-05-27)

0.4.0 (2020-04-23)

Chores

• remove peer-info usage (602ccaa)

BREAKING CHANGES

• using new topology api with peer-id instead of peer-info and new pubsub internal peer data structure

0.3.0 (2020-04-23)

Bug Fixes

• add buffer and update deps (d8e9d1b)

0.2.6 (2020-04-04)

0.2.5 (2020-03-21)

0.2.4 (2020-02-14)

Bug Fixes

• remove use of assert module (#65) (e0a37cc)

0.2.3 (2020-02-03)

Bug Fixes

• bind is not needed (7faae98)
• fix double publish bug (519f868), closes /github.com/ChainSafe/gossipsub-js/blob/master/test/floodsub.spec.js#L21 /travis-ci.com/ChainSafe/gossipsub-js/jobs/278427804#L270
• fix heartbeat startup/shutdown timing bug (a8302f9)
• parameter to _onPeerDisconnected (d43ceb5)

Chores

• update dependencies (7a44b66)

Code Refactoring

• switch to async iterators (3027835)

Performance Improvements

• do not depend on floodsub (#63) (f825e07)

BREAKING CHANGES

• getPeersSubscribed from parent class renamed to getSubscribers to remove redundant wording
• Switch to using async/await and async iterators for all the API. Moreover, gossipsub does not need the libp2p instance anymore, receiving a registerar that enables it to receive the necessary events from libp2p

0.2.2 (2020-01-24)

Bug Fixes

• bind is not needed (7faae98)
• fix double publish bug (519f868), closes /github.com/ChainSafe/gossipsub-js/blob/master/test/floodsub.spec.js#L21 /travis-ci.com/ChainSafe/gossipsub-js/jobs/278427804#L270
• fix heartbeat startup/shutdown timing bug (a8302f9)
• parameter to _onPeerDisconnected (d43ceb5)

Chores

• update dependencies (7a44b66)

Code Refactoring

• switch to async iterators (3027835)

BREAKING CHANGES

• getPeersSubscribed from parent class renamed to getSubscribers to remove redundant wording
• Switch to using async/await and async iterators for all the API. Moreover, gossipsub does not need the libp2p instance anymore, receiving a registerar that enables it to receive the necessary events from libp2p

0.2.1 (2019-01-14)

Bug Fixes

• bind is not needed (7faae98)

0.2.0 (2019-12-02)

Chores

• update dependencies (7a44b66)

BREAKING CHANGES

• getPeersSubscribed from parent class renamed to getSubscribers to remove redundant wording.

0.1.0 (2019-19-14)

Code Refactoring

• switch to async iterators (ec8db51)

BREAKING CHANGES

• Switch to using async/await and async iterators.

0.0.2 (2019-06-04)

0.0.1 (2019-06-04)

Bug Fixes

• integration with js-libp2p (f894281)