2025-06-21 23:30:33 +03:00

2726 lines
26 KiB
HTML

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Module: bchaddr</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">Module: bchaddr</h1>
<section>
<header>
</header>
<article>
<div class="container-overview">
<div class="description">General purpose Bitcoin Cash address detection and translation.<br />
Supports all major Bitcoin Cash address formats.<br />
Currently:
<ul>
<li> Legacy format </li>
<li> Bitpay format </li>
<li> Cashaddr format </li>
</ul></div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="bchaddr.js.html">bchaddr.js</a>, <a href="bchaddr.js.html#line13">line 13</a>
</li></ul></dd>
</dl>
</div>
<h3 class="subsection-title">Classes</h3>
<dl>
<dt><a href="module-bchaddr-InvalidAddressError.html">InvalidAddressError</a></dt>
<dd></dd>
</dl>
<h3 class="subsection-title">Members</h3>
<h4 class="name" id=".Format"><span class="type-signature">(static) </span>Format<span class="type-signature"></span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="bchaddr.js.html">bchaddr.js</a>, <a href="bchaddr.js.html#line29">line 29</a>
</li></ul></dd>
</dl>
<h4 class="name" id=".Network"><span class="type-signature">(static) </span>Network<span class="type-signature"></span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="bchaddr.js.html">bchaddr.js</a>, <a href="bchaddr.js.html#line38">line 38</a>
</li></ul></dd>
</dl>
<h4 class="name" id=".Type"><span class="type-signature">(static) </span>Type<span class="type-signature"></span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="bchaddr.js.html">bchaddr.js</a>, <a href="bchaddr.js.html#line46">line 46</a>
</li></ul></dd>
</dl>
<h3 class="subsection-title">Methods</h3>
<h4 class="name" id=".detectAddressFormat"><span class="type-signature">(static) </span>detectAddressFormat<span class="signature">(address)</span><span class="type-signature"> &rarr; {string}</span></h4>
<div class="description">
Detects what is the given address' format.
</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>address</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">A valid Bitcoin Cash address in any format.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="bchaddr.js.html">bchaddr.js</a>, <a href="bchaddr.js.html#line72">line 72</a>
</li></ul></dd>
</dl>
<h5>Throws:</h5>
<div class="param-desc">
<span class="param-type">InvalidAddressError</span>
</div>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">string</span>
</dd>
</dl>
<h4 class="name" id=".detectAddressNetwork"><span class="type-signature">(static) </span>detectAddressNetwork<span class="signature">(address)</span><span class="type-signature"> &rarr; {string}</span></h4>
<div class="description">
Detects what is the given address' network.
</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>address</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">A valid Bitcoin Cash address in any format.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="bchaddr.js.html">bchaddr.js</a>, <a href="bchaddr.js.html#line83">line 83</a>
</li></ul></dd>
</dl>
<h5>Throws:</h5>
<div class="param-desc">
<span class="param-type">InvalidAddressError</span>
</div>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">string</span>
</dd>
</dl>
<h4 class="name" id=".detectAddressType"><span class="type-signature">(static) </span>detectAddressType<span class="signature">(address)</span><span class="type-signature"> &rarr; {string}</span></h4>
<div class="description">
Detects what is the given address' type.
</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>address</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">A valid Bitcoin Cash address in any format.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="bchaddr.js.html">bchaddr.js</a>, <a href="bchaddr.js.html#line94">line 94</a>
</li></ul></dd>
</dl>
<h5>Throws:</h5>
<div class="param-desc">
<span class="param-type">InvalidAddressError</span>
</div>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">string</span>
</dd>
</dl>
<h4 class="name" id=".isBitpayAddress"><span class="type-signature">(static) </span>isBitpayAddress<span class="signature">(address)</span><span class="type-signature"> &rarr; {boolean}</span></h4>
<div class="description">
Returns a boolean indicating whether the address is in bitpay format.
</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>address</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">A valid Bitcoin Cash address in any format.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="bchaddr.js.html">bchaddr.js</a>, <a href="bchaddr.js.html#line369">line 369</a>
</li></ul></dd>
</dl>
<h5>Throws:</h5>
<div class="param-desc">
<span class="param-type">InvalidAddressError</span>
</div>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">boolean</span>
</dd>
</dl>
<h4 class="name" id=".isCashAddress"><span class="type-signature">(static) </span>isCashAddress<span class="signature">(address)</span><span class="type-signature"> &rarr; {boolean}</span></h4>
<div class="description">
Returns a boolean indicating whether the address is in cashaddr format.
</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>address</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">A valid Bitcoin Cash address in any format.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="bchaddr.js.html">bchaddr.js</a>, <a href="bchaddr.js.html#line380">line 380</a>
</li></ul></dd>
</dl>
<h5>Throws:</h5>
<div class="param-desc">
<span class="param-type">InvalidAddressError</span>
</div>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">boolean</span>
</dd>
</dl>
<h4 class="name" id=".isLegacyAddress"><span class="type-signature">(static) </span>isLegacyAddress<span class="signature">(address)</span><span class="type-signature"> &rarr; {boolean}</span></h4>
<div class="description">
Returns a boolean indicating whether the address is in legacy format.
</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>address</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">A valid Bitcoin Cash address in any format.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="bchaddr.js.html">bchaddr.js</a>, <a href="bchaddr.js.html#line358">line 358</a>
</li></ul></dd>
</dl>
<h5>Throws:</h5>
<div class="param-desc">
<span class="param-type">InvalidAddressError</span>
</div>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">boolean</span>
</dd>
</dl>
<h4 class="name" id=".isMainnetAddress"><span class="type-signature">(static) </span>isMainnetAddress<span class="signature">(address)</span><span class="type-signature"> &rarr; {boolean}</span></h4>
<div class="description">
Returns a boolean indicating whether the address is a mainnet address.
</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>address</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">A valid Bitcoin Cash address in any format.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="bchaddr.js.html">bchaddr.js</a>, <a href="bchaddr.js.html#line391">line 391</a>
</li></ul></dd>
</dl>
<h5>Throws:</h5>
<div class="param-desc">
<span class="param-type">InvalidAddressError</span>
</div>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">boolean</span>
</dd>
</dl>
<h4 class="name" id=".isP2PKHAddress"><span class="type-signature">(static) </span>isP2PKHAddress<span class="signature">(address)</span><span class="type-signature"> &rarr; {boolean}</span></h4>
<div class="description">
Returns a boolean indicating whether the address is a p2pkh address.
</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>address</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">A valid Bitcoin Cash address in any format.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="bchaddr.js.html">bchaddr.js</a>, <a href="bchaddr.js.html#line413">line 413</a>
</li></ul></dd>
</dl>
<h5>Throws:</h5>
<div class="param-desc">
<span class="param-type">InvalidAddressError</span>
</div>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">boolean</span>
</dd>
</dl>
<h4 class="name" id=".isP2SHAddress"><span class="type-signature">(static) </span>isP2SHAddress<span class="signature">(address)</span><span class="type-signature"> &rarr; {boolean}</span></h4>
<div class="description">
Returns a boolean indicating whether the address is a p2sh address.
</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>address</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">A valid Bitcoin Cash address in any format.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="bchaddr.js.html">bchaddr.js</a>, <a href="bchaddr.js.html#line424">line 424</a>
</li></ul></dd>
</dl>
<h5>Throws:</h5>
<div class="param-desc">
<span class="param-type">InvalidAddressError</span>
</div>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">boolean</span>
</dd>
</dl>
<h4 class="name" id=".isTestnetAddress"><span class="type-signature">(static) </span>isTestnetAddress<span class="signature">(address)</span><span class="type-signature"> &rarr; {boolean}</span></h4>
<div class="description">
Returns a boolean indicating whether the address is a testnet address.
</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>address</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">A valid Bitcoin Cash address in any format.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="bchaddr.js.html">bchaddr.js</a>, <a href="bchaddr.js.html#line402">line 402</a>
</li></ul></dd>
</dl>
<h5>Throws:</h5>
<div class="param-desc">
<span class="param-type">InvalidAddressError</span>
</div>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">boolean</span>
</dd>
</dl>
<h4 class="name" id=".isValidAddress"><span class="type-signature">(static) </span>isValidAddress<span class="signature">(input)</span><span class="type-signature"> &rarr; {boolean}</span></h4>
<div class="description">
Returns a boolean indicating whether the given input is a valid Bitcoin Cash address.
</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>input</code></td>
<td class="type">
<span class="param-type">*</span>
</td>
<td class="description last">Any input to check for validity.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="bchaddr.js.html">bchaddr.js</a>, <a href="bchaddr.js.html#line56">line 56</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=".toBitpayAddress"><span class="type-signature">(static) </span>toBitpayAddress<span class="signature">(address)</span><span class="type-signature"> &rarr; {string}</span></h4>
<div class="description">
Translates the given address into bitpay format.
</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>address</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">A valid Bitcoin Cash address in any format.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="bchaddr.js.html">bchaddr.js</a>, <a href="bchaddr.js.html#line120">line 120</a>
</li></ul></dd>
</dl>
<h5>Throws:</h5>
<div class="param-desc">
<span class="param-type">InvalidAddressError</span>
</div>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">string</span>
</dd>
</dl>
<h4 class="name" id=".toCashAddress"><span class="type-signature">(static) </span>toCashAddress<span class="signature">(address)</span><span class="type-signature"> &rarr; {string}</span></h4>
<div class="description">
Translates the given address into cashaddr format.
</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>address</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">A valid Bitcoin Cash address in any format.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="bchaddr.js.html">bchaddr.js</a>, <a href="bchaddr.js.html#line135">line 135</a>
</li></ul></dd>
</dl>
<h5>Throws:</h5>
<div class="param-desc">
<span class="param-type">InvalidAddressError</span>
</div>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">string</span>
</dd>
</dl>
<h4 class="name" id=".toLegacyAddress"><span class="type-signature">(static) </span>toLegacyAddress<span class="signature">(address)</span><span class="type-signature"> &rarr; {string}</span></h4>
<div class="description">
Translates the given address into legacy format.
</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>address</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">A valid Bitcoin Cash address in any format.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="bchaddr.js.html">bchaddr.js</a>, <a href="bchaddr.js.html#line105">line 105</a>
</li></ul></dd>
</dl>
<h5>Throws:</h5>
<div class="param-desc">
<span class="param-type">InvalidAddressError</span>
</div>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">string</span>
</dd>
</dl>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-bchaddr.html">bchaddr</a></li></ul><h3>Classes</h3><ul><li><a href="module-bchaddr-InvalidAddressError.html">InvalidAddressError</a></li></ul>
</nav>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.3</a> on Sat Dec 26 2020 20:43:05 GMT+0100 (Central European Standard Time)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>