overhaul transports

This commit is contained in:
LordGhostX 2023-05-14 06:18:41 +01:00
parent 7f100470f2
commit d117ca5375
No known key found for this signature in database
GPG Key ID: 520CC5DC4F94FCC7
6 changed files with 25 additions and 15 deletions

View File

@ -1,11 +0,0 @@
---
title: Transports in Waku
---
Waku v2 is built in top of libp2p, and like libp2p it strives to be transport agnostic. We define a set of recommended transports in order to achieve a baseline of interoperability between clients.
This section describes these recommended transports:
- Waku nodes uses TCP to communicate by default. A service node should be using TCP to listen to, and connect to other nodes.
- For browser environments, secure websocket is used. Service nodes are encouraged to setup a SSL certificate to enable incoming connections from browser and serve them.
- Other protocols such as [WebRTC](https://github.com/waku-org/js-waku/issues/20), [WebTransport](https://github.com/waku-org/js-waku/issues/697) and QUIC have been studied.

View File

@ -0,0 +1,13 @@
---
title: Transports in Waku
---
Waku aims to be transport agnostic, providing flexibility in selecting suitable transports. However, a set of recommended transports is defined to establish a baseline of client interoperability.
The recommended transports for Waku nodes are as follows:
- TCP: By default, Waku nodes utilize TCP for communication. Service nodes should employ TCP for listening to and connecting with other nodes.
- Secure WebSocket: In browser environments, secure WebSocket is used. Service nodes are encouraged to set up SSL certificates to enable incoming connections from browsers and serve them securely.
- Other protocols like [WebRTC](https://github.com/waku-org/js-waku/issues/20), [WebTransport](https://github.com/waku-org/js-waku/issues/697), and QUIC have been investigated and studied for potential integration.
Waku ensures compatibility and enhanced communication capabilities among nodes by adhering to these recommended transports.

View File

@ -19,13 +19,21 @@ const sidebars = {
"overview/concepts/protocols",
"overview/concepts/network-domains",
"overview/concepts/node-discovery",
"overview/concepts/transports-in-waku",
"overview/concepts/transports",
"overview/concepts/content-topics",
"overview/concepts/security-features",
"overview/concepts/research-in-progress",
"overview/concepts/waku-vs-libp2p",
],
},
{
type: "category",
label: "Reference",
collapsed: true,
collapsible: true,
items: [
"overview/reference/security-features",
"overview/reference/research-in-progress",
"overview/reference/waku-vs-libp2p",
],
},
],
browser: [
"browser/introduction",