2023-10-03 16:11:49 +00:00
|
|
|
<!DOCTYPE html>
|
|
|
|
|
<html lang="en" dir="ltr">
|
|
|
|
|
|
|
|
|
|
<head>
|
|
|
|
|
<meta name="generator" content="Hugo 0.106.0">
|
|
|
|
|
<meta charset="UTF-8">
|
|
|
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
|
|
|
<meta name="description" content="Metadata Protocol # Waku specifies a req/resp protocol that provides information about the node’s medatadata. Such metadata is meant to be used by the node to decide if a peer is worth connecting or not. The node that makes the request, includes its metadata so that the receiver is aware of it, without requiring an extra interaction. The parameters are the following:
|
|
|
|
|
clusterId: Unique identifier of the cluster that the node is running in.">
|
|
|
|
|
<meta name="theme-color" content="#FFFFFF"><meta property="og:title" content="66/WAKU2-METADATA" />
|
|
|
|
|
<meta property="og:description" content="Metadata Protocol # Waku specifies a req/resp protocol that provides information about the node’s medatadata. Such metadata is meant to be used by the node to decide if a peer is worth connecting or not. The node that makes the request, includes its metadata so that the receiver is aware of it, without requiring an extra interaction. The parameters are the following:
|
|
|
|
|
clusterId: Unique identifier of the cluster that the node is running in." />
|
|
|
|
|
<meta property="og:type" content="article" />
|
|
|
|
|
<meta property="og:url" content="https://rfc.vac.dev/spec/66/" /><meta property="article:section" content="docs" />
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<title>66/WAKU2-METADATA | 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=">
|
2023-10-05 11:07:17 +00:00
|
|
|
<script defer src="/en.search.min.63d0833c2423f05762cd743afc2b2d78c13d564374d961f99ba488bac6a2beef.js" integrity="sha256-Y9CDPCQj8FdizXQ6/CsteME9VkN02WH5m6SIusaivu8="></script>
|
2023-10-03 16:11:49 +00:00
|
|
|
<!--
|
|
|
|
|
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-V1</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/38/">38/CONSENSUS-CLARO</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>
|
|
|
|
|
<li><a href="/spec/46/">46/GOSSIPSUB-TOR-PUSH</a></li>
|
|
|
|
|
<li><a href="/spec/47/">47/WAKU2-TOR-PUSH</a></li>
|
|
|
|
|
<li><a href="/spec/48/">48/RLN-INTEREP-SPEC</a></li>
|
|
|
|
|
<li><a href="/spec/51/">51/WAKU2-RELAY-SHARDING</a></li>
|
|
|
|
|
<li><a href="/spec/52/">52/WAKU2-RELAY-STATIC-SHARD-ALLOC</a></li>
|
|
|
|
|
<li><a href="/spec/57/">57/STATUS-Simple-Scaling</a></li>
|
|
|
|
|
<li><a href="/spec/58/">58/RLN-V2</a></li>
|
|
|
|
|
<li><a href="/spec/61/">61/STATUS-Community-History-Archives</a></li>
|
|
|
|
|
<li><a href="/spec/63/">63/STATUS-Keycard-Usage</a></li>
|
|
|
|
|
<li><a href="/spec/64/">64/WAKU2-NETWORK</a></li>
|
|
|
|
|
<li><a href="/spec/66/"class=active>66/WAKU2-METADATA</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>
|
|
|
|
|
<li><a href="/spec/53/">53/WAKU2-X3DH</a></li>
|
|
|
|
|
<li><a href="/spec/54/">54/WAKU2-X3DH-SESSIONS</a></li>
|
|
|
|
|
<li><a href="/spec/55/">55/STATUS-1TO1-CHAT</a></li>
|
|
|
|
|
<li><a href="/spec/56/">56/STATUS-COMMUNITIES</a></li>
|
2023-10-05 11:07:17 +00:00
|
|
|
<li><a href="/spec/65/">65/STATUS-ACCOUNTS</a></li>
|
2023-10-03 16:11:49 +00:00
|
|
|
</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 e=document.querySelector("aside.book-menu nav");addEventListener("beforeunload",function(){localStorage.setItem("menu.scrollTop",e.scrollTop)}),e.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>66/WAKU2-METADATA</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="#metadata-protocol">Metadata Protocol</a>
|
|
|
|
|
<ul>
|
|
|
|
|
<li><a href="#protocol-id">Protocol id</a></li>
|
|
|
|
|
<li><a href="#request">Request</a></li>
|
|
|
|
|
<li><a href="#response">Response</a></li>
|
|
|
|
|
</ul>
|
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</nav>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</aside>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</header>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<article class="markdown">
|
|
|
|
|
<h1 id="66waku2-metadata">
|
|
|
|
|
66/WAKU2-METADATA
|
|
|
|
|
<a class="anchor" href="#66waku2-metadata">#</a>
|
|
|
|
|
</h1>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h1 id="waku-metadata-protocol">
|
|
|
|
|
Waku Metadata Protocol
|
|
|
|
|
<a class="anchor" href="#waku-metadata-protocol">#</a>
|
|
|
|
|
</h1>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<img src="https://img.shields.io/badge/status-raw-lightgrey?style=flat-square" />
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<ul>
|
|
|
|
|
<li>Status: raw</li>
|
|
|
|
|
<li>Editor: Alvaro Revuelta <a href="mailto:alrevuelta@status.im">alrevuelta@status.im</a></li>
|
|
|
|
|
|
|
|
|
|
</ul><h1 id="metadata-protocol">
|
|
|
|
|
Metadata Protocol
|
|
|
|
|
<a class="anchor" href="#metadata-protocol">#</a>
|
|
|
|
|
</h1>
|
|
|
|
|
<p>Waku specifies a req/resp protocol that provides information about the node’s medatadata. Such metadata is meant to be used
|
|
|
|
|
by the node to decide if a peer is worth connecting or not. The node that makes the request, includes its metadata
|
|
|
|
|
so that the receiver is aware of it, without requiring an extra interaction. The parameters are the following:</p>
|
|
|
|
|
<ul>
|
|
|
|
|
<li><code>clusterId</code>: Unique identifier of the cluster that the node is running in.</li>
|
|
|
|
|
<li><code>shards</code>: Shard indexes that the node is subscribed to.</li>
|
|
|
|
|
</ul>
|
|
|
|
|
<h2 id="protocol-id">
|
|
|
|
|
Protocol id
|
|
|
|
|
<a class="anchor" href="#protocol-id">#</a>
|
|
|
|
|
</h2>
|
|
|
|
|
<p><code>/vac/waku/metadata/1.0.0</code></p>
|
|
|
|
|
<h2 id="request">
|
|
|
|
|
Request
|
|
|
|
|
<a class="anchor" href="#request">#</a>
|
|
|
|
|
</h2>
|
|
|
|
|
<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-proto" data-lang="proto"><span style="display:flex;"><span><span style="color:#66d9ef">message</span> <span style="color:#a6e22e">WakuMetadataRequest</span> {<span style="color:#960050;background-color:#1e0010">
|
|
|
|
|
</span></span></span><span style="display:flex;"><span><span style="color:#960050;background-color:#1e0010"></span> <span style="color:#66d9ef">optional</span> <span style="color:#66d9ef">uint32</span> cluster_id <span style="color:#f92672">=</span> <span style="color:#ae81ff">1</span>;<span style="color:#960050;background-color:#1e0010">
|
|
|
|
|
</span></span></span><span style="display:flex;"><span><span style="color:#960050;background-color:#1e0010"></span> <span style="color:#66d9ef">repeated</span> <span style="color:#66d9ef">uint32</span> shards <span style="color:#f92672">=</span> <span style="color:#ae81ff">2</span>;<span style="color:#960050;background-color:#1e0010">
|
|
|
|
|
</span></span></span><span style="display:flex;"><span><span style="color:#960050;background-color:#1e0010"></span>}<span style="color:#960050;background-color:#1e0010">
|
|
|
|
|
</span></span></span></code></pre></div><h2 id="response">
|
|
|
|
|
Response
|
|
|
|
|
<a class="anchor" href="#response">#</a>
|
|
|
|
|
</h2>
|
|
|
|
|
<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-proto" data-lang="proto"><span style="display:flex;"><span><span style="color:#66d9ef">message</span> <span style="color:#a6e22e">WakuMetadataResponse</span> {<span style="color:#960050;background-color:#1e0010">
|
|
|
|
|
</span></span></span><span style="display:flex;"><span><span style="color:#960050;background-color:#1e0010"></span> <span style="color:#66d9ef">optional</span> <span style="color:#66d9ef">uint32</span> cluster_id <span style="color:#f92672">=</span> <span style="color:#ae81ff">1</span>;<span style="color:#960050;background-color:#1e0010">
|
|
|
|
|
</span></span></span><span style="display:flex;"><span><span style="color:#960050;background-color:#1e0010"></span> <span style="color:#66d9ef">repeated</span> <span style="color:#66d9ef">uint32</span> shards <span style="color:#f92672">=</span> <span style="color:#ae81ff">2</span>;<span style="color:#960050;background-color:#1e0010">
|
|
|
|
|
</span></span></span><span style="display:flex;"><span><span style="color:#960050;background-color:#1e0010"></span>}<span style="color:#960050;background-color:#1e0010">
|
|
|
|
|
</span></span></span></code></pre></div></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="#metadata-protocol">Metadata Protocol</a>
|
|
|
|
|
<ul>
|
|
|
|
|
<li><a href="#protocol-id">Protocol id</a></li>
|
|
|
|
|
<li><a href="#request">Request</a></li>
|
|
|
|
|
<li><a href="#response">Response</a></li>
|
|
|
|
|
</ul>
|
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</nav>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
</aside>
|
|
|
|
|
|
|
|
|
|
</main>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</body>
|
|
|
|
|
|
|
|
|
|
</html>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
