nwaku/CHANGELOG.md

18 KiB

2021-01-19 v0.7

Release highlights:

  • Support for secure websockets.
  • Ability to remove unreachable clients in a filter node.
  • Several fixes to improve store performance and decrease query times. Query time for large stores decreased from longer than 8 min to under 100 ms.
  • Fix for a long-standing bug that prevented proper database migration in some deployed Docker containers.

The full list of changes is below.

Features

  • Support for secure websocket transport

Changes

  • Filter nodes can now remove unreachable clients
  • The WakuInfo listenStr is deprecated and replaced with a sequence of listenAddresses to accommodate multiple transports
  • Removed cached peerInfo on local node. Rely on underlying libp2p switch instead
  • Metrics: added counters for protocol messages
  • Waku v2 node discovery now supports 31/WAKU2-ENR
  • resuming the history via resume now takes the answers of all peers in peerList into consideration and consolidates them into one deduplicated list

Fixes

  • Fixed database migration failure in the Docker image
  • All HistoryResponse messages are now auto-paginated to a maximum of 100 messages per response
  • Increased maximum length for reading from a libp2p input stream to allow largest possible protocol messages, including HistoryResponse messages at max size
  • Significantly improved store node query performance
  • Implemented a GossipSub MessageIdProvider for 11/WAKU2-RELAY messages instead of relying on the unstable default
  • Receiver timestamps for message indexing in the store now have consistent millisecond resolution

This release supports the following libp2p protocols:

Protocol Spec status Protocol id
17/WAKU-RLN-RELAY raw /vac/waku/waku-rln-relay/2.0.0-alpha1
11/WAKU2-RELAY stable /vac/waku/relay/2.0.0
12/WAKU2-FILTER draft /vac/waku/filter/2.0.0-beta1
13/WAKU2-STORE draft /vac/waku/store/2.0.0-beta3
18/WAKU2-SWAP draft /vac/waku/swap/2.0.0-beta1
19/WAKU2-LIGHTPUSH draft /vac/waku/lightpush/2.0.0-beta1

The Waku v1 implementation is stable but not under active development.

2021-11-05 v0.6

Some useful features and fixes in this release, include:

  • two methods for Waku v2 node discovery
  • support for unsecure websockets, which paves the way for native browser usage
  • a fix for nim-waku store nodes running out of memory due to store size: the number of stored messages can now easily be configured
  • a fix for densely connected nodes refusing new connections: the maximum number of allowed connections can now easily be configured
  • support for larger message sizes (up from 64kb to 1Mb per message)

The full list of changes is below.

Features

Changes

  • Pagination of historical queries are now simplified
  • GossipSub prune backoff period is now the recommended 1 minute
  • Bridge now uses content topic format according to 23/WAKU2-TOPICS
  • Better internal differentiation between local and remote peer info
  • Maximum number of libp2p connections is now configurable
  • udp-port CLI option has been removed for binaries where it's not used
  • Waku v2 now supports unsecure WebSockets
  • Waku v2 now supports larger message sizes of up to 1 Mb by default
  • Further experimental development of RLN for spam protection. These changes are disabled by default under a compiler flag. Changes include:
    • Per-message rate limit proof defined
    • RLN proof generation and verification integrated into Waku v2
    • RLN tree depth changed from 32 to 20
    • Support added for static membership group formation

Docs

Fixes

  • Bridge between toy-chat and matterbridge now shows correct announced addresses
  • Bridge no longer re-encodes already encoded payloads when publishing to V1
  • Bridge now populates WakuMessage timestamps when publishing to V2
  • Store now has a configurable maximum number of stored messages
  • Network simulations for Waku v1 and Waku v2 are runnable again

This release supports the following libp2p protocols:

Protocol Spec status Protocol id
17/WAKU-RLN raw /vac/waku/waku-rln-relay/2.0.0-alpha1
11/WAKU2-RELAY stable /vac/waku/relay/2.0.0
12/WAKU2-FILTER draft /vac/waku/filter/2.0.0-beta1
13/WAKU2-STORE draft /vac/waku/store/2.0.0-beta3
18/WAKU2-SWAP draft /vac/waku/swap/2.0.0-beta1
19/WAKU2-LIGHTPUSH draft /vac/waku/lightpush/2.0.0-beta1

The Waku v1 implementation is stable but not under active development.

2021-07-26 v0.5.1

This patch release contains the following fix:

  • Support for multiple protocol IDs when reconnecting to previously connected peers: A bug in v0.5 caused clients using persistent peer storage to only support the mounted protocol ID.

This is a patch release that is fully backwards-compatible with release v0.5. It supports the same libp2p protocols:

Protocol Spec status Protocol id
17/WAKU-RLN raw /vac/waku/waku-rln-relay/2.0.0-alpha1
11/WAKU2-RELAY stable /vac/waku/relay/2.0.0
12/WAKU2-FILTER draft /vac/waku/filter/2.0.0-beta1
13/WAKU2-STORE draft /vac/waku/store/2.0.0-beta3
18/WAKU2-SWAP draft /vac/waku/swap/2.0.0-beta1
19/WAKU2-LIGHTPUSH draft /vac/waku/lightpush/2.0.0-beta1

The Waku v1 implementation is stable but not under active development.

2021-07-23 v0.5

This release contains the following:

Features

  • Support for keep-alives using libp2p ping protocol.
  • DB migration for the message and peer stores.
  • Support for multiple protocol IDs. Mounted protocols now match versions of the same protocol that adds a postfix to the stable protocol ID.

Changes

  • Bridge topics are now configurable.
  • The resume Nim API now eliminates duplicates messages before storing them.
  • The resume Nim API now fetches historical messages in page sequence.
  • Added support for stable version of relay protocol, with protocol ID /vac/waku/relay/2.0.0.
  • Added optional timestamp to WakuRelayMessage.
  • Removed PCRE as a prerequisite for building Waku v1 and Waku v2.
  • Improved swap metrics.

General refactoring

  • Refactored modules according to Nim best practices.
  • Simplified the way protocols get notified of new messages.
  • Refactored wakunode2 setup into 6 distinct phases with improved logging and error handling.
  • Moved Whisper types and protocol from the nim-eth module to nim-waku.

Docs

Schema

  • Updated the Message table of the persistent message store:
    • Added senderTimestamp column.
    • Renamed the timestamp column to receiverTimestamp and changes its type to REAL.

API

Fixes

  • Conversion between topics for the Waku v1 <-> v2 bridge now follows the RFC recommendation.
  • Fixed field order of HistoryResponse protobuf message: the field numbers of the HistoryResponse are shifted up by one to match up the 13/WAKU2-STORE specs.

This release supports the following libp2p protocols:

Protocol Spec status Protocol id
17/WAKU-RLN raw /vac/waku/waku-rln-relay/2.0.0-alpha1
11/WAKU2-RELAY stable /vac/waku/relay/2.0.0
12/WAKU2-FILTER draft /vac/waku/filter/2.0.0-beta1
13/WAKU2-STORE draft /vac/waku/store/2.0.0-beta3
18/WAKU2-SWAP draft /vac/waku/swap/2.0.0-beta1
19/WAKU2-LIGHTPUSH draft /vac/waku/lightpush/2.0.0-beta1

The Waku v1 implementation is stable but not under active development.

2021-06-03 v0.4

This release contains the following:

Features

Changes

  • The toy-chat application can now perform lightpush and request content-filtered messages from remote peers.
  • The toy-chat application now uses default content topic /toy-chat/2/huilong/proto
  • Improve toy-chat briding to matterbridge
  • Improve swap logging and enable soft mode by default
  • Content topics are no longer in a redundant nested structure
  • Improve error handling

API

Fixes

  • Connections between nodes no longer become unstable due to keep-alive errors if mesh grows large
  • Re-enable lightpush tests and fix Windows CI failure

The Waku v2 suite of protocols are still in a raw/draft state. This release supports the following libp2p protocols:

Protocol Spec status Protocol id
17/WAKU-RLN raw /vac/waku/waku-rln-relay/2.0.0-alpha1
11/WAKU2-RELAY draft /vac/waku/relay/2.0.0-beta2
12/WAKU2-FILTER draft /vac/waku/filter/2.0.0-beta1
13/WAKU2-STORE draft /vac/waku/store/2.0.0-beta3
18/WAKU2-SWAP draft /vac/waku/swap/2.0.0-beta1
19/WAKU2-LIGHTPUSH draft /vac/waku/lightpush/2.0.0-beta1

The Waku v1 implementation is stable but not under active development.

2021-05-11 v0.3

This release contains the following:

Features

Changes

  • Enable swap protocol by default and improve logging

General refactoring

  • Split out waku_types types into the right place; create utils folder.
  • Change type of contentTopic in ContentFilter to string.
  • Replace sequence of contentTopics in ContentFilter with a single contentTopic.
  • Add timestamp field to WakuMessage.
  • Ensure CLI config parameters use a consistent naming scheme. Summary of changes here.

Docs

Several clarifications and additions aimed at contributors, including

Schema

  • Add Message table to the persistent message store. This table replaces the old messages table. It has two additional columns, namely
    • pubsubTopic, and
    • version.
  • Add Peer table for persistent peer storage.

API

  • JSON-RPC Admin API: Added a post method to connect to peers on an ad-hoc basis.
  • Nim API: PubSub topic subscribe and unsubscribe no longer returns a future (removed async designation).
  • HistoryQuery: Added pubsubTopic field. Message history can now be filtered and queried based on the pubsubTopic.
  • HistoryQuery: Added support for querying a time window by specifying start and end times.

Fixes

  • Running nodes can now be shut down gracefully
  • Content filtering now works on any PubSub topic and not just the waku default.
  • Nodes can now mount protocols without supporting relay as a capability

The Waku v2 suite of protocols are still in a raw/draft state. This release supports the following libp2p protocols:

Protocol Spec status Protocol id
17/WAKU-RLN raw /vac/waku/waku-rln-relay/2.0.0-alpha1
18/WAKU2-SWAP raw /vac/waku/swap/2.0.0-alpha1
19/WAKU2-LIGHTPUSH raw /vac/waku/lightpush/2.0.0-alpha1
11/WAKU2-RELAY draft /vac/waku/relay/2.0.0-beta2
12/WAKU2-FILTER draft /vac/waku/filter/2.0.0-beta1
13/WAKU2-STORE draft /vac/waku/store/2.0.0-beta3

The Waku v1 implementation is stable but not under active development.

2021-01-05 v0.2

This release contains the following changes:

  • Calls to publish a message on wakunode2 now await instead of discard dispatched WakuRelay procedures.
  • StrictNoSign enabled.
  • Add JSON-RPC API for external access to wakunode2 functionality:
    • Admin API retrieves information about peers registered on the wakunode2.
    • Debug API exposes debug information about a wakunode2.
    • Filter API saves bandwidth by allowing light nodes to filter for specific content.
    • Private API enables symmetric or asymmetric cryptography to encrypt/decrypt message payloads.
    • Relay API allows basic pub/sub functionality.
    • Store API retrieves historical messages.
  • Add tutorial on how to use JSON-RPC API.
  • Refactor: Move waku_filter protocol into its own module.

The Waku v2 implementation, and most protocols it consist of, are still in a draft/beta state. The Waku v1 implementation is stable but not under active development.

2020-11-30 v0.1

Initial beta release.

This release contains:

  • A Nim implementation of the Waku v1 protocol.
  • A Nim implementation of the Waku v2 protocol.
  • CLI applications wakunode and wakunode2 that allows you to run a Waku v1 or v2 node.
  • Examples of Waku v1 and v2 usage.
  • Various tests of above.

Currenty the Waku v2 implementation, and most protocols it consist of, are in a draft/beta state. The Waku v1 implementation is stable but not under active development.

Feedback welcome!