2.0 KiB
| title | slug |
|---|---|
| Introduction | /clients/js-waku |
JS-Waku Documentation
JS-Waku is the TypeScript implementation of the Waku protocol, specifically designed for the browser environment. This powerful, easy-to-use library enables you to integrate Waku into your web applications seamlessly.
:::info
If you wish to use Waku with a NodeJS application, you can either:
- Use nwaku's JSON RPC API
- Or, attempt to use go-waku's c-bindings in NodeJS
:::
To get started, the Quick Start guide offers a simple way to integrate Waku into your web app. For a more comprehensive tutorial, follow the Build a Chat App guide, which demonstrates how to create a chat app from scratch.
Explore the js-waku-examples repository to find various working Proof-of-Concepts that showcase how to use JS-Waku effectively. You can also interact with these examples live:
- web-chat: A simple public chat.
- eth-pm: End-to-end encrypted private messages.
- rln-js: Demonstration of RLN, an economic spam protection protocol that rate limit using zero-knowledge for privacy preserving purposes.
To gain a deeper understanding of Waku, visit the overview documentation. If you are interested in learning how Waku works under the hood, check out the specs at rfc.vac.dev.
Bugs, Questions & Support
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 #js-waku on Vac Discord or the Waku Telegram Group.