<h2id="symmetric-encryption"class="tsd-anchor-link">Symmetric Encryption<ahref="#symmetric-encryption"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"aria-hidden="true"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h2><p>Symmetric encryption uses a unique key to encrypt and decrypt messages.</p>
<pre><codeclass="typescript"><spanclass="hl-8">import</span><spanclass="hl-1"> {</span><br/><spanclass="hl-1"></span><spanclass="hl-5">createDecoder</span><spanclass="hl-1">,</span><br/><spanclass="hl-1"></span><spanclass="hl-5">createEncoder</span><spanclass="hl-1">,</span><br/><spanclass="hl-1"></span><spanclass="hl-5">generateSymmetricKey</span><br/><spanclass="hl-1">} </span><spanclass="hl-8">from</span><spanclass="hl-1"></span><spanclass="hl-2">"@waku/message-encryption/symmetric"</span><spanclass="hl-1">;</span><br/><br/><spanclass="hl-3">// Generate a random key</span><br/><spanclass="hl-4">const</span><spanclass="hl-1"></span><spanclass="hl-7">key</span><spanclass="hl-1"> = </span><spanclass="hl-0">generateSymmetricKey</span><spanclass="hl-1">();</span><br/><br/><spanclass="hl-3">// To send messages, create an encoder</span><br/><spanclass="hl-4">const</span><spanclass="hl-1"></span><spanclass="hl-7">encoder</span><spanclass="hl-1"> = </span><spanclass="hl-0">createEncoder</span><spanclass="hl-1">(</span><spanclass="hl-5">contentTopic</span><spanclass="hl-1">, </span><spanclass="hl-5">key</span><spanclass="hl-1">);</span><br/><br/><spanclass="hl-3">// For example</span><br/><spanclass="hl-5">waku</span><spanclass="hl-1">.</span><spanclass="hl-5">lightPush</span><spanclass="hl-1">.</span><spanclass="hl-0">push</span><spanclass="hl-1">(</span><spanclass="hl-5">encoder</span><spanclass="hl-1">, { </span><spanclass="hl-5">payload</span><spanclass="hl-1"> });</span><br/><br/><spanclass="hl-3">// To receive messages, create a decoder</span><br/><spanclass="hl-4">const</span><spanclass="hl-1"></span><spanclass="hl-7">decoder</span><spanclass="hl-1"> = </span><spanclass="hl-0">createDecoder</span><spanclass="hl-1">(</span><spanclass="hl-5">contentTopic</span><spanclass="hl-1">, </span><spanclass="hl-5">key</span><spanclass="hl-1">);</span><br/><br/><spanclass="hl-3">// For example</span><br/><spanclass="hl-8">await</span><spanclass="hl-1"></span><spanclass="hl-5">waku</span><spanclass="hl-1">.</span><spanclass="hl-5">store</span><spanclass="hl-1">.</span><spanclass="hl-0">queryOrderedCallback</span><spanclass="hl-1">([</span><spanclass="hl-5">decoder</span><spanclass="hl-1">], (</span><spanclass="hl-5">msg</span><spanclass="hl-1">) </span><spanclass="hl-4">=></span><spanclass="hl-1"> {</span><br/><spanclass="hl-1"></span><spanclass="hl-3">// ...</span><br/><spanclass="hl-1">});</span>
</code><buttontype="button">Copy</button></pre>
<h2id="ecies-encryption"class="tsd-anchor-link">ECIES Encryption<ahref="#ecies-encryption"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"aria-hidden="true"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h2><p>ECIES encryption enables encryption for a public key and decryption using a private key.</p>
<pre><codeclass="typescript"><spanclass="hl-8">import</span><spanclass="hl-1"> {</span><br/><spanclass="hl-1"></span><spanclass="hl-5">createDecoder</span><spanclass="hl-1">,</span><br/><spanclass="hl-1"></span><spanclass="hl-5">createEncoder</span><spanclass="hl-1">,</span><br/><spanclass="hl-1"></span><spanclass="hl-5">generatePrivateKey</span><spanclass="hl-1">,</span><br/><spanclass="hl-1"></span><spanclass="hl-5">getPublicKey</span><br/><spanclass="hl-1">} </span><spanclass="hl-8">from</span><spanclass="hl-1"></span><spanclass="hl-2">"@waku/message-encryption/ecies"</span><spanclass="hl-1">;</span><br/><br/><spanclass="hl-3">// Generate a random private key</span><br/><spanclass="hl-4">const</span><spanclass="hl-1"></span><spanclass="hl-7">privateKey</span><spanclass="hl-1"> = </span><spanclass="hl-0">generatePrivateKey</span><spanclass="hl-1">();</span><br/><br/><spanclass="hl-3">// Keep the private key secure, provide the public key to the sender</span><br/><spanclass="hl-4">const</span><spanclass="hl-1"></span><spanclass="hl-7">publicKey</span><spanclass="hl-1"> = </span><spanclass="hl-0">getPublicKey</span><spanclass="hl-1">(</span><spanclass="hl-5">privateKey</span><spanclass="hl-1">);</span><br/><br/><spanclass="hl-3">// To send messages, create an encoder</span><br/><spanclass="hl-4">const</span><spanclass="hl-1"></span><spanclass="hl-7">encoder</span><spanclass="hl-1"> = </span><spanclass="hl-0">createEncoder</span><spanclass="hl-1">(</span><spanclass="hl-5">contentTopic</span><spanclass="hl-1">, </span><spanclass="hl-5">publicKey</span><spanclass="hl-1">);</span><br/><br/><spanclass="hl-3">// For example</span><br/><spanclass="hl-5">waku</span><spanclass="hl-1">.</span><spanclass="hl-5">lightPush</span><spanclass="hl-1">.</span><spanclass="hl-0">push</span><spanclass="hl-1">(</span><spanclass="hl-5">encoder</span><spanclass="hl-1">, { </span><spanclass="hl-5">payload</span><spanclass="hl-1"> });</span><br/><br/><spanclass="hl-3">// To receive messages, create a decoder</span><br/><spanclass="hl-4">const</span><spanclass="hl-1"></span><spanclass="hl-7">decoder</span><spanclass="hl-1"> = </span><spanclass="hl-0">createDecoder</span><spanclass="hl-1">(</span><spanclass="hl-5">contentTopic</span><spanclass="hl-1">, </span><spanclass="hl-5">privateKey</span><spanclass="hl-1">);</span><br/><br/><spanclass="hl-3">// For example</span><br/><spanclass="hl-8">await</span><spanclass="hl-1"></span><spanclass="hl-5">waku</span><spanclass="hl-1">.</span><spanclass="hl-5">store</span><spanclass="hl-1">.</span><spanclass="hl-0">queryOrderedCallback</span><spanclass="hl-1">([</span><spanclass="hl-5">decoder</span><spanclass="hl-1">], (</span><spanclass="hl-5">msg</span><spanclass="hl-1">) </span><spanclass="hl-4">=></span><spanclass="hl-1"> {</span><br/><spanclass="hl-1"></span><spanclass="hl-3">// ...</span><br/><spanclass="hl-1">});</span>