2022-05-02 05:12:46 +00:00
|
|
|
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ENRTree | 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="../modules/discovery.html">discovery</a></li><li><a href="discovery.ENRTree.html">ENRTree</a></li></ul><h1>Class ENRTree</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">ENRTree</span></li></ul></section><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>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="discovery.ENRTree.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><a href="discovery.ENRTree.html#BRANCH_PREFIX" class="tsd-kind-icon">BRANCH_<wbr/>PREFIX</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><a href="discovery.ENRTree.html#RECORD_PREFIX" class="tsd-kind-icon">RECORD_<wbr/>PREFIX</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><a href="discovery.ENRTree.html#ROOT_PREFIX" class="tsd-kind-icon">ROOT_<wbr/>PREFIX</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><a href="discovery.ENRTree.html#TREE_PREFIX" class="tsd-kind-icon">TREE_<wbr/>PREFIX</a></li></ul></section><section class="tsd-index-section "><h3>Methods</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="discovery.ENRTree.html#parseAndVerifyRoot" class="tsd-kind-icon">parse<wbr/>And<wbr/>Verify<wbr/>Root</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="discovery.ENRTree.html#parseBranch" class="tsd-kind-icon">parse<wbr/>Branch</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="discovery.ENRTree.html#parseRootValues" class="tsd-kind-icon">parse<wbr/>Root<wbr/>Values</a></li><li class="tsd-kind-me
|
2022-01-24 10:13:20 +00:00
|
|
|
<p>Extracts the branch subdomain referenced by a DNS tree root string after verifying
|
|
|
|
|
the root record signature with its base32 compressed public key.</p>
|
2022-05-02 05:12:46 +00:00
|
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>root: <span class="tsd-signature-type">string</span></h5></li><li><h5>publicKey: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static"><a id="parseBranch" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagStatic">Static</span> parse<wbr/>Branch<a href="#parseBranch" 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><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static"><li class="tsd-signature tsd-kind-icon">parse<wbr/>Branch<span class="tsd-signature-symbol">(</span>branch<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/status-im/js-waku/blob/5377bd6/src/lib/discovery/enrtree.ts#L108">src/lib/discovery/enrtree.ts:108</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
2022-01-24 10:13:20 +00:00
|
|
|
<p>Returns subdomains listed in an ENR branch entry. These in turn lead to
|
|
|
|
|
either further branch entries or ENR records.</p>
|
2022-05-02 05:12:46 +00:00
|
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>branch: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static"><a id="parseRootValues" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagStatic">Static</span> parse<wbr/>Root<wbr/>Values<a href="#parseRootValues" 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><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static"><li class="tsd-signature tsd-kind-icon">parse<wbr/>Root<wbr/>Values<span class="tsd-signature-symbol">(</span>txt<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../modules/discovery.html#ENRRootValues" class="tsd-signature-type" data-tsd-kind="Type alias">ENRRootValues</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/status-im/js-waku/blob/5377bd6/src/lib/discovery/enrtree.ts#L62">src/lib/discovery/enrtree.ts:62</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>txt: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="../modules/discovery.html#ENRRootValues" class="tsd-signature-type" data-tsd-kind="Type alias">ENRRootValues</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static"><a id="parseTree" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagStatic">Static</span> parse<wbr/>Tree<a href="#parseTree" 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><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static"><li class="tsd-signature tsd-kind-icon">parse<wbr/>Tree<span class="tsd-signature-symbol">(</span>tree<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../modules/discovery.html#ENRTreeValues" class="tsd-signature-type" data-tsd-kind="Type alias">ENRTreeValues</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/status-im/js-waku/blob/5377bd6/src/lib/discovery/enrtree.ts#L85">src/lib/discovery/enrtree.ts:85</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
2022-01-24 10:13:20 +00:00
|
|
|
<p>Returns the public key and top level domain of an ENR tree entry.
|
|
|
|
|
The domain is the starting point for traversing a set of linked DNS TXT records
|
|
|
|
|
and the public key is used to verify the root entry record</p>
|
2022-03-25 06:17:30 +00:00
|
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>tree: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="../modules/discovery.html#ENRTreeValues" class="tsd-signature-type" data-tsd-kind="Type alias">ENRTreeValues</a></h4></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li><li class="current tsd-kind-namespace"><a href="../modules/discovery.html">discovery</a><ul><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="../modules/discovery.predefined.html">predefined</a></li></ul></li><li class=" tsd-kind-namespace"><a href="../modules/enr.html">enr</a></li><li class=" tsd-kind-namespace"><a href="../modules/utils.html">utils</a></li><li class=" tsd-kind-namespace"><a href="../modules/waku.html">waku</a></li><li class=" tsd-kind-namespace"><a href="../modules/waku_light_push.html">waku_<wbr/>light_<wbr/>push</a></li><li class=" tsd-kind-namespace"><a href="../modules/waku_message.html">waku_<wbr/>message</a></li><li class=" tsd-kind-namespace"><a href="../modules/waku_relay.html">waku_<wbr/>relay</a></li><li class=" tsd-kind-namespace"><a href="../modules/waku_store.html">waku_<wbr/>store</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-class tsd-parent-kind-namespace"><a href="discovery.ENRTree.html" class="tsd-kind-icon">ENRTree</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="discovery.ENRTree.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><a href="discovery.ENRTree.html#BRANCH_PREFIX" class="tsd-kind-icon">BRANCH_<wbr/>PREFIX</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><a href="discovery.ENRTree.html#RECORD_PREFIX" class="tsd-kind-icon">RECORD_<wbr/>PREFIX</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><a href="discovery.ENRTree.html#ROOT_PREFIX" class="tsd-kind-icon">ROOT_<wbr/>PREFIX</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><a href="discovery.ENRTree.html#TREE_PREFIX" class="tsd-kind-icon">TREE_<wbr/>PREFIX</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="discovery.ENRTree.html#parseAndVerifyRoot" class="tsd-kind-icon">parse<wbr/>And<wbr/>Verify<wbr/>Root</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="discovery.ENRTree.html#parseBranch" class="tsd-kind-icon">parse<wbr/>Branch</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="discovery.ENRTree.html#parseRootValues" class="tsd-kind-icon">parse<wbr/>Root<wbr/>Values</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="discovery.ENRTree.html#parseTree" class="tsd-kind-icon">parse<wbr/>Tree</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>
|
