waku-org
/
js-waku
mirror of https://github.com/waku-org/js-waku.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
js-waku/enums/_waku_interfaces.ProtocolEr...

33 lines
20 KiB
HTML
Raw Normal View History

Updates
2024-04-12 15:06:23 +00:00
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ProtocolError | Documentation</title><meta name="description" content="Documentation for Documentation"/><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 defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</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"><use href="../assets/icons.svg#icon-search"></use></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">Documentation</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"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">Documentation</a></li><li><a href="../modules/_waku_interfaces.html">@waku/interfaces</a></li><li><a href="_waku_interfaces.ProtocolError.html">ProtocolError</a></li></ul><h1>Enumeration ProtocolError</h1></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/waku-org/js-waku/blob/e5e8cd5e1/packages/interfaces/src/protocols.ts#L125">packages/interfaces/src/protocols.ts:125</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"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Enumeration Members</h3><div class="tsd-index-list"><a href="_waku_interfaces.ProtocolError.html#DECODE_FAILED" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>DECODE_<wbr/>FAILED</span></a>
Updates
2024-04-07 07:56:46 +00:00
<a href="_waku_interfaces.ProtocolError.html#EMPTY_PAYLOAD" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>EMPTY_<wbr/>PAYLOAD</span></a>
<a href="_waku_interfaces.ProtocolError.html#ENCODE_FAILED" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>ENCODE_<wbr/>FAILED</span></a>
<a href="_waku_interfaces.ProtocolError.html#GENERIC_FAIL" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>GENERIC_<wbr/>FAIL</span></a>
<a href="_waku_interfaces.ProtocolError.html#NO_PEER_AVAILABLE" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>NO_<wbr/>PEER_<wbr/>AVAILABLE</span></a>
<a href="_waku_interfaces.ProtocolError.html#REMOTE_PEER_FAULT" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>REMOTE_<wbr/>PEER_<wbr/>FAULT</span></a>
<a href="_waku_interfaces.ProtocolError.html#REMOTE_PEER_REJECTED" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>REMOTE_<wbr/>PEER_<wbr/>REJECTED</span></a>
<a href="_waku_interfaces.ProtocolError.html#REQUEST_TIMEOUT" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>REQUEST_<wbr/>TIMEOUT</span></a>
<a href="_waku_interfaces.ProtocolError.html#SIZE_TOO_BIG" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>SIZE_<wbr/>TOO_<wbr/>BIG</span></a>
<a href="_waku_interfaces.ProtocolError.html#TOPIC_NOT_CONFIGURED" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>TOPIC_<wbr/>NOT_<wbr/>CONFIGURED</span></a>
</div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Enumeration Members</h2><section class="tsd-panel tsd-member"><a id="DECODE_FAILED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>DECODE_<wbr/>FAILED</span><a href="#DECODE_FAILED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">DECODE_<wbr/>FAILED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;Failed to decode&quot;</span></div><div class="tsd-comment tsd-typography"><p>Failure to protobuf decode the message. May be due to a remote peer issue,
Updates
2023-10-16 22:17:04 +00:00
ensuring that messages are sent via several peer enable mitigation of this error.</p>
Updates
2024-04-12 15:06:23 +00:00
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/waku-org/js-waku/blob/e5e8cd5e1/packages/interfaces/src/protocols.ts#L137">packages/interfaces/src/protocols.ts:137</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="EMPTY_PAYLOAD" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>EMPTY_<wbr/>PAYLOAD</span><a href="#EMPTY_PAYLOAD" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">EMPTY_<wbr/>PAYLOAD</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;Payload is empty&quot;</span></div><div class="tsd-comment tsd-typography"><p>The message payload is empty, making the message invalid. Ensure that a non-empty
Updates
2023-10-16 22:17:04 +00:00
payload is set on the outgoing message.</p>
Updates
2024-04-12 15:06:23 +00:00
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/waku-org/js-waku/blob/e5e8cd5e1/packages/interfaces/src/protocols.ts#L142">packages/interfaces/src/protocols.ts:142</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="ENCODE_FAILED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>ENCODE_<wbr/>FAILED</span><a href="#ENCODE_FAILED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">ENCODE_<wbr/>FAILED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;Failed to encode&quot;</span></div><div class="tsd-comment tsd-typography"><p>Failure to protobuf encode the message. This is not recoverable and needs
Updates
2023-09-21 02:40:39 +00:00
further investigation.</p>
Updates
2024-04-12 15:06:23 +00:00
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/waku-org/js-waku/blob/e5e8cd5e1/packages/interfaces/src/protocols.ts#L132">packages/interfaces/src/protocols.ts:132</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="GENERIC_FAIL" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>GENERIC_<wbr/>FAIL</span><a href="#GENERIC_FAIL" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">GENERIC_<wbr/>FAIL</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;Generic error&quot;</span></div><div class="tsd-comment tsd-typography"><p>Could not determine the origin of the fault. Best to check connectivity and try again</p>
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/waku-org/js-waku/blob/e5e8cd5e1/packages/interfaces/src/protocols.ts#L127">packages/interfaces/src/protocols.ts:127</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="NO_PEER_AVAILABLE" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>NO_<wbr/>PEER_<wbr/>AVAILABLE</span><a href="#NO_PEER_AVAILABLE" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">NO_<wbr/>PEER_<wbr/>AVAILABLE</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;No peer available&quot;</span></div><div class="tsd-comment tsd-typography"><p>Failure to find a peer with suitable protocols. This may due to a connection issue.
Updates
2023-09-21 02:40:39 +00:00
Mitigation can be: retrying after a given time period, display connectivity issue
to user or listening for <code>peer:connected:bootstrap</code> or <code>peer:connected:peer-exchange</code>
on the connection manager before retrying.</p>
Updates
2024-04-12 15:06:23 +00:00
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/waku-org/js-waku/blob/e5e8cd5e1/packages/interfaces/src/protocols.ts#L159">packages/interfaces/src/protocols.ts:159</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="REMOTE_PEER_FAULT" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>REMOTE_<wbr/>PEER_<wbr/>FAULT</span><a href="#REMOTE_PEER_FAULT" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">REMOTE_<wbr/>PEER_<wbr/>FAULT</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;Remote peer fault&quot;</span></div><div class="tsd-comment tsd-typography"><p>The remote peer did not behave as expected. Mitigation for <code>NO_PEER_AVAILABLE</code>
Updates
2023-09-21 02:40:39 +00:00
or <code>DECODE_FAILED</code> can be used.</p>
Updates
2024-04-12 15:06:23 +00:00
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/waku-org/js-waku/blob/e5e8cd5e1/packages/interfaces/src/protocols.ts#L164">packages/interfaces/src/protocols.ts:164</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="REMOTE_PEER_REJECTED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>REMOTE_<wbr/>PEER_<wbr/>REJECTED</span><a href="#REMOTE_PEER_REJECTED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">REMOTE_<wbr/>PEER_<wbr/>REJECTED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;Remote peer rejected&quot;</span></div><div class="tsd-comment tsd-typography"><p>The remote peer rejected the message. Information provided by the remote peer
Updates
2023-09-21 02:40:39 +00:00
is logged. Review message validity, or mitigation for <code>NO_PEER_AVAILABLE</code>
or <code>DECODE_FAILED</code> can be used.</p>
Updates
2024-04-12 15:06:23 +00:00
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/waku-org/js-waku/blob/e5e8cd5e1/packages/interfaces/src/protocols.ts#L170">packages/interfaces/src/protocols.ts:170</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="REQUEST_TIMEOUT" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>REQUEST_<wbr/>TIMEOUT</span><a href="#REQUEST_TIMEOUT" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">REQUEST_<wbr/>TIMEOUT</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;Request timeout&quot;</span></div><div class="tsd-comment tsd-typography"><p>The protocol request timed out without a response. This may be due to a connection issue.
Updates
2024-03-13 14:05:08 +00:00
Mitigation can be: retrying after a given time period</p>
Updates
2024-04-12 15:06:23 +00:00
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/waku-org/js-waku/blob/e5e8cd5e1/packages/interfaces/src/protocols.ts#L175">packages/interfaces/src/protocols.ts:175</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="SIZE_TOO_BIG" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>SIZE_<wbr/>TOO_<wbr/>BIG</span><a href="#SIZE_TOO_BIG" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">SIZE_<wbr/>TOO_<wbr/>BIG</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;Size is too big&quot;</span></div><div class="tsd-comment tsd-typography"><p>The message size is above the maximum message size allowed on the Waku Network.
Updates
2023-09-21 02:40:39 +00:00
Compressing the message or using an alternative strategy for large messages is recommended.</p>
Updates
2024-04-12 15:06:23 +00:00
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/waku-org/js-waku/blob/e5e8cd5e1/packages/interfaces/src/protocols.ts#L147">packages/interfaces/src/protocols.ts:147</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="TOPIC_NOT_CONFIGURED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>TOPIC_<wbr/>NOT_<wbr/>CONFIGURED</span><a href="#TOPIC_NOT_CONFIGURED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">TOPIC_<wbr/>NOT_<wbr/>CONFIGURED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;Topic not configured&quot;</span></div><div class="tsd-comment tsd-typography"><p>The PubsubTopic passed to the send function is not configured on the Waku node.
Updates
2023-11-14 15:55:04 +00:00
Please ensure that the PubsubTopic is used when initializing the Waku node.</p>
Updates
2024-04-12 15:06:23 +00:00
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/waku-org/js-waku/blob/e5e8cd5e1/packages/interfaces/src/protocols.ts#L152">packages/interfaces/src/protocols.ts:152</a></li></ul></aside></section></section></div><div class="col-sidebar"><div class="page-menu"><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"><use href="../assets/icons.svg#icon-chevronDown"></use></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></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#DECODE_FAILED" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>DECODE_<wbr/>FAILED</span></a><a href="#EMPTY_PAYLOAD" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>EMPTY_<wbr/>PAYLOAD</span></a><a href="#ENCODE_FAILED" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>ENCODE_<wbr/>FAILED</span></a><a href="#GENERIC_FAIL" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>GENERIC_<wbr/>FAIL</span></a><a href="#NO_PEER_AVAILABLE" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>NO_<wbr/>PEER_<wbr/>AVAILABLE</span></a><a href="#REMOTE_PEER_FAULT" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>REMOTE_<wbr/>PEER_<wbr/>FAULT</span></a><a href="#REMOTE_PEER_REJECTED" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>REMOTE_<wbr/>PEER_<wbr/>REJECTED</span></a><a href="#REQUEST_TIMEOUT" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../asset