lukechilds
/
bcoin-org.github.io
mirror of https://github.com/lukechilds/bcoin-org.github.io.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
233 Commits
16 Branches
0 Tags
19 MiB
 
 
 
 
Tree: e5d10b06a6
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'e5d10b06a6'
${ noResults }
bcoin-org.github.io/docs/module-wallet.Wallet.html

10598 lines
122 KiB
Raw Blame History

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Class: Wallet</title>
<script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<div id="main">
<h1 class="page-title">Class: Wallet</h1>
<section>
<header>
<h2>
<span class="ancestors"><a href="module-wallet.html">wallet</a>.</span>Wallet</h2>
</header>
<article>
<div class="container-overview">
<h4 class="name" id="Wallet"><span class="type-signature"></span>new Wallet<span class="signature">(options)</span><span class="type-signature"></span></h4>
<div class="description">
<p>BIP44 Wallet</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>options</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last">
<h6>Properties</h6>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>db</code></td>
<td class="type">
<span class="param-type"><a href="WalletDB.html">WalletDB</a></span>
</td>
<td class="attributes">
</td>
<td class="description last"><p>present, no coins will be available.</p></td>
</tr>
<tr>
<td class="name"><code>master</code></td>
<td class="type">
<span class="param-type">HDPrivateKey</span>
|
<span class="param-type">HDPublicKey</span>
</td>
<td class="attributes">
&lt;nullable><br>
</td>
<td class="description last"><p>Master HD key. If not
present, it will be generated.</p></td>
</tr>
<tr>
<td class="name"><code>witness</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="attributes">
&lt;nullable><br>
</td>
<td class="description last"><p>Whether to use witness programs.</p></td>
</tr>
<tr>
<td class="name"><code>accountIndex</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="attributes">
&lt;nullable><br>
</td>
<td class="description last"><p>The BIP44 account index (default=0).</p></td>
</tr>
<tr>
<td class="name"><code>receiveDepth</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="attributes">
&lt;nullable><br>
</td>
<td class="description last"><p>The index of the <em>next</em> receiving
address.</p></td>
</tr>
<tr>
<td class="name"><code>changeDepth</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="attributes">
&lt;nullable><br>
</td>
<td class="description last"><p>The index of the <em>next</em> change
address.</p></td>
</tr>
<tr>
<td class="name"><code>type</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="attributes">
&lt;nullable><br>
</td>
<td class="description last"><p>Type of wallet (pubkeyhash, multisig)
(default=pubkeyhash).</p></td>
</tr>
<tr>
<td class="name"><code>compressed</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="attributes">
&lt;nullable><br>
</td>
<td class="description last"><p>Whether to use compressed
public keys (default=true).</p></td>
</tr>
<tr>
<td class="name"><code>m</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="attributes">
&lt;nullable><br>
</td>
<td class="description last"><p><code>m</code> value for multisig.</p></td>
</tr>
<tr>
<td class="name"><code>n</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="attributes">
&lt;nullable><br>
</td>
<td class="description last"><p><code>n</code> value for multisig.</p></td>
</tr>
<tr>
<td class="name"><code>id</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="attributes">
&lt;nullable><br>
</td>
<td class="description last"><p>Wallet ID (used for storage)
(default=account key &quot;address&quot;).</p></td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="wallet_wallet.js.html">wallet/wallet.js</a>, <a href="wallet_wallet.js.html#line60">line 60</a>
</li></ul></dd>
</dl>
</div>
<h3 class="subsection-title">Members</h3>
<h4 class="name" id="_add"><span class="type-signature">(private) </span>_add<span class="type-signature"></span></h4>
<div class="description">
<p>Add a transaction to the wallet without a lock.
Potentially resolves orphans.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="wallet_wallet.js.html">wallet/wallet.js</a>, <a href="wallet_wallet.js.html#line2210">line 2210</a>
</li></ul></dd>
</dl>
<h4 class="name" id="_addSharedKey"><span class="type-signature">(private) </span>_addSharedKey<span class="type-signature"></span></h4>
<div class="description">
<p>Add a public account key to the wallet without a lock.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="wallet_wallet.js.html">wallet/wallet.js</a>, <a href="wallet_wallet.js.html#line279">line 279</a>
</li></ul></dd>
</dl>
<h4 class="name" id="_createAccount"><span class="type-signature"></span>_createAccount<span class="type-signature"></span></h4>
<div class="description">
<p>Create an account without a lock.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="wallet_wallet.js.html">wallet/wallet.js</a>, <a href="wallet_wallet.js.html#line682">line 682</a>
</li></ul></dd>
</dl>
<h4 class="name" id="_createKey"><span class="type-signature">(private) </span>_createKey<span class="type-signature"></span></h4>
<div class="description">
<p>Create a new address (increments depth) without a lock.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="wallet_wallet.js.html">wallet/wallet.js</a>, <a href="wallet_wallet.js.html#line980">line 980</a>
</li></ul></dd>
</dl>
<h4 class="name" id="_decrypt"><span class="type-signature">(private) </span>_decrypt<span class="type-signature"></span></h4>
<div class="description">
<p>Decrypt the wallet permanently, without a lock.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="wallet_wallet.js.html">wallet/wallet.js</a>, <a href="wallet_wallet.js.html#line447">line 447</a>
</li></ul></dd>
</dl>
<h4 class="name" id="_encrypt"><span class="type-signature">(private) </span>_encrypt<span class="type-signature"></span></h4>
<div class="description">
<p>Encrypt the wallet permanently, without a lock.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="wallet_wallet.js.html">wallet/wallet.js</a>, <a href="wallet_wallet.js.html#line405">line 405</a>
</li></ul></dd>
</dl>
<h4 class="name" id="_fund"><span class="type-signature">(private) </span>_fund<span class="type-signature"></span></h4>
<div class="description">
<p>Fill a transaction with inputs without a lock.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="wallet_wallet.js.html">wallet/wallet.js</a>, <a href="wallet_wallet.js.html#line1401">line 1401</a>
</li></ul></dd>
<dt class="tag-see">See:</dt>
<dd class="tag-see">
<ul>
<li>MTX#selectCoins</li>
<li>MTX#fill</li>
</ul>
</dd>
</dl>
<h4 class="name" id="_getAccount"><span class="type-signature"></span>_getAccount<span class="type-signature"></span></h4>
<div class="description">
<p>Retrieve an account from the database without a lock.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="wallet_wallet.js.html">wallet/wallet.js</a>, <a href="wallet_wallet.js.html#line833">line 833</a>
</li></ul></dd>
</dl>
<h4 class="name" id="_importAddress"><span class="type-signature">(private) </span>_importAddress<span class="type-signature"></span></h4>
<div class="description">
<p>Import a keyring (will not exist on derivation chain) without a lock.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="wallet_wallet.js.html">wallet/wallet.js</a>, <a href="wallet_wallet.js.html#line1317">line 1317</a>
</li></ul></dd>
</dl>
<h4 class="name" id="_importKey"><span class="type-signature">(private) </span>_importKey<span class="type-signature"></span></h4>
<div class="description">
<p>Import a keyring (will not exist on derivation chain) without a lock.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="wallet_wallet.js.html">wallet/wallet.js</a>, <a href="wallet_wallet.js.html#line1231">line 1231</a>
</li></ul></dd>
</dl>
<h4 class="name" id="_removeSharedKey"><span class="type-signature">(private) </span>_removeSharedKey<span class="type-signature"></span></h4>
<div class="description">
<p>Remove a public account key from the wallet (multisig).</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="wallet_wallet.js.html">wallet/wallet.js</a>, <a href="wallet_wallet.js.html#line333">line 333</a>
</li></ul></dd>
</dl>
<h4 class="name" id="_renameAccount"><span class="type-signature">(private) </span>_renameAccount<span class="type-signature"></span></h4>
<div class="description">
<p>Rename account without a lock.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="wallet_wallet.js.html">wallet/wallet.js</a>, <a href="wallet_wallet.js.html#line542">line 542</a>
</li></ul></dd>
</dl>
<h4 class="name" id="_retoken"><span class="type-signature">(private) </span>_retoken<span class="type-signature"></span></h4>
<div class="description">
<p>Generate a new token without a lock.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="wallet_wallet.js.html">wallet/wallet.js</a>, <a href="wallet_wallet.js.html#line489">line 489</a>
</li></ul></dd>
</dl>
<h4 class="name" id="_send"><span class="type-signature">(private) </span>_send<span class="type-signature"></span></h4>
<div class="description">
<p>Build and send a transaction without a lock.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="wallet_wallet.js.html">wallet/wallet.js</a>, <a href="wallet_wallet.js.html#line1630">line 1630</a>
</li></ul></dd>
</dl>
<h4 class="name" id="_setLookahead"><span class="type-signature">(private) </span>_setLookahead<span class="type-signature"></span></h4>
<div class="description">
<p>Increase lookahead for account (without a lock).</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="wallet_wallet.js.html">wallet/wallet.js</a>, <a href="wallet_wallet.js.html#line1947">line 1947</a>
</li></ul></dd>
</dl>
<h4 class="name" id="_zap"><span class="type-signature">(private) </span>_zap<span class="type-signature"></span></h4>
<div class="description">
<p>Zap stale TXs from wallet without a lock.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="wallet_wallet.js.html">wallet/wallet.js</a>, <a href="wallet_wallet.js.html#line2287">line 2287</a>
</li></ul></dd>
</dl>
<h4 class="name" id="abandon"><span class="type-signature"></span>abandon<span class="type-signature"></span></h4>
<div class="description">
<p>Abandon transaction.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="wallet_wallet.js.html">wallet/wallet.js</a>, <a href="wallet_wallet.js.html#line2298">line 2298</a>
</li></ul></dd>
</dl>
<h4 class="name" id="add"><span class="type-signature"></span>add<span class="type-signature"></span></h4>
<div class="description">
<p>Add a transaction to the wallets TX history.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="wallet_wallet.js.html">wallet/wallet.js</a>, <a href="wallet_wallet.js.html#line2193">line 2193</a>
</li></ul></dd>
</dl>
<h4 class="name" id="addSharedKey"><span class="type-signature"></span>addSharedKey<span class="type-signature"></span></h4>
<div class="description">
<p>Add a public account key to the wallet (multisig).
Saves the key in the wallet database.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="wallet_wallet.js.html">wallet/wallet.js</a>, <a href="wallet_wallet.js.html#line262">line 262</a>
</li></ul></dd>
</dl>
<h4 class="name" id="createAccount"><span class="type-signature"></span>createAccount<span class="type-signature"></span></h4>
<div class="description">
<p>Create an account. Requires passphrase if master key is encrypted.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="wallet_wallet.js.html">wallet/wallet.js</a>, <a href="wallet_wallet.js.html#line667">line 667</a>
</li></ul></dd>
</dl>
<h4 class="name" id="createKey"><span class="type-signature"></span>createKey<span class="type-signature"></span></h4>
<div class="description">
<p>Create a new address (increments depth).</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="wallet_wallet.js.html">wallet/wallet.js</a>, <a href="wallet_wallet.js.html#line963">line 963</a>
</li></ul></dd>
</dl>
<h4 class="name" id="createTX"><span class="type-signature"></span>createTX<span class="type-signature"></span></h4>
<div class="description">
<p>Build a transaction, fill it with outputs and inputs,
sort the members according to BIP69 (set options.sort=false
to avoid sorting), set locktime, and template it.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="wallet_wallet.js.html">wallet/wallet.js</a>, <a href="wallet_wallet.js.html#line1553">line 1553</a>
</li></ul></dd>
</dl>
<h4 class="name" id="decrypt"><span class="type-signature"></span>decrypt<span class="type-signature"></span></h4>
<div class="description">
<p>Decrypt the wallet permanently.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="wallet_wallet.js.html">wallet/wallet.js</a>, <a href="wallet_wallet.js.html#line431">line 431</a>
</li></ul></dd>
</dl>
<h4 class="name" id="deriveInputs"><span class="type-signature"></span>deriveInputs<span class="type-signature"></span></h4>
<div class="description">
<p>Derive necessary addresses for signing a transaction.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="wallet_wallet.js.html">wallet/wallet.js</a>, <a href="wallet_wallet.js.html#line1790">line 1790</a>
</li></ul></dd>
</dl>
<h4 class="name" id="destroy"><span class="type-signature"></span>destroy<span class="type-signature"></span></h4>
<div class="description">
<p>Close the wallet, unregister with the database.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="wallet_wallet.js.html">wallet/wallet.js</a>, <a href="wallet_wallet.js.html#line239">line 239</a>
</li></ul></dd>
</dl>
<h4 class="name" id="encrypt"><span class="type-signature"></span>encrypt<span class="type-signature"></span></h4>
<div class="description">
<p>Encrypt the wallet permanently.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="wallet_wallet.js.html">wallet/wallet.js</a>, <a href="wallet_wallet.js.html#line389">line 389</a>
</li></ul></dd>
</dl>
<h4 class="name" id="ensureAccount"><span class="type-signature"></span>ensureAccount<span class="type-signature"></span></h4>
<div class="description">
<p>Ensure an account. Requires passphrase if master key is encrypted.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="wallet_wallet.js.html">wallet/wallet.js</a>, <a href="wallet_wallet.js.html#line757">line 757</a>
</li></ul></dd>
</dl>
<h4 class="name" id="ensureIndex"><span class="type-signature">(private) </span>ensureIndex<span class="type-signature"></span></h4>
<div class="description">
<p>Resolve account index.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="wallet_wallet.js.html">wallet/wallet.js</a>, <a href="wallet_wallet.js.html#line2437">line 2437</a>
</li></ul></dd>
</dl>
<h4 class="name" id="estimateSize"><span class="type-signature"></span>estimateSize<span class="type-signature"></span></h4>
<div class="description">
<p>Input size estimator for max possible tx size.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="wallet_wallet.js.html">wallet/wallet.js</a>, <a href="wallet_wallet.js.html#line1477">line 1477</a>
</li></ul></dd>
</dl>
<h4 class="name" id="fund"><span class="type-signature"></span>fund<span class="type-signature"></span></h4>
<div class="description">
<p>Fill a transaction with inputs, estimate
transaction size, calculate fee, and add a change output.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="wallet_wallet.js.html">wallet/wallet.js</a>, <a href="wallet_wallet.js.html#line1385">line 1385</a>
</li></ul></dd>
<dt class="tag-see">See:</dt>
<dd class="tag-see">
<ul>
<li>MTX#selectCoins</li>
<li>MTX#fill</li>
</ul>
</dd>
</dl>
<h4 class="name" id="getAccount"><span class="type-signature"></span>getAccount<span class="type-signature"></span></h4>
<div class="description">
<p>Retrieve an account from the database.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="wallet_wallet.js.html">wallet/wallet.js</a>, <a href="wallet_wallet.js.html#line805">line 805</a>
</li></ul></dd>
</dl>
<h4 class="name" id="getAccountByAddress"><span class="type-signature"></span>getAccountByAddress<span class="type-signature"></span></h4>
<div class="description">
<p>Get account by address.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="wallet_wallet.js.html">wallet/wallet.js</a>, <a href="wallet_wallet.js.html#line1456">line 1456</a>
</li></ul></dd>
</dl>
<h4 class="name" id="getAccountHashes"><span class="type-signature"></span>getAccountHashes<span class="type-signature"></span></h4>
<div class="description">
<p>Get all account address hashes.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="wallet_wallet.js.html">wallet/wallet.js</a>, <a href="wallet_wallet.js.html#line794">line 794</a>
</li></ul></dd>
</dl>
<h4 class="name" id="getAccountIndex"><span class="type-signature"></span>getAccountIndex<span class="type-signature"></span></h4>
<div class="description">
<p>Lookup the corresponding account name's index.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="wallet_wallet.js.html">wallet/wallet.js</a>, <a href="wallet_wallet.js.html#line863">line 863</a>
</li></ul></dd>
</dl>
<h4 class="name" id="getAccountName"><span class="type-signature"></span>getAccountName<span class="type-signature"></span></h4>
<div class="description">
<p>Lookup the corresponding account index's name.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="wallet_wallet.js.html">wallet/wallet.js</a>, <a href="wallet_wallet.js.html#line894">line 894</a>
</li></ul></dd>
</dl>
<h4 class="name" id="getAccountPaths"><span class="type-signature"></span>getAccountPaths<span class="type-signature"></span></h4>
<div class="description">
<p>Get all account paths.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="wallet_wallet.js.html">wallet/wallet.js</a>, <a href="wallet_wallet.js.html#line1178">line 1178</a>
</li></ul></dd>
</dl>
<h4 class="name" id="getBalance"><span class="type-signature"></span>getBalance<span class="type-signature"></span></h4>
<div class="description">
<p>Get wallet balance.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="wallet_wallet.js.html">wallet/wallet.js</a>, <a href="wallet_wallet.js.html#line2393">line 2393</a>
</li></ul></dd>
</dl>
<h4 class="name" id="getCoins"><span class="type-signature"></span>getCoins<span class="type-signature"></span></h4>
<div class="description">
<p>Get all available coins.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="wallet_wallet.js.html">wallet/wallet.js</a>, <a href="wallet_wallet.js.html#line2371">line 2371</a>
</li></ul></dd>
</dl>
<h4 class="name" id="getHistory"><span class="type-signature"></span>getHistory<span class="type-signature"></span></h4>
<div class="description">
<p>Get all transactions in transaction history.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="wallet_wallet.js.html">wallet/wallet.js</a>, <a href="wallet_wallet.js.html#line2360">line 2360</a>
</li></ul></dd>
</dl>
<h4 class="name" id="getInputPaths"><span class="type-signature"></span>getInputPaths<span class="type-signature"></span></h4>
<div class="description">
<p>Map input addresses to paths.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="wallet_wallet.js.html">wallet/wallet.js</a>, <a href="wallet_wallet.js.html#line1881">line 1881</a>
</li></ul></dd>
</dl>
<h4 class="name" id="getKey"><span class="type-signature"></span>getKey<span class="type-signature"></span></h4>
<div class="description">
<p>Retrieve a single keyring by address.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="wallet_wallet.js.html">wallet/wallet.js</a>, <a href="wallet_wallet.js.html#line1820">line 1820</a>
</li></ul></dd>
</dl>
<h4 class="name" id="getLast"><span class="type-signature"></span>getLast<span class="type-signature"></span></h4>
<div class="description">
<p>Get the last N transactions.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="wallet_wallet.js.html">wallet/wallet.js</a>, <a href="wallet_wallet.js.html#line2424">line 2424</a>
</li></ul></dd>
</dl>
<h4 class="name" id="getOutputPaths"><span class="type-signature"></span>getOutputPaths<span class="type-signature"></span></h4>
<div class="description">
<p>Map output addresses to paths.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="wallet_wallet.js.html">wallet/wallet.js</a>, <a href="wallet_wallet.js.html#line1908">line 1908</a>
</li></ul></dd>
</dl>
<h4 class="name" id="getPath"><span class="type-signature"></span>getPath<span class="type-signature"></span></h4>
<div class="description">
<p>Get path by address hash.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="wallet_wallet.js.html">wallet/wallet.js</a>, <a href="wallet_wallet.js.html#line1080">line 1080</a>
</li></ul></dd>
</dl>
<h4 class="name" id="getPaths"><span class="type-signature"></span>getPaths<span class="type-signature"></span></h4>
<div class="description">
<p>Get all wallet paths.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="wallet_wallet.js.html">wallet/wallet.js</a>, <a href="wallet_wallet.js.html#line1148">line 1148</a>
</li></ul></dd>
</dl>
<h4 class="name" id="getPending"><span class="type-signature"></span>getPending<span class="type-signature"></span></h4>
<div class="description">
<p>Get all pending/unconfirmed transactions.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="wallet_wallet.js.html">wallet/wallet.js</a>, <a href="wallet_wallet.js.html#line2382">line 2382</a>
</li></ul></dd>
</dl>
<h4 class="name" id="getPrivateKey"><span class="type-signature"></span>getPrivateKey<span class="type-signature"></span></h4>
<div class="description">
<p>Retrieve a single keyring by address
(with the private key reference).</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="wallet_wallet.js.html">wallet/wallet.js</a>, <a href="wallet_wallet.js.html#line1848">line 1848</a>
</li></ul></dd>
</dl>
<h4 class="name" id="getRange"><span class="type-signature"></span>getRange<span class="type-signature"></span></h4>
<div class="description">
<p>Get a range of transactions between two timestamps.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="wallet_wallet.js.html">wallet/wallet.js</a>, <a href="wallet_wallet.js.html#line2407">line 2407</a>
</li></ul></dd>
</dl>
<h4 class="name" id="getRedeem"><span class="type-signature"></span>getRedeem<span class="type-signature"></span></h4>
<div class="description">
<p>Get a redeem script or witness script by hash.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="wallet_wallet.js.html">wallet/wallet.js</a>, <a href="wallet_wallet.js.html#line2057">line 2057</a>
</li></ul></dd>
</dl>
<h4 class="name" id="hasAccount"><span class="type-signature"></span>hasAccount<span class="type-signature"></span></h4>
<div class="description">
<p>Test whether an account exists.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="wallet_wallet.js.html">wallet/wallet.js</a>, <a href="wallet_wallet.js.html#line914">line 914</a>
</li></ul></dd>
</dl>
<h4 class="name" id="hasAddress"><span class="type-signature"></span>hasAddress<span class="type-signature"></span></h4>
<div class="description">
<p>Test whether the wallet possesses an address.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="wallet_wallet.js.html">wallet/wallet.js</a>, <a href="wallet_wallet.js.html#line1062">line 1062</a>
</li></ul></dd>
</dl>
<h4 class="name" id="hasPath"><span class="type-signature"></span>hasPath<span class="type-signature"></span></h4>
<div class="description">
<p>Test whether the wallet contains a path.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="wallet_wallet.js.html">wallet/wallet.js</a>, <a href="wallet_wallet.js.html#line1130">line 1130</a>
</li></ul></dd>
</dl>
<h4 class="name" id="importAddress"><span class="type-signature"></span>importAddress<span class="type-signature"></span></h4>
<div class="description">
<p>Import a keyring (will not exist on derivation chain).
Rescanning must be invoked manually.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="wallet_wallet.js.html">wallet/wallet.js</a>, <a href="wallet_wallet.js.html#line1299">line 1299</a>
</li></ul></dd>
</dl>
<h4 class="name" id="importKey"><span class="type-signature"></span>importKey<span class="type-signature"></span></h4>
<div class="description">
<p>Import a keyring (will not exist on derivation chain).
Rescanning must be invoked manually.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="wallet_wallet.js.html">wallet/wallet.js</a>, <a href="wallet_wallet.js.html#line1213">line 1213</a>
</li></ul></dd>
</dl>
<h4 class="name" id="increaseFee"><span class="type-signature"></span>increaseFee<span class="type-signature"></span></h4>
<div class="description">
<p>Intentionally double-spend outputs by
increasing fee for an existing transaction.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="wallet_wallet.js.html">wallet/wallet.js</a>, <a href="wallet_wallet.js.html#line1666">line 1666</a>
</li></ul></dd>
</dl>
<h4 class="name" id="init"><span class="type-signature"></span>init<span class="type-signature"></span></h4>
<div class="description">
<p>Attempt to intialize the wallet (generating
the first addresses along with the lookahead
addresses). Called automatically from the
walletdb.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="wallet_wallet.js.html">wallet/wallet.js</a>, <a href="wallet_wallet.js.html#line192">line 192</a>
</li></ul></dd>
</dl>
<h4 class="name" id="lock"><span class="type-signature"></span>lock<span class="type-signature"></span></h4>
<div class="description">
<p>Lock the wallet, destroy decrypted key.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="wallet_wallet.js.html">wallet/wallet.js</a>, <a href="wallet_wallet.js.html#line585">line 585</a>
</li></ul></dd>
</dl>
<h4 class="name" id="open"><span class="type-signature"></span>open<span class="type-signature"></span></h4>
<div class="description">
<p>Open wallet (done after retrieval).</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="wallet_wallet.js.html">wallet/wallet.js</a>, <a href="wallet_wallet.js.html#line217">line 217</a>
</li></ul></dd>
</dl>
<h4 class="name" id="readPath"><span class="type-signature">(private) </span>readPath<span class="type-signature"></span></h4>
<div class="description">
<p>Get path by address hash (without account name).</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="wallet_wallet.js.html">wallet/wallet.js</a>, <a href="wallet_wallet.js.html#line1102">line 1102</a>
</li></ul></dd>
</dl>
<h4 class="name" id="remove"><span class="type-signature"></span>remove<span class="type-signature"></span></h4>
<div class="description">
<p>Remove a wallet transaction.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="wallet_wallet.js.html">wallet/wallet.js</a>, <a href="wallet_wallet.js.html#line2254">line 2254</a>
</li></ul></dd>
</dl>
<h4 class="name" id="removeSharedKey"><span class="type-signature"></span>removeSharedKey<span class="type-signature"></span></h4>
<div class="description">
<p>Remove a public account key from the wallet (multisig).</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="wallet_wallet.js.html">wallet/wallet.js</a>, <a href="wallet_wallet.js.html#line316">line 316</a>
</li></ul></dd>
</dl>
<h4 class="name" id="rename"><span class="type-signature"></span>rename<span class="type-signature"></span></h4>
<div class="description">
<p>Rename the wallet.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="wallet_wallet.js.html">wallet/wallet.js</a>, <a href="wallet_wallet.js.html#line509">line 509</a>
</li></ul></dd>
</dl>
<h4 class="name" id="renameAccount"><span class="type-signature"></span>renameAccount<span class="type-signature"></span></h4>
<div class="description">
<p>Rename account.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="wallet_wallet.js.html">wallet/wallet.js</a>, <a href="wallet_wallet.js.html#line525">line 525</a>
</li></ul></dd>
</dl>
<h4 class="name" id="resend"><span class="type-signature"></span>resend<span class="type-signature"></span></h4>
<div class="description">
<p>Resend pending wallet transactions.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="wallet_wallet.js.html">wallet/wallet.js</a>, <a href="wallet_wallet.js.html#line1762">line 1762</a>
</li></ul></dd>
</dl>
<h4 class="name" id="retoken"><span class="type-signature"></span>retoken<span class="type-signature"></span></h4>
<div class="description">
<p>Generate a new token.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="wallet_wallet.js.html">wallet/wallet.js</a>, <a href="wallet_wallet.js.html#line473">line 473</a>
</li></ul></dd>
</dl>
<h4 class="name" id="send"><span class="type-signature"></span>send<span class="type-signature"></span></h4>
<div class="description">
<p>Build a transaction, fill it with outputs and inputs,
sort the members according to BIP69, set locktime,
sign and broadcast. Doing this all in one go prevents
coins from being double spent.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="wallet_wallet.js.html">wallet/wallet.js</a>, <a href="wallet_wallet.js.html#line1613">line 1613</a>
</li></ul></dd>
</dl>
<h4 class="name" id="setLookahead"><span class="type-signature"></span>setLookahead<span class="type-signature"></span></h4>
<div class="description">
<p>Increase lookahead for account.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="wallet_wallet.js.html">wallet/wallet.js</a>, <a href="wallet_wallet.js.html#line1930">line 1930</a>
</li></ul></dd>
</dl>
<h4 class="name" id="setPassphrase"><span class="type-signature"></span>setPassphrase<span class="type-signature"></span></h4>
<div class="description">
<p>Change or set master key's passphrase.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="wallet_wallet.js.html">wallet/wallet.js</a>, <a href="wallet_wallet.js.html#line370">line 370</a>
</li></ul></dd>
</dl>
<h4 class="name" id="sign"><span class="type-signature"></span>sign<span class="type-signature"></span></h4>
<div class="description">
<p>Build input scripts and sign inputs for a transaction. Only attempts
to build/sign inputs that are redeemable by this wallet.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="wallet_wallet.js.html">wallet/wallet.js</a>, <a href="wallet_wallet.js.html#line2094">line 2094</a>
</li></ul></dd>
</dl>
<h4 class="name" id="syncOutputDepth"><span class="type-signature"></span>syncOutputDepth<span class="type-signature"></span></h4>
<div class="description">
<p>Sync address depths based on a transaction's outputs.
This is used for deriving new addresses when
a confirmed transaction is seen.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="wallet_wallet.js.html">wallet/wallet.js</a>, <a href="wallet_wallet.js.html#line1983">line 1983</a>
</li></ul></dd>
</dl>
<h4 class="name" id="template"><span class="type-signature"></span>template<span class="type-signature"></span></h4>
<div class="description">
<p>Build input scripts templates for a transaction (does not
sign, only creates signature slots). Only builds scripts
for inputs that are redeemable by this wallet.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="wallet_wallet.js.html">wallet/wallet.js</a>, <a href="wallet_wallet.js.html#line2080">line 2080</a>
</li></ul></dd>
</dl>
<h4 class="name" id="unconfirm"><span class="type-signature"></span>unconfirm<span class="type-signature"></span></h4>
<div class="description">
<p>Unconfirm a wallet transcation.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="wallet_wallet.js.html">wallet/wallet.js</a>, <a href="wallet_wallet.js.html#line2239">line 2239</a>
</li></ul></dd>
</dl>
<h4 class="name" id="zap"><span class="type-signature"></span>zap<span class="type-signature"></span></h4>
<div class="description">
<p>Zap stale TXs from wallet.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="wallet_wallet.js.html">wallet/wallet.js</a>, <a href="wallet_wallet.js.html#line2270">line 2270</a>
</li></ul></dd>
</dl>
<h3 class="subsection-title">Methods</h3>
<h4 class="name" id=".fromOptions"><span class="type-signature">(static) </span>fromOptions<span class="signature">(db, options)</span><span class="type-signature"> &rarr; {Wallet}</span></h4>
<div class="description">
<p>Instantiate wallet from options.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>db</code></td>
<td class="type">
<span class="param-type"><a href="WalletDB.html">WalletDB</a></span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>options</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="wallet_wallet.js.html">wallet/wallet.js</a>, <a href="wallet_wallet.js.html#line180">line 180</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Wallet</span>
</dd>
</dl>
<h4 class="name" id=".fromRaw"><span class="type-signature">(static) </span>fromRaw<span class="signature">(data)</span><span class="type-signature"> &rarr; {Wallet}</span></h4>
<div class="description">
<p>Instantiate a wallet from serialized data.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>data</code></td>
<td class="type">
<span class="param-type">Buffer</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="wallet_wallet.js.html">wallet/wallet.js</a>, <a href="wallet_wallet.js.html#line2603">line 2603</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Wallet</span>
</dd>
</dl>
<h4 class="name" id=".isWallet"><span class="type-signature">(static) </span>isWallet<span class="signature">(obj)</span><span class="type-signature"> &rarr; {Boolean}</span></h4>
<div class="description">
<p>Test an object to see if it is a Wallet.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>obj</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="wallet_wallet.js.html">wallet/wallet.js</a>, <a href="wallet_wallet.js.html#line2613">line 2613</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Boolean</span>
</dd>
</dl>
<h4 class="name" id="_abandon"><span class="type-signature">(private) </span>_abandon<span class="signature">(hash)</span><span class="type-signature"> &rarr; {Promise}</span></h4>
<div class="description">
<p>Abandon transaction without a lock.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>hash</code></td>
<td class="type">
<span class="param-type"><a href="global.html#Hash">Hash</a></span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="wallet_wallet.js.html">wallet/wallet.js</a>, <a href="wallet_wallet.js.html#line2314">line 2314</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise</span>
</dd>
</dl>
<h4 class="name" id="clear"><span class="type-signature">(private) </span>clear<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
<p>Clear batch.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="wallet_wallet.js.html">wallet/wallet.js</a>, <a href="wallet_wallet.js.html#line1043">line 1043</a>
</li></ul></dd>
</dl>
<h4 class="name" id="commit"><span class="type-signature"></span>commit<span class="signature">()</span><span class="type-signature"> &rarr; {Promise}</span></h4>
<div class="description">
<p>Save batch.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="wallet_wallet.js.html">wallet/wallet.js</a>, <a href="wallet_wallet.js.html#line1052">line 1052</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise</span>
</dd>
</dl>
<h4 class="name" id="createChange"><span class="type-signature"></span>createChange<span class="signature">(acct<span class="signature-attributes">nullable</span>)</span><span class="type-signature"> &rarr; {Promise}</span></h4>
<div class="description">
<p>Create a new change address (increments receiveDepth).</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>acct</code></td>
<td class="type">
<span class="param-type">Number</span>
|
<span class="param-type">String</span>
</td>
<td class="attributes">
&lt;nullable><br>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="wallet_wallet.js.html">wallet/wallet.js</a>, <a href="wallet_wallet.js.html#line942">line 942</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<ul>
<li>Returns WalletKey.</li>
</ul>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise</span>
</dd>
</dl>
<h4 class="name" id="createNested"><span class="type-signature"></span>createNested<span class="signature">(acct<span class="signature-attributes">nullable</span>)</span><span class="type-signature"> &rarr; {Promise}</span></h4>
<div class="description">
<p>Create a new nested address (increments receiveDepth).</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>acct</code></td>
<td class="type">
<span class="param-type">Number</span>
|
<span class="param-type">String</span>
</td>
<td class="attributes">
&lt;nullable><br>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="wallet_wallet.js.html">wallet/wallet.js</a>, <a href="wallet_wallet.js.html#line952">line 952</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<ul>
<li>Returns WalletKey.</li>
</ul>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise</span>
</dd>
</dl>
<h4 class="name" id="createReceive"><span class="type-signature"></span>createReceive<span class="signature">(acct<span class="signature-attributes">nullable</span>)</span><span class="type-signature"> &rarr; {Promise}</span></h4>
<div class="description">
<p>Create a new receiving address (increments receiveDepth).</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>acct</code></td>
<td class="type">
<span class="param-type">Number</span>
|
<span class="param-type">String</span>
</td>
<td class="attributes">
&lt;nullable><br>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="wallet_wallet.js.html">wallet/wallet.js</a>, <a href="wallet_wallet.js.html#line932">line 932</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<ul>
<li>Returns WalletKey.</li>
</ul>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise</span>
</dd>
</dl>
<h4 class="name" id="drop"><span class="type-signature">(private) </span>drop<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
<p>Drop batch.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="wallet_wallet.js.html">wallet/wallet.js</a>, <a href="wallet_wallet.js.html#line1034">line 1034</a>
</li></ul></dd>
</dl>
<h4 class="name" id="fromOptions"><span class="type-signature">(private) </span>fromOptions<span class="signature">(options)</span><span class="type-signature"></span></h4>
<div class="description">
<p>Inject properties from options object.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>options</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="wallet_wallet.js.html">wallet/wallet.js</a>, <a href="wallet_wallet.js.html#line103">line 103</a>
</li></ul></dd>
</dl>
<h4 class="name" id="fromRaw"><span class="type-signature">(private) </span>fromRaw<span class="signature">(data)</span><span class="type-signature"></span></h4>
<div class="description">
<p>Inject properties from serialized data.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>data</code></td>
<td class="type">
<span class="param-type">Buffer</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="wallet_wallet.js.html">wallet/wallet.js</a>, <a href="wallet_wallet.js.html#line2579">line 2579</a>
</li></ul></dd>
</dl>
<h4 class="name" id="getAccounts"><span class="type-signature"></span>getAccounts<span class="signature">()</span><span class="type-signature"> &rarr; {Promise}</span></h4>
<div class="description">
<p>List account names and indexes from the db.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="wallet_wallet.js.html">wallet/wallet.js</a>, <a href="wallet_wallet.js.html#line772">line 772</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<ul>
<li>Returns Array.</li>
</ul>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise</span>
</dd>
</dl>
<h4 class="name" id="getAddress"><span class="type-signature"></span>getAddress<span class="signature">(enc<span class="signature-attributes">nullable</span>)</span><span class="type-signature"> &rarr; {Address|<a href="global.html#Base58Address">Base58Address</a>}</span></h4>
<div class="description">
<p>Get current receive address.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>enc</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="attributes">
&lt;nullable><br>
</td>
<td class="description last"><p><code>&quot;base58&quot;</code> or <code>null</code>.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="wallet_wallet.js.html">wallet/wallet.js</a>, <a href="wallet_wallet.js.html#line2460">line 2460</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Address</span>
|
<span class="param-type"><a href="global.html#Base58Address">Base58Address</a></span>
</dd>
</dl>
<h4 class="name" id="getAddressHashes"><span class="type-signature"></span>getAddressHashes<span class="signature">(acct<span class="signature-attributes">nullable</span>)</span><span class="type-signature"> &rarr; {Promise}</span></h4>
<div class="description">
<p>Get all wallet address hashes.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>acct</code></td>
<td class="type">
<span class="param-type">String</span>
|
<span class="param-type">Number</span>
</td>
<td class="attributes">
&lt;nullable><br>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="wallet_wallet.js.html">wallet/wallet.js</a>, <a href="wallet_wallet.js.html#line782">line 782</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<ul>
<li>Returns Array.</li>
</ul>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise</span>
</dd>
</dl>
<h4 class="name" id="getBlock"><span class="type-signature"></span>getBlock<span class="signature">(height)</span><span class="type-signature"> &rarr; {Promise}</span></h4>
<div class="description">
<p>Get a block from the wallet.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>height</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="wallet_wallet.js.html">wallet/wallet.js</a>, <a href="wallet_wallet.js.html#line2183">line 2183</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<ul>
<li>Returns BlockRecord.</li>
</ul>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise</span>
</dd>
</dl>
<h4 class="name" id="getBlocks"><span class="type-signature"></span>getBlocks<span class="signature">()</span><span class="type-signature"> &rarr; {Promise}</span></h4>
<div class="description">
<p>List blocks for the wallet.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="wallet_wallet.js.html">wallet/wallet.js</a>, <a href="wallet_wallet.js.html#line2173">line 2173</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<ul>
<li>Returns BlockRecord.</li>
</ul>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise</span>
</dd>
</dl>
<h4 class="name" id="getChange"><span class="type-signature"></span>getChange<span class="signature">(enc<span class="signature-attributes">nullable</span>)</span><span class="type-signature"> &rarr; {Address|<a href="global.html#Base58Address">Base58Address</a>}</span></h4>
<div class="description">
<p>Get current change address.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>enc</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="attributes">
&lt;nullable><br>
</td>
<td class="description last"><p><code>&quot;base58&quot;</code> or <code>null</code>.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="wallet_wallet.js.html">wallet/wallet.js</a>, <a href="wallet_wallet.js.html#line2480">line 2480</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Address</span>
|
<span class="param-type"><a href="global.html#Base58Address">Base58Address</a></span>
</dd>
</dl>
<h4 class="name" id="getCoin"><span class="type-signature"></span>getCoin<span class="signature">(hash, index)</span><span class="type-signature"> &rarr; {Promise}</span></h4>
<div class="description">
<p>Get a coin from the wallet.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>hash</code></td>
<td class="type">
<span class="param-type"><a href="global.html#Hash">Hash</a></span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>index</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="wallet_wallet.js.html">wallet/wallet.js</a>, <a href="wallet_wallet.js.html#line2154">line 2154</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<ul>
<li>Returns Coin.</li>
</ul>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise</span>
</dd>
</dl>
<h4 class="name" id="getCoinView"><span class="type-signature"></span>getCoinView<span class="signature">(tx)</span><span class="type-signature"> &rarr; {Promise}</span></h4>
<div class="description">
<p>Get a coin viewpoint.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>tx</code></td>
<td class="type">
<span class="param-type">TX</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="wallet_wallet.js.html">wallet/wallet.js</a>, <a href="wallet_wallet.js.html#line2113">line 2113</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<ul>
<li>Returns CoinView.</li>
</ul>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise</span>
</dd>
</dl>
<h4 class="name" id="getDetails"><span class="type-signature"></span>getDetails<span class="signature">(hash)</span><span class="type-signature"> &rarr; {Promise}</span></h4>
<div class="description">
<p>Get transaction details.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>hash</code></td>
<td class="type">
<span class="param-type"><a href="global.html#Hash">Hash</a></span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="wallet_wallet.js.html">wallet/wallet.js</a>, <a href="wallet_wallet.js.html#line2143">line 2143</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<ul>
<li>Returns Details.</li>
</ul>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise</span>
</dd>
</dl>
<h4 class="name" id="getID"><span class="type-signature">(private) </span>getID<span class="signature">()</span><span class="type-signature"> &rarr; {<a href="global.html#Base58String">Base58String</a>}</span></h4>
<div class="description">
<p>Generate the wallet ID if none was passed in.
It is represented as HASH160(m/44-&gt;public|magic)
converted to an &quot;address&quot; with a prefix
of <code>0x03be04</code> (<code>WLT</code> in base58).</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="wallet_wallet.js.html">wallet/wallet.js</a>, <a href="wallet_wallet.js.html#line615">line 615</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="global.html#Base58String">Base58String</a></span>
</dd>
</dl>
<h4 class="name" id="getLocked"><span class="type-signature"></span>getLocked<span class="signature">()</span><span class="type-signature"> &rarr; {Array:<a href="global.html"></a>.&lt;Outpoint:<a href="global.html"></a>>}</span></h4>
<div class="description">
<p>Return an array of all locked outpoints.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="wallet_wallet.js.html">wallet/wallet.js</a>, <a href="wallet_wallet.js.html#line2350">line 2350</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Array:<a href="global.html"></a>.&lt;Outpoint:<a href="global.html"></a>></span>
</dd>
</dl>
<h4 class="name" id="getNested"><span class="type-signature"></span>getNested<span class="signature">(enc<span class="signature-attributes">nullable</span>)</span><span class="type-signature"> &rarr; {Address|<a href="global.html#Base58Address">Base58Address</a>}</span></h4>
<div class="description">
<p>Get current nested address.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>enc</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="attributes">
&lt;nullable><br>
</td>
<td class="description last"><p><code>&quot;base58&quot;</code> or <code>null</code>.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="wallet_wallet.js.html">wallet/wallet.js</a>, <a href="wallet_wallet.js.html#line2490">line 2490</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Address</span>
|
<span class="param-type"><a href="global.html#Base58Address">Base58Address</a></span>
</dd>
</dl>
<h4 class="name" id="getReceive"><span class="type-signature"></span>getReceive<span class="signature">(enc<span class="signature-attributes">nullable</span>)</span><span class="type-signature"> &rarr; {Address|<a href="global.html#Base58Address">Base58Address</a>}</span></h4>
<div class="description">
<p>Get current receive address.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>enc</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="attributes">
&lt;nullable><br>
</td>
<td class="description last"><p><code>&quot;base58&quot;</code> or <code>null</code>.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="wallet_wallet.js.html">wallet/wallet.js</a>, <a href="wallet_wallet.js.html#line2470">line 2470</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Address</span>
|
<span class="param-type"><a href="global.html#Base58Address">Base58Address</a></span>
</dd>
</dl>
<h4 class="name" id="getSize"><span class="type-signature"></span>getSize<span class="signature">()</span><span class="type-signature"> &rarr; {Number}</span></h4>
<div class="description">
<p>Calculate serialization size.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="wallet_wallet.js.html">wallet/wallet.js</a>, <a href="wallet_wallet.js.html#line2543">line 2543</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Number</span>
</dd>
</dl>
<h4 class="name" id="getSpentView"><span class="type-signature"></span>getSpentView<span class="signature">(tx)</span><span class="type-signature"> &rarr; {Promise}</span></h4>
<div class="description">
<p>Get a historical coin viewpoint.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>tx</code></td>
<td class="type">
<span class="param-type">TX</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="wallet_wallet.js.html">wallet/wallet.js</a>, <a href="wallet_wallet.js.html#line2123">line 2123</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<ul>
<li>Returns CoinView.</li>
</ul>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise</span>
</dd>
</dl>
<h4 class="name" id="getToken"><span class="type-signature">(private) </span>getToken<span class="signature">(master, nonce)</span><span class="type-signature"> &rarr; {Buffer}</span></h4>
<div class="description">
<p>Generate the wallet api key if none was passed in.
It is represented as HASH256(m/44'-&gt;private|nonce).</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>master</code></td>
<td class="type">
<span class="param-type">HDPrivateKey</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>nonce</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="wallet_wallet.js.html">wallet/wallet.js</a>, <a href="wallet_wallet.js.html#line647">line 647</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Buffer</span>
</dd>
</dl>
<h4 class="name" id="getTX"><span class="type-signature"></span>getTX<span class="signature">(hash)</span><span class="type-signature"> &rarr; {Promise}</span></h4>
<div class="description">
<p>Get a transaction from the wallet.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>hash</code></td>
<td class="type">
<span class="param-type"><a href="global.html#Hash">Hash</a></span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="wallet_wallet.js.html">wallet/wallet.js</a>, <a href="wallet_wallet.js.html#line2164">line 2164</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<ul>
<li>Returns TX.</li>
</ul>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise</span>
</dd>
</dl>
<h4 class="name" id="inspect"><span class="type-signature"></span>inspect<span class="signature">()</span><span class="type-signature"> &rarr; {Object}</span></h4>
<div class="description">
<p>Convert the wallet to a more inspection-friendly object.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="wallet_wallet.js.html">wallet/wallet.js</a>, <a href="wallet_wallet.js.html#line2499">line 2499</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Object</span>
</dd>
</dl>
<h4 class="name" id="isLocked"><span class="type-signature"></span>isLocked<span class="signature">(coin)</span><span class="type-signature"></span></h4>
<div class="description">
<p>Test locked status of a single coin.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>coin</code></td>
<td class="type">
<span class="param-type">Coin</span>
|
<span class="param-type">Outpoint</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="wallet_wallet.js.html">wallet/wallet.js</a>, <a href="wallet_wallet.js.html#line2341">line 2341</a>
</li></ul></dd>
</dl>
<h4 class="name" id="lockCoin"><span class="type-signature"></span>lockCoin<span class="signature">(coin)</span><span class="type-signature"></span></h4>
<div class="description">
<p>Lock a single coin.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>coin</code></td>
<td class="type">
<span class="param-type">Coin</span>
|
<span class="param-type">Outpoint</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="wallet_wallet.js.html">wallet/wallet.js</a>, <a href="wallet_wallet.js.html#line2323">line 2323</a>
</li></ul></dd>
</dl>
<h4 class="name" id="save"><span class="type-signature"></span>save<span class="signature">()</span><span class="type-signature"> &rarr; {Promise}</span></h4>
<div class="description">
<p>Save the wallet to the database. Necessary
when address depth and keys change.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="wallet_wallet.js.html">wallet/wallet.js</a>, <a href="wallet_wallet.js.html#line1016">line 1016</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise</span>
</dd>
</dl>
<h4 class="name" id="start"><span class="type-signature">(private) </span>start<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
<p>Start batch.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="wallet_wallet.js.html">wallet/wallet.js</a>, <a href="wallet_wallet.js.html#line1025">line 1025</a>
</li></ul></dd>
</dl>
<h4 class="name" id="toDetails"><span class="type-signature"></span>toDetails<span class="signature">(wtx)</span><span class="type-signature"> &rarr; {Promise}</span></h4>
<div class="description">
<p>Convert transaction to transaction details.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>wtx</code></td>
<td class="type">
<span class="param-type">TXRecord</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="wallet_wallet.js.html">wallet/wallet.js</a>, <a href="wallet_wallet.js.html#line2133">line 2133</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<ul>
<li>Returns Details.</li>
</ul>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise</span>
</dd>
</dl>
<h4 class="name" id="toJSON"><span class="type-signature"></span>toJSON<span class="signature">(unsafe<span class="signature-attributes">nullable</span>)</span><span class="type-signature"> &rarr; {Object}</span></h4>
<div class="description">
<p>Convert the wallet to an object suitable for
serialization.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>unsafe</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="attributes">
&lt;nullable><br>
</td>
<td class="description last"><p>Whether to include
the master key in the JSON.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="wallet_wallet.js.html">wallet/wallet.js</a>, <a href="wallet_wallet.js.html#line2522">line 2522</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Object</span>
</dd>
</dl>
<h4 class="name" id="toRaw"><span class="type-signature"></span>toRaw<span class="signature">()</span><span class="type-signature"> &rarr; {Buffer}</span></h4>
<div class="description">
<p>Serialize the wallet.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="wallet_wallet.js.html">wallet/wallet.js</a>, <a href="wallet_wallet.js.html#line2556">line 2556</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Buffer</span>
</dd>
</dl>
<h4 class="name" id="unlock"><span class="type-signature"></span>unlock<span class="signature">(passphrase, timeout<span class="signature-attributes">opt, nullable</span>)</span><span class="type-signature"></span></h4>
<div class="description">
<p>Unlock the key for <code>timeout</code> seconds.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>passphrase</code></td>
<td class="type">
<span class="param-type">Buffer</span>
|
<span class="param-type">String</span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>timeout</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="attributes">
&lt;optional><br>
&lt;nullable><br>
</td>
<td class="default">
60
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="wallet_wallet.js.html">wallet/wallet.js</a>, <a href="wallet_wallet.js.html#line602">line 602</a>
</li></ul></dd>
</dl>
<h4 class="name" id="unlockCoin"><span class="type-signature"></span>unlockCoin<span class="signature">(coin)</span><span class="type-signature"></span></h4>
<div class="description">
<p>Unlock a single coin.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>coin</code></td>
<td class="type">
<span class="param-type">Coin</span>
|
<span class="param-type">Outpoint</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="wallet_wallet.js.html">wallet/wallet.js</a>, <a href="wallet_wallet.js.html#line2332">line 2332</a>
</li></ul></dd>
</dl>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-bcoin.html">bcoin</a></li><li><a href="module-bip70.html">bip70</a></li><li><a href="module-bip70_pk.html">bip70/pk</a></li><li><a href="module-bip70_x509.html">bip70/x509</a></li><li><a href="module-blockchain.html">blockchain</a></li><li><a href="module-blockchain_common.html">blockchain/common</a></li><li><a href="module-btc.html">btc</a></li><li><a href="module-coins.html">coins</a></li><li><a href="module-crypto.html">crypto</a></li><li><a href="module-crypto_chachapoly.html">crypto/chachapoly</a></li><li><a href="module-crypto_ec.html">crypto/ec</a></li><li><a href="module-crypto_pk.html">crypto/pk</a></li><li><a href="module-crypto_schnorr.html">crypto/schnorr</a></li><li><a href="module-crypto_siphash.html">crypto/siphash</a></li><li><a href="module-db.html">db</a></li><li><a href="module-hd.html">hd</a></li><li><a href="module-http.html">http</a></li><li><a href="module-mempool.html">mempool</a></li><li><a href="module-mining.html">mining</a></li><li><a href="module-net.html">net</a></li><li><a href="module-net_bip152.html">net/bip152</a></li><li><a href="module-net_common.html">net/common</a></li><li><a href="module-net_dns.html">net/dns</a></li><li><a href="module-net_packets.html">net/packets</a></li><li><a href="module-net_socks.html">net/socks</a></li><li><a href="module-net_tcp.html">net/tcp</a></li><li><a href="module-node.html">node</a></li><li><a href="module-node_config.html">node/config</a></li><li><a href="module-primitives.html">primitives</a></li><li><a href="module-protocol.html">protocol</a></li><li><a href="module-protocol_consensus.html">protocol/consensus</a></li><li><a href="module-protocol_errors.html">protocol/errors</a></li><li><a href="module-protocol_networks.html">protocol/networks</a></li><li><a href="module-protocol_policy.html">protocol/policy</a></li><li><a href="module-script.html">script</a></li><li><a href="module-script_common.html">script/common</a></li><li><a href="module-utils.html">utils</a></li><li><a href="module-utils_asn1.html">utils/asn1</a></li><li><a href="module-utils_base32.html">utils/base32</a></li><li><a href="module-utils_base58.html">utils/base58</a></li><li><a href="module-utils_co.html">utils/co</a></li><li><a href="module-utils_encoding.html">utils/encoding</a></li><li><a href="module-utils_ip.html">utils/ip</a></li><li><a href="module-utils_pem.html">utils/pem</a></li><li><a href="module-utils_protobuf.html">utils/protobuf</a></li><li><a href="module-utils_util.html">utils/util</a></li><li><a href="module-wallet.html">wallet</a></li><li><a href="module-wallet_common.html">wallet/common</a></li><li><a href="module-wallet_records.html">wallet/records</a></li><li><a href="module-workers.html">workers</a></li><li><a href="module-workers_jobs.html">workers/jobs</a></li><li><a href="module-workers_packets.html">workers/packets</a></li></ul><h3>Classes</h3><ul><li><a href="Environment.html">Environment</a></li><li><a href="module-bip70.Payment.html">Payment</a></li><li><a href="module-bip70.PaymentACK.html">PaymentACK</a></li><li><a href="module-bip70.PaymentDetails.html">PaymentDetails</a></li><li><a href="module-bip70.PaymentRequest.html">PaymentRequest</a></li><li><a href="module-blockchain.Chain.html">Chain</a></li><li><a href="module-blockchain.ChainDB.html">ChainDB</a></li><li><a href="module-blockchain.ChainEntry.html">ChainEntry</a></li><li><a href="module-blockchain.ChainFlags.html">ChainFlags</a></li><li><a href="module-blockchain.ChainOptions.html">ChainOptions</a></li><li><a href="module-blockchain.ChainState.html">ChainState</a></li><li><a href="module-blockchain.DeploymentState.html">DeploymentState</a></li><li><a href="module-blockchain.StateCache.html">StateCache</a></li><li><a href="module-btc.Amount.html">Amount</a></li><li><a href="module-btc.URI.html">URI</a></li><li><a href="module-coins.CoinEntry.html">CoinEntry</a></li><li><a href="module-coins.Coins.html">Coins</a></li><li><a href="module-coins.CoinView.html">CoinView</a></li><li><a href="module-coins.UndoCoin.html">UndoCoin</a></li><li><a href="module-coins.UndoCoins.html">UndoCoins</a></li><li><a href="module-crypto_aes.AESCipher.html">AESCipher</a></li><li><a href="module-crypto_aes.AESDecipher.html">AESDecipher</a></li><li><a href="module-crypto_aes.AESKey.html">AESKey</a></li><li><a href="module-crypto_chachapoly.AEAD.html">AEAD</a></li><li><a href="module-crypto_chachapoly.ChaCha20.html">ChaCha20</a></li><li><a href="module-crypto_chachapoly.Poly1305.html">Poly1305</a></li><li><a href="module-crypto_sha256.SHA256.html">SHA256</a></li><li><a href="module-crypto_sha256.SHA256Hmac.html">SHA256Hmac</a></li><li><a href="module-db.LowlevelUp.html">LowlevelUp</a></li><li><a href="module-db.RBT.html">RBT</a></li><li><a href="module-hd.Mnemonic.html">Mnemonic</a></li><li><a href="module-hd.PrivateKey.html">PrivateKey</a></li><li><a href="module-hd.PublicKey.html">PublicKey</a></li><li><a href="module-http.Base.html">Base</a></li><li><a href="module-http.Client.html">Client</a></li><li><a href="module-http.HTTPBaseOptions.html">HTTPBaseOptions</a></li><li><a href="module-http.HTTPOptions.html">HTTPOptions</a></li><li><a href="module-http.Request.html">Request</a></li><li><a href="module-http.RPC.html">RPC</a></li><li><a href="module-http.RPCClient.html">RPCClient</a></li><li><a href="module-http.Server.html">Server</a></li><li><a href="module-http.Wallet.html">Wallet</a></li><li><a href="module-mempool.ConfirmStats.html">ConfirmStats</a></li><li><a href="module-mempool.Mempool.html">Mempool</a></li><li><a href="module-mempool.MempoolEntry.html">MempoolEntry</a></li><li><a href="module-mempool.MempoolOptions.html">MempoolOptions</a></li><li><a href="module-mempool.PolicyEstimator.html">PolicyEstimator</a></li><li><a href="module-mining.BlockEntry.html">BlockEntry</a></li><li><a href="module-mining.Miner.html">Miner</a></li><li><a href="module-mining.MinerBlock.html">MinerBlock</a></li><li><a href="module-mining.MinerOptions.html">MinerOptions</a></li><li><a href="module-net.AuthDB.html">AuthDB</a></li><li><a href="module-net.BIP150.html">BIP150</a></li><li><a href="module-net.BIP151.html">BIP151</a></li><li><a href="module-net.BIP151Stream.html">BIP151Stream</a></li><li><a href="module-net.BroadcastItem.html">BroadcastItem</a></li><li><a href="module-net.Framer.html">Framer</a></li><li><a href="module-net.HostEntry.html">HostEntry</a></li><li><a href="module-net.HostList.html">HostList</a></li><li><a href="module-net.Parser.html">Parser</a></li><li><a href="module-net.Peer.html">Peer</a></li><li><a href="module-net.PeerList.html">PeerList</a></li><li><a href="module-net.PeerOptions.html">PeerOptions</a></li><li><a href="module-net.Pool.html">Pool</a></li><li><a href="module-net.PoolOptions.html">PoolOptions</a></li><li><a href="module-net_bip152-CompactBlock.html">CompactBlock</a></li><li><a href="module-net_bip152-PrefilledTX.html">PrefilledTX</a></li><li><a href="module-net_bip152-TXRequest.html">TXRequest</a></li><li><a href="module-net_bip152-TXResponse.html">TXResponse</a></li><li><a href="module-net_packets-AddrPacket.html">AddrPacket</a></li><li><a href="module-net_packets-AuthChallengePacket.html">AuthChallengePacket</a></li><li><a href="module-net_packets-AuthProposePacket.html">AuthProposePacket</a></li><li><a href="module-net_packets-AuthReplyPacket.html">AuthReplyPacket</a></li><li><a href="module-net_packets-BlockPacket.html">BlockPacket</a></li><li><a href="module-net_packets-BlockTxnPacket.html">BlockTxnPacket</a></li><li><a href="module-net_packets-CmpctBlockPacket.html">CmpctBlockPacket</a></li><li><a href="module-net_packets-EncackPacket.html">EncackPacket</a></li><li><a href="module-net_packets-EncinitPacket.html">EncinitPacket</a></li><li><a href="module-net_packets-FeeFilterPacket.html">FeeFilterPacket</a></li><li><a href="module-net_packets-FilterAddPacket.html">FilterAddPacket</a></li><li><a href="module-net_packets-FilterClearPacket.html">FilterClearPacket</a></li><li><a href="module-net_packets-FilterLoadPacket.html">FilterLoadPacket</a></li><li><a href="module-net_packets-GetAddrPacket.html">GetAddrPacket</a></li><li><a href="module-net_packets-GetBlocksPacket.html">GetBlocksPacket</a></li><li><a href="module-net_packets-GetBlockTxnPacket.html">GetBlockTxnPacket</a></li><li><a href="module-net_packets-GetDataPacket.html">GetDataPacket</a></li><li><a href="module-net_packets-GetHeadersPacket.html">GetHeadersPacket</a></li><li><a href="module-net_packets-HeadersPacket.html">HeadersPacket</a></li><li><a href="module-net_packets-InvPacket.html">InvPacket</a></li><li><a href="module-net_packets-MempoolPacket.html">MempoolPacket</a></li><li><a href="module-net_packets-MerkleBlockPacket.html">MerkleBlockPacket</a></li><li><a href="module-net_packets-NotFoundPacket.html">NotFoundPacket</a></li><li><a href="module-net_packets-Packet.html">Packet</a></li><li><a href="module-net_packets-PingPacket.html">PingPacket</a></li><li><a href="module-net_packets-PongPacket.html">PongPacket</a></li><li><a href="module-net_packets-RejectPacket.html">RejectPacket</a></li><li><a href="module-net_packets-SendCmpctPacket.html">SendCmpctPacket</a></li><li><a href="module-net_packets-SendHeadersPacket.html">SendHeadersPacket</a></li><li><a href="module-net_packets-TXPacket.html">TXPacket</a></li><li><a href="module-net_packets-UnknownPacket.html">UnknownPacket</a></li><li><a href="module-net_packets-VerackPacket.html">VerackPacket</a></li><li><a href="module-net_packets-VersionPacket.html">VersionPacket</a></li><li><a href="module-net_socks-Proxy.html">Proxy</a></li><li><a href="module-net_socks-SOCKS.html">SOCKS</a></li><li><a href="module-node.FullNode.html">FullNode</a></li><li><a href="module-node.Logger.html">Logger</a></li><li><a href="module-node.Node.html">Node</a></li><li><a href="module-node.NodeClient.html">NodeClient</a></li><li><a href="module-node.SPVNode.html">SPVNode</a></li><li><a href="module-primitives.AbstractBlock.html">AbstractBlock</a></li><li><a href="module-primitives.Address.html">Address</a></li><li><a href="module-primitives.Block.html">Block</a></li><li><a href="module-primitives.Coin.html">Coin</a></li><li><a href="module-primitives.CoinSelector.html">CoinSelector</a></li><li><a href="module-primitives.Headers.html">Headers</a></li><li><a href="module-primitives.Input.html">Input</a></li><li><a href="module-primitives.InvItem.html">InvItem</a></li><li><a href="module-primitives.KeyRing.html">KeyRing</a></li><li><a href="module-primitives.MemBlock.html">MemBlock</a></li><li><a href="module-primitives.MerkleBlock.html">MerkleBlock</a></li><li><a href="module-primitives.MTX.html">MTX</a></li><li><a href="module-primitives.NetAddress.html">NetAddress</a></li><li><a href="module-primitives.Outpoint.html">Outpoint</a></li><li><a href="module-primitives.Output.html">Output</a></li><li><a href="module-primitives.TX.html">TX</a></li><li><a href="module-primitives.TXMeta.html">TXMeta</a></li><li><a href="module-protocol.Network.html">Network</a></li><li><a href="module-protocol.TimeData.html">TimeData</a></li><li><a href="module-protocol_errors-VerifyError.html">VerifyError</a></li><li><a href="module-protocol_errors-VerifyResult.html">VerifyResult</a></li><li><a href="module-script.Opcode.html">Opcode</a></li><li><a href="module-script.Program.html">Program</a></li><li><a href="module-script.Script.html">Script</a></li><li><a href="module-script.ScriptError.html">ScriptError</a></li><li><a href="module-script.SigCache.html">SigCache</a></li><li><a href="module-script.Stack.html">Stack</a></li><li><a href="module-script.Witness.html">Witness</a></li><li><a href="module-utils.AsyncEmitter.html">AsyncEmitter</a></li><li><a href="module-utils.AsyncObject.html">AsyncObject</a></li><li><a href="module-utils.Bloom.html">Bloom</a></li><li><a href="module-utils.BufferReader.html">BufferReader</a></li><li><a href="module-utils.BufferWriter.html">BufferWriter</a></li><li><a href="module-utils.List.html">List</a></li><li><a href="module-utils.ListItem.html">ListItem</a></li><li><a href="module-utils.Lock.html">Lock</a></li><li><a href="module-utils.LRU.html">LRU</a></li><li><a href="module-utils.LRUBatch.html">LRUBatch</a></li><li><a href="module-utils.LRUItem.html">LRUItem</a></li><li><a href="module-utils.LRUOp.html">LRUOp</a></li><li><a href="module-utils.Map.html">Map</a></li><li><a href="module-utils.MappedLock.html">MappedLock</a></li><li><a href="module-utils.RollingFilter.html">RollingFilter</a></li><li><a href="module-utils.StaticWriter.html">StaticWriter</a></li><li><a href="module-utils_ip.Address.html">Address</a></li><li><a href="module-utils_protobuf-ProtoReader.html">ProtoReader</a></li><li><a href="module-utils_protobuf-ProtoWriter.html">ProtoWriter</a></li><li><a href="module-wallet.Account.html">Account</a></li><li><a href="module-wallet.Balance.html">Balance</a></li><li><a href="module-wallet.BlockRecord.html">BlockRecord</a></li><li><a href="module-wallet.ChainState.html">ChainState</a></li><li><a href="module-wallet.Credit.html">Credit</a></li><li><a href="module-wallet.Details.html">Details</a></li><li><a href="module-wallet.DetailsMember.html">DetailsMember</a></li><li><a href="module-wallet.MasterKey.html">MasterKey</a></li><li><a href="module-wallet.Path.html">Path</a></li><li><a href="module-wallet.TXDB.html">TXDB</a></li><li><a href="module-wallet.Wallet.html">Wallet</a></li><li><a href="module-wallet.WalletClient.html">WalletClient</a></li><li><a href="module-wallet.WalletDB.html">WalletDB</a></li><li><a href="module-wallet.WalletKey.html">WalletKey</a></li><li><a href="module-wallet.WalletOptions.html">WalletOptions</a></li><li><a href="module-wallet_records-BlockMapRecord.html">BlockMapRecord</a></li><li><a href="module-wallet_records-BlockMeta.html">BlockMeta</a></li><li><a href="module-wallet_records-ChainState.html">ChainState</a></li><li><a href="module-wallet_records-OutpointMapRecord.html">OutpointMapRecord</a></li><li><a href="module-wallet_records-PathMapRecord.html">PathMapRecord</a></li><li><a href="module-wallet_records-TXMapRecord.html">TXMapRecord</a></li><li><a href="module-wallet_records-TXRecord.html">TXRecord</a></li><li><a href="module-workers.Framer.html">Framer</a></li><li><a href="module-workers.Master.html">Master</a></li><li><a href="module-workers.Parser.html">Parser</a></li><li><a href="module-workers.ParserClient.html">ParserClient</a></li><li><a href="module-workers.Worker.html">Worker</a></li><li><a href="module-workers.WorkerPool.html">WorkerPool</a></li><li><a href="module-workers_packets-ECSignPacket.html">ECSignPacket</a></li><li><a href="module-workers_packets-ECSignResultPacket.html">ECSignResultPacket</a></li><li><a href="module-workers_packets-ECVerifyPacket.html">ECVerifyPacket</a></li><li><a href="module-workers_packets-ECVerifyResultPacket.html">ECVerifyResultPacket</a></li><li><a href="module-workers_packets-ErrorPacket.html">ErrorPacket</a></li><li><a href="module-workers_packets-ErrorResultPacket.html">ErrorResultPacket</a></li><li><a href="module-workers_packets-EventPacket.html">EventPacket</a></li><li><a href="module-workers_packets-LogPacket.html">LogPacket</a></li><li><a href="module-workers_packets-MinePacket.html">MinePacket</a></li><li><a href="module-workers_packets-MineResultPacket.html">MineResultPacket</a></li><li><a href="module-workers_packets-Packet.html">Packet</a></li><li><a href="module-workers_packets-ScryptPacket.html">ScryptPacket</a></li><li><a href="module-workers_packets-ScryptResultPacket.html">ScryptResultPacket</a></li><li><a href="module-workers_packets-SignInputPacket.html">SignInputPacket</a></li><li><a href="module-workers_packets-SignInputResultPacket.html">SignInputResultPacket</a></li><li><a href="module-workers_packets-SignPacket.html">SignPacket</a></li><li><a href="module-workers_packets-SignResultPacket.html">SignResultPacket</a></li><li><a href="module-workers_packets-VerifyInputPacket.html">VerifyInputPacket</a></li><li><a href="module-workers_packets-VerifyInputResultPacket.html">VerifyInputResultPacket</a></li><li><a href="module-workers_packets-VerifyPacket.html">VerifyPacket</a></li><li><a href="module-workers_packets-VerifyResultPacket.html">VerifyResultPacket</a></li></ul><h3>Namespaces</h3><ul><li><a href="module-crypto_pk.ecdsa.html">ecdsa</a></li><li><a href="module-crypto_pk.rsa.html">rsa</a></li></ul><h3>Global</h3><ul><li><a href="global.html"></a></li><li><a href="global.html#DoubleMap">DoubleMap</a></li><li><a href="global.html#StatEntry">StatEntry</a></li></ul>
</nav>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Fri Feb 10 2017 09:40:28 GMT-0800 (PST)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>