mirror of
https://github.com/logos-messaging/js-waku.git
synced 2026-01-02 13:53:12 +00:00
18 lines
36 KiB
HTML
18 lines
36 KiB
HTML
<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>DecodedMessage | 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><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">Documentation</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="../modules/_waku_message-encryption.html">@waku/message-encryption</a></li><li><a href="" aria-current="page">DecodedMessage</a></li></ul><h1>Class DecodedMessage</h1></div><section class="tsd-panel tsd-hierarchy" data-refl="7651"><h4>Hierarchy (<a href="../hierarchy.html#@waku/message-encryption.DecodedMessage">View Summary</a>)</h4><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><a href="_waku_core.DecodedMessage.html" class="tsd-signature-type tsd-kind-class">DecodedMessage</a><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">DecodedMessage</span></li></ul></li></ul></section><section class="tsd-panel"><h4>Implements</h4><ul class="tsd-hierarchy"><li><a href="../interfaces/_waku_interfaces.IEncryptedMessage.html" class="tsd-signature-type tsd-kind-interface">IEncryptedMessage</a></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/waku-org/js-waku/blob/84a6ea69cf8630dacea0cafd58dd8c605ee8dc48/packages/message-encryption/src/decoded_message.ts#L8">packages/message-encryption/src/decoded_message.ts:8</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-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h5 class="tsd-index-heading uppercase">Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
|
||
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="#pubsubtopic" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>pubsub<wbr/>Topic</span></a>
|
||
<a href="#signature" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>signature?</span></a>
|
||
<a href="#signaturepublickey" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>signature<wbr/>Public<wbr/>Key?</span></a>
|
||
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Accessors</h3><div class="tsd-index-list"><a href="#contenttopic" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>content<wbr/>Topic</span></a>
|
||
<a href="#ephemeral" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>ephemeral</span></a>
|
||
<a href="#hash" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>hash</span></a>
|
||
<a href="#hashstr" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>hash<wbr/>Str</span></a>
|
||
<a href="#meta" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>meta</span></a>
|
||
<a href="#payload" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>payload</span></a>
|
||
<a href="#ratelimitproof" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>rate<wbr/>Limit<wbr/>Proof</span></a>
|
||
<a href="#timestamp" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>timestamp</span></a>
|
||
<a href="#version" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>version</span></a>
|
||
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="#verifysignature" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>verify<wbr/>Signature</span></a>
|
||
</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Constructors</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="constructor"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="constructordecodedmessage"><span class="tsd-signature-keyword">new</span> <span class="tsd-kind-constructor-signature">DecodedMessage</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">pubsubTopic</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">proto</span><span class="tsd-signature-symbol">:</span> <a href="../modules/_waku_core.message.html" class="tsd-signature-type tsd-kind-namespace">message</a><span class="tsd-signature-symbol">.</span><a href="../modules/_waku_core.message.version_0.html" class="tsd-signature-type tsd-kind-namespace">version_0</a><span class="tsd-signature-symbol">.</span><a href="../modules/_waku_core.message.version_0.proto.html" class="tsd-signature-type tsd-kind-namespace">proto</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/_waku_core.message.version_0.proto.WakuMessage.html" class="tsd-signature-type tsd-kind-interface">WakuMessage</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">decodedPayload</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Uint8Array</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">signature</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Uint8Array</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ArrayBufferLike</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">signaturePublicKey</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Uint8Array</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ArrayBufferLike</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">DecodedMessage</a><a href="#constructordecodedmessage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">pubsubTopic</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">proto</span>: <a href="../modules/_waku_core.message.html" class="tsd-signature-type tsd-kind-namespace">message</a><span class="tsd-signature-symbol">.</span><a href="../modules/_waku_core.message.version_0.html" class="tsd-signature-type tsd-kind-namespace">version_0</a><span class="tsd-signature-symbol">.</span><a href="../modules/_waku_core.message.version_0.proto.html" class="tsd-signature-type tsd-kind-namespace">proto</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/_waku_core.message.version_0.proto.WakuMessage.html" class="tsd-signature-type tsd-kind-interface">WakuMessage</a></span></li><li><span><span class="tsd-kind-parameter">decodedPayload</span>: <span class="tsd-signature-type">Uint8Array</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">signature</span>: <span class="tsd-signature-type">Uint8Array</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ArrayBufferLike</span><span class="tsd-signature-symbol">></span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">signaturePublicKey</span>: <span class="tsd-signature-type">Uint8Array</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ArrayBufferLike</span><span class="tsd-signature-symbol">></span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">DecodedMessage</a></h4><aside class="tsd-sources"><p>Overrides <a href="_waku_core.DecodedMessage.html">DecodedMessage</a>.<a href="_waku_core.DecodedMessage.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/waku-org/js-waku/blob/84a6ea69cf8630dacea0cafd58dd8c605ee8dc48/packages/message-encryption/src/decoded_message.ts#L14">packages/message-encryption/src/decoded_message.ts:14</a></li></ul></aside></div></li></ul></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Properties</h2></summary><section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="pubsubtopic"><span>pubsub<wbr/>Topic</span><a href="#pubsubtopic" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">pubsubTopic</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/_waku_interfaces.IEncryptedMessage.html">IEncryptedMessage</a>.<a href="../interfaces/_waku_interfaces.IEncryptedMessage.html#pubsubtopic">pubsubTopic</a></p><p>Inherited from <a href="_waku_core.DecodedMessage.html">DecodedMessage</a>.<a href="_waku_core.DecodedMessage.html#pubsubtopic">pubsubTopic</a></p><ul><li>Defined in packages/core/dist/lib/message/version_0.d.ts:6</li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="signature"><code class="tsd-tag">Optional</code><span>signature</span><a href="#signature" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">signature</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Uint8Array</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ArrayBufferLike</span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/_waku_interfaces.IEncryptedMessage.html">IEncryptedMessage</a>.<a href="../interfaces/_waku_interfaces.IEncryptedMessage.html#signature">signature</a></p><ul><li>Defined in <a href="https://github.com/waku-org/js-waku/blob/84a6ea69cf8630dacea0cafd58dd8c605ee8dc48/packages/message-encryption/src/decoded_message.ts#L18">packages/message-encryption/src/decoded_message.ts:18</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="signaturepublickey"><code class="tsd-tag">Optional</code><span>signature<wbr/>Public<wbr/>Key</span><a href="#signaturepublickey" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">signaturePublicKey</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Uint8Array</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ArrayBufferLike</span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/_waku_interfaces.IEncryptedMessage.html">IEncryptedMessage</a>.<a href="../interfaces/_waku_interfaces.IEncryptedMessage.html#signaturepublickey">signaturePublicKey</a></p><ul><li>Defined in <a href="https://github.com/waku-org/js-waku/blob/84a6ea69cf8630dacea0cafd58dd8c605ee8dc48/packages/message-encryption/src/decoded_message.ts#L19">packages/message-encryption/src/decoded_message.ts:19</a></li></ul></aside></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Accessors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Accessors</h2></summary><section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="contenttopic"><span>content<wbr/>Topic</span><a href="#contenttopic" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li><div class="tsd-signature" id="contenttopiccontenttopic"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">contentTopic</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/_waku_interfaces.IEncryptedMessage.html">IEncryptedMessage</a>.<a href="../interfaces/_waku_interfaces.IEncryptedMessage.html#contenttopic">contentTopic</a></p><p>Inherited from DecodedMessageV0.contentTopic</p><ul><li>Defined in packages/core/dist/lib/message/version_0.d.ts:13</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="ephemeral"><span>ephemeral</span><a href="#ephemeral" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li><div class="tsd-signature" id="ephemeralephemeral"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">ephemeral</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/_waku_interfaces.IEncryptedMessage.html">IEncryptedMessage</a>.<a href="../interfaces/_waku_interfaces.IEncryptedMessage.html#ephemeral">ephemeral</a></p><p>Inherited from DecodedMessageV0.ephemeral</p><ul><li>Defined in packages/core/dist/lib/message/version_0.d.ts:11</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="hash"><span>hash</span><a href="#hash" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li><div class="tsd-signature" id="hashhash"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">hash</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Uint8Array</span></div><div class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Uint8Array</span></h4><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/_waku_interfaces.IEncryptedMessage.html">IEncryptedMessage</a>.<a href="../interfaces/_waku_interfaces.IEncryptedMessage.html#hash">hash</a></p><p>Inherited from DecodedMessageV0.hash</p><ul><li>Defined in packages/core/dist/lib/message/version_0.d.ts:14</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="hashstr"><span>hash<wbr/>Str</span><a href="#hashstr" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li><div class="tsd-signature" id="hashstrhashstr"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">hashStr</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/_waku_interfaces.IEncryptedMessage.html">IEncryptedMessage</a>.<a href="../interfaces/_waku_interfaces.IEncryptedMessage.html#hashstr">hashStr</a></p><p>Inherited from DecodedMessageV0.hashStr</p><ul><li>Defined in packages/core/dist/lib/message/version_0.d.ts:15</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="meta"><span>meta</span><a href="#meta" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li><div class="tsd-signature" id="metameta"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">meta</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">Uint8Array</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ArrayBufferLike</span><span class="tsd-signature-symbol">></span></div><div class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">Uint8Array</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ArrayBufferLike</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/_waku_interfaces.IEncryptedMessage.html">IEncryptedMessage</a>.<a href="../interfaces/_waku_interfaces.IEncryptedMessage.html#meta">meta</a></p><p>Inherited from DecodedMessageV0.meta</p><ul><li>Defined in packages/core/dist/lib/message/version_0.d.ts:17</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="payload"><span>payload</span><a href="#payload" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li><div class="tsd-signature" id="payloadpayload"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">payload</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Uint8Array</span></div><div class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Uint8Array</span></h4><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/_waku_interfaces.IEncryptedMessage.html">IEncryptedMessage</a>.<a href="../interfaces/_waku_interfaces.IEncryptedMessage.html#payload">payload</a></p><p>Overrides DecodedMessageV0.payload</p><ul><li>Defined in <a href="https://github.com/waku-org/js-waku/blob/84a6ea69cf8630dacea0cafd58dd8c605ee8dc48/packages/message-encryption/src/decoded_message.ts#L25">packages/message-encryption/src/decoded_message.ts:25</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="ratelimitproof"><span>rate<wbr/>Limit<wbr/>Proof</span><a href="#ratelimitproof" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li><div class="tsd-signature" id="ratelimitproofratelimitproof"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">rateLimitProof</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <a href="../interfaces/_waku_interfaces.IRateLimitProof.html" class="tsd-signature-type tsd-kind-interface">IRateLimitProof</a></div><div class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <a href="../interfaces/_waku_interfaces.IRateLimitProof.html" class="tsd-signature-type tsd-kind-interface">IRateLimitProof</a></h4><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/_waku_interfaces.IEncryptedMessage.html">IEncryptedMessage</a>.<a href="../interfaces/_waku_interfaces.IEncryptedMessage.html#ratelimitproof">rateLimitProof</a></p><p>Inherited from DecodedMessageV0.rateLimitProof</p><ul><li>Defined in packages/core/dist/lib/message/version_0.d.ts:19</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="timestamp"><span>timestamp</span><a href="#timestamp" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li><div class="tsd-signature" id="timestamptimestamp"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">timestamp</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">Date</span></div><div class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">Date</span></h4><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/_waku_interfaces.IEncryptedMessage.html">IEncryptedMessage</a>.<a href="../interfaces/_waku_interfaces.IEncryptedMessage.html#timestamp">timestamp</a></p><p>Inherited from DecodedMessageV0.timestamp</p><ul><li>Defined in packages/core/dist/lib/message/version_0.d.ts:16</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="version"><span>version</span><a href="#version" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li><div class="tsd-signature" id="versionversion"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">version</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/_waku_interfaces.IEncryptedMessage.html">IEncryptedMessage</a>.<a href="../interfaces/_waku_interfaces.IEncryptedMessage.html#version">version</a></p><p>Inherited from DecodedMessageV0.version</p><ul><li>Defined in packages/core/dist/lib/message/version_0.d.ts:18</li></ul></aside></div></li></ul></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Methods</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="verifysignature"><span>verify<wbr/>Signature</span><a href="#verifysignature" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="verifysignature-1"><span class="tsd-kind-call-signature">verifySignature</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">publicKey</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Uint8Array</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><a href="#verifysignature-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Verify the message's signature against the public key.</p>
|
||
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">publicKey</span>: <span class="tsd-signature-type">Uint8Array</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><p>true if the signature matches the public key, false if not or if no signature is present.</p>
|
||
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/_waku_interfaces.IEncryptedMessage.html">IEncryptedMessage</a>.<a href="../interfaces/_waku_interfaces.IEncryptedMessage.html#verifysignature">verifySignature</a></p><ul><li>Defined in <a href="https://github.com/waku-org/js-waku/blob/84a6ea69cf8630dacea0cafd58dd8c605ee8dc48/packages/message-encryption/src/decoded_message.ts#L34">packages/message-encryption/src/decoded_message.ts:34</a></li></ul></aside></div></li></ul></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><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-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></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><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-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Constructors</summary><div><a href="#constructor"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#pubsubtopic" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>pubsub<wbr/>Topic</span></a><a href="#signature"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>signature</span></a><a href="#signaturepublickey"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>signature<wbr/>Public<wbr/>Key</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Accessors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Accessors</summary><div><a href="#contenttopic" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>content<wbr/>Topic</span></a><a href="#ephemeral" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>ephemeral</span></a><a href="#hash" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>hash</span></a><a href="#hashstr" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>hash<wbr/>Str</span></a><a href="#meta" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>meta</span></a><a href="#payload"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>payload</span></a><a href="#ratelimitproof" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>rate<wbr/>Limit<wbr/>Proof</span></a><a href="#timestamp" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>timestamp</span></a><a href="#version" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>version</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Methods</summary><div><a href="#verifysignature"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>verify<wbr/>Signature</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">Documentation</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|