3.2 KiB
| title | hide_table_of_contents | slug |
|---|---|---|
| Getting Started | true | / |
:::caution Waku has risks and limitations as it is still developing and preparing for extensive adoption. However, it is already demonstrating its capabilities by powering various applications. Join our community to stay updated on our progress. :::
Ready to integrate Waku into your application for private, secure, censorship-free communication? Explore the available SDKs and contribute by running a node.
Run a Waku node
The Waku Network is a decentralised, permissionless system where anyone can run nodes, use the network, and contribute to its support.
| Description | Documentation | |
|---|---|---|
| nwaku | Nim-based Waku implementation to run a standalone node and access the network (recommended) | Run a Nwaku Node |
| nwaku-compose | Pre-configured Docker Compose setup for running a RLN-enabled nwaku node with Grafana metrics dashboard |
Run Nwaku with Docker Compose |
| go-waku | Golang-based Waku implementation to run a standalone node and access the network | COMING SOON |
Integrate using SDKs
Waku is implemented in multiple SDKs, allowing it to integrate with different languages and address various use cases efficiently.
| Description | Documentation | |
|---|---|---|
| @waku/sdk | JavaScript/TypeScript SDK designed for browser environments | JavaScript Waku SDK |
| @waku/react | React components and UI adapters designed for seamless integration with @waku/sdk |
Build React DApps Using @waku/react |
| nwaku | Nim SDK designed for integration with native Nim applications | COMING SOON |
| go-waku | Golang SDK designed for integration with Golang applications, includes C bindings for usage in C/C++, C#/Unity, Swift, and Kotlin | COMING SOON |
| waku-rust-bindings | Rust wrapper using go-waku bindings designed for integration in Rust applications |
COMING SOON |
Run on mobile devices
Waku provides integrations tailored for mobile applications, enabling Waku to run efficiently on mobile devices.
| Description | Documentation | |
|---|---|---|
| Swift (iOS) | go-waku bindings for Swift applications to seamlessly integrate Waku |
COMING SOON |
| Kotlin (Android) | go-waku bindings for Kotlin applications to seamlessly integrate Waku |
COMING SOON |
More integrations
| Description | Documentation | |
|---|---|---|
| REST API | REST API interface provided by nwaku and go-waku to interact with the Waku Network |
Waku Node REST API Reference |
| @waku/create-app | Starter kit to bootstrap your next @waku/sdk project from various example templates |
Scaffold DApps Using @waku/create-app |