mirror of
https://github.com/logos-messaging/docs.waku.org.git
synced 2026-01-05 22:33:06 +00:00
Merge pull request #77 from waku-org/docs-improvements
Docs improvements
This commit is contained in:
LordGhostX
GitHub
commit
d5706faada
@ -98,7 +98,7 @@ To learn more about running nwaku, please refer to:
|
||||
|
||||
## Run Test Suite
|
||||
|
||||
Run the tests for both `Waku v1` and `Waku v2`:
|
||||
Run the tests for Waku:
|
||||
|
||||
```bash
|
||||
make test
|
||||
|
||||
@ -41,14 +41,18 @@ To enable [DNS Discovery](/overview/concepts/dns-discovery) in a `nwaku` node, u
|
||||
--dns-discovery-name-server:[DNS NAME SERVER IP]
|
||||
```
|
||||
|
||||
For instance, consider a `nwaku` node that enables `DNS Discovery`, connects to a DNS node list, and queries the IPs `1.1.1.1` and `1.0.0.1`:
|
||||
:::info
|
||||
If you omit the `dns-discovery-name-server` option, `nwaku` will attempt to use the CloudFlare servers `1.1.1.1` and `1.0.0.1`.
|
||||
:::
|
||||
|
||||
For instance, consider a `nwaku` node that enables `DNS Discovery`, connects to a DNS node list, and queries the IPs `8.8.8.8` and `8.8.4.4`:
|
||||
|
||||
```bash
|
||||
./build/wakunode2 \
|
||||
--dns-discovery:true \
|
||||
--dns-discovery-url:enrtree://AOGECG2SPND25EEFMAJ5WF3KSGJNSGV356DSTL2YVLLZWIV6SAYBM@test.waku.nodes.status.im \
|
||||
--dns-discovery-name-server:1.1.1.1 \
|
||||
--dns-discovery-name-server:1.0.0.1
|
||||
--dns-discovery-name-server:8.8.8.8 \
|
||||
--dns-discovery-name-server:8.8.4.4
|
||||
```
|
||||
|
||||
## Configure Discv5
|
||||
@ -65,7 +69,7 @@ To enable [Discv5](/overview/concepts/discv5) in a `nwaku` node, use the followi
|
||||
--discv5-bootstrap-node:[DISCV5 ENR BOOTSTRAP ENTRY 2]
|
||||
```
|
||||
|
||||
For instance, consider a `nwaku` node that enables `Discv5` and bootstraps it's routing table using a static `ENR`:
|
||||
For instance, consider a `nwaku` node that enables `Discv5` and bootstraps its routing table using a static `ENR`:
|
||||
|
||||
```bash
|
||||
./build/wakunode2 \
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
title: Run Nwaku in a Docker Container
|
||||
---
|
||||
|
||||
This guide provides detailed steps to build and run a `nwaku` node in a Docker container. If you prefer a pre-configured setup that includes a monitoring dashboard, see the [Run Nwaku with Docker Compose](/guides/nwaku/run-docker-compose) guide.
|
||||
This guide provides detailed steps to build and run a `nwaku` node in a Docker container. If you prefer a pre-configured setup with a monitoring dashboard, see the [Run Nwaku with Docker Compose](/guides/nwaku/run-docker-compose) guide.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
@ -51,12 +51,12 @@ docker run -i -t -p 60000:60000 -p 9000:9000/udp statusteam/nim-waku \
|
||||
--nat:extip:[YOUR PUBLIC IP] # or, if you are behind a nat: --nat=any
|
||||
```
|
||||
|
||||
:::tip
|
||||
To find your public IP, use:
|
||||
|
||||
```bash
|
||||
dig TXT +short o-o.myaddr.l.google.com @ns1.google.com | awk -F'"' '{ print $2}'
|
||||
```
|
||||
|
||||
:::tip
|
||||
We recommend using explicit port mappings (`-p`) when exposing ports accessible from outside the host (listening and discovery ports, API servers).
|
||||
:::
|
||||
@ -6,7 +6,7 @@ Nwaku is a lightweight and robust Nim client for running a Waku node, equipped w
|
||||
|
||||
This guide provides detailed steps to download, build, configure, and connect a `nwaku` node to the Waku Network. It also includes interacting with the node and finding its addresses.
|
||||
|
||||
## Get the Binary
|
||||
## Get the Node Binary
|
||||
|
||||
To run a node, you must have the `nwaku` binary. Nwaku provides multiple options for acquiring the node binary:
|
||||
|
||||
@ -21,7 +21,7 @@ To run a node, you must have the `nwaku` binary. Nwaku provides multiple options
|
||||
|
||||
You can build the node binary directly from the [nwaku source code](https://github.com/waku-org/nwaku). To learn more, please refer to the [Build Nwaku from Source](/guides/nwaku/build-source) guide.
|
||||
|
||||
#### Run the Binary in Docker
|
||||
#### Run Nwaku in Docker
|
||||
|
||||
| | Description | Documentation |
|
||||
| - | - | - |
|
||||
@ -105,7 +105,7 @@ curl --location --request GET 'http://localhost:8545' \
|
||||
</Tabs>
|
||||
|
||||
:::info
|
||||
The `listenAddresses` field stores the node's listening address(es), while the `enrUri` field stores the discoverable `ENR` URI for peer discovery.
|
||||
The `listenAddresses` field stores the node's listening addresses, while the `enrUri` field stores the discoverable `ENR` URI for peer discovery.
|
||||
:::
|
||||
|
||||
## Find the Node Addresses
|
||||
|
||||
@ -4,7 +4,7 @@ title: Content Topics
|
||||
|
||||
`Content Topics` are metadata strings set by developers on outgoing messages to facilitate protocol-level features like selectively processing incoming messages ([Relay](/overview/concepts/protocols#relay) or [Filter](/overview/concepts/protocols#filter)) and retrieving historical messages ([Store](/overview/concepts/protocols#store)) that meet specific filtering criteria. Please refer to the [WAKU2-TOPICS](https://rfc.vac.dev/spec/23/#content-topics) specification to learn more.
|
||||
|
||||
## Content Topic Format
|
||||
## Naming Format
|
||||
|
||||
Here is the recommended format for content topics:
|
||||
|
||||
|
||||
@ -38,7 +38,7 @@ While the `Light Push` protocol acknowledges the receipt by the remote peer, it
|
||||
|
||||
## [Waku Message](https://rfc.vac.dev/spec/14)
|
||||
|
||||
`Waku Message` specifies the message structure used in the Waku Network. It defines the attributes and metadata fields that accompany a message, including the following:
|
||||
`Waku Message` specifies the structure and format of messages in the Waku Network. It includes the following attributes:
|
||||
|
||||
- `content_topic` attribute for [content-based filtering](/overview/concepts/content-topics).
|
||||
- `payload` attribute containing the message data payload to be sent.
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
---
|
||||
title: What is Waku?
|
||||
title: Introduction to Waku
|
||||
slug: /
|
||||
---
|
||||
|
||||
|
||||
@ -28,7 +28,7 @@ DNS discovery is a [peer discovery](#peer-discovery) mechanism that allows the r
|
||||
|
||||
### [ENR](https://rfc.vac.dev/spec/31/)
|
||||
|
||||
Ethereum Node Record (ENR) is a specification used to represent and identify [nodes](#node), facilitating [discovery](#peer-discovery) and communication within the network. Besides connection details, `Waku ENR` also includes node configuration information like enabled protocol and shards.
|
||||
Ethereum Node Record (ENR) is a specification used to represent and identify [nodes](#node), facilitating [discovery](#peer-discovery) and communication within the network. Besides connection details, `ENR` also includes node configuration information like enabled protocol and shards.
|
||||
|
||||
### [Filter](/overview/concepts/protocols#filter)
|
||||
|
||||
|
||||
@ -2,16 +2,16 @@
|
||||
title: Why Waku?
|
||||
---
|
||||
|
||||
Communication in the present day is heavily influenced by third-party intervention, ranging from censorship and deplatforming to intermediaries that seek to profit from rent and the misuse of data in the surveillance economy.
|
||||
Present-day communication is predominantly centralized, enabling significant third-party intervention, with profit motives overshadowing principles and downplaying censorship and privacy concerns. This shift leads to the exploitation and unauthorized use of user data in the surveillance economy, where data ownership is no longer in the hands of individuals.
|
||||
|
||||
Waku is intended to empower individuals by returning control of communication to them. It is the go-to standard for Web3 communication, offering a scalable decentralized communication solution.
|
||||
Waku empowers individuals by restoring control of communication and data to them. Waku stands as the standard for Web3 communication, providing a scalable and decentralized solution.
|
||||
|
||||
- Waku improves upon Whisper's capabilities by overcoming limitations and addressing functional gaps.
|
||||
- It provides a public infrastructure for the Ethereum and multi-chain ecosystem, serving as a common good.
|
||||
- It is not confined to a particular blockchain.
|
||||
- It is modular, adaptable, and can cater to various use cases.
|
||||
- It allows developers to decentralize communication in their dApps or move actions off-chain while maintaining decentralization.
|
||||
- It can run on various platforms, including mobile devices, cloud environments, web browsers, desktop apps, or even a [Dappnode](https://dappnode.com/)!
|
||||
- Provides a public infrastructure for the Ethereum and multi-chain ecosystem, serving as a common good.
|
||||
- Waku is not confined to a particular blockchain.
|
||||
- Modular, adaptable, configurable, and can cater to various use cases.
|
||||
- Enables developers to decentralize communication in their dApps or move actions off-chain while maintaining decentralization.
|
||||
- Designed to run on various platforms, including mobile devices, cloud environments, web browsers, desktop apps, or even a [Dappnode](https://dappnode.com/)!
|
||||
|
||||
## Why Waku is Necessary
|
||||
|
||||
|
||||
@ -32,13 +32,6 @@ import { PoweredBy } from "@site/src/components/mdx";
|
||||
logoSrcDark: "/img/the-graph-mark-white.svg",
|
||||
link: "https://thegraph.com/",
|
||||
},
|
||||
{
|
||||
name: "XMTP",
|
||||
description:
|
||||
"Inter-blockchain account messaging protocol XMTP uses Waku to facilitate communication between nodes in its currently permissioned network.",
|
||||
logoSrc: "/img/xmtp-mark-black.svg",
|
||||
logoSrcDark: "/img/xmtp-mark-white.svg",
|
||||
link: "https://xmtp.org",
|
||||
},
|
||||
]}
|
||||
/>
|
||||
``
|
||||
@ -42,6 +42,7 @@ const sidebars = {
|
||||
{
|
||||
type: "category",
|
||||
label: "Reference",
|
||||
collapsed: false,
|
||||
items: [
|
||||
"overview/reference/glossary",
|
||||
"overview/reference/security-features",
|
||||
@ -69,6 +70,7 @@ const sidebars = {
|
||||
{
|
||||
type: "category",
|
||||
label: "Reference",
|
||||
collapsed: false,
|
||||
items: [
|
||||
"guides/reference/node-config-methods",
|
||||
"guides/reference/node-config-options",
|
||||
|
||||
@ -1,10 +0,0 @@
|
||||
<svg width="58" height="58" viewBox="0 0 58 58" fill="none" xmlns="http://www.w3.org/2000/svg">
|
||||
<g clip-path="url(#clip0_949_40203)">
|
||||
<path d="M2 29.5C2 14.3122 14.1486 2 29.1346 2C44.1109 2 55.6819 14.0833 56.0342 29.3809C56.0342 34.2619 54.3897 38.369 50.2785 42.238C46.8043 45.5077 40.8811 45.988 36.5353 43.5476C33.4334 41.7342 31.0428 37.8722 29.0171 35.0357L25.2582 40.869H17.1531L24.7884 29.3805L17.388 18.0714H25.7281L29.076 23.9048L32.3648 18.0714H40.7638L33.1285 29.3809C33.1285 29.3809 36.7699 35.0357 38.7668 37.2381C40.7638 39.4406 44.4052 39.5 46.7544 37.1191C49.3375 34.5012 49.9157 32.4168 49.9262 29.3809C49.9664 17.6303 40.7568 8.19047 29.1346 8.19047C17.5221 8.19047 8.10822 17.7311 8.10822 29.5C8.10822 41.2689 17.5221 50.8096 29.1346 50.8096C30.7409 50.8096 32.2803 50.6728 33.7745 50.3332L35.0667 56.3453C32.9406 56.8283 31.2229 57 29.1346 57C14.1486 57 2 44.6878 2 29.5Z" fill="black"/>
|
||||
</g>
|
||||
<defs>
|
||||
<clipPath id="clip0_949_40203">
|
||||
<rect width="58" height="58" fill="white"/>
|
||||
</clipPath>
|
||||
</defs>
|
||||
</svg>
|
||||
|
Before Width: | Height: | Size: 1.0 KiB |
@ -1,10 +0,0 @@
|
||||
<svg width="58" height="58" viewBox="0 0 58 58" fill="none" xmlns="http://www.w3.org/2000/svg">
|
||||
<g clip-path="url(#clip0_1029_16174)">
|
||||
<path d="M2 29.5C2 14.3122 14.1486 2 29.1346 2C44.1109 2 55.6819 14.0833 56.0342 29.3809C56.0342 34.2619 54.3897 38.369 50.2785 42.238C46.8043 45.5077 40.8811 45.988 36.5353 43.5476C33.4334 41.7342 31.0428 37.8722 29.0171 35.0357L25.2582 40.869H17.1531L24.7884 29.3805L17.388 18.0714H25.7281L29.076 23.9048L32.3648 18.0714H40.7638L33.1285 29.3809C33.1285 29.3809 36.7699 35.0357 38.7668 37.2381C40.7638 39.4406 44.4052 39.5 46.7544 37.1191C49.3375 34.5012 49.9157 32.4168 49.9262 29.3809C49.9664 17.6303 40.7568 8.19047 29.1346 8.19047C17.5221 8.19047 8.10822 17.7311 8.10822 29.5C8.10822 41.2689 17.5221 50.8096 29.1346 50.8096C30.7409 50.8096 32.2803 50.6728 33.7745 50.3332L35.0667 56.3453C32.9406 56.8283 31.2229 57 29.1346 57C14.1486 57 2 44.6878 2 29.5Z" fill="white"/>
|
||||
</g>
|
||||
<defs>
|
||||
<clipPath id="clip0_1029_16174">
|
||||
<rect width="58" height="58" fill="white"/>
|
||||
</clipPath>
|
||||
</defs>
|
||||
</svg>
|
||||
|
Before Width: | Height: | Size: 1.0 KiB |
Loading…
x
Reference in New Issue
Block a user