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 > 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" > < h1 > js-waku< / 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 > References< / h3 > < ul class = "tsd-index-list" > < li class = "tsd-kind-reference" > < a href = "modules.html#DefaultPubSubTopic" class = "tsd-kind-icon" > Default< wbr / > Pub< wbr / > Sub< wbr / > Topic< / a > < / li > < li class = "tsd-kind-reference" > < a href = "modules.html#LightPushCodec" class = "tsd-kind-icon" > Light< wbr / > Push< wbr / > Codec< / a > < / li > < li class = "tsd-kind-reference" > < a href = "modules.html#PageDirection" class = "tsd-kind-icon" > Page< wbr / > Direction< / a > < / li > < li class = "tsd-kind-reference" > < a href = "modules.html#Protocols" class = "tsd-kind-icon" > Protocols< / a > < / li > < li class = "tsd-kind-reference" > < a href = "modules.html#PushResponse" class = "tsd-kind-icon" > Push< wbr / > Response< / a > < / li > < li class = "tsd-kind-reference" > < a href = "modules.html#RelayCodecs" class = "tsd-kind-icon" > Relay< wbr / > Codecs< / a > < / li > < li class = "tsd-kind-reference" > < a href = "modules.html#StoreCodecs" class = "tsd-kind-icon" > Store< wbr / > Codecs< / a > < / li > < li class = "tsd-kind-reference" > < a href = "modules.html#Waku" class = "tsd-kind-icon" > Waku< / a > < / li > < li class = "tsd-kind-reference" > < a href = "modules.html#WakuLightPush" class = "tsd-kind-icon" > Waku< wbr / > Light< wbr / > Push< / a > < / li > < li class = "tsd-kind-reference" > < a href = "modules.html#WakuMessage" class = "tsd-kind-icon" > Waku< wbr / > Message< / a > < / li > < li class = "tsd-kind-reference" > < a href = "modules.html#WakuRelay" class = "tsd-kind-icon" > Waku< wbr / > Relay< / a > < / li > < li class = "tsd-kind-reference" > < a href = "modules.html#WakuStore" class = "tsd-kind-icon" > Waku< wbr / > Store< / a > < / li > < / ul > < / section > < section class = "tsd-index-section " > < h3 > Namespaces< / h3 > < ul class = "tsd-index-list" > < li class = "tsd-kind-namespace" > < a href = "modules/discovery.html" class = "tsd-kind-icon" > discovery< / a > < / li > < li class = "tsd-kind-namespace" > < a href = "modules/enr.html" class = "tsd-kind-icon" > enr< / a > < / li > < li class = "tsd-kind-namespace" > < a href = "modules/utils.html" class = "tsd-kind-icon" > utils< / a > < / li > < li class = "tsd-kind-namespace" > < a href = "modules/waku.html" class = "tsd-kind-icon" > waku< / a > < / li > < li cla
2022-01-24 10:13:20 +00:00
< p > Generate a new private key to be used for asymmetric encryption.< / p >
< / div > < div > < p > Use < a href = "modules.html#getPublicKey" > getPublicKey< / a > to get the corresponding Public Key.< / p >
2022-05-27 01:12:25 +00:00
< / div > < / div > < h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > Uint8Array< / span > < / h4 > < / li > < / ul > < / section > < section class = "tsd-panel tsd-member tsd-kind-function" > < a id = "generateSymmetricKey" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > generate< wbr / > Symmetric< wbr / > Key< a href = "#generateSymmetricKey" 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-function" > < li class = "tsd-signature tsd-kind-icon" > generate< wbr / > Symmetric< wbr / > Key< span class = "tsd-signature-symbol" > (< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > Uint8Array< / 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/ac56778/src/lib/crypto.ts#L43" > src/lib/crypto.ts:43< / a > < / li > < / ul > < / aside > < div class = "tsd-comment tsd-typography" > < div class = "lead" >
2022-01-24 10:13:20 +00:00
< p > Generate a new symmetric key to be used for symmetric encryption.< / p >
2022-05-27 01:12:25 +00:00
< / div > < / div > < h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > Uint8Array< / span > < / h4 > < / li > < / ul > < / section > < section class = "tsd-panel tsd-member tsd-kind-function" > < a id = "getPredefinedBootstrapNodes" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > get< wbr / > Predefined< wbr / > Bootstrap< wbr / > Nodes< a href = "#getPredefinedBootstrapNodes" 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-function" > < li class = "tsd-signature tsd-kind-icon" > get< wbr / > Predefined< wbr / > Bootstrap< wbr / > Nodes< span class = "tsd-signature-symbol" > (< / span > fleet< span class = "tsd-signature-symbol" > ?: < / span > < a href = "enums/discovery.predefined.Fleet.html" class = "tsd-signature-type" data-tsd-kind = "Enumeration" > Fleet< / a > , wantedNumber< span class = "tsd-signature-symbol" > ?: < / span > < span class = "tsd-signature-type" > number< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > Multiaddr< / 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/ac56778/src/lib/discovery/predefined.ts#L22" > src/lib/discovery/predefined.ts:22< / a > < / li > < / ul > < / aside > < div class = "tsd-comment tsd-typography" > < div class = "lead" >
2022-02-21 09:57:52 +00:00
< p > Return list of pre-defined (hardcoded) bootstrap nodes.< / p >
2022-04-06 03:42:19 +00:00
< / div > < div > < p > Default behavior is to return nodes of the nwaku Status Prod fleet.< / p >
2022-02-21 09:57:52 +00:00
< / div > < / div > < h4 class = "tsd-parameters-title" > Parameters< / h4 > < ul class = "tsd-parameters" > < li > < h5 > fleet: < a href = "enums/discovery.predefined.Fleet.html" class = "tsd-signature-type" data-tsd-kind = "Enumeration" > Fleet< / a > < span class = "tsd-signature-symbol" > = Fleet.Prod< / span > < / h5 > < div class = "tsd-comment tsd-typography" > < div class = "lead" >
< p > The fleet to be returned. Defaults to production fleet.< / p >
< / div > < / div > < / li > < li > < h5 > wantedNumber: < span class = "tsd-signature-type" > number< / span > < span class = "tsd-signature-symbol" > = DefaultWantedNumber< / span > < / h5 > < div class = "tsd-comment tsd-typography" > < div class = "lead" >
< p > The number of connections desired. Defaults to < a href = "modules/discovery.predefined.html#DefaultWantedNumber" > DefaultWantedNumber< / a > .< / p >
< / div > < / div > < / li > < / ul > < h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > Multiaddr< / span > < span class = "tsd-signature-symbol" > []< / span > < / h4 > < div > < p > An array of multiaddresses.< / p >
2022-05-27 01:12:25 +00:00
< / div > < / li > < / ul > < / section > < section class = "tsd-panel tsd-member tsd-kind-function" > < a id = "getPublicKey" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > get< wbr / > Public< wbr / > Key< a href = "#getPublicKey" 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-function" > < li class = "tsd-signature tsd-kind-icon" > get< wbr / > Public< wbr / > Key< span class = "tsd-signature-symbol" > (< / span > privateKey< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > number< / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > bigint< / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > Uint8Array< / span > , isCompressed< span class = "tsd-signature-symbol" > ?: < / span > < span class = "tsd-signature-type" > boolean< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > Uint8Array< / span > < / li > < li class = "tsd-signature tsd-kind-icon" > get< wbr / > Public< wbr / > Key< span class = "tsd-signature-symbol" > (< / span > privateKey< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > string< / span > , isCompressed< span class = "tsd-signature-symbol" > ?: < / span > < span class = "tsd-signature-type" > boolean< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > string< / 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/ac56778/src/lib/crypto.ts#L51" > src/lib/crypto.ts:51< / a > < / li > < / ul > < / aside > < div class = "tsd-comment tsd-typography" > < div class = "lead" >
2022-01-24 10:13:20 +00:00
< p > Return the public key for the given private key, to be used for asymmetric
encryption.< / p >
2022-05-27 01:12:25 +00:00
< / div > < / div > < h4 class = "tsd-parameters-title" > Parameters< / h4 > < ul class = "tsd-parameters" > < li > < h5 > privateKey: < span class = "tsd-signature-type" > number< / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > bigint< / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > Uint8Array< / span > < / h5 > < / li > < li > < h5 > < span class = "tsd-flag ts-flagOptional" > Optional< / span > isCompressed: < span class = "tsd-signature-type" > boolean< / span > < / h5 > < / li > < / ul > < h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > Uint8Array< / span > < / h4 > < / li > < li class = "tsd-description" > < aside class = "tsd-sources" > < ul > < li > Defined in < a href = "https://github.com/status-im/js-waku/blob/ac56778/src/lib/crypto.ts#L51" > src/lib/crypto.ts:51< / a > < / li > < / ul > < / aside > < div class = "tsd-comment tsd-typography" > < div class = "lead" >
2022-05-20 02:32:46 +00:00
< p > Return the public key for the given private key, to be used for asymmetric
encryption.< / p >
< / div > < / div > < h4 class = "tsd-parameters-title" > Parameters< / h4 > < ul class = "tsd-parameters" > < li > < h5 > privateKey: < span class = "tsd-signature-type" > string< / span > < / h5 > < / li > < li > < h5 > < span class = "tsd-flag ts-flagOptional" > Optional< / span > isCompressed: < span class = "tsd-signature-type" > boolean< / span > < / h5 > < / li > < / ul > < h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > string< / 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 = "current" > < a href = "modules.html" > Exports< / a > < / li > < li class = " tsd-kind-namespace" > < a href = "modules/discovery.html" > discovery< / a > < / 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 = "tsd-kind-reference" > < a href = "modules.html#DefaultPubSubTopic" class = "tsd-kind-icon" > Default< wbr / > Pub< wbr / > Sub< wbr / > Topic< / a > < / li > < li class = "tsd-kind-reference" > < a href = "modules.html#LightPushCodec" class = "tsd-kind-icon" > Light< wbr / > Push< wbr / > Codec< / a > < / li > < li class = "tsd-kind-reference" > < a href = "modules.html#PageDirection" class = "tsd-kind-icon" > Page< wbr / > Direction< / a > < / li > < li class = "tsd-kind-reference" > < a href = "modules.html#Protocols" class = "tsd-kind-icon" > Protocols< / a > < / li > < li class = "tsd-kind-reference" > < a href = "modules.html#PushResponse" class = "tsd-kind-icon" > Push< wbr / > Response< / a > < / li > < li class = "tsd-kind-reference" > < a href = "modules.html#RelayCodecs" class = "tsd-kind-icon" > Relay< wbr / > Codecs< / a > < / li > < li class = "tsd-kind-reference" > < a href = "modules.html#StoreCodecs" class = "tsd-kind-icon" > Store< wbr / > Codecs< / a > < / li > < li class = "tsd-kind-reference" > < a href = "modules.html#Waku" class = "tsd-kind-icon" > Waku< / a > < / li > < li class = "tsd-kind-reference" > < a href = "modules.html#WakuLightPush" class = "tsd-kind-icon" > Waku< wbr / > Light< wbr / > Push< / a > < / li > < li class = "tsd-kind-reference" > < a href = "modules.html#WakuMessage" class = "tsd-kind-icon" > Waku< wbr / > Message< / a > < / li > < li class = "tsd-kind-reference" > < a href = "modules.html#WakuRelay" class = "tsd-kind-icon" > Waku< wbr / > Relay< / a > < / li > < li class = "tsd-kind-reference" > < a href = "modules.html#WakuStore" class = "tsd-kind-icon" > Waku< wbr / > Store< / a > < / li > < li class = "tsd-kind-function" > < a href = "modules.html#generatePrivateKey" class = "tsd-kind-icon" > generate< wbr / > Private< wbr / > Key< / a > < / li > < li class = "tsd-kind-function" > < a href = "modules.html#generateSymmetricKey" class = "tsd-kind-icon" > generate< wbr / > Symmetric< wbr / > Key< / a > < / li > < li class = "tsd-kind-function" > < a href = "modules.html#getPredefinedBootstrapNodes" class = "tsd-kind-icon" > get< wbr / > Predefined< wbr / > Bootstrap< wbr / > Nodes< / a > < / li > < li class = "tsd-kind-function" > < a href = "modules.html#getPublicKey" class = "tsd-kind-icon" > get< wbr / > Public< wbr / > Key< / a > < / li > < / ul > < / nav > < / div > < / div > < / div > < footer class = "with-border-bottom" > < div class = "container" > < 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 >
