Files
stacks.js/docs/classes/localregtest.html
Matthew Little ffd0802d7d * Backwards compatibility fixes for makeAuthRequest(...) and redirectToSignIn(...).
* Adding type for the UserData returned by the loadUserData() function.
2019-03-11 21:34:47 -04:00

1555 lines
100 KiB
HTML

<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>LocalRegtest | blockstack</title>
<meta name="description" content="">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.js" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">blockstack</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-only-exported" />
<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../index.html">Globals</a>
</li>
<li>
<a href="localregtest.html">LocalRegtest</a>
</li>
</ul>
<h1>Class LocalRegtest</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<a href="blockstacknetwork.html" class="tsd-signature-type">BlockstackNetwork</a>
<ul class="tsd-hierarchy">
<li>
<span class="target">LocalRegtest</span>
</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Constructors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a href="localregtest.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<section class="tsd-index-section tsd-is-inherited">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="localregtest.html#dust_minimum" class="tsd-kind-icon">DUST_<wbr>MINIMUM</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="localregtest.html#magic_bytes" class="tsd-kind-icon">MAGIC_<wbr>BYTES</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="localregtest.html#blockstackapiurl" class="tsd-kind-icon">blockstackAPIUrl</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="localregtest.html#broadcastserviceurl" class="tsd-kind-icon">broadcast<wbr>Service<wbr>Url</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="localregtest.html#btc" class="tsd-kind-icon">btc</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="localregtest.html#excludeutxoset" class="tsd-kind-icon">exclude<wbr>Utxo<wbr>Set</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="localregtest.html#includeutxomap" class="tsd-kind-icon">include<wbr>Utxo<wbr>Map</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="localregtest.html#layer1" class="tsd-kind-icon">layer1</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-private"><a href="localregtest.html#broadcastnameregistration" class="tsd-kind-icon">broadcast<wbr>Name<wbr>Registration</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-private"><a href="localregtest.html#broadcastservicefetchhelper" class="tsd-kind-icon">broadcast<wbr>Service<wbr>Fetch<wbr>Helper</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-private"><a href="localregtest.html#broadcasttransaction" class="tsd-kind-icon">broadcast<wbr>Transaction</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-private"><a href="localregtest.html#broadcastzonefile" class="tsd-kind-icon">broadcast<wbr>Zone<wbr>File</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="localregtest.html#coerceaddress" class="tsd-kind-icon">coerce<wbr>Address</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="localregtest.html#countdustoutputs" class="tsd-kind-icon">count<wbr>Dust<wbr>Outputs</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="localregtest.html#getaccountat" class="tsd-kind-icon">get<wbr>Account<wbr>At</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="localregtest.html#getaccountbalance" class="tsd-kind-icon">get<wbr>Account<wbr>Balance</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="localregtest.html#getaccounthistorypage" class="tsd-kind-icon">get<wbr>Account<wbr>History<wbr>Page</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="localregtest.html#getaccountstatus" class="tsd-kind-icon">get<wbr>Account<wbr>Status</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="localregtest.html#getaccounttokens" class="tsd-kind-icon">get<wbr>Account<wbr>Tokens</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="localregtest.html#getblockheight" class="tsd-kind-icon">get<wbr>Block<wbr>Height</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="localregtest.html#getconsensushash" class="tsd-kind-icon">get<wbr>Consensus<wbr>Hash</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="localregtest.html#getdefaultburnaddress" class="tsd-kind-icon">get<wbr>Default<wbr>Burn<wbr>Address</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="localregtest.html#getfeerate" class="tsd-kind-icon">get<wbr>Fee<wbr>Rate</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="localregtest.html#getgraceperiod" class="tsd-kind-icon">get<wbr>Grace<wbr>Period</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="localregtest.html#getnameinfo" class="tsd-kind-icon">get<wbr>Name<wbr>Info</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="localregtest.html#getnameprice" class="tsd-kind-icon">get<wbr>Name<wbr>Price</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-private"><a href="localregtest.html#getnamepricev1" class="tsd-kind-icon">get<wbr>Name<wbr>Price<wbr>V1</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-private"><a href="localregtest.html#getnamepricev2" class="tsd-kind-icon">get<wbr>Name<wbr>Price<wbr>V2</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="localregtest.html#getnamesowned" class="tsd-kind-icon">get<wbr>Names<wbr>Owned</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="localregtest.html#getnamespaceburnaddress" class="tsd-kind-icon">get<wbr>Namespace<wbr>Burn<wbr>Address</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="localregtest.html#getnamespaceinfo" class="tsd-kind-icon">get<wbr>Namespace<wbr>Info</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="localregtest.html#getnamespaceprice" class="tsd-kind-icon">get<wbr>Namespace<wbr>Price</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-private"><a href="localregtest.html#getnamespacepricev1" class="tsd-kind-icon">get<wbr>Namespace<wbr>Price<wbr>V1</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-private"><a href="localregtest.html#getnamespacepricev2" class="tsd-kind-icon">get<wbr>Namespace<wbr>Price<wbr>V2</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="localregtest.html#getnetworkedutxos" class="tsd-kind-icon">get<wbr>NetworkedUTXOs</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="localregtest.html#gettransactioninfo" class="tsd-kind-icon">get<wbr>Transaction<wbr>Info</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="localregtest.html#getutxos" class="tsd-kind-icon">getUTXOs</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="localregtest.html#getzonefile" class="tsd-kind-icon">get<wbr>Zonefile</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-private"><a href="localregtest.html#modifyutxosetfrom" class="tsd-kind-icon">modifyUTXOSet<wbr>From</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="localregtest.html#resetutxos" class="tsd-kind-icon">resetUTXOs</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Constructors</h2>
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite">
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite">
<li class="tsd-signature tsd-kind-icon">new <wbr>Local<wbr>Regtest<span class="tsd-signature-symbol">(</span>apiUrl<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, broadcastServiceUrl<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, bitcoinAPI<span class="tsd-signature-symbol">: </span><a href="bitcoinnetwork.html" class="tsd-signature-type">BitcoinNetwork</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="localregtest.html" class="tsd-signature-type">LocalRegtest</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Overrides <a href="blockstacknetwork.html">BlockstackNetwork</a>.<a href="blockstacknetwork.html#constructor">constructor</a></p>
<ul>
<li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/f9be48c/src/network.ts#L902">network.ts:902</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>apiUrl: <span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5>broadcastServiceUrl: <span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5>bitcoinAPI: <a href="bitcoinnetwork.html" class="tsd-signature-type">BitcoinNetwork</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="localregtest.html" class="tsd-signature-type">LocalRegtest</a></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a name="dust_minimum" class="tsd-anchor"></a>
<h3>DUST_<wbr>MINIMUM</h3>
<div class="tsd-signature tsd-kind-icon">DUST_<wbr>MINIMUM<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="blockstacknetwork.html">BlockstackNetwork</a>.<a href="blockstacknetwork.html#dust_minimum">DUST_MINIMUM</a></p>
<ul>
<li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/f9be48c/src/network.ts#L46">network.ts:46</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a name="magic_bytes" class="tsd-anchor"></a>
<h3>MAGIC_<wbr>BYTES</h3>
<div class="tsd-signature tsd-kind-icon">MAGIC_<wbr>BYTES<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="blockstacknetwork.html">BlockstackNetwork</a>.<a href="blockstacknetwork.html#magic_bytes">MAGIC_BYTES</a></p>
<ul>
<li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/f9be48c/src/network.ts#L54">network.ts:54</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a name="blockstackapiurl" class="tsd-anchor"></a>
<h3>blockstackAPIUrl</h3>
<div class="tsd-signature tsd-kind-icon">blockstackAPIUrl<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="blockstacknetwork.html">BlockstackNetwork</a>.<a href="blockstacknetwork.html#blockstackapiurl">blockstackAPIUrl</a></p>
<ul>
<li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/f9be48c/src/network.ts#L40">network.ts:40</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a name="broadcastserviceurl" class="tsd-anchor"></a>
<h3>broadcast<wbr>Service<wbr>Url</h3>
<div class="tsd-signature tsd-kind-icon">broadcast<wbr>Service<wbr>Url<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="blockstacknetwork.html">BlockstackNetwork</a>.<a href="blockstacknetwork.html#broadcastserviceurl">broadcastServiceUrl</a></p>
<ul>
<li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/f9be48c/src/network.ts#L42">network.ts:42</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a name="btc" class="tsd-anchor"></a>
<h3>btc</h3>
<div class="tsd-signature tsd-kind-icon">btc<span class="tsd-signature-symbol">:</span> <a href="bitcoinnetwork.html" class="tsd-signature-type">BitcoinNetwork</a></div>
<aside class="tsd-sources">
<p>Inherited from <a href="blockstacknetwork.html">BlockstackNetwork</a>.<a href="blockstacknetwork.html#btc">btc</a></p>
<ul>
<li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/f9be48c/src/network.ts#L52">network.ts:52</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a name="excludeutxoset" class="tsd-anchor"></a>
<h3>exclude<wbr>Utxo<wbr>Set</h3>
<div class="tsd-signature tsd-kind-icon">exclude<wbr>Utxo<wbr>Set<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol">&lt;</span><a href="../index.html#utxo" class="tsd-signature-type">UTXO</a><span class="tsd-signature-symbol">&gt;</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="blockstacknetwork.html">BlockstackNetwork</a>.<a href="blockstacknetwork.html#excludeutxoset">excludeUtxoSet</a></p>
<ul>
<li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/f9be48c/src/network.ts#L50">network.ts:50</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a name="includeutxomap" class="tsd-anchor"></a>
<h3>include<wbr>Utxo<wbr>Map</h3>
<div class="tsd-signature tsd-kind-icon">include<wbr>Utxo<wbr>Map<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="blockstacknetwork.html">BlockstackNetwork</a>.<a href="blockstacknetwork.html#includeutxomap">includeUtxoMap</a></p>
<ul>
<li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/f9be48c/src/network.ts#L48">network.ts:48</a></li>
</ul>
</aside>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter-index-signature">
<h5><span class="tsd-signature-symbol">[</span>address: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><a href="../index.html#utxo" class="tsd-signature-type">UTXO</a><span class="tsd-signature-symbol">[]</span></h5>
</li>
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a name="layer1" class="tsd-anchor"></a>
<h3>layer1</h3>
<div class="tsd-signature tsd-kind-icon">layer1<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="blockstacknetwork.html">BlockstackNetwork</a>.<a href="blockstacknetwork.html#layer1">layer1</a></p>
<ul>
<li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/f9be48c/src/network.ts#L44">network.ts:44</a></li>
</ul>
</aside>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-private">
<a name="broadcastnameregistration" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagPrivate">Private</span> broadcast<wbr>Name<wbr>Registration</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-private">
<li class="tsd-signature tsd-kind-icon">broadcast<wbr>Name<wbr>Registration<span class="tsd-signature-symbol">(</span>preorderTransaction<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, registerTransaction<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, zoneFile<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="blockstacknetwork.html">BlockstackNetwork</a>.<a href="blockstacknetwork.html#broadcastnameregistration">broadcastNameRegistration</a></p>
<ul>
<li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/f9be48c/src/network.ts#L748">network.ts:748</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Sends the preorder and registration transactions and zone file
for a Blockstack name registration
along with the to the transaction broadcast service.</p>
</div>
<p>The transaction broadcast:</p>
<ul>
<li>immediately broadcasts the preorder transaction</li>
<li>broadcasts the register transactions after the preorder transaction
has an appropriate number of confirmations</li>
<li>broadcasts the zone file to the Atlas network after the register transaction
has an appropriate number of confirmations</li>
</ul>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>preorderTransaction: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>the hex-encoded, signed preorder transaction generated
using the <code>makePreorder</code> function</p>
</div>
</li>
<li>
<h5>registerTransaction: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>the hex-encoded, signed register transaction generated
using the <code>makeRegister</code> function</p>
</div>
</li>
<li>
<h5>zoneFile: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>the zone file to be broadcast to the Atlas network</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4>
<p>Returns a Promise that resolves to an object with a
<code>transaction_hash</code> key containing the transaction hash of the broadcasted transaction.</p>
<p>In the event of an error, it rejects with:</p>
<ul>
<li>a <code>RemoteServiceError</code> if there is a problem
with the transaction broadcast service</li>
<li><code>MissingParameterError</code> if you call the function without a required
parameter</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-private">
<a name="broadcastservicefetchhelper" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagPrivate">Private</span> broadcast<wbr>Service<wbr>Fetch<wbr>Helper</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-private">
<li class="tsd-signature tsd-kind-icon">broadcast<wbr>Service<wbr>Fetch<wbr>Helper<span class="tsd-signature-symbol">(</span>endpoint<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, body<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Error</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="blockstacknetwork.html">BlockstackNetwork</a>.<a href="blockstacknetwork.html#broadcastservicefetchhelper">broadcastServiceFetchHelper</a></p>
<ul>
<li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/f9be48c/src/network.ts#L570">network.ts:570</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Performs a POST request to the given URL</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>endpoint: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>the name of</p>
</div>
</li>
<li>
<h5>body: <span class="tsd-signature-type">any</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Error</span><span class="tsd-signature-symbol">&gt;</span></h4>
<p>Returns a <code>Promise</code> that resolves to the object requested.
In the event of an error, it rejects with:</p>
<ul>
<li>a <code>RemoteServiceError</code> if there is a problem
with the transaction broadcast service</li>
<li><code>MissingParameterError</code> if you call the function without a required
parameter</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-private">
<a name="broadcasttransaction" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagPrivate">Private</span> broadcast<wbr>Transaction</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-private">
<li class="tsd-signature tsd-kind-icon">broadcast<wbr>Transaction<span class="tsd-signature-symbol">(</span>transaction<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, transactionToWatch<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, confirmations<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="blockstacknetwork.html">BlockstackNetwork</a>.<a href="blockstacknetwork.html#broadcasttransaction">broadcastTransaction</a></p>
<ul>
<li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/f9be48c/src/network.ts#L612">network.ts:612</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Broadcasts a signed bitcoin transaction to the network optionally waiting to broadcast the
transaction until a second transaction has a certain number of confirmations.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>transaction: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>the hex-encoded transaction to broadcast</p>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> transactionToWatch: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> =&nbsp;null</span></h5>
<div class="tsd-comment tsd-typography">
<p>the hex transaction id of the transaction to watch for
the specified number of confirmations before broadcasting the <code>transaction</code></p>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> confirmations: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> =&nbsp;6</span></h5>
<div class="tsd-comment tsd-typography">
<p>the number of confirmations <code>transactionToWatch</code> must have
before broadcasting <code>transaction</code>.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4>
<p>Returns a Promise that resolves to an object with a
<code>transaction_hash</code> key containing the transaction hash of the broadcasted transaction.</p>
<p>In the event of an error, it rejects with:</p>
<ul>
<li>a <code>RemoteServiceError</code> if there is a problem
with the transaction broadcast service</li>
<li><code>MissingParameterError</code> if you call the function without a required
parameter</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-private">
<a name="broadcastzonefile" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagPrivate">Private</span> broadcast<wbr>Zone<wbr>File</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-private">
<li class="tsd-signature tsd-kind-icon">broadcast<wbr>Zone<wbr>File<span class="tsd-signature-symbol">(</span>zoneFile<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, transactionToWatch<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="blockstacknetwork.html">BlockstackNetwork</a>.<a href="blockstacknetwork.html#broadcastzonefile">broadcastZoneFile</a></p>
<ul>
<li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/f9be48c/src/network.ts#L665">network.ts:665</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Broadcasts a zone file to the Atlas network via the transaction broadcast service.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> zoneFile: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>the zone file to be broadcast to the Atlas network</p>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> transactionToWatch: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> =&nbsp;null</span></h5>
<div class="tsd-comment tsd-typography">
<p>the hex transaction id of the transaction
to watch for confirmation before broadcasting the zone file to the Atlas network</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4>
<p>Returns a Promise that resolves to an object with a
<code>transaction_hash</code> key containing the transaction hash of the broadcasted transaction.</p>
<p>In the event of an error, it rejects with:</p>
<ul>
<li>a <code>RemoteServiceError</code> if there is a problem
with the transaction broadcast service</li>
<li><code>MissingParameterError</code> if you call the function without a required
parameter</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="coerceaddress" class="tsd-anchor"></a>
<h3>coerce<wbr>Address</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">coerce<wbr>Address<span class="tsd-signature-symbol">(</span>address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="blockstacknetwork.html">BlockstackNetwork</a>.<a href="blockstacknetwork.html#coerceaddress">coerceAddress</a></p>
<ul>
<li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/f9be48c/src/network.ts#L70">network.ts:70</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>address: <span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="countdustoutputs" class="tsd-anchor"></a>
<h3>count<wbr>Dust<wbr>Outputs</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">count<wbr>Dust<wbr>Outputs<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="blockstacknetwork.html">BlockstackNetwork</a>.<a href="blockstacknetwork.html#countdustoutputs">countDustOutputs</a></p>
<ul>
<li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/f9be48c/src/network.ts#L793">network.ts:793</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="getaccountat" class="tsd-anchor"></a>
<h3>get<wbr>Account<wbr>At</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">get<wbr>Account<wbr>At<span class="tsd-signature-symbol">(</span>address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, blockHeight<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="blockstacknetwork.html">BlockstackNetwork</a>.<a href="blockstacknetwork.html#getaccountat">getAccountAt</a></p>
<ul>
<li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/f9be48c/src/network.ts#L473">network.ts:473</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Get the state(s) of an account at a particular block height. This includes the state of the
account beginning with this block&#39;s transactions, as well as all of the states the account
passed through when this block was processed (if any).</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>address: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>the account&#39;s address</p>
</div>
</li>
<li>
<h5>blockHeight: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<p>the block to query</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></h4>
<p>a promise that resolves to an Array of Objects, where each Object encodes
states of the account at this block.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="getaccountbalance" class="tsd-anchor"></a>
<h3>get<wbr>Account<wbr>Balance</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">get<wbr>Account<wbr>Balance<span class="tsd-signature-symbol">(</span>address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, tokenType<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">BN</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="blockstacknetwork.html">BlockstackNetwork</a>.<a href="blockstacknetwork.html#getaccountbalance">getAccountBalance</a></p>
<ul>
<li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/f9be48c/src/network.ts#L532">network.ts:532</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Get the number of tokens owned by an account. If the account does not exist or has no
tokens of this type, then 0 will be returned.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>address: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>the account&#39;s address</p>
</div>
</li>
<li>
<h5>tokenType: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>the type of token to query.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">BN</span><span class="tsd-signature-symbol">&gt;</span></h4>
<p>a promise that resolves to a BigInteger that encodes the number of tokens
held by this account.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="getaccounthistorypage" class="tsd-anchor"></a>
<h3>get<wbr>Account<wbr>History<wbr>Page</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">get<wbr>Account<wbr>History<wbr>Page<span class="tsd-signature-symbol">(</span>address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, page<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="blockstacknetwork.html">BlockstackNetwork</a>.<a href="blockstacknetwork.html#getaccounthistorypage">getAccountHistoryPage</a></p>
<ul>
<li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/f9be48c/src/network.ts#L437">network.ts:437</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Get a page of an account&#39;s transaction history.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>address: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>the account&#39;s address</p>
</div>
</li>
<li>
<h5>page: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<p>the page number. Page 0 is the most recent transactions</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></h4>
<p>a promise that resolves to an Array of Objects, where each Object encodes
states of the account at various block heights (e.g. prior balances, txids, etc)</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="getaccountstatus" class="tsd-anchor"></a>
<h3>get<wbr>Account<wbr>Status</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">get<wbr>Account<wbr>Status<span class="tsd-signature-symbol">(</span>address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, tokenType<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="blockstacknetwork.html">BlockstackNetwork</a>.<a href="blockstacknetwork.html#getaccountstatus">getAccountStatus</a></p>
<ul>
<li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/f9be48c/src/network.ts#L408">network.ts:408</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Get the status of an account for a particular token holding. This includes its total number of
expenditures and credits, lockup times, last txid, and so on.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>address: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>the account</p>
</div>
</li>
<li>
<h5>tokenType: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>the token type to query</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4>
<p>a promise that resolves to an object representing the state of the account
for this token</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="getaccounttokens" class="tsd-anchor"></a>
<h3>get<wbr>Account<wbr>Tokens</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">get<wbr>Account<wbr>Tokens<span class="tsd-signature-symbol">(</span>address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="blockstacknetwork.html">BlockstackNetwork</a>.<a href="blockstacknetwork.html#getaccounttokens">getAccountTokens</a></p>
<ul>
<li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/f9be48c/src/network.ts#L505">network.ts:505</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Get the set of token types that this account owns</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>address: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>the account&#39;s address</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></h4>
<p>a promise that resolves to an Array of Strings, where each item encodes the
type of token this account holds (excluding the underlying blockchain&#39;s tokens)</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="getblockheight" class="tsd-anchor"></a>
<h3>get<wbr>Block<wbr>Height</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">get<wbr>Block<wbr>Height<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="blockstacknetwork.html">BlockstackNetwork</a>.<a href="blockstacknetwork.html#getblockheight">getBlockHeight</a></p>
<ul>
<li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/f9be48c/src/network.ts#L893">network.ts:893</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="getconsensushash" class="tsd-anchor"></a>
<h3>get<wbr>Consensus<wbr>Hash</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">get<wbr>Consensus<wbr>Hash<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="blockstacknetwork.html">BlockstackNetwork</a>.<a href="blockstacknetwork.html#getconsensushash">getConsensusHash</a></p>
<ul>
<li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/f9be48c/src/network.ts#L883">network.ts:883</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="getdefaultburnaddress" class="tsd-anchor"></a>
<h3>get<wbr>Default<wbr>Burn<wbr>Address</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">get<wbr>Default<wbr>Burn<wbr>Address<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="blockstacknetwork.html">BlockstackNetwork</a>.<a href="blockstacknetwork.html#getdefaultburnaddress">getDefaultBurnAddress</a></p>
<ul>
<li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/f9be48c/src/network.ts#L87">network.ts:87</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-overwrite">
<a name="getfeerate" class="tsd-anchor"></a>
<h3>get<wbr>Fee<wbr>Rate</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite">
<li class="tsd-signature tsd-kind-icon">get<wbr>Fee<wbr>Rate<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Overrides <a href="blockstacknetwork.html">BlockstackNetwork</a>.<a href="blockstacknetwork.html#getfeerate">getFeeRate</a></p>
<ul>
<li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/f9be48c/src/network.ts#L908">network.ts:908</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="getgraceperiod" class="tsd-anchor"></a>
<h3>get<wbr>Grace<wbr>Period</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">get<wbr>Grace<wbr>Period<span class="tsd-signature-symbol">(</span>fullyQualifiedName<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="blockstacknetwork.html">BlockstackNetwork</a>.<a href="blockstacknetwork.html#getgraceperiod">getGracePeriod</a></p>
<ul>
<li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/f9be48c/src/network.ts#L265">network.ts:265</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>How many blocks can pass between a name expiring and the name being able to be
re-registered by a different owner?</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> fullyQualifiedName: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>unused</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">&gt;</span></h4>
<p>a promise to the number of blocks</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="getnameinfo" class="tsd-anchor"></a>
<h3>get<wbr>Name<wbr>Info</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">get<wbr>Name<wbr>Info<span class="tsd-signature-symbol">(</span>fullyQualifiedName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="blockstacknetwork.html">BlockstackNetwork</a>.<a href="blockstacknetwork.html#getnameinfo">getNameInfo</a></p>
<ul>
<li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/f9be48c/src/network.ts#L318">network.ts:318</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Get WHOIS-like information for a name, including the address that owns it,
the block at which it expires, and the zone file anchored to it (if available).</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>fullyQualifiedName: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>the name to query. Can be on-chain of off-chain.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4>
<p>a promise that resolves to the WHOIS-like information</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="getnameprice" class="tsd-anchor"></a>
<h3>get<wbr>Name<wbr>Price</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">get<wbr>Name<wbr>Price<span class="tsd-signature-symbol">(</span>fullyQualifiedName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="blockstacknetwork.html">BlockstackNetwork</a>.<a href="blockstacknetwork.html#getnameprice">getNamePrice</a></p>
<ul>
<li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/f9be48c/src/network.ts#L238">network.ts:238</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Get the price of a name.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>fullyQualifiedName: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>the name to query</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">&gt;</span></h4>
<p>a promise to an Object with { units: String, amount: BigInteger }, where
.units encodes the cryptocurrency units to pay (e.g. BTC, STACKS), and
.amount encodes the number of units, in the smallest denominiated amount
(e.g. if .units is BTC, .amount will be satoshis; if .units is STACKS,
.amount will be microStacks)</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-private">
<a name="getnamepricev1" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagPrivate">Private</span> get<wbr>Name<wbr>Price<wbr>V1</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-private">
<li class="tsd-signature tsd-kind-icon">get<wbr>Name<wbr>Price<wbr>V1<span class="tsd-signature-symbol">(</span>fullyQualifiedName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="blockstacknetwork.html">BlockstackNetwork</a>.<a href="blockstacknetwork.html#getnamepricev1">getNamePriceV1</a></p>
<ul>
<li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/f9be48c/src/network.ts#L97">network.ts:97</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Get the price of a name via the legacy /v1/prices API endpoint.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>fullyQualifiedName: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>the name to query</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">&gt;</span></h4>
<p>a promise to an Object with { units: String, amount: BigInteger }</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-private">
<a name="getnamepricev2" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagPrivate">Private</span> get<wbr>Name<wbr>Price<wbr>V2</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-private">
<li class="tsd-signature tsd-kind-icon">get<wbr>Name<wbr>Price<wbr>V2<span class="tsd-signature-symbol">(</span>fullyQualifiedName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="blockstacknetwork.html">BlockstackNetwork</a>.<a href="blockstacknetwork.html#getnamepricev2">getNamePriceV2</a></p>
<ul>
<li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/f9be48c/src/network.ts#L162">network.ts:162</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Get the price of a name via the /v2/prices API endpoint.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>fullyQualifiedName: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>the name to query</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">&gt;</span></h4>
<p>a promise to an Object with { units: String, amount: BigInteger }</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="getnamesowned" class="tsd-anchor"></a>
<h3>get<wbr>Names<wbr>Owned</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">get<wbr>Names<wbr>Owned<span class="tsd-signature-symbol">(</span>address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="blockstacknetwork.html">BlockstackNetwork</a>.<a href="blockstacknetwork.html#getnamesowned">getNamesOwned</a></p>
<ul>
<li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/f9be48c/src/network.ts#L274">network.ts:274</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Get the names -- both on-chain and off-chain -- owned by an address.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>address: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>the blockchain address (the hash of the owner public key)</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></h4>
<p>a promise that resolves to a list of names (Strings)</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="getnamespaceburnaddress" class="tsd-anchor"></a>
<h3>get<wbr>Namespace<wbr>Burn<wbr>Address</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">get<wbr>Namespace<wbr>Burn<wbr>Address<span class="tsd-signature-symbol">(</span>namespace<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="blockstacknetwork.html">BlockstackNetwork</a>.<a href="blockstacknetwork.html#getnamespaceburnaddress">getNamespaceBurnAddress</a></p>
<ul>
<li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/f9be48c/src/network.ts#L287">network.ts:287</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Get the blockchain address to which a name&#39;s registration fee must be sent
(the address will depend on the namespace in which it is registered.)</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>namespace: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>the namespace ID</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></h4>
<p>a promise that resolves to an address (String)</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="getnamespaceinfo" class="tsd-anchor"></a>
<h3>get<wbr>Namespace<wbr>Info</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">get<wbr>Namespace<wbr>Info<span class="tsd-signature-symbol">(</span>namespaceID<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="blockstacknetwork.html">BlockstackNetwork</a>.<a href="blockstacknetwork.html#getnamespaceinfo">getNamespaceInfo</a></p>
<ul>
<li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/f9be48c/src/network.ts#L349">network.ts:349</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Get the pricing parameters and creation history of a namespace.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>namespaceID: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>the namespace to query</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4>
<p>a promise that resolves to the namespace information.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="getnamespaceprice" class="tsd-anchor"></a>
<h3>get<wbr>Namespace<wbr>Price</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">get<wbr>Namespace<wbr>Price<span class="tsd-signature-symbol">(</span>namespaceID<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="blockstacknetwork.html">BlockstackNetwork</a>.<a href="blockstacknetwork.html#getnamespaceprice">getNamespacePrice</a></p>
<ul>
<li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/f9be48c/src/network.ts#L253">network.ts:253</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Get the price of a namespace</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>namespaceID: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>the namespace to query</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">&gt;</span></h4>
<p>a promise to an Object with { units: String, amount: BigInteger }, where
.units encodes the cryptocurrency units to pay (e.g. BTC, STACKS), and
.amount encodes the number of units, in the smallest denominiated amount
(e.g. if .units is BTC, .amount will be satoshis; if .units is STACKS,
.amount will be microStacks)</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-private">
<a name="getnamespacepricev1" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagPrivate">Private</span> get<wbr>Namespace<wbr>Price<wbr>V1</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-private">
<li class="tsd-signature tsd-kind-icon">get<wbr>Namespace<wbr>Price<wbr>V1<span class="tsd-signature-symbol">(</span>namespaceID<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="blockstacknetwork.html">BlockstackNetwork</a>.<a href="blockstacknetwork.html#getnamespacepricev1">getNamespacePriceV1</a></p>
<ul>
<li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/f9be48c/src/network.ts#L131">network.ts:131</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Get the price of a namespace via the legacy /v1/prices API endpoint.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>namespaceID: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>the namespace to query</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">&gt;</span></h4>
<p>a promise to an Object with { units: String, amount: BigInteger }</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-private">
<a name="getnamespacepricev2" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagPrivate">Private</span> get<wbr>Namespace<wbr>Price<wbr>V2</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-private">
<li class="tsd-signature tsd-kind-icon">get<wbr>Namespace<wbr>Price<wbr>V2<span class="tsd-signature-symbol">(</span>namespaceID<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="blockstacknetwork.html">BlockstackNetwork</a>.<a href="blockstacknetwork.html#getnamespacepricev2">getNamespacePriceV2</a></p>
<ul>
<li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/f9be48c/src/network.ts#L200">network.ts:200</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Get the price of a namespace via the /v2/prices API endpoint.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>namespaceID: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>the namespace to query</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">&gt;</span></h4>
<p>a promise to an Object with { units: String, amount: BigInteger }</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="getnetworkedutxos" class="tsd-anchor"></a>
<h3>get<wbr>NetworkedUTXOs</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">get<wbr>NetworkedUTXOs<span class="tsd-signature-symbol">(</span>address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol">&lt;</span><a href="../index.html#utxo" class="tsd-signature-type">UTXO</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="blockstacknetwork.html">BlockstackNetwork</a>.<a href="blockstacknetwork.html#getnetworkedutxos">getNetworkedUTXOs</a></p>
<ul>
<li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/f9be48c/src/network.ts#L897">network.ts:897</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>address: <span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol">&lt;</span><a href="../index.html#utxo" class="tsd-signature-type">UTXO</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="gettransactioninfo" class="tsd-anchor"></a>
<h3>get<wbr>Transaction<wbr>Info</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">get<wbr>Transaction<wbr>Info<span class="tsd-signature-symbol">(</span>txHash<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="blockstacknetwork.html">BlockstackNetwork</a>.<a href="blockstacknetwork.html#gettransactioninfo">getTransactionInfo</a></p>
<ul>
<li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/f9be48c/src/network.ts#L889">network.ts:889</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>txHash: <span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="getutxos" class="tsd-anchor"></a>
<h3>getUTXOs</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">getUTXOs<span class="tsd-signature-symbol">(</span>address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol">&lt;</span><a href="../index.html#utxo" class="tsd-signature-type">UTXO</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="blockstacknetwork.html">BlockstackNetwork</a>.<a href="blockstacknetwork.html#getutxos">getUTXOs</a></p>
<ul>
<li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/f9be48c/src/network.ts#L797">network.ts:797</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>address: <span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol">&lt;</span><a href="../index.html#utxo" class="tsd-signature-type">UTXO</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="getzonefile" class="tsd-anchor"></a>
<h3>get<wbr>Zonefile</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">get<wbr>Zonefile<span class="tsd-signature-symbol">(</span>zonefileHash<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="blockstacknetwork.html">BlockstackNetwork</a>.<a href="blockstacknetwork.html#getzonefile">getZonefile</a></p>
<ul>
<li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/f9be48c/src/network.ts#L381">network.ts:381</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Get a zone file, given its hash. Throws an exception if the zone file
obtained does not match the hash.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>zonefileHash: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>the ripemd160(sha256) hash of the zone file</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></h4>
<p>a promise that resolves to the zone file&#39;s text</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-private">
<a name="modifyutxosetfrom" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagPrivate">Private</span> modifyUTXOSet<wbr>From</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-private">
<li class="tsd-signature tsd-kind-icon">modifyUTXOSet<wbr>From<span class="tsd-signature-symbol">(</span>txHex<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="blockstacknetwork.html">BlockstackNetwork</a>.<a href="blockstacknetwork.html#modifyutxosetfrom">modifyUTXOSetFrom</a></p>
<ul>
<li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/f9be48c/src/network.ts#L830">network.ts:830</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>This will modify the network&#39;s utxo set to include UTXOs
from the given transaction and exclude UTXOs <em>spent</em> in
that transaction</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>txHex: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>the hex-encoded transaction to use</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
<p>no return value, this modifies the UTXO config state</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="resetutxos" class="tsd-anchor"></a>
<h3>resetUTXOs</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">resetUTXOs<span class="tsd-signature-symbol">(</span>address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="blockstacknetwork.html">BlockstackNetwork</a>.<a href="blockstacknetwork.html#resetutxos">resetUTXOs</a></p>
<ul>
<li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/f9be48c/src/network.ts#L878">network.ts:878</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>address: <span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class="globals ">
<a href="../index.html"><em>Globals</em></a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-class">
<a href="localregtest.html" class="tsd-kind-icon">Local<wbr>Regtest</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite">
<a href="localregtest.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a href="localregtest.html#dust_minimum" class="tsd-kind-icon">DUST_<wbr>MINIMUM</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a href="localregtest.html#magic_bytes" class="tsd-kind-icon">MAGIC_<wbr>BYTES</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a href="localregtest.html#blockstackapiurl" class="tsd-kind-icon">blockstackAPIUrl</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a href="localregtest.html#broadcastserviceurl" class="tsd-kind-icon">broadcast<wbr>Service<wbr>Url</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a href="localregtest.html#btc" class="tsd-kind-icon">btc</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a href="localregtest.html#excludeutxoset" class="tsd-kind-icon">exclude<wbr>Utxo<wbr>Set</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a href="localregtest.html#includeutxomap" class="tsd-kind-icon">include<wbr>Utxo<wbr>Map</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a href="localregtest.html#layer1" class="tsd-kind-icon">layer1</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-private">
<a href="localregtest.html#broadcastnameregistration" class="tsd-kind-icon">broadcast<wbr>Name<wbr>Registration</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-private">
<a href="localregtest.html#broadcastservicefetchhelper" class="tsd-kind-icon">broadcast<wbr>Service<wbr>Fetch<wbr>Helper</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-private">
<a href="localregtest.html#broadcasttransaction" class="tsd-kind-icon">broadcast<wbr>Transaction</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-private">
<a href="localregtest.html#broadcastzonefile" class="tsd-kind-icon">broadcast<wbr>Zone<wbr>File</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="localregtest.html#coerceaddress" class="tsd-kind-icon">coerce<wbr>Address</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="localregtest.html#countdustoutputs" class="tsd-kind-icon">count<wbr>Dust<wbr>Outputs</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="localregtest.html#getaccountat" class="tsd-kind-icon">get<wbr>Account<wbr>At</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="localregtest.html#getaccountbalance" class="tsd-kind-icon">get<wbr>Account<wbr>Balance</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="localregtest.html#getaccounthistorypage" class="tsd-kind-icon">get<wbr>Account<wbr>History<wbr>Page</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="localregtest.html#getaccountstatus" class="tsd-kind-icon">get<wbr>Account<wbr>Status</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="localregtest.html#getaccounttokens" class="tsd-kind-icon">get<wbr>Account<wbr>Tokens</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="localregtest.html#getblockheight" class="tsd-kind-icon">get<wbr>Block<wbr>Height</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="localregtest.html#getconsensushash" class="tsd-kind-icon">get<wbr>Consensus<wbr>Hash</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="localregtest.html#getdefaultburnaddress" class="tsd-kind-icon">get<wbr>Default<wbr>Burn<wbr>Address</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-overwrite">
<a href="localregtest.html#getfeerate" class="tsd-kind-icon">get<wbr>Fee<wbr>Rate</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="localregtest.html#getgraceperiod" class="tsd-kind-icon">get<wbr>Grace<wbr>Period</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="localregtest.html#getnameinfo" class="tsd-kind-icon">get<wbr>Name<wbr>Info</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="localregtest.html#getnameprice" class="tsd-kind-icon">get<wbr>Name<wbr>Price</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-private">
<a href="localregtest.html#getnamepricev1" class="tsd-kind-icon">get<wbr>Name<wbr>Price<wbr>V1</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-private">
<a href="localregtest.html#getnamepricev2" class="tsd-kind-icon">get<wbr>Name<wbr>Price<wbr>V2</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="localregtest.html#getnamesowned" class="tsd-kind-icon">get<wbr>Names<wbr>Owned</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="localregtest.html#getnamespaceburnaddress" class="tsd-kind-icon">get<wbr>Namespace<wbr>Burn<wbr>Address</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="localregtest.html#getnamespaceinfo" class="tsd-kind-icon">get<wbr>Namespace<wbr>Info</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="localregtest.html#getnamespaceprice" class="tsd-kind-icon">get<wbr>Namespace<wbr>Price</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-private">
<a href="localregtest.html#getnamespacepricev1" class="tsd-kind-icon">get<wbr>Namespace<wbr>Price<wbr>V1</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-private">
<a href="localregtest.html#getnamespacepricev2" class="tsd-kind-icon">get<wbr>Namespace<wbr>Price<wbr>V2</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="localregtest.html#getnetworkedutxos" class="tsd-kind-icon">get<wbr>NetworkedUTXOs</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="localregtest.html#gettransactioninfo" class="tsd-kind-icon">get<wbr>Transaction<wbr>Info</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="localregtest.html#getutxos" class="tsd-kind-icon">getUTXOs</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="localregtest.html#getzonefile" class="tsd-kind-icon">get<wbr>Zonefile</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-private">
<a href="localregtest.html#modifyutxosetfrom" class="tsd-kind-icon">modifyUTXOSet<wbr>From</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="localregtest.html#resetutxos" class="tsd-kind-icon">resetUTXOs</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
</ul>
</nav>
</div>
</div>
</div>
<footer class="with-border-bottom">
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
</div>
</div>
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
</body>
</html>