mirror of
https://github.com/logos-messaging/js-waku.git
synced 2026-01-20 22:53:06 +00:00
26d115ab7c
### 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`. - 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}])`.
js-waku
A JavaScript implementation of the Waku v2 protocol.
Documentation
API Documentation can also be generated locally:
git clone https://github.com/status-im/js-waku.git
cd js-waku
npm install
npm run doc
Changelog
Release changelog can be found in CHANGELOG.md.
Bugs, Questions & Features
If you encounter any bug or would like to propose new features, feel free to open an issue.
To get help, join #dappconnect-support on Vac Discord or Telegram.
For more general discussion and latest news, join #dappconnect on Vac Discord or Telegram.
Roadmap
You can track progress on the project board.
Contributing
See CONTRIBUTING.md.
License
Licensed and distributed under either of
- MIT license: LICENSE-MIT or http://opensource.org/licenses/MIT
or
- Apache License, Version 2.0, (LICENSE-APACHE-v2 or http://www.apache.org/licenses/LICENSE-2.0)
at your option. These files may not be copied, modified, or distributed except according to those terms.