diff --git a/codex/README.md b/codex/README.md index 596d378b6..e6988d52a 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 ab540ad66..0a9b95817 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 1e828ef14..b9135059e 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 2daf80cc4..267bcc84f 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 b16014b8f..80914c2a3 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 1f879f8ad..1a06f6b87 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 4e163e1e0..eeae36b55 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 98dd61bdb..92e57cec7 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 27f6bebd3..e5fdd9451 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 b2658b79e..e7eed383d 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 805b0c869..ef9d17061 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 cf0b97da0..ecc6abbb3 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 bd409165f..2ed3c5f2b 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 63f855496..738c8aa37 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 2fa3946f6..152283162 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 3f3203036..d29e377a7 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 8e3a9ee0a..18a123be1 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 641e97685..4d605e6ee 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 2f20dc19c..1234b5a60 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 dc395774a..988ffaec3 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 7687db293..a3fb4a42b 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 9a1871c1e..0f95c63b0 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 17e503a4e..c6bccc526 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 467da7773..0453294e7 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 5f814a67e..44616b243 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 5ae02c988..95adfdc14 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 30ce4acf8..b3302311a 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 ee47b7af8..70283f867 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 d8b93e1f8..89abd6c03 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 ecccd8112..18caa945f 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 a62d72e36..06ae459d8 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 58ffb01a1..2bd2b7a49 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 ce3a92792..21c0addeb 100644 Binary files a/waku/informational/30/images/adaptive_node_cross_section.jpg and b/waku/informational/30/images/adaptive_node_cross_section.jpg differ diff --git a/waku/informational/30/images/adaptive_node_cross_section2.png b/waku/informational/30/images/adaptive_node_cross_section2.png index e9b1efbc9..d13836cd3 100644 Binary files a/waku/informational/30/images/adaptive_node_cross_section2.png and b/waku/informational/30/images/adaptive_node_cross_section2.png differ diff --git a/waku/informational/30/images/adaptive_node_protocol_selection2.png b/waku/informational/30/images/adaptive_node_protocol_selection2.png index fb8f0b929..8ef67a825 100644 Binary files a/waku/informational/30/images/adaptive_node_protocol_selection2.png and b/waku/informational/30/images/adaptive_node_protocol_selection2.png differ diff --git a/waku/informational/30/images/adaptive_protocol_selection.jpg b/waku/informational/30/images/adaptive_protocol_selection.jpg index 97f8bc589..de04de0ec 100644 Binary files a/waku/informational/30/images/adaptive_protocol_selection.jpg and b/waku/informational/30/images/adaptive_protocol_selection.jpg differ diff --git a/waku/informational/adaptive-nodes.md b/waku/informational/adaptive-nodes.md index c244e1bc2..37636595c 100644 --- a/waku/informational/adaptive-nodes.md +++ b/waku/informational/adaptive-nodes.md @@ -6,6 +6,8 @@ editor: Oskar Thorén \ 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 03bb34b6f..71d736a97 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 0eae009ce..d18f7e34b 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 541ddd6d3..d32c9d8cf 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 dd84f2fab..d7eabb6ab 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 4f0dbb943..5f4cf0a19 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 5b30ba36f..0abf21612 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 bf19c4d52..12eb298b4 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 496ff3519..e6e2772db 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 fc74ea93d..73a1ea5ac 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 a58fa4c47..ab05bac9e 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 907f51eb9..0b95082a7 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 1f96a63e3..6c333ff31 100644 Binary files a/waku/standards/core/17/images/rln-relay.png and b/waku/standards/core/17/images/rln-relay.png differ diff --git a/waku/standards/core/bindings-api.md b/waku/standards/core/bindings-api.md index 549066e85..ddd66c0ea 100644 --- a/waku/standards/core/bindings-api.md +++ b/waku/standards/core/bindings-api.md @@ -7,6 +7,10 @@ contributors: - Franck Royer \ 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 ccd2e1c6a..a9aac7937 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 37a3029da..8517956ec 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 8c24d80e9..ea673b9f3 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 551838cf3..772eb9fb8 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 126417389..31086ec87 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 a02abde66..bd61253ae 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 addb9b2a3..ca91db4fa 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 a9759a6d3..0946fce0a 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 12ebd760f..3d9c451c9 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 6b82fb187..e6fb38c5c 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 e53e8ff6d..6eafeb22c 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 9161dec0d..90822cbc1 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 9eef51136..93e2d712b 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 1cb1b9908..d9b888bc4 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.