Skip to content

Commit ff5464b

Browse files
LordGhostXLordGhostX
authored
add general FAQ (#189)
1 parent d54c569 commit ff5464b

File tree

6 files changed

+150
-107
lines changed

6 files changed

+150
-107
lines changed

‎diagrams/_protocol-interaction.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -20,11 +20,11 @@ sequenceDiagram
2020
D ->> E: HistoryResponse(msg1, ...) (6)
2121
```
2222

23-
The Pub/Sub topic `pubtopic1` serves as a means of routing messages (the network employs a default Pub/Sub topic) and indicates that it is subscribed to messages on that topic for a relay. Node D serves as a `Store` and is responsible for persisting messages.
23+
The Pub/Sub topic `pubtopic1` serves as a means of routing messages (the network employs a default Pub/Sub topic) and indicates that it is subscribed to messages on that topic for a relay. Node D serves as a `Store` and is responsible for storing messages.
2424

2525
1. Node A creates a WakuMessage `msg1` with [Content Topic](/learn/concepts/content-topics) `contentTopic1`.
2626
2. Node F requests to get messages filtered by Pub/Sub topic `pubtopic1` and Content Topic `contentTopic1`. Node D subscribes F to this filter and will forward messages that match that filter in the future.
2727
3. Node A publishes `msg1` on `pubtopic1`. The message is sent from Node A to Node B and then forwarded to Node D.
2828
4. Node D, upon receiving `msg1`, stores the message for future retrieval by other nodes and forwards it to Node C.
2929
5. Node D also pushes `msg1` to Node F, informing it about the arrival of a new message.
30-
6. At a later time, Node E comes online and requests messages matching `pubtopic1` and `contentTopic1` from Node D. Node D responds with `msg1` and potentially other messages that match the query.
30+
6. At a later time, Node E comes online and requests messages matching `pubtopic1` and `contentTopic1` from Node D. Node D responds with `msg1` and potentially other messages that match the query.

‎docs/guides/js-waku/faq.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ import { AccordionItem } from '@site/src/components/mdx'
1818
Check out the <a href="/guides/js-waku/store-retrieve-messages">Retrieve Messages Using Store Protocol</a> guide to learn how to retrieve and filter historical messages using the <a href="/learn/concepts/protocols#store">Store protocol</a>.
1919
</AccordionItem>
2020

21-
<AccordionItem title="How can I prevent Store peers from persisting my messages?">
21+
<AccordionItem title="How can I prevent Store peers from storing my messages?">
2222
When <a href="/guides/js-waku/light-send-receive#choose-a-content-topic">creating your message encoder</a>, you can configure the <strong>ephemeral</strong> option to prevent Store peers from keeping your messages on the Waku Network.
2323
</AccordionItem>
2424

@@ -48,4 +48,4 @@ import { AccordionItem } from '@site/src/components/mdx'
4848

4949
<AccordionItem title="How can I send images and videos on the Waku Network?">
5050
While it's possible to transmit media such as images as bytes on Waku, we recommend uploading your media to a CDN or a file system like <a href="https://ipfs.tech/">IPFS</a> and then sharing the corresponding URL via Waku.
51-
</AccordionItem>
51+
</AccordionItem>

‎docs/guides/nwaku/configure-nwaku.md

+8-7
Original file line numberDiff line numberDiff line change
@@ -43,12 +43,12 @@ You can use the domain name provided by your cloud provider to configure the dom
4343
To enable message caching and serve them to network peers, enable the [Store protocol](/learn/concepts/protocols#store) using the following configuration options:
4444

4545
- `store`: Enables storing messages to serve them to peers (disabled by default).
46-
- `store-message-retention-policy`: Retention policy of the store node (how long messages will be persisted). Three different retention policies are supported:
47-
- Time retention policy: `time:<duration-in-seconds>` (e.g., `time:14400`)
48-
- Capacity retention policy: `capacity:<messages-count>` (e.g, `capacity:25000`)
46+
- `store-message-retention-policy`: Retention policy of the store node (how long messages will be stored). Three different retention policies are supported:
47+
- Time retention policy: `time:<duration-in-seconds>` (e.g., `time:14400`)
48+
- Capacity retention policy: `capacity:<messages-count>` (e.g, `capacity:25000`)
4949
- Size retention policy: `size:<storage-in-MB/GB>` (e.g, `size:512MB` or `size:10GB`)
50-
- Set this option to `none` to disable the retention policy. If you omit this option, it will default to `time:172800` (48 hours).
51-
- `store-message-db-url`: Database connection URL for persisting messages in the [SQLAlchemy database URL format](https://docs.sqlalchemy.org/en/20/core/engines.html#database-urls). Setting this option to an empty string will instruct the node to use the fallback in-memory message store. If you omit this option, it will default to `sqlite://store.sqlite3`.
50+
- Set this option to `none` to disable the retention policy. If you omit this option, it will default to `time:172800` (48 hours).
51+
- `store-message-db-url`: Database connection URL for storing messages in the [SQLAlchemy database URL format](https://docs.sqlalchemy.org/en/20/core/engines.html#database-urls). Setting this option to an empty string will instruct the node to use the fallback in-memory message store. If you omit this option, it will default to `sqlite://store.sqlite3`.
5252

5353
```shell
5454
./build/wakunode2 \
@@ -72,7 +72,7 @@ You can configure `nwaku` as a `Store client` using the `storenode` option. This
7272
./build/wakunode2 --storenode=[STORE PEER MULTIADDR]
7373
```
7474

75-
For example, consider a `nwaku` node that does not persist messages but can query peers for historical messages:
75+
For example, consider a `nwaku` node that does not store messages but can query peers for historical messages:
7676

7777
```shell
7878
./build/wakunode2 --storenode=/dns4/node-01.ac-cn-hongkong-c.waku.sandbox.status.im/tcp/30303/p2p/16Uiu2HAmSJvSJphxRdbnigUV5bjRRZFBhTtWFTSyiKaQByCjwmpV
@@ -157,6 +157,7 @@ You can use [Let's Encrypt](https://letsencrypt.org/) or [Certbot](https://certb
157157
```shell
158158
sudo certbot certonly -d <your.domain.name>
159159
```
160+
160161
:::
161162

162163
## Configure REST API server
@@ -166,7 +167,7 @@ Nwaku provides a [REST API](https://waku-org.github.io/waku-rest-api/) to intera
166167
- `rest`: Enables the REST API server on the node (disabled by default).
167168
- `rest-address` (optional): Listening address of the REST API server. If you omit this option, it will default to `127.0.0.1`.
168169
- `rest-port` (optional): Listening port of the REST API server. If you omit this option, it will default to `8645`.
169-
- `rest-relay-cache-capacity` (optional): Capacity of the Relay REST API message cache. If you omit this option, it will default to `30`.
170+
- `rest-relay-cache-capacity` (optional): Capacity of the Relay REST API message cache. If you omit this option, it will default to `30`.
170171
- `rest-admin` (optional): Enables access to REST admin API (disabled by default).
171172
- `rest-private` (optional): Enables access to REST private API (disabled by default).
172173

‎docs/learn/concepts/protocols.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -45,4 +45,4 @@ While the `Light Push` protocol acknowledges the receipt by the remote peer, it
4545
- `payload` attribute containing the message data payload to be sent.
4646
- `meta` attribute for conveying additional details to various protocols for application-specific processing.
4747
- `timestamp` attribute signifying the time at which the message was generated by its sender.
48-
- `ephemeral` attribute specifying whether the network should not persist the message.
48+
- `ephemeral` attribute specifying whether the network should not store the message.

‎docs/learn/faq.md

+35
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
---
2+
title: Waku FAQ
3+
hide_table_of_contents: true
4+
sidebar_label: Frequently Asked Questions
5+
---
6+
7+
import { AccordionItem } from '@site/src/components/mdx'
8+
9+
<AccordionItem title="How can I start building my application using Waku?">
10+
Check out the <a href="/">Getting Started</a> guide to explore our numerous SDKs and learn how to run a Waku node.
11+
</AccordionItem>
12+
13+
<AccordionItem title="Does messaging on Waku require a gas fee?">
14+
No, sending and receiving messages on Waku involves no gas fee.
15+
</AccordionItem>
16+
17+
<AccordionItem title="What encryption does Waku use?">
18+
Waku uses libp2p noise encryption for node-to-node connections. However, no default encryption method is applied to the data sent over the network. This design choice enhances Waku's encryption flexibility, encouraging developers to use custom protocols or Waku message payload encryption methods freely.
19+
</AccordionItem>
20+
21+
<AccordionItem title="Where does Waku store the messages?">
22+
Waku's <a href="/learn/concepts/protocols#store">Store protocol</a> is designed to temporarily store messages within the network. However, Waku does not guarantee the message's availability and recommends using <a href="https://codex.storage/">Codex</a> for long-term storage.
23+
</AccordionItem>
24+
25+
<AccordionItem title="Can Waku only be used for wallet-to-wallet messaging?">
26+
No, Waku is flexible and imposes no specific rules on identifiers.
27+
</AccordionItem>
28+
29+
<AccordionItem title="How does Waku differ from IPFS?">
30+
Waku focuses on short, ephemeral, real-time time messages, while IPFS focuses on large, long-term data storage. Although there's an overlap between the two technologies, Waku does not currently support large data for privacy reasons.
31+
</AccordionItem>
32+
33+
<AccordionItem title="What are Rate Limiting Nullifiers (RLN)?">
34+
<a href="/learn/concepts/protocols#rln-relay">Rate Limiting Nullifier</a> is a zero-knowledge (ZK) protocol enabling spam protection in a decentralized network while preserving privacy. Each message must be accompanied by a ZK proof, which <a href="/learn/concepts/protocols#relay">Relay</a> nodes verify to ensure the publishers do not send more messages than they are allowed. The ZK proof does not leak any private information about message publishers - it only proves they are members of a set of users allowed to publish a certain number of messages per given time frame.
35+
</AccordionItem>

‎sidebars.js

+102-95
Original file line numberDiff line numberDiff line change
@@ -2,101 +2,108 @@
22

33
/** @type {import("@docusaurus/plugin-content-docs").SidebarsConfig} */
44
const sidebars = {
5-
guides: [
6-
"guides/getting-started",
7-
{
8-
type: "category",
9-
label: "Run a Nwaku Node",
10-
link: {
11-
type: "doc",
12-
id: "guides/nwaku/run-node",
13-
},
14-
items: [
15-
"guides/nwaku/run-docker-compose",
16-
"guides/nwaku/run-docker",
17-
"guides/nwaku/build-source",
18-
"guides/nwaku/configure-discovery",
19-
"guides/nwaku/config-methods",
20-
"guides/nwaku/config-options",
21-
"guides/nwaku/configure-nwaku",
22-
"guides/nwaku/faq",
23-
{
24-
type: 'html',
25-
value: '<a href="https://waku-org.github.io/waku-rest-api/" target="_blank" rel="noopener noreferrer" class="menu__link external-link">REST API Reference<svg width="16" height="16" viewBox="0 0 16 16" fill="none" xmlns="http://www.w3.org/2000/svg"><path fill-rule="evenodd" clip-rule="evenodd" d="M11.1918 4H3.42848V2.85715H13.1428V12.5714H11.9999V4.80813L3.83254 12.9755L3.02441 12.1674L11.1918 4Z" fill="white"/></svg>',
26-
},
27-
]
28-
},
29-
{
30-
type: "category",
31-
label: "JavaScript Waku SDK",
32-
link: {
33-
type: "doc",
34-
id: "guides/js-waku/index",
35-
},
36-
items: [
37-
"guides/js-waku/light-send-receive",
38-
"guides/js-waku/store-retrieve-messages",
39-
"guides/js-waku/message-encryption",
40-
"guides/js-waku/use-waku-react",
41-
"guides/js-waku/use-waku-create-app",
42-
"guides/js-waku/configure-discovery",
43-
"guides/js-waku/run-waku-nodejs",
44-
"guides/js-waku/debug-waku-dapp",
45-
"guides/js-waku/manage-filter",
46-
"guides/js-waku/faq",
47-
{
48-
type: 'html',
49-
value: '<a href="https://examples.waku.org" target="_blank" rel="noopener noreferrer" class="menu__link external-link">@waku/sdk Examples<svg width="16" height="16" viewBox="0 0 16 16" fill="none" xmlns="http://www.w3.org/2000/svg"><path fill-rule="evenodd" clip-rule="evenodd" d="M11.1918 4H3.42848V2.85715H13.1428V12.5714H11.9999V4.80813L3.83254 12.9755L3.02441 12.1674L11.1918 4Z" fill="white"/></svg>',
50-
},
51-
{
52-
type: 'html',
53-
value: '<a href="https://js.waku.org" target="_blank" rel="noopener noreferrer" class="menu__link external-link">API Reference<svg width="16" height="16" viewBox="0 0 16 16" fill="none" xmlns="http://www.w3.org/2000/svg"><path fill-rule="evenodd" clip-rule="evenodd" d="M11.1918 4H3.42848V2.85715H13.1428V12.5714H11.9999V4.80813L3.83254 12.9755L3.02441 12.1674L11.1918 4Z" fill="white"/></svg>',
54-
},
55-
]
56-
},
57-
],
58-
learn: [
59-
"learn/waku-network",
60-
{
61-
type: "category",
62-
label: "Concepts",
63-
collapsed: false,
64-
items: [
65-
"learn/concepts/protocols",
66-
"learn/concepts/content-topics",
67-
"learn/concepts/network-domains",
68-
"learn/concepts/transports",
69-
{
70-
type: "category",
71-
label: "Peer Discovery",
72-
link: {
73-
type: "doc",
74-
id: "learn/concepts/peer-discovery",
75-
},
76-
items: [
77-
"learn/concepts/static-peers",
78-
"learn/concepts/dns-discovery",
79-
"learn/concepts/discv5",
80-
"learn/concepts/peer-exchange",
81-
]
82-
},
83-
]
84-
},
85-
"learn/security-features",
86-
"learn/research",
87-
"learn/waku-vs-libp2p",
88-
"learn/glossary",
89-
{
90-
type: 'html',
91-
value: '<a href="https://ideas.waku.org" target="_blank" rel="noopener noreferrer" class="menu__link external-link">Waku Idea Board<svg width="16" height="16" viewBox="0 0 16 16" fill="none" xmlns="http://www.w3.org/2000/svg"><path fill-rule="evenodd" clip-rule="evenodd" d="M11.1918 4H3.42848V2.85715H13.1428V12.5714H11.9999V4.80813L3.83254 12.9755L3.02441 12.1674L11.1918 4Z" fill="white"/></svg>',
92-
},
93-
],
94-
research: [
95-
{
96-
type: 'autogenerated',
97-
dirName: 'research', // '.' means the current docs folder
98-
},
99-
],
5+
guides: [
6+
"guides/getting-started",
7+
{
8+
type: "category",
9+
label: "Run a Nwaku Node",
10+
collapsed: false,
11+
link: {
12+
type: "doc",
13+
id: "guides/nwaku/run-node",
14+
},
15+
items: [
16+
"guides/nwaku/run-docker-compose",
17+
"guides/nwaku/run-docker",
18+
"guides/nwaku/build-source",
19+
"guides/nwaku/configure-discovery",
20+
"guides/nwaku/config-methods",
21+
"guides/nwaku/config-options",
22+
"guides/nwaku/configure-nwaku",
23+
"guides/nwaku/faq",
24+
{
25+
type: "html",
26+
value:
27+
'<a href="https://waku-org.github.io/waku-rest-api/" target="_blank" rel="noopener noreferrer" class="menu__link external-link">REST API Reference<svg width="16" height="16" viewBox="0 0 16 16" fill="none" xmlns="http://www.w3.org/2000/svg"><path fill-rule="evenodd" clip-rule="evenodd" d="M11.1918 4H3.42848V2.85715H13.1428V12.5714H11.9999V4.80813L3.83254 12.9755L3.02441 12.1674L11.1918 4Z" fill="white"/></svg>',
28+
},
29+
],
30+
},
31+
{
32+
type: "category",
33+
label: "JavaScript Waku SDK",
34+
collapsed: false,
35+
link: {
36+
type: "doc",
37+
id: "guides/js-waku/index",
38+
},
39+
items: [
40+
"guides/js-waku/light-send-receive",
41+
"guides/js-waku/store-retrieve-messages",
42+
"guides/js-waku/message-encryption",
43+
"guides/js-waku/use-waku-react",
44+
"guides/js-waku/use-waku-create-app",
45+
"guides/js-waku/configure-discovery",
46+
"guides/js-waku/run-waku-nodejs",
47+
"guides/js-waku/debug-waku-dapp",
48+
"guides/js-waku/manage-filter",
49+
"guides/js-waku/faq",
50+
{
51+
type: "html",
52+
value:
53+
'<a href="https://examples.waku.org" target="_blank" rel="noopener noreferrer" class="menu__link external-link">@waku/sdk Examples<svg width="16" height="16" viewBox="0 0 16 16" fill="none" xmlns="http://www.w3.org/2000/svg"><path fill-rule="evenodd" clip-rule="evenodd" d="M11.1918 4H3.42848V2.85715H13.1428V12.5714H11.9999V4.80813L3.83254 12.9755L3.02441 12.1674L11.1918 4Z" fill="white"/></svg>',
54+
},
55+
{
56+
type: "html",
57+
value:
58+
'<a href="https://js.waku.org" target="_blank" rel="noopener noreferrer" class="menu__link external-link">API Reference<svg width="16" height="16" viewBox="0 0 16 16" fill="none" xmlns="http://www.w3.org/2000/svg"><path fill-rule="evenodd" clip-rule="evenodd" d="M11.1918 4H3.42848V2.85715H13.1428V12.5714H11.9999V4.80813L3.83254 12.9755L3.02441 12.1674L11.1918 4Z" fill="white"/></svg>',
59+
},
60+
],
61+
},
62+
],
63+
learn: [
64+
"learn/waku-network",
65+
{
66+
type: "category",
67+
label: "Concepts",
68+
collapsed: false,
69+
items: [
70+
"learn/concepts/protocols",
71+
"learn/concepts/content-topics",
72+
"learn/concepts/network-domains",
73+
"learn/concepts/transports",
74+
{
75+
type: "category",
76+
label: "Peer Discovery",
77+
link: {
78+
type: "doc",
79+
id: "learn/concepts/peer-discovery",
80+
},
81+
items: [
82+
"learn/concepts/static-peers",
83+
"learn/concepts/dns-discovery",
84+
"learn/concepts/discv5",
85+
"learn/concepts/peer-exchange",
86+
],
87+
},
88+
],
89+
},
90+
"learn/security-features",
91+
"learn/research",
92+
"learn/waku-vs-libp2p",
93+
"learn/glossary",
94+
"learn/faq",
95+
{
96+
type: "html",
97+
value:
98+
'<a href="https://ideas.waku.org" target="_blank" rel="noopener noreferrer" class="menu__link external-link">Waku Idea Board<svg width="16" height="16" viewBox="0 0 16 16" fill="none" xmlns="http://www.w3.org/2000/svg"><path fill-rule="evenodd" clip-rule="evenodd" d="M11.1918 4H3.42848V2.85715H13.1428V12.5714H11.9999V4.80813L3.83254 12.9755L3.02441 12.1674L11.1918 4Z" fill="white"/></svg>',
99+
},
100+
],
101+
research: [
102+
{
103+
type: "autogenerated",
104+
dirName: "research", // '.' means the current docs folder
105+
},
106+
],
100107
};
101108

102109
module.exports = sidebars;

0 commit comments

Comments
 (0)