docs.waku.org/docs/guides/nodes-and-sdks.md

48 lines
3.1 KiB
Markdown
Raw Normal View History

2023-05-23 11:50:55 +00:00
---
2023-06-08 12:28:25 +00:00
title: Nodes and SDKs
2023-05-23 11:50:55 +00:00
---
:::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](/powered-by-waku). [Join our community](/community) to stay updated on our progress.
2023-05-23 11:50:55 +00:00
:::
2023-06-19 17:07:45 +00:00
Ready to integrate Waku into your application for private, secure, censorship-free communication? Explore the available SDKs and contribute by running a node.
2023-05-23 11:50:55 +00:00
2023-06-09 19:32:04 +00:00
## Run a Waku Node
2023-05-23 11:50:55 +00:00
2023-06-08 12:28:25 +00:00
The Waku Network is a decentralized, permissionless system where anyone can run nodes, use the network, and contribute to its support.
2023-06-09 19:32:04 +00:00
| | Description | Documentation |
2023-06-08 12:28:25 +00:00
| - | - | - |
2023-06-09 19:32:04 +00:00
| [nwaku](https://github.com/waku-org/nwaku) | Nim-based Waku implementation to run a standalone node and access the network (recommended) | [Run a Nwaku Node](/guides/run-nwaku-node) |
| [go-waku](https://github.com/waku-org/go-waku) | Golang-based Waku implementation to run a standalone node and access the network | [Run a Go-Waku Node](https://github.com/waku-org/go-waku/tree/master/docs/operators) |
2023-05-23 11:50:55 +00:00
2023-05-27 06:45:58 +00:00
## Integrate Using SDKs
2023-06-09 19:32:04 +00:00
Waku is implemented in multiple SDKs, allowing it to integrate with different languages and address various use cases efficiently.
2023-05-23 11:50:55 +00:00
2023-06-09 19:32:04 +00:00
| | Description | Documentation |
2023-05-23 11:50:55 +00:00
| - | - | - |
| [js-waku](https://github.com/waku-org/js-waku) | JavaScript/TypeScript SDK designed for browser environments | |
2023-06-08 12:28:25 +00:00
| [nwaku](https://github.com/waku-org/nwaku) | Nim SDK designed for integration with native Nim applications | |
2023-05-29 13:56:25 +00:00
| [go-waku](https://github.com/waku-org/go-waku) | Golang SDK designed for integration with Golang applications, includes C bindings for usage in C/C++, C#/Unity, Swift, and Kotlin | |
| [waku-rust-bindings](https://github.com/waku-org/waku-rust-bindings) | Rust wrapper using `go-waku` bindings designed for integration in Rust applications | |
2023-05-23 11:50:55 +00:00
2023-05-25 15:39:25 +00:00
## Run on Mobile Devices
2023-05-23 11:50:55 +00:00
2023-06-09 19:32:04 +00:00
Waku provides integrations tailored for mobile applications, enabling Waku to run efficiently on mobile devices.
2023-05-27 06:45:58 +00:00
2023-06-09 19:32:04 +00:00
| | Description | Documentation |
2023-05-23 11:50:55 +00:00
| - | - | - |
2023-05-25 15:39:25 +00:00
| [React Native](https://github.com/waku-org/waku-react-native) | React Native wrapper using `go-waku` bindings designed for native mobile integration | |
2023-05-27 06:45:58 +00:00
| Swift (iOS) | `go-waku` bindings for Swift applications to seamlessly integrate Waku | |
| Kotlin (Android) | `go-waku` bindings for Kotlin applications to seamlessly integrate Waku | |
2023-05-27 06:45:58 +00:00
## More Integrations
2023-06-09 19:32:04 +00:00
| | Description | Documentation |
| - | - | - |
2023-06-15 02:09:14 +00:00
| JSON-RPC API | `JSON-RPC` API interface provided by `nwaku` and `go-waku` to interact with the Waku Network | |
2023-05-30 13:48:15 +00:00
| [@waku/react](https://www.npmjs.com/package/@waku/react) | React components and UI adapters designed for seamless integration with `js-waku` | |
| [@waku/create-app](https://www.npmjs.com/package/@waku/create-app) | Starter kit to bootstrap your next `js-waku` project from various example templates | |
2023-06-15 02:09:14 +00:00
| [nwaku-compose](https://github.com/alrevuelta/nwaku-compose) | Pre-configured `docker-compose` setup for running and monitoring a `nwaku` node using Prometheus and Grafana. | [Run Nwaku with Docker Compose](/guides/nwaku/run-docker-compose) |