From d117ca5375550b37330403a548faef0e7a972eb1 Mon Sep 17 00:00:00 2001 From: LordGhostX Date: Sun, 14 May 2023 06:18:41 +0100 Subject: [PATCH] overhaul transports --- docs/overview/concepts/transports-in-waku.md | 11 ----------- docs/overview/concepts/transports.md | 13 +++++++++++++ .../research-in-progress.md | 0 .../{concepts => reference}/security-features.md | 0 .../{concepts => reference}/waku-vs-libp2p.md | 0 sidebars.js | 16 ++++++++++++---- 6 files changed, 25 insertions(+), 15 deletions(-) delete mode 100644 docs/overview/concepts/transports-in-waku.md create mode 100644 docs/overview/concepts/transports.md rename docs/overview/{concepts => reference}/research-in-progress.md (100%) rename docs/overview/{concepts => reference}/security-features.md (100%) rename docs/overview/{concepts => reference}/waku-vs-libp2p.md (100%) diff --git a/docs/overview/concepts/transports-in-waku.md b/docs/overview/concepts/transports-in-waku.md deleted file mode 100644 index 3487b69..0000000 --- a/docs/overview/concepts/transports-in-waku.md +++ /dev/null @@ -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. diff --git a/docs/overview/concepts/transports.md b/docs/overview/concepts/transports.md new file mode 100644 index 0000000..7bc2ae1 --- /dev/null +++ b/docs/overview/concepts/transports.md @@ -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. \ No newline at end of file diff --git a/docs/overview/concepts/research-in-progress.md b/docs/overview/reference/research-in-progress.md similarity index 100% rename from docs/overview/concepts/research-in-progress.md rename to docs/overview/reference/research-in-progress.md diff --git a/docs/overview/concepts/security-features.md b/docs/overview/reference/security-features.md similarity index 100% rename from docs/overview/concepts/security-features.md rename to docs/overview/reference/security-features.md diff --git a/docs/overview/concepts/waku-vs-libp2p.md b/docs/overview/reference/waku-vs-libp2p.md similarity index 100% rename from docs/overview/concepts/waku-vs-libp2p.md rename to docs/overview/reference/waku-vs-libp2p.md diff --git a/sidebars.js b/sidebars.js index 09dd9ed..2f9575f 100644 --- a/sidebars.js +++ b/sidebars.js @@ -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",