feat: parse front matter

This commit is contained in:
jinhojang6
2024-03-28 02:17:25 +09:00
parent f3bf3a9875
commit 5e2df2cd2d
64 changed files with 313 additions and 2 deletions

View File

@@ -1,3 +1,4 @@
# Codex RFCs # Codex RFCs
Codex specifications related to a decentralised data storage platform. Codex specifications related to a decentralised data storage platform.

View File

@@ -74,8 +74,6 @@ async function fetchDirectoryContents(dirUrl, basePath, prefixToRemove) {
function adjustPathForMarkdown(filePath) { function adjustPathForMarkdown(filePath) {
const parts = filePath.split('/') const parts = filePath.split('/')
console.log(filePath)
if (parts?.length === 1) return filePath if (parts?.length === 1) return filePath
if (filePath.includes('README.md')) return filePath if (filePath.includes('README.md')) return filePath
@@ -97,6 +95,75 @@ async function fetchDirectoryContents(dirUrl, basePath, prefixToRemove) {
}) })
} }
function enhanceMarkdownWithBulletPointsCorrected(input) {
// Split the input text into lines
const lines = input.split('\n')
// Initialize an array to hold the extracted fields
let extractedFields = []
// Initialize variables to track the frontmatter and contributors section
let inFrontMatter = false
let inContributors = false
let contributorsLines = [] // Holds contributors lines
// Process each line
const outputLines = lines.map(line => {
if (line.trim() === '---') {
inFrontMatter = !inFrontMatter
if (!inFrontMatter && contributorsLines.length) {
// We're exiting frontmatter; time to add contributors
extractedFields.push(`contributors:\n${contributorsLines.join('\n')}`)
contributorsLines = [] // Reset for safety
}
return line // Keep the frontmatter delimiters
}
if (inFrontMatter) {
if (line.startsWith('contributors:')) {
inContributors = true // Entering contributors section
} else if (inContributors) {
if (line.startsWith(' -')) {
contributorsLines.push(line.trim()) // Add contributors line
} else {
// Exiting contributors section
inContributors = false
extractedFields.push(`contributors:\n${contributorsLines.join('\n')}`)
contributorsLines = [] // Reset
}
} else {
const match = line.match(/(status|category|editor):(.*)/)
if (match) {
extractedFields.push(line.trim())
}
}
}
return line // Return the line unmodified
})
// Find the index of the second frontmatter delimiter
const endOfFrontMatterIndex = outputLines.findIndex(
(line, index) => line.trim() === '---' && index > 0,
)
// Insert the extracted fields as capitalized bullet points after the frontmatter
const bulletPoints = extractedFields
.map(field => {
// Capitalize the first letter of the label and ensure proper formatting for multi-line fields
if (field.includes('\n')) {
const [label, ...values] = field.split('\n')
return `- ${label.charAt(0).toUpperCase() +
label.slice(1)}:\n ${values.join('\n ')}`
} else {
return `- ${field.charAt(0).toUpperCase() + field.slice(1)}`
}
})
.join('\n')
outputLines.splice(endOfFrontMatterIndex + 1, 0, bulletPoints)
// Join the lines back into a single string and return
return outputLines.join('\n')
}
function parseSlugFromFrontmatter(content) { function parseSlugFromFrontmatter(content) {
const frontmatterMatch = content.match(/---\s*\n([\s\S]*?)\n---/) const frontmatterMatch = content.match(/---\s*\n([\s\S]*?)\n---/)
if (frontmatterMatch) { if (frontmatterMatch) {
@@ -154,6 +221,8 @@ async function downloadAndSaveFile(url, filePath) {
// // parse sidebarPosition from the slug in the frontmatter // // parse sidebarPosition from the slug in the frontmatter
const sidebarPosition = parseSlugFromFrontmatter(content) || 1 const sidebarPosition = parseSlugFromFrontmatter(content) || 1
content = enhanceMarkdownWithBulletPointsCorrected(content)
content = updateMarkdownImagePath(content, sidebarPosition) content = updateMarkdownImagePath(content, sidebarPosition)
// Insert sidebar_position at the end of frontmatter if it doesn't exist // Insert sidebar_position at the end of frontmatter if it doesn't exist

View File

@@ -1,3 +1,4 @@
# Nomos Request For Comments(RFC) # Nomos Request For Comments(RFC)
Nomos is building secure, flexible, and scalable infrastructure for developers creating applications for the network state. Nomos is building secure, flexible, and scalable infrastructure for developers creating applications for the network state.

View File

@@ -12,6 +12,11 @@ contributors:
- Mark Evenson - Mark Evenson
sidebar_position: 38 sidebar_position: 38
--- ---
- Status: raw
- Category: Standards Track
- Editor: Corey Petty \<corey@status.im\>
- Contributors::
## Abstract ## Abstract

View File

@@ -13,6 +13,11 @@ contributors:
- Dean Eigenmann \<dean@status.im\> - Dean Eigenmann \<dean@status.im\>
sidebar_position: 55 sidebar_position: 55
--- ---
- Status: draft
- Category: Standards Track
- Editor: Aaryamann Challani \<aaryamann@status.im\>
- Contributors::
## Abstract ## Abstract

View File

@@ -1,3 +1,4 @@
# Status RFCs # Status RFCs
Status is a communitication tool providing privacy features for the user. Status is a communitication tool providing privacy features for the user.

View File

@@ -11,6 +11,11 @@ contributors:
- Samuel Hawksby-Robinson \<samuel@status.im\> - Samuel Hawksby-Robinson \<samuel@status.im\>
sidebar_position: 65 sidebar_position: 65
--- ---
- Status: draft
- Category: Standards Track
- Editor: Aaryamann Challani \<aaryamann@status.im\>
- Contributors::
## Abstract ## Abstract

View File

@@ -9,6 +9,11 @@ contributors:
- Andrea Piana \<andreap@status.im\> - Andrea Piana \<andreap@status.im\>
sidebar_position: 56 sidebar_position: 56
--- ---
- Status: draft
- Category: Standards Track
- Editor: Aaryamann Challani \<aaryamann@status.im\>
- Contributors::
## Abstract ## Abstract

View File

@@ -10,6 +10,12 @@ contributors:
- John Lea \<john@status.im\> - John Lea \<john@status.im\>
sidebar_position: 61 sidebar_position: 61
--- ---
- Status: draft
- Category: Standards Track
- Editor: r4bbit \<r4bbit@status.im\>
- Contributors::
- Sanaz Taheri \<sanaz@status.im\>
- John Lea \<john@status.im\>
## Abstract ## Abstract

View File

@@ -6,6 +6,8 @@ description: A voting protocol for SNT holders to submit votes to a smart contra
editor: Szymon Szlachtowicz \<szymon.s@ethworks.io\> editor: Szymon Szlachtowicz \<szymon.s@ethworks.io\>
sidebar_position: 24 sidebar_position: 24
--- ---
- Status: draft
- Editor: Szymon Szlachtowicz \<szymon.s@ethworks.io\>
## Abstract ## Abstract
This specification is a voting protocol for peers to submit votes to a smart contract. Voting is immutable, This specification is a voting protocol for peers to submit votes to a smart contract. Voting is immutable,

View File

@@ -6,6 +6,8 @@ description: To gain new members, current SNT holders can vote to feature an act
editor: Szymon Szlachtowicz \<szymon.s@ethworks.io\> editor: Szymon Szlachtowicz \<szymon.s@ethworks.io\>
sidebar_position: 28 sidebar_position: 28
--- ---
- Status: draft
- Editor: Szymon Szlachtowicz \<szymon.s@ethworks.io\>
## Abstract ## Abstract
This specification describes a voting method to feature different active Status Communities. This specification describes a voting method to feature different active Status Communities.

View File

@@ -9,6 +9,11 @@ contributors:
- Jimmy Debe \<jimmy@status.im\> - Jimmy Debe \<jimmy@status.im\>
sidebar_position: 63 sidebar_position: 63
--- ---
- Status: draft
- Category: Standards Track
- Editor: Aaryamann Challani \<aaryamann@status.im\>
- Contributors::
- Jimmy Debe \<jimmy@status.im\>
## Terminology ## Terminology

View File

@@ -10,6 +10,10 @@ contributors:
- Samuel Hawksby-Robinson \<samuel@status.im\> - Samuel Hawksby-Robinson \<samuel@status.im\>
sidebar_position: 62 sidebar_position: 62
--- ---
- Status: draft
- Editor: r4bbit \<r4bbit@status.im\>
- Contributors::
## Abstract ## Abstract

View File

@@ -9,6 +9,11 @@ contributors:
- Andrea Maria Piana \<andreap@status.im\> - Andrea Maria Piana \<andreap@status.im\>
sidebar_position: 71 sidebar_position: 71
--- ---
- Status: draft
- Category: Standards Track
- Editor: Jimmy Debe \<jimmy@status.im\>
- Contributors::
- Andrea Maria Piana \<andreap@status.im\>
## Abstract ## Abstract
A push notification server implementation for IOS devices and Android devices. A push notification server implementation for IOS devices and Android devices.

View File

@@ -9,6 +9,11 @@ contributors:
- Alvaro Revuelta \<alrevuelta@status.im\> - Alvaro Revuelta \<alrevuelta@status.im\>
sidebar_position: 57 sidebar_position: 57
--- ---
- Status: raw
- Category: Informational
- Editor: Daniel Kaiser \<danielkaiser@status.im\>
- Contributors::
## Abstract ## Abstract

View File

@@ -10,6 +10,11 @@ contributors:
sidebar_position: 1 sidebar_position: 1
--- ---
- Status: raw
- Category: Best Current Practice
- Editor: Aaryamann Challani \<aaryamann@status.im\>
- Contributors::
## Abstract ## Abstract

View File

@@ -1,3 +1,4 @@
# Vac RFCs # Vac RFCs
Vac builds public good protocols for the decentralise web. Vac builds public good protocols for the decentralise web.

View File

@@ -13,6 +13,16 @@ contributors:
- Daniel Kaiser \<danielkaiser@status.im\> - Daniel Kaiser \<danielkaiser@status.im\>
sidebar_position: 1 sidebar_position: 1
--- ---
- Status: draft
- Category: Best Current Practice
- Editor: Oskar Thoren \<oskarth@titanproxy.com\>
- Contributors::
- Pieter Hintjens \<ph@imatix.com\>
- André Rebentisch \<andre@openstandards.de\>
- Alberto Barrionuevo \<abarrio@opentia.es\>
- Chris Puttick \<chris.puttick@thehumanjourney.net\>
- Yurii Rashkovskii \<yrashk@gmail.com\>
- Daniel Kaiser \<danielkaiser@status.im\>
This document describes a consensus-oriented specification system (COSS) for building interoperable technical specifications. This document describes a consensus-oriented specification system (COSS) for building interoperable technical specifications.
COSS is based on a lightweight editorial process that seeks to engage the widest possible range of interested parties and move rapidly to consensus through working code. COSS is based on a lightweight editorial process that seeks to engage the widest possible range of interested parties and move rapidly to consensus through working code.

View File

@@ -7,6 +7,9 @@ editor: Ramses Fernandez \<ramses@status.im\>
contributors: contributors:
sidebar_position: 70 sidebar_position: 70
--- ---
- Status: raw
- Category: Standards Track
- Editor: Ramses Fernandez \<ramses@status.im\>
## Motivation ## Motivation
The need for secure communications has become paramount. The need for secure communications has become paramount.

View File

@@ -7,6 +7,9 @@ editor: Daniel Kaiser \<danielkaiser@status.im\>
contributors: contributors:
sidebar_position: 46 sidebar_position: 46
--- ---
- Status: raw
- Category: Standards Track
- Editor: Daniel Kaiser \<danielkaiser@status.im\>
## Abstract ## Abstract

View File

@@ -6,6 +6,8 @@ editor: Hanno Cornelius \<hanno@status.im\>
contributors: contributors:
sidebar_position: 25 sidebar_position: 25
--- ---
- Status: deleted
- Editor: Hanno Cornelius \<hanno@status.im\>
`25/LIBP2P-DNS-DISCOVERY` specifies a scheme to implement [`libp2p`](https://libp2p.io/) peer discovery via DNS for Waku v2. `25/LIBP2P-DNS-DISCOVERY` specifies a scheme to implement [`libp2p`](https://libp2p.io/) peer discovery via DNS for Waku v2.
The generalised purpose is to retrieve an arbitrarily long, authenticated, updateable list of [`libp2p` peers](https://docs.libp2p.io/concepts/peer-id/) to bootstrap connection to a `libp2p` network. The generalised purpose is to retrieve an arbitrarily long, authenticated, updateable list of [`libp2p` peers](https://docs.libp2p.io/concepts/peer-id/) to bootstrap connection to a `libp2p` network.

View File

@@ -9,6 +9,12 @@ contributors:
- Oskar Thorén \<oskarth@titanproxy.com\> - Oskar Thorén \<oskarth@titanproxy.com\>
sidebar_position: 4 sidebar_position: 4
--- ---
- Status: draft
- Editor: Sanaz Taheri \<sanaz@status.im\>
- Contributors::
- Dean Eigenmann \<dean@status.im\>
- Andrea Maria Piana \<andreap@status.im\>
- Oskar Thorén \<oskarth@titanproxy.com\>
In this specification, we describe a method to construct message history that will aid the consistency guarantees of [2/MVDS](../2/mvds.md). Additionally, we explain how data sync can be used for more lightweight messages that do not require full synchronization. In this specification, we describe a method to construct message history that will aid the consistency guarantees of [2/MVDS](../2/mvds.md). Additionally, we explain how data sync can be used for more lightweight messages that do not require full synchronization.

View File

@@ -8,6 +8,11 @@ contributors:
- Oskar Thorén \<oskarth@titanproxy.com\> - Oskar Thorén \<oskarth@titanproxy.com\>
sidebar_position: 2 sidebar_position: 2
--- ---
- Status: stable
- Editor: Sanaz Taheri \<sanaz@status.im\>
- Contributors::
- Dean Eigenmann \<dean@status.im\>
- Oskar Thorén \<oskarth@titanproxy.com\>
In this specification, we describe a minimum viable protocol for data synchronization inspired by the Bramble Synchronization Protocol[^1]. This protocol is designed to ensure reliable messaging between peers across an unreliable peer-to-peer (P2P) network where they may be unreachable or unresponsive. In this specification, we describe a minimum viable protocol for data synchronization inspired by the Bramble Synchronization Protocol[^1]. This protocol is designed to ensure reliable messaging between peers across an unreliable peer-to-peer (P2P) network where they may be unreachable or unresponsive.

View File

@@ -1,3 +1,4 @@
# Vac Raw Specifications # Vac Raw Specifications
All Vac specifications that have not reached **draft** status will live in this repository. All Vac specifications that have not reached **draft** status will live in this repository.

View File

@@ -7,6 +7,10 @@ contributors:
- Dean Eigenmann \<dean@status.im\> - Dean Eigenmann \<dean@status.im\>
sidebar_position: 3 sidebar_position: 3
--- ---
- Status: draft
- Editor: Oskar Thorén \<oskarth@titanproxy.com\>
- Contributors::
- Dean Eigenmann \<dean@status.im\>
A remote log is a replication of a local log. This means a node can read data that originally came from a node that is offline. A remote log is a replication of a local log. This means a node can read data that originally came from a node that is offline.

View File

@@ -7,6 +7,9 @@ editor: Aaryamann Challani \<aaryamann@status.im\>
contributors: contributors:
sidebar_position: 48 sidebar_position: 48
--- ---
- Status: raw
- Category:
- Editor: Aaryamann Challani \<aaryamann@status.im\>
## Abstract ## Abstract

View File

@@ -11,6 +11,10 @@ contributors:
- Blagoj Dimovski \<blagoj.dimovski@yandex.com\> - Blagoj Dimovski \<blagoj.dimovski@yandex.com\>
sidebar_position: 32 sidebar_position: 32
--- ---
- Status: raw
- Editor: Rasul Ibragimov \<curryrasul@gmail.com\>
- Contributors::
## Abstract ## Abstract

View File

@@ -7,6 +7,10 @@ contributors:
- Lev Soukhanov \<0xdeadfae@gmail.com\> - Lev Soukhanov \<0xdeadfae@gmail.com\>
sidebar_position: 58 sidebar_position: 58
--- ---
- Status: raw
- Editor: Rasul Ibragimov \<curryrasul@gmail.com\>
- Contributors::
## Abstract ## Abstract

View File

@@ -7,6 +7,9 @@ editor: Daniel Kaiser \<danielkaiser@status.im\>
contributors: contributors:
sidebar_position: 1 sidebar_position: 1
--- ---
- Status: (raw|draft|stable)
- Category: (Standards Track|Informational|Best Current Practice)
- Editor: Daniel Kaiser \<danielkaiser@status.im\>
# (Info, remove this section) # (Info, remove this section)

View File

@@ -1,3 +1,4 @@
# Waku RFCs # Waku RFCs
Waku builds a family of privacy-preserving, censorship-resistant communication protocols for web3 applications. Waku builds a family of privacy-preserving, censorship-resistant communication protocols for web3 applications.

View File

@@ -1,3 +1,4 @@
# Deprecated RFCs # Deprecated RFCs
Deprecated specifications are no longer used in Waku products. Deprecated specifications are no longer used in Waku products.

View File

@@ -10,6 +10,13 @@ contributors:
- Kim De Mey \<kimdemey@status.im\> - Kim De Mey \<kimdemey@status.im\>
sidebar_position: 5 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. 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.

View File

@@ -6,6 +6,8 @@ editor: Oskar Thorén \<oskarth@titanproxy.com\>
contributors: contributors:
sidebar_position: 30 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. This is an informational spec that show cases the concept of adaptive nodes.

View File

@@ -6,6 +6,8 @@ editor: Hanno Cornelius \<hanno@status.im\>
contributors: contributors:
sidebar_position: 29 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. `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), Since Waku v2 is built on [libp2p](https://github.com/libp2p/specs),

View File

@@ -6,6 +6,8 @@ editor: Hanno Cornelius \<hanno@status.im\>
contributors: contributors:
sidebar_position: 27 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. `27/WAKU2-PEERS` describes a recommended minimal set of peer storage and peer management features to be implemented by Waku v2 clients.

View File

@@ -9,6 +9,12 @@ contributors:
- Daniel Kaiser \<danielkaiser@status.im\> - Daniel Kaiser \<danielkaiser@status.im\>
sidebar_position: 23 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. 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: In [10/WAKU2 spec](../../standards/core/10/waku2.md) there are two types of topics:

View File

@@ -7,6 +7,10 @@ contributors:
- Hanno Cornelius \<hanno@status.im\> - Hanno Cornelius \<hanno@status.im\>
sidebar_position: 22 sidebar_position: 22
--- ---
- Status: draft
- Editor: Franck Royer \<franck@status.im\>
- Contributors::
**Content Topic**: `/toy-chat/2/huilong/proto`. **Content Topic**: `/toy-chat/2/huilong/proto`.

View File

@@ -6,6 +6,8 @@ editor: Sanaz Taheri \<sanaz@status.im\>
contributors: contributors:
sidebar_position: 21 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. 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. If a node goes offline, then it will risk missing all the messages transmitted in the network during that time.

View File

@@ -6,6 +6,8 @@ editor: Oskar Thoren \<oskarth@titanproxy.com\>
contributors: contributors:
sidebar_position: 26 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. 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). 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).

View File

@@ -6,6 +6,8 @@ editor: Oskar Thorén \<oskarth@titanproxy.com\>
contributor: Ebube Ud \<ebube@status.im\> contributor: Ebube Ud \<ebube@status.im\>
sidebar_position: 18 sidebar_position: 18
--- ---
- Status: draft
- Editor: Oskar Thorén \<oskarth@titanproxy.com\>
## Abstract ## Abstract

View File

@@ -6,6 +6,8 @@ editor: Franck Royer \<franck@status.im\>
contributors: contributors:
sidebar_position: 20 sidebar_position: 20
--- ---
- Status: draft
- Editor: Franck Royer \<franck@status.im\>
**Content Topics**: **Content Topics**:

View File

@@ -12,6 +12,11 @@ contributors:
- Dean Eigenmann \<dean@status.im\> - Dean Eigenmann \<dean@status.im\>
sidebar_position: 54 sidebar_position: 54
--- ---
- Status: draft
- Category: Standards Track
- Editor: Aaryamann Challani \<aaryamann@status.im\>
- Contributors::
## Abstract ## Abstract

View File

@@ -12,6 +12,11 @@ contributors:
- Dean Eigenmann \<dean@status.im\> - Dean Eigenmann \<dean@status.im\>
sidebar_position: 53 sidebar_position: 53
--- ---
- Status: draft
- Category: Standards Track
- Editor: Aaryamann Challani \<aaryamann@status.im\>
- Contributors::
## Abstract ## Abstract

View File

@@ -10,6 +10,15 @@ contributors:
- Ebube Ud \<ebube@status.im\> - Ebube Ud \<ebube@status.im\>
sidebar_position: 12 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 version: 00
--- ---

View File

@@ -7,6 +7,10 @@ contributors:
- Franck Royer \<franck@status.im\> - Franck Royer \<franck@status.im\>
sidebar_position: 36 sidebar_position: 36
--- ---
- Status: draft
- Editor: Richard Ramos \<richard@status.im\>
- Contributors::
# Introduction # Introduction

View File

@@ -5,6 +5,8 @@ status: draft
editor: Hanno Cornelius \<hanno@status.im\> editor: Hanno Cornelius \<hanno@status.im\>
sidebar_position: 15 sidebar_position: 15
--- ---
- Status: draft
- Editor: Hanno Cornelius \<hanno@status.im\>
A bridge between Waku v1 and Waku v2. A bridge between Waku v1 and Waku v2.

View File

@@ -6,6 +6,8 @@ editor: Daniel Kaiser \<danielkaiser@status.im\>
contributors: contributors:
sidebar_position: 33 sidebar_position: 33
--- ---
- Status: draft
- Editor: Daniel Kaiser \<danielkaiser@status.im\>
## Abstract ## Abstract

View File

@@ -11,6 +11,15 @@ contributors:
- Ebube Ud \<ebube@status.im\> - Ebube Ud \<ebube@status.im\>
sidebar_position: 12 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) previous versions: [00](./previous-versions00)

View File

@@ -8,6 +8,11 @@ contributors:
- Oskar Thorén \<oskarth@titanproxy.com\> - Oskar Thorén \<oskarth@titanproxy.com\>
sidebar_position: 19 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` **Protocol identifier**: `/vac/waku/lightpush/2.0.0-beta1`

View File

@@ -12,6 +12,15 @@ contributors:
- Oskar Thorén \<oskarth@titanproxy.com\> - Oskar Thorén \<oskarth@titanproxy.com\>
sidebar_position: 14 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 ## Abstract

View File

@@ -8,6 +8,11 @@ contributors:
- Sanaz Taheri \<sanaz@status.im\> - Sanaz Taheri \<sanaz@status.im\>
sidebar_position: 11 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. `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. 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.

View File

@@ -10,6 +10,13 @@ contributors:
- Hanno Cornelius \<hanno@status.im\> - Hanno Cornelius \<hanno@status.im\>
sidebar_position: 17 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). 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).

View File

@@ -5,6 +5,8 @@ status: draft
editor: Hanno Cornelius \<hanno@status.im\> editor: Hanno Cornelius \<hanno@status.im\>
sidebar_position: 16 sidebar_position: 16
--- ---
- Status: draft
- Editor: Hanno Cornelius \<hanno@status.im\>
## Introduction ## Introduction

View File

@@ -11,6 +11,14 @@ contributors:
- Hanno Cornelius \<hanno@status.im\> - Hanno Cornelius \<hanno@status.im\>
sidebar_position: 13 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 ## Abstract
This specification explains the `13/WAKU2-STORE` protocol which enables querying of messages received through the relay protocol and This specification explains the `13/WAKU2-STORE` protocol which enables querying of messages received through the relay protocol and

View File

@@ -11,6 +11,14 @@ contributors:
- Oskar Thorén \<oskarth@titanproxy.com\> - Oskar Thorén \<oskarth@titanproxy.com\>
sidebar_position: 10 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 ## Abstract

View File

@@ -8,6 +8,11 @@ contributors:
- Kim De Mey \<kimdemey@status.im\> - Kim De Mey \<kimdemey@status.im\>
sidebar_position: 7 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). This specification describes the encryption, decryption and signing of the content in the [data field used in Waku](../6/waku1.md/#abnf-specification).

View File

@@ -9,6 +9,12 @@ contributors:
- Oskar Thorén \<oskarth@titanproxy.com\> - Oskar Thorén \<oskarth@titanproxy.com\>
sidebar_position: 8 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 ## Abstract

View File

@@ -8,6 +8,11 @@ contributors:
- Oskar Thorén \<oskarth@titanproxy.com\> - Oskar Thorén \<oskarth@titanproxy.com\>
sidebar_position: 9 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 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. be able to connect to any node implementation. The API described is privileged as a node stores the keys of clients.

View File

@@ -10,6 +10,13 @@ contributors:
- Kim De Mey \<kimdemey@status.im\> - Kim De Mey \<kimdemey@status.im\>
sidebar_position: 6 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. 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.