You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/build/javascript/configure-discovery.mdx
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -81,7 +81,7 @@ await Promise.all(promises);
81
81
```
82
82
83
83
:::tip
84
-
For local development using a `nwaku` node, use a `ws` address instead of `wss`. Remember that this setup is functional only when your web server is running locally. You can check how to get multi address of your locally run node in [Find node address](/guides/nwaku/find-node-address).
84
+
For local development using a `nwaku` node, use a `ws` address instead of `wss`. Remember that this setup is functional only when your web server is running locally. You can check how to get multi address of your locally run node in [Find node address](/run-node/find-node-address).
Copy file name to clipboardExpand all lines: docs/build/javascript/debug-waku-dapp.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@ hide_table_of_contents: true
4
4
displayed_sidebar: build
5
5
---
6
6
7
-
This guide provides detailed steps to enable and use debug logs to troubleshoot your Waku DApp, whether in a NodeJS or browser environment and check your WebSocket connections in [nwaku](/guides/nwaku/run-node).
7
+
This guide provides detailed steps to enable and use debug logs to troubleshoot your Waku DApp, whether in a NodeJS or browser environment and check your WebSocket connections in [nwaku](/run-node/).
8
8
9
9
## Enabling debug logs
10
10
@@ -46,7 +46,7 @@ To view debug logs in your browser's console, modify the local storage and add t
46
46
47
47
## Checking WebSocket setup
48
48
49
-
[Nwaku](/guides/nwaku/run-node) provides native support for WebSocket (`ws`) and WebSocket Secure (`wss`) protocols. These are the only [transports](/learn/concepts/transports) supported for connecting to the Waku Network via browsers.
49
+
[Nwaku](/run-node/) provides native support for WebSocket (`ws`) and WebSocket Secure (`wss`) protocols. These are the only [transports](/learn/concepts/transports) supported for connecting to the Waku Network via browsers.
50
50
51
51
It's important to note that browsers impose certain limitations on WebSocket usage:
Copy file name to clipboardExpand all lines: docs/build/javascript/faq.md
+11-11Lines changed: 11 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,49 +8,49 @@ displayed_sidebar: build
8
8
import { AccordionItem } from '@site/src/components/mdx'
9
9
10
10
<AccordionItemtitle="How do I install the @waku/sdk package in my project?">
11
-
You can add the JavaScript SDK to your project using NPM, Yarn, or a CDN. Check out the <a href="/guides/js-waku/#installation">installation guide</a> to get started.
11
+
You can add the JavaScript SDK to your project using NPM, Yarn, or a CDN. Check out the <a href="/build/javascript/#installation">installation guide</a> to get started.
12
12
</AccordionItem>
13
13
14
14
<AccordionItemtitle="Why should I use Protocol Buffers for my application's message structure when using Waku?">
15
-
Protocol Buffers ensure consistent formatting, interoperability, and backward compatibility for your application's messages, with a smaller payload size than JSON. Check out the <a href="/guides/js-waku/#message-structure">installation guide</a> and <a href="https://protobuf.dev/overview/">Protobuf documentation</a> to learn more.
15
+
Protocol Buffers ensure consistent formatting, interoperability, and backward compatibility for your application's messages, with a smaller payload size than JSON. Check out the <a href="/build/javascript/#message-structure">installation guide</a> and <a href="https://protobuf.dev/overview/">Protobuf documentation</a> to learn more.
16
16
</AccordionItem>
17
17
18
18
<AccordionItemtitle="What are the steps to retrieve historical messages on Waku?">
19
-
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>.
19
+
Check out the <a href="/build/javascript/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>.
20
20
</AccordionItem>
21
21
22
22
<AccordionItemtitle="How can I prevent Store peers from storing my messages?">
23
-
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.
23
+
When <a href="/build/javascript/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.
24
24
</AccordionItem>
25
25
26
26
<AccordionItemtitle="How can I encrypt, decrypt, and sign messages in my Waku application?">
27
-
You can encrypt and decrypt your messages using symmetric, ECIES, and noise encryption methods. Check out the <a href="/guides/js-waku/message-encryption">Encrypt, Decrypt, and Sign Your Messages</a> guide to get started.
27
+
You can encrypt and decrypt your messages using symmetric, ECIES, and noise encryption methods. Check out the <a href="/build/javascript/message-encryption">Encrypt, Decrypt, and Sign Your Messages</a> guide to get started.
28
28
</AccordionItem>
29
29
30
30
<AccordionItemtitle="How do I integrate Waku into a React application?">
31
-
Waku has a specialized SDK designed for building React applications. Check out the <a href="/guides/js-waku/use-waku-react">Build React DApps Using @waku/react</a> guide for instructions on installation and usage.
31
+
Waku has a specialized SDK designed for building React applications. Check out the <a href="/build/javascript/use-waku-react">Build React DApps Using @waku/react</a> guide for instructions on installation and usage.
32
32
</AccordionItem>
33
33
34
34
<AccordionItemtitle="How can I bootstrap and discover peers in the Waku Network for browser nodes?">
35
-
The JavaScript SDK has a <a href="/guides/js-waku/configure-discovery#default-bootstrap-method">default bootstrap method</a> that can be configured with <a href="/learn/concepts/static-peers">Static Peers</a> and <a href="/learn/concepts/dns-discovery">DNS Discovery</a>. Check out the <a href="/guides/js-waku/configure-discovery">Bootstrap Nodes and Discover Peers</a> guide for setting up peer discovery for your node.
35
+
The JavaScript SDK has a <a href="/build/javascript/configure-discovery#default-bootstrap-method">default bootstrap method</a> that can be configured with <a href="/learn/concepts/static-peers">Static Peers</a> and <a href="/learn/concepts/dns-discovery">DNS Discovery</a>. Check out the <a href="/build/javascript/configure-discovery">Bootstrap Nodes and Discover Peers</a> guide for setting up peer discovery for your node.
36
36
</AccordionItem>
37
37
38
38
<AccordionItemtitle="How can I integrate Waku into a NodeJS application?">
39
-
Though the JavaScript SDK isn't directly usable in NodeJS due to <a href="/guides/js-waku/run-waku-nodejs">certain limitations</a>, we recommend running <a href="/guides/nwaku/run-docker-compose">nwaku in a Docker container</a> and consuming its <a href="https://waku-org.github.io/waku-rest-api/">REST API</a> in a NodeJS application.
39
+
Though the JavaScript SDK isn't directly usable in NodeJS due to <a href="/build/javascript/run-waku-nodejs">certain limitations</a>, we recommend running <a href="/run-node/run-docker-compose">nwaku in a Docker container</a> and consuming its <a href="https://waku-org.github.io/waku-rest-api/">REST API</a> in a NodeJS application.
40
40
</AccordionItem>
41
41
42
42
<AccordionItemtitle="How can I debug my Waku DApp and check WebSocket connections?">
43
-
Check out the <a href="/guides/js-waku/debug-waku-dapp">Debug Your Waku DApp and WebSocket</a> guide to discover how to use debug logs to troubleshoot your Waku DApp and resolve connection issues with nwaku WebSockets.
43
+
Check out the <a href="/build/javascript/debug-waku-dapp">Debug Your Waku DApp and WebSocket</a> guide to discover how to use debug logs to troubleshoot your Waku DApp and resolve connection issues with nwaku WebSockets.
44
44
</AccordionItem>
45
45
46
46
<AccordionItemtitle="How can I manage unexpected disconnections of my Filter subscription from Waku?">
47
-
We recommend regularly pinging peers to check for an active connection and reinitiating the subscription when it disconnects. Check out the <a href="/guides/js-waku/manage-filter">Manage Your Filter Subscriptions</a> guide for a detailed explanation and step-by-step instructions.
47
+
We recommend regularly pinging peers to check for an active connection and reinitiating the subscription when it disconnects. Check out the <a href="/build/javascript/manage-filter">Manage Your Filter Subscriptions</a> guide for a detailed explanation and step-by-step instructions.
48
48
</AccordionItem>
49
49
50
50
<AccordionItemtitle="How can I send images and videos on the Waku Network?">
51
51
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.
52
52
</AccordionItem>
53
53
54
54
<AccordionItemtitle="How can I connect to my own node?">
55
-
To manually set your own node as a starting point use <a href="/guides/js-waku/configure-discovery#configure-static-peers">Configure static peers</a>.
55
+
To manually set your own node as a starting point use <a href="/build/javascript/configure-discovery#configure-static-peers">Configure static peers</a>.
|[Send and Receive Messages in a Reliable Channel](/guides/js-waku/reliable-channels)| Learn how to send and receive messages with a convenient SDK that provide various reliable functionalities out-of-the-box. |
100
-
|[Send and Receive Messages Using Light Push and Filter](/guides/js-waku/light-send-receive)| Learn how to send and receive messages on light nodes using the [Light Push](/learn/concepts/protocols#light-push) and [Filter](/learn/concepts/protocols#filter) protocols |
101
-
|[Retrieve Messages Using Store Protocol](/guides/js-waku/store-retrieve-messages)| Learn how to retrieve and filter historical messages on light nodes using the [Store protocol](/learn/concepts/protocols#store)|
102
-
|[Encrypt, Decrypt, and Sign Your Messages](/guides/js-waku/message-encryption)| Learn how to use the [@waku/message-encryption](https://www.npmjs.com/package/@waku/message-encryption) package to encrypt, decrypt, and sign your messages |
103
-
|[Build React DApps Using @waku/react](/guides/js-waku/use-waku-react)| Learn how to use the [@waku/react](https://www.npmjs.com/package/@waku/react) package seamlessly integrate `@waku/sdk` into a React application |
104
-
|[Scaffold DApps Using @waku/create-app](/guides/js-waku/use-waku-create-app)| Learn how to use the [@waku/create-app](https://www.npmjs.com/package/@waku/create-app) package to bootstrap your next `@waku/sdk` project from various example templates |
105
-
|[Bootstrap Nodes and Discover Peers](/guides/js-waku/configure-discovery)| Learn how to bootstrap your node using [Static Peers](/learn/concepts/static-peers) and discover peers using [DNS Discovery](/learn/concepts/dns-discovery)|
106
-
|[Run @waku/sdk in a NodeJS Application](/guides/js-waku/run-waku-nodejs)| Learn our suggested approach for using the `@waku/sdk` package within a NodeJS application |
107
-
|[Debug Your Waku DApp and WebSocket](/guides/js-waku/debug-waku-dapp)| Learn how to troubleshoot your Waku DApp using debug logs and check [WebSocket](/learn/concepts/transports) connections in [nwaku](/guides/nwaku/run-node)|
108
-
|[Manage Your Filter Subscriptions](/guides/js-waku/manage-filter)| Learn how to manage [filter subscriptions](/learn/concepts/protocols#filter) and handle node disconnections in your application |
|[Send and Receive Messages in a Reliable Channel](/build/javascript/reliable-channels)| Learn how to send and receive messages with a convenient SDK that provide various reliable functionalities out-of-the-box. |
100
+
|[Send and Receive Messages Using Light Push and Filter](/build/javascript/light-send-receive)| Learn how to send and receive messages on light nodes using the [Light Push](/learn/concepts/protocols#light-push) and [Filter](/learn/concepts/protocols#filter) protocols |
101
+
|[Retrieve Messages Using Store Protocol](/build/javascript/store-retrieve-messages)| Learn how to retrieve and filter historical messages on light nodes using the [Store protocol](/learn/concepts/protocols#store)|
102
+
|[Encrypt, Decrypt, and Sign Your Messages](/build/javascript/message-encryption)| Learn how to use the [@waku/message-encryption](https://www.npmjs.com/package/@waku/message-encryption) package to encrypt, decrypt, and sign your messages |
103
+
|[Build React DApps Using @waku/react](/build/javascript/use-waku-react)| Learn how to use the [@waku/react](https://www.npmjs.com/package/@waku/react) package seamlessly integrate `@waku/sdk` into a React application |
104
+
|[Scaffold DApps Using @waku/create-app](/build/javascript/use-waku-create-app)| Learn how to use the [@waku/create-app](https://www.npmjs.com/package/@waku/create-app) package to bootstrap your next `@waku/sdk` project from various example templates |
105
+
|[Bootstrap Nodes and Discover Peers](/build/javascript/configure-discovery)| Learn how to bootstrap your node using [Static Peers](/learn/concepts/static-peers) and discover peers using [DNS Discovery](/learn/concepts/dns-discovery)|
106
+
|[Run @waku/sdk in a NodeJS Application](/build/javascript/run-waku-nodejs)| Learn our suggested approach for using the `@waku/sdk` package within a NodeJS application |
107
+
|[Debug Your Waku DApp and WebSocket](/build/javascript/debug-waku-dapp)| Learn how to troubleshoot your Waku DApp using debug logs and check [WebSocket](/learn/concepts/transports) connections in [nwaku](/run-node/)|
108
+
|[Manage Your Filter Subscriptions](/build/javascript/manage-filter)| Learn how to manage [filter subscriptions](/learn/concepts/protocols#filter) and handle node disconnections in your application |
109
109
110
110
:::tip
111
-
Until [node incentivisation](/learn/research#prevention-of-denial-of-service-dos-and-node-incentivisation) is in place, you should [operate extra nodes](/#run-a-waku-node) alongside the ones provided by the Waku Network. When running a node, we recommend using the [DNS Discovery and Static Peers](/guides/js-waku/configure-discovery#configure-dns-discovery-and-static-peers) configuration to connect to both the Waku Network and your node.
111
+
Until [node incentivisation](/learn/research#prevention-of-denial-of-service-dos-and-node-incentivisation) is in place, you should [operate extra nodes](/#run-a-waku-node) alongside the ones provided by the Waku Network. When running a node, we recommend using the [DNS Discovery and Static Peers](/build/javascript/configure-discovery#configure-dns-discovery-and-static-peers) configuration to connect to both the Waku Network and your node.
Copy file name to clipboardExpand all lines: docs/build/javascript/light-send-receive.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@ hide_table_of_contents: true
4
4
displayed_sidebar: build
5
5
---
6
6
7
-
This guide provides detailed steps to start using the `@waku/sdk` package by setting up a [Light Node](/learn/glossary#light-node) to send messages using the [Light Push protocol](/learn/concepts/protocols#light-push), and receive messages using the [Filter protocol](/learn/concepts/protocols#filter). Have a look at the [installation guide](/guides/js-waku/#installation) for steps on adding `@waku/sdk` to your project.
7
+
This guide provides detailed steps to start using the `@waku/sdk` package by setting up a [Light Node](/learn/glossary#light-node) to send messages using the [Light Push protocol](/learn/concepts/protocols#light-push), and receive messages using the [Filter protocol](/learn/concepts/protocols#filter). Have a look at the [installation guide](/build/javascript/#installation) for steps on adding `@waku/sdk` to your project.
8
8
9
9
## Create a light node
10
10
@@ -22,7 +22,7 @@ await node.start();
22
22
```
23
23
24
24
:::info
25
-
When the `defaultBootstrap` parameter is set to `true`, your node will be bootstrapped using the [default bootstrap method](/guides/js-waku/configure-discovery#default-bootstrap-method). Have a look at the [Bootstrap Nodes and Discover Peers](/guides/js-waku/configure-discovery) guide to learn more methods to bootstrap nodes.
25
+
When the `defaultBootstrap` parameter is set to `true`, your node will be bootstrapped using the [default bootstrap method](/build/javascript/configure-discovery#default-bootstrap-method). Have a look at the [Bootstrap Nodes and Discover Peers](/build/javascript/configure-discovery) guide to learn more methods to bootstrap nodes.
26
26
:::
27
27
28
28
A node needs to know how to route messages. By default, it will use The Waku Network configuration (`{ clusterId: 1, shards: [0,1,2,3,4,5,6,7] }`). For most applications, it's recommended to use autosharding:
Copy file name to clipboardExpand all lines: docs/build/javascript/manage-filter.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@ hide_table_of_contents: true
4
4
displayed_sidebar: build
5
5
---
6
6
7
-
This guide provides detailed steps to manage [Filter](/learn/concepts/protocols#filter) subscriptions and handle node disconnections in your application. Have a look at the [Send and Receive Messages Using Light Push and Filter](/guides/js-waku/light-send-receive) guide for using the `Light Push` and `Filter` protocols.
7
+
This guide provides detailed steps to manage [Filter](/learn/concepts/protocols#filter) subscriptions and handle node disconnections in your application. Have a look at the [Send and Receive Messages Using Light Push and Filter](/build/javascript/light-send-receive) guide for using the `Light Push` and `Filter` protocols.
0 commit comments