add run nwaku outline
This commit is contained in:
LordGhostX
parent
a869aa1be1
commit
1973a5791b
|
|
@ -4,11 +4,11 @@ title: Contribute to Waku
|
|||
|
||||
Get involved in Waku's open-source initiatives to improve the protocols, SDKs, developer tools and examples, and documentation. You can contribute by:
|
||||
|
||||
- [Operating a node](/guides/sdks-and-nodes#operate-a-waku-node) within your application.
|
||||
- [Operating a node](/guides/nodes-and-sdks#operate-a-waku-node) within your application.
|
||||
- [Reporting bugs](#report-a-bug) and [suggesting missing features](#suggest-a-feature) to the development team.
|
||||
- Inspiring other developers to explore and use Waku for [various use cases](/overview/use-cases).
|
||||
|
||||
Begin your journey by visiting the [SDKs and Nodes](/guides/sdks-and-nodes) guide and start building on Waku today!
|
||||
Begin your journey by visiting the [Nodes and SDKs](/guides/nodes-and-sdks) guide and start building on Waku today!
|
||||
|
||||
## Report a Bug
|
||||
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
title: SDKs and Nodes
|
||||
title: Nodes and SDKs
|
||||
---
|
||||
|
||||
:::caution
|
||||
|
|
@ -10,7 +10,12 @@ Ready to integrate Waku into your application for private, secure, censorship-fr
|
|||
|
||||
## Operate a Waku Node
|
||||
|
||||
The Waku Network is permissionless and decentralized, consisting of nodes. It is open for anyone to run a node, use the network, and contribute to its support. Please visit the [nwaku guide](https://github.com/waku-org/nwaku/tree/master/docs/operators) (recommended) or [go-waku guide](https://github.com/waku-org/go-waku/tree/master/docs/operators) for operators to learn more.
|
||||
The Waku Network is a decentralized, permissionless system where anyone can run nodes, use the network, and contribute to its support.
|
||||
|
||||
| Client | Description | Documentation |
|
||||
| - | - | - |
|
||||
| [nwaku](https://github.com/waku-org/nwaku) | Nim-based Waku implementation to run a standalone node and access the network (recommended) | [Run 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 Go-Waku Node](https://github.com/waku-org/go-waku/tree/master/docs/operators) |
|
||||
|
||||
## Integrate Using SDKs
|
||||
|
||||
|
|
@ -19,7 +24,7 @@ Waku is implemented in multiple SDKs, allowing it to easily integrate with diffe
|
|||
| SDK | Description | Documentation |
|
||||
| - | - | - |
|
||||
| [js-waku](https://github.com/waku-org/js-waku) | JavaScript/TypeScript SDK designed for browser environments | |
|
||||
| [nwaku](https://github.com/waku-org/nwaku) | Nim SDK for running a standalone node and accessing the Waku Network | |
|
||||
| [nwaku](https://github.com/waku-org/nwaku) | Nim SDK designed for integration with native Nim applications | |
|
||||
| [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 | |
|
||||
|
||||
|
|
@ -0,0 +1,17 @@
|
|||
---
|
||||
title: Run Nwaku Node
|
||||
---
|
||||
|
||||
Nwaku (formerly `nim-waku`) is a lightweight and robust Nim client for running a Waku node, equipped with tools to monitor and maintain a running node. Nwaku is highly configurable, enabling operators to select the [protocols](/overview/concepts/protocols) they wish to support based on their needs, motivations, and available resources.
|
||||
|
||||
This guide provides detailed steps to build, configure, and connect a `nwaku` node to the Waku Network. It also covers using existing tools to monitor and maintain the node.
|
||||
|
||||
## Build the Node
|
||||
|
||||
## Configure the Node
|
||||
|
||||
## Connect the Node
|
||||
|
||||
## Interact with the Node
|
||||
|
||||
## Monitor the Node
|
||||
|
|
@ -12,7 +12,7 @@ Once a connection is established, the node must actively seek out additional pee
|
|||
|
||||
## Predefined Nodes
|
||||
|
||||
Waku applications have the flexibility to embed bootstrap node addresses directly into their codebase. Developers can opt to use either the [predefined nodes by Status](https://github.com/waku-org/js-waku/blob/master/packages/core/src/lib/predefined_bootstrap_nodes.ts#L45) or [operate a node](/guides/sdks-and-nodes#operate-a-waku-node) per their preference.
|
||||
Waku applications have the flexibility to embed bootstrap node addresses directly into their codebase. Developers can opt to use either the [predefined nodes by Status](https://github.com/waku-org/js-waku/blob/master/packages/core/src/lib/predefined_bootstrap_nodes.ts#L45) or [operate a node](/guides/nodes-and-sdks#operate-a-waku-node) per their preference.
|
||||
|
||||
#### Pros
|
||||
|
||||
|
|
|
|||
|
|
@ -98,7 +98,7 @@ Resource-limited refers to environments or devices restricting available resourc
|
|||
|
||||
RLN Relay is an extension of the [Relay protocol](#relay) that uses [Rate Limit Nullifiers (RLN)](#rate-limit-nullifiers) to prevent spam economically by enforcing a rate limit on messages over time, imposing penalties, and facilitating network removal for spammers.
|
||||
|
||||
### [SDK](/guides/sdks-and-nodes)
|
||||
### [SDK](/guides/nodes-and-sdks)
|
||||
|
||||
SDKs are tools, libraries, and resources to integrate Waku's private, secure, and censorship-free communication features into various applications.
|
||||
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@ Since Waku is built on top of libp2p, they share a lot of concepts and terminolo
|
|||
|
||||
## Waku as a Service Network
|
||||
|
||||
Waku intends to incentivize mechanisms to run nodes, but it's not part of libp2p's scope. Additionally, users or developers do not have to deploy their infra as a prerequisite to use Waku. It is a service network. However, you are encouraged to [operate a node](/guides/sdks-and-nodes#operate-a-waku-node) to support and decentralize the network.
|
||||
Waku intends to incentivize mechanisms to run nodes, but it's not part of libp2p's scope. Additionally, users or developers do not have to deploy their infra as a prerequisite to use Waku. It is a service network. However, you are encouraged to [operate a node](/guides/nodes-and-sdks#operate-a-waku-node) to support and decentralize the network.
|
||||
|
||||
## Waku as a Keyturn Solution
|
||||
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
title: Watch Our Presentations
|
||||
---
|
||||
|
||||
## Using ZKP for Better p2p Messaging With Waku
|
||||
## Using ZKP for Better p2p Messaging with Waku
|
||||
|
||||
<iframe class="yt-video" src="https://www.youtube.com/embed/eJwX1JpcKQk" title="Using ZKP for better p2p messaging with Waku by Oskar Thorén" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>
|
||||
|
||||
|
|
|
|||
|
|
@ -63,8 +63,12 @@ const config = {
|
|||
position: "right",
|
||||
items: [
|
||||
{
|
||||
label: "SDKs and Nodes",
|
||||
to: "/guides/sdks-and-nodes"
|
||||
label: "Nodes and SDKs",
|
||||
to: "/guides/nodes-and-sdks"
|
||||
},
|
||||
{
|
||||
label: "Run Nwaku Node",
|
||||
to: "guides/run-nwaku-node"
|
||||
}
|
||||
]
|
||||
},
|
||||
|
|
@ -110,8 +114,12 @@ const config = {
|
|||
title: "Guides",
|
||||
items: [
|
||||
{
|
||||
to: "/guides/sdks-and-nodes",
|
||||
label: "SDKs and Nodes"
|
||||
to: "/guides/nodes-and-sdks",
|
||||
label: "Nodes and SDKs"
|
||||
},
|
||||
{
|
||||
label: "Run Nwaku Node",
|
||||
to: "guides/run-nwaku-node"
|
||||
}
|
||||
]
|
||||
},
|
||||
|
|
|
|||
|
|
@ -14,7 +14,7 @@ const sidebars = {
|
|||
"overview/use-cases",
|
||||
{
|
||||
type: "html",
|
||||
value: "<a href='/guides/sdks-and-nodes' target='_blank' rel='noopener noreferrer' class='menu__link external-link'>SDKs and Nodes <svg width='13.5' height='13.5' viewBox='0 0 24 24'><path fill='currentColor' d='M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z'></path></svg></a>"
|
||||
value: "<a href='/guides/nodes-and-sdks' target='_blank' rel='noopener noreferrer' class='menu__link external-link'>Nodes and SDKs <svg width='13.5' height='13.5' viewBox='0 0 24 24'><path fill='currentColor' d='M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z'></path></svg></a>"
|
||||
},
|
||||
{
|
||||
type: "html",
|
||||
|
|
@ -51,7 +51,8 @@ const sidebars = {
|
|||
label: "Guides",
|
||||
collapsible: false,
|
||||
items: [
|
||||
"guides/sdks-and-nodes"
|
||||
"guides/nodes-and-sdks",
|
||||
"guides/run-nwaku-node"
|
||||
]
|
||||
}
|
||||
],
|
||||
|
|
|
|||
Loading…
Reference in New Issue