kylefang/stacks.js
1
0
Fork 0
mirror of https://github.com/alexgo-io/stacks.js.git synced 2026-05-07 13:14:52 +08:00
Code Issues Packages Projects Releases Wiki Activity
Files
f572477ca0e5bc5e862c8a4e2fcc276655ee55a3
stacks.js/docs/modules/encryption.html
Alexander Graebe f572477ca0 feat: add regtest to list of available networks 
fixes #1041
2021-06-28 10:27:07 -07:00

555 lines
30 KiB
HTML
Vendored
Raw Blame History

<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>encryption | Stacks.js 1.4.1 Library Reference</title>
<meta name="description" content="Documentation for Stacks.js 1.4.1 Library Reference">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</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">Stacks.js 1.4.1 Library Reference</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">Stacks.js 1.4.1 Library Reference</a>
</li>
<li>
<a href="encryption.html">encryption</a>
</li>
</ul>
<h1>Module encryption</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-comment">
<div class="tsd-comment tsd-typography">
<a href="#stacksencryption" id="stacksencryption" style="color: inherit; text-decoration: none;">
<h1>@stacks/encryption</h1>
</a>
<p>Encryption functions used by Stacks.js packages.</p>
<a href="#installation" id="installation" style="color: inherit; text-decoration: none;">
<h2>Installation</h2>
</a>
<pre><code><span style="color: #001080">npm</span><span style="color: #000000"> </span><span style="color: #001080">install</span><span style="color: #000000"> @</span><span style="color: #001080">stacks</span><span style="color: #000000">/</span><span style="color: #001080">cli</span>
</code></pre>
</div>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Classes</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/encryption.nodecryptosha2hash.html" class="tsd-kind-icon">Node<wbr>Crypto<wbr>Sha2<wbr>Hash</a></li>
<li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/encryption.webcryptosha2hash.html" class="tsd-kind-icon">Web<wbr>Crypto<wbr>Sha2<wbr>Hash</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Interfaces</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/encryption.encryptcontentoptions.html" class="tsd-kind-icon">Encrypt<wbr>Content<wbr>Options</a></li>
<li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/encryption.encryptionoptions.html" class="tsd-kind-icon">Encryption<wbr>Options</a></li>
<li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/encryption.sha2hash.html" class="tsd-kind-icon">Sha2<wbr>Hash</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Type aliases</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="encryption.html#getrandombytes" class="tsd-kind-icon">Get<wbr>Random<wbr>Bytes</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Functions</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-function tsd-parent-kind-module"><a href="encryption.html#createsha2hash" class="tsd-kind-icon">create<wbr>Sha2<wbr>Hash</a></li>
<li class="tsd-kind-function tsd-parent-kind-module"><a href="encryption.html#decryptcontent" class="tsd-kind-icon">decrypt<wbr>Content</a></li>
<li class="tsd-kind-function tsd-parent-kind-module"><a href="encryption.html#encryptcontent" class="tsd-kind-icon">encrypt<wbr>Content</a></li>
<li class="tsd-kind-function tsd-parent-kind-module"><a href="encryption.html#getbase64outputlength" class="tsd-kind-icon">get<wbr>Base64<wbr>Output<wbr>Length</a></li>
<li class="tsd-kind-function tsd-parent-kind-module"><a href="encryption.html#hashsha256sync" class="tsd-kind-icon">hash<wbr>Sha256<wbr>Sync</a></li>
<li class="tsd-kind-function tsd-parent-kind-module"><a href="encryption.html#hashsha512sync" class="tsd-kind-icon">hash<wbr>Sha512<wbr>Sync</a></li>
<li class="tsd-kind-function tsd-parent-kind-module tsd-is-external"><a href="encryption.html#randombytes" class="tsd-kind-icon">random<wbr>Bytes</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Type aliases</h2>
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module">
<a name="getrandombytes" class="tsd-anchor"></a>
<h3>Get<wbr>Random<wbr>Bytes</h3>
<div class="tsd-signature tsd-kind-icon">Get<wbr>Random<wbr>Bytes<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>count<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Buffer</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/encryption/src/cryptoRandom.ts#L8">packages/encryption/src/cryptoRandom.ts:8</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Optional function to generate cryptographically secure random bytes</p>
</div>
</div>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter-signature">
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-alias">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>count<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>count: <span class="tsd-signature-type">number</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Buffer</span></h4>
</li>
</ul>
</li>
</ul>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Functions</h2>
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
<a name="createsha2hash" class="tsd-anchor"></a>
<h3>create<wbr>Sha2<wbr>Hash</h3>
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
<li class="tsd-signature tsd-kind-icon">create<wbr>Sha2<wbr>Hash<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/encryption.sha2hash.html" class="tsd-signature-type" data-tsd-kind="Interface">Sha2Hash</a><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/encryption/src/sha2Hash.ts#L61">packages/encryption/src/sha2Hash.ts:61</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/encryption.sha2hash.html" class="tsd-signature-type" data-tsd-kind="Interface">Sha2Hash</a><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
<a name="decryptcontent" class="tsd-anchor"></a>
<h3>decrypt<wbr>Content</h3>
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
<li class="tsd-signature tsd-kind-icon">decrypt<wbr>Content<span class="tsd-signature-symbol">(</span>content<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>privateKey<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-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/encryption/src/encryption.ts#L111">packages/encryption/src/encryption.ts:111</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Decrypts data encrypted with <code>encryptContent</code> with the
transit private key.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>content: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>encrypted content.</p>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-symbol">{ </span>privateKey<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></h5>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5><span class="tsd-flag ts-flagOptional">Optional</span> private<wbr>Key<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>the hex string of the ECDSA private
key to use for decryption. If not provided, will use user&#39;s appPrivateKey.</p>
</div>
</li>
</ul>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">&gt;</span></h4>
<p>decrypted content.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
<a name="encryptcontent" class="tsd-anchor"></a>
<h3>encrypt<wbr>Content</h3>
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
<li class="tsd-signature tsd-kind-icon">encrypt<wbr>Content<span class="tsd-signature-symbol">(</span>content<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Buffer</span>, options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/encryption.encryptcontentoptions.html" class="tsd-signature-type" data-tsd-kind="Interface">EncryptContentOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/encryption/src/encryption.ts#L59">packages/encryption/src/encryption.ts:59</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Encrypts the data provided with the app public key.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>content: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Buffer</span></h5>
<div class="tsd-comment tsd-typography">
<p>data to encrypt</p>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <a href="../interfaces/encryption.encryptcontentoptions.html" class="tsd-signature-type" data-tsd-kind="Interface">EncryptContentOptions</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></h4>
<p>Stringified ciphertext object</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
<a name="getbase64outputlength" class="tsd-anchor"></a>
<h3>get<wbr>Base64<wbr>Output<wbr>Length</h3>
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
<li class="tsd-signature tsd-kind-icon">get<wbr>Base64<wbr>Output<wbr>Length<span class="tsd-signature-symbol">(</span>inputByteLength<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/encryption/src/utils.ts#L18">packages/encryption/src/utils.ts:18</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Calculate the base64 encoded string length for a given input length.
This is equivalent to the byte length when the string is ASCII or UTF8-8
encoded.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>inputByteLength: <span class="tsd-signature-type">number</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
<a name="hashsha256sync" class="tsd-anchor"></a>
<h3>hash<wbr>Sha256<wbr>Sync</h3>
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
<li class="tsd-signature tsd-kind-icon">hash<wbr>Sha256<wbr>Sync<span class="tsd-signature-symbol">(</span>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/encryption/src/sha2Hash.ts#L70">packages/encryption/src/sha2Hash.ts:70</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>data: <span class="tsd-signature-type">Buffer</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Buffer</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
<a name="hashsha512sync" class="tsd-anchor"></a>
<h3>hash<wbr>Sha512<wbr>Sync</h3>
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
<li class="tsd-signature tsd-kind-icon">hash<wbr>Sha512<wbr>Sync<span class="tsd-signature-symbol">(</span>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/encryption/src/sha2Hash.ts#L76">packages/encryption/src/sha2Hash.ts:76</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>data: <span class="tsd-signature-type">Buffer</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Buffer</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module tsd-is-external">
<a name="randombytes" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagConst">Const</span> random<wbr>Bytes</h3>
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module tsd-is-external">
<li class="tsd-signature tsd-kind-icon">random<wbr>Bytes<span class="tsd-signature-symbol">(</span>size<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span></li>
<li class="tsd-signature tsd-kind-icon">random<wbr>Bytes<span class="tsd-signature-symbol">(</span>size<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, callback<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Error</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span>, buf<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in node_modules/@types/randombytes/index.d.ts:12</li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>size: <span class="tsd-signature-type">number</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Buffer</span></h4>
</li>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in node_modules/@types/randombytes/index.d.ts:12</li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>size: <span class="tsd-signature-type">number</span></h5>
</li>
<li>
<h5>callback: <span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Error</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span>, buf<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span></h5>
<ul class="tsd-parameters">
<li class="tsd-parameter-signature">
<ul class="tsd-signatures tsd-kind-type-literal tsd-is-external">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Error</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span>, buf<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>err: <span class="tsd-signature-type">Error</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></h5>
</li>
<li>
<h5>buf: <span class="tsd-signature-type">Buffer</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../modules.html">Modules</a>
</li>
<li class=" tsd-kind-module">
<a href="auth.html">auth</a>
</li>
<li class=" tsd-kind-module">
<a href="bns.html">bns</a>
</li>
<li class=" tsd-kind-module">
<a href="cli.html">cli</a>
</li>
<li class=" tsd-kind-module">
<a href="common.html">common</a>
</li>
<li class="current tsd-kind-module">
<a href="encryption.html">encryption</a>
</li>
<li class=" tsd-kind-module">
<a href="keychain.html">keychain</a>
</li>
<li class=" tsd-kind-module">
<a href="network.html">network</a>
</li>
<li class=" tsd-kind-module">
<a href="profile.html">profile</a>
</li>
<li class=" tsd-kind-module">
<a href="stacking.html">stacking</a>
</li>
<li class=" tsd-kind-module">
<a href="storage.html">storage</a>
</li>
<li class=" tsd-kind-module">
<a href="transactions.html">transactions</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
<li class=" tsd-kind-module">
<a href="auth.html" class="tsd-kind-icon">auth</a>
</li>
<li class=" tsd-kind-module">
<a href="bns.html" class="tsd-kind-icon">bns</a>
</li>
<li class=" tsd-kind-module">
<a href="cli.html" class="tsd-kind-icon">cli</a>
</li>
<li class=" tsd-kind-module">
<a href="common.html" class="tsd-kind-icon">common</a>
</li>
</ul>
<ul class="current">
<li class="current tsd-kind-module">
<a href="encryption.html" class="tsd-kind-icon">encryption</a>
<ul>
<li class=" tsd-kind-class tsd-parent-kind-module">
<a href="../classes/encryption.nodecryptosha2hash.html" class="tsd-kind-icon">Node<wbr>Crypto<wbr>Sha2<wbr>Hash</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-module">
<a href="../classes/encryption.webcryptosha2hash.html" class="tsd-kind-icon">Web<wbr>Crypto<wbr>Sha2<wbr>Hash</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="../interfaces/encryption.encryptcontentoptions.html" class="tsd-kind-icon">Encrypt<wbr>Content<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="../interfaces/encryption.encryptionoptions.html" class="tsd-kind-icon">Encryption<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="../interfaces/encryption.sha2hash.html" class="tsd-kind-icon">Sha2<wbr>Hash</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
<a href="encryption.html#getrandombytes" class="tsd-kind-icon">Get<wbr>Random<wbr>Bytes</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-module">
<a href="encryption.html#createsha2hash" class="tsd-kind-icon">create<wbr>Sha2<wbr>Hash</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-module">
<a href="encryption.html#decryptcontent" class="tsd-kind-icon">decrypt<wbr>Content</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-module">
<a href="encryption.html#encryptcontent" class="tsd-kind-icon">encrypt<wbr>Content</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-module">
<a href="encryption.html#getbase64outputlength" class="tsd-kind-icon">get<wbr>Base64<wbr>Output<wbr>Length</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-module">
<a href="encryption.html#hashsha256sync" class="tsd-kind-icon">hash<wbr>Sha256<wbr>Sync</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-module">
<a href="encryption.html#hashsha512sync" class="tsd-kind-icon">hash<wbr>Sha512<wbr>Sync</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-module tsd-is-external">
<a href="encryption.html#randombytes" class="tsd-kind-icon">random<wbr>Bytes</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
<li class=" tsd-kind-module">
<a href="keychain.html" class="tsd-kind-icon">keychain</a>
</li>
<li class=" tsd-kind-module">
<a href="network.html" class="tsd-kind-icon">network</a>
</li>
<li class=" tsd-kind-module">
<a href="profile.html" class="tsd-kind-icon">profile</a>
</li>
<li class=" tsd-kind-module">
<a href="stacking.html" class="tsd-kind-icon">stacking</a>
</li>
<li class=" tsd-kind-module">
<a href="storage.html" class="tsd-kind-icon">storage</a>
</li>
<li class=" tsd-kind-module">
<a href="transactions.html" class="tsd-kind-icon">transactions</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<footer class="with-border-bottom">
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
<li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
</ul>
</div>
</div>
</footer>
<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/js/main.js"></script>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink