js-waku

A TypeScript implementation of the Waku v2 protocol.

Documentation

• Quick start
• Full documentation
• API documentation (master branch)
• Waku
• Vac

API Documentation can also be generated locally:

git clone https://github.com/waku-org/js-waku.git
cd js-waku
npm install
npm run doc
Copy

Using Nix shell

git clone https://github.com/waku-org/js-waku.git
cd js-waku
nix develop
npm install
npm run doc
Copy

Bugs, Questions & Features

If you encounter any bug or would like to propose new features, feel free to open an issue.

For general discussion, get help or latest news, join us on Vac Discord or the Waku Telegram Group.

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.