mirror of https://github.com/waku-org/js-waku.git
626 lines
102 KiB
HTML
626 lines
102 KiB
HTML
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>RelayCreateOptions | @waku/root</title><meta name="description" content="Documentation for @waku/root"/><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.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
|
|
<div class="tsd-toolbar-contents container">
|
|
<div class="table-cell" id="tsd-search" data-base="..">
|
|
<div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-text)"></path></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div>
|
|
<div class="field">
|
|
<div id="tsd-toolbar-links"></div></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">@waku/root</a></div>
|
|
<div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><rect x="1" y="3" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="7" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="11" width="14" height="2" fill="var(--color-text)"></rect></svg></a></div></div></header>
|
|
<div class="container container-main">
|
|
<div class="col-8 col-content">
|
|
<div class="tsd-page-title">
|
|
<ul class="tsd-breadcrumb">
|
|
<li><a href="../modules.html">@waku/root</a></li>
|
|
<li><a href="../modules/_waku_core.html">@waku/core</a></li>
|
|
<li><a href="../modules/_waku_core.waku_relay.html">waku_relay</a></li>
|
|
<li><a href="_waku_core.waku_relay.RelayCreateOptions.html">RelayCreateOptions</a></li></ul>
|
|
<h1>Interface RelayCreateOptions</h1></div>
|
|
<section class="tsd-panel tsd-hierarchy">
|
|
<h4>Hierarchy</h4>
|
|
<ul class="tsd-hierarchy">
|
|
<li><span class="tsd-signature-type">GossipsubOpts</span>
|
|
<ul class="tsd-hierarchy">
|
|
<li><span class="target">RelayCreateOptions</span></li></ul></li></ul></section><aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/waku-org/js-waku/blob/cc1d8bb3/packages/core/src/lib/relay/index.ts#L33">packages/core/src/lib/relay/index.ts:33</a></li></ul></aside>
|
|
<section class="tsd-panel-group tsd-index-group">
|
|
<section class="tsd-panel tsd-index-panel">
|
|
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
|
|
<h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex=0><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M1.5 5.50969L8 11.6609L14.5 5.50969L12.5466 3.66086L8 7.96494L3.45341 3.66086L1.5 5.50969Z" fill="var(--color-text)"></path></svg> Index</h5></summary>
|
|
<div class="tsd-accordion-details">
|
|
<section class="tsd-index-section">
|
|
<h3 class="tsd-index-heading">Properties</h3>
|
|
<div class="tsd-index-list"><a href="_waku_core.waku_relay.RelayCreateOptions.html#D" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="#FF984D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12" id="icon-1024-path"></rect><path d="M9.354 16V7.24H12.174C12.99 7.24 13.638 7.476 14.118 7.948C14.606 8.412 14.85 9.036 14.85 9.82C14.85 10.604 14.606 11.232 14.118 11.704C13.638 12.168 12.99 12.4 12.174 12.4H10.434V16H9.354ZM10.434 11.428H12.174C12.646 11.428 13.022 11.284 13.302 10.996C13.59 10.7 13.734 10.308 13.734 9.82C13.734 9.324 13.59 8.932 13.302 8.644C13.022 8.356 12.646 8.212 12.174 8.212H10.434V11.428Z" fill="var(--color-text)" id="icon-1024-text"></path></svg><span>D</span></a>
|
|
<a href="_waku_core.waku_relay.RelayCreateOptions.html#Dhi" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>Dhi</span></a>
|
|
<a href="_waku_core.waku_relay.RelayCreateOptions.html#Dlazy" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>Dlazy</span></a>
|
|
<a href="_waku_core.waku_relay.RelayCreateOptions.html#Dlo" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>Dlo</span></a>
|
|
<a href="_waku_core.waku_relay.RelayCreateOptions.html#Dout" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>Dout</span></a>
|
|
<a href="_waku_core.waku_relay.RelayCreateOptions.html#Dscore" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>Dscore</span></a>
|
|
<a href="_waku_core.waku_relay.RelayCreateOptions.html#allowPublishToZeroPeers" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>allow<wbr/>Publish<wbr/>To<wbr/>Zero<wbr/>Peers</span></a>
|
|
<a href="_waku_core.waku_relay.RelayCreateOptions.html#allowedTopics" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>allowed<wbr/>Topics?</span></a>
|
|
<a href="_waku_core.waku_relay.RelayCreateOptions.html#asyncValidation" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>async<wbr/>Validation</span></a>
|
|
<a href="_waku_core.waku_relay.RelayCreateOptions.html#awaitRpcHandler" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>await<wbr/>Rpc<wbr/>Handler</span></a>
|
|
<a href="_waku_core.waku_relay.RelayCreateOptions.html#awaitRpcMessageHandler" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>await<wbr/>Rpc<wbr/>Message<wbr/>Handler</span></a>
|
|
<a href="_waku_core.waku_relay.RelayCreateOptions.html#canRelayMessage" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>can<wbr/>Relay<wbr/>Message?</span></a>
|
|
<a href="_waku_core.waku_relay.RelayCreateOptions.html#dataTransform" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>data<wbr/>Transform?</span></a>
|
|
<a href="_waku_core.waku_relay.RelayCreateOptions.html#debugName" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>debug<wbr/>Name?</span></a>
|
|
<a href="_waku_core.waku_relay.RelayCreateOptions.html#decodeRpcLimits" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>decode<wbr/>Rpc<wbr/>Limits?</span></a>
|
|
<a href="_waku_core.waku_relay.RelayCreateOptions.html#directConnectTicks" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>direct<wbr/>Connect<wbr/>Ticks?</span></a>
|
|
<a href="_waku_core.waku_relay.RelayCreateOptions.html#directPeers" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>direct<wbr/>Peers</span></a>
|
|
<a href="_waku_core.waku_relay.RelayCreateOptions.html#doPX" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>doPX</span></a>
|
|
<a href="_waku_core.waku_relay.RelayCreateOptions.html#emitSelf" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>emit<wbr/>Self?</span></a>
|
|
<a href="_waku_core.waku_relay.RelayCreateOptions.html#enabled" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>enabled?</span></a>
|
|
<a href="_waku_core.waku_relay.RelayCreateOptions.html#fallbackToFloodsub" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>fallback<wbr/>To<wbr/>Floodsub</span></a>
|
|
<a href="_waku_core.waku_relay.RelayCreateOptions.html#fanoutTTL" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>fanoutTTL</span></a>
|
|
<a href="_waku_core.waku_relay.RelayCreateOptions.html#fastMsgIdFn" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>fast<wbr/>Msg<wbr/>Id<wbr/>Fn</span></a>
|
|
<a href="_waku_core.waku_relay.RelayCreateOptions.html#floodPublish" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>flood<wbr/>Publish</span></a>
|
|
<a href="_waku_core.waku_relay.RelayCreateOptions.html#globalSignaturePolicy" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>global<wbr/>Signature<wbr/>Policy?</span></a>
|
|
<a href="_waku_core.waku_relay.RelayCreateOptions.html#gossipsubIWantFollowupMs" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>gossipsubIWant<wbr/>Followup<wbr/>Ms</span></a>
|
|
<a href="_waku_core.waku_relay.RelayCreateOptions.html#graftFloodThreshold" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>graft<wbr/>Flood<wbr/>Threshold?</span></a>
|
|
<a href="_waku_core.waku_relay.RelayCreateOptions.html#heartbeatInterval" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>heartbeat<wbr/>Interval</span></a>
|
|
<a href="_waku_core.waku_relay.RelayCreateOptions.html#maxInboundDataLength" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>max<wbr/>Inbound<wbr/>Data<wbr/>Length?</span></a>
|
|
<a href="_waku_core.waku_relay.RelayCreateOptions.html#maxInboundStreams" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>max<wbr/>Inbound<wbr/>Streams?</span></a>
|
|
<a href="_waku_core.waku_relay.RelayCreateOptions.html#maxOutboundBufferSize" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>max<wbr/>Outbound<wbr/>Buffer<wbr/>Size?</span></a>
|
|
<a href="_waku_core.waku_relay.RelayCreateOptions.html#maxOutboundStreams" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>max<wbr/>Outbound<wbr/>Streams?</span></a>
|
|
<a href="_waku_core.waku_relay.RelayCreateOptions.html#mcacheGossip" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>mcache<wbr/>Gossip</span></a>
|
|
<a href="_waku_core.waku_relay.RelayCreateOptions.html#mcacheLength" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>mcache<wbr/>Length</span></a>
|
|
<a href="_waku_core.waku_relay.RelayCreateOptions.html#messageCache" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>message<wbr/>Cache</span></a>
|
|
<a href="_waku_core.waku_relay.RelayCreateOptions.html#messageProcessingConcurrency" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>message<wbr/>Processing<wbr/>Concurrency?</span></a>
|
|
<a href="_waku_core.waku_relay.RelayCreateOptions.html#metricsRegister" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>metrics<wbr/>Register?</span></a>
|
|
<a href="_waku_core.waku_relay.RelayCreateOptions.html#metricsTopicStrToLabel" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>metrics<wbr/>Topic<wbr/>Str<wbr/>To<wbr/>Label?</span></a>
|
|
<a href="_waku_core.waku_relay.RelayCreateOptions.html#msgIdFn" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>msg<wbr/>Id<wbr/>Fn</span></a>
|
|
<a href="_waku_core.waku_relay.RelayCreateOptions.html#msgIdToStrFn" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>msg<wbr/>Id<wbr/>To<wbr/>Str<wbr/>Fn</span></a>
|
|
<a href="_waku_core.waku_relay.RelayCreateOptions.html#multicodecs" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>multicodecs?</span></a>
|
|
<a href="_waku_core.waku_relay.RelayCreateOptions.html#opportunisticGraftPeers" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>opportunistic<wbr/>Graft<wbr/>Peers?</span></a>
|
|
<a href="_waku_core.waku_relay.RelayCreateOptions.html#opportunisticGraftTicks" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>opportunistic<wbr/>Graft<wbr/>Ticks?</span></a>
|
|
<a href="_waku_core.waku_relay.RelayCreateOptions.html#pruneBackoff" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>prune<wbr/>Backoff?</span></a>
|
|
<a href="_waku_core.waku_relay.RelayCreateOptions.html#prunePeers" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>prune<wbr/>Peers?</span></a>
|
|
<a href="_waku_core.waku_relay.RelayCreateOptions.html#pubSubTopic" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>pub<wbr/>Sub<wbr/>Topic?</span></a>
|
|
<a href="_waku_core.waku_relay.RelayCreateOptions.html#scoreParams" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>score<wbr/>Params</span></a>
|
|
<a href="_waku_core.waku_relay.RelayCreateOptions.html#scoreThresholds" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>score<wbr/>Thresholds</span></a>
|
|
<a href="_waku_core.waku_relay.RelayCreateOptions.html#seenTTL" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>seenTTL</span></a>
|
|
</div></section></div></details></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 tsd-is-inherited tsd-is-external"><a id="D" class="tsd-anchor"></a>
|
|
<h3 class="tsd-anchor-link"><span>D</span><a href="#D" aria-label="Permalink" class="tsd-anchor-icon"><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" id="icon-anchor-a"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5" id="icon-anchor-b"></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" id="icon-anchor-c"></path></svg></a></h3>
|
|
<div class="tsd-signature">D<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
|
|
<div class="tsd-comment tsd-typography"><p>D sets the optimal degree for a Gossipsub topic mesh.</p>
|
|
</div><aside class="tsd-sources">
|
|
<p>Inherited from GossipsubOpts.D</p>
|
|
<ul>
|
|
<li>Defined in node_modules/@chainsafe/libp2p-gossipsub/dist/src/config.d.ts:3</li></ul></aside></section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="Dhi" class="tsd-anchor"></a>
|
|
<h3 class="tsd-anchor-link"><span>Dhi</span><a href="#Dhi" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
<div class="tsd-signature">Dhi<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
|
|
<div class="tsd-comment tsd-typography"><p>Dhi sets the upper bound on the number of peers we keep in a Gossipsub topic mesh.</p>
|
|
</div><aside class="tsd-sources">
|
|
<p>Inherited from GossipsubOpts.Dhi</p>
|
|
<ul>
|
|
<li>Defined in node_modules/@chainsafe/libp2p-gossipsub/dist/src/config.d.ts:7</li></ul></aside></section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="Dlazy" class="tsd-anchor"></a>
|
|
<h3 class="tsd-anchor-link"><span>Dlazy</span><a href="#Dlazy" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
<div class="tsd-signature">Dlazy<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
|
|
<div class="tsd-comment tsd-typography"><p>Dlazy affects how many peers we will emit gossip to at each heartbeat.</p>
|
|
</div><aside class="tsd-sources">
|
|
<p>Inherited from GossipsubOpts.Dlazy</p>
|
|
<ul>
|
|
<li>Defined in node_modules/@chainsafe/libp2p-gossipsub/dist/src/config.d.ts:13</li></ul></aside></section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="Dlo" class="tsd-anchor"></a>
|
|
<h3 class="tsd-anchor-link"><span>Dlo</span><a href="#Dlo" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
<div class="tsd-signature">Dlo<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
|
|
<div class="tsd-comment tsd-typography"><p>Dlo sets the lower bound on the number of peers we keep in a Gossipsub topic mesh.</p>
|
|
</div><aside class="tsd-sources">
|
|
<p>Inherited from GossipsubOpts.Dlo</p>
|
|
<ul>
|
|
<li>Defined in node_modules/@chainsafe/libp2p-gossipsub/dist/src/config.d.ts:5</li></ul></aside></section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="Dout" class="tsd-anchor"></a>
|
|
<h3 class="tsd-anchor-link"><span>Dout</span><a href="#Dout" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
<div class="tsd-signature">Dout<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
|
|
<div class="tsd-comment tsd-typography"><p>Dout sets the quota for the number of outbound connections to maintain in a topic mesh.</p>
|
|
</div><aside class="tsd-sources">
|
|
<p>Inherited from GossipsubOpts.Dout</p>
|
|
<ul>
|
|
<li>Defined in node_modules/@chainsafe/libp2p-gossipsub/dist/src/config.d.ts:11</li></ul></aside></section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="Dscore" class="tsd-anchor"></a>
|
|
<h3 class="tsd-anchor-link"><span>Dscore</span><a href="#Dscore" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
<div class="tsd-signature">Dscore<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
|
|
<div class="tsd-comment tsd-typography"><p>Dscore affects how peers are selected when pruning a mesh due to over subscription.</p>
|
|
</div><aside class="tsd-sources">
|
|
<p>Inherited from GossipsubOpts.Dscore</p>
|
|
<ul>
|
|
<li>Defined in node_modules/@chainsafe/libp2p-gossipsub/dist/src/config.d.ts:9</li></ul></aside></section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="allowPublishToZeroPeers" class="tsd-anchor"></a>
|
|
<h3 class="tsd-anchor-link"><span>allow<wbr/>Publish<wbr/>To<wbr/>Zero<wbr/>Peers</span><a href="#allowPublishToZeroPeers" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
<div class="tsd-signature">allow<wbr/>Publish<wbr/>To<wbr/>Zero<wbr/>Peers<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
<div class="tsd-comment tsd-typography"><p>Do not throw <code>InsufficientPeers</code> error if publishing to zero peers</p>
|
|
</div><aside class="tsd-sources">
|
|
<p>Inherited from GossipsubOpts.allowPublishToZeroPeers</p>
|
|
<ul>
|
|
<li>Defined in node_modules/@chainsafe/libp2p-gossipsub/dist/src/index.d.ts:33</li></ul></aside></section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="allowedTopics" class="tsd-anchor"></a>
|
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>allowed<wbr/>Topics</span><a href="#allowedTopics" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
<div class="tsd-signature">allowed<wbr/>Topics<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">Set</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></div>
|
|
<div class="tsd-comment tsd-typography"><p>If provided, only allow topics in this list</p>
|
|
</div><aside class="tsd-sources">
|
|
<p>Inherited from GossipsubOpts.allowedTopics</p>
|
|
<ul>
|
|
<li>Defined in node_modules/@chainsafe/libp2p-gossipsub/dist/src/index.d.ts:88</li></ul></aside></section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="asyncValidation" class="tsd-anchor"></a>
|
|
<h3 class="tsd-anchor-link"><span>async<wbr/>Validation</span><a href="#asyncValidation" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
<div class="tsd-signature">async<wbr/>Validation<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
<div class="tsd-comment tsd-typography"><p>If true will not forward messages to mesh peers until reportMessageValidationResult() is called.
|
|
Messages will be cached in mcache for some time after which they are evicted. Calling
|
|
reportMessageValidationResult() after the message is dropped from mcache won't forward the message.</p>
|
|
</div><aside class="tsd-sources">
|
|
<p>Inherited from GossipsubOpts.asyncValidation</p>
|
|
<ul>
|
|
<li>Defined in node_modules/@chainsafe/libp2p-gossipsub/dist/src/index.d.ts:31</li></ul></aside></section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="awaitRpcHandler" class="tsd-anchor"></a>
|
|
<h3 class="tsd-anchor-link"><span>await<wbr/>Rpc<wbr/>Handler</span><a href="#awaitRpcHandler" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
<div class="tsd-signature">await<wbr/>Rpc<wbr/>Handler<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
<div class="tsd-comment tsd-typography"><p>For a single stream, await processing each RPC before processing the next</p>
|
|
</div><aside class="tsd-sources">
|
|
<p>Inherited from GossipsubOpts.awaitRpcHandler</p>
|
|
<ul>
|
|
<li>Defined in node_modules/@chainsafe/libp2p-gossipsub/dist/src/index.d.ts:35</li></ul></aside></section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="awaitRpcMessageHandler" class="tsd-anchor"></a>
|
|
<h3 class="tsd-anchor-link"><span>await<wbr/>Rpc<wbr/>Message<wbr/>Handler</span><a href="#awaitRpcMessageHandler" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
<div class="tsd-signature">await<wbr/>Rpc<wbr/>Message<wbr/>Handler<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
<div class="tsd-comment tsd-typography"><p>For a single RPC, await processing each message before processing the next</p>
|
|
</div><aside class="tsd-sources">
|
|
<p>Inherited from GossipsubOpts.awaitRpcMessageHandler</p>
|
|
<ul>
|
|
<li>Defined in node_modules/@chainsafe/libp2p-gossipsub/dist/src/index.d.ts:37</li></ul></aside></section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="canRelayMessage" class="tsd-anchor"></a>
|
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>can<wbr/>Relay<wbr/>Message</span><a href="#canRelayMessage" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
<div class="tsd-signature">can<wbr/>Relay<wbr/>Message<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
<div class="tsd-comment tsd-typography"><p>if can relay messages not subscribed</p>
|
|
</div><aside class="tsd-sources">
|
|
<p>Inherited from GossipsubOpts.canRelayMessage</p>
|
|
<ul>
|
|
<li>Defined in node_modules/@libp2p/interface-pubsub/dist/src/index.d.ts:79</li></ul></aside></section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="dataTransform" class="tsd-anchor"></a>
|
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>data<wbr/>Transform</span><a href="#dataTransform" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
<div class="tsd-signature">data<wbr/>Transform<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">DataTransform</span></div><aside class="tsd-sources">
|
|
<p>Inherited from GossipsubOpts.dataTransform</p>
|
|
<ul>
|
|
<li>Defined in node_modules/@chainsafe/libp2p-gossipsub/dist/src/index.d.ts:59</li></ul></aside></section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="debugName" class="tsd-anchor"></a>
|
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>debug<wbr/>Name</span><a href="#debugName" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
<div class="tsd-signature">debug<wbr/>Name<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
<div class="tsd-comment tsd-typography"><p>Prefix tag for debug logs</p>
|
|
</div><aside class="tsd-sources">
|
|
<p>Inherited from GossipsubOpts.debugName</p>
|
|
<ul>
|
|
<li>Defined in node_modules/@chainsafe/libp2p-gossipsub/dist/src/index.d.ts:63</li></ul></aside></section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="decodeRpcLimits" class="tsd-anchor"></a>
|
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>decode<wbr/>Rpc<wbr/>Limits</span><a href="#decodeRpcLimits" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
<div class="tsd-signature">decode<wbr/>Rpc<wbr/>Limits<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">DecodeRPCLimits</span></div>
|
|
<div class="tsd-comment tsd-typography"><p>Limits to bound protobuf decoding</p>
|
|
</div><aside class="tsd-sources">
|
|
<p>Inherited from GossipsubOpts.decodeRpcLimits</p>
|
|
<ul>
|
|
<li>Defined in node_modules/@chainsafe/libp2p-gossipsub/dist/src/index.d.ts:92</li></ul></aside></section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="directConnectTicks" class="tsd-anchor"></a>
|
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>direct<wbr/>Connect<wbr/>Ticks</span><a href="#directConnectTicks" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
<div class="tsd-signature">direct<wbr/>Connect<wbr/>Ticks<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources">
|
|
<p>Inherited from GossipsubOpts.directConnectTicks</p>
|
|
<ul>
|
|
<li>Defined in node_modules/@chainsafe/libp2p-gossipsub/dist/src/index.d.ts:58</li></ul></aside></section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="directPeers" class="tsd-anchor"></a>
|
|
<h3 class="tsd-anchor-link"><span>direct<wbr/>Peers</span><a href="#directPeers" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
<div class="tsd-signature">direct<wbr/>Peers<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">AddrInfo</span><span class="tsd-signature-symbol">[]</span></div>
|
|
<div class="tsd-comment tsd-typography"><p>peers with which we will maintain direct connections</p>
|
|
</div><aside class="tsd-sources">
|
|
<p>Inherited from GossipsubOpts.directPeers</p>
|
|
<ul>
|
|
<li>Defined in node_modules/@chainsafe/libp2p-gossipsub/dist/src/index.d.ts:25</li></ul></aside></section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="doPX" class="tsd-anchor"></a>
|
|
<h3 class="tsd-anchor-link"><span>doPX</span><a href="#doPX" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
<div class="tsd-signature">doPX<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
<div class="tsd-comment tsd-typography"><p>whether PX is enabled; this should be enabled in bootstrappers and other well connected/trusted nodes.</p>
|
|
</div><aside class="tsd-sources">
|
|
<p>Inherited from GossipsubOpts.doPX</p>
|
|
<ul>
|
|
<li>Defined in node_modules/@chainsafe/libp2p-gossipsub/dist/src/index.d.ts:23</li></ul></aside></section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="emitSelf" class="tsd-anchor"></a>
|
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>emit<wbr/>Self</span><a href="#emitSelf" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
<div class="tsd-signature">emit<wbr/>Self<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
<div class="tsd-comment tsd-typography"><p>if publish should emit to self, if subscribed</p>
|
|
</div><aside class="tsd-sources">
|
|
<p>Inherited from GossipsubOpts.emitSelf</p>
|
|
<ul>
|
|
<li>Defined in node_modules/@libp2p/interface-pubsub/dist/src/index.d.ts:83</li></ul></aside></section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="enabled" class="tsd-anchor"></a>
|
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>enabled</span><a href="#enabled" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
<div class="tsd-signature">enabled<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources">
|
|
<p>Inherited from GossipsubOpts.enabled</p>
|
|
<ul>
|
|
<li>Defined in node_modules/@libp2p/interface-pubsub/dist/src/index.d.ts:70</li></ul></aside></section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="fallbackToFloodsub" class="tsd-anchor"></a>
|
|
<h3 class="tsd-anchor-link"><span>fallback<wbr/>To<wbr/>Floodsub</span><a href="#fallbackToFloodsub" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
<div class="tsd-signature">fallback<wbr/>To<wbr/>Floodsub<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
<div class="tsd-comment tsd-typography"><p>if dial should fallback to floodsub</p>
|
|
</div><aside class="tsd-sources">
|
|
<p>Inherited from GossipsubOpts.fallbackToFloodsub</p>
|
|
<ul>
|
|
<li>Defined in node_modules/@chainsafe/libp2p-gossipsub/dist/src/index.d.ts:19</li></ul></aside></section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="fanoutTTL" class="tsd-anchor"></a>
|
|
<h3 class="tsd-anchor-link"><span>fanoutTTL</span><a href="#fanoutTTL" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
<div class="tsd-signature">fanoutTTL<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
|
|
<div class="tsd-comment tsd-typography"><p>fanoutTTL controls how long we keep track of the fanout state. If it's been
|
|
fanoutTTL milliseconds since we've published to a topic that we're not subscribed to,
|
|
we'll delete the fanout map for that topic.</p>
|
|
</div><aside class="tsd-sources">
|
|
<p>Inherited from GossipsubOpts.fanoutTTL</p>
|
|
<ul>
|
|
<li>Defined in node_modules/@chainsafe/libp2p-gossipsub/dist/src/config.d.ts:21</li></ul></aside></section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="fastMsgIdFn" class="tsd-anchor"></a>
|
|
<h3 class="tsd-anchor-link"><span>fast<wbr/>Msg<wbr/>Id<wbr/>Fn</span><a href="#fastMsgIdFn" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
<div class="tsd-signature">fast<wbr/>Msg<wbr/>Id<wbr/>Fn<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">FastMsgIdFn</span></div>
|
|
<div class="tsd-comment tsd-typography"><p>fast message id function</p>
|
|
</div><aside class="tsd-sources">
|
|
<p>Inherited from GossipsubOpts.fastMsgIdFn</p>
|
|
<ul>
|
|
<li>Defined in node_modules/@chainsafe/libp2p-gossipsub/dist/src/index.d.ts:41</li></ul></aside></section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="floodPublish" class="tsd-anchor"></a>
|
|
<h3 class="tsd-anchor-link"><span>flood<wbr/>Publish</span><a href="#floodPublish" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
<div class="tsd-signature">flood<wbr/>Publish<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
<div class="tsd-comment tsd-typography"><p>if self-published messages should be sent to all peers</p>
|
|
</div><aside class="tsd-sources">
|
|
<p>Inherited from GossipsubOpts.floodPublish</p>
|
|
<ul>
|
|
<li>Defined in node_modules/@chainsafe/libp2p-gossipsub/dist/src/index.d.ts:21</li></ul></aside></section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="globalSignaturePolicy" class="tsd-anchor"></a>
|
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>global<wbr/>Signature<wbr/>Policy</span><a href="#globalSignaturePolicy" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
<div class="tsd-signature">global<wbr/>Signature<wbr/>Policy<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">SignaturePolicy</span></div>
|
|
<div class="tsd-comment tsd-typography"><p>defines how signatures should be handled</p>
|
|
</div><aside class="tsd-sources">
|
|
<p>Inherited from GossipsubOpts.globalSignaturePolicy</p>
|
|
<ul>
|
|
<li>Defined in node_modules/@libp2p/interface-pubsub/dist/src/index.d.ts:75</li></ul></aside></section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="gossipsubIWantFollowupMs" class="tsd-anchor"></a>
|
|
<h3 class="tsd-anchor-link"><span>gossipsubIWant<wbr/>Followup<wbr/>Ms</span><a href="#gossipsubIWantFollowupMs" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
<div class="tsd-signature">gossipsubIWant<wbr/>Followup<wbr/>Ms<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
|
|
<div class="tsd-comment tsd-typography"><p>customize GossipsubIWantFollowupTime in order not to apply IWANT penalties</p>
|
|
</div><aside class="tsd-sources">
|
|
<p>Inherited from GossipsubOpts.gossipsubIWantFollowupMs</p>
|
|
<ul>
|
|
<li>Defined in node_modules/@chainsafe/libp2p-gossipsub/dist/src/index.d.ts:51</li></ul></aside></section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="graftFloodThreshold" class="tsd-anchor"></a>
|
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>graft<wbr/>Flood<wbr/>Threshold</span><a href="#graftFloodThreshold" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
<div class="tsd-signature">graft<wbr/>Flood<wbr/>Threshold<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources">
|
|
<p>Inherited from GossipsubOpts.graftFloodThreshold</p>
|
|
<ul>
|
|
<li>Defined in node_modules/@chainsafe/libp2p-gossipsub/dist/src/index.d.ts:55</li></ul></aside></section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="heartbeatInterval" class="tsd-anchor"></a>
|
|
<h3 class="tsd-anchor-link"><span>heartbeat<wbr/>Interval</span><a href="#heartbeatInterval" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
<div class="tsd-signature">heartbeat<wbr/>Interval<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
|
|
<div class="tsd-comment tsd-typography"><p>heartbeatInterval is the time between heartbeats in milliseconds</p>
|
|
</div><aside class="tsd-sources">
|
|
<p>Inherited from GossipsubOpts.heartbeatInterval</p>
|
|
<ul>
|
|
<li>Defined in node_modules/@chainsafe/libp2p-gossipsub/dist/src/config.d.ts:15</li></ul></aside></section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="maxInboundDataLength" class="tsd-anchor"></a>
|
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>max<wbr/>Inbound<wbr/>Data<wbr/>Length</span><a href="#maxInboundDataLength" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
<div class="tsd-signature">max<wbr/>Inbound<wbr/>Data<wbr/>Length<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div>
|
|
<div class="tsd-comment tsd-typography"><p>Specify max size to skip decoding messages whose data
|
|
section exceeds this size.</p>
|
|
</div><aside class="tsd-sources">
|
|
<p>Inherited from GossipsubOpts.maxInboundDataLength</p>
|
|
<ul>
|
|
<li>Defined in node_modules/@chainsafe/libp2p-gossipsub/dist/src/index.d.ts:84</li></ul></aside></section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="maxInboundStreams" class="tsd-anchor"></a>
|
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>max<wbr/>Inbound<wbr/>Streams</span><a href="#maxInboundStreams" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
<div class="tsd-signature">max<wbr/>Inbound<wbr/>Streams<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div>
|
|
<div class="tsd-comment tsd-typography"><p>Specify the maximum number of inbound gossipsub protocol
|
|
streams that are allowed to be open concurrently</p>
|
|
</div><aside class="tsd-sources">
|
|
<p>Inherited from GossipsubOpts.maxInboundStreams</p>
|
|
<ul>
|
|
<li>Defined in node_modules/@chainsafe/libp2p-gossipsub/dist/src/index.d.ts:68</li></ul></aside></section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="maxOutboundBufferSize" class="tsd-anchor"></a>
|
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>max<wbr/>Outbound<wbr/>Buffer<wbr/>Size</span><a href="#maxOutboundBufferSize" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
<div class="tsd-signature">max<wbr/>Outbound<wbr/>Buffer<wbr/>Size<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div>
|
|
<div class="tsd-comment tsd-typography"><p>Specify max buffer size in bytes for OutboundStream.
|
|
If full it will throw and reject sending any more data.</p>
|
|
</div><aside class="tsd-sources">
|
|
<p>Inherited from GossipsubOpts.maxOutboundBufferSize</p>
|
|
<ul>
|
|
<li>Defined in node_modules/@chainsafe/libp2p-gossipsub/dist/src/index.d.ts:78</li></ul></aside></section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="maxOutboundStreams" class="tsd-anchor"></a>
|
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>max<wbr/>Outbound<wbr/>Streams</span><a href="#maxOutboundStreams" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
<div class="tsd-signature">max<wbr/>Outbound<wbr/>Streams<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div>
|
|
<div class="tsd-comment tsd-typography"><p>Specify the maximum number of outbound gossipsub protocol
|
|
streams that are allowed to be open concurrently</p>
|
|
</div><aside class="tsd-sources">
|
|
<p>Inherited from GossipsubOpts.maxOutboundStreams</p>
|
|
<ul>
|
|
<li>Defined in node_modules/@chainsafe/libp2p-gossipsub/dist/src/index.d.ts:73</li></ul></aside></section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="mcacheGossip" class="tsd-anchor"></a>
|
|
<h3 class="tsd-anchor-link"><span>mcache<wbr/>Gossip</span><a href="#mcacheGossip" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
<div class="tsd-signature">mcache<wbr/>Gossip<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
|
|
<div class="tsd-comment tsd-typography"><p>mcacheGossip is the number of windows to gossip about</p>
|
|
</div><aside class="tsd-sources">
|
|
<p>Inherited from GossipsubOpts.mcacheGossip</p>
|
|
<ul>
|
|
<li>Defined in node_modules/@chainsafe/libp2p-gossipsub/dist/src/config.d.ts:25</li></ul></aside></section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="mcacheLength" class="tsd-anchor"></a>
|
|
<h3 class="tsd-anchor-link"><span>mcache<wbr/>Length</span><a href="#mcacheLength" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
<div class="tsd-signature">mcache<wbr/>Length<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
|
|
<div class="tsd-comment tsd-typography"><p>mcacheLength is the number of windows to retain full messages for IWANT responses</p>
|
|
</div><aside class="tsd-sources">
|
|
<p>Inherited from GossipsubOpts.mcacheLength</p>
|
|
<ul>
|
|
<li>Defined in node_modules/@chainsafe/libp2p-gossipsub/dist/src/config.d.ts:23</li></ul></aside></section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="messageCache" class="tsd-anchor"></a>
|
|
<h3 class="tsd-anchor-link"><span>message<wbr/>Cache</span><a href="#messageCache" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
<div class="tsd-signature">message<wbr/>Cache<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">MessageCache</span></div>
|
|
<div class="tsd-comment tsd-typography"><p>override the default MessageCache</p>
|
|
</div><aside class="tsd-sources">
|
|
<p>Inherited from GossipsubOpts.messageCache</p>
|
|
<ul>
|
|
<li>Defined in node_modules/@chainsafe/libp2p-gossipsub/dist/src/index.d.ts:45</li></ul></aside></section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="messageProcessingConcurrency" class="tsd-anchor"></a>
|
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>message<wbr/>Processing<wbr/>Concurrency</span><a href="#messageProcessingConcurrency" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
<div class="tsd-signature">message<wbr/>Processing<wbr/>Concurrency<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div>
|
|
<div class="tsd-comment tsd-typography"><p>handle this many incoming pubsub messages concurrently</p>
|
|
</div><aside class="tsd-sources">
|
|
<p>Inherited from GossipsubOpts.messageProcessingConcurrency</p>
|
|
<ul>
|
|
<li>Defined in node_modules/@libp2p/interface-pubsub/dist/src/index.d.ts:87</li></ul></aside></section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="metricsRegister" class="tsd-anchor"></a>
|
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>metrics<wbr/>Register</span><a href="#metricsRegister" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
<div class="tsd-signature">metrics<wbr/>Register<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">MetricsRegister</span></div><aside class="tsd-sources">
|
|
<p>Inherited from GossipsubOpts.metricsRegister</p>
|
|
<ul>
|
|
<li>Defined in node_modules/@chainsafe/libp2p-gossipsub/dist/src/index.d.ts:60</li></ul></aside></section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="metricsTopicStrToLabel" class="tsd-anchor"></a>
|
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>metrics<wbr/>Topic<wbr/>Str<wbr/>To<wbr/>Label</span><a href="#metricsTopicStrToLabel" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
<div class="tsd-signature">metrics<wbr/>Topic<wbr/>Str<wbr/>To<wbr/>Label<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">TopicStrToLabel</span></div><aside class="tsd-sources">
|
|
<p>Inherited from GossipsubOpts.metricsTopicStrToLabel</p>
|
|
<ul>
|
|
<li>Defined in node_modules/@chainsafe/libp2p-gossipsub/dist/src/index.d.ts:61</li></ul></aside></section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="msgIdFn" class="tsd-anchor"></a>
|
|
<h3 class="tsd-anchor-link"><span>msg<wbr/>Id<wbr/>Fn</span><a href="#msgIdFn" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
<div class="tsd-signature">msg<wbr/>Id<wbr/>Fn<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">MsgIdFn</span></div>
|
|
<div class="tsd-comment tsd-typography"><p>message id function</p>
|
|
</div><aside class="tsd-sources">
|
|
<p>Inherited from GossipsubOpts.msgIdFn</p>
|
|
<ul>
|
|
<li>Defined in node_modules/@chainsafe/libp2p-gossipsub/dist/src/index.d.ts:39</li></ul></aside></section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="msgIdToStrFn" class="tsd-anchor"></a>
|
|
<h3 class="tsd-anchor-link"><span>msg<wbr/>Id<wbr/>To<wbr/>Str<wbr/>Fn</span><a href="#msgIdToStrFn" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
<div class="tsd-signature">msg<wbr/>Id<wbr/>To<wbr/>Str<wbr/>Fn<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">MsgIdToStrFn</span></div>
|
|
<div class="tsd-comment tsd-typography"><p>Uint8Array message id to string function</p>
|
|
</div><aside class="tsd-sources">
|
|
<p>Inherited from GossipsubOpts.msgIdToStrFn</p>
|
|
<ul>
|
|
<li>Defined in node_modules/@chainsafe/libp2p-gossipsub/dist/src/index.d.ts:43</li></ul></aside></section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="multicodecs" class="tsd-anchor"></a>
|
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>multicodecs</span><a href="#multicodecs" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
<div class="tsd-signature">multicodecs<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources">
|
|
<p>Inherited from GossipsubOpts.multicodecs</p>
|
|
<ul>
|
|
<li>Defined in node_modules/@libp2p/interface-pubsub/dist/src/index.d.ts:71</li></ul></aside></section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="opportunisticGraftPeers" class="tsd-anchor"></a>
|
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>opportunistic<wbr/>Graft<wbr/>Peers</span><a href="#opportunisticGraftPeers" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
<div class="tsd-signature">opportunistic<wbr/>Graft<wbr/>Peers<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources">
|
|
<p>Inherited from GossipsubOpts.opportunisticGraftPeers</p>
|
|
<ul>
|
|
<li>Defined in node_modules/@chainsafe/libp2p-gossipsub/dist/src/index.d.ts:56</li></ul></aside></section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="opportunisticGraftTicks" class="tsd-anchor"></a>
|
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>opportunistic<wbr/>Graft<wbr/>Ticks</span><a href="#opportunisticGraftTicks" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
<div class="tsd-signature">opportunistic<wbr/>Graft<wbr/>Ticks<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources">
|
|
<p>Inherited from GossipsubOpts.opportunisticGraftTicks</p>
|
|
<ul>
|
|
<li>Defined in node_modules/@chainsafe/libp2p-gossipsub/dist/src/index.d.ts:57</li></ul></aside></section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="pruneBackoff" class="tsd-anchor"></a>
|
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>prune<wbr/>Backoff</span><a href="#pruneBackoff" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
<div class="tsd-signature">prune<wbr/>Backoff<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources">
|
|
<p>Inherited from GossipsubOpts.pruneBackoff</p>
|
|
<ul>
|
|
<li>Defined in node_modules/@chainsafe/libp2p-gossipsub/dist/src/index.d.ts:54</li></ul></aside></section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="prunePeers" class="tsd-anchor"></a>
|
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>prune<wbr/>Peers</span><a href="#prunePeers" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
<div class="tsd-signature">prune<wbr/>Peers<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div>
|
|
<div class="tsd-comment tsd-typography"><p>override constants for fine tuning</p>
|
|
</div><aside class="tsd-sources">
|
|
<p>Inherited from GossipsubOpts.prunePeers</p>
|
|
<ul>
|
|
<li>Defined in node_modules/@chainsafe/libp2p-gossipsub/dist/src/index.d.ts:53</li></ul></aside></section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="pubSubTopic" class="tsd-anchor"></a>
|
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>pub<wbr/>Sub<wbr/>Topic</span><a href="#pubSubTopic" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
<div class="tsd-signature">pub<wbr/>Sub<wbr/>Topic<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
<div class="tsd-comment tsd-typography"><p>The PubSub Topic to use. Defaults to <a href="../variables/_waku_core.DefaultPubSubTopic.html">DefaultPubSubTopic</a>.</p>
|
|
<p>One and only one pubsub topic is used by Waku. This is used by:</p>
|
|
<ul>
|
|
<li>WakuRelay to receive, route and send messages,</li>
|
|
<li>WakuLightPush to send messages,</li>
|
|
<li>WakuStore to retrieve messages.</li>
|
|
</ul>
|
|
<p>The usage of the default pubsub topic is recommended.
|
|
See <a href="https://rfc.vac.dev/spec/23/">Waku v2 Topic Usage Recommendations</a> for details.</p>
|
|
|
|
<h3>Default</h3><p><a href="../variables/_waku_core.DefaultPubSubTopic.html">DefaultPubSubTopic</a></p>
|
|
</div><aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/waku-org/js-waku/blob/cc1d8bb3/packages/core/src/lib/relay/index.ts#L47">packages/core/src/lib/relay/index.ts:47</a></li></ul></aside></section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="scoreParams" class="tsd-anchor"></a>
|
|
<h3 class="tsd-anchor-link"><span>score<wbr/>Params</span><a href="#scoreParams" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
<div class="tsd-signature">score<wbr/>Params<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">PeerScoreParams</span><span class="tsd-signature-symbol">></span></div>
|
|
<div class="tsd-comment tsd-typography"><p>peer score parameters</p>
|
|
</div><aside class="tsd-sources">
|
|
<p>Inherited from GossipsubOpts.scoreParams</p>
|
|
<ul>
|
|
<li>Defined in node_modules/@chainsafe/libp2p-gossipsub/dist/src/index.d.ts:47</li></ul></aside></section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="scoreThresholds" class="tsd-anchor"></a>
|
|
<h3 class="tsd-anchor-link"><span>score<wbr/>Thresholds</span><a href="#scoreThresholds" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
<div class="tsd-signature">score<wbr/>Thresholds<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">PeerScoreThresholds</span><span class="tsd-signature-symbol">></span></div>
|
|
<div class="tsd-comment tsd-typography"><p>peer score thresholds</p>
|
|
</div><aside class="tsd-sources">
|
|
<p>Inherited from GossipsubOpts.scoreThresholds</p>
|
|
<ul>
|
|
<li>Defined in node_modules/@chainsafe/libp2p-gossipsub/dist/src/index.d.ts:49</li></ul></aside></section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="seenTTL" class="tsd-anchor"></a>
|
|
<h3 class="tsd-anchor-link"><span>seenTTL</span><a href="#seenTTL" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
<div class="tsd-signature">seenTTL<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
|
|
<div class="tsd-comment tsd-typography"><p>seenTTL is the number of milliseconds to retain message IDs in the seen cache</p>
|
|
</div><aside class="tsd-sources">
|
|
<p>Inherited from GossipsubOpts.seenTTL</p>
|
|
<ul>
|
|
<li>Defined in node_modules/@chainsafe/libp2p-gossipsub/dist/src/config.d.ts:27</li></ul></aside></section></section></div>
|
|
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
|
<div class="tsd-navigation settings">
|
|
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
|
|
<h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></svg> Settings</h3></summary>
|
|
<div class="tsd-accordion-details">
|
|
<div class="tsd-filter-visibility">
|
|
<h4 class="uppercase">Member Visibility</h4><form>
|
|
<ul id="tsd-filter-options">
|
|
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li>
|
|
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li>
|
|
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li>
|
|
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div>
|
|
<div class="tsd-theme-toggle">
|
|
<h4 class="uppercase">Theme</h4><select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div>
|
|
<nav class="tsd-navigation primary">
|
|
<details class="tsd-index-accordion" open><summary class="tsd-accordion-summary">
|
|
<h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></svg> Modules</h3></summary>
|
|
<div class="tsd-accordion-details">
|
|
<ul>
|
|
<li class="current"><a href="../modules.html">@waku/root</a>
|
|
<ul>
|
|
<li class="tsd-kind-module"><a href="../modules/_waku_byte_utils.html">@waku/byte-<wbr/>utils</a></li>
|
|
<li class="current tsd-kind-module"><a href="../modules/_waku_core.html">@waku/core</a>
|
|
<ul>
|
|
<li class="tsd-kind-namespace tsd-parent-kind-module"><a href="../modules/_waku_core.message.html">message</a>
|
|
<ul>
|
|
<li class="tsd-kind-namespace tsd-parent-kind-namespace"><a href="../modules/_waku_core.message.topic_only_message.html">topic_<wbr/>only_<wbr/>message</a></li>
|
|
<li class="tsd-kind-namespace tsd-parent-kind-namespace"><a href="../modules/_waku_core.message.version_0.html">version_<wbr/>0</a>
|
|
<ul>
|
|
<li class="tsd-kind-namespace tsd-parent-kind-namespace"><a href="../modules/_waku_core.message.version_0.proto.html">proto</a>
|
|
<ul>
|
|
<li class="tsd-kind-namespace tsd-parent-kind-namespace"><a href="../modules/_waku_core.message.version_0.proto.RateLimitProof.html">Rate<wbr/>Limit<wbr/>Proof</a></li>
|
|
<li class="tsd-kind-namespace tsd-parent-kind-namespace"><a href="../modules/_waku_core.message.version_0.proto.WakuMessage.html">Waku<wbr/>Message</a></li></ul></li></ul></li></ul></li>
|
|
<li class="tsd-kind-namespace tsd-parent-kind-module"><a href="../modules/_waku_core.waku.html">waku</a></li>
|
|
<li class="tsd-kind-namespace tsd-parent-kind-module"><a href="../modules/_waku_core.waku_filter.html">waku_<wbr/>filter</a></li>
|
|
<li class="tsd-kind-namespace tsd-parent-kind-module"><a href="../modules/_waku_core.waku_light_push.html">waku_<wbr/>light_<wbr/>push</a>
|
|
<ul>
|
|
<li class="tsd-kind-namespace tsd-parent-kind-namespace"><a href="../modules/_waku_core.waku_light_push.PushResponse.html">Push<wbr/>Response</a></li></ul></li>
|
|
<li class="current tsd-kind-namespace tsd-parent-kind-module"><a href="../modules/_waku_core.waku_relay.html">waku_<wbr/>relay</a></li>
|
|
<li class="tsd-kind-namespace tsd-parent-kind-module"><a href="../modules/_waku_core.waku_store.html">waku_<wbr/>store</a></li></ul></li>
|
|
<li class="tsd-kind-module"><a href="../modules/_waku_create.html">@waku/create</a></li>
|
|
<li class="tsd-kind-module"><a href="../modules/_waku_dns_discovery.html">@waku/dns-<wbr/>discovery</a></li>
|
|
<li class="tsd-kind-module"><a href="../modules/_waku_enr.html">@waku/enr</a></li>
|
|
<li class="tsd-kind-module"><a href="../modules/_waku_interfaces.html">@waku/interfaces</a></li>
|
|
<li class="tsd-kind-module"><a href="../modules/_waku_libp2p_utils.html">@waku/libp2p-<wbr/>utils</a></li>
|
|
<li class="tsd-kind-module"><a href="../modules/_waku_message_encryption.html">@waku/message-<wbr/>encryption</a>
|
|
<ul>
|
|
<li class="tsd-kind-namespace tsd-parent-kind-module"><a href="../modules/_waku_message_encryption.ecies.html">ecies</a></li>
|
|
<li class="tsd-kind-namespace tsd-parent-kind-module"><a href="../modules/_waku_message_encryption.symmetric.html">symmetric</a></li></ul></li>
|
|
<li class="tsd-kind-module"><a href="../modules/_waku_peer_exchange.html">@waku/peer-<wbr/>exchange</a></li>
|
|
<li class="tsd-kind-module"><a href="../modules/_waku_proto.html">@waku/proto</a>
|
|
<ul>
|
|
<li class="tsd-kind-namespace tsd-parent-kind-module"><a href="../modules/_waku_proto.WakuMessage.html">Waku<wbr/>Message</a></li>
|
|
<li class="tsd-kind-namespace tsd-parent-kind-module"><a href="../modules/_waku_proto.proto_filter.html">proto_<wbr/>filter</a>
|
|
<ul>
|
|
<li class="tsd-kind-namespace tsd-parent-kind-namespace"><a href="../modules/_waku_proto.proto_filter.FilterRPC.html">FilterRPC</a></li>
|
|
<li class="tsd-kind-namespace tsd-parent-kind-namespace"><a href="../modules/_waku_proto.proto_filter.FilterRequest.html">Filter<wbr/>Request</a>
|
|
<ul>
|
|
<li class="tsd-kind-namespace tsd-parent-kind-namespace"><a href="../modules/_waku_proto.proto_filter.FilterRequest.ContentFilter.html">Content<wbr/>Filter</a></li></ul></li>
|
|
<li class="tsd-kind-namespace tsd-parent-kind-namespace"><a href="../modules/_waku_proto.proto_filter.MessagePush.html">Message<wbr/>Push</a></li>
|
|
<li class="tsd-kind-namespace tsd-parent-kind-namespace"><a href="../modules/_waku_proto.proto_filter.RateLimitProof.html">Rate<wbr/>Limit<wbr/>Proof</a></li></ul></li>
|
|
<li class="tsd-kind-namespace tsd-parent-kind-module"><a href="../modules/_waku_proto.proto_lightpush.html">proto_<wbr/>lightpush</a>
|
|
<ul>
|
|
<li class="tsd-kind-namespace tsd-parent-kind-namespace"><a href="../modules/_waku_proto.proto_lightpush.PushRPC.html">PushRPC</a></li>
|
|
<li class="tsd-kind-namespace tsd-parent-kind-namespace"><a href="../modules/_waku_proto.proto_lightpush.PushRequest.html">Push<wbr/>Request</a></li>
|
|
<li class="tsd-kind-namespace tsd-parent-kind-namespace"><a href="../modules/_waku_proto.proto_lightpush.PushResponse.html">Push<wbr/>Response</a></li>
|
|
<li class="tsd-kind-namespace tsd-parent-kind-namespace"><a href="../modules/_waku_proto.proto_lightpush.RateLimitProof.html">Rate<wbr/>Limit<wbr/>Proof</a></li>
|
|
<li class="tsd-kind-namespace tsd-parent-kind-namespace"><a href="../modules/_waku_proto.proto_lightpush.WakuMessage.html">Waku<wbr/>Message</a></li></ul></li>
|
|
<li class="tsd-kind-namespace tsd-parent-kind-module"><a href="../modules/_waku_proto.proto_message.html">proto_<wbr/>message</a>
|
|
<ul>
|
|
<li class="tsd-kind-namespace tsd-parent-kind-namespace"><a href="../modules/_waku_proto.proto_message.RateLimitProof.html">Rate<wbr/>Limit<wbr/>Proof</a></li>
|
|
<li class="tsd-kind-namespace tsd-parent-kind-namespace"><a href="../modules/_waku_proto.proto_message.WakuMessage.html">Waku<wbr/>Message</a></li></ul></li>
|
|
<li class="tsd-kind-namespace tsd-parent-kind-module"><a href="../modules/_waku_proto.proto_peer_exchange.html">proto_<wbr/>peer_<wbr/>exchange</a>
|
|
<ul>
|
|
<li class="tsd-kind-namespace tsd-parent-kind-namespace"><a href="../modules/_waku_proto.proto_peer_exchange.PeerExchangeQuery.html">Peer<wbr/>Exchange<wbr/>Query</a></li>
|
|
<li class="tsd-kind-namespace tsd-parent-kind-namespace"><a href="../modules/_waku_proto.proto_peer_exchange.PeerExchangeRPC.html">Peer<wbr/>ExchangeRPC</a></li>
|
|
<li class="tsd-kind-namespace tsd-parent-kind-namespace"><a href="../modules/_waku_proto.proto_peer_exchange.PeerExchangeResponse.html">Peer<wbr/>Exchange<wbr/>Response</a></li>
|
|
<li class="tsd-kind-namespace tsd-parent-kind-namespace"><a href="../modules/_waku_proto.proto_peer_exchange.PeerInfo.html">Peer<wbr/>Info</a></li></ul></li>
|
|
<li class="tsd-kind-namespace tsd-parent-kind-module"><a href="../modules/_waku_proto.proto_store.html">proto_<wbr/>store</a>
|
|
<ul>
|
|
<li class="tsd-kind-namespace tsd-parent-kind-namespace"><a href="../modules/_waku_proto.proto_store.ContentFilter.html">Content<wbr/>Filter</a></li>
|
|
<li class="tsd-kind-namespace tsd-parent-kind-namespace"><a href="../modules/_waku_proto.proto_store.HistoryQuery.html">History<wbr/>Query</a></li>
|
|
<li class="tsd-kind-namespace tsd-parent-kind-namespace"><a href="../modules/_waku_proto.proto_store.HistoryRPC.html">HistoryRPC</a></li>
|
|
<li class="tsd-kind-namespace tsd-parent-kind-namespace"><a href="../modules/_waku_proto.proto_store.HistoryResponse.html">History<wbr/>Response</a>
|
|
<ul>
|
|
<li class="tsd-kind-namespace tsd-parent-kind-namespace"><a href="../modules/_waku_proto.proto_store.HistoryResponse.HistoryError.html">History<wbr/>Error</a></li></ul></li>
|
|
<li class="tsd-kind-namespace tsd-parent-kind-namespace"><a href="../modules/_waku_proto.proto_store.Index.html">Index</a></li>
|
|
<li class="tsd-kind-namespace tsd-parent-kind-namespace"><a href="../modules/_waku_proto.proto_store.PagingInfo.html">Paging<wbr/>Info</a>
|
|
<ul>
|
|
<li class="tsd-kind-namespace tsd-parent-kind-namespace"><a href="../modules/_waku_proto.proto_store.PagingInfo.Direction.html">Direction</a></li></ul></li>
|
|
<li class="tsd-kind-namespace tsd-parent-kind-namespace"><a href="../modules/_waku_proto.proto_store.RateLimitProof.html">Rate<wbr/>Limit<wbr/>Proof</a></li>
|
|
<li class="tsd-kind-namespace tsd-parent-kind-namespace"><a href="../modules/_waku_proto.proto_store.WakuMessage.html">Waku<wbr/>Message</a></li></ul></li>
|
|
<li class="tsd-kind-namespace tsd-parent-kind-module"><a href="../modules/_waku_proto.proto_topic_only_message.html">proto_<wbr/>topic_<wbr/>only_<wbr/>message</a>
|
|
<ul>
|
|
<li class="tsd-kind-namespace tsd-parent-kind-namespace"><a href="../modules/_waku_proto.proto_topic_only_message.TopicOnlyMessage.html">Topic<wbr/>Only<wbr/>Message</a></li></ul></li></ul></li></ul></li></ul></div></details></nav>
|
|
<nav class="tsd-navigation secondary menu-sticky">
|
|
<ul>
|
|
<li class="current tsd-kind-interface tsd-parent-kind-namespace"><a href="_waku_core.waku_relay.RelayCreateOptions.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-interface)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-256-path"></rect><path d="M9.51 16V15.016H11.298V8.224H9.51V7.24H14.19V8.224H12.402V15.016H14.19V16H9.51Z" fill="var(--color-text)" id="icon-256-text"></path></svg><span>Relay<wbr/>Create<wbr/>Options</span></a>
|
|
<ul>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="_waku_core.waku_relay.RelayCreateOptions.html#D" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>D</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="_waku_core.waku_relay.RelayCreateOptions.html#Dhi" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>Dhi</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="_waku_core.waku_relay.RelayCreateOptions.html#Dlazy" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>Dlazy</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="_waku_core.waku_relay.RelayCreateOptions.html#Dlo" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>Dlo</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="_waku_core.waku_relay.RelayCreateOptions.html#Dout" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>Dout</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="_waku_core.waku_relay.RelayCreateOptions.html#Dscore" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>Dscore</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="_waku_core.waku_relay.RelayCreateOptions.html#allowPublishToZeroPeers" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>allow<wbr/>Publish<wbr/>To<wbr/>Zero<wbr/>Peers</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="_waku_core.waku_relay.RelayCreateOptions.html#allowedTopics" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>allowed<wbr/>Topics?</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="_waku_core.waku_relay.RelayCreateOptions.html#asyncValidation" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>async<wbr/>Validation</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="_waku_core.waku_relay.RelayCreateOptions.html#awaitRpcHandler" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>await<wbr/>Rpc<wbr/>Handler</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="_waku_core.waku_relay.RelayCreateOptions.html#awaitRpcMessageHandler" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>await<wbr/>Rpc<wbr/>Message<wbr/>Handler</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="_waku_core.waku_relay.RelayCreateOptions.html#canRelayMessage" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>can<wbr/>Relay<wbr/>Message?</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="_waku_core.waku_relay.RelayCreateOptions.html#dataTransform" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>data<wbr/>Transform?</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="_waku_core.waku_relay.RelayCreateOptions.html#debugName" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>debug<wbr/>Name?</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="_waku_core.waku_relay.RelayCreateOptions.html#decodeRpcLimits" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>decode<wbr/>Rpc<wbr/>Limits?</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="_waku_core.waku_relay.RelayCreateOptions.html#directConnectTicks" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>direct<wbr/>Connect<wbr/>Ticks?</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="_waku_core.waku_relay.RelayCreateOptions.html#directPeers" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>direct<wbr/>Peers</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="_waku_core.waku_relay.RelayCreateOptions.html#doPX" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>doPX</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="_waku_core.waku_relay.RelayCreateOptions.html#emitSelf" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>emit<wbr/>Self?</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="_waku_core.waku_relay.RelayCreateOptions.html#enabled" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>enabled?</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="_waku_core.waku_relay.RelayCreateOptions.html#fallbackToFloodsub" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>fallback<wbr/>To<wbr/>Floodsub</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="_waku_core.waku_relay.RelayCreateOptions.html#fanoutTTL" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>fanoutTTL</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="_waku_core.waku_relay.RelayCreateOptions.html#fastMsgIdFn" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>fast<wbr/>Msg<wbr/>Id<wbr/>Fn</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="_waku_core.waku_relay.RelayCreateOptions.html#floodPublish" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>flood<wbr/>Publish</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="_waku_core.waku_relay.RelayCreateOptions.html#globalSignaturePolicy" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>global<wbr/>Signature<wbr/>Policy?</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="_waku_core.waku_relay.RelayCreateOptions.html#gossipsubIWantFollowupMs" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>gossipsubIWant<wbr/>Followup<wbr/>Ms</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="_waku_core.waku_relay.RelayCreateOptions.html#graftFloodThreshold" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>graft<wbr/>Flood<wbr/>Threshold?</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="_waku_core.waku_relay.RelayCreateOptions.html#heartbeatInterval" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>heartbeat<wbr/>Interval</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="_waku_core.waku_relay.RelayCreateOptions.html#maxInboundDataLength" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>max<wbr/>Inbound<wbr/>Data<wbr/>Length?</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="_waku_core.waku_relay.RelayCreateOptions.html#maxInboundStreams" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>max<wbr/>Inbound<wbr/>Streams?</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="_waku_core.waku_relay.RelayCreateOptions.html#maxOutboundBufferSize" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>max<wbr/>Outbound<wbr/>Buffer<wbr/>Size?</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="_waku_core.waku_relay.RelayCreateOptions.html#maxOutboundStreams" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>max<wbr/>Outbound<wbr/>Streams?</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="_waku_core.waku_relay.RelayCreateOptions.html#mcacheGossip" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>mcache<wbr/>Gossip</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="_waku_core.waku_relay.RelayCreateOptions.html#mcacheLength" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>mcache<wbr/>Length</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="_waku_core.waku_relay.RelayCreateOptions.html#messageCache" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>message<wbr/>Cache</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="_waku_core.waku_relay.RelayCreateOptions.html#messageProcessingConcurrency" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>message<wbr/>Processing<wbr/>Concurrency?</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="_waku_core.waku_relay.RelayCreateOptions.html#metricsRegister" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>metrics<wbr/>Register?</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="_waku_core.waku_relay.RelayCreateOptions.html#metricsTopicStrToLabel" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>metrics<wbr/>Topic<wbr/>Str<wbr/>To<wbr/>Label?</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="_waku_core.waku_relay.RelayCreateOptions.html#msgIdFn" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>msg<wbr/>Id<wbr/>Fn</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="_waku_core.waku_relay.RelayCreateOptions.html#msgIdToStrFn" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>msg<wbr/>Id<wbr/>To<wbr/>Str<wbr/>Fn</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="_waku_core.waku_relay.RelayCreateOptions.html#multicodecs" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>multicodecs?</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="_waku_core.waku_relay.RelayCreateOptions.html#opportunisticGraftPeers" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>opportunistic<wbr/>Graft<wbr/>Peers?</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="_waku_core.waku_relay.RelayCreateOptions.html#opportunisticGraftTicks" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>opportunistic<wbr/>Graft<wbr/>Ticks?</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="_waku_core.waku_relay.RelayCreateOptions.html#pruneBackoff" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>prune<wbr/>Backoff?</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="_waku_core.waku_relay.RelayCreateOptions.html#prunePeers" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>prune<wbr/>Peers?</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_waku_core.waku_relay.RelayCreateOptions.html#pubSubTopic" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>pub<wbr/>Sub<wbr/>Topic?</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="_waku_core.waku_relay.RelayCreateOptions.html#scoreParams" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>score<wbr/>Params</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="_waku_core.waku_relay.RelayCreateOptions.html#scoreThresholds" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>score<wbr/>Thresholds</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="_waku_core.waku_relay.RelayCreateOptions.html#seenTTL" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>seenTTL</a></li></ul></li></ul></nav></div></div>
|
|
<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> |