js-waku/modules/enr.html

4 lines
32 KiB
HTML
Raw Normal View History

2022-05-27 01:12:25 +00:00
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>enr | js-waku</title><meta name="description" content="Documentation for js-waku"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">js-waku</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">js-waku</a></li><li><a href="enr.html">enr</a></li></ul><h1>Namespace enr</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Enumerations</h3><ul class="tsd-index-list"><li class="tsd-kind-enum tsd-parent-kind-namespace"><a href="../enums/enr.KeypairType.html" class="tsd-kind-icon">Keypair<wbr/>Type</a></li></ul></section><section class="tsd-index-section "><h3>Classes</h3><ul class="tsd-index-list"><li class="tsd-kind-class tsd-parent-kind-namespace"><a href="../classes/enr.ENR.html" class="tsd-kind-icon">ENR</a></li><li class="tsd-kind-class tsd-parent-kind-namespace"><a href="../classes/enr.Secp256k1Keypair.html" class="tsd-kind-icon">Secp256k1<wbr/>Keypair</a></li></ul></section><section class="tsd-index-section "><h3>Interfaces</h3><ul class="tsd-index-list"><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/enr.IKeypair.html" class="tsd-kind-icon">IKeypair</a></li><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/enr.Waku2.html" class="tsd-kind-icon">Waku2</a></li></ul></section><section class="tsd-index-section "><h3>Type aliases</h3><ul class="tsd-index-list"><li class="tsd-kind-type-alias tsd-parent-kind-namespace"><a href="enr.html#ENRKey" class="tsd-kind-icon">ENRKey</a></li><li class="tsd-kind-type-alias tsd-parent-kind-namespace"><a href="enr.html#ENRValue" class="tsd-kind-icon">ENRValue</a></li><li class="tsd-kind-type-alias tsd-parent-kind-namespace"><a href="enr.html#NodeId" class="tsd-kind-icon">Node<wbr/>Id</a></li><li class="tsd-kind-type-alias tsd-parent-kind-namespace"><a href="enr.html#SequenceNumber" class="tsd-kind-icon">Sequence<wbr/>Number</a></li></ul></section><section class="tsd-index-section "><h3>Variables</h3><ul class="tsd-index-list"><li class="tsd-kind-variable tsd-parent-kind-namespace"><a href="enr.html#ERR_INVALID_ID" class="tsd-kind-icon">ERR_<wbr/>INVALID_<wbr/>ID</a></li><
2022-01-24 10:13:20 +00:00
<p>We represent NodeId as a hex string, since node equality is used very heavily
and it is convenient to index data by NodeId</p>
2022-05-27 01:12:25 +00:00
</div></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace"><a id="SequenceNumber" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Sequence<wbr/>Number<a href="#SequenceNumber" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Sequence<wbr/>Number<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">bigint</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/status-im/js-waku/blob/ac56778/src/lib/enr/types.ts#L8">src/lib/enr/types.ts:8</a></li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group "><h2>Variables</h2><section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-namespace"><a id="ERR_INVALID_ID" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagConst">Const</span> ERR_<wbr/>INVALID_<wbr/>ID<a href="#ERR_INVALID_ID" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">ERR_<wbr/>INVALID_<wbr/>ID<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;Invalid record id&quot;</span><span class="tsd-signature-symbol"> = &quot;Invalid record id&quot;</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/status-im/js-waku/blob/ac56778/src/lib/enr/constants.ts#L4">src/lib/enr/constants.ts:4</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-namespace"><a id="ERR_NO_SIGNATURE" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagConst">Const</span> ERR_<wbr/>NO_<wbr/>SIGNATURE<a href="#ERR_NO_SIGNATURE" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">ERR_<wbr/>NO_<wbr/>SIGNATURE<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;No valid signature found&quot;</span><span class="tsd-signature-symbol"> = &quot;No valid signature found&quot;</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/status-im/js-waku/blob/ac56778/src/lib/enr/constants.ts#L6">src/lib/enr/constants.ts:6</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-namespace"><a id="ERR_TYPE_NOT_IMPLEMENTED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagConst">Const</span> ERR_<wbr/>TYPE_<wbr/>NOT_<wbr/>IMPLEMENTED<a href="#ERR_TYPE_NOT_IMPLEMENTED" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 1