mirror of
https://github.com/vacp2p/rfc.vac.dev.git
synced 2026-01-09 22:27:59 -05:00
feat: parse front matter
This commit is contained in:
@@ -1,3 +1,4 @@
|
||||
|
||||
# Waku RFCs
|
||||
|
||||
Waku builds a family of privacy-preserving, censorship-resistant communication protocols for web3 applications.
|
||||
|
||||
@@ -1,3 +1,4 @@
|
||||
|
||||
# Deprecated RFCs
|
||||
|
||||
Deprecated specifications are no longer used in Waku products.
|
||||
|
||||
@@ -10,6 +10,13 @@ contributors:
|
||||
- Kim De Mey \<kimdemey@status.im\>
|
||||
sidebar_position: 5
|
||||
---
|
||||
- Status: deprecated
|
||||
- Editor: Oskar Thorén \<oskarth@titanproxy.com\>
|
||||
- Contributors::
|
||||
- Adam Babik \<adam@status.im\>
|
||||
- Andrea Maria Piana \<andreap@status.im\>
|
||||
- Dean Eigenmann \<dean@status.im\>
|
||||
- Kim De Mey \<kimdemey@status.im\>
|
||||
|
||||
This specification describes the format of Waku messages within the ÐΞVp2p Wire Protocol. This spec substitutes [EIP-627](https://eips.ethereum.org/EIPS/eip-627). Waku is a fork of the original Whisper protocol that enables better usability for resource restricted devices, such as mostly-offline bandwidth-constrained smartphones. It does this through (a) light node support, (b) historic messages (with a mailserver) (c) expressing topic interest for better bandwidth usage and (d) basic rate limiting.
|
||||
|
||||
|
||||
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
@@ -6,6 +6,8 @@ editor: Oskar Thorén \<oskarth@titanproxy.com\>
|
||||
contributors:
|
||||
sidebar_position: 30
|
||||
---
|
||||
- Status: draft
|
||||
- Editor: Oskar Thorén \<oskarth@titanproxy.com\>
|
||||
|
||||
This is an informational spec that show cases the concept of adaptive nodes.
|
||||
|
||||
|
||||
@@ -6,6 +6,8 @@ editor: Hanno Cornelius \<hanno@status.im\>
|
||||
contributors:
|
||||
sidebar_position: 29
|
||||
---
|
||||
- Status: draft
|
||||
- Editor: Hanno Cornelius \<hanno@status.im\>
|
||||
|
||||
`29/WAKU2-CONFIG` describes the RECOMMENDED values to assign to configurable parameters for Waku v2 clients.
|
||||
Since Waku v2 is built on [libp2p](https://github.com/libp2p/specs),
|
||||
|
||||
@@ -6,6 +6,8 @@ editor: Hanno Cornelius \<hanno@status.im\>
|
||||
contributors:
|
||||
sidebar_position: 27
|
||||
---
|
||||
- Status: draft
|
||||
- Editor: Hanno Cornelius \<hanno@status.im\>
|
||||
|
||||
`27/WAKU2-PEERS` describes a recommended minimal set of peer storage and peer management features to be implemented by Waku v2 clients.
|
||||
|
||||
|
||||
@@ -9,6 +9,12 @@ contributors:
|
||||
- Daniel Kaiser \<danielkaiser@status.im\>
|
||||
sidebar_position: 23
|
||||
---
|
||||
- Status: draft
|
||||
- Category: Informational
|
||||
- Editor: Oskar Thoren \<oskarth@titanproxy.com\>
|
||||
- Contributors::
|
||||
- Hanno Cornelius \<hanno@status.im\>
|
||||
- Daniel Kaiser \<danielkaiser@status.im\>
|
||||
|
||||
This document outlines recommended usage of topic names in Waku v2.
|
||||
In [10/WAKU2 spec](../../standards/core/10/waku2.md) there are two types of topics:
|
||||
|
||||
@@ -7,6 +7,10 @@ contributors:
|
||||
- Hanno Cornelius \<hanno@status.im\>
|
||||
sidebar_position: 22
|
||||
---
|
||||
- Status: draft
|
||||
- Editor: Franck Royer \<franck@status.im\>
|
||||
- Contributors::
|
||||
|
||||
|
||||
**Content Topic**: `/toy-chat/2/huilong/proto`.
|
||||
|
||||
|
||||
@@ -6,6 +6,8 @@ editor: Sanaz Taheri \<sanaz@status.im\>
|
||||
contributors:
|
||||
sidebar_position: 21
|
||||
---
|
||||
- Status: draft
|
||||
- Editor: Sanaz Taheri \<sanaz@status.im\>
|
||||
|
||||
The reliability of [13/WAKU2-STORE](../../core/13/store.md) protocol heavily relies on the fact that full nodes i.e., those who persist messages have high availability and uptime and do not miss any messages.
|
||||
If a node goes offline, then it will risk missing all the messages transmitted in the network during that time.
|
||||
|
||||
@@ -6,6 +6,8 @@ editor: Oskar Thoren \<oskarth@titanproxy.com\>
|
||||
contributors:
|
||||
sidebar_position: 26
|
||||
---
|
||||
- Status: draft
|
||||
- Editor: Oskar Thoren \<oskarth@titanproxy.com\>
|
||||
|
||||
This specification describes how Waku provides confidentiality, authenticity, and integrity, as well as some form of unlinkability.
|
||||
Specifically, it describes how encryption, decryption and signing works in [6/WAKU1](../../legacy/6/waku1.md) and in [10/WAKU2 spec](../../core/10/waku2.md) with [14/WAKU-MESSAGE version 1](../../core/14/message.md/#version1).
|
||||
|
||||
@@ -6,6 +6,8 @@ editor: Oskar Thorén \<oskarth@titanproxy.com\>
|
||||
contributor: Ebube Ud \<ebube@status.im\>
|
||||
sidebar_position: 18
|
||||
---
|
||||
- Status: draft
|
||||
- Editor: Oskar Thorén \<oskarth@titanproxy.com\>
|
||||
|
||||
## Abstract
|
||||
|
||||
|
||||
@@ -6,6 +6,8 @@ editor: Franck Royer \<franck@status.im\>
|
||||
contributors:
|
||||
sidebar_position: 20
|
||||
---
|
||||
- Status: draft
|
||||
- Editor: Franck Royer \<franck@status.im\>
|
||||
|
||||
**Content Topics**:
|
||||
|
||||
|
||||
@@ -12,6 +12,11 @@ contributors:
|
||||
- Dean Eigenmann \<dean@status.im\>
|
||||
sidebar_position: 54
|
||||
---
|
||||
- Status: draft
|
||||
- Category: Standards Track
|
||||
- Editor: Aaryamann Challani \<aaryamann@status.im\>
|
||||
- Contributors::
|
||||
|
||||
|
||||
## Abstract
|
||||
|
||||
|
||||
@@ -12,6 +12,11 @@ contributors:
|
||||
- Dean Eigenmann \<dean@status.im\>
|
||||
sidebar_position: 53
|
||||
---
|
||||
- Status: draft
|
||||
- Category: Standards Track
|
||||
- Editor: Aaryamann Challani \<aaryamann@status.im\>
|
||||
- Contributors::
|
||||
|
||||
|
||||
## Abstract
|
||||
|
||||
|
||||
@@ -10,6 +10,15 @@ contributors:
|
||||
- Ebube Ud \<ebube@status.im\>
|
||||
sidebar_position: 12
|
||||
---
|
||||
- Status: draft
|
||||
- Editor: Hanno Cornelius \<hanno@status.im\>
|
||||
- Contributors::
|
||||
- Dean Eigenmann \<dean@status.im\>
|
||||
- Oskar Thorén \<oskarth@titanproxy.com\>
|
||||
- Sanaz Taheri \<sanaz@status.im\>
|
||||
- Ebube Ud \<ebube@status.im\>
|
||||
- Contributors::
|
||||
|
||||
version: 00
|
||||
|
||||
---
|
||||
|
||||
Binary file not shown.
@@ -7,6 +7,10 @@ contributors:
|
||||
- Franck Royer \<franck@status.im\>
|
||||
sidebar_position: 36
|
||||
---
|
||||
- Status: draft
|
||||
- Editor: Richard Ramos \<richard@status.im\>
|
||||
- Contributors::
|
||||
|
||||
|
||||
# Introduction
|
||||
|
||||
|
||||
@@ -5,6 +5,8 @@ status: draft
|
||||
editor: Hanno Cornelius \<hanno@status.im\>
|
||||
sidebar_position: 15
|
||||
---
|
||||
- Status: draft
|
||||
- Editor: Hanno Cornelius \<hanno@status.im\>
|
||||
|
||||
A bridge between Waku v1 and Waku v2.
|
||||
|
||||
|
||||
@@ -6,6 +6,8 @@ editor: Daniel Kaiser \<danielkaiser@status.im\>
|
||||
contributors:
|
||||
sidebar_position: 33
|
||||
---
|
||||
- Status: draft
|
||||
- Editor: Daniel Kaiser \<danielkaiser@status.im\>
|
||||
|
||||
## Abstract
|
||||
|
||||
|
||||
@@ -11,6 +11,15 @@ contributors:
|
||||
- Ebube Ud \<ebube@status.im\>
|
||||
sidebar_position: 12
|
||||
---
|
||||
- Status: draft
|
||||
- Editor: Hanno Cornelius \<hanno@status.im\>
|
||||
- Contributors::
|
||||
- Dean Eigenmann \<dean@status.im\>
|
||||
- Oskar Thorén \<oskar@status.im\>
|
||||
- Sanaz Taheri \<sanaz@status.im\>
|
||||
- Ebube Ud \<ebube@status.im\>
|
||||
- Contributors::
|
||||
|
||||
|
||||
previous versions: [00](./previous-versions00)
|
||||
|
||||
|
||||
@@ -8,6 +8,11 @@ contributors:
|
||||
- Oskar Thorén \<oskarth@titanproxy.com\>
|
||||
sidebar_position: 19
|
||||
---
|
||||
- Status: draft
|
||||
- Editor: Hanno Cornelius \<hanno@status.im\>
|
||||
- Contributors::
|
||||
- Daniel Kaiser \<danielkaiser@status.im\>
|
||||
- Oskar Thorén \<oskarth@titanproxy.com\>
|
||||
|
||||
**Protocol identifier**: `/vac/waku/lightpush/2.0.0-beta1`
|
||||
|
||||
|
||||
@@ -12,6 +12,15 @@ contributors:
|
||||
- Oskar Thorén \<oskarth@titanproxy.com\>
|
||||
sidebar_position: 14
|
||||
---
|
||||
- Status: draft
|
||||
- Category: Standards Track
|
||||
- Editor: Hanno Cornelius \<hanno@status.im\>
|
||||
- Contributors::
|
||||
- Sanaz Taheri \<sanaz@status.im\>
|
||||
- Aaryamann Challani \<aaryamann@status.im\>
|
||||
- Lorenzo Delgado \<lorenzo@status.im\>
|
||||
- Abhimanyu Rawat \<abhi@status.im\>
|
||||
- Oskar Thorén \<oskarth@titanproxy.com\>
|
||||
|
||||
## Abstract
|
||||
|
||||
|
||||
@@ -8,6 +8,11 @@ contributors:
|
||||
- Sanaz Taheri \<sanaz@status.im\>
|
||||
sidebar_position: 11
|
||||
---
|
||||
- Status: stable
|
||||
- Editor: Hanno Cornelius \<hanno@status.im\>
|
||||
- Contributors::
|
||||
- Oskar Thorén \<oskarth@titanproxy.com\>
|
||||
- Sanaz Taheri \<sanaz@status.im\>
|
||||
|
||||
`11/WAKU2-RELAY` specifies a [Publish/Subscribe approach](https://docs.libp2p.io/concepts/publish-subscribe/) to peer-to-peer messaging with a strong focus on privacy, censorship-resistance, security and scalability.
|
||||
Its current implementation is a minor extension of the [libp2p GossipSub protocol](https://github.com/libp2p/specs/blob/master/pubsub/gossipsub/README.md) and prescribes gossip-based dissemination.
|
||||
|
||||
@@ -10,6 +10,13 @@ contributors:
|
||||
- Hanno Cornelius \<hanno@status.im\>
|
||||
sidebar_position: 17
|
||||
---
|
||||
- Status: draft
|
||||
- Editor: Alvaro Revuelta \<alvaro@status.im\>
|
||||
- Contributors::
|
||||
- Oskar Thorén \<oskarth@titanproxy.com\>
|
||||
- Aaryamann Challani \<aaryamann@status.im\>
|
||||
- Sanaz Taheri \<sanaz@status.im\>
|
||||
- Hanno Cornelius \<hanno@status.im\>
|
||||
|
||||
The `17/WAKU2-RLN-RELAY` protocol is an extension of `11/WAKU2-RELAY` which additionally provides spam protection using [Rate Limiting Nullifiers (RLN)](../../../../vac/32/rln-v1.md).
|
||||
|
||||
|
||||
@@ -5,6 +5,8 @@ status: draft
|
||||
editor: Hanno Cornelius \<hanno@status.im\>
|
||||
sidebar_position: 16
|
||||
---
|
||||
- Status: draft
|
||||
- Editor: Hanno Cornelius \<hanno@status.im\>
|
||||
|
||||
## Introduction
|
||||
|
||||
|
||||
@@ -11,6 +11,14 @@ contributors:
|
||||
- Hanno Cornelius \<hanno@status.im\>
|
||||
sidebar_position: 13
|
||||
---
|
||||
- Status: draft
|
||||
- Editor: Simon-Pierre Vivier \<simvivier@status.im\>
|
||||
- Contributors::
|
||||
- Dean Eigenmann \<dean@status.im\>
|
||||
- Oskar Thorén \<oskarth@titanproxy.com\>
|
||||
- Aaryamann Challani \<aaryamann@status.im\>
|
||||
- Sanaz Taheri \<sanaz@status.im\>
|
||||
- Hanno Cornelius \<hanno@status.im\>
|
||||
|
||||
## Abstract
|
||||
This specification explains the `13/WAKU2-STORE` protocol which enables querying of messages received through the relay protocol and
|
||||
|
||||
@@ -11,6 +11,14 @@ contributors:
|
||||
- Oskar Thorén \<oskarth@titanproxy.com\>
|
||||
sidebar_position: 10
|
||||
---
|
||||
- Status: draft
|
||||
- Editor: Hanno Cornelius \<hanno@status.im\>
|
||||
- Contributors::
|
||||
- Sanaz Taheri \<sanaz@status.im\>
|
||||
- Hanno Cornelius \<hanno@status.im\>
|
||||
- Reeshav Khan \<reeshav@status.im\>
|
||||
- Daniel Kaiser \<danielkaiser@status.im\>
|
||||
- Oskar Thorén \<oskarth@titanproxy.com\>
|
||||
|
||||
## Abstract
|
||||
|
||||
|
||||
@@ -8,6 +8,11 @@ contributors:
|
||||
- Kim De Mey \<kimdemey@status.im\>
|
||||
sidebar_position: 7
|
||||
---
|
||||
- Status: stable
|
||||
- Editor: Oskar Thorén \<oskarth@titanproxy.com\>
|
||||
- Contributors::
|
||||
- Dean Eigenmann \<dean@status.im\>
|
||||
- Kim De Mey \<kimdemey@status.im\>
|
||||
|
||||
This specification describes the encryption, decryption and signing of the content in the [data field used in Waku](../6/waku1.md/#abnf-specification).
|
||||
|
||||
|
||||
@@ -9,6 +9,12 @@ contributors:
|
||||
- Oskar Thorén \<oskarth@titanproxy.com\>
|
||||
sidebar_position: 8
|
||||
---
|
||||
- Status: stable
|
||||
- Editor: Andrea Maria Piana \<andreap@status.im\>
|
||||
- Contributors::
|
||||
- Adam Babik \<adam@status.im\>
|
||||
- Dean Eigenmann \<dean@status.im\>
|
||||
- Oskar Thorén \<oskarth@titanproxy.com\>
|
||||
|
||||
## Abstract
|
||||
|
||||
|
||||
@@ -8,6 +8,11 @@ contributors:
|
||||
- Oskar Thorén \<oskarth@titanproxy.com\>
|
||||
sidebar_position: 9
|
||||
---
|
||||
- Status: stable
|
||||
- Editor: Andrea Maria Piana \<andreap@status.im\>
|
||||
- Contributors::
|
||||
- Dean Eigenmann \<dean@status.im\>
|
||||
- Oskar Thorén \<oskarth@titanproxy.com\>
|
||||
|
||||
This specification describes the RPC API that Waku nodes MAY adhere to. The unified API allows clients to easily
|
||||
be able to connect to any node implementation. The API described is privileged as a node stores the keys of clients.
|
||||
|
||||
@@ -10,6 +10,13 @@ contributors:
|
||||
- Kim De Mey \<kimdemey@status.im\>
|
||||
sidebar_position: 6
|
||||
---
|
||||
- Status: stable
|
||||
- Editor: Oskar Thorén \<oskarth@titanproxy.com\>
|
||||
- Contributors::
|
||||
- Adam Babik \<adam@status.im\>
|
||||
- Andrea Maria Piana \<andreap@status.im\>
|
||||
- Dean Eigenmann \<dean@status.im\>
|
||||
- Kim De Mey \<kimdemey@status.im\>
|
||||
|
||||
This specification describes the format of Waku packets within the ÐΞVp2p Wire Protocol. This spec substitutes [EIP-627](https://eips.ethereum.org/EIPS/eip-627). Waku is a fork of the original Whisper protocol that enables better usability for resource restricted devices, such as mostly-offline bandwidth-constrained smartphones. It does this through (a) light node support, (b) historic envelopes (with a mailserver) (c) expressing topic interest for better bandwidth usage and (d) basic rate limiting.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user