diff --git a/.github/workflows/.markdownlint.json b/.github/workflows/.markdownlint.json index 6103c8c..9690186 100644 --- a/.github/workflows/.markdownlint.json +++ b/.github/workflows/.markdownlint.json @@ -3,4 +3,4 @@ "MD024": false, "MD025": false, "MD033": false -} \ No newline at end of file +} diff --git a/custom.css b/custom.css index 50970be..338f06e 100644 --- a/custom.css +++ b/custom.css @@ -75,30 +75,12 @@ main h1, main h2, main h3, main h4 { margin-bottom: 0.6em; } -.rfc-meta { +main h1 + table { margin: 1rem 0 1.5rem 0; - padding: 0.75rem 1rem; - border: 1px solid var(--table-border-color); - background: var(--bg); } -.rfc-meta table { - margin: 0; - border: none; -} - -.rfc-meta th, -.rfc-meta td { - border: none; - padding: 0.2rem 0.4rem 0.2rem 0; - text-align: left; - vertical-align: top; -} - -.rfc-meta th { +main h1 + table th { width: 10rem; - color: var(--sidebar-fg); - font-weight: 600; } main p, main li { @@ -311,3 +293,42 @@ main h1 { min-width: 0; } } + + +.menu-title-link { + position: absolute; + left: 50%; + transform: translateX(-50%); + text-decoration: none; + color: inherit; +} + +.menu-title-link .menu-title { + text-decoration: none; +} + +.chapter-item > .chapter-link-wrapper > a { + display: flex; + align-items: center; + gap: 0.4rem; +} + +.section-toggle::before { + content: "▸"; + display: inline-block; + font-size: 0.9em; + line-height: 1; + transition: transform 0.15s ease; +} + +.chapter-item:not(.collapsed) > a .section-toggle::before { + transform: rotate(90deg); +} + +.chapter-item.collapsed > ol.section { + display: none; +} + +.chapter-item.collapsed > .chapter-link-wrapper > a .section-toggle::before { + transform: rotate(0deg); +} diff --git a/docs/README.md b/docs/README.md index b70131f..5782de8 100644 --- a/docs/README.md +++ b/docs/README.md @@ -24,14 +24,6 @@ An IETF-style index of Vac-managed RFCs across Waku, Nomos, Codex, and Status. U Codex -
- 1/COSS (Process) - Vac index - Waku index - Status index - Nomos index - Codex index -
diff --git a/docs/codex/raw/codex-block-exchange.md b/docs/codex/raw/codex-block-exchange.md index 22175a5..b80da41 100644 --- a/docs/codex/raw/codex-block-exchange.md +++ b/docs/codex/raw/codex-block-exchange.md @@ -1,14 +1,13 @@ # CODEX-BLOCK-EXCHANGE -
- - - - - - -
NameCodex Block Exchange Protocol
Statusraw
CategoryStandards Track
EditorCodex Team
ContributorsFilip Dimitrijevic <filip@status.im>
-
+| Field | Value | +| --- | --- | +| Name | Codex Block Exchange Protocol | +| Status | raw | +| Category | Standards Track | +| Editor | Codex Team | +| Contributors | Filip Dimitrijevic | + ## Specification Status This specification contains a mix of: diff --git a/docs/codex/raw/codex-marketplace.md b/docs/codex/raw/codex-marketplace.md index df6cc0a..a9d0aa9 100644 --- a/docs/codex/raw/codex-marketplace.md +++ b/docs/codex/raw/codex-marketplace.md @@ -1,15 +1,14 @@ # CODEX-MARKETPLACE -
- - - - - - - -
NameCodex Storage Marketplace
Slugcodex-marketplace
Statusraw
CategoryStandards Track
EditorCodex Team and Dmitriy Ryajov <dryajov@status.im>
ContributorsMark Spanbroek <mark@codex.storage>
Adam Uhlíř <adam@codex.storage>
Eric Mastro <eric@codex.storage>
Jimmy Debe <jimmy@status.im>
Filip Dimitrijevic <filip@status.im>
-
+| Field | Value | +| --- | --- | +| Name | Codex Storage Marketplace | +| Slug | codex-marketplace | +| Status | raw | +| Category | Standards Track | +| Editor | Codex Team and Dmitriy Ryajov | +| Contributors | Mark Spanbroek , Adam Uhlíř , Eric Mastro , Jimmy Debe , Filip Dimitrijevic | + ## Abstract Codex Marketplace and its interactions are defined by a smart contract deployed on an EVM-compatible blockchain. This specification describes these interactions for the various roles within the network. diff --git a/docs/nomos/deprecated/claro.md b/docs/nomos/deprecated/claro.md index 5fd8dd9..f64a2d3 100644 --- a/docs/nomos/deprecated/claro.md +++ b/docs/nomos/deprecated/claro.md @@ -1,14 +1,13 @@ # CONSENSUS-CLARO -
- - - - - - -
NameClaro Consensus Protocol
Statusdeprecated
CategoryStandards Track
EditorCorey Petty <corey@status.im>
ContributorsÁlvaro Castro-Castilla
Mark Evenson
-
+| Field | Value | +| --- | --- | +| Name | Claro Consensus Protocol | +| Status | deprecated | +| Category | Standards Track | +| Editor | Corey Petty | +| Contributors | Álvaro Castro-Castilla, Mark Evenson | + ## Abstract This document specifies Claro: a Byzantine, fault-tolerant, binary decision diff --git a/docs/nomos/raw/nomosda-encoding.md b/docs/nomos/raw/nomosda-encoding.md index 7b4265a..b85e05e 100644 --- a/docs/nomos/raw/nomosda-encoding.md +++ b/docs/nomos/raw/nomosda-encoding.md @@ -1,13 +1,12 @@ # NOMOSDA-ENCODING -
- - - - - -
NameNomosDA Encoding Protocol
Statusraw
EditorDaniel Sanchez-Quiros <danielsq@status.im>
ContributorsDaniel Kashepava <danielkashepava@status.im>
Álvaro Castro-Castilla <alvaro@status.im>
Filip Dimitrijevic <filip@status.im>
Thomas Lavaur <thomaslavaur@status.im>
Mehmet Gonen <mehmet@status.im>
-
+| Field | Value | +| --- | --- | +| Name | NomosDA Encoding Protocol | +| Status | raw | +| Editor | Daniel Sanchez-Quiros | +| Contributors | Daniel Kashepava , Álvaro Castro-Castilla , Filip Dimitrijevic , Thomas Lavaur , Mehmet Gonen | + ## Introduction This document describes the encoding and verification processes of NomosDA, which is the data availability (DA) solution used by the Nomos blockchain. NomosDA provides an assurance that all data from Nomos blobs are accessible and verifiable by every network participant. diff --git a/docs/nomos/raw/nomosda-network.md b/docs/nomos/raw/nomosda-network.md index 8376790..a804ddd 100644 --- a/docs/nomos/raw/nomosda-network.md +++ b/docs/nomos/raw/nomosda-network.md @@ -1,13 +1,12 @@ # NOMOS-DA-NETWORK -
- - - - - -
NameNomosDA Network
Statusraw
EditorDaniel Sanchez Quiros <danielsq@status.im>
ContributorsÁlvaro Castro-Castilla <alvaro@status.im>
Daniel Kashepava <danielkashepava@status.im>
Gusto Bacvinka <augustinas@status.im>
Filip Dimitrijevic <filip@status.im>
-
+| Field | Value | +| --- | --- | +| Name | NomosDA Network | +| Status | raw | +| Editor | Daniel Sanchez Quiros | +| Contributors | Álvaro Castro-Castilla , Daniel Kashepava , Gusto Bacvinka , Filip Dimitrijevic | + ## Introduction NomosDA is the scalability solution protocol for data availability within the Nomos network. diff --git a/docs/nomos/raw/p2p-hardware-requirements.md b/docs/nomos/raw/p2p-hardware-requirements.md index 5b59e1b..ee36e65 100644 --- a/docs/nomos/raw/p2p-hardware-requirements.md +++ b/docs/nomos/raw/p2p-hardware-requirements.md @@ -1,14 +1,13 @@ # P2P-HARDWARE-REQUIREMENTS -
- - - - - - -
NameNomos p2p Network Hardware Requirements Specification
Statusraw
Categoryinfrastructure
EditorDaniel Sanchez-Quiros <danielsq@status.im>
ContributorsFilip Dimitrijevic <filip@status.im>
-
+| Field | Value | +| --- | --- | +| Name | Nomos p2p Network Hardware Requirements Specification | +| Status | raw | +| Category | infrastructure | +| Editor | Daniel Sanchez-Quiros | +| Contributors | Filip Dimitrijevic | + ## Abstract This specification defines the hardware requirements for running various types of Nomos blockchain nodes. Hardware needs vary significantly based on the node's role, from lightweight verification nodes to high-performance Zone Executors. The requirements are designed to support diverse participation levels while ensuring network security and performance. diff --git a/docs/nomos/raw/p2p-nat-solution.md b/docs/nomos/raw/p2p-nat-solution.md index 005bc02..ca37e2d 100644 --- a/docs/nomos/raw/p2p-nat-solution.md +++ b/docs/nomos/raw/p2p-nat-solution.md @@ -1,14 +1,13 @@ # P2P-NAT-SOLUTION -
- - - - - - -
NameNomos P2P Network NAT Solution Specification
Statusraw
Categorynetworking
EditorAntonio Antonino <antonio@status.im>
ContributorsÁlvaro Castro-Castilla <alvaro@status.im>
Daniel Sanchez-Quiros <danielsq@status.im>
Petar Radovic <petar@status.im>
Gusto Bacvinka <augustinas@status.im>
Youngjoon Lee <youngjoon@status.im>
Filip Dimitrijevic <filip@status.im>
-
+| Field | Value | +| --- | --- | +| Name | Nomos P2P Network NAT Solution Specification | +| Status | raw | +| Category | networking | +| Editor | Antonio Antonino | +| Contributors | Álvaro Castro-Castilla , Daniel Sanchez-Quiros , Petar Radovic , Gusto Bacvinka , Youngjoon Lee , Filip Dimitrijevic | + ## Abstract This specification defines a comprehensive NAT (Network Address Translation) traversal solution for the Nomos P2P network. The solution enables nodes to automatically determine their NAT status and establish both outbound and inbound connections regardless of network configuration. The strategy combines [AutoNAT](https://github.com/libp2p/specs/blob/master/autonat/autonat-v2.md), dynamic port mapping protocols, and continuous verification to maximize public reachability while maintaining decentralized operation. diff --git a/docs/nomos/raw/p2p-network-bootstrapping.md b/docs/nomos/raw/p2p-network-bootstrapping.md index 11758ff..44a4cc0 100644 --- a/docs/nomos/raw/p2p-network-bootstrapping.md +++ b/docs/nomos/raw/p2p-network-bootstrapping.md @@ -1,14 +1,13 @@ # P2P-NETWORK-BOOTSTRAPPING -
- - - - - - -
NameNomos P2P Network Bootstrapping Specification
Statusraw
Categorynetworking
EditorDaniel Sanchez-Quiros <danielsq@status.im>
ContributorsÁlvaro Castro-Castilla <alvaro@status.im>
Petar Radovic <petar@status.im>
Gusto Bacvinka <augustinas@status.im>
Antonio Antonino <antonio@status.im>
Youngjoon Lee <youngjoon@status.im>
Filip Dimitrijevic <filip@status.im>
-
+| Field | Value | +| --- | --- | +| Name | Nomos P2P Network Bootstrapping Specification | +| Status | raw | +| Category | networking | +| Editor | Daniel Sanchez-Quiros | +| Contributors | Álvaro Castro-Castilla , Petar Radovic , Gusto Bacvinka , Antonio Antonino , Youngjoon Lee , Filip Dimitrijevic | + ## Introduction Nomos network bootstrapping is the process by which a new node discovers peers and synchronizes with the existing decentralized network. It ensures that a node can: diff --git a/docs/nomos/raw/p2p-network.md b/docs/nomos/raw/p2p-network.md index a67b43a..a581592 100644 --- a/docs/nomos/raw/p2p-network.md +++ b/docs/nomos/raw/p2p-network.md @@ -1,14 +1,13 @@ # NOMOS-P2P-NETWORK -
- - - - - - -
NameNomos P2P Network Specification
Statusdraft
Categorynetworking
EditorDaniel Sanchez-Quiros <danielsq@status.im>
ContributorsFilip Dimitrijevic <filip@status.im>
-
+| Field | Value | +| --- | --- | +| Name | Nomos P2P Network Specification | +| Status | draft | +| Category | networking | +| Editor | Daniel Sanchez-Quiros | +| Contributors | Filip Dimitrijevic | + ## Abstract This specification defines the peer-to-peer (P2P) network layer for Nomos blockchain nodes. The network serves as the comprehensive communication infrastructure enabling transaction dissemination through mempool and block propagation. The specification leverages established libp2p protocols to ensure robust, scalable performance with low bandwidth requirements and minimal latency while maintaining accessibility for diverse hardware configurations and network environments. diff --git a/docs/nomos/raw/sdp.md b/docs/nomos/raw/sdp.md index 61965a1..5ff70ca 100644 --- a/docs/nomos/raw/sdp.md +++ b/docs/nomos/raw/sdp.md @@ -1,13 +1,12 @@ # NOMOS-SDP -
- - - - - -
NameNomos Service Declaration Protocol Specification
Statusraw
EditorMarcin Pawlowski <marcin@status.im>
ContributorsMehmet <mehmet@status.im>
Daniel Sanchez Quiros <danielsq@status.im>
Álvaro Castro-Castilla <alvaro@status.im>
Thomas Lavaur <thomaslavaur@status.im>
Filip Dimitrijevic <filip@status.im>
Gusto Bacvinka <augustinas@status.im>
David Rusu <davidrusu@status.im>
-
+| Field | Value | +| --- | --- | +| Name | Nomos Service Declaration Protocol Specification | +| Status | raw | +| Editor | Marcin Pawlowski | +| Contributors | Mehmet , Daniel Sanchez Quiros , Álvaro Castro-Castilla , Thomas Lavaur , Filip Dimitrijevic , Gusto Bacvinka , David Rusu | + ## Introduction This document defines a mechanism enabling validators to declare their participation in specific protocols that require a known and agreed-upon list of participants. Some examples of this are Data Availability and the Blend Network. We create a single repository of identifiers which is used to establish secure communication between validators and provide services. Before being admitted to the repository, the validator proves that it locked at least a minimum stake. diff --git a/docs/status/24/curation.md b/docs/status/24/curation.md index 5b8104e..0224480 100644 --- a/docs/status/24/curation.md +++ b/docs/status/24/curation.md @@ -1,13 +1,12 @@ # 24/STATUS-CURATION -
- - - - - -
NameStatus Community Directory Curation Voting using Waku v2
Slug24
Statusdraft
EditorSzymon Szlachtowicz <szymon.s@ethworks.io>
-
+| Field | Value | +| --- | --- | +| Name | Status Community Directory Curation Voting using Waku v2 | +| Slug | 24 | +| Status | draft | +| Editor | Szymon Szlachtowicz | + ## Abstract This specification is a voting protocol for peers to submit votes to a smart contract. diff --git a/docs/status/28/featuring.md b/docs/status/28/featuring.md index 78227e9..2cd89ab 100644 --- a/docs/status/28/featuring.md +++ b/docs/status/28/featuring.md @@ -1,13 +1,12 @@ # 28/STATUS-FEATURING -
- - - - - -
NameStatus community featuring using waku v2
Slug28
Statusdraft
EditorSzymon Szlachtowicz <szymon.s@ethworks.io>
-
+| Field | Value | +| --- | --- | +| Name | Status community featuring using waku v2 | +| Slug | 28 | +| Status | draft | +| Editor | Szymon Szlachtowicz | + ## Abstract This specification describes a voting method to feature different active Status Communities. diff --git a/docs/status/55/1to1-chat.md b/docs/status/55/1to1-chat.md index 67c3318..00fbdda 100644 --- a/docs/status/55/1to1-chat.md +++ b/docs/status/55/1to1-chat.md @@ -1,15 +1,14 @@ # 55/STATUS-1TO1-CHAT -
- - - - - - - -
NameStatus 1-to-1 Chat
Slug55
Statusdraft
CategoryStandards Track
EditorAaryamann Challani <p1ge0nh8er@proton.me>
ContributorsAndrea Piana <andreap@status.im>
Pedro Pombeiro <pedro@status.im>
Corey Petty <corey@status.im>
Oskar Thorén <oskarth@titanproxy.com>
Dean Eigenmann <dean@status.im>
-
+| Field | Value | +| --- | --- | +| Name | Status 1-to-1 Chat | +| Slug | 55 | +| Status | draft | +| Category | Standards Track | +| Editor | Aaryamann Challani | +| Contributors | Andrea Piana , Pedro Pombeiro , Corey Petty , Oskar Thorén , Dean Eigenmann | + ## Abstract This specification describes how the Status 1-to-1 chat protocol is implemented diff --git a/docs/status/56/communities.md b/docs/status/56/communities.md index 0948e21..ebed7fe 100644 --- a/docs/status/56/communities.md +++ b/docs/status/56/communities.md @@ -1,15 +1,14 @@ # 56/STATUS-COMMUNITIES -
- - - - - - - -
NameStatus Communities that run over Waku v2
Slug56
Statusdraft
CategoryStandards Track
EditorAaryamann Challani <p1ge0nh8er@proton.me>
ContributorsAndrea Piana <andreap@status.im>
Prem Chaitanya Prathi <prem@waku.org>
-
+| Field | Value | +| --- | --- | +| Name | Status Communities that run over Waku v2 | +| Slug | 56 | +| Status | draft | +| Category | Standards Track | +| Editor | Aaryamann Challani | +| Contributors | Andrea Piana , Prem Chaitanya Prathi | + ## Abstract This document describes the design of Status Communities over Waku v2, diff --git a/docs/status/61/community-history-service.md b/docs/status/61/community-history-service.md index 0e39657..8e9214f 100644 --- a/docs/status/61/community-history-service.md +++ b/docs/status/61/community-history-service.md @@ -1,15 +1,14 @@ # 61/STATUS-Community-History-Service -
- - - - - - - -
NameStatus Community History Service
Slug61
Statusdraft
CategoryStandards Track
Editorr4bbit <r4bbit@status.im>
ContributorsSanaz Taheri <sanaz@status.im>
John Lea <john@status.im>
-
+| Field | Value | +| --- | --- | +| Name | Status Community History Service | +| Slug | 61 | +| Status | draft | +| Category | Standards Track | +| Editor | r4bbit | +| Contributors | Sanaz Taheri , John Lea | + ## Abstract Messages are stored permanently by store nodes diff --git a/docs/status/62/payloads.md b/docs/status/62/payloads.md index 505ac1f..a5c4e56 100644 --- a/docs/status/62/payloads.md +++ b/docs/status/62/payloads.md @@ -1,14 +1,13 @@ # 62/STATUS-PAYLOADS -
- - - - - - -
NameStatus Message Payloads
Slug62
Statusdraft
Editorr4bbit <r4bbit@status.im>
ContributorsAdam Babik <adam@status.im>
Andrea Maria Piana <andreap@status.im>
Oskar Thoren <oskarth@titanproxy.com>
Samuel Hawksby-Robinson <samuel@status.im>
-
+| Field | Value | +| --- | --- | +| Name | Status Message Payloads | +| Slug | 62 | +| Status | draft | +| Editor | r4bbit | +| Contributors | Adam Babik , Andrea Maria Piana , Oskar Thoren , Samuel Hawksby-Robinson | + ## Abstract This specification describes how the payload of each message in Status looks diff --git a/docs/status/63/keycard-usage.md b/docs/status/63/keycard-usage.md index 9a1c39f..e6425bc 100644 --- a/docs/status/63/keycard-usage.md +++ b/docs/status/63/keycard-usage.md @@ -1,15 +1,14 @@ # 63/STATUS-Keycard-Usage -
- - - - - - - -
NameStatus Keycard Usage
Slug63
Statusdraft
CategoryStandards Track
EditorAaryamann Challani <p1ge0nh8er@proton.me>
ContributorsJimmy Debe <jimmy@status.im>
-
+| Field | Value | +| --- | --- | +| Name | Status Keycard Usage | +| Slug | 63 | +| Status | draft | +| Category | Standards Track | +| Editor | Aaryamann Challani | +| Contributors | Jimmy Debe | + ## Terminology - **Account**: A valid diff --git a/docs/status/65/account-address.md b/docs/status/65/account-address.md index d57c91c..dca03fa 100644 --- a/docs/status/65/account-address.md +++ b/docs/status/65/account-address.md @@ -1,15 +1,14 @@ # 65/STATUS-ACCOUNT-ADDRESS -
- - - - - - - -
NameStatus Account Address
Slug65
Statusdraft
CategoryStandards Track
EditorAaryamann Challani <p1ge0nh8er@proton.me>
ContributorsCorey Petty <corey@status.im>
Oskar Thorén <oskarth@titanproxy.com>
Samuel Hawksby-Robinson <samuel@status.im>
-
+| Field | Value | +| --- | --- | +| Name | Status Account Address | +| Slug | 65 | +| Status | draft | +| Category | Standards Track | +| Editor | Aaryamann Challani | +| Contributors | Corey Petty , Oskar Thorén , Samuel Hawksby-Robinson | + ## Abstract This specification details what a Status account address is and diff --git a/docs/status/71/push-notification-server.md b/docs/status/71/push-notification-server.md index 4c6cd07..5fdb0d6 100644 --- a/docs/status/71/push-notification-server.md +++ b/docs/status/71/push-notification-server.md @@ -1,15 +1,14 @@ # 71/STATUS-PUSH-NOTIFICATION-SERVER -
- - - - - - - -
NamePush Notification Server
Slug71
Statusdraft
CategoryStandards Track
EditorJimmy Debe <jimmy@status.im>
ContributorsAndrea Maria Piana <andreap@status.im>
-
+| Field | Value | +| --- | --- | +| Name | Push Notification Server | +| Slug | 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/docs/status/deprecated/3rd-party.md b/docs/status/deprecated/3rd-party.md index 8ad2728..fdac805 100644 --- a/docs/status/deprecated/3rd-party.md +++ b/docs/status/deprecated/3rd-party.md @@ -1,13 +1,12 @@ # 3RD-PARTY -
- - - - - -
Name3rd party
Statusdeprecated
EditorFilip Dimitrijevic <filip@status.im>
ContributorsVolodymyr Kozieiev <volodymyr@status.im>
-
+| Field | Value | +| --- | --- | +| Name | 3rd party | +| Status | deprecated | +| Editor | Filip Dimitrijevic | +| Contributors | Volodymyr Kozieiev | + ## Abstract This specification discusses 3rd party APIs that Status relies on. diff --git a/docs/status/deprecated/IPFS-gateway-for-sticker-Pack.md b/docs/status/deprecated/IPFS-gateway-for-sticker-Pack.md index 43f6f17..a639b1d 100644 --- a/docs/status/deprecated/IPFS-gateway-for-sticker-Pack.md +++ b/docs/status/deprecated/IPFS-gateway-for-sticker-Pack.md @@ -1,13 +1,12 @@ # IPFS-gateway-for-Sticker-Pack -
- - - - - -
NameIPFS gateway for Sticker Pack
Statusdeprecated
EditorFilip Dimitrijevic <filip@status.im>
ContributorsGheorghe Pinzaru <gheorghe@status.im>
-
+| Field | Value | +| --- | --- | +| Name | IPFS gateway for Sticker Pack | +| Status | deprecated | +| Editor | Filip Dimitrijevic | +| Contributors | Gheorghe Pinzaru | + ## Abstract This specification describes how Status uses the IPFS gateway diff --git a/docs/status/deprecated/account.md b/docs/status/deprecated/account.md index 3e6f777..da8d2f6 100644 --- a/docs/status/deprecated/account.md +++ b/docs/status/deprecated/account.md @@ -1,13 +1,12 @@ # ACCOUNT -
- - - - - -
NameAccount
Statusdeprecated
EditorFilip Dimitrijevic <filip@status.im>
ContributorsCorey Petty <corey@status.im>
Oskar Thorén <oskar@status.im>
Samuel Hawksby-Robinson <samuel@status.im>
-
+| Field | Value | +| --- | --- | +| Name | Account | +| Status | deprecated | +| Editor | Filip Dimitrijevic | +| Contributors | Corey Petty , Oskar Thorén , Samuel Hawksby-Robinson | + ## Abstract This specification explains what a Status account is, diff --git a/docs/status/deprecated/client.md b/docs/status/deprecated/client.md index 83e1479..b0446e1 100644 --- a/docs/status/deprecated/client.md +++ b/docs/status/deprecated/client.md @@ -1,13 +1,12 @@ # CLIENT -
- - - - - -
NameClient
Statusdeprecated
EditorFilip Dimitrijevic <filip@status.im>
ContributorsAdam Babik <adam@status.im>
Andrea Maria Piana <andreap@status.im>
Dean Eigenmann <dean@status.im>
Corey Petty <corey@status.im>
Oskar Thorén <oskar@status.im>
Samuel Hawksby-Robinson <samuel@status.im>
-
+| Field | Value | +| --- | --- | +| Name | Client | +| Status | deprecated | +| Editor | Filip Dimitrijevic | +| Contributors | Adam Babik , Andrea Maria Piana , Dean Eigenmann , Corey Petty , Oskar Thorén , Samuel Hawksby-Robinson | + ## Abstract This specification describes how to write a Status client for communicating diff --git a/docs/status/deprecated/dapp-browser-API-usage.md b/docs/status/deprecated/dapp-browser-API-usage.md index 10b6a7b..9d4098a 100644 --- a/docs/status/deprecated/dapp-browser-API-usage.md +++ b/docs/status/deprecated/dapp-browser-API-usage.md @@ -1,12 +1,11 @@ # Dapp browser API usage -
- - - - -
NameDapp browser API usage
Statusdeprecated
EditorFilip Dimitrijevic <filip@status.im>
-
+| Field | Value | +| --- | --- | +| Name | Dapp browser API usage | +| Status | deprecated | +| Editor | Filip Dimitrijevic | + ## Abstract This document describes requirements that an application must fulfill in order to provide a proper environment for Dapps running inside a browser. diff --git a/docs/status/deprecated/eips.md b/docs/status/deprecated/eips.md index ed92109..40a0b76 100644 --- a/docs/status/deprecated/eips.md +++ b/docs/status/deprecated/eips.md @@ -1,13 +1,12 @@ # EIPS -
- - - - - -
NameEIPS
Statusdeprecated
EditorRicardo Guilherme Schmidt <ricardo3@status.im>
ContributorsNone
-
+| Field | Value | +| --- | --- | +| Name | EIPS | +| Status | deprecated | +| Editor | Ricardo Guilherme Schmidt | +| Contributors | None | + ## Abstract This specification describes how Status relates with EIPs. diff --git a/docs/status/deprecated/ethereum-usage.md b/docs/status/deprecated/ethereum-usage.md index 55b939a..7824634 100644 --- a/docs/status/deprecated/ethereum-usage.md +++ b/docs/status/deprecated/ethereum-usage.md @@ -1,13 +1,12 @@ # ETHEREUM-USAGE -
- - - - - -
NameStatus interactions with the Ethereum blockchain
Statusdeprecated
EditorFilip Dimitrijevic <filip@status.im>
ContributorsAndrea Maria Piana <andreap@status.im>
-
+| Field | Value | +| --- | --- | +| Name | Status interactions with the Ethereum blockchain | +| Status | deprecated | +| Editor | Filip Dimitrijevic | +| Contributors | Andrea Maria Piana | + ## Abstract This specification documents all the interactions that the Status client has diff --git a/docs/status/deprecated/group-chat.md b/docs/status/deprecated/group-chat.md index 48a519c..fc0f667 100644 --- a/docs/status/deprecated/group-chat.md +++ b/docs/status/deprecated/group-chat.md @@ -1,13 +1,12 @@ # GROUP-CHAT -
- - - - - -
NameGroup Chat
Statusdeprecated
EditorFilip Dimitrijevic <filip@status.im>
ContributorsAndrea Piana <andreap@status.im>
-
+| Field | Value | +| --- | --- | +| Name | Group Chat | +| Status | deprecated | +| Editor | Filip Dimitrijevic | +| Contributors | Andrea Piana | + ## Abstract This document describes the group chat protocol used by the Status application. diff --git a/docs/status/deprecated/keycard-usage-for-wallet-and-chat-keys.md b/docs/status/deprecated/keycard-usage-for-wallet-and-chat-keys.md index bc2fe6c..be7a591 100644 --- a/docs/status/deprecated/keycard-usage-for-wallet-and-chat-keys.md +++ b/docs/status/deprecated/keycard-usage-for-wallet-and-chat-keys.md @@ -1,13 +1,12 @@ # Keycard Usage for Wallet and Chat Keys -
- - - - - -
NameKeycard Usage for Wallet and Chat Keys
Statusdeprecated
EditorFilip Dimitrijevic <filip@status.im>
ContributorsRoman Volosovskyi <roman@status.im>
-
+| Field | Value | +| --- | --- | +| Name | Keycard Usage for Wallet and Chat Keys | +| Status | deprecated | +| Editor | Filip Dimitrijevic | +| Contributors | Roman Volosovskyi | + ## Abstract In this specification, we describe how Status communicates with Keycard to create, store and use multiaccount. diff --git a/docs/status/deprecated/notifications.md b/docs/status/deprecated/notifications.md index 3bc2137..43c2841 100644 --- a/docs/status/deprecated/notifications.md +++ b/docs/status/deprecated/notifications.md @@ -1,13 +1,11 @@ # NOTIFICATIONS -
- - - - - -
NameNotifications
Statusdeprecated
EditorFilip Dimitrijevic <filip@status.im>
ContributorsEric Dvorsak <eric@status.im>
-
+| Field | Value | +| --- | --- | +| Name | Notifications | +| Status | deprecated | +| Editor | Filip Dimitrijevic | +| Contributors | Eric Dvorsak | ## Local Notifications diff --git a/docs/status/deprecated/payloads.md b/docs/status/deprecated/payloads.md index 48dc40c..e98ae19 100644 --- a/docs/status/deprecated/payloads.md +++ b/docs/status/deprecated/payloads.md @@ -1,13 +1,12 @@ # PAYLOADS -
- - - - - -
NamePayloads
Statusdeprecated
EditorFilip Dimitrijevic <filip@status.im>
ContributorsAdam Babik <adam@status.im>
Andrea Maria Piana <andreap@status.im>
Oskar Thorén <oskar@status.im>
-
+| Field | Value | +| --- | --- | +| Name | Payloads | +| Status | deprecated | +| Editor | Filip Dimitrijevic | +| Contributors | Adam Babik , Andrea Maria Piana , Oskar Thorén | + ## Abstract This specification describes how the payload of each message in Status looks like. diff --git a/docs/status/deprecated/push-notification-server.md b/docs/status/deprecated/push-notification-server.md index 6613acf..f108321 100644 --- a/docs/status/deprecated/push-notification-server.md +++ b/docs/status/deprecated/push-notification-server.md @@ -1,13 +1,12 @@ # PUSH-NOTIFICATION-SERVER -
- - - - - -
NamePush notification server
Statusdeprecated
EditorFilip Dimitrijevic <filip@status.im>
ContributorsAndrea Maria Piana <andreap@status.im>
-
+| Field | Value | +| --- | --- | +| Name | Push notification server | +| Status | deprecated | +| Editor | Filip Dimitrijevic | +| Contributors | Andrea Maria Piana | + ## Reason Push notifications for iOS devices and some Android devices can only be implemented by relying on [APN service](https://developer.apple.com/library/archive/documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/APNSOverview.html#//apple_ref/doc/uid/TP40008194-CH8-SW1) for iOS or [Firebase](https://firebase.google.com/). diff --git a/docs/status/deprecated/secure-transport.md b/docs/status/deprecated/secure-transport.md index 1f93165..cce90d7 100644 --- a/docs/status/deprecated/secure-transport.md +++ b/docs/status/deprecated/secure-transport.md @@ -1,13 +1,12 @@ # SECURE-TRANSPORT -
- - - - - -
NameSecure Transport
Statusdeprecated
EditorFilip Dimitrijevic <filip@status.im>
ContributorsAndrea Maria Piana <andreap@status.im>
Corey Petty <corey@status.im>
Dean Eigenmann <dean@status.im>
Oskar Thorén <oskar@status.im>
Pedro Pombeiro <pedro@status.im>
-
+| Field | Value | +| --- | --- | +| Name | Secure Transport | +| Status | deprecated | +| Editor | Filip Dimitrijevic | +| Contributors | Andrea Maria Piana , Corey Petty , Dean Eigenmann , Oskar Thorén , Pedro Pombeiro | + ## Abstract This document describes how Status provides a secure channel between two peers, diff --git a/docs/status/deprecated/waku-mailserver.md b/docs/status/deprecated/waku-mailserver.md index b5eca01..0f3ea91 100644 --- a/docs/status/deprecated/waku-mailserver.md +++ b/docs/status/deprecated/waku-mailserver.md @@ -1,13 +1,12 @@ # WAKU-MAILSERVER -
- - - - - -
NameWaku Mailserver
Statusdeprecated
EditorFilip Dimitrijevic <filip@status.im>
ContributorsAdam Babik <adam@status.im>
Oskar Thorén <oskar@status.im>
Samuel Hawksby-Robinson <samuel@status.im>
-
+| Field | Value | +| --- | --- | +| Name | Waku Mailserver | +| Status | deprecated | +| Editor | Filip Dimitrijevic | +| Contributors | Adam Babik , Oskar Thorén , Samuel Hawksby-Robinson | + ## Abstract Being mostly offline is an intrinsic property of mobile clients. diff --git a/docs/status/deprecated/waku-usage.md b/docs/status/deprecated/waku-usage.md index 7494bea..44ba8ce 100644 --- a/docs/status/deprecated/waku-usage.md +++ b/docs/status/deprecated/waku-usage.md @@ -1,13 +1,12 @@ # WAKU-USAGE -
- - - - - -
NameWaku Usage
Statusdeprecated
EditorFilip Dimitrijevic <filip@status.im>
ContributorsAdam Babik <adam@status.im>
Corey Petty <corey@status.im>
Oskar Thorén <oskar@status.im>
Samuel Hawksby-Robinson <samuel@status.im>
-
+| Field | Value | +| --- | --- | +| Name | Waku Usage | +| Status | deprecated | +| Editor | Filip Dimitrijevic | +| Contributors | Adam Babik , Corey Petty , Oskar Thorén , Samuel Hawksby-Robinson | + ## Abstract Status uses [Waku](/waku/standards/legacy/6/waku1.md) to provide privacy-preserving routing diff --git a/docs/status/deprecated/whisper-mailserver.md b/docs/status/deprecated/whisper-mailserver.md index da87632..c39302d 100644 --- a/docs/status/deprecated/whisper-mailserver.md +++ b/docs/status/deprecated/whisper-mailserver.md @@ -1,13 +1,12 @@ # WHISPER-MAILSERVER -
- - - - - -
NameWhisper mailserver
Statusdeprecated
EditorFilip Dimitrijevic <filip@status.im>
ContributorsAdam Babik <adam@status.im>
Oskar Thorén <oskar@status.im>
-
+| Field | Value | +| --- | --- | +| Name | Whisper mailserver | +| Status | deprecated | +| Editor | Filip Dimitrijevic | +| Contributors | Adam Babik , Oskar Thorén | + ## Abstract Being mostly offline is an intrinsic property of mobile clients. diff --git a/docs/status/deprecated/whisper-usage.md b/docs/status/deprecated/whisper-usage.md index f5d095a..267730e 100644 --- a/docs/status/deprecated/whisper-usage.md +++ b/docs/status/deprecated/whisper-usage.md @@ -1,13 +1,12 @@ # WHISPER-USAGE -
- - - - - -
NameWhisper Usage
Statusdeprecated
EditorFilip Dimitrijevic <filip@status.im>
ContributorsAdam Babik <adam@status.im>
Andrea Piana <andreap@status.im>
Corey Petty <corey@status.im>
Oskar Thorén <oskar@status.im>
-
+| Field | Value | +| --- | --- | +| Name | Whisper Usage | +| Status | deprecated | +| Editor | Filip Dimitrijevic | +| Contributors | Adam Babik , Andrea Piana , Corey Petty , Oskar Thorén | + ## Abstract Status uses [Whisper](https://eips.ethereum.org/EIPS/eip-627) to provide diff --git a/docs/status/raw/simple-scaling.md b/docs/status/raw/simple-scaling.md index c06fa73..cf28be5 100644 --- a/docs/status/raw/simple-scaling.md +++ b/docs/status/raw/simple-scaling.md @@ -1,14 +1,13 @@ # STATUS-SIMPLE-SCALING -
- - - - - - -
NameStatus Simple Scaling
Statusraw
CategoryInformational
EditorDaniel Kaiser <danielkaiser@status.im>
ContributorsAlvaro Revuelta <alrevuelta@status.im>
-
+| Field | Value | +| --- | --- | +| Name | Status Simple Scaling | +| Status | raw | +| Category | Informational | +| Editor | Daniel Kaiser | +| Contributors | Alvaro Revuelta | + ## Abstract This document describes how to scale diff --git a/docs/status/raw/status-app-protocols.md b/docs/status/raw/status-app-protocols.md index 8cc52d7..f69c989 100644 --- a/docs/status/raw/status-app-protocols.md +++ b/docs/status/raw/status-app-protocols.md @@ -1,14 +1,13 @@ # STATUS-PROTOCOLS -
- - - - - - -
NameStatus Protocol Stack
Statusraw
CategoryStandards Track
EditorHanno Cornelius <hanno@status.im>
ContributorsJimmy Debe <jimmy@status.im>
Aaryamann Challani <p1ge0nh8er@proton.me>
-
+| Field | Value | +| --- | --- | +| Name | Status Protocol Stack | +| Status | raw | +| Category | Standards Track | +| Editor | Hanno Cornelius | +| Contributors | Jimmy Debe , Aaryamann Challani | + ## Abstract This specification describes the Status Application protocol stack. diff --git a/docs/status/raw/status-mvds.md b/docs/status/raw/status-mvds.md index ee82964..489148b 100644 --- a/docs/status/raw/status-mvds.md +++ b/docs/status/raw/status-mvds.md @@ -1,13 +1,12 @@ # STATUS-MVDS-USAGE -
- - - - - -
NameMVDS Usage in Status
Statusraw
CategoryBest Current Practice
EditorKaichao Sun <kaichao@status.im>
-
+| Field | Value | +| --- | --- | +| Name | MVDS Usage in Status | +| Status | raw | +| Category | Best Current Practice | +| Editor | Kaichao Sun | + ## Abstract This document lists the types of messages that are using [MVDS](/vac/2/mvds.md) diff --git a/docs/status/raw/url-data.md b/docs/status/raw/url-data.md index a9d285e..f1caf5a 100644 --- a/docs/status/raw/url-data.md +++ b/docs/status/raw/url-data.md @@ -1,14 +1,13 @@ # STATUS-URL-DATA -
- - - - - - -
NameStatus URL Data
Statusraw
CategoryStandards Track
EditorFelicio Mununga <felicio@status.im>
ContributorsAaryamann Challani <aaryamann@status.im>
-
+| Field | Value | +| --- | --- | +| Name | Status URL Data | +| Status | raw | +| Category | Standards Track | +| Editor | Felicio Mununga | +| Contributors | Aaryamann Challani | + ## Abstract This document specifies serialization, compression, and diff --git a/docs/status/raw/url-scheme.md b/docs/status/raw/url-scheme.md index 8c9b18f..5639c8e 100644 --- a/docs/status/raw/url-scheme.md +++ b/docs/status/raw/url-scheme.md @@ -1,13 +1,12 @@ # STATUS-URL-SCHEME -
- - - - - -
NameStatus URL Scheme
Statusraw
CategoryStandards Track
EditorFelicio Mununga <felicio@status.im>
-
+| Field | Value | +| --- | --- | +| Name | Status URL Scheme | +| Status | raw | +| Category | Standards Track | +| Editor | Felicio Mununga | + ## Abstract This document describes URL scheme for previewing and diff --git a/docs/vac/1/coss.md b/docs/vac/1/coss.md index 3d3e3c2..eba1dac 100644 --- a/docs/vac/1/coss.md +++ b/docs/vac/1/coss.md @@ -1,15 +1,14 @@ # 1/COSS -
- - - - - - - -
NameConsensus-Oriented Specification System
Slug1
Statusdraft
CategoryBest Current Practice
EditorDaniel Kaiser <danielkaiser@status.im>
ContributorsOskar Thoren <oskarth@titanproxy.com>
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>
Jimmy Debe <jimmy@status.im>
-
+| Field | Value | +| --- | --- | +| Name | Consensus-Oriented Specification System | +| Slug | 1 | +| Status | draft | +| Category | Best Current Practice | +| Editor | Daniel Kaiser | +| Contributors | Oskar Thoren , Pieter Hintjens , André Rebentisch , Alberto Barrionuevo , Chris Puttick , Yurii Rashkovskii , Jimmy Debe | + This document describes a consensus-oriented specification system (COSS) for building interoperable technical specifications. COSS is based on a lightweight editorial process that diff --git a/docs/vac/2/mvds.md b/docs/vac/2/mvds.md index e0386b1..abf3b1d 100644 --- a/docs/vac/2/mvds.md +++ b/docs/vac/2/mvds.md @@ -1,14 +1,13 @@ # 2/MVDS -
- - - - - - -
NameMinimum Viable Data Synchronization
Slug2
Statusstable
EditorSanaz Taheri <sanaz@status.im>
ContributorsDean Eigenmann <dean@status.im>
Oskar Thorén <oskarth@titanproxy.com>
-
+| Field | Value | +| --- | --- | +| Name | Minimum Viable Data Synchronization | +| Slug | 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 ([BSP](https://code.briarproject.org/briar/briar-spec/blob/master/protocols/BSP.md)). This protocol is designed to ensure reliable messaging diff --git a/docs/vac/25/libp2p-dns-discovery.md b/docs/vac/25/libp2p-dns-discovery.md index fcec806..e7b2abe 100644 --- a/docs/vac/25/libp2p-dns-discovery.md +++ b/docs/vac/25/libp2p-dns-discovery.md @@ -1,13 +1,12 @@ # 25/LIBP2P-DNS-DISCOVERY -
- - - - - -
NameLibp2p Peer Discovery via DNS
Slug25
Statusdeleted
EditorHanno Cornelius <hanno@status.im>
-
+| Field | Value | +| --- | --- | +| Name | Libp2p Peer Discovery via DNS | +| Slug | 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, diff --git a/docs/vac/3/remote-log.md b/docs/vac/3/remote-log.md index b874c06..fc3e1cf 100644 --- a/docs/vac/3/remote-log.md +++ b/docs/vac/3/remote-log.md @@ -1,14 +1,13 @@ # 3/REMOTE-LOG -
- - - - - - -
NameRemote log specification
Slug3
Statusdraft
EditorOskar Thorén <oskarth@titanproxy.com>
ContributorsDean Eigenmann <dean@status.im>
-
+| Field | Value | +| --- | --- | +| Name | Remote log specification | +| Slug | 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/docs/vac/32/rln-v1.md b/docs/vac/32/rln-v1.md index a4aeeec..d24b6d1 100644 --- a/docs/vac/32/rln-v1.md +++ b/docs/vac/32/rln-v1.md @@ -1,14 +1,13 @@ # 32/RLN-V1 -
- - - - - - -
NameRate Limit Nullifier
Slug32
Statusdraft
EditorAaryamann Challani <p1ge0nh8er@proton.me>
ContributorsBarry Whitehat <barrywhitehat@protonmail.com>
Sanaz Taheri <sanaz@status.im>
Oskar Thorén <oskarth@titanproxy.com>
Onur Kilic <onurkilic1004@gmail.com>
Blagoj Dimovski <blagoj.dimovski@yandex.com>
Rasul Ibragimov <curryrasul@gmail.com>
-
+| Field | Value | +| --- | --- | +| Name | Rate Limit Nullifier | +| Slug | 32 | +| Status | draft | +| Editor | Aaryamann Challani | +| Contributors | Barry Whitehat , Sanaz Taheri , Oskar Thorén , Onur Kilic , Blagoj Dimovski , Rasul Ibragimov | + ## Abstract The following specification covers the RLN construct diff --git a/docs/vac/4/mvds-meta.md b/docs/vac/4/mvds-meta.md index 6189ead..c1261a7 100644 --- a/docs/vac/4/mvds-meta.md +++ b/docs/vac/4/mvds-meta.md @@ -1,14 +1,13 @@ # 4/MVDS-META -
- - - - - - -
NameMVDS Metadata Field
Slug4
Statusdraft
EditorSanaz Taheri <sanaz@status.im>
ContributorsDean Eigenmann <dean@status.im>
Andrea Maria Piana <andreap@status.im>
Oskar Thorén <oskarth@titanproxy.com>
-
+| Field | Value | +| --- | --- | +| Name | MVDS Metadata Field | +| Slug | 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, diff --git a/docs/vac/raw/consensus-hashgraphlike.md b/docs/vac/raw/consensus-hashgraphlike.md index 0c39de3..bd52578 100644 --- a/docs/vac/raw/consensus-hashgraphlike.md +++ b/docs/vac/raw/consensus-hashgraphlike.md @@ -1,14 +1,13 @@ # HASHGRAPHLIKE CONSENSUS -
- - - - - - -
NameHashgraphlike Consensus Protocol
Statusraw
CategoryStandards Track
EditorUgur Sen [ugur@status.im](mailto:ugur@status.im)
Contributorss
e
e
m
e
n
k
i
n
a

[
e
k
a
t
e
r
i
n
a
@
s
t
a
t
u
s
.
i
m
]
(
m
a
i
l
t
o
:
e
k
a
t
e
r
i
n
a
@
s
t
a
t
u
s
.
i
m
)
-
+| Field | Value | +| --- | --- | +| Name | Hashgraphlike Consensus Protocol | +| Status | raw | +| Category | Standards Track | +| Editor | Ugur Sen [ugur@status.im](mailto:ugur@status.im) | +| Contributors | seemenkina [ekaterina@status.im](mailto:ekaterina@status.im) | + ## Abstract This document specifies a scalable, decentralized, and Byzantine Fault Tolerant (BFT) diff --git a/docs/vac/raw/decentralized-messaging-ethereum.md b/docs/vac/raw/decentralized-messaging-ethereum.md index f275eb0..0f3d3b7 100644 --- a/docs/vac/raw/decentralized-messaging-ethereum.md +++ b/docs/vac/raw/decentralized-messaging-ethereum.md @@ -1,13 +1,12 @@ # ETH-DCGKA -
- - - - - -
NameDecentralized Key and Session Setup for Secure Messaging over Ethereum
Statusraw
Categoryinformational
EditorRamses Fernandez-Valencia <ramses@status.im>
-
+| Field | Value | +| --- | --- | +| Name | Decentralized Key and Session Setup for Secure Messaging over Ethereum | +| Status | raw | +| Category | informational | +| Editor | Ramses Fernandez-Valencia | + ## Abstract This document introduces a decentralized group messaging protocol diff --git a/docs/vac/raw/deleted/eth-secpm.md b/docs/vac/raw/deleted/eth-secpm.md index 63c9f5e..0ce6691 100644 --- a/docs/vac/raw/deleted/eth-secpm.md +++ b/docs/vac/raw/deleted/eth-secpm.md @@ -1,13 +1,12 @@ # ETH-SECPM -
- - - - - -
NameSecure channel setup using Ethereum accounts
Statusdeleted
CategoryStandards Track
EditorRamses Fernandez <ramses@status.im>
-
+| Field | Value | +| --- | --- | +| Name | Secure channel setup using Ethereum accounts | +| Status | deleted | +| Category | Standards Track | +| Editor | Ramses Fernandez | + ## NOTE The content of this specification has been split between diff --git a/docs/vac/raw/eth-mls-offchain.md b/docs/vac/raw/eth-mls-offchain.md index 820715d..b61d67c 100644 --- a/docs/vac/raw/eth-mls-offchain.md +++ b/docs/vac/raw/eth-mls-offchain.md @@ -1,14 +1,13 @@ # ETH-MLS-OFFCHAIN -
- - - - - - -
NameSecure channel setup using decentralized MLS and Ethereum accounts
Statusraw
CategoryStandards Track
EditorUgur Sen [ugur@status.im](mailto:ugur@status.im)
Contributorss
e
e
m
e
n
k
i
n
a

[
e
k
a
t
e
r
i
n
a
@
s
t
a
t
u
s
.
i
m
]
(
m
a
i
l
t
o
:
e
k
a
t
e
r
i
n
a
@
s
t
a
t
u
s
.
i
m
)
-
+| Field | Value | +| --- | --- | +| Name | Secure channel setup using decentralized MLS and Ethereum accounts | +| Status | raw | +| Category | Standards Track | +| Editor | Ugur Sen [ugur@status.im](mailto:ugur@status.im) | +| Contributors | seemenkina [ekaterina@status.im](mailto:ekaterina@status.im) | + ## Abstract The following document specifies Ethereum authenticated scalable diff --git a/docs/vac/raw/eth-mls-onchain.md b/docs/vac/raw/eth-mls-onchain.md index 26460a5..32f4455 100644 --- a/docs/vac/raw/eth-mls-onchain.md +++ b/docs/vac/raw/eth-mls-onchain.md @@ -1,14 +1,13 @@ # ETH-MLS-ONCHAIN -
- - - - - - -
NameSecure channel setup using decentralized MLS and Ethereum accounts
Statusraw
CategoryStandards Track
EditorRamses Fernandez <ramses@status.im>
ContributorsA
a
r
y
a
m
a
n
n

C
h
a
l
l
a
n
i

<
a
a
r
y
a
m
a
n
n
@
s
t
a
t
u
s
.
i
m
>
,

E
k
a
t
e
r
i
n
a

B
r
o
s
l
a
v
s
k
a
y
a

<
e
k
a
t
e
r
i
n
a
@
s
t
a
t
u
s
.
i
m
>
,

U
g
u
r

S
e
n

<
u
g
u
r
@
s
t
a
t
u
s
.
i
m
>
,

K
s
r

<
k
s
r
@
s
t
a
t
u
s
.
i
m
>
-
+| Field | Value | +| --- | --- | +| Name | Secure channel setup using decentralized MLS and Ethereum accounts | +| Status | raw | +| Category | Standards Track | +| Editor | Ramses Fernandez | +| Contributors | Aaryamann Challani , Ekaterina Broslavskaya , Ugur Sen , Ksr | + ## Motivation The need for secure communications has become paramount. diff --git a/docs/vac/raw/gossipsub-tor-push.md b/docs/vac/raw/gossipsub-tor-push.md index 5503733..9be4f6c 100644 --- a/docs/vac/raw/gossipsub-tor-push.md +++ b/docs/vac/raw/gossipsub-tor-push.md @@ -1,13 +1,12 @@ # GOSSIPSUB-TOR-PUSH -
- - - - - -
NameGossipsub Tor Push
Statusraw
CategoryStandards Track
EditorDaniel Kaiser <danielkaiser@status.im>
-
+| Field | Value | +| --- | --- | +| Name | Gossipsub Tor Push | +| Status | raw | +| Category | Standards Track | +| Editor | Daniel Kaiser | + ## Abstract This document extends the [libp2p gossipsub specification](https://github.com/libp2p/specs/blob/master/pubsub/gossipsub/README.md) diff --git a/docs/vac/raw/logos-capability-discovery.md b/docs/vac/raw/logos-capability-discovery.md index 13e39ec..d0a48d8 100644 --- a/docs/vac/raw/logos-capability-discovery.md +++ b/docs/vac/raw/logos-capability-discovery.md @@ -1,14 +1,13 @@ # LOGOS-CAPABILITY-DISCOVERY -
- - - - - - -
NameLogos Capability Discovery Protocol
Statusraw
CategoryStandards Track
EditorArunima Chaudhuri [arunima@status.im](mailto:arunima@status.im)
ContributorsU
g
u
r

S
e
n

[
u
g
u
r
@
s
t
a
t
u
s
.
i
m
]
(
m
a
i
l
t
o
:
u
g
u
r
@
s
t
a
t
u
s
.
i
m
)
-
+| Field | Value | +| --- | --- | +| Name | Logos Capability Discovery Protocol | +| Status | raw | +| Category | Standards Track | +| Editor | Arunima Chaudhuri [arunima@status.im](mailto:arunima@status.im) | +| Contributors | Ugur Sen [ugur@status.im](mailto:ugur@status.im) | + > **Note:** This specification is currently a WIP and undergoing a high rate of changes. ## Abstract diff --git a/docs/vac/raw/mix.md b/docs/vac/raw/mix.md index 67b69f0..68055a3 100644 --- a/docs/vac/raw/mix.md +++ b/docs/vac/raw/mix.md @@ -1,14 +1,13 @@ # LIBP2P-MIX -
- - - - - - -
NameLibp2p Mix Protocol
Statusraw
CategoryStandards Track
EditorPrem Prathi <premprathi@proton.me>
ContributorsA
k
s
h
a
y
a

M
a
n
i

<
a
k
s
h
a
y
a
@
s
t
a
t
u
s
.
i
m
>
,

D
a
n
i
e
l

K
a
i
s
e
r

<
d
a
n
i
e
l
k
a
i
s
e
r
@
s
t
a
t
u
s
.
i
m
>
-
+| Field | Value | +| --- | --- | +| Name | Libp2p Mix Protocol | +| Status | raw | +| Category | Standards Track | +| Editor | Prem Prathi | +| Contributors | Akshaya Mani , Daniel Kaiser | + ## Abstract The Mix Protocol defines a decentralized anonymous message routing layer for libp2p networks. diff --git a/docs/vac/raw/noise-x3dh-double-ratchet.md b/docs/vac/raw/noise-x3dh-double-ratchet.md index aaaa49e..3ee13d4 100644 --- a/docs/vac/raw/noise-x3dh-double-ratchet.md +++ b/docs/vac/raw/noise-x3dh-double-ratchet.md @@ -1,13 +1,12 @@ # NOISE-X3DH-DOUBLE-RATCHET -
- - - - - -
NameSecure 1-to-1 channel setup using X3DH and the double ratchet
Statusraw
CategoryStandards Track
EditorRamses Fernandez <ramses@status.im>
-
+| Field | Value | +| --- | --- | +| Name | Secure 1-to-1 channel setup using X3DH and the double ratchet | +| Status | raw | +| Category | Standards Track | +| Editor | Ramses Fernandez | + ## Motivation The need for secure communications has become paramount. diff --git a/docs/vac/raw/rln-interep-spec.md b/docs/vac/raw/rln-interep-spec.md index ef7f631..f30d192 100644 --- a/docs/vac/raw/rln-interep-spec.md +++ b/docs/vac/raw/rln-interep-spec.md @@ -1,12 +1,11 @@ # RLN-INTEREP-SPEC -
- - - - -
NameInterep as group management for RLN
Statusraw
EditorAaryamann Challani <p1ge0nh8er@proton.me>
-
+| Field | Value | +| --- | --- | +| Name | Interep as group management for RLN | +| Status | raw | +| Editor | Aaryamann Challani | + ## Abstract This spec integrates [Interep](https://interep.link) diff --git a/docs/vac/raw/rln-stealth-commitments.md b/docs/vac/raw/rln-stealth-commitments.md index b5128db..53ee492 100644 --- a/docs/vac/raw/rln-stealth-commitments.md +++ b/docs/vac/raw/rln-stealth-commitments.md @@ -1,13 +1,12 @@ # RLN-STEALTH-COMMITMENTS -
- - - - - -
NameRLN Stealth Commitment Usage
CategoryStandards Track
EditorAaryamann Challani <p1ge0nh8er@proton.me>
ContributorsJimmy Debe <jimmy@status.im>
-
+| Field | Value | +| --- | --- | +| Name | RLN Stealth Commitment Usage | +| Category | Standards Track | +| Editor | Aaryamann Challani | +| Contributors | Jimmy Debe | + ## Abstract This specification describes the usage of stealth commitments diff --git a/docs/vac/raw/rln-v2.md b/docs/vac/raw/rln-v2.md index 46f36f6..adbe345 100644 --- a/docs/vac/raw/rln-v2.md +++ b/docs/vac/raw/rln-v2.md @@ -1,13 +1,12 @@ # RLN-V2 -
- - - - - -
NameRate Limit Nullifier V2
Statusraw
EditorRasul Ibragimov <curryrasul@gmail.com>
ContributorsLev Soukhanov <0xdeadfae@gmail.com>
-
+| Field | Value | +| --- | --- | +| Name | Rate Limit Nullifier V2 | +| Status | raw | +| Editor | Rasul Ibragimov | +| Contributors | Lev Soukhanov <0xdeadfae@gmail.com> | + ## Abstract The protocol specified in this document is an improvement of [32/RLN-V1](../32/rln-v1.md), diff --git a/docs/vac/raw/sds.md b/docs/vac/raw/sds.md index ecb9c85..57b8241 100644 --- a/docs/vac/raw/sds.md +++ b/docs/vac/raw/sds.md @@ -1,13 +1,12 @@ # SDS -
- - - - - -
NameScalable Data Sync protocol for distributed logs
Statusraw
EditorHanno Cornelius <hanno@status.im>
ContributorsAkhil Peddireddy <akhil@status.im>
-
+| Field | Value | +| --- | --- | +| Name | Scalable Data Sync protocol for distributed logs | +| Status | raw | +| Editor | Hanno Cornelius | +| Contributors | Akhil Peddireddy | + ## Abstract This specification introduces the Scalable Data Sync (SDS) protocol diff --git a/docs/vac/template.md b/docs/vac/template.md index d4039de..458d694 100644 --- a/docs/vac/template.md +++ b/docs/vac/template.md @@ -1,14 +1,13 @@ # TEMPLATE -
- - - - - - -
NameRFC Template
SlugXX
Statusraw/draft/stable/deprecated
CategoryStandards Track/Informational/Best Current Practice
EditorDaniel Kaiser <danielkaiser@status.im>
-
+| Field | Value | +| --- | --- | +| Name | RFC Template | +| Slug | XX | +| Status | raw/draft/stable/deprecated | +| Category | Standards Track/Informational/Best Current Practice | +| Editor | Daniel Kaiser | + ## (Info, remove this section) This section contains meta info about writing RFCs. diff --git a/docs/waku/deprecated/16/rpc.md b/docs/waku/deprecated/16/rpc.md index 75f961e..da19bd1 100644 --- a/docs/waku/deprecated/16/rpc.md +++ b/docs/waku/deprecated/16/rpc.md @@ -1,13 +1,12 @@ # 16/WAKU2-RPC -
- - - - - -
NameWaku v2 RPC API
Slug16
Statusdeprecated
EditorHanno Cornelius <hanno@status.im>
-
+| Field | Value | +| --- | --- | +| Name | Waku v2 RPC API | +| Slug | 16 | +| Status | deprecated | +| Editor | Hanno Cornelius | + ## Introduction This specification describes the JSON-RPC API that Waku v2 nodes MAY adhere to. diff --git a/docs/waku/deprecated/18/swap.md b/docs/waku/deprecated/18/swap.md index ccce74f..0a9bafe 100644 --- a/docs/waku/deprecated/18/swap.md +++ b/docs/waku/deprecated/18/swap.md @@ -1,13 +1,12 @@ # 18/WAKU2-SWAP -
- - - - - -
NameWaku SWAP Accounting
Slug18
Statusdeprecated
EditorOskar Thorén <oskarth@titanproxy.com>
-
+| Field | Value | +| --- | --- | +| Name | Waku SWAP Accounting | +| Slug | 18 | +| Status | deprecated | +| Editor | Oskar Thorén | + ## Abstract This specification outlines how we do accounting and settlement based on the provision @@ -56,10 +55,10 @@ where `b>c`. From A's point of view: -A/B | Cooperate | Defect ------|----------|------- -Cooperate | b-c | -c -Defect | b | 0 +| A/B | Cooperate | Defect | +| --- | --- | --- | +| Cooperate | b-c | -c | +| Defect | b | 0 | What this means is that if A and B cooperates, A gets some benefit `b` minus a cost `c`. @@ -69,10 +68,10 @@ If both defect they get neither benefit nor cost. The generalized form of PD is: -A/B | Cooperate | Defect ------|----------|------- -Cooperate | R | S -Defect | T | P +| A/B | Cooperate | Defect | +| --- | --- | --- | +| Cooperate | R | S | +| Defect | T | P | With R=reward, S=Sucker's payoff, T=temptation, P=punishment diff --git a/docs/waku/deprecated/5/waku0.md b/docs/waku/deprecated/5/waku0.md index c68cf50..26b2bf3 100644 --- a/docs/waku/deprecated/5/waku0.md +++ b/docs/waku/deprecated/5/waku0.md @@ -1,14 +1,13 @@ # 5/WAKU0 -
- - - - - - -
NameWaku v0
Slug5
Statusdeprecated
EditorOskar Thorén <oskarth@titanproxy.com>
ContributorsAdam Babik <adam@status.im>
Andrea Maria Piana <andreap@status.im>
Dean Eigenmann <dean@status.im>
Kim De Mey <kimdemey@status.im>
-
+| Field | Value | +| --- | --- | +| Name | Waku v0 | +| Slug | 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 diff --git a/docs/waku/deprecated/fault-tolerant-store.md b/docs/waku/deprecated/fault-tolerant-store.md index cc7a68d..8922983 100644 --- a/docs/waku/deprecated/fault-tolerant-store.md +++ b/docs/waku/deprecated/fault-tolerant-store.md @@ -1,13 +1,12 @@ # 21/WAKU2-FAULT-TOLERANT-STORE -
- - - - - -
NameWaku v2 Fault-Tolerant Store
Slug21
Statusdeleted
EditorSanaz Taheri <sanaz@status.im>
-
+| Field | Value | +| --- | --- | +| Name | Waku v2 Fault-Tolerant Store | +| Slug | 21 | +| Status | deleted | +| 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 diff --git a/docs/waku/informational/22/toy-chat.md b/docs/waku/informational/22/toy-chat.md index c424e99..2c48849 100644 --- a/docs/waku/informational/22/toy-chat.md +++ b/docs/waku/informational/22/toy-chat.md @@ -1,14 +1,13 @@ # 22/TOY-CHAT -
- - - - - - -
NameWaku v2 Toy Chat
Slug22
Statusdraft
EditorFranck Royer <franck@status.im>
ContributorsHanno Cornelius <hanno@status.im>
-
+| Field | Value | +| --- | --- | +| Name | Waku v2 Toy Chat | +| Slug | 22 | +| Status | draft | +| Editor | Franck Royer | +| Contributors | Hanno Cornelius | + **Content Topic**: `/toy-chat/2/huilong/proto`. This specification explains a toy chat example using Waku v2. diff --git a/docs/waku/informational/23/topics.md b/docs/waku/informational/23/topics.md index 82aaa07..a653e05 100644 --- a/docs/waku/informational/23/topics.md +++ b/docs/waku/informational/23/topics.md @@ -1,15 +1,14 @@ # 23/WAKU2-TOPICS -
- - - - - - - -
NameWaku v2 Topic Usage Recommendations
Slug23
Statusdraft
CategoryInformational
EditorOskar Thoren <oskarth@titanproxy.com>
ContributorsHanno Cornelius <hanno@status.im>
Daniel Kaiser <danielkaiser@status.im>
Filip Dimitrijevic <filip@status.im>
-
+| Field | Value | +| --- | --- | +| Name | Waku v2 Topic Usage Recommendations | +| Slug | 23 | +| Status | draft | +| Category | Informational | +| Editor | Oskar Thoren | +| Contributors | Hanno Cornelius , Daniel Kaiser , Filip Dimitrijevic | + This document outlines recommended usage of topic names in Waku v2. In [10/WAKU2 spec](/waku/standards/core/10/waku2.md) there are two types of topics: diff --git a/docs/waku/informational/27/peers.md b/docs/waku/informational/27/peers.md index 0f3019e..21f3adf 100644 --- a/docs/waku/informational/27/peers.md +++ b/docs/waku/informational/27/peers.md @@ -1,14 +1,13 @@ # 27/WAKU2-PEERS -
- - - - - - -
NameWaku v2 Client Peer Management Recommendations
Slug27
Statusdraft
EditorHanno Cornelius <hanno@status.im>
ContributorsFilip Dimitrijevic <filip@status.im>
-
+| Field | Value | +| --- | --- | +| Name | Waku v2 Client Peer Management Recommendations | +| Slug | 27 | +| Status | draft | +| Editor | Hanno Cornelius | +| Contributors | Filip Dimitrijevic | + `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/docs/waku/informational/29/config.md b/docs/waku/informational/29/config.md index 16bf850..7690782 100644 --- a/docs/waku/informational/29/config.md +++ b/docs/waku/informational/29/config.md @@ -1,14 +1,13 @@ # 29/WAKU2-CONFIG -
- - - - - - -
NameWaku v2 Client Parameter Configuration Recommendations
Slug29
Statusdraft
EditorHanno Cornelius <hanno@status.im>
ContributorsFilip Dimitrijevic <filip@status.im>
-
+| Field | Value | +| --- | --- | +| Name | Waku v2 Client Parameter Configuration Recommendations | +| Slug | 29 | +| Status | draft | +| Editor | Hanno Cornelius | +| Contributors | Filip Dimitrijevic | + `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/docs/waku/informational/30/adaptive-nodes.md b/docs/waku/informational/30/adaptive-nodes.md index ff51735..754e509 100644 --- a/docs/waku/informational/30/adaptive-nodes.md +++ b/docs/waku/informational/30/adaptive-nodes.md @@ -1,14 +1,13 @@ # 30/ADAPTIVE-NODES -
- - - - - - -
NameAdaptive nodes
Slug30
Statusdraft
EditorOskar Thorén <oskarth@titanproxy.com>
ContributorsFilip Dimitrijevic <filip@status.im>
-
+| Field | Value | +| --- | --- | +| Name | Adaptive nodes | +| Slug | 30 | +| Status | draft | +| Editor | Oskar Thorén | +| Contributors | Filip Dimitrijevic | + This is an informational spec that show cases the concept of adaptive nodes. ## Node types - a continuum diff --git a/docs/waku/standards/application/20/toy-eth-pm.md b/docs/waku/standards/application/20/toy-eth-pm.md index 320958d..350ba26 100644 --- a/docs/waku/standards/application/20/toy-eth-pm.md +++ b/docs/waku/standards/application/20/toy-eth-pm.md @@ -1,13 +1,12 @@ # 20/TOY-ETH-PM -
- - - - - -
NameToy Ethereum Private Message
Slug20
Statusdraft
EditorFranck Royer <franck@status.im>
-
+| Field | Value | +| --- | --- | +| Name | Toy Ethereum Private Message | +| Slug | 20 | +| Status | draft | +| Editor | Franck Royer | + **Content Topics**: - Public Key Broadcast: `/eth-pm/1/public-key/proto` diff --git a/docs/waku/standards/application/26/payload.md b/docs/waku/standards/application/26/payload.md index a11e886..4fbf223 100644 --- a/docs/waku/standards/application/26/payload.md +++ b/docs/waku/standards/application/26/payload.md @@ -1,14 +1,13 @@ # 26/WAKU2-PAYLOAD -
- - - - - - -
NameWaku Message Payload Encryption
Slug26
Statusdraft
EditorOskar Thoren <oskarth@titanproxy.com>
ContributorsOskar Thoren <oskarth@titanproxy.com>
-
+| Field | Value | +| --- | --- | +| Name | Waku Message Payload Encryption | +| Slug | 26 | +| Status | draft | +| Editor | Oskar Thoren | +| Contributors | Oskar Thoren | + ## Abstract This specification describes how Waku provides confidentiality, authenticity, and diff --git a/docs/waku/standards/application/53/x3dh.md b/docs/waku/standards/application/53/x3dh.md index b761ed0..37995fa 100644 --- a/docs/waku/standards/application/53/x3dh.md +++ b/docs/waku/standards/application/53/x3dh.md @@ -1,15 +1,14 @@ # 53/WAKU2-X3DH -
- - - - - - - -
NameX3DH usage for Waku payload encryption
Slug53
Statusdraft
CategoryStandards Track
EditorAaryamann Challani <p1ge0nh8er@proton.me>
ContributorsAndrea Piana <andreap@status.im>
Pedro Pombeiro <pedro@status.im>
Corey Petty <corey@status.im>
Oskar Thorén <oskarth@titanproxy.com>
Dean Eigenmann <dean@status.im>
Filip Dimitrijevic <filip@status.im>
-
+| Field | Value | +| --- | --- | +| Name | X3DH usage for Waku payload encryption | +| Slug | 53 | +| Status | draft | +| Category | Standards Track | +| Editor | Aaryamann Challani | +| Contributors | Andrea Piana , Pedro Pombeiro , Corey Petty , Oskar Thorén , Dean Eigenmann , Filip Dimitrijevic | + ## Abstract This document describes a method that can be used to provide a secure channel diff --git a/docs/waku/standards/application/54/x3dh-sessions.md b/docs/waku/standards/application/54/x3dh-sessions.md index 5e0c17d..dbe6e34 100644 --- a/docs/waku/standards/application/54/x3dh-sessions.md +++ b/docs/waku/standards/application/54/x3dh-sessions.md @@ -1,15 +1,14 @@ # 54/WAKU2-X3DH-SESSIONS -
- - - - - - - -
NameSession management for Waku X3DH
Slug54
Statusdraft
CategoryStandards Track
EditorAaryamann Challani <p1ge0nh8er@proton.me>
ContributorsAndrea Piana <andreap@status.im>
Pedro Pombeiro <pedro@status.im>
Corey Petty <corey@status.im>
Oskar Thorén <oskarth@titanproxy.com>
Dean Eigenmann <dean@status.im>
Filip Dimitrijevic <filip@status.im>
-
+| Field | Value | +| --- | --- | +| Name | Session management for Waku X3DH | +| Slug | 54 | +| Status | draft | +| Category | Standards Track | +| Editor | Aaryamann Challani | +| Contributors | Andrea Piana , Pedro Pombeiro , Corey Petty , Oskar Thorén , Dean Eigenmann , Filip Dimitrijevic | + ## Abstract This document specifies how to manage sessions based on an X3DH key exchange. diff --git a/docs/waku/standards/core/10/waku2.md b/docs/waku/standards/core/10/waku2.md index 0231cea..3fe34bc 100644 --- a/docs/waku/standards/core/10/waku2.md +++ b/docs/waku/standards/core/10/waku2.md @@ -1,14 +1,13 @@ # 10/WAKU2 -
- - - - - - -
NameWaku v2
Slug10
Statusdraft
EditorHanno Cornelius <hanno@status.im>
ContributorsSanaz 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>
-
+| Field | Value | +| --- | --- | +| Name | Waku v2 | +| Slug | 10 | +| Status | draft | +| Editor | Hanno Cornelius | +| Contributors | Sanaz Taheri , Hanno Cornelius , Reeshav Khan , Daniel Kaiser , Oskar Thorén | + ## Timeline diff --git a/docs/waku/standards/core/11/relay.md b/docs/waku/standards/core/11/relay.md index acf5c6c..7ece0d3 100644 --- a/docs/waku/standards/core/11/relay.md +++ b/docs/waku/standards/core/11/relay.md @@ -1,14 +1,13 @@ # 11/WAKU2-RELAY -
- - - - - - -
NameWaku v2 Relay
Slug11
Statusstable
EditorHanno Cornelius <hanno@status.im>
ContributorsOskar Thorén <oskarth@titanproxy.com>
Sanaz Taheri <sanaz@status.im>
-
+| Field | Value | +| --- | --- | +| Name | Waku v2 Relay | +| Slug | 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. diff --git a/docs/waku/standards/core/12/filter.md b/docs/waku/standards/core/12/filter.md index d47070d..34016d1 100644 --- a/docs/waku/standards/core/12/filter.md +++ b/docs/waku/standards/core/12/filter.md @@ -1,14 +1,13 @@ # 12/WAKU2-FILTER -
- - - - - - -
NameWaku v2 Filter
Slug12
Statusdraft
EditorHanno Cornelius <hanno@status.im>
ContributorsDean Eigenmann <dean@status.im>
Oskar Thorén <oskar@status.im>
Sanaz Taheri <sanaz@status.im>
Ebube Ud <ebube@status.im>
-
+| Field | Value | +| --- | --- | +| Name | Waku v2 Filter | +| Slug | 12 | +| Status | draft | +| Editor | Hanno Cornelius | +| Contributors | Dean Eigenmann , Oskar Thorén , Sanaz Taheri , Ebube Ud | + previous versions: [00](/waku/standards/core/12/previous-versions/00/filter.md) **Protocol identifiers**: diff --git a/docs/waku/standards/core/12/previous-versions/00/filter.md b/docs/waku/standards/core/12/previous-versions/00/filter.md index 4dcdb19..873988c 100644 --- a/docs/waku/standards/core/12/previous-versions/00/filter.md +++ b/docs/waku/standards/core/12/previous-versions/00/filter.md @@ -1,14 +1,13 @@ # 12/WAKU2-FILTER -
- - - - - - -
NameWaku v2 Filter
Slug12
Statusdraft
EditorHanno Cornelius <hanno@status.im>
ContributorsDean Eigenmann <dean@status.im>
Oskar Thorén <oskarth@titanproxy.com>
Sanaz Taheri <sanaz@status.im>
Ebube Ud <ebube@status.im>
-
+| Field | Value | +| --- | --- | +| Name | Waku v2 Filter | +| Slug | 12 | +| Status | draft | +| Editor | Hanno Cornelius | +| Contributors | Dean Eigenmann , Oskar Thorén , Sanaz Taheri , Ebube Ud | + `WakuFilter` is a protocol that enables subscribing to messages that a peer receives. This is a more lightweight version of `WakuRelay` specifically designed for bandwidth restricted devices. diff --git a/docs/waku/standards/core/13/previous-versions/00/store.md b/docs/waku/standards/core/13/previous-versions/00/store.md index 164c871..b134542 100644 --- a/docs/waku/standards/core/13/previous-versions/00/store.md +++ b/docs/waku/standards/core/13/previous-versions/00/store.md @@ -1,14 +1,13 @@ # 13/WAKU2-STORE -
- - - - - - -
NameWaku v2 Store
Slug13
Statusdraft
EditorSimon-Pierre Vivier <simvivier@status.im>
ContributorsDean Eigenmann <dean@status.im>
Oskar Thorén <oskarth@titanproxy.com>
Aaryamann Challani <p1ge0nh8er@proton.me>
Sanaz Taheri <sanaz@status.im>
Hanno Cornelius <hanno@status.im>
-
+| Field | Value | +| --- | --- | +| Name | Waku v2 Store | +| Slug | 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 diff --git a/docs/waku/standards/core/13/store.md b/docs/waku/standards/core/13/store.md index 2b9bc55..ccb968e 100644 --- a/docs/waku/standards/core/13/store.md +++ b/docs/waku/standards/core/13/store.md @@ -1,14 +1,13 @@ # 13/WAKU2-STORE -
- - - - - - -
NameWaku Store Query
Slug13
Statusdraft
EditorHanno Cornelius <hanno@status.im>
ContributorsDean Eigenmann <dean@status.im>
Oskar Thorén <oskarth@titanproxy.com>
Aaryamann Challani <p1ge0nh8er@proton.me>
Sanaz Taheri <sanaz@status.im>
-
+| Field | Value | +| --- | --- | +| Name | Waku Store Query | +| Slug | 13 | +| Status | draft | +| Editor | Hanno Cornelius | +| Contributors | Dean Eigenmann , Oskar Thorén , Aaryamann Challani , Sanaz Taheri | + Previous version: [00](/waku/standards/core/13/previous-versions/00/store.md) ## Abstract diff --git a/docs/waku/standards/core/14/message.md b/docs/waku/standards/core/14/message.md index bdd5887..002c39d 100644 --- a/docs/waku/standards/core/14/message.md +++ b/docs/waku/standards/core/14/message.md @@ -1,15 +1,14 @@ # 14/WAKU2-MESSAGE -
- - - - - - - -
NameWaku v2 Message
Slug14
Statusstable
CategoryStandards Track
EditorHanno Cornelius <hanno@status.im>
ContributorsSanaz Taheri <sanaz@status.im>
Aaryamann Challani <p1ge0nh8er@proton.me>
Lorenzo Delgado <lorenzo@status.im>
Abhimanyu Rawat <abhi@status.im>
Oskar Thorén <oskarth@titanproxy.com>
-
+| Field | Value | +| --- | --- | +| Name | Waku v2 Message | +| Slug | 14 | +| Status | stable | +| Category | Standards Track | +| Editor | Hanno Cornelius | +| Contributors | Sanaz Taheri , Aaryamann Challani , Lorenzo Delgado , Abhimanyu Rawat , Oskar Thorén | + ## Abstract [10/WAKU2](/waku/standards/core/10/waku2.md) is a family of modular peer-to-peer protocols diff --git a/docs/waku/standards/core/15/bridge.md b/docs/waku/standards/core/15/bridge.md index bcb67ba..f5d0f1e 100644 --- a/docs/waku/standards/core/15/bridge.md +++ b/docs/waku/standards/core/15/bridge.md @@ -1,13 +1,12 @@ # 15/WAKU-BRIDGE -
- - - - - -
NameWaku Bridge
Slug15
Statusdraft
EditorHanno Cornelius <hanno@status.im>
-
+| Field | Value | +| --- | --- | +| Name | Waku Bridge | +| Slug | 15 | +| Status | draft | +| Editor | Hanno Cornelius | + ## Abstract This specification describes how [6/WAKU1](/waku/standards/legacy/6/waku1.md) diff --git a/docs/waku/standards/core/17/rln-relay.md b/docs/waku/standards/core/17/rln-relay.md index ff6e424..dabba96 100644 --- a/docs/waku/standards/core/17/rln-relay.md +++ b/docs/waku/standards/core/17/rln-relay.md @@ -1,14 +1,13 @@ # 17/WAKU2-RLN-RELAY -
- - - - - - -
NameWaku v2 RLN Relay
Slug17
Statusdraft
EditorAlvaro Revuelta <alvaro@status.im>
ContributorsOskar Thorén <oskarth@titanproxy.com>
Aaryamann Challani <p1ge0nh8er@proton.me>
Sanaz Taheri <sanaz@status.im>
Hanno Cornelius <hanno@status.im>
-
+| Field | Value | +| --- | --- | +| Name | Waku v2 RLN Relay | +| Slug | 17 | +| Status | draft | +| Editor | Alvaro Revuelta | +| Contributors | Oskar Thorén , Aaryamann Challani , Sanaz Taheri , Hanno Cornelius | + ## Abstract This specification describes the `17/WAKU2-RLN-RELAY` protocol, diff --git a/docs/waku/standards/core/19/lightpush.md b/docs/waku/standards/core/19/lightpush.md index 77976f3..dffec33 100644 --- a/docs/waku/standards/core/19/lightpush.md +++ b/docs/waku/standards/core/19/lightpush.md @@ -1,14 +1,13 @@ # 19/WAKU2-LIGHTPUSH -
- - - - - - -
NameWaku v2 Light Push
Slug19
Statusdraft
EditorHanno Cornelius <hanno@status.im>
ContributorsDaniel Kaiser <danielkaiser@status.im>
Oskar Thorén <oskarth@titanproxy.com>
-
+| Field | Value | +| --- | --- | +| Name | Waku v2 Light Push | +| Slug | 19 | +| Status | draft | +| Editor | Hanno Cornelius | +| Contributors | Daniel Kaiser , Oskar Thorén | + **Protocol identifier**: `/vac/waku/lightpush/2.0.0-beta1` ## Motivation and Goals diff --git a/docs/waku/standards/core/31/enr.md b/docs/waku/standards/core/31/enr.md index 758c634..70f0da5 100644 --- a/docs/waku/standards/core/31/enr.md +++ b/docs/waku/standards/core/31/enr.md @@ -1,13 +1,12 @@ # 31/WAKU2-ENR -
- - - - - -
NameWaku v2 usage of ENR
Slug31
Statusdraft
EditorFranck Royer <franck@status.im>
-
+| Field | Value | +| --- | --- | +| Name | Waku v2 usage of ENR | +| Slug | 31 | +| Status | draft | +| Editor | Franck Royer | + ## Abstract This specification describes the usage of the ENR (Ethereum Node Records) diff --git a/docs/waku/standards/core/33/discv5.md b/docs/waku/standards/core/33/discv5.md index 8740f13..b0e27ba 100644 --- a/docs/waku/standards/core/33/discv5.md +++ b/docs/waku/standards/core/33/discv5.md @@ -1,14 +1,13 @@ # 33/WAKU2-DISCV5 -
- - - - - - -
NameWaku v2 Discv5 Ambient Peer Discovery
Slug33
Statusdraft
EditorDaniel Kaiser <danielkaiser@status.im>
ContributorsFilip Dimitrijevic <filip@status.im>
-
+| Field | Value | +| --- | --- | +| Name | Waku v2 Discv5 Ambient Peer Discovery | +| Slug | 33 | +| Status | draft | +| Editor | Daniel Kaiser | +| Contributors | Filip Dimitrijevic | + ## Abstract `33/WAKU2-DISCV5` specifies a modified version of diff --git a/docs/waku/standards/core/34/peer-exchange.md b/docs/waku/standards/core/34/peer-exchange.md index ed06eca..d211679 100644 --- a/docs/waku/standards/core/34/peer-exchange.md +++ b/docs/waku/standards/core/34/peer-exchange.md @@ -1,15 +1,14 @@ # 34/WAKU2-PEER-EXCHANGE -
- - - - - - - -
NameWaku2 Peer Exchange
Slug34
Statusdraft
CategoryStandards Track
EditorHanno Cornelius <hanno@status.im>
ContributorsDaniel Kaiser <danielkaiser@status.im>
-
+| Field | Value | +| --- | --- | +| Name | Waku2 Peer Exchange | +| Slug | 34 | +| Status | draft | +| Category | Standards Track | +| Editor | Hanno Cornelius | +| Contributors | Daniel Kaiser | + ## Abstract This document specifies a simple request-response peer exchange protocol. diff --git a/docs/waku/standards/core/36/bindings-api.md b/docs/waku/standards/core/36/bindings-api.md index 03d9953..e6aa31a 100644 --- a/docs/waku/standards/core/36/bindings-api.md +++ b/docs/waku/standards/core/36/bindings-api.md @@ -1,14 +1,13 @@ # 36/WAKU2-BINDINGS-API -
- - - - - - -
NameWaku v2 C Bindings API
Slug36
Statusdraft
EditorRichard Ramos <richard@status.im>
ContributorsFranck Royer <franck@status.im>
-
+| Field | Value | +| --- | --- | +| Name | Waku v2 C Bindings API | +| Slug | 36 | +| Status | draft | +| Editor | Richard Ramos | +| Contributors | Franck Royer | + ## Introduction Native applications that wish to integrate Waku may not be able to use nwaku and diff --git a/docs/waku/standards/core/64/network.md b/docs/waku/standards/core/64/network.md index 8c5b194..a392a5b 100644 --- a/docs/waku/standards/core/64/network.md +++ b/docs/waku/standards/core/64/network.md @@ -1,14 +1,13 @@ # 64/WAKU2-NETWORK -
- - - - - - -
NameWaku v2 Network
Slug64
Statusdraft
CategoryBest Current Practice
EditorHanno Cornelius <hanno@status.im>
-
+| Field | Value | +| --- | --- | +| Name | Waku v2 Network | +| Slug | 64 | +| Status | draft | +| Category | Best Current Practice | +| Editor | Hanno Cornelius | + ## Abstract This specification describes an opinionated deployment of [10/WAKU2](../10/waku2.md) diff --git a/docs/waku/standards/core/66/metadata.md b/docs/waku/standards/core/66/metadata.md index 21e66a7..f54e965 100644 --- a/docs/waku/standards/core/66/metadata.md +++ b/docs/waku/standards/core/66/metadata.md @@ -1,14 +1,13 @@ # 66/WAKU2-METADATA -
- - - - - - -
NameWaku Metadata Protocol
Slug66
Statusdraft
EditorFranck Royer <franck@status.im>
ContributorsFilip Dimitrijevic <filip@status.im>
Alvaro Revuelta <alrevuelta@status.im>
-
+| Field | Value | +| --- | --- | +| Name | Waku Metadata Protocol | +| Slug | 66 | +| Status | draft | +| Editor | Franck Royer | +| Contributors | Filip Dimitrijevic , Alvaro Revuelta | + ## Abstract This specification describes the metadata diff --git a/docs/waku/standards/legacy/6/waku1.md b/docs/waku/standards/legacy/6/waku1.md index 2746895..0e055bf 100644 --- a/docs/waku/standards/legacy/6/waku1.md +++ b/docs/waku/standards/legacy/6/waku1.md @@ -1,14 +1,13 @@ # 6/WAKU1 -
- - - - - - -
NameWaku v1
Slug6
Statusstable
EditorOskar Thorén <oskarth@titanproxy.com>
ContributorsAdam Babik <adam@status.im>
Andrea Maria Piana <andreap@status.im>
Dean Eigenmann <dean@status.im>
Kim De Mey <kimdemey@status.im>
-
+| Field | Value | +| --- | --- | +| Name | Waku v1 | +| Slug | 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 diff --git a/docs/waku/standards/legacy/7/data.md b/docs/waku/standards/legacy/7/data.md index 858f928..9197ea6 100644 --- a/docs/waku/standards/legacy/7/data.md +++ b/docs/waku/standards/legacy/7/data.md @@ -1,14 +1,13 @@ # 7/WAKU-DATA -
- - - - - - -
NameWaku Envelope data field
Slug7
Statusstable
EditorOskar Thorén <oskarth@titanproxy.com>
ContributorsDean Eigenmann <dean@status.im>
Kim De Mey <kimdemey@status.im>
-
+| Field | Value | +| --- | --- | +| Name | Waku Envelope data field | +| Slug | 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/docs/waku/standards/legacy/8/mail.md b/docs/waku/standards/legacy/8/mail.md index 88178dc..8c5880f 100644 --- a/docs/waku/standards/legacy/8/mail.md +++ b/docs/waku/standards/legacy/8/mail.md @@ -1,14 +1,13 @@ # 8/WAKU-MAIL -
- - - - - - -
NameWaku Mailserver
Slug8
Statusstable
EditorAndrea Maria Piana <andreap@status.im>
ContributorsAdam Babik <adam@status.im>
Dean Eigenmann <dean@status.im>
Oskar Thorén <oskarth@titanproxy.com>
-
+| Field | Value | +| --- | --- | +| Name | Waku Mailserver | +| Slug | 8 | +| Status | stable | +| Editor | Andrea Maria Piana | +| Contributors | Adam Babik , Dean Eigenmann , Oskar Thorén | + ## Abstract In this specification, we describe Mailservers. diff --git a/docs/waku/standards/legacy/9/rpc.md b/docs/waku/standards/legacy/9/rpc.md index a80d066..78aa415 100644 --- a/docs/waku/standards/legacy/9/rpc.md +++ b/docs/waku/standards/legacy/9/rpc.md @@ -1,14 +1,13 @@ # 9/WAKU-RPC -
- - - - - - -
NameWaku RPC API
Slug9
Statusstable
EditorAndrea Maria Piana <andreap@status.im>
ContributorsDean Eigenmann <dean@status.im>
Oskar Thorén <oskarth@titanproxy.com>
-
+| Field | Value | +| --- | --- | +| Name | Waku RPC API | +| Slug | 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. diff --git a/scripts/gen_rfc_index.py b/scripts/gen_rfc_index.py index bd2fd41..0024d06 100644 --- a/scripts/gen_rfc_index.py +++ b/scripts/gen_rfc_index.py @@ -21,38 +21,27 @@ EXCLUDE_FILES = {"README.md", "SUMMARY.md"} EXCLUDE_PARTS = {"previous-versions"} -def parse_meta_from_html(text: str) -> Optional[Dict[str, str]]: - if '
' not in text: - return None - +def parse_meta_from_markdown_table(text: str) -> Optional[Dict[str, str]]: + lines = text.splitlines() meta: Dict[str, str] = {} - for match in re.findall(r"([^<]+)(.*?)", text, flags=re.DOTALL): - key = match[0].strip().lower() - value = match[1].replace("
", "\n").strip() - value = html.unescape(value) - meta[key] = value - - return meta or None - - -def parse_front_matter(text: str) -> Optional[Dict[str, str]]: - if not text.startswith("---"): - return None - - end = text.find("\n---", 3) - if end == -1: - return None - - front = text[3:end].strip().splitlines() - meta: Dict[str, str] = {} - for line in front: - if ":" not in line: + for i in range(len(lines) - 2): + line = lines[i].strip() + next_line = lines[i + 1].strip() + if not (line.startswith('|') and next_line.startswith('|') and '---' in next_line): continue - key, value = line.split(":", 1) - key = key.strip().lower() - value = value.strip().strip('"').strip("'") - if key and value: - meta[key] = value + + # Simple two-column table parsing + j = i + 2 + while j < len(lines) and lines[j].strip().startswith('|'): + parts = [p.strip() for p in lines[j].strip().strip('|').split('|')] + if len(parts) >= 2: + key = parts[0].lower() + value = html.unescape(parts[1]) + if key and value: + meta[key] = value + j += 1 + break + return meta or None @@ -75,9 +64,7 @@ def collect() -> List[Dict[str, str]]: text = path.read_text(encoding="utf-8", errors="ignore") - meta = parse_front_matter(text) - if meta is None: - meta = parse_meta_from_html(text) or {} + meta = parse_meta_from_markdown_table(text) or {} slug = meta.get("slug") title = meta.get("title") or meta.get("name") or parse_title_from_h1(text) or rel.stem diff --git a/scripts/rfc-index.js b/scripts/rfc-index.js index 9ba496a..4f49140 100644 --- a/scripts/rfc-index.js +++ b/scripts/rfc-index.js @@ -1,4 +1,93 @@ (() => { + function linkMenuTitle() { + const menuTitle = document.querySelector(".menu-title"); + if (!menuTitle || menuTitle.dataset.linked === "true") { + return; + } + + const existingLink = menuTitle.closest("a"); + if (existingLink) { + menuTitle.dataset.linked = "true"; + return; + } + + const root = (typeof path_to_root !== "undefined" && path_to_root) ? path_to_root : ""; + const link = document.createElement("a"); + link.href = `${root}index.html`; + link.className = "menu-title-link"; + link.setAttribute("aria-label", "Back to home"); + + const parent = menuTitle.parentNode; + parent.replaceChild(link, menuTitle); + link.appendChild(menuTitle); + menuTitle.dataset.linked = "true"; + } + + document.addEventListener("DOMContentLoaded", linkMenuTitle); + + document.addEventListener("DOMContentLoaded", () => { + const printLink = document.querySelector("a[href$='print.html']"); + if (!printLink) return; + printLink.addEventListener("click", (event) => { + event.preventDefault(); + window.print(); + }); + }); + + function initSidebarCollapsible(root) { + if (!root) return; + const items = root.querySelectorAll("li.chapter-item"); + items.forEach((item) => { + const section = item.querySelector(":scope > ol.section"); + const link = item.querySelector(":scope > .chapter-link-wrapper > a"); + if (!section || !link) return; + + if (!link.querySelector(".section-toggle")) { + const toggle = document.createElement("span"); + toggle.className = "section-toggle"; + toggle.setAttribute("role", "button"); + toggle.setAttribute("aria-label", "Toggle section"); + toggle.addEventListener("click", (event) => { + event.preventDefault(); + event.stopPropagation(); + item.classList.toggle("collapsed"); + }); + link.prepend(toggle); + } + + const hasActive = item.querySelector(".active"); + if (!hasActive) { + item.classList.add("collapsed"); + } + }); + } + + function bindSidebarCollapsible() { + const sidebar = document.querySelector("#mdbook-sidebar .sidebar-scrollbox"); + if (sidebar) { + initSidebarCollapsible(sidebar); + } + + const iframe = document.querySelector(".sidebar-iframe-outer"); + if (iframe) { + const onLoad = () => { + try { + initSidebarCollapsible(iframe.contentDocument); + } catch (e) { + // ignore access errors + } + }; + iframe.addEventListener("load", onLoad); + onLoad(); + } + } + + document.addEventListener("DOMContentLoaded", () => { + bindSidebarCollapsible(); + // toc.js may inject the sidebar after load + setTimeout(bindSidebarCollapsible, 100); + }); + const searchInput = document.getElementById("rfc-search"); const resultsCount = document.getElementById("results-count"); const tableContainer = document.getElementById("rfc-table-container");