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](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [Unreleased]

### 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`. 

### Changed
- **Breaking**: Auto select peer if none provided for store and light push protocols.

## [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](https://rfc.vac.dev/spec/23/) in README.
- Doc: Link to [Waku v2 Toy Chat specs](https://rfc.vac.dev/spec/22/) 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](https://rfc.vac.dev/spec/19/).
- 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 `string`s 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](https://rfc.vac.dev/spec/11/).
- Support of [Waku v2 Store](https://rfc.vac.dev/spec/13/).
- [Node Chat App example](./examples/cli-chat).
- [ReactJS Chat App example](./examples/web-chat).
- [Typedoc Documentation](https://status-im.github.io/js-waku/docs).

[Unreleased]: https://github.com/status-im/js-waku/compare/v0.7.0...HEAD
[0.7.0]: https://github.com/status-im/js-waku/compare/v0.6.0...v0.7.0
[0.6.0]: https://github.com/status-im/js-waku/compare/v0.5.0...v0.6.0
[0.5.0]: https://github.com/status-im/js-waku/compare/v0.4.0...v0.5.0
[0.4.0]: https://github.com/status-im/js-waku/compare/v0.3.0...v0.4.0
[0.3.0]: https://github.com/status-im/js-waku/compare/v0.2.0...v0.3.0
[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
Add CHANGELOG.md 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]`

Auto select peer if none provided for store and light push protocols 2021-06-16 13:37:13 +00:00			`### Added`
Add `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-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.
Add keep alive feature Using libp2p ping protocol. 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.`
			Can be disabled or default frequency (10s) can be changed when calling `Waku.create`.
Add `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-16 04:29:50 +00:00
Auto select peer if none provided for store and light push protocols 2021-06-16 13:37:13 +00:00			`### Changed`
			`- Breaking: Auto select peer if none provided for store and light push protocols.`

Release 0.7.0 ### 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. 2021-06-15 05:31:12 +00:00			`## [0.7.0] - 2021-06-15`

Upgrade nim-waku to v0.4 2021-06-11 04:32:16 +00:00			`### Changed`
			`- Test: Upgrade nim-waku node to v0.4.`
Update Light Push protocol string to match nim-waku v0.4 2021-06-11 04:32:49 +00:00			- Waku Light Push upgraded to `2.0.0-beta1`.
Do not fail if a chat message is malformed 2021-06-11 04:33:03 +00:00			`- Examples (web chat): Catch error if chat message decoding fails.`
Do not send message if a modifier is pressed to enable multiline msgs 2021-06-11 04:34:50 +00:00			`- Examples (web chat): Do not send message if shift/alt/ctrl is pressed, enabling multiline messages.`
Upgrade nim-waku to v0.4 2021-06-11 04:32:16 +00:00
Release 0.6.0 ### 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](https://rfc.vac.dev/spec/23/) in README. - Doc: Link to [Waku v2 Toy Chat specs](https://rfc.vac.dev/spec/22/) 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. 2021-06-09 06:34:09 +00:00			`## [0.6.0] - 2021-06-09`

Separate the libp2p create options from Waku's 2021-06-08 12:01:48 +00:00			`### Changed`
Clarify new libp2p modules transport behaviour 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`.
Separate the libp2p create options from Waku's 2021-06-08 12:01:48 +00:00			- Breaking: Options passed to `Waku.create` used to be passed to `Libp2p.create`;
Use tcp protocol only Due to #201, Websocket protocol is not added by default if the caller specifies a protocol for libp2p. In the case cli-chat. We were using both tcp and ws. As the web-chat already demonstrates usage of websocket protocol, we cli-chat to tcp only. 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.`
Separate the libp2p create options from Waku's 2021-06-08 12:01:48 +00:00
Enable test encoding and decoding of WakuMessage.timestamp 2021-05-28 06:00:34 +00:00			`### Added`
			- Enable access to `WakuMessage.timestamp`.
Use waku message timestamp as better unique key 2021-05-28 06:31:08 +00:00			- Examples (web chat): Use `WakuMessage.timestamp` as unique key for list items.
Add link to new topic usage recommendation 2021-06-01 06:07:44 +00:00			`- Doc: Link to new [topic guidelines](https://rfc.vac.dev/spec/23/) in README.`
Add link to Waku v2 Toy Chat specs 2021-06-01 06:10:03 +00:00			`- Doc: Link to [Waku v2 Toy Chat specs](https://rfc.vac.dev/spec/22/) in README.`
Persist nick 2021-06-04 05:15:07 +00:00			`- Examples (web chat): Persist nick.`
Enable passing a custom pubsub topic Note that we currently only support one, and only one, pubsub topic for a given instance across the codebase. The PubSub topic needs to be set when instantiating the Waku* classes. At this stage, we believe that most DApp will use, and only use, the default PubSub topic. Some application want to use an alternative topic but not use the default one so this behaviour should be fine. See #174 for details. 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.`
Enable test encoding and decoding of WakuMessage.timestamp 2021-05-28 06:00:34 +00:00
Release 0.5.0 2021-05-21 05:42:03 +00:00			`## [0.5.0] - 2021-05-21`

Implement Light Push protocol 2021-05-19 01:00:43 +00:00			`### Added`
			`- Implement [Waku v2 Light Push protocol](https://rfc.vac.dev/spec/19/).`
Get messages from store in chronological order 2021-05-19 01:57:03 +00:00			- Expose `Direction` enum from js-waku root (it was only accessible via the proto module).
Use light push to send messages if it's passed 2021-05-19 01:59:02 +00:00			- Examples (cli chat): Use light push to send messages if `--lightPush` is passed.
Add `--help` command 2021-05-19 02:07:48 +00:00			- Examples (cli chat): Print usage if `--help` is passed.
Implement Light Push protocol 2021-05-19 01:00:43 +00:00
Release 0.4.0 2021-05-18 04:12:17 +00:00			`## [0.4.0] - 2021-05-18`

Use one object as we are increasing the number of parameters 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.

Upgrade nim-waku to v0.3 2021-05-15 11:54:44 +00:00			`### Changed`
			`- Testing: Upgrade nim-waku node to v0.3.`
Add callback option to store query 2021-05-17 06:11:01 +00:00			- Breaking: Modify `WakuStore.queryHistory()` to accept one `Object` instead of multiple individual arguments.
Use prod nodes by default instead of test 2021-05-18 03:26:42 +00:00			- `getStatusFleetNodes` return prod nodes by default, instead of test nodes.
Connect to prod fleet by default, test fleet for local development 2021-05-18 03:47:16 +00:00			`- Examples (web chat): Connect to prod fleet by default, test fleet for local development.`
Connect cli chat to prod fleet upon passing `--prod` 2021-05-18 03:50:36 +00:00			- Examples (cli chat): Connect to test fleet by default, use `--prod` to connect to prod fleet.
Upgrade nim-waku to v0.3 2021-05-15 11:54:44 +00:00
Expose `Enviroment` & `Protocol` enums to pass to `getStatusFleetNodes` 2021-05-18 03:45:49 +00:00			`### Fixed`
			- Expose `Enviroment` and `Protocol` enums to pass to `getStatusFleetNodes`.

Release 0.3.0 2021-05-15 10:45:33 +00:00			`## [0.3.0] - 2021-05-15`

Add and use `getStatusFleetNodes` to connect to Status' wakunodes 2021-05-14 03:23:44 +00:00			`### Added`
			- `getStatusFleetNodes` to connect to Status' nim-waku nodes.

Clarify content topic format 2021-05-14 05:58:09 +00:00			`### Changed`
			`- Clarify content topic format in README.md.`

Remove unused dependencies 2021-05-15 09:49:37 +00:00			`## Removed`
			`- Unused dependencies.`

Release 0.2.0 2021-05-13 23:35:06 +00:00			`## [0.2.0] - 2021-05-14`

Add getPeers method To know if relay messages would be published. 2021-05-13 06:42:18 +00:00			`### Added`
			- `WakuRelay.getPeers` method.
Disable send button if no peer available Yet keep it enabled if user tries to send a command. Resolves #136 2021-05-13 09:48:05 +00:00			- Use `WakuRelay.getPeers` in web chat app example to disable send button.
Add getPeers method To know if relay messages would be published. 2021-05-13 06:42:18 +00:00
Enhance addPeerToAddressBook So that consumer does not need to import multiaddr and peer-id. 2021-05-13 01:47:03 +00:00			`### Changed`
			- Enable passing `string`s to `addPeerToAddressBook`.
Update usage with dial peer method 2021-05-13 01:51:39 +00:00			- Use `addPeerToAddressBook` in examples and usage doc.
Revert naming to js-waku To align with go-waku and nim-waku and keep bors working. 2021-05-13 06:49:29 +00:00			- Settle on `js-waku` name across the board.
Align terminology with specs In specs, this is referenced as a `pubsubTopic`. 2021-05-13 06:29:44 +00:00			- Breaking: `RelayDefaultTopic` renamed to `DefaultPubsubTopic`.
Enhance addPeerToAddressBook So that consumer does not need to import multiaddr and peer-id. 2021-05-13 01:47:03 +00:00
Release 0.1.0 ### Added - Add usage section to the README. - Support of [Waku v2 Relay](https://rfc.vac.dev/spec/11/). - Support of [Waku v2 Store](https://rfc.vac.dev/spec/13/). - [Node Chat App example](./examples/cli-chat). - [ReactJS Chat App example](./examples/web-chat). - [Typedoc Documentation](https://status-im.github.io/js-waku/docs). 2021-05-13 02:01:07 +00:00			`## [0.1.0] - 2021-05-12`
Release 1.0.0 2021-05-11 06:44:23 +00:00
Add CHANGELOG.md 2021-05-11 01:18:23 +00:00			`### Added`
Set first release version to 0.1.0 2021-05-13 00:39:20 +00:00			`- Add usage section to the README.`
Add CHANGELOG.md 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/).`
			`- [Node Chat App example](./examples/cli-chat).`
			`- [ReactJS Chat App example](./examples/web-chat).`
			`- [Typedoc Documentation](https://status-im.github.io/js-waku/docs).`

Release 0.7.0 ### 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. 2021-06-15 05:31:12 +00:00			`[Unreleased]: https://github.com/status-im/js-waku/compare/v0.7.0...HEAD`
			`[0.7.0]: https://github.com/status-im/js-waku/compare/v0.6.0...v0.7.0`
Release 0.6.0 ### 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](https://rfc.vac.dev/spec/23/) in README. - Doc: Link to [Waku v2 Toy Chat specs](https://rfc.vac.dev/spec/22/) 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. 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`
Release 0.5.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`
Release 0.4.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`
Fix link 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`
Release 0.2.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`