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]
|
|
|
|
|
|
2021-06-08 12:01:48 +00:00
|
|
|
### Changed
|
|
|
|
|
- **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.
|
|
|
|
|
|
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/).
|
|
|
|
|
- [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-21 05:42:03 +00:00
|
|
|
[Unreleased]: https://github.com/status-im/js-waku/compare/v0.5.0...HEAD
|
|
|
|
|
[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
|
