3.1 KiB
js-waku
A JavaScript implementation of the Waku v2 protocol.
Waku Protocol Support
You can track progress on the project board.
- ✔: Supported
- 🚧: Implementation in progress
- ⛔: Support is not planned
Spec | Implementation Status |
---|---|
6/WAKU1 | ⛔ |
7/WAKU-DATA | ⛔ |
8/WAKU-MAIL | ⛔ |
9/WAKU-RPC | ⛔ |
10/WAKU2 | 🚧 |
11/WAKU2-RELAY | ✔ |
12/WAKU2-FILTER | |
13/WAKU2-STORE | 🚧 |
14/WAKU2-MESSAGE | ✔ |
15/WAKU2-BRIDGE | |
16/WAKU2-RPC | ⛔ |
17/WAKU2-RLNRELAY | |
18/WAKU2-SWAP |
Bugs, Questions & Features
If you encounter any bug or would like to propose new features, feel free to open an issue.
For support, questions & more general topics, please join the discussion on the Vac forum (use #js-waku tag).
Examples
Chat app
A node chat app is provided as a working example of the library. It is interoperable with the nim-waku chat app example. To run the chat app:
git clone https://github.com/status-im/js-waku/ ; cd js-waku
npm install
npm run chat -- --staticNode /ip4/134.209.139.210/tcp/30303/p2p/16Uiu2HAmPLe7Mzm8TsYUubgCAW1aJoeFScxrLj8ppHFivPo97bUZ
You can also specify an optional listenAddr
parameter (.e.g --listenAddr /ip4/0.0.0.0/tcp/55123
).
This is only useful if you want a remote node to dial to your chat app,
it is not necessary in normal usage when you just connect to the fleet.
Contributing
Build & Test
To build and test this repository, you need:
- Node.js & npm
- bufbuild (only if changing protobuf files)
- protoc (only if changing protobuf files)
To ensure interoperability with nim-waku, some tests are run against a nim-waku node.
This is why nim-waku
is present as a git submodule, which itself contain several submodules.
At this stage, it is not possible to exclude nim-waku tests, hence git submodule update --init --recursive
is run before testing (see pretest
script).
To build nim-waku, you also need Rust.
Guidelines
- Please follow Chris Beam's commit message guide,
- Usually best to test new code,
- CI must pass.