DASH-1194 Update tests and readme file.

.env.example

@@ -0,0 +1,9 @@
+WALLET1_PRIVATE_KEY=your_private_key_here
+WALLET2_PRIVATE_KEY=your_private_key_here
+
+# FIO Handles should already exist on appropriate wallet
+WALLET1_FIO_HANDLE=your_fio_handle_here
+WALLET2_FIO_HANDLE=your_fio_handle_here
+
+# Encrypted content string to decrypt
+ENCRYPTED_CONTENT_STRING=your_encrypted_content_string_here

README.md

@@ -70,7 +70,7 @@ async function main() {
                 },
             },
         ],
-        privateKey: '5JSTL6nnXztYTD1buYfYSqJkNZTBdS9MDZf5nZsFW7gZd1pxZXo',
+        privateKey: FIO_PRIVATE_KEY,
         // Get one for testing at: http://monitor.testnet.fioprotocol.io:3000/#createKey
         // And add tokens from faucet at: http://monitor.testnet.fioprotocol.io:3000/#faucet
     };
@@ -157,9 +157,11 @@ async function main() {
     try {
         const encryptedContent = encryptContent({
             content,
-            encryptionPublicKey: 'FIO7MYkz3serGGGanVPnPPupE1xSm7t7t8mWJ3H7KEd2vS2ZZbXBF',
+            encryptionPublicKey: FIO_PUBLIC_KEY_RECIPIENT, // FIO Public key of the recipient wallet that will be used for encryption
             fioContentType: 'new_funds_content', // new_funds_content - FIO Request, or 'record_obt_data_content' - FIO Data
-            privateKey: '5JTmqev7ZsryGGkN6z4FRzd4ELQJLNZuhtQhobVVsJsBHnXxFCw'
+            privateKey: FIO_PRIVATE_KEY_SENDER // FIO Private key of the sender
+            // Get one for testing at: http://monitor.testnet.fioprotocol.io:3000/#createKey
+            // And add tokens from faucet at: http://monitor.testnet.fioprotocol.io:3000/#faucet
         });
         console.log(encryptedContent);
     } catch (error) {
@@ -192,7 +194,9 @@ async function main() {
     // URL of FIO Chain API node, see: https://bpmonitor.fio.net/nodes
     const apiUrl = 'https://test.fio.eosusa.io'; // No trailing slashes
     const params = {
-        fio_public_key: "FIO7MYkz3serGGGanVPnPPupE1xSm1t7t8mWJ3H7KEd2vS2ZZbXBF",
+        fio_public_key: FIO_PUBLIC_KEY_SENDER, // FIO Public key of the sender wallet that will be used for encryption.
+        // You need to have pending FIO Request from the sender to the recipient.
+        // You can make it using [/new_funds_request](https://dev.fio.net/reference/new_funds_request) action.
         limit: 1,
         offset: 0,
     };
@@ -206,15 +210,25 @@ async function main() {
         );
         const sentFioRequests = await response.json();
         const fioRequestToDecrypt = sentFioRequests.requests[0];
-        const decryptedContent = decryptContent({
+        const decryptedContentSender = decryptContent({
             content: fioRequestToDecrypt.content,
             encryptionPublicKey: fioRequestToDecrypt.payer_fio_public_key,
             fioContentType: 'new_funds_content', // new_funds_content - FIO Request, or 'record_obt_data_content' - FIO Data
-            privateKey: '5JTmqev7ZsryGGkN6z4FRzd4ELQJLNZuhtQhobVVsJsBHnXxFCw',
+            privateKey: FIO_PRIVATE_KEY_SENDER, // FIO Private key of the sender
             // Get one for testing at: http://monitor.testnet.fioprotocol.io:3000/#createKey
             // And add tokens from faucet at: http://monitor.testnet.fioprotocol.io:3000/#faucet
         });
-        console.log(decryptedContent);
+
+        const decryptedContentRecipient = decryptContent({
+            content: fioRequestToDecrypt.content,
+            encryptionPublicKey: fioRequestToDecrypt.payee_fio_public_key,
+            fioContentType: 'new_funds_content', // new_funds_content - FIO Request, or 'record_obt_data_content' - FIO Data
+            privateKey: FIO_PRIVATE_KEY_RECIPIENT, // FIO Private key of the recipient
+        });
+
+        // Decrypted content should be the same for both sender and recipient
+        console.log(decryptedContentSender);
+        console.log(decryptedContentRecipient);
     } catch (error) {
         console.error("Error:", error);
     }
@@ -250,7 +264,7 @@ import { signNonce, getPublicKey, verifySignature} from '@fioprotocol/fio-sdk-li
 import { createHmac, randomBytes } from 'crypto-browserify';
 
 async function main() {
-  const privKey = '5JSTL6nnXztYTD1buYfYSqJkNZTBdS9MDZf5nZsFW7gZd1pxZXo';
+  const privKey = FIO_PRIVATE_KEY;
   // Get one for testing at: http://monitor.testnet.fioprotocol.io:3000/#createKey
   // And add tokens from faucet at: http://monitor.testnet.fioprotocol.io:3000/#faucet
   const secret = 'nvjrf43dwmcsl';
@@ -287,6 +301,7 @@ main();
 
 # Testing
 
+To run tests, you need to have 2 FIO wallets with FIO Handles already created. Set it in `.env` file using `.env.example` as a template.
 Run tests using:
 
 ```bash

docs/functions/index.decryptContent.html

@@ -1 +1 @@
-<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>decryptContent | @fioprotocol/fio-sdk-lite - v1.0.1</title><meta name="description" content="Documentation for @fioprotocol/fio-sdk-lite"/><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">@fioprotocol/fio-sdk-lite - v1.0.1</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">@fioprotocol/fio-sdk-lite</a></li><li><a href="../modules/index.html">index</a></li><li><a href="index.decryptContent.html">decryptContent</a></li></ul><h1>Function decryptContent</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="decryptContent" class="tsd-anchor"></a><span class="tsd-kind-call-signature">decrypt<wbr/>Content</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">__namedParameters</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../types/types.DecryptedContent.html" class="tsd-signature-type tsd-kind-type-alias">DecryptedContent</a><a href="#decryptContent" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li 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">__namedParameters</span>: <span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">content</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">encryptionPublicKey</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">fioContentType</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">privateKey</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></span><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">content</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">encryption<wbr/>Public<wbr/>Key</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">fio<wbr/>Content<wbr/>Type</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">private<wbr/>Key</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../types/types.DecryptedContent.html" class="tsd-signature-type tsd-kind-type-alias">DecryptedContent</a></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/fioprotocol/fio.sdk-lite/blob/cb5e479cd967f7463f0ea16d98d3303206c7b44f/src/utils/encrypt/decrypt-fio.ts#L4">utils/encrypt/decrypt-fio.ts:4</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-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"><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-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></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@fioprotocol/fio-sdk-lite - v1.0.1</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer></footer><div class="overlay"></div></body></html>
+<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>decryptContent | @fioprotocol/fio-sdk-lite - v1.0.1</title><meta name="description" content="Documentation for @fioprotocol/fio-sdk-lite"/><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">@fioprotocol/fio-sdk-lite - v1.0.1</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">@fioprotocol/fio-sdk-lite</a></li><li><a href="../modules/index.html">index</a></li><li><a href="index.decryptContent.html">decryptContent</a></li></ul><h1>Function decryptContent</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="decryptContent" class="tsd-anchor"></a><span class="tsd-kind-call-signature">decrypt<wbr/>Content</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">__namedParameters</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../types/types.DecryptedContent.html" class="tsd-signature-type tsd-kind-type-alias">DecryptedContent</a><a href="#decryptContent" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li 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">__namedParameters</span>: <span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">content</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">encryptionPublicKey</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">fioContentType</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">privateKey</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></span><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">content</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">encryption<wbr/>Public<wbr/>Key</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">fio<wbr/>Content<wbr/>Type</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">private<wbr/>Key</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../types/types.DecryptedContent.html" class="tsd-signature-type tsd-kind-type-alias">DecryptedContent</a></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/fioprotocol/fio.sdk-lite/blob/d31e12c054d888993acf0af6ea5d50d566e57875/src/utils/encrypt/decrypt-fio.ts#L4">utils/encrypt/decrypt-fio.ts:4</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-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"><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-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></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@fioprotocol/fio-sdk-lite - v1.0.1</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer></footer><div class="overlay"></div></body></html>