2021-05-11 01:18:23 +00:00
# Changelog
All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog ](https://keepachangelog.com/en/1.0.0/ ),
and this project adheres to [Semantic Versioning ](https://semver.org/spec/v2.0.0.html ).
## [Unreleased]
2022-09-20 02:38:04 +00:00
### Changed
- Waku message encoding and decoding is more generic, to enable upcoming feature such as [RLN ](https://rfc.vac.dev/spec/17/ ) & [Noise ](https://rfc.vac.dev/spec/43/ );
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` .
2022-09-20 01:42:02 +00:00
## [0.28.1] - 2022-09-20
2022-09-19 02:21:29 +00:00
### Added
- `WakuRelay.addObserver` now returns a function to delete the observer.
2022-09-20 04:18:32 +00:00
- `WakuLightPush.push` and `WakuRelay.send` returns `SendResult` with the list of recipients.
2022-09-19 02:21:29 +00:00
2022-09-19 01:40:33 +00:00
### Changed
- `queryCallbackOnPromise` 's return value has been simplified to `Promise<void>` .
- doc: clarified behaviour of `WakuStore` query functions.
2022-09-19 03:50:29 +00:00
### Deleted
- `WakuMessage` class in favour of the `Message` , `Encoder` , `Decoder` interfaces and `EncoderV0` , `AsymEncoder` , `SymEncoder` (and related decoders).
2022-09-19 01:40:33 +00:00
2022-09-16 02:45:14 +00:00
## [0.28.0] - 2022-09-16
2022-09-14 12:24:00 +00:00
### Changed
- Correct options type for `createFullNode` & `createPrivacy` to enable passing gossipsub options.
2022-09-14 03:44:00 +00:00
- `WakuStore` now provides several APIs: `queryGenerator` , `queryCallbackOnPromise` , `queryOrderedCallback` ;
each provides different guarantees and performance.
2022-09-14 12:24:00 +00:00
2022-09-13 03:53:15 +00:00
## [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** .
2022-09-09 00:32:43 +00:00
### Changed
2022-09-13 03:53:15 +00:00
- `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.
2022-09-09 00:32:43 +00:00
- `addPeerToAddressBook` is now async.
2022-09-10 14:39:02 +00:00
- API Docs moved to https://js.waku.org/
2022-09-10 14:57:10 +00:00
- test: fix typing for nwaku JSON RPC responses.
2022-09-09 00:32:43 +00:00
2022-09-08 05:06:06 +00:00
## [0.26.0] - 2022-09-08
2022-09-05 11:48:27 +00:00
### Added
- Simple connection management that selects the most recent connection for store, light push and filter requests.
2022-09-05 12:07:18 +00:00
### Changed
2022-09-07 06:47:22 +00:00
- **breaking**: `DecryptionParams` may be passed when using `queryHistory` instead of just keys.
- Examples have been moved to https://github.com/waku-org/js-waku-examples.
2022-09-05 12:07:18 +00:00
2022-09-07 11:11:46 +00:00
### Fixed
- doc: add missing modules.
2022-09-08 05:06:06 +00:00
## [0.25.0] - 2022-09-05
2022-09-05 05:36:57 +00:00
2022-05-27 13:01:52 +00:00
### Changed
- Published files moved from `build` to `dist/` .
2022-06-15 11:17:46 +00:00
- 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.
2022-08-03 05:18:25 +00:00
- Move package to `"type": "module"` , it is now a [pure ESM package ](https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c ).
2022-06-20 04:57:49 +00:00
- Use ESM code in Mocha and Karma tests.
2022-07-19 05:43:35 +00:00
- Upgrade `dns-query` dependency, breaking change on `DnsNodeDiscovery` API.
2022-08-03 05:18:25 +00:00
- 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.
2022-08-05 11:21:06 +00:00
- Remove need to polyfill `buffer` .
2022-08-03 05:18:25 +00:00
- **breaking**: Various API changes. Refer to tests to check proper usage of the new API.
2022-08-05 14:56:21 +00:00
- **breaking**: `createWaku` is in separate exports path.
- **breaking**: Bootstrap class split: dns discovery, static list.
- **breaking**: bundled files are now under `bundle/` .
2022-08-03 05:18:25 +00:00
2022-08-05 14:56:21 +00:00
### Fixed
2022-08-03 05:18:25 +00:00
- size-limit config to test several usages of Waku.
2022-08-03 05:31:21 +00:00
- `buffer` is not needed in the browser.
2022-05-27 13:01:52 +00:00
2022-08-05 14:56:21 +00:00
### Removed
- `terser` minification and `gzip` compressions have been removed.
2022-05-27 13:41:15 +00:00
## [0.24.0] - 2022-05-27
2022-05-18 05:55:08 +00:00
### Added
- `waitForRemotePeer` now accepts a `timeoutMs` parameter that rejects the promise if it is reached. By default, no timeout is applied.
2022-05-26 04:49:51 +00:00
- **Experimental** support for the [Waku Filter ](https://rfc.vac.dev/spec/12/ ) protocol (client side) added, currently only works in NodeJS.
2022-05-18 05:55:08 +00:00
2022-05-16 05:47:54 +00:00
### Changed
- `waitForRemotePeer` waits for a Relay peer by default instead of Relay and Store.
2022-05-20 02:22:41 +00:00
- **Breaking**: Removed dupe secp256k1 code, removed some unused APIs.
2022-05-16 05:47:54 +00:00
2022-05-19 05:54:24 +00:00
## [0.23.0] - 2022-05-19
2022-05-18 07:50:23 +00:00
### Added
- Some dependencies that were used but not declared (often transient).
2022-05-18 07:17:55 +00:00
### Changed
- Replaced deprecated `multihashes` with `multiformats` .
2022-05-12 05:16:15 +00:00
### Removed
- No more `assert` usage.
2022-05-10 06:44:17 +00:00
## [0.22.0] - 2022-05-10
2022-05-10 06:42:25 +00:00
### Changed
- Replaced `secp256k1` and hence `elliptic` dependencies with `@noble/secp256k1` ,
reducing package size, number of dependency and removing need for `crypto-browserify` polyfill.
2022-05-05 06:45:27 +00:00
## [0.21.0] - 2022-05-5
2022-05-05 04:58:56 +00:00
### Added
- Support of the `waku2` ENR key: When using DNS Discovery, wanted node capabilities (e.g. relay, store) must be passed.
2022-04-29 08:20:39 +00:00
### Changed
- Prefer the use of `BigInt` over integer literal (`n` postfix) to facilitate the use of a polyfill.
2022-04-06 02:36:53 +00:00
### Fixed
- Declare `it-pipe` dependency, import as per `it-pipe@2.0.0` convention.
2022-03-29 10:33:17 +00:00
## [0.20.0] - 2022-03-29
2022-03-21 00:12:49 +00:00
### Changed
- Examples: Add Relay JavaScript example.
2022-03-25 05:20:14 +00:00
- **Breaking**: Moved utf-8 conversion functions to `utils` .
2022-03-29 10:25:32 +00:00
- Froze `libp2p-gossipsub` to `0.13.0` as new patch version bring breaking changes.
2022-03-21 00:12:49 +00:00
2022-03-25 00:02:40 +00:00
### Fixed
2022-03-25 00:59:14 +00:00
- Replace Base 64 buggy conversion functions with `uint8arrays` .
### Removed
- **Breaking**: Removed `equalByteArrays` , use `uint8arrays/equals` instead.
See changes in `eth-pm` example.
2022-03-25 03:24:48 +00:00
- **Breaking**: Removed deprecated utils functions.
2022-03-25 00:02:40 +00:00
2022-03-20 23:27:18 +00:00
## [0.19.2] - 2022-03-21
2022-03-18 03:47:25 +00:00
### Fixed
- Enable usage in NodeJS by fixing `exports` field and usage of the `crypto` module.
2022-03-10 05:25:51 +00:00
## [0.19.1] - 2022-03-10
2022-03-09 07:38:28 +00:00
### Added
- When using `Waku.create` , `bootstrap.peers` now accepts an array of `Multiaddr` .
2022-03-10 05:25:51 +00:00
- Exports `Protocols` for easy usage with `waitForRemotePeer` .
2022-03-09 07:38:28 +00:00
2022-03-09 03:29:35 +00:00
## [0.19.0] - 2022-03-09
2022-03-04 05:47:23 +00:00
### Added
- New `pubsub_topic` field on the `cursor` of Waku Store queries ([#585](https://github.com/status-im/js-waku/issues/595)).
2022-03-01 05:56:02 +00:00
### Changed
- Add `exports` to `package.json` for NodeJS usage (not officially supported but helpful for experiments).
2022-03-01 05:51:21 +00:00
### Fixed
- Handle errors thrown by `bytesToUtf8` .
2022-03-09 01:00:02 +00:00
- `WakuMessage.timestamp` field must use nanoseconds (was using microseconds).
2022-03-01 05:51:21 +00:00
2022-03-06 12:20:59 +00:00
### Removed
- Removed `ecies-geth` dependency.
2022-02-24 05:40:14 +00:00
## [0.18.0] - 2022-02-24
2022-02-16 03:08:48 +00:00
### Changed
- Replaced `rlp` dependency with `@ethersproject/rlp` .
2022-02-24 05:25:58 +00:00
- **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` .
2022-02-16 03:08:48 +00:00
### Removed
- `base64url` and `bigint-buffer` dependencies.
2022-02-16 00:55:53 +00:00
## [0.17.0] - 2022-02-16
2022-02-02 04:12:08 +00:00
### Changed
- **Breaking**: Upgrade `libp2p` to `0.36.2` & `libp2p-gossipsub` to `0.13.0` . Some APIs are now async.
2022-02-11 06:27:15 +00:00
- docs: Various improvements.
- Ran `npm audit fix` .
2022-02-13 08:04:50 +00:00
- `Waku.dial` accepts protocols expected from the peer. Defaults to Waku Relay only.
2022-02-13 23:50:02 +00:00
- Deprecated `hexToBuf` & `bufToHex` in favour of `hexToBytes` & `bytesToHex` to move towards removing the `buffer` polyfill.
2022-02-16 00:43:57 +00:00
- **Breaking**: Replaced `getNodesFromHostedJson` with `getPredefinedBootstrapNodes` . Now, it uses a hardcoded list of nodes.
2022-02-02 04:12:08 +00:00
2022-02-13 22:26:22 +00:00
### Removed
2022-02-16 01:11:54 +00:00
- `axios` dependency in favour of fetch.
2022-02-13 22:26:22 +00:00
2022-01-31 04:56:59 +00:00
## [0.16.0] - 2022-01-31
2022-01-19 04:43:45 +00:00
### Changed
- Test: Upgrade nim-waku node to v0.7.
2022-01-27 01:40:46 +00:00
- Doc: Renamed "DappConnect" to "Waku Connect".
- Docs: API Docs are now available at https://js-waku.wakuconnect.dev/.
2022-01-30 10:56:21 +00:00
- **Breaking**: Replace `waitForConnectedPeer` with `waitForRemotePeer` ; the new method checks that the peer is ready before resolving the promise.
2022-01-19 04:43:45 +00:00
2022-01-19 01:24:32 +00:00
## [0.15.0] - 2022-01-17
2022-01-14 01:49:40 +00:00
### Added
- Implement DNS Discovery as per [EIP-1459 ](https://eips.ethereum.org/EIPS/eip-1459 ),
with ENR records as defined in [31/WAKU2-ENR ](https://rfc.vac.dev/spec/31/ );
Available by passing `{ bootstrap: { enrUrl: enrtree://... } }` to `Waku.create` .
2022-01-17 03:11:05 +00:00
- 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.
2022-01-14 01:49:40 +00:00
2021-10-12 02:22:29 +00:00
### Changed
- Test: Upgrade nim-waku node to v0.6.
2022-01-13 04:26:52 +00:00
- **Breaking**: Renamed `getBootstrapNodes` to `getNodesFromHostedJson` .
2022-01-06 02:31:05 +00:00
- Minimum node version changed to 16.
2022-01-13 03:28:45 +00:00
- **Breaking**: Changed `Waku.create` bootstrap option from `{ bootstrap: boolean }` to `{ bootstrap: BootstrapOptions }` .
Replace `{ boostrap: true }` with `{ boostrap: { default: true } }` to retain same behaviour.
2022-01-17 03:11:05 +00:00
- **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}])` .
2021-10-12 02:22:29 +00:00
2021-12-02 12:42:35 +00:00
### Fixed
- Doc: Some broken links.
2021-11-30 00:14:03 +00:00
## [0.14.2] - 2021-11-30
2021-11-26 04:54:54 +00:00
### Changed
- Examples: JS examples uses local ESM folder to replicate behaviour of js-waku publish package.
2021-11-26 04:53:58 +00:00
### Fixed
- `TypeError` issue related to constructors using js-waku in a JS project
([#323](https://github.com/status-im/js-waku/issues/323)).
2021-10-22 03:12:59 +00:00
## [0.14.1] - 2021-10-22
2021-10-19 04:22:38 +00:00
### Fixed
- Issue when importing the `utils` module.
2021-10-12 23:23:53 +00:00
## [0.14.0] - 2021-10-13
2021-10-07 04:33:00 +00:00
### Added
- If the `callback` function passed to`WakuStore.queryHistory` returns `true` , then no further pages are retrieved from the store.
2021-10-12 23:21:40 +00:00
- Use webpack to build UMD bundle of the library, see [README ](./README.md ) for usage.
2021-10-07 04:33:00 +00:00
2021-10-04 01:21:13 +00:00
### 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.
2021-10-05 00:17:03 +00:00
### Fixed
2022-01-27 01:40:46 +00:00
- Docs: Ensure that `WakuStore` 's `QueryOptions` documentation is available [online ](https://js-waku.wakuconnect.dev/ ).
2021-10-05 00:17:03 +00:00
2021-09-21 04:56:49 +00:00
## [0.13.1] - 2021-09-21
2021-09-21 04:24:56 +00:00
### Fixed
- `Error: Bootstrap requires a list of peer addresses` error when using `bootstrap: true` in `Waku.create` .
2021-09-16 04:49:30 +00:00
## [0.13.0] - 2021-09-16
2021-09-15 06:53:55 +00:00
### Changed
- Upgrade libp2p libraries: @chainsafe/libp2p -noise@4.1.1, libp2p@0.32.4, libp2p-gossipsub@0.11.1.
2021-09-15 06:53:55 +00:00
- Connects to a limited number of bootstrap nodes, defaults to 1.
2021-09-15 06:53:55 +00:00
2021-09-21 05:24:38 +00:00
## [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` .
2021-09-16 05:17:36 +00:00
## [0.12.1] - 2021-09-16
### Changed
- **hot fix**: Connects to a limited number of bootstrap nodes, defaults to 1.
2021-09-02 06:36:36 +00:00
## [0.12.0] - 2021-09-2
2021-08-26 05:24:57 +00:00
### Added
- Examples (eth-pm): Encrypt Public Key Messages using symmetric encryption.
2021-08-26 04:36:37 +00:00
- Guides: Encrypt messages using Waku Message Version 1.
2021-09-01 02:48:51 +00:00
- Allow passing decryption keys in hex string format.
2021-09-01 03:55:46 +00:00
- Allow passing decryption keys to `WakuStore` instance to avoid having to pass them at every `queryHistory` call.
2021-09-01 05:02:28 +00:00
- Allow passing decryption keys to `Waku` instance to avoid having to pass them to both `WakuRelay` and `WakuStore` .
2021-09-02 05:01:52 +00:00
- `Waku.waitForConnectedPeer` helper to ensure that we are connected to Waku peers when using the bootstrap option.
2021-08-26 05:24:57 +00:00
2021-08-25 02:14:53 +00:00
### 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.
2021-08-30 10:41:18 +00:00
- Renamed and promote the usage of `generateSymmetricKey()` to generate random symmetric keys.
2021-09-02 05:27:39 +00:00
- Improved errors thrown by `WakuStore.queryHistory` .
2021-08-25 02:14:53 +00:00
2021-08-26 05:22:42 +00:00
### Fixed
- Buffer concat error when using symmetric encryption in the browser.
2021-08-20 02:12:01 +00:00
## [0.11.0] - 2021-08-20
2021-08-10 01:32:14 +00:00
### Added
2021-08-20 02:12:01 +00:00
- Examples: New [Ethereum Private Message Using Wallet Encryption Web App ](./examples/eth-pm-wallet-encryption/README.md )
example that demonstrates the usage of `eth_encrypt` API (available on Metamask) and EIP-712 for typed structured data signing.
2021-08-10 01:32:14 +00:00
- New `bootstrap` option for `Waku.create` to easily connect to Waku nodes upon start up.
2021-08-19 05:49:43 +00:00
- Support for `startTime` and `endTime` in Store queries to filter by time window as per [21/WAKU2-FTSTORE ](https://rfc.vac.dev/spec/21/ ).
2021-08-10 01:32:14 +00:00
2021-08-09 06:25:10 +00:00
### Changed
2021-08-10 01:32:14 +00:00
- Renamed `discover.getStatusFleetNodes` to `discovery.getBootstrapNodes` ;
Changed the API to allow retrieval of bootstrap nodes from other sources.
2021-08-19 01:13:34 +00:00
- Examples: Renamed `eth-dm` to `eth-pm` ; "Direct Message" can lead to confusion with "Direct Connection" that
2021-08-17 06:01:27 +00:00
refers to low latency network connections.
2021-08-19 01:13:34 +00:00
- Examples (eth-pm): Use sign typed data EIP-712 instead of personal sign.
2021-08-18 05:39:06 +00:00
- Upgraded dependencies to remove warning at installation.
2021-08-19 04:12:24 +00:00
- **Breaking**: Moved `DefaultPubSubTopic` to `waku.ts` and fixed the casing.
2021-08-20 00:12:19 +00:00
- **Breaking**: Rename all `pubsubTopic` occurrences to `pubSubTopic` , across all interfaces.
2021-08-09 06:25:10 +00:00
2021-08-06 06:59:54 +00:00
### 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 ](https://rfc.vac.dev/spec/22/ ) protocol.
2021-08-06 07:20:30 +00:00
- `ChatMessage` has been moved from js-waku to web-chat example;
it is a type used for the [TOY-CHAT ](https://rfc.vac.dev/spec/22/ ) protocol;
js-waku users should not build on top if this toy protocol and instead design message data structures appropriate to their use case.
2021-08-20 00:35:36 +00:00
- Unused dependencies & scripts.
2021-08-06 06:59:54 +00:00
2021-08-06 06:35:40 +00:00
## [0.10.0] - 2021-08-06
2021-08-02 04:36:14 +00:00
### Added
- Relay and ReactJS guides and examples
([#56](https://github.com/status-im/js-waku/issues/56)).
2021-07-28 01:19:24 +00:00
### Changed
- **Breaking**: The `WakuMessage` APIs have been changed to move `contentTopic` out of the optional parameters.
2021-08-04 01:59:53 +00:00
- **Breaking**: Move `contentTopics` out the `WakuStore.queryHistory` 's optional parameters.
2021-08-04 02:35:47 +00:00
- **Breaking**: `WakuStore.queryHistory` throws when encountering an error instead of returning a `null` value.
2021-07-28 01:19:24 +00:00
2021-07-28 01:42:42 +00:00
### Removed
- Examples (web-chat): Remove broken `/fleet` command.
2021-07-28 01:19:24 +00:00
- **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/.
2021-07-28 01:42:42 +00:00
2021-08-01 23:51:37 +00:00
### Fixed
- `WakuMessage.payloadAsUtf8` returning garbage on utf-8 non-ascii characters.
2021-08-02 00:36:50 +00:00
- `ChatMessage.payloadAsUtf8` returning garbage on utf-8 non-ascii characters.
2021-08-01 23:51:37 +00:00
2021-07-26 06:41:21 +00:00
## [0.9.0] - 2021-07-26
2021-07-22 00:59:45 +00:00
### Changed
2021-07-26 06:41:21 +00:00
- **Breaking**: Store Response Protobuf changed to align with nim-waku v0.5
2021-07-22 00:59:45 +00:00
([nim-waku#676](https://github.com/status-im/nim-waku/pull/676)).
2021-07-16 01:59:22 +00:00
## [0.8.1] - 2021-07-16
2021-07-15 23:43:10 +00:00
### Added
2021-07-15 23:50:44 +00:00
- Examples (web-chat): New `/fleet` command to switch connection between Status prod and test fleets.
2021-07-15 23:43:10 +00:00
- Export `generatePrivateKey` and `getPublicKey` directly from the root.
2021-07-16 01:17:11 +00:00
- Usage of the encryption and signature APIs to the readme.
2021-07-21 05:15:11 +00:00
- Support multiple protocol ids for Waku Relay, allowing interoperability with nim-waku v0.4 and latest master
([#238](https://github.com/status-im/js-waku/issues/238)).
2021-07-15 23:43:10 +00:00
2021-07-16 00:24:29 +00:00
### 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.
2021-07-22 05:31:34 +00:00
- Upgrade libp2p to 0.32.0.
2021-07-22 06:34:27 +00:00
- **Breaking**: Rename `keepAlive` option to `pingKeepAlive` .
2021-07-27 05:55:11 +00:00
- 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 ](https://github.com/libp2p/js-libp2p/issues/744 ) is done as there are issues when TCP(?) timeouts and the stream gets closed
([#185](https://github.com/status-im/js-waku/issues/185), [js-libp2p#939 ](https://github.com/libp2p/js-libp2p/issues/939 ))
2021-07-16 00:24:29 +00:00
2021-07-21 05:33:58 +00:00
### Fixed
2021-07-16 00:24:29 +00:00
- Align `WakuMessage` readme example with actual code behaviour.
2021-07-21 05:15:11 +00:00
- Remove infinite loop when an error with Waku Store is encountered.
2021-07-15 23:51:59 +00:00
2021-07-15 02:45:29 +00:00
## [0.8.0] - 2021-07-15
2021-06-16 13:37:13 +00:00
### Added
2021-06-16 04:29:50 +00:00
- `WakuRelay.deleteObserver` to allow removal of observers, useful when a React component add observers when mounting and needs to delete it when unmounting.
2021-06-18 06:48:16 +00:00
- Keep alive feature that pings host regularly, reducing the chance of connections being dropped due to idle.
2021-07-09 05:12:52 +00:00
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.
2021-07-12 03:11:43 +00:00
- 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.
2021-07-12 03:13:00 +00:00
- Enable passing decryption private keys to `WakuStore.queryHistory` .
2021-07-14 05:35:46 +00:00
- Test: Introduce testing in browser environment (Chrome) using Karma.
2021-07-14 11:15:54 +00:00
- Add support for Waku Message version 1: Asymmetric encryption, symmetric encryption, and signature of the data.
2021-06-16 04:29:50 +00:00
2021-06-16 13:37:13 +00:00
### Changed
- **Breaking**: Auto select peer if none provided for store and light push protocols.
2021-06-21 06:37:31 +00:00
- Upgrade to `libp2p@0.31.7` and `libp2p-gossipsub@0.10.0` to avoid `TextEncoder` errors in ReactJS tests.
2021-07-02 06:08:29 +00:00
- Disable keep alive by default as latest nim-waku release does not support ping protocol.
2021-07-06 05:29:02 +00:00
- **Breaking**: Optional parameters for `WakuMessage.fromBytes` and `WakuMessage.fromUtf8String` are now passed in a single `Options` object.
2021-07-07 01:23:56 +00:00
- **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.
2021-07-12 07:29:22 +00:00
- 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](https://github.com/status-im/js-waku/issues/214)).
2021-06-16 13:37:13 +00:00
2021-07-02 00:51:58 +00:00
### Fixed
- Disable `keepAlive` if set to `0` .
2021-06-15 05:31:12 +00:00
## [0.7.0] - 2021-06-15
2021-06-11 04:32:16 +00:00
### Changed
- Test: Upgrade nim-waku node to v0.4.
2021-06-11 04:32:49 +00:00
- Waku Light Push upgraded to `2.0.0-beta1` .
2021-06-11 04:33:03 +00:00
- Examples (web chat): Catch error if chat message decoding fails.
2021-06-11 04:34:50 +00:00
- Examples (web chat): Do not send message if shift/alt/ctrl is pressed, enabling multiline messages.
2021-06-11 04:32:16 +00:00
2021-06-09 06:34:09 +00:00
## [0.6.0] - 2021-06-09
2021-06-08 12:01:48 +00:00
### Changed
2021-06-09 06:59:27 +00:00
- **Breaking**: Websocket protocol is not automatically added anymore if the user specifies a protocol in `libp2p.modules`
when using `Waku.create` .
2021-06-08 12:01:48 +00:00
- **Breaking**: Options passed to `Waku.create` used to be passed to `Libp2p.create` ;
2021-06-09 06:58:08 +00:00
Now, only the `libp2p` property is passed to `Libp2p.create` , allowing for a cleaner interface.
- Examples (cli chat): Use tcp protocol instead of websocket.
2021-06-08 12:01:48 +00:00
2021-05-28 06:00:34 +00:00
### Added
- Enable access to `WakuMessage.timestamp` .
2021-05-28 06:31:08 +00:00
- Examples (web chat): Use `WakuMessage.timestamp` as unique key for list items.
2021-06-01 06:07:44 +00:00
- Doc: Link to new [topic guidelines ](https://rfc.vac.dev/spec/23/ ) in README.
2021-06-01 06:10:03 +00:00
- Doc: Link to [Waku v2 Toy Chat specs ](https://rfc.vac.dev/spec/22/ ) in README.
2021-06-04 05:15:07 +00:00
- Examples (web chat): Persist nick.
2021-06-09 02:25:56 +00:00
- 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.
2021-05-28 06:00:34 +00:00
2021-05-21 05:42:03 +00:00
## [0.5.0] - 2021-05-21
2021-05-19 01:00:43 +00:00
### Added
- Implement [Waku v2 Light Push protocol ](https://rfc.vac.dev/spec/19/ ).
2021-05-19 01:57:03 +00:00
- Expose `Direction` enum from js-waku root (it was only accessible via the proto module).
2021-05-19 01:59:02 +00:00
- Examples (cli chat): Use light push to send messages if `--lightPush` is passed.
2021-05-19 02:07:48 +00:00
- Examples (cli chat): Print usage if `--help` is passed.
2021-05-19 01:00:43 +00:00
2021-05-18 04:12:17 +00:00
## [0.4.0] - 2021-05-18
2021-05-07 06:10:58 +00:00
### 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.
2021-05-15 11:54:44 +00:00
### Changed
- Testing: Upgrade nim-waku node to v0.3.
2021-05-17 06:11:01 +00:00
- **Breaking**: Modify `WakuStore.queryHistory()` to accept one `Object` instead of multiple individual arguments.
2021-05-18 03:26:42 +00:00
- `getStatusFleetNodes` return prod nodes by default, instead of test nodes.
2021-05-18 03:47:16 +00:00
- Examples (web chat): Connect to prod fleet by default, test fleet for local development.
2021-05-18 03:50:36 +00:00
- Examples (cli chat): Connect to test fleet by default, use `--prod` to connect to prod fleet.
2021-05-15 11:54:44 +00:00
2021-05-18 03:45:49 +00:00
### Fixed
- Expose `Enviroment` and `Protocol` enums to pass to `getStatusFleetNodes` .
2021-05-15 10:45:33 +00:00
## [0.3.0] - 2021-05-15
2021-05-14 03:23:44 +00:00
### Added
- `getStatusFleetNodes` to connect to Status' nim-waku nodes.
2021-05-14 05:58:09 +00:00
### Changed
- Clarify content topic format in README.md.
2021-05-15 09:49:37 +00:00
## Removed
- Unused dependencies.
2021-05-13 23:35:06 +00:00
## [0.2.0] - 2021-05-14
2021-05-13 06:42:18 +00:00
### Added
- `WakuRelay.getPeers` method.
2021-05-13 09:48:05 +00:00
- Use `WakuRelay.getPeers` in web chat app example to disable send button.
2021-05-13 06:42:18 +00:00
2021-05-13 01:47:03 +00:00
### Changed
- Enable passing `string` s to `addPeerToAddressBook` .
2021-05-13 01:51:39 +00:00
- Use `addPeerToAddressBook` in examples and usage doc.
2021-05-13 06:49:29 +00:00
- Settle on `js-waku` name across the board.
2021-05-13 06:29:44 +00:00
- **Breaking**: `RelayDefaultTopic` renamed to `DefaultPubsubTopic` .
2021-05-13 01:47:03 +00:00
2021-05-13 02:01:07 +00:00
## [0.1.0] - 2021-05-12
2021-05-11 06:44:23 +00:00
2021-05-11 01:18:23 +00:00
### Added
2021-05-13 00:39:20 +00:00
- Add usage section to the README.
2021-05-11 01:18:23 +00:00
- Support of [Waku v2 Relay ](https://rfc.vac.dev/spec/11/ ).
- Support of [Waku v2 Store ](https://rfc.vac.dev/spec/13/ ).
2022-02-02 00:56:40 +00:00
- [Node Chat App example]().
2021-05-11 01:18:23 +00:00
- [ReactJS Chat App example ](./examples/web-chat ).
2022-02-02 00:56:40 +00:00
- [Typedoc Documentation ](https://js-waku.wakuconnect.dev/ ).
2021-05-11 01:18:23 +00:00
2022-09-20 01:42:02 +00:00
[Unreleased]: https://github.com/status-im/js-waku/compare/v0.28.1...HEAD
[0.28.1]: https://github.com/status-im/js-waku/compare/v0.28.0...v0.28.1
2022-09-16 02:45:14 +00:00
[0.28.0]: https://github.com/status-im/js-waku/compare/v0.27.0...v0.28.0
2022-09-13 03:53:15 +00:00
[0.27.0]: https://github.com/status-im/js-waku/compare/v0.26.0...v0.27.0
2022-09-08 05:06:06 +00:00
[0.26.0]: https://github.com/status-im/js-waku/compare/v0.25.0...v0.26.0
2022-09-05 05:36:57 +00:00
[0.25.0]: https://github.com/status-im/js-waku/compare/v0.24.0...v0.25.0
2022-05-27 13:41:15 +00:00
[0.24.0]: https://github.com/status-im/js-waku/compare/v0.23.0...v0.24.0
2022-05-19 05:54:24 +00:00
[0.23.0]: https://github.com/status-im/js-waku/compare/v0.22.0...v0.23.0
2022-05-10 06:44:17 +00:00
[0.22.0]: https://github.com/status-im/js-waku/compare/v0.21.0...v0.22.0
2022-05-05 06:45:27 +00:00
[0.21.0]: https://github.com/status-im/js-waku/compare/v0.20.0...v0.21.0
2022-03-29 10:33:17 +00:00
[0.20.0]: https://github.com/status-im/js-waku/compare/v0.19.2...v0.20.0
2022-03-20 23:27:18 +00:00
[0.19.2]: https://github.com/status-im/js-waku/compare/v0.19.0...v0.19.2
2022-03-10 05:25:51 +00:00
[0.19.1]: https://github.com/status-im/js-waku/compare/v0.19.0...v0.19.1
2022-03-09 03:29:35 +00:00
[0.19.0]: https://github.com/status-im/js-waku/compare/v0.18.0...v0.19.0
2022-02-24 05:40:14 +00:00
[0.18.0]: https://github.com/status-im/js-waku/compare/v0.17.0...v0.18.0
2022-02-16 00:55:53 +00:00
[0.17.0]: https://github.com/status-im/js-waku/compare/v0.16.0...v0.17.0
2022-01-31 04:56:59 +00:00
[0.16.0]: https://github.com/status-im/js-waku/compare/v0.15.0...v0.16.0
2022-01-19 01:24:32 +00:00
[0.15.0]: https://github.com/status-im/js-waku/compare/v0.14.2...v0.15.0
2021-11-30 01:16:07 +00:00
[0.14.2]: https://github.com/status-im/js-waku/compare/v0.14.1...v0.14.2
2021-10-22 03:12:59 +00:00
[0.14.1]: https://github.com/status-im/js-waku/compare/v0.14.0...v0.14.1
2021-10-12 23:23:53 +00:00
[0.14.0]: https://github.com/status-im/js-waku/compare/v0.13.1...v0.14.0
2021-09-21 04:56:49 +00:00
[0.13.1]: https://github.com/status-im/js-waku/compare/v0.13.0...v0.13.1
2021-09-16 04:49:30 +00:00
[0.13.0]: https://github.com/status-im/js-waku/compare/v0.12.0...v0.13.0
2021-09-21 05:41:23 +00:00
[0.12.2]: https://github.com/status-im/js-waku/compare/v0.12.1...v0.12.2
2021-09-16 05:17:36 +00:00
[0.12.1]: https://github.com/status-im/js-waku/compare/v0.12.0...v0.12.1
2021-09-02 06:36:36 +00:00
[0.12.0]: https://github.com/status-im/js-waku/compare/v0.11.0...v0.12.0
2021-08-20 02:12:01 +00:00
[0.11.0]: https://github.com/status-im/js-waku/compare/v0.10.0...v0.11.0
2021-08-06 06:35:40 +00:00
[0.10.0]: https://github.com/status-im/js-waku/compare/v0.9.0...v0.10.0
[0.9.0]: https://github.com/status-im/js-waku/compare/v0.8.1...v0.9.0
[0.8.1]: https://github.com/status-im/js-waku/compare/v0.8.0...v0.8.1
2021-07-16 01:59:22 +00:00
[0.8.1]: https://github.com/status-im/js-waku/compare/v0.8.0...v0.8.1
2021-07-15 02:45:29 +00:00
[0.8.0]: https://github.com/status-im/js-waku/compare/v0.7.0...v0.8.0
2021-06-15 05:31:12 +00:00
[0.7.0]: https://github.com/status-im/js-waku/compare/v0.6.0...v0.7.0
2021-06-09 06:34:09 +00:00
[0.6.0]: https://github.com/status-im/js-waku/compare/v0.5.0...v0.6.0
2021-05-21 05:42:03 +00:00
[0.5.0]: https://github.com/status-im/js-waku/compare/v0.4.0...v0.5.0
2021-05-18 04:12:17 +00:00
[0.4.0]: https://github.com/status-im/js-waku/compare/v0.3.0...v0.4.0
2021-05-15 12:00:29 +00:00
[0.3.0]: https://github.com/status-im/js-waku/compare/v0.2.0...v0.3.0
2021-05-13 23:35:06 +00:00
[0.2.0]: https://github.com/status-im/js-waku/compare/v0.1.0...v0.2.0
[0.1.0]: https://github.com/status-im/js-waku/compare/f46ce77f57c08866873b5c80acd052e0ddba8bc9...v0.1.0