js-waku/CHANGELOG.md

Changelog

All notable changes to this project will be documented in this file.

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

Unreleased

Changed

• Test: Upgrade nim-waku node to v0.4.
• Waku Light Push upgraded to 2.0.0-beta1.

0.6.0 - 2021-06-09

Changed

• Breaking: Websocket protocol is not automatically added anymore if the user specifies a protocol in libp2p.modules when using Waku.create.
• Breaking: Options passed to Waku.create used to be passed to Libp2p.create; Now, only the libp2p property is passed to Libp2p.create, allowing for a cleaner interface.
• Examples (cli chat): Use tcp protocol instead of websocket.

Added

• Enable access to WakuMessage.timestamp.
• Examples (web chat): Use WakuMessage.timestamp as unique key for list items.
• Doc: Link to new topic guidelines in README.
• Doc: Link to Waku v2 Toy Chat specs in README.
• Examples (web chat): Persist nick.
• Support for custom PubSub Topics to Waku, WakuRelay, WakuStore and WakuLightPush; Passing a PubSub Topic is optional and still defaults to /waku/2/default-waku/proto; JS-Waku currently supports one, and only, PubSub topic per instance.

0.5.0 - 2021-05-21

Added

• Implement Waku v2 Light Push protocol.
• Expose Direction enum from js-waku root (it was only accessible via the proto module).
• Examples (cli chat): Use light push to send messages if --lightPush is passed.
• Examples (cli chat): Print usage if --help is passed.

0.4.0 - 2021-05-18

Added

• callback argument to WakuStore.queryHistory(), called as messages are retrieved ; Messages are retrieved using pagination, and it may take some time to retrieve all messages, with the callback function, messages are processed as soon as they are received.

Changed

• Testing: Upgrade nim-waku node to v0.3.
• Breaking: Modify WakuStore.queryHistory() to accept one Object instead of multiple individual arguments.
• getStatusFleetNodes return prod nodes by default, instead of test nodes.
• Examples (web chat): Connect to prod fleet by default, test fleet for local development.
• Examples (cli chat): Connect to test fleet by default, use --prod to connect to prod fleet.

Fixed

• Expose Enviroment and Protocol enums to pass to getStatusFleetNodes.

0.3.0 - 2021-05-15

Added

• getStatusFleetNodes to connect to Status' nim-waku nodes.

Changed

• Clarify content topic format in README.md.

Removed

• Unused dependencies.

0.2.0 - 2021-05-14

Added

• WakuRelay.getPeers method.
• Use WakuRelay.getPeers in web chat app example to disable send button.

Changed

• Enable passing strings to addPeerToAddressBook.
• Use addPeerToAddressBook in examples and usage doc.
• Settle on js-waku name across the board.
• Breaking: RelayDefaultTopic renamed to DefaultPubsubTopic.

0.1.0 - 2021-05-12

Added

• Add usage section to the README.
• Support of Waku v2 Relay.
• Support of Waku v2 Store.
• Node Chat App example.
• ReactJS Chat App example.
• Typedoc Documentation.