waku-org
/
js-waku
mirror of https://github.com/waku-org/js-waku.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
js-waku/packages/core/CHANGELOG.md

52 KiB
Raw Blame History

Changelog

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

The file is maintained by Release Please based on Conventional Commits specification, and this project adheres to Semantic Versioning.

0.0.30 (2024-07-10)

⚠ BREAKING CHANGES

  • filter: return error codes instead of throwing errors (#1971)

Features

  • filter: Return error codes instead of throwing errors (#1971) (4eb06c6)
  • lightpush: Peer management for protocols (#2003) (93e78c3)

Bug Fixes

  • Failing node_optional check (#2025) (984fb94)
  • Increasing maxInboundStreams for lightpush from 32 to 100 (#2021) (2311a59)

Dependencies

  • The following workspace dependencies were updated
    • dependencies
      • @waku/enr bumped from ^0.0.23 to ^0.0.24
      • @waku/interfaces bumped from 0.0.24 to 0.0.25
      • @waku/utils bumped from 0.0.17 to 0.0.18

0.0.29 (2024-04-30)

⚠ BREAKING CHANGES

  • use ShardingParams on subscriptions, make Decoder/Encoder auto sharding friendly by default (#1958)
  • lightpush: move protocol implementation to @waku/sdk (1/n) (#1964)

Features

  • Use ShardingParams on subscriptions, make Decoder/Encoder auto sharding friendly by default (#1958) (f3627c4)

Bug Fixes

  • Only override ping metadata in peer store (#1984) (fb34b72)
  • Use correct shard index when creating encoder (9514653)

Miscellaneous Chores

  • lightpush: Move protocol implementation to @waku/sdk (1/n) (#1964) (5fb1006)

Dependencies

  • The following workspace dependencies were updated
    • dependencies
      • @waku/enr bumped from ^0.0.22 to ^0.0.23
      • @waku/interfaces bumped from 0.0.23 to 0.0.24
      • @waku/proto bumped from 0.0.6 to 0.0.7
      • @waku/utils bumped from 0.0.16 to 0.0.17

0.0.28 (2024-04-09)

⚠ BREAKING CHANGES

  • store: move protocol implementation opinions to @waku/sdk (#1913)
  • lightpush: move protocol implementation opinions to @waku/sdk (#1887)

Features

Miscellaneous Chores

  • lightpush: Move protocol implementation opinions to @waku/sdk (#1887) (8deab11)
  • store: Move protocol implementation opinions to @waku/sdk (#1913) (bf42c8f)

Dependencies

  • The following workspace dependencies were updated
    • dependencies
      • @waku/enr bumped from ^0.0.21 to ^0.0.22
      • @waku/interfaces bumped from 0.0.22 to 0.0.23
      • @waku/message-hash bumped from ^0.1.11 to ^0.1.12
      • @waku/utils bumped from 0.0.15 to 0.0.16

0.0.27 (2024-03-04)

⚠ BREAKING CHANGES

  • protocols filter peers as per configured shard (#1756)

Features

  • Create node and subscription by content topic (ee2d417)
  • Decouple sharding params out of core (e138b4f)
  • Lightpush & filter send requests to multiple peers (#1779) (7affbe2)
  • Local discovery (#1811) (199f6ab)
  • Make ShardingParams optional in sdk, required internally (68d3229)
  • Protocols filter peers as per configured shard (#1756) (477c2a5)

Dependencies

  • The following workspace dependencies were updated
    • dependencies
      • @waku/enr bumped from ^0.0.20 to ^0.0.21
      • @waku/interfaces bumped from 0.0.21 to 0.0.22
      • @waku/message-hash bumped from ^0.1.10 to ^0.1.11
      • @waku/utils bumped from 0.0.14 to 0.0.15

0.0.26 (2024-01-10)

⚠ BREAKING CHANGES

  • add support for sharded pubsub topics & remove support for named pubsub topics (#1697)
  • change all instances of PubSubTopic to PubsubTopic (#1703)

Features

  • Add support for autosharded pubsub topics (2bc3735)
  • Add support for sharded pubsub topics & remove support for named pubsub topics (#1697) (4cf2ffe)
  • Metadata protocol (#1732) (9ac2a3f)
  • Track node connection state (#1719) (1d0e2ac)

Miscellaneous Chores

  • Change all instances of PubSubTopic to PubsubTopic (#1703) (3166a51)

Dependencies

  • The following workspace dependencies were updated
    • dependencies
      • @waku/enr bumped from ^0.0.19 to ^0.0.20
      • @waku/interfaces bumped from 0.0.20 to 0.0.21
      • @waku/proto bumped from 0.0.5 to 0.0.6
      • @waku/utils bumped from 0.0.13 to 0.0.14

0.0.25 (2023-11-01)

Features

Bug Fixes

  • Don't dial discovered peers if have already been attempted dial (#1657) (1892f50)
  • Filter subscription with pubsubTopic1 and decoder with pubsubTopic2 (#1675) (491366b)
  • Handle all empty responses in filter (#1688) (b3864f8)
  • Measure total message size (#1643) (b7dc3d7)

Dependencies

  • The following workspace dependencies were updated
    • dependencies
      • @waku/enr bumped from ^0.0.18 to ^0.0.19
      • @waku/interfaces bumped from 0.0.19 to 0.0.20
      • @waku/utils bumped from 0.0.12 to 0.0.13

0.0.24 (2023-10-16)

⚠ BREAKING CHANGES

  • store: use pubSubTopic from DecodedMessage for createCursor (#1640)
  • static-sharding: allow multiple pubSubTopics (#1586)
  • return REMOTE_PEER_REJECTED if remote peer rejected the message

Features

  • Add Firefox and Webkit to karma (#1598) (d9e4bcb)
  • Enable pinging connected peers by default (#1647) (1d60c4b)
  • Return REMOTE_PEER_REJECTED if remote peer rejected the message (053b654)
  • static-sharding: Allow multiple pubSubTopics (#1586) (a3c45b6)
  • static-sharding: Filter peer connections per shards (#1626) (124a29e)

Bug Fixes

  • Catch stream creation promise rejection for lightPush.send (b696a89)
  • Catch top level exception when preemptively creating streams (fb37c89)
  • store: Use pubSubTopic from DecodedMessage for createCursor (#1640) (b10c46b)
  • Throw error when no response (#1567) (d049ebb)

Dependencies

  • The following workspace dependencies were updated
    • dependencies
      • @waku/enr bumped from ^0.0.17 to ^0.0.18
      • @waku/interfaces bumped from 0.0.18 to 0.0.19
      • @waku/utils bumped from 0.0.11 to 0.0.12

0.0.23 (2023-09-11)

⚠ BREAKING CHANGES

  • set peer-exchange with default bootstrap (#1469)
  • refactor store protocol for readability (#1456)

Features

  • Pre-emptive stream creation for protocols (#1516) (b4f8216)
  • Set peer-exchange with default bootstrap (#1469) (81a52a8)
  • Use the lowest latency peer for protocols (#1540) (6f09fbf)

Miscellaneous Chores

Dependencies

  • The following workspace dependencies were updated
    • dependencies
      • @waku/interfaces bumped from 0.0.17 to 0.0.18
      • @waku/utils bumped from 0.0.10 to 0.0.11

0.0.22 (2023-08-02)

Features

  • ConnectionManager extends EventEmitter & exposed on the Waku interface (& minor improvements) (#1447) (0b8936f)

Bug Fixes

  • Improve connection manager error handling + edge cases (#1450) (785df52)
  • Refactors message decoding to abort as soon as a suitable decoder found (#1414) (30fcace)

Dependencies

  • The following workspace dependencies were updated
    • dependencies
      • @waku/interfaces bumped from 0.0.16 to 0.0.17
      • @waku/utils bumped from 0.0.9 to 0.0.10

0.0.21 (2023-07-26)

⚠ BREAKING CHANGES

Features

Miscellaneous Chores

Dependencies

  • The following workspace dependencies were updated
    • dependencies
      • @waku/interfaces bumped from 0.0.15 to 0.0.16
      • @waku/utils bumped from 0.0.8 to 0.0.9

0.0.20 (2023-06-08)

⚠ BREAKING CHANGES

  • rename package from @waku/create to @waku/sdk (#1386)

Features

  • Allow passing of multiple ENR URLs to DNS Discovery & dial multiple peers in parallel (#1379) (f32d7d9)
  • Rename package from @waku/create to @waku/sdk (#1386) (951ebda)

Dependencies

  • The following workspace dependencies were updated
    • dependencies
      • @waku/interfaces bumped from 0.0.14 to 0.0.15
      • @waku/utils bumped from 0.0.7 to 0.0.8

0.0.19 (2023-05-26)

⚠ BREAKING CHANGES

Features

Dependencies

  • The following workspace dependencies were updated
    • dependencies
      • @waku/interfaces bumped from 0.0.13 to 0.0.14
      • @waku/proto bumped from * to 0.0.5
      • @waku/utils bumped from 0.0.6 to 0.0.7

0.0.18 (2023-05-18)

⚠ BREAKING CHANGES

Features

Bug Fixes

Dependencies

  • The following workspace dependencies were updated
    • dependencies
      • @waku/interfaces bumped from * to 0.0.13
      • @waku/utils bumped from * to 0.0.6

0.0.17 (2023-05-09)

Features

  • Add mapping function to multiaddr of peerid (#1306) (763dc01)
  • Ensure content topic is defined (bd9d073)
  • ToSubscriptionIterator impl for IReceiver (#1307) (7daa9d0)
  • Use nwaku/go-waku docker images instead of building binaries (#1259) (dc3774c)

Bug Fixes

  • Enum used from this dependency (c9e7af4)

Dependencies

  • The following workspace dependencies were updated
    • dependencies
      • @waku/interfaces bumped from 0.0.11 to 0.0.12
      • @waku/utils bumped from 0.0.4 to 0.0.5

0.0.16 (2023-04-03)

⚠ BREAKING CHANGES

  • add and implement IReceiver (#1219)

Features

Dependencies

  • The following workspace dependencies were updated
    • dependencies
      • @waku/interfaces bumped from 0.0.10 to 0.0.11
      • @waku/utils bumped from 0.0.3 to 0.0.4

0.0.15 (2023-03-31)

Bug Fixes

0.0.14 (2023-03-29)

Features

Nothing. Was published by mistake and does not contain valid code. Same as 0.0.13

0.0.13 (2023-03-24)

Bug Fixes

Dependencies

  • The following workspace dependencies were updated
    • dependencies
      • @waku/interfaces bumped from 0.0.9 to 0.0.10
      • @waku/proto bumped from 0.0.3 to 0.0.4
      • @waku/utils bumped from 0.0.2 to 0.0.3

0.0.12 (2023-03-23)

⚠ BREAKING CHANGES

  • use ISender and deprecate Light Push .push (#1217)

Features

Dependencies

  • The following workspace dependencies were updated
    • dependencies
      • @waku/interfaces bumped from 0.0.8 to 0.0.9

0.0.11 (2023-03-16)

⚠ BREAKING CHANGES

  • add custom events to Relay and make observers private (#1213)
  • add exports map to @waku/utils (#1201)
  • enable encoding of meta field
  • expose pubsub topic in IDecodedMessage
  • update store.proto
  • update message.proto: payload and content topic are always defined
  • ConnectionManager and KeepAliveManager (#1135)
  • bump typescript
  • bump all prod dependencies
  • bump libp2p dependencies

Features

  • Add custom events to Relay and make observers private (#1213) (275b166)
  • Codec as a property of the protocol implementations (a5ff788)
  • ConnectionManager and KeepAliveManager (#1135) (24c24cc)
  • Enable encoding of meta field (bd983ea)
  • Export Decoder, Encoder and DecodedMessage types from root (da1b18d), closes #1010
  • Expose pubsub topic in IDecodedMessage (628ac50), closes #1208
  • relay: Validate waku message at gossip layer (9684737)

Bug Fixes

  • Add payload to relay ping messages to avoid poor relay peer scoring (560c393)
  • Prettier and cspell ignore CHANGELOG (#1235) (4d7b3e3)
  • Remove initialising peer-exchange while creating a node (#1158) (1b41569)

Miscellaneous Chores

  • Add exports map to @waku/utils (#1201) (a30b2bd)
  • Bump all prod dependencies (88cc76d)
  • Bump libp2p dependencies (803ae7b)
  • Bump typescript (12d86e6)
  • Update message.proto: payload and content topic are always defined (5cf8ed2)
  • Update store.proto (967e6ff)

Dependencies

  • The following workspace dependencies were updated
    • dependencies
      • @waku/interfaces bumped from * to 0.0.8
      • @waku/proto bumped from * to 0.0.3
      • @waku/utils bumped from * to 0.0.2

Unreleased

Added

  • multicodec property from protocol interfaces.

Removed

  • Dependency on @waku/peer-exchange.

Changed

  • Filter, LightPush and Store classes now takes in options of type ProtocolCreateOptions as the second argument, instead of pubSubTopic
  • Relay class now takes in options of type Partial<RealyCreateOptions> as the second argument, instead of pubSubTopic

@waku/core@0.0.10 - 2023-01-25

Changed

  • Ping Relay messages are now set as ephemeral.

Fixed

  • Moved @chai and @fast-check to devDependencies list.

@waku/core@0.0.9 - 2023-01-18

Changed

  • Removed /vac/waku/relay/2.0.0-beta2 from WakuRelay protocols.
  • Moved @chai and @fast-check to dependencies list.
  • Remove peer exchange from protocols to expect in waitForRemotePeer by default.

Fixed

  • Documentation links.

@waku/core@0.0.8 - 2022-12-19

Fixed

  • Missing dependency declarations.
  • Invalid re-export.

@waku/core@0.0.7 - 2022-12-15

Added

  • Add @multiformats/multiaddr as peer dependency.
  • New createEncoder and createDecoder functions so that the consumer does not deal with Encoder/Decoder classes.

Changed

  • waitForRemotePeer must now be directly imported from @waku/core.
  • V0 suffix removed from the version 0 objects.
  • createEncoder/createDecoder/DecodedMessage for Waku Message Version 0 (no Waku level encryption) can now be imported directly from @waku/core.
  • Removed Waku and waku_ prefixed on protocol implementations.

@waku/core@0.0.6 - 2022-11-18

Added

  • Waku Message ephemeral field to mark messages as do-not-store.

Changed

  • Bumped libp2p to 0.40.0 and associated libp2p libraries.

Removed

  • PeerDiscoveryStaticPeer has been removed, use @libp2p/bootstrap instead.

@waku/core@0.0.5 - 2022-11-11

Changed

  • Bumped libp2p to 0.39.5.

@waku/core@0.0.4 - 2022-11-09

Changed

  • Bumped libp2p to 0.39.2.

@waku/core@0.0.3 - 2022-11-04

Fixed

  • Missing .js extension.

@waku/core@0.0.2 - 2022-11-04

Changed

  • js-waku is deprecated, @waku/core and other @waku/* packages should be used instead.
  • extract version-1 from chore
  • extract utils from core
  • extract dns discovery and enr from core (f7f28f0)
  • split outgoing and incoming message interface (8aa9b43), closes #979

0.30.0 - 2022-10-28

Added

  • RateLimitProof field in Waku Message protobuf for RLN.

Changed

  • Message interface changed to ensure implementations do not omit fields.
  • Decoder and Encoder interfaces change to better express what the function members do.

Fixed

  • Incorrect cursor encoding in Store queries.
  • WakuStore.queryOrderedCallback not stopping when callback returns true.

Removed

  • Support for Waku Store 2.0.0-beta3.

0.29.0 - 2022-09-21

Changed

  • Waku message encoding and decoding is more generic, to enable upcoming feature such as RLN & Noise; it also enables separating the version_1 module out to reduce bundle size and improve cross-platform compatibility when not used.
  • Due to the change above, all APIs that handle messages have changed to receive a Decoder or Encoder.

0.28.1 - 2022-09-20

Added

  • WakuRelay.addObserver now returns a function to delete the observer.
  • WakuLightPush.push and WakuRelay.send returns SendResult with the list of recipients.

Removed

  • queryCallbackOnPromise's return value has been simplified to Promise<void>.
  • doc: clarified behaviour of WakuStore query functions.

Deleted

  • WakuMessage class in favour of the Message, Encoder, Decoder interfaces and EncoderV0, AsymEncoder, SymEncoder (and related decoders).

0.28.0 - 2022-09-16

Changed

  • Correct options type for createFullNode & createPrivacy to enable passing gossipsub options.
  • WakuStore now provides several APIs: queryGenerator, queryCallbackOnPromise, queryOrderedCallback; each provides different guarantees and performance.

0.27.0 - 2022-09-13

Added

  • createLightNode to create a Waku node for resource restricted environment with Light Push, Filter and Relay.
  • createPrivacyNode to create a Waku node for privacy preserving usage with Relay only.
  • createFullNode to create a Waku node for with all protocols, for testing purposes only.

Changed

  • Waku is now defined as an interface with WakuNode an implementation of it.
  • createWaku is deprecated in favour of createLightNode and createPrivacyNode.
  • waitForRemotePeer can throw, default behaviour has changed.
  • addPeerToAddressBook is now async.
  • API Docs moved to https://js.waku.org/
  • test: fix typing for nwaku JSON RPC responses.

0.26.0 - 2022-09-08

Added

  • Simple connection management that selects the most recent connection for store, light push and filter requests.

Changed

Fixed

  • doc: add missing modules.

0.25.0 - 2022-09-05

Changed

  • Published files moved from build to dist/.
  • Migrate from ts-proto to protons; the latter does not bring Buffer/Long deps, is ESM compatible and remove the need for bufbuild and protoc.
  • Move package to "type": "module", it is now a pure ESM package.
  • Use ESM code in Mocha and Karma tests.
  • Upgrade dns-query dependency, breaking change on DnsNodeDiscovery API.
  • Bump many libp2p libraries to their latest version (which usually are pure ESM).
  • Replace webpack with parcel for bundling
  • Examples: Updated store-js and relay-js to demonstrate usage of ESM bundle in <script> tag.
  • Remove need to polyfill buffer.
  • breaking: Various API changes. Refer to tests to check proper usage of the new API.
  • breaking: createWaku is in separate exports path.
  • breaking: Bootstrap class split: dns discovery, static list.
  • breaking: bundled files are now under bundle/.

Fixed

  • size-limit config to test several usages of Waku.
  • buffer is not needed in the browser.

Removed

  • terser minification and gzip compressions have been removed.

0.24.0 - 2022-05-27

Added

  • waitForRemotePeer now accepts a timeoutMs parameter that rejects the promise if it is reached. By default, no timeout is applied.
  • Experimental support for the Waku Filter protocol (client side) added, currently only works in NodeJS.

Changed

  • waitForRemotePeer waits for a Relay peer by default instead of Relay and Store.
  • Breaking: Removed dupe secp256k1 code, removed some unused APIs.

0.23.0 - 2022-05-19

Added

  • Some dependencies that were used but not declared (often transient).

Changed

  • Replaced deprecated multihashes with multiformats.

Removed

  • No more assert usage.

0.22.0 - 2022-05-10

Changed

  • Replaced secp256k1 and hence elliptic dependencies with @noble/secp256k1, reducing package size, number of dependency and removing need for crypto-browserify polyfill.

0.21.0 - 2022-05-5

Added

  • Support of the waku2 ENR key: When using DNS Discovery, wanted node capabilities (e.g. relay, store) must be passed.

Changed

  • Prefer the use of BigInt over integer literal (n postfix) to facilitate the use of a polyfill.

Fixed

  • Declare it-pipe dependency, import as per it-pipe@2.0.0 convention.

0.20.0 - 2022-03-29

Changed

  • Examples: Add Relay JavaScript example.
  • Breaking: Moved utf-8 conversion functions to utils.
  • Froze libp2p-gossipsub to 0.13.0 as new patch version bring breaking changes.

Fixed

  • Replace Base 64 buggy conversion functions with uint8arrays.

Removed

  • Breaking: Removed equalByteArrays, use uint8arrays/equals instead. See changes in eth-pm example.
  • Breaking: Removed deprecated utils functions.

0.19.2 - 2022-03-21

Fixed

  • Enable usage in NodeJS by fixing exports field and usage of the crypto module.

0.19.1 - 2022-03-10

Added

  • When using Waku.create, bootstrap.peers now accepts an array of Multiaddr.
  • Exports Protocols for easy usage with waitForRemotePeer.

0.19.0 - 2022-03-09

Added

  • New pubsub_topic field on the cursor of Waku Store queries (#585).

Changed

  • Add exports to package.json for NodeJS usage (not officially supported but helpful for experiments).

Fixed

  • Handle errors thrown by bytesToUtf8.
  • WakuMessage.timestamp field must use nanoseconds (was using microseconds).

Removed

  • Removed ecies-geth dependency.

0.18.0 - 2022-02-24

Changed

  • Replaced rlp dependency with @ethersproject/rlp.
  • Breaking: staticNoiseKey changed from Buffer to Uint8Array.
  • Implement Waku Store 2.0.0-beta4. The WakuMessage.timestamp field now stores nanoseconds over the wire.
  • Breaking: HistoryRPC.createQuery takes Date instead of number for startTime and endTime.

Removed

  • base64url and bigint-buffer dependencies.

0.17.0 - 2022-02-16

Changed

  • Breaking: Upgrade libp2p to 0.36.2 & libp2p-gossipsub to 0.13.0. Some APIs are now async.
  • docs: Various improvements.
  • Ran npm audit fix.
  • Waku.dial accepts protocols expected from the peer. Defaults to Waku Relay only.
  • Deprecated hexToBuf & bufToHex in favour of hexToBytes & bytesToHex to move towards removing the buffer polyfill.
  • Breaking: Replaced getNodesFromHostedJson with getPredefinedBootstrapNodes. Now, it uses a hardcoded list of nodes.

Removed

  • axios dependency in favour of fetch.

0.16.0 - 2022-01-31

Changed

  • Test: Upgrade nim-waku node to v0.7.
  • Doc: Renamed "DappConnect" to "Waku Connect".
  • Docs: API Docs are now available at https://js-waku.wakuconnect.dev/.
  • Breaking: Replace waitForConnectedPeer with waitForRemotePeer; the new method checks that the peer is ready before resolving the promise.

0.15.0 - 2022-01-17

Added

  • Implement DNS Discovery as per EIP-1459, with ENR records as defined in 31/WAKU2-ENR; Available by passing { bootstrap: { enrUrl: enrtree://... } } to Waku.create.
  • When using addDecryptionKey, it is now possible to specify the decryption method and the content topics of the messages to decrypt; this is to reduce the number of decryption attempt done and improve performance.

Changed

  • Test: Upgrade nim-waku node to v0.6.
  • Breaking: Renamed getBootstrapNodes to getNodesFromHostedJson.
  • Minimum node version changed to 16.
  • Breaking: Changed Waku.create bootstrap option from { bootstrap: boolean } to { bootstrap: BootstrapOptions }. Replace { boostrap: true } with { boostrap: { default: true } } to retain same behaviour.
  • Breaking: WakuMessage.decode and WakuMessage.decodeProto now accepts method and content topics for the decryption key. WakuMessage.decode(bytes, [key]) becomes WakuMessage.decode(bytes, [{key: key}]).

Fixed

  • Doc: Some broken links.

0.14.2 - 2021-11-30

Changed

  • Examples: JS examples uses local ESM folder to replicate behaviour of js-waku publish package.

Fixed

  • TypeError issue related to constructors using js-waku in a JS project (#323).

0.14.1 - 2021-10-22

Fixed

  • Issue when importing the utils module.

0.14.0 - 2021-10-13

Added

  • If the callback function passed toWakuStore.queryHistory returns true, then no further pages are retrieved from the store.
  • Use webpack to build UMD bundle of the library, see README for usage.

Changed

  • Breaking: Renamed WakuStore.QueryOptions's direction to pageDirection (and its type) as it only affects the page ordering, not the ordering of messages with the page.

Fixed

  • Docs: Ensure that WakuStore's QueryOptions documentation is available online.

0.13.1 - 2021-09-21

Fixed

  • Error: Bootstrap requires a list of peer addresses error when using bootstrap: true in Waku.create.

0.13.0 - 2021-09-16

Changed

  • Upgrade libp2p libraries: @chainsafe/libp2p-noise@4.1.1, libp2p@0.32.4, libp2p-gossipsub@0.11.1.
  • Connects to a limited number of bootstrap nodes, defaults to 1.

0.12.2 - 2021-09-21

Fixed

  • hot fix: Error: Bootstrap requires a list of peer addresses error when using bootstrap: true in Waku.create.

0.12.1 - 2021-09-16

Changed

  • hot fix: Connects to a limited number of bootstrap nodes, defaults to 1.

0.12.0 - 2021-09-2

Added

  • Examples (eth-pm): Encrypt Public Key Messages using symmetric encryption.
  • Guides: Encrypt messages using Waku Message Version 1.
  • Allow passing decryption keys in hex string format.
  • Allow passing decryption keys to WakuStore instance to avoid having to pass them at every queryHistory call.
  • Allow passing decryption keys to Waku instance to avoid having to pass them to both WakuRelay and WakuStore.
  • Waku.waitForConnectedPeer helper to ensure that we are connected to Waku peers when using the bootstrap option.

Changed

  • Breaking: Moved startTime and endTime for history queries to a timeFilter property as both or neither must be passed; passing only one parameter is not supported.
  • Renamed and promote the usage of generateSymmetricKey() to generate random symmetric keys.
  • Improved errors thrown by WakuStore.queryHistory.

Fixed

  • Buffer concat error when using symmetric encryption in the browser.

0.11.0 - 2021-08-20

Added

  • Examples: New Ethereum Private Message Using Wallet Encryption Web App example that demonstrates the usage of eth_encrypt API (available on Metamask) and EIP-712 for typed structured data signing.
  • New bootstrap option for Waku.create to easily connect to Waku nodes upon start up.
  • Support for startTime and endTime in Store queries to filter by time window as per 21/WAKU2-FTSTORE.

Changed

  • Renamed discover.getStatusFleetNodes to discovery.getBootstrapNodes; Changed the API to allow retrieval of bootstrap nodes from other sources.
  • Examples: Renamed eth-dm to eth-pm; "Direct Message" can lead to confusion with "Direct Connection" that refers to low latency network connections.
  • Examples (eth-pm): Use sign typed data EIP-712 instead of personal sign.
  • Upgraded dependencies to remove warning at installation.
  • Breaking: Moved DefaultPubSubTopic to waku.ts and fixed the casing.
  • Breaking: Rename all pubsubTopic occurrences to pubSubTopic, across all interfaces.

Removed

  • Examples (cli-chat): The focus of this library is Web environment; Several examples now cover usage of Waku Relay and Waku Store making cli-chat example obsolete; web-chat POC should be preferred to use the TOY-CHAT protocol.
  • ChatMessage has been moved from js-waku to web-chat example; it is a type used for the TOY-CHAT protocol; js-waku users should not build on top if this toy protocol and instead design message data structures appropriate to their use case.
  • Unused dependencies & scripts.

0.10.0 - 2021-08-06

Added

  • Relay and ReactJS guides and examples (#56).

Changed

  • Breaking: The WakuMessage APIs have been changed to move contentTopic out of the optional parameters.
  • Breaking: Move contentTopics out the WakuStore.queryHistory's optional parameters.
  • Breaking: WakuStore.queryHistory throws when encountering an error instead of returning a null value.

Removed

  • Examples (web-chat): Remove broken /fleet command.
  • Breaking: Removed DefaultContentTopic as developers must choose a content topic for their app; recommendations for content topic can be found at https://rfc.vac.dev/spec/23/.

Fixed

  • WakuMessage.payloadAsUtf8 returning garbage on utf-8 non-ascii characters.
  • ChatMessage.payloadAsUtf8 returning garbage on utf-8 non-ascii characters.

0.9.0 - 2021-07-26

Changed

  • Breaking: Store Response Protobuf changed to align with nim-waku v0.5 (nim-waku#676).

0.8.1 - 2021-07-16

Added

  • Examples (web-chat): New /fleet command to switch connection between Status prod and test fleets.
  • Export generatePrivateKey and getPublicKey directly from the root.
  • Usage of the encryption and signature APIs to the readme.
  • Support multiple protocol ids for Waku Relay, allowing interoperability with nim-waku v0.4 and latest master (#238).

Changed

  • Breaking: Renamed WakuRelay.(add|delete)PrivateDecryptionKey to WakuRelay.(add|delete)DecryptionKey to make it clearer that it accepts both symmetric keys and asymmetric private keys.
  • Upgrade libp2p to 0.32.0.
  • Breaking: Rename keepAlive option to pingKeepAlive.
  • Introduced new relayKeepAlive option on Waku with a default to 59s to send ping messages over relay to ensure the relay stream stays open. This is a workaround until js-libp2p#744 is done as there are issues when TCP(?) timeouts and the stream gets closed (#185, js-libp2p#939)

Fixed

  • Align WakuMessage readme example with actual code behaviour.
  • Remove infinite loop when an error with Waku Store is encountered.

0.8.0 - 2021-07-15

Added

  • WakuRelay.deleteObserver to allow removal of observers, useful when a React component add observers when mounting and needs to delete it when unmounting.
  • Keep alive feature that pings host regularly, reducing the chance of connections being dropped due to idle. Can be disabled or default frequency (10s) can be changed when calling Waku.create.
  • New lib/utils module for easy, dependency-less hex/bytes conversions.
  • New peers and randomPeer methods on WakuStore and WakuLightPush to have a better idea of available peers; Note that it does not check whether Waku node is currently connected to said peers.
  • Enable passing decryption private keys to WakuStore.queryHistory.
  • Test: Introduce testing in browser environment (Chrome) using Karma.
  • Add support for Waku Message version 1: Asymmetric encryption, symmetric encryption, and signature of the data.

Changed

  • Breaking: Auto select peer if none provided for store and light push protocols.
  • Upgrade to libp2p@0.31.7 and libp2p-gossipsub@0.10.0 to avoid TextEncoder errors in ReactJS tests.
  • Disable keep alive by default as latest nim-waku release does not support ping protocol.
  • Breaking: Optional parameters for WakuMessage.fromBytes and WakuMessage.fromUtf8String are now passed in a single Options object.
  • Breaking: WakuMessage static functions are now async to allow for encryption and decryption.
  • Breaking: WakuMessage constructor is now private, from* and decode* function should be used.
  • WakuMessage version 1 is partially supported, enabling asymmetrical encryption and signature of messages; this can be done by passing keys to WakuMessage.from* and WakuMessage.decode* methods.
  • Examples (eth-dm): Use Waku Message version 1 encryption scheme instead of eth-crypto.
  • Examples (eth-dm): Use Protobuf for direct messages instead of JSON (#214).

Fixed

  • Disable keepAlive if set to 0.

0.7.0 - 2021-06-15

Changed

  • Test: Upgrade nim-waku node to v0.4.
  • Waku Light Push upgraded to 2.0.0-beta1.
  • Examples (web chat): Catch error if chat message decoding fails.
  • Examples (web chat): Do not send message if shift/alt/ctrl is pressed, enabling multiline messages.

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