improve docs with feedback

This commit is contained in:
LordGhostX 2023-06-22 11:46:26 +01:00
parent 9cd9ee7cca
commit 52dc1b67ff
No known key found for this signature in database
GPG Key ID: 520CC5DC4F94FCC7
6 changed files with 18 additions and 14 deletions

View File

@ -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

View File

@ -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

View File

@ -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).
:::

View File

@ -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

View File

@ -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.

View File

@ -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