JavaScript implementation of Waku v2 https://js.waku.org
Go to file
bors[bot] 330caa2525
Merge #139
139: Provide API to process waku messages over relay r=D4nte a=D4nte

Resolves #54

Co-authored-by: Franck Royer <franck@status.im>
2021-05-10 05:44:39 +00:00
.github Move web-chat to examples folder 2021-05-05 16:35:14 +10:00
.vscode Format json files 2021-05-04 10:49:14 +10:00
examples Enable observers to filter by contentTopic 2021-05-10 14:54:08 +10:00
nim-waku@7c5df3379b Upgrade nim-waku to latest version 2021-05-07 11:30:36 +10:00
proto Clean up WakuMessage API 2021-05-03 16:26:02 +10:00
src Enable observers to filter by contentTopic 2021-05-10 14:54:08 +10:00
.cspell.json Use one cspell file for all project inc examples 2021-05-05 16:40:23 +10:00
.editorconfig Initial commit 2021-03-05 09:34:01 +11:00
.eslintrc.json Remove null-assertion warnings for tests 2021-05-04 11:12:32 +10:00
.gitignore Check in protobuf generated files 2021-04-20 15:32:10 +10:00
.gitmodules Re-add nim-waku submodule 2021-03-19 11:23:34 +11:00
.mocharc.json Move mocha --exit to config file 2021-05-05 09:59:32 +10:00
.prettierignore Use waku messages over waku relay 2021-03-10 16:22:49 +11:00
CONTRIBUTING.md Clarify expectations around commit patches 2021-04-29 16:53:49 +10:00
LICENSE-APACHE-v2 Apply MIT or Apache V2.0 License 2021-04-28 21:27:26 +10:00
LICENSE-MIT Apply MIT or Apache V2.0 License 2021-04-28 21:27:26 +10:00
README.md Move web-chat to examples folder 2021-05-05 16:35:14 +10:00
bors.toml Move web-chat to examples folder 2021-05-05 16:35:14 +10:00
buf.gen.yaml Implement chat message protobuf to support nick and time handles 2021-04-01 11:01:15 +11:00
buf.yaml Use waku messages over waku relay 2021-03-10 16:22:49 +11:00
package-lock.json Move cli chat to examples folder 2021-05-05 10:53:40 +10:00
package.json Add command to easily upgrade nim-waku to master HEAD 2021-05-07 11:30:35 +10:00
tsconfig.json Add few tsconfig rules 2021-05-04 10:49:13 +10:00
tsconfig.module.json Format json files 2021-05-04 10:49:14 +10:00

README.md

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 ✔ (querying node only)
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

Web Chat App (ReactJS)

A ReactJS web app is provided as an a show case of the library used in the browser.

A deployed version is available at https://status-im.github.io/js-waku/

To run a development version locally, do:

git clone https://github.com/status-im/js-waku/ ; cd js-waku
npm install   # Install dependencies for js-waku
npm run build # Build js-waku
cd examples/web-chat   
npm install   # Install dependencies for the web app
npm run start # Start development server to serve the web app on http://localhost:3000/js-waku

Use /help to see the available commands.

CLI Chat App (NodeJS)

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, first ensure you have Node.js v14 or above:

node --version

Then, install and run:

git clone https://github.com/status-im/js-waku/ ; cd js-waku
npm install   # Install dependencies for js-waku
npm run build # Build js-waku
cd examples/cli-chat
npm install # Install dependencies for the cli app
npm run start -- --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/7777/ws). 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

See CONTRIBUTING.md.

License

Licensed and distributed under either of

or

at your option. These files may not be copied, modified, or distributed except according to those terms.