2022-01-24 08:45:55 +00:00
<!DOCTYPE html> < html class = "default" > < head > < meta charSet = "utf-8" / > < meta http-equiv = "x-ua-compatible" content = "IE=edge" / > < title > BootstrapOptions | 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.BootstrapOptions.html" > BootstrapOptions< / a > < / li > < / ul > < h1 > Interface BootstrapOptions< / h1 > < / div > < / div > < / header > < div class = "container container-main" > < div class = "row" > < div class = "col-8 col-content" > < section class = "tsd-panel tsd-comment" > < div class = "tsd-comment tsd-typography" > < div class = "lead" >
< p > Setup discovery method used to bootstrap.< / p >
< / div > < div > < p > Only one method is used. < code > default< / code > , < code > peers< / code > , < code > getPeers< / code > and < code > enr< / code > options are mutually exclusive.< / p >
2022-02-23 23:57:01 +00:00
< / div > < / div > < / section > < section class = "tsd-panel tsd-hierarchy" > < h3 > Hierarchy< / h3 > < ul class = "tsd-hierarchy" > < li > < span class = "target" > BootstrapOptions< / 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 > Properties< / h3 > < ul class = "tsd-index-list" > < li class = "tsd-kind-property tsd-parent-kind-interface" > < a href = "discovery.BootstrapOptions.html#default" class = "tsd-kind-icon" > default< / a > < / li > < li class = "tsd-kind-property tsd-parent-kind-interface" > < a href = "discovery.BootstrapOptions.html#enrUrl" class = "tsd-kind-icon" > enr< wbr / > Url< / a > < / li > < li class = "tsd-kind-property tsd-parent-kind-interface" > < a href = "discovery.BootstrapOptions.html#maxPeers" class = "tsd-kind-icon" > max< wbr / > Peers< / a > < / li > < li class = "tsd-kind-property tsd-parent-kind-interface" > < a href = "discovery.BootstrapOptions.html#peers" class = "tsd-kind-icon" > peers< / 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-interface" > < a href = "discovery.BootstrapOptions.html#getPeers" class = "tsd-kind-icon" > get< wbr / > Peers< / a > < / li > < / ul > < / section > < / div > < / section > < / section > < section class = "tsd-panel-group tsd-member-group " > < h2 > Properties< / h2 > < section class = "tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface" > < a id = "default" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > < span class = "tsd-flag ts-flagOptional" > Optional< / span > default< a href = "#default" 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" > default< span class = "tsd-signature-symbol" > ?:< / span > < span class = "tsd-signature-type" > boolean< / span > < / div > < aside class = "tsd-sources" > < ul > < li > Defined in < a href = "https://github.com/status-im/js-waku/blob/b50e211/src/lib/discovery/bootstrap.ts#L30" > src/lib/discovery/bootstrap.ts:30< / a > < / li > < / ul > < / aside > < div class = "tsd-comment tsd-typography" > < div class = "lead" >
2022-01-24 08:45:55 +00:00
< p > Use the default discovery method. Overrides all other options but < code > maxPeers< / code > < / p >
< / div > < div > < p > The default discovery method is likely to change overtime as new discovery
methods are implemented.< / p >
< / div > < dl class = "tsd-comment-tags" > < dt > default< / dt > < dd > < p > false< / p >
2022-02-23 23:57:01 +00:00
< / dd > < / dl > < / div > < / section > < section class = "tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface" > < a id = "enrUrl" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > < span class = "tsd-flag ts-flagOptional" > Optional< / span > enr< wbr / > Url< a href = "#enrUrl" 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" > enr< wbr / > Url< span class = "tsd-signature-symbol" > ?:< / span > < span class = "tsd-signature-type" > string< / span > < / div > < aside class = "tsd-sources" > < ul > < li > Defined in < a href = "https://github.com/status-im/js-waku/blob/b50e211/src/lib/discovery/bootstrap.ts#L43" > src/lib/discovery/bootstrap.ts:43< / a > < / li > < / ul > < / aside > < div class = "tsd-comment tsd-typography" > < div class = "lead" >
2022-01-24 08:45:55 +00:00
< p > An EIP-1459 ENR Tree URL. For example:
" enrtree://< a href = "mailto:AOFTICU2XWDULNLZGRMQS4RIZPAZEHYMV4FYHAPW563HNRAOERP7C@test.nodes.vac.dev" > AOFTICU2XWDULNLZGRMQS4RIZPAZEHYMV4FYHAPW563HNRAOERP7C@test.nodes.vac.dev< / a > " < / p >
2022-02-23 23:57:01 +00:00
< / div > < / div > < / section > < section class = "tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface" > < a id = "maxPeers" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > < span class = "tsd-flag ts-flagOptional" > Optional< / span > max< wbr / > Peers< a href = "#maxPeers" 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" > max< wbr / > Peers< span class = "tsd-signature-symbol" > ?:< / span > < span class = "tsd-signature-type" > number< / span > < / div > < aside class = "tsd-sources" > < ul > < li > Defined in < a href = "https://github.com/status-im/js-waku/blob/b50e211/src/lib/discovery/bootstrap.ts#L21" > src/lib/discovery/bootstrap.ts:21< / a > < / li > < / ul > < / aside > < div class = "tsd-comment tsd-typography" > < div class = "lead" >
2022-01-24 08:45:55 +00:00
< p > The maximum of peers to connect to as part of the bootstrap process.< / p >
< / div > < dl class = "tsd-comment-tags" > < dt > default< / dt > < dd > < p > < a href = "../classes/discovery.Bootstrap.html#DefaultMaxPeers" > Bootstrap.DefaultMaxPeers< / a > < / p >
2022-02-23 23:57:01 +00:00
< / dd > < / dl > < / div > < / section > < section class = "tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface" > < a id = "peers" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > < span class = "tsd-flag ts-flagOptional" > Optional< / span > peers< a href = "#peers" 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" > peers< span class = "tsd-signature-symbol" > ?:< / span > < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > []< / span > < / div > < aside class = "tsd-sources" > < ul > < li > Defined in < a href = "https://github.com/status-im/js-waku/blob/b50e211/src/lib/discovery/bootstrap.ts#L34" > src/lib/discovery/bootstrap.ts:34< / a > < / li > < / ul > < / aside > < div class = "tsd-comment tsd-typography" > < div class = "lead" >
2022-01-24 08:45:55 +00:00
< p > Multiaddrs of peers to connect to.< / p >
2022-02-23 23:57:01 +00:00
< / div > < / div > < / section > < / section > < section class = "tsd-panel-group tsd-member-group " > < h2 > Methods< / h2 > < section class = "tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface" > < a id = "getPeers" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > < span class = "tsd-flag ts-flagOptional" > Optional< / span > get< wbr / > Peers< a href = "#getPeers" 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-interface" > < li class = "tsd-signature tsd-kind-icon" > get< wbr / > Peers< span class = "tsd-signature-symbol" > (< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > Promise< / span > < span class = "tsd-signature-symbol" > < < / span > < span class = "tsd-signature-type" > Multiaddr< / 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 > < 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/b50e211/src/lib/discovery/bootstrap.ts#L38" > src/lib/discovery/bootstrap.ts:38< / a > < / li > < / ul > < / aside > < div class = "tsd-comment tsd-typography" > < div class = "lead" >
2022-01-24 08:45:55 +00:00
< p > Getter that retrieve multiaddrs of peers to connect to.< / p >
2022-02-21 09:57:52 +00:00
< / div > < / div > < h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > Promise< / span > < span class = "tsd-signature-symbol" > < < / span > < span class = "tsd-signature-type" > Multiaddr< / 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 > < span class = "tsd-signature-symbol" > > < / span > < / 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/proto.html" > proto< / a > < / li > < li class = " tsd-kind-namespace" > < a href = "../modules/utf8.html" > utf8< / 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-interface tsd-parent-kind-namespace" > < a href = "discovery.BootstrapOptions.html" class = "tsd-kind-icon" > Bootstrap< wbr / > Options< / a > < ul > < li class = "tsd-kind-property tsd-parent-kind-interface" > < a href = "discovery.BootstrapOptions.html#default" class = "tsd-kind-icon" > default< / a > < / li > < li class = "tsd-kind-property tsd-parent-kind-interface" > < a href = "discovery.BootstrapOptions.html#enrUrl" class = "tsd-kind-icon" > enr< wbr / > Url< / a > < / li > < li class = "tsd-kind-property tsd-parent-kind-interface" > < a href = "discovery.BootstrapOptions.html#maxPeers" class = "tsd-kind-icon" > max< wbr / > Peers< / a > < / li > < li class = "tsd-kind-property tsd-parent-kind-interface" > < a href = "discovery.BootstrapOptions.html#peers" class = "tsd-kind-icon" > peers< / a > < / li > < li class = "tsd-kind-method tsd-parent-kind-interface" > < a href = "discovery.BootstrapOptions.html#getPeers" class = "tsd-kind-icon" > get< wbr / > Peers< / 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-interface" > < span class = "tsd-kind-icon" > Property< / span > < / li > < li class = "tsd-kind-method tsd-parent-kind-interface" > < span class = "tsd-kind-icon" > Method< / 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 >
