From 5e2df2cd2dba062e5a433639605b3f8a47d1a9cb Mon Sep 17 00:00:00 2001 From: jinhojang6 Date: Thu, 28 Mar 2024 02:17:25 +0900 Subject: [PATCH] feat: parse front matter --- codex/README.md | 1 + fetch-content.js | 73 +++++++++++++++++- nomos/README.md | 1 + nomos/claro.md | 5 ++ status/1to1-chat.md | 5 ++ status/README.md | 1 + status/account-address.md | 5 ++ status/communities.md | 5 ++ status/community-history-service.md | 6 ++ status/curation.md | 2 + status/featuring.md | 2 + status/keycard-usage.md | 5 ++ status/payloads.md | 4 + status/push-notification-server.md | 5 ++ status/simple-scaling.md | 5 ++ status/status-waku-usage.md | 5 ++ vac/README.md | 1 + vac/coss.md | 10 +++ vac/eth-secpm.md | 3 + vac/gossipsub-tor-push.md | 3 + vac/libp2p-dns-discovery.md | 2 + vac/mvds-meta.md | 6 ++ vac/mvds.md | 5 ++ vac/raw/README.md | 1 + vac/remote-log.md | 4 + vac/rln-interep-spec.md | 3 + vac/rln-v1.md | 4 + vac/rln-v2.md | 4 + vac/template.md | 3 + waku/README.md | 1 + waku/deprecated/README.md | 1 + waku/deprecated/waku0.md | 7 ++ .../30/images/adaptive_node_cross_section.jpg | Bin 736197 -> 736191 bytes .../images/adaptive_node_cross_section2.png | Bin 145805 -> 145793 bytes .../adaptive_node_protocol_selection2.png | Bin 96393 -> 96389 bytes .../30/images/adaptive_protocol_selection.jpg | Bin 1085786 -> 1085793 bytes waku/informational/adaptive-nodes.md | 2 + waku/informational/config.md | 2 + waku/informational/peers.md | 2 + waku/informational/topics.md | 6 ++ waku/informational/toy-chat.md | 4 + .../application/fault-tolerant-store.md | 2 + waku/standards/application/payload.md | 2 + waku/standards/application/swap.md | 2 + waku/standards/application/toy-eth-pm.md | 2 + waku/standards/application/x3dh-sessions.md | 5 ++ waku/standards/application/x3dh.md | 5 ++ waku/standards/core/12/filter.md | 9 +++ waku/standards/core/17/images/rln-relay.png | Bin 170277 -> 170288 bytes waku/standards/core/bindings-api.md | 4 + waku/standards/core/bridge.md | 2 + waku/standards/core/discv5.md | 2 + waku/standards/core/filter.md | 9 +++ waku/standards/core/lightpush.md | 5 ++ waku/standards/core/message.md | 9 +++ waku/standards/core/relay.md | 5 ++ waku/standards/core/rln-relay.md | 7 ++ waku/standards/core/rpc.md | 2 + waku/standards/core/store.md | 8 ++ waku/standards/core/waku2.md | 8 ++ waku/standards/legacy/data.md | 5 ++ waku/standards/legacy/mail.md | 6 ++ waku/standards/legacy/rpc.md | 5 ++ waku/standards/legacy/waku1.md | 7 ++ 64 files changed, 313 insertions(+), 2 deletions(-) diff --git a/codex/README.md b/codex/README.md index 596d378..e6988d5 100644 --- a/codex/README.md +++ b/codex/README.md @@ -1,3 +1,4 @@ + # Codex RFCs Codex specifications related to a decentralised data storage platform. diff --git a/fetch-content.js b/fetch-content.js index ab540ad..0a9b958 100644 --- a/fetch-content.js +++ b/fetch-content.js @@ -74,8 +74,6 @@ async function fetchDirectoryContents(dirUrl, basePath, prefixToRemove) { function adjustPathForMarkdown(filePath) { const parts = filePath.split('/') - console.log(filePath) - if (parts?.length === 1) 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) { const frontmatterMatch = content.match(/---\s*\n([\s\S]*?)\n---/) if (frontmatterMatch) { @@ -154,6 +221,8 @@ async function downloadAndSaveFile(url, filePath) { // // parse sidebarPosition from the slug in the frontmatter const sidebarPosition = parseSlugFromFrontmatter(content) || 1 + content = enhanceMarkdownWithBulletPointsCorrected(content) + content = updateMarkdownImagePath(content, sidebarPosition) // Insert sidebar_position at the end of frontmatter if it doesn't exist diff --git a/nomos/README.md b/nomos/README.md index 1e828ef..b913505 100644 --- a/nomos/README.md +++ b/nomos/README.md @@ -1,3 +1,4 @@ + # Nomos Request For Comments(RFC) Nomos is building secure, flexible, and scalable infrastructure for developers creating applications for the network state. diff --git a/nomos/claro.md b/nomos/claro.md index 2daf80c..267bcc8 100644 --- a/nomos/claro.md +++ b/nomos/claro.md @@ -12,6 +12,11 @@ contributors: - Mark Evenson sidebar_position: 38 --- +- Status: raw +- Category: Standards Track +- Editor: Corey Petty \ +- Contributors:: + ## Abstract diff --git a/status/1to1-chat.md b/status/1to1-chat.md index b16014b..80914c2 100644 --- a/status/1to1-chat.md +++ b/status/1to1-chat.md @@ -13,6 +13,11 @@ contributors: - Dean Eigenmann \ sidebar_position: 55 --- +- Status: draft +- Category: Standards Track +- Editor: Aaryamann Challani \ +- Contributors:: + ## Abstract diff --git a/status/README.md b/status/README.md index 1f879f8..1a06f6b 100644 --- a/status/README.md +++ b/status/README.md @@ -1,3 +1,4 @@ + # Status RFCs Status is a communitication tool providing privacy features for the user. diff --git a/status/account-address.md b/status/account-address.md index 4e163e1..eeae36b 100644 --- a/status/account-address.md +++ b/status/account-address.md @@ -11,6 +11,11 @@ contributors: - Samuel Hawksby-Robinson \ sidebar_position: 65 --- +- Status: draft +- Category: Standards Track +- Editor: Aaryamann Challani \ +- Contributors:: + ## Abstract diff --git a/status/communities.md b/status/communities.md index 98dd61b..92e57ce 100644 --- a/status/communities.md +++ b/status/communities.md @@ -9,6 +9,11 @@ contributors: - Andrea Piana \ sidebar_position: 56 --- +- Status: draft +- Category: Standards Track +- Editor: Aaryamann Challani \ +- Contributors:: + ## Abstract diff --git a/status/community-history-service.md b/status/community-history-service.md index 27f6beb..e5fdd94 100644 --- a/status/community-history-service.md +++ b/status/community-history-service.md @@ -10,6 +10,12 @@ contributors: - John Lea \ sidebar_position: 61 --- +- Status: draft +- Category: Standards Track +- Editor: r4bbit \ +- Contributors:: + - Sanaz Taheri \ + - John Lea \ ## Abstract diff --git a/status/curation.md b/status/curation.md index b2658b7..e7eed38 100644 --- a/status/curation.md +++ b/status/curation.md @@ -6,6 +6,8 @@ description: A voting protocol for SNT holders to submit votes to a smart contra editor: Szymon Szlachtowicz \ sidebar_position: 24 --- +- Status: draft +- Editor: Szymon Szlachtowicz \ ## Abstract This specification is a voting protocol for peers to submit votes to a smart contract. Voting is immutable, diff --git a/status/featuring.md b/status/featuring.md index 805b0c8..ef9d170 100644 --- a/status/featuring.md +++ b/status/featuring.md @@ -6,6 +6,8 @@ description: To gain new members, current SNT holders can vote to feature an act editor: Szymon Szlachtowicz \ sidebar_position: 28 --- +- Status: draft +- Editor: Szymon Szlachtowicz \ ## Abstract This specification describes a voting method to feature different active Status Communities. diff --git a/status/keycard-usage.md b/status/keycard-usage.md index cf0b97d..ecc6abb 100644 --- a/status/keycard-usage.md +++ b/status/keycard-usage.md @@ -9,6 +9,11 @@ contributors: - Jimmy Debe \ sidebar_position: 63 --- +- Status: draft +- Category: Standards Track +- Editor: Aaryamann Challani \ +- Contributors:: + - Jimmy Debe \ ## Terminology diff --git a/status/payloads.md b/status/payloads.md index bd40916..2ed3c5f 100644 --- a/status/payloads.md +++ b/status/payloads.md @@ -10,6 +10,10 @@ contributors: - Samuel Hawksby-Robinson \ sidebar_position: 62 --- +- Status: draft +- Editor: r4bbit \ +- Contributors:: + ## Abstract diff --git a/status/push-notification-server.md b/status/push-notification-server.md index 63f8554..738c8aa 100644 --- a/status/push-notification-server.md +++ b/status/push-notification-server.md @@ -9,6 +9,11 @@ contributors: - Andrea Maria Piana \ sidebar_position: 71 --- +- Status: draft +- Category: Standards Track +- Editor: Jimmy Debe \ +- Contributors:: + - Andrea Maria Piana \ ## Abstract A push notification server implementation for IOS devices and Android devices. diff --git a/status/simple-scaling.md b/status/simple-scaling.md index 2fa3946..1522831 100644 --- a/status/simple-scaling.md +++ b/status/simple-scaling.md @@ -9,6 +9,11 @@ contributors: - Alvaro Revuelta \ sidebar_position: 57 --- +- Status: raw +- Category: Informational +- Editor: Daniel Kaiser \ +- Contributors:: + ## Abstract diff --git a/status/status-waku-usage.md b/status/status-waku-usage.md index 3f32030..d29e377 100644 --- a/status/status-waku-usage.md +++ b/status/status-waku-usage.md @@ -10,6 +10,11 @@ contributors: sidebar_position: 1 --- +- Status: raw +- Category: Best Current Practice +- Editor: Aaryamann Challani \ +- Contributors:: + ## Abstract diff --git a/vac/README.md b/vac/README.md index 8e3a9ee..18a123b 100644 --- a/vac/README.md +++ b/vac/README.md @@ -1,3 +1,4 @@ + # Vac RFCs Vac builds public good protocols for the decentralise web. diff --git a/vac/coss.md b/vac/coss.md index 641e976..4d605e6 100644 --- a/vac/coss.md +++ b/vac/coss.md @@ -13,6 +13,16 @@ contributors: - Daniel Kaiser \ sidebar_position: 1 --- +- Status: draft +- Category: Best Current Practice +- Editor: Oskar Thoren \ +- Contributors:: + - Pieter Hintjens \ + - André Rebentisch \ + - Alberto Barrionuevo \ + - Chris Puttick \ + - Yurii Rashkovskii \ + - Daniel Kaiser \ 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. diff --git a/vac/eth-secpm.md b/vac/eth-secpm.md index 2f20dc1..1234b5a 100644 --- a/vac/eth-secpm.md +++ b/vac/eth-secpm.md @@ -7,6 +7,9 @@ editor: Ramses Fernandez \ contributors: sidebar_position: 70 --- +- Status: raw +- Category: Standards Track +- Editor: Ramses Fernandez \ ## Motivation The need for secure communications has become paramount. diff --git a/vac/gossipsub-tor-push.md b/vac/gossipsub-tor-push.md index dc39577..988ffae 100644 --- a/vac/gossipsub-tor-push.md +++ b/vac/gossipsub-tor-push.md @@ -7,6 +7,9 @@ editor: Daniel Kaiser \ contributors: sidebar_position: 46 --- +- Status: raw +- Category: Standards Track +- Editor: Daniel Kaiser \ ## Abstract diff --git a/vac/libp2p-dns-discovery.md b/vac/libp2p-dns-discovery.md index 7687db2..a3fb4a4 100644 --- a/vac/libp2p-dns-discovery.md +++ b/vac/libp2p-dns-discovery.md @@ -6,6 +6,8 @@ editor: Hanno Cornelius \ contributors: sidebar_position: 25 --- +- Status: deleted +- Editor: Hanno Cornelius \ `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. diff --git a/vac/mvds-meta.md b/vac/mvds-meta.md index 9a1871c..0f95c63 100644 --- a/vac/mvds-meta.md +++ b/vac/mvds-meta.md @@ -9,6 +9,12 @@ contributors: - Oskar Thorén \ sidebar_position: 4 --- +- Status: draft +- Editor: Sanaz Taheri \ +- Contributors:: + - Dean Eigenmann \ + - Andrea Maria Piana \ + - Oskar Thorén \ 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. diff --git a/vac/mvds.md b/vac/mvds.md index 17e503a..c6bccc5 100644 --- a/vac/mvds.md +++ b/vac/mvds.md @@ -8,6 +8,11 @@ contributors: - Oskar Thorén \ sidebar_position: 2 --- +- Status: stable +- Editor: Sanaz Taheri \ +- Contributors:: + - Dean Eigenmann \ + - Oskar Thorén \ 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. diff --git a/vac/raw/README.md b/vac/raw/README.md index 467da77..0453294 100644 --- a/vac/raw/README.md +++ b/vac/raw/README.md @@ -1,3 +1,4 @@ + # Vac Raw Specifications All Vac specifications that have not reached **draft** status will live in this repository. diff --git a/vac/remote-log.md b/vac/remote-log.md index 5f814a6..44616b2 100644 --- a/vac/remote-log.md +++ b/vac/remote-log.md @@ -7,6 +7,10 @@ contributors: - Dean Eigenmann \ sidebar_position: 3 --- +- Status: draft +- Editor: Oskar Thorén \ +- Contributors:: + - Dean Eigenmann \ 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. diff --git a/vac/rln-interep-spec.md b/vac/rln-interep-spec.md index 5ae02c9..95adfdc 100644 --- a/vac/rln-interep-spec.md +++ b/vac/rln-interep-spec.md @@ -7,6 +7,9 @@ editor: Aaryamann Challani \ contributors: sidebar_position: 48 --- +- Status: raw +- Category: +- Editor: Aaryamann Challani \ ## Abstract diff --git a/vac/rln-v1.md b/vac/rln-v1.md index 30ce4ac..b330231 100644 --- a/vac/rln-v1.md +++ b/vac/rln-v1.md @@ -11,6 +11,10 @@ contributors: - Blagoj Dimovski \ sidebar_position: 32 --- +- Status: raw +- Editor: Rasul Ibragimov \ +- Contributors:: + ## Abstract diff --git a/vac/rln-v2.md b/vac/rln-v2.md index ee47b7a..70283f8 100644 --- a/vac/rln-v2.md +++ b/vac/rln-v2.md @@ -7,6 +7,10 @@ contributors: - Lev Soukhanov \<0xdeadfae@gmail.com\> sidebar_position: 58 --- +- Status: raw +- Editor: Rasul Ibragimov \ +- Contributors:: + ## Abstract diff --git a/vac/template.md b/vac/template.md index d8b93e1..89abd6c 100644 --- a/vac/template.md +++ b/vac/template.md @@ -7,6 +7,9 @@ editor: Daniel Kaiser \ contributors: sidebar_position: 1 --- +- Status: (raw|draft|stable) +- Category: (Standards Track|Informational|Best Current Practice) +- Editor: Daniel Kaiser \ # (Info, remove this section) diff --git a/waku/README.md b/waku/README.md index ecccd81..18caa94 100644 --- a/waku/README.md +++ b/waku/README.md @@ -1,3 +1,4 @@ + # Waku RFCs Waku builds a family of privacy-preserving, censorship-resistant communication protocols for web3 applications. diff --git a/waku/deprecated/README.md b/waku/deprecated/README.md index a62d72e..06ae459 100644 --- a/waku/deprecated/README.md +++ b/waku/deprecated/README.md @@ -1,3 +1,4 @@ + # Deprecated RFCs Deprecated specifications are no longer used in Waku products. diff --git a/waku/deprecated/waku0.md b/waku/deprecated/waku0.md index 58ffb01..2bd2b7a 100644 --- a/waku/deprecated/waku0.md +++ b/waku/deprecated/waku0.md @@ -10,6 +10,13 @@ contributors: - Kim De Mey \ sidebar_position: 5 --- +- Status: deprecated +- Editor: Oskar Thorén \ +- Contributors:: + - Adam Babik \ + - Andrea Maria Piana \ + - Dean Eigenmann \ + - Kim De Mey \ 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. diff --git a/waku/informational/30/images/adaptive_node_cross_section.jpg b/waku/informational/30/images/adaptive_node_cross_section.jpg index ce3a927924c7431b97d49d5a94a4c3f0ecf8bdf2..21c0addeb10c6c0ea4a44ea54c0f4c0ee52b7682 100644 GIT binary patch delta 43 ucmX^5U1$GyorV_17N!>F7M2#)Eo@F_+da;*0Wmuea{w{tc8{}MwRr%Ta1sUp delta 43 ucmdo0UFYa`orV_17N!>F7M2#)Eo@F_+ilLW0Wmuea{w{tcAK+Y&3OQoUJ=j$ diff --git a/waku/informational/30/images/adaptive_node_cross_section2.png b/waku/informational/30/images/adaptive_node_cross_section2.png index e9b1efbc9237691f36e470cd52766852e616063f..d13836cd3bd46c5fd1a58342755f1c6d8774c312 100644 GIT binary patch delta 38 wcmV+>0NMYI^9X_S2(WGm0?VPZbP4HA0@aFxV^_ChR{=L~0^Pf}pvD31a#np2%>V!Z delta 50 ucmZqt%+dRqV?!P%+xz`{foO99=SyEGyE!_1dvrLXc|MfCeabP$w?zQDF&o$b diff --git a/waku/informational/30/images/adaptive_node_protocol_selection2.png b/waku/informational/30/images/adaptive_node_protocol_selection2.png index fb8f0b929f1c593c89794cfe2d97e1d8ab51117a..8ef67a8252cc5a907ce25664d18a67ddc8bf3bbc 100644 GIT binary patch delta 20 bcmeDD$lCgmwP6dRlO@x&wc9-`86E8bT}%h* delta 24 ecmZqu$lCdlwP6dRlO@~x{d<9EyNe~GqdfqU{tG++ diff --git a/waku/informational/30/images/adaptive_protocol_selection.jpg b/waku/informational/30/images/adaptive_protocol_selection.jpg index 97f8bc589f5da9815ac333937a3d50e62b74e67d..de04de0ec4d9df3b67fb622e1c3f2935e9029b2a 100644 GIT binary patch delta 88 zcmcb$$m!uCr-l~B7N!>F7M2#)7Pc1l7LF~PmnKe+nZe01-QheJ%l6w7IS)LWu6lz- oXgY5pJNx!E6F7M2#)7Pc1l7LF~PmnJgpn7IA=M9$;SSUyf!yL|hq3a%*k j>DQ*R2~5}f%*56%c7O|rxq+Amh contributors: sidebar_position: 30 --- +- Status: draft +- Editor: Oskar Thorén \ This is an informational spec that show cases the concept of adaptive nodes. diff --git a/waku/informational/config.md b/waku/informational/config.md index 03bb34b..71d736a 100644 --- a/waku/informational/config.md +++ b/waku/informational/config.md @@ -6,6 +6,8 @@ editor: Hanno Cornelius \ contributors: sidebar_position: 29 --- +- Status: draft +- Editor: Hanno Cornelius \ `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), diff --git a/waku/informational/peers.md b/waku/informational/peers.md index 0eae009..d18f7e3 100644 --- a/waku/informational/peers.md +++ b/waku/informational/peers.md @@ -6,6 +6,8 @@ editor: Hanno Cornelius \ contributors: sidebar_position: 27 --- +- Status: draft +- Editor: Hanno Cornelius \ `27/WAKU2-PEERS` describes a recommended minimal set of peer storage and peer management features to be implemented by Waku v2 clients. diff --git a/waku/informational/topics.md b/waku/informational/topics.md index 541ddd6..d32c9d8 100644 --- a/waku/informational/topics.md +++ b/waku/informational/topics.md @@ -9,6 +9,12 @@ contributors: - Daniel Kaiser \ sidebar_position: 23 --- +- Status: draft +- Category: Informational +- Editor: Oskar Thoren \ +- Contributors:: + - Hanno Cornelius \ + - Daniel Kaiser \ 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: diff --git a/waku/informational/toy-chat.md b/waku/informational/toy-chat.md index dd84f2f..d7eabb6 100644 --- a/waku/informational/toy-chat.md +++ b/waku/informational/toy-chat.md @@ -7,6 +7,10 @@ contributors: - Hanno Cornelius \ sidebar_position: 22 --- +- Status: draft +- Editor: Franck Royer \ +- Contributors:: + **Content Topic**: `/toy-chat/2/huilong/proto`. diff --git a/waku/standards/application/fault-tolerant-store.md b/waku/standards/application/fault-tolerant-store.md index 4f0dbb9..5f4cf0a 100644 --- a/waku/standards/application/fault-tolerant-store.md +++ b/waku/standards/application/fault-tolerant-store.md @@ -6,6 +6,8 @@ editor: Sanaz Taheri \ contributors: sidebar_position: 21 --- +- Status: draft +- Editor: Sanaz Taheri \ 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. diff --git a/waku/standards/application/payload.md b/waku/standards/application/payload.md index 5b30ba3..0abf216 100644 --- a/waku/standards/application/payload.md +++ b/waku/standards/application/payload.md @@ -6,6 +6,8 @@ editor: Oskar Thoren \ contributors: sidebar_position: 26 --- +- Status: draft +- Editor: Oskar Thoren \ 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). diff --git a/waku/standards/application/swap.md b/waku/standards/application/swap.md index bf19c4d..12eb298 100644 --- a/waku/standards/application/swap.md +++ b/waku/standards/application/swap.md @@ -6,6 +6,8 @@ editor: Oskar Thorén \ contributor: Ebube Ud \ sidebar_position: 18 --- +- Status: draft +- Editor: Oskar Thorén \ ## Abstract diff --git a/waku/standards/application/toy-eth-pm.md b/waku/standards/application/toy-eth-pm.md index 496ff35..e6e2772 100644 --- a/waku/standards/application/toy-eth-pm.md +++ b/waku/standards/application/toy-eth-pm.md @@ -6,6 +6,8 @@ editor: Franck Royer \ contributors: sidebar_position: 20 --- +- Status: draft +- Editor: Franck Royer \ **Content Topics**: diff --git a/waku/standards/application/x3dh-sessions.md b/waku/standards/application/x3dh-sessions.md index fc74ea9..73a1ea5 100644 --- a/waku/standards/application/x3dh-sessions.md +++ b/waku/standards/application/x3dh-sessions.md @@ -12,6 +12,11 @@ contributors: - Dean Eigenmann \ sidebar_position: 54 --- +- Status: draft +- Category: Standards Track +- Editor: Aaryamann Challani \ +- Contributors:: + ## Abstract diff --git a/waku/standards/application/x3dh.md b/waku/standards/application/x3dh.md index a58fa4c..ab05bac 100644 --- a/waku/standards/application/x3dh.md +++ b/waku/standards/application/x3dh.md @@ -12,6 +12,11 @@ contributors: - Dean Eigenmann \ sidebar_position: 53 --- +- Status: draft +- Category: Standards Track +- Editor: Aaryamann Challani \ +- Contributors:: + ## Abstract diff --git a/waku/standards/core/12/filter.md b/waku/standards/core/12/filter.md index 907f51e..0b95082 100644 --- a/waku/standards/core/12/filter.md +++ b/waku/standards/core/12/filter.md @@ -10,6 +10,15 @@ contributors: - Ebube Ud \ sidebar_position: 12 --- +- Status: draft +- Editor: Hanno Cornelius \ +- Contributors:: + - Dean Eigenmann \ + - Oskar Thorén \ + - Sanaz Taheri \ + - Ebube Ud \ +- Contributors:: + version: 00 --- diff --git a/waku/standards/core/17/images/rln-relay.png b/waku/standards/core/17/images/rln-relay.png index 1f96a63e36377f050759b0e2423cd9cf90f42df5..6c333ff31930a490f5222b78ff44c22c6a642941 100644 GIT binary patch delta 43 rcmZ3wiE9H8ML2E_b^J1k?fw3}K(yKWifjRt-Ja#bxIN2-X?F+!{s sidebar_position: 36 --- +- Status: draft +- Editor: Richard Ramos \ +- Contributors:: + # Introduction diff --git a/waku/standards/core/bridge.md b/waku/standards/core/bridge.md index ccd2e1c..a9aac79 100644 --- a/waku/standards/core/bridge.md +++ b/waku/standards/core/bridge.md @@ -5,6 +5,8 @@ status: draft editor: Hanno Cornelius \ sidebar_position: 15 --- +- Status: draft +- Editor: Hanno Cornelius \ A bridge between Waku v1 and Waku v2. diff --git a/waku/standards/core/discv5.md b/waku/standards/core/discv5.md index 37a3029..8517956 100644 --- a/waku/standards/core/discv5.md +++ b/waku/standards/core/discv5.md @@ -6,6 +6,8 @@ editor: Daniel Kaiser \ contributors: sidebar_position: 33 --- +- Status: draft +- Editor: Daniel Kaiser \ ## Abstract diff --git a/waku/standards/core/filter.md b/waku/standards/core/filter.md index 8c24d80..ea673b9 100644 --- a/waku/standards/core/filter.md +++ b/waku/standards/core/filter.md @@ -11,6 +11,15 @@ contributors: - Ebube Ud \ sidebar_position: 12 --- +- Status: draft +- Editor: Hanno Cornelius \ +- Contributors:: + - Dean Eigenmann \ + - Oskar Thorén \ + - Sanaz Taheri \ + - Ebube Ud \ +- Contributors:: + previous versions: [00](./previous-versions00) diff --git a/waku/standards/core/lightpush.md b/waku/standards/core/lightpush.md index 551838c..772eb9f 100644 --- a/waku/standards/core/lightpush.md +++ b/waku/standards/core/lightpush.md @@ -8,6 +8,11 @@ contributors: - Oskar Thorén \ sidebar_position: 19 --- +- Status: draft +- Editor: Hanno Cornelius \ +- Contributors:: + - Daniel Kaiser \ + - Oskar Thorén \ **Protocol identifier**: `/vac/waku/lightpush/2.0.0-beta1` diff --git a/waku/standards/core/message.md b/waku/standards/core/message.md index 1264173..31086ec 100644 --- a/waku/standards/core/message.md +++ b/waku/standards/core/message.md @@ -12,6 +12,15 @@ contributors: - Oskar Thorén \ sidebar_position: 14 --- +- Status: draft +- Category: Standards Track +- Editor: Hanno Cornelius \ +- Contributors:: + - Sanaz Taheri \ + - Aaryamann Challani \ + - Lorenzo Delgado \ + - Abhimanyu Rawat \ + - Oskar Thorén \ ## Abstract diff --git a/waku/standards/core/relay.md b/waku/standards/core/relay.md index a02abde..bd61253 100644 --- a/waku/standards/core/relay.md +++ b/waku/standards/core/relay.md @@ -8,6 +8,11 @@ contributors: - Sanaz Taheri \ sidebar_position: 11 --- +- Status: stable +- Editor: Hanno Cornelius \ +- Contributors:: + - Oskar Thorén \ + - Sanaz Taheri \ `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. diff --git a/waku/standards/core/rln-relay.md b/waku/standards/core/rln-relay.md index addb9b2..ca91db4 100644 --- a/waku/standards/core/rln-relay.md +++ b/waku/standards/core/rln-relay.md @@ -10,6 +10,13 @@ contributors: - Hanno Cornelius \ sidebar_position: 17 --- +- Status: draft +- Editor: Alvaro Revuelta \ +- Contributors:: + - Oskar Thorén \ + - Aaryamann Challani \ + - Sanaz Taheri \ + - Hanno Cornelius \ 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). diff --git a/waku/standards/core/rpc.md b/waku/standards/core/rpc.md index a9759a6..0946fce 100644 --- a/waku/standards/core/rpc.md +++ b/waku/standards/core/rpc.md @@ -5,6 +5,8 @@ status: draft editor: Hanno Cornelius \ sidebar_position: 16 --- +- Status: draft +- Editor: Hanno Cornelius \ ## Introduction diff --git a/waku/standards/core/store.md b/waku/standards/core/store.md index 12ebd76..3d9c451 100644 --- a/waku/standards/core/store.md +++ b/waku/standards/core/store.md @@ -11,6 +11,14 @@ contributors: - Hanno Cornelius \ sidebar_position: 13 --- +- Status: draft +- Editor: Simon-Pierre Vivier \ +- Contributors:: + - Dean Eigenmann \ + - Oskar Thorén \ + - Aaryamann Challani \ + - Sanaz Taheri \ + - Hanno Cornelius \ ## Abstract This specification explains the `13/WAKU2-STORE` protocol which enables querying of messages received through the relay protocol and diff --git a/waku/standards/core/waku2.md b/waku/standards/core/waku2.md index 6b82fb1..e6fb38c 100644 --- a/waku/standards/core/waku2.md +++ b/waku/standards/core/waku2.md @@ -11,6 +11,14 @@ contributors: - Oskar Thorén \ sidebar_position: 10 --- +- Status: draft +- Editor: Hanno Cornelius \ +- Contributors:: + - Sanaz Taheri \ + - Hanno Cornelius \ + - Reeshav Khan \ + - Daniel Kaiser \ + - Oskar Thorén \ ## Abstract diff --git a/waku/standards/legacy/data.md b/waku/standards/legacy/data.md index e53e8ff..6eafeb2 100644 --- a/waku/standards/legacy/data.md +++ b/waku/standards/legacy/data.md @@ -8,6 +8,11 @@ contributors: - Kim De Mey \ sidebar_position: 7 --- +- Status: stable +- Editor: Oskar Thorén \ +- Contributors:: + - Dean Eigenmann \ + - Kim De Mey \ This specification describes the encryption, decryption and signing of the content in the [data field used in Waku](../6/waku1.md/#abnf-specification). diff --git a/waku/standards/legacy/mail.md b/waku/standards/legacy/mail.md index 9161dec..90822cb 100644 --- a/waku/standards/legacy/mail.md +++ b/waku/standards/legacy/mail.md @@ -9,6 +9,12 @@ contributors: - Oskar Thorén \ sidebar_position: 8 --- +- Status: stable +- Editor: Andrea Maria Piana \ +- Contributors:: + - Adam Babik \ + - Dean Eigenmann \ + - Oskar Thorén \ ## Abstract diff --git a/waku/standards/legacy/rpc.md b/waku/standards/legacy/rpc.md index 9eef511..93e2d71 100644 --- a/waku/standards/legacy/rpc.md +++ b/waku/standards/legacy/rpc.md @@ -8,6 +8,11 @@ contributors: - Oskar Thorén \ sidebar_position: 9 --- +- Status: stable +- Editor: Andrea Maria Piana \ +- Contributors:: + - Dean Eigenmann \ + - Oskar Thorén \ 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. diff --git a/waku/standards/legacy/waku1.md b/waku/standards/legacy/waku1.md index 1cb1b99..d9b888b 100644 --- a/waku/standards/legacy/waku1.md +++ b/waku/standards/legacy/waku1.md @@ -10,6 +10,13 @@ contributors: - Kim De Mey \ sidebar_position: 6 --- +- Status: stable +- Editor: Oskar Thorén \ +- Contributors:: + - Adam Babik \ + - Andrea Maria Piana \ + - Dean Eigenmann \ + - Kim De Mey \ 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.