mirror of https://github.com/vacp2p/rfc.git
360 lines
11 KiB
HTML
360 lines
11 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en" dir="ltr">
|
|
|
|
<head>
|
|
<meta name="generator" content="Hugo 0.92.2" />
|
|
<meta charset="UTF-8">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
<meta name="description" content="(Info, remove this section) # This section contains meta info about writing RFCs. This section (including its subsections) MUST be removed.
|
|
COSS explains the Vac RFC process.
|
|
Tags # The tags metadata SHOULD contain a list of tags if applicable.
|
|
Currently identified tags comprise
|
|
waku/core-protocol for Waku protocol definitions (e.g. store, relay, light push), waku/application for applications built on top of Waku protocol (e.g. eth-dm, toy-chat), Abstract # Background / Rationale / Motivation # This section serves as an introduction providing background information and a motivation/rationale for why the specified protocol is useful.">
|
|
<meta name="theme-color" content="#FFFFFF"><meta property="og:title" content="XX/(WAKU2|LOGOS|CODEX|*)-TEMPLATE" />
|
|
<meta property="og:description" content="(Info, remove this section) # This section contains meta info about writing RFCs. This section (including its subsections) MUST be removed.
|
|
COSS explains the Vac RFC process.
|
|
Tags # The tags metadata SHOULD contain a list of tags if applicable.
|
|
Currently identified tags comprise
|
|
waku/core-protocol for Waku protocol definitions (e.g. store, relay, light push), waku/application for applications built on top of Waku protocol (e.g. eth-dm, toy-chat), Abstract # Background / Rationale / Motivation # This section serves as an introduction providing background information and a motivation/rationale for why the specified protocol is useful." />
|
|
<meta property="og:type" content="article" />
|
|
<meta property="og:url" content="https://rfc.vac.dev/spec/xx/" /><meta property="article:section" content="docs" />
|
|
|
|
|
|
|
|
<title>XX/(WAKU2|LOGOS|CODEX|*)-TEMPLATE | Vac RFC</title>
|
|
<link rel="manifest" href="/manifest.json">
|
|
<link rel="icon" href="/favicon.png" type="image/x-icon">
|
|
<link rel="stylesheet" href="/book.min.e935e20bd0d469378cb482f0958edf258c731a4f895dccd55799c6fbc8043f23.css" integrity="sha256-6TXiC9DUaTeMtILwlY7fJYxzGk+JXczVV5nG+8gEPyM=">
|
|
<script defer src="/en.search.min.91fd3c536519b740f8f116fe6c244859417e1f488c171b668524e0a9b063dff2.js" integrity="sha256-kf08U2UZt0D48Rb+bCRIWUF+H0iMFxtmhSTgqbBj3/I="></script>
|
|
<!--
|
|
Made with Book Theme
|
|
https://github.com/alex-shpak/hugo-book
|
|
-->
|
|
|
|
|
|
</head>
|
|
|
|
<body dir="ltr">
|
|
<input type="checkbox" class="hidden toggle" id="menu-control" />
|
|
<input type="checkbox" class="hidden toggle" id="toc-control" />
|
|
<main class="container flex">
|
|
<aside class="book-menu">
|
|
<div class="book-menu-content">
|
|
|
|
<nav>
|
|
<h2 class="book-brand">
|
|
<a href="/"><span>Vac RFC</span>
|
|
</a>
|
|
</h2>
|
|
|
|
|
|
<div class="book-search">
|
|
<input type="text" id="book-search-input" placeholder="Search" aria-label="Search" maxlength="64" data-hotkeys="s/" />
|
|
<div class="book-search-spinner hidden"></div>
|
|
<ul id="book-search-results"></ul>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<ul>
|
|
<li>Raw
|
|
<ul>
|
|
<li><a href="/spec/20/">20/TOY-ETH-PM</a></li>
|
|
<li><a href="/spec/24/">24/STATUS-CURATION</a></li>
|
|
<li><a href="/spec/28/">28/STATUS-FEATURING</a></li>
|
|
<li><a href="/spec/31/">31/WAKU2-ENR</a></li>
|
|
<li><a href="/spec/32/">32/RLN-SPEC</a></li>
|
|
<li><a href="/spec/34/">34/WAKU2-PEER-EXCHANGE</a></li>
|
|
<li><a href="/spec/35/">35/WAKU2-NOISE</a></li>
|
|
<li><a href="/spec/37/">37/WAKU2-NOISE-SESSIONS</a></li>
|
|
<li><a href="/spec/43/">43/WAKU2-NOISE-PAIRING</a></li>
|
|
<li><a href="/spec/44/">44/WAKU2-DANDELION</a></li>
|
|
<li><a href="/spec/45/">45/WAKU2-ADVERSARIAL-MODELS</a></li>
|
|
</ul>
|
|
</li>
|
|
<li>Draft
|
|
<ul>
|
|
<li><a href="/spec/1/">1/COSS</a></li>
|
|
<li><a href="/spec/3/">3/REMOTE-LOG</a></li>
|
|
<li><a href="/spec/4/">4/MVDS-META</a></li>
|
|
<li><a href="/spec/10/">10/WAKU2</a></li>
|
|
<li><a href="/spec/12/">12/WAKU2-FILTER</a></li>
|
|
<li><a href="/spec/13/">13/WAKU2-STORE</a></li>
|
|
<li><a href="/spec/14/">14/WAKU2-MESSAGE</a></li>
|
|
<li><a href="/spec/15/">15/WAKU2-BRIDGE</a></li>
|
|
<li><a href="/spec/16/">16/WAKU2-RPC</a></li>
|
|
<li><a href="/spec/17/">17/WAKU2-RLN-RELAY</a></li>
|
|
<li><a href="/spec/18/">18/WAKU2-SWAP</a></li>
|
|
<li><a href="/spec/19/">19/WAKU2-LIGHTPUSH</a></li>
|
|
<li><a href="/spec/21/">21/WAKU2-FTSTORE</a></li>
|
|
<li><a href="/spec/22/">22/TOY-CHAT</a></li>
|
|
<li><a href="/spec/23/">23/WAKU2-TOPICS</a></li>
|
|
<li><a href="/spec/26/">26/WAKU2-PAYLOAD</a></li>
|
|
<li><a href="/spec/27/">27/WAKU2-PEERS</a></li>
|
|
<li><a href="/spec/29/">29/WAKU2-CONFIG</a></li>
|
|
<li><a href="/spec/30/">30/ADAPTIVE-NODES</a></li>
|
|
<li><a href="/spec/33/">33/WAKU2-DISCV5</a></li>
|
|
<li><a href="/spec/36/">36/WAKU2-BINDINGS-API</a></li>
|
|
</ul>
|
|
</li>
|
|
<li>Stable
|
|
<ul>
|
|
<li><a href="/spec/2/">2/MVDS</a></li>
|
|
<li><a href="/spec/6/">6/WAKU1</a></li>
|
|
<li><a href="/spec/7/">7/WAKU-DATA</a></li>
|
|
<li><a href="/spec/8/">8/WAKU-MAIL</a></li>
|
|
<li><a href="/spec/9/">9/WAKU-RPC</a></li>
|
|
<li><a href="/spec/11/">11/WAKU2-RELAY</a></li>
|
|
</ul>
|
|
</li>
|
|
<li>Deprecated
|
|
<ul>
|
|
<li><a href="/spec/5/">5/WAKU0</a></li>
|
|
</ul>
|
|
</li>
|
|
<li>Retired</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</nav>
|
|
|
|
|
|
|
|
|
|
<script>(function(){var a=document.querySelector("aside.book-menu nav");addEventListener("beforeunload",function(b){localStorage.setItem("menu.scrollTop",a.scrollTop)}),a.scrollTop=localStorage.getItem("menu.scrollTop")})()</script>
|
|
|
|
|
|
|
|
</div>
|
|
</aside>
|
|
|
|
<div class="book-page">
|
|
<header class="book-header">
|
|
|
|
<div class="flex align-center justify-between">
|
|
<label for="menu-control">
|
|
<img src="/svg/menu.svg" class="book-icon" alt="Menu" />
|
|
</label>
|
|
|
|
<strong>XX/(WAKU2|LOGOS|CODEX|*)-TEMPLATE</strong>
|
|
|
|
<label for="toc-control">
|
|
|
|
<img src="/svg/toc.svg" class="book-icon" alt="Table of Contents" />
|
|
|
|
</label>
|
|
</div>
|
|
|
|
|
|
|
|
<aside class="hidden clearfix">
|
|
|
|
|
|
<nav id="TableOfContents">
|
|
<ul>
|
|
<li><a href="#tags">Tags</a></li>
|
|
</ul>
|
|
|
|
<ul>
|
|
<li><a href="#normative">normative</a></li>
|
|
<li><a href="#informative">informative</a></li>
|
|
</ul>
|
|
</nav>
|
|
|
|
|
|
|
|
</aside>
|
|
|
|
|
|
</header>
|
|
|
|
|
|
|
|
<article class="markdown">
|
|
<h1 id="xxwaku2logoscodex-template">XX/(WAKU2|LOGOS|CODEX|*)-TEMPLATE</h1>
|
|
|
|
|
|
<h1 id="waku-v2--logos--codex-rfc-template">(Waku v2 | Logos | Codex) RFC Template</h1>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<ul>
|
|
<li>Status: (raw|draft|stable)</li>
|
|
<li>Editor: Daniel Kaiser <a href="mailto:danielkaiser@status.im">danielkaiser@status.im</a></li>
|
|
|
|
</ul><h1 id="info-remove-this-section">
|
|
(Info, remove this section)
|
|
<a class="anchor" href="#info-remove-this-section">#</a>
|
|
</h1>
|
|
<p>This section contains meta info about writing RFCs.
|
|
This section (including its subsections) MUST be removed.</p>
|
|
<p><a href="https://rfc.vac.dev/spec/1/">COSS</a> explains the Vac RFC process.</p>
|
|
<h2 id="tags">
|
|
Tags
|
|
<a class="anchor" href="#tags">#</a>
|
|
</h2>
|
|
<p>The <code>tags</code> metadata SHOULD contain a list of tags if applicable.</p>
|
|
<p>Currently identified tags comprise</p>
|
|
<ul>
|
|
<li><code>waku/core-protocol</code> for Waku protocol definitions (e.g. store, relay, light push),</li>
|
|
<li><code>waku/application</code> for applications built on top of Waku protocol (e.g. eth-dm, toy-chat),</li>
|
|
</ul>
|
|
<h1 id="abstract">
|
|
Abstract
|
|
<a class="anchor" href="#abstract">#</a>
|
|
</h1>
|
|
<h1 id="background--rationale--motivation">
|
|
Background / Rationale / Motivation
|
|
<a class="anchor" href="#background--rationale--motivation">#</a>
|
|
</h1>
|
|
<p>This section serves as an introduction providing background information and a motivation/rationale for why the specified protocol is useful.</p>
|
|
<h1 id="theory--semantics">
|
|
Theory / Semantics
|
|
<a class="anchor" href="#theory--semantics">#</a>
|
|
</h1>
|
|
<p>A standard track RFC in <code>stable</code> status MUST feature this section.
|
|
A standard track RFC in <code>raw</code> or <code>draft</code> status SHOULD feature this section.
|
|
This section SHOULD explain in detail how the proposed protocol works.
|
|
It may touch on the wire format where necessary for the explanation.
|
|
This section MAY also specify endpoint behaviour when receiving specific messages, e.g. the behaviour of certain caches etc.</p>
|
|
<h1 id="wire-format-specification--syntax">
|
|
Wire Format Specification / Syntax
|
|
<a class="anchor" href="#wire-format-specification--syntax">#</a>
|
|
</h1>
|
|
<p>A standard track RFC in <code>stable</code> status MUST feature this section.
|
|
A standard track RFC in <code>raw</code> or <code>draft</code> status SHOULD feature this section.
|
|
This section SHOULD not contain explanations of semantics and focus on concisely defining the wire format.
|
|
Implementations MUST adhere to these exact formats to interoperate with other implementations.
|
|
It is fine, if parts of the previous section that touch on the wire format are repeated.
|
|
The purpose of this section is having a concise definition of what an implementation sends and accepts.
|
|
Parts that are not specified here are considered implementation details. Implementors are free to decide on how to implement these details.
|
|
An optional <em>implementation suggestions</em> section may provide suggestions on how to approach implementation details, and, if available, point to existing implementations for reference.</p>
|
|
<h1 id="implementation-suggestions-optional">
|
|
Implementation Suggestions (optional)
|
|
<a class="anchor" href="#implementation-suggestions-optional">#</a>
|
|
</h1>
|
|
<h1 id="further-optional-sections">
|
|
(Further Optional Sections)
|
|
<a class="anchor" href="#further-optional-sections">#</a>
|
|
</h1>
|
|
<h1 id="securityprivacy-considerations">
|
|
Security/Privacy Considerations
|
|
<a class="anchor" href="#securityprivacy-considerations">#</a>
|
|
</h1>
|
|
<p>A standard track RFC in <code>stable</code> status MUST feature this section.
|
|
A standard track RFC in <code>raw</code> or <code>draft</code> status SHOULD feature this section.
|
|
Informational RFCs (in any state) may feature this section.
|
|
If there are none, this section MUST explicitly state that fact.
|
|
This section MAY contain additional relevant information, e.g. an explanation as to why there are no security consideration for the respective document.</p>
|
|
<h1 id="copyright">
|
|
Copyright
|
|
<a class="anchor" href="#copyright">#</a>
|
|
</h1>
|
|
<p>Copyright and related rights waived via <a href="https://creativecommons.org/publicdomain/zero/1.0/">CC0</a>.</p>
|
|
<h1 id="references">
|
|
References
|
|
<a class="anchor" href="#references">#</a>
|
|
</h1>
|
|
<p>References MAY be subdivided into normative and informative.</p>
|
|
<h2 id="normative">
|
|
normative
|
|
<a class="anchor" href="#normative">#</a>
|
|
</h2>
|
|
<p>A list of references that MUST be read to fully understand and/or implement this protocol.
|
|
See <a href="https://datatracker.ietf.org/doc/html/rfc3967#section-1.1">RFC3967 Section 1.1</a>.</p>
|
|
<h2 id="informative">
|
|
informative
|
|
<a class="anchor" href="#informative">#</a>
|
|
</h2>
|
|
<p>A list of additional references.</p>
|
|
</article>
|
|
|
|
|
|
|
|
<footer class="book-footer">
|
|
|
|
<div class="flex flex-wrap justify-between">
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
</footer>
|
|
|
|
|
|
|
|
<div class="book-comments">
|
|
|
|
</div>
|
|
|
|
|
|
|
|
<label for="menu-control" class="hidden book-menu-overlay"></label>
|
|
</div>
|
|
|
|
|
|
<aside class="book-toc">
|
|
<div class="book-toc-content">
|
|
|
|
|
|
<nav id="TableOfContents">
|
|
<ul>
|
|
<li><a href="#tags">Tags</a></li>
|
|
</ul>
|
|
|
|
<ul>
|
|
<li><a href="#normative">normative</a></li>
|
|
<li><a href="#informative">informative</a></li>
|
|
</ul>
|
|
</nav>
|
|
|
|
|
|
|
|
</div>
|
|
</aside>
|
|
|
|
</main>
|
|
|
|
|
|
</body>
|
|
|
|
</html>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|