kylefang/stacks.js
1
0
Fork 0
mirror of https://github.com/alexgo-io/stacks.js.git synced 2026-06-12 00:54:46 +08:00
Code Issues Packages Projects Releases Wiki Activity
Files
v3
stacks.js/docs/classes/stacking.stackingclient.html
Alexander Graebe f572477ca0 feat: add regtest to list of available networks 
fixes #1041
2021-06-28 10:27:07 -07:00

1096 lines
72 KiB
HTML
Vendored
Raw Permalink Blame History

<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>StackingClient | Stacks.js 1.4.1 Library Reference</title>
<meta name="description" content="Documentation for Stacks.js 1.4.1 Library Reference">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">Stacks.js 1.4.1 Library Reference</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">Stacks.js 1.4.1 Library Reference</a>
</li>
<li>
<a href="../modules/stacking.html">stacking</a>
</li>
<li>
<a href="stacking.stackingclient.html">StackingClient</a>
</li>
</ul>
<h1>Class StackingClient</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>
<span class="target">StackingClient</span>
</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"><a href="stacking.stackingclient.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-class"><a href="stacking.stackingclient.html#address" class="tsd-kind-icon">address</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="stacking.stackingclient.html#network" class="tsd-kind-icon">network</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"><a href="stacking.stackingclient.html#canstack" class="tsd-kind-icon">can<wbr>Stack</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="stacking.stackingclient.html#delegatestackstx" class="tsd-kind-icon">delegate<wbr>Stack<wbr>Stx</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="stacking.stackingclient.html#delegatestx" class="tsd-kind-icon">delegate<wbr>Stx</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="stacking.stackingclient.html#getaccountbalance" class="tsd-kind-icon">get<wbr>Account<wbr>Balance</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="stacking.stackingclient.html#getaccountstatus" class="tsd-kind-icon">get<wbr>Account<wbr>Status</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="stacking.stackingclient.html#getcoreinfo" class="tsd-kind-icon">get<wbr>Core<wbr>Info</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="stacking.stackingclient.html#getcycleduration" class="tsd-kind-icon">get<wbr>Cycle<wbr>Duration</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="stacking.stackingclient.html#getdelegateoptions" class="tsd-kind-icon">get<wbr>Delegate<wbr>Options</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="stacking.stackingclient.html#getdelegatestackoptions" class="tsd-kind-icon">get<wbr>Delegate<wbr>Stack<wbr>Options</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="stacking.stackingclient.html#getpoxinfo" class="tsd-kind-icon">get<wbr>Pox<wbr>Info</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="stacking.stackingclient.html#getrevokedelegatestxoptions" class="tsd-kind-icon">get<wbr>Revoke<wbr>Delegate<wbr>Stx<wbr>Options</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="stacking.stackingclient.html#getsecondsuntilnextcycle" class="tsd-kind-icon">get<wbr>Seconds<wbr>Until<wbr>Next<wbr>Cycle</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="stacking.stackingclient.html#getstackaggregationcommitoptions" class="tsd-kind-icon">get<wbr>Stack<wbr>Aggregation<wbr>Commit<wbr>Options</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="stacking.stackingclient.html#getstackoptions" class="tsd-kind-icon">get<wbr>Stack<wbr>Options</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="stacking.stackingclient.html#getstatus" class="tsd-kind-icon">get<wbr>Status</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="stacking.stackingclient.html#gettargetblocktime" class="tsd-kind-icon">get<wbr>Target<wbr>Block<wbr>Time</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="stacking.stackingclient.html#hasminimumstx" class="tsd-kind-icon">has<wbr>Minimum<wbr>Stx</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="stacking.stackingclient.html#isstackingenablednextcycle" class="tsd-kind-icon">is<wbr>Stacking<wbr>Enabled<wbr>Next<wbr>Cycle</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="stacking.stackingclient.html#modifylocktxfee" class="tsd-kind-icon">modify<wbr>Lock<wbr>TxFee</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="stacking.stackingclient.html#parsecontractid" class="tsd-kind-icon">parse<wbr>Contract<wbr>Id</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="stacking.stackingclient.html#revokedelegatestx" class="tsd-kind-icon">revoke<wbr>Delegate<wbr>Stx</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="stacking.stackingclient.html#stack" class="tsd-kind-icon">stack</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="stacking.stackingclient.html#stackaggregationcommit" class="tsd-kind-icon">stack<wbr>Aggregation<wbr>Commit</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">
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">new <wbr>Stacking<wbr>Client<span class="tsd-signature-symbol">(</span>address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, network<span class="tsd-signature-symbol">: </span><a href="../interfaces/network.stacksnetwork.html" class="tsd-signature-type" data-tsd-kind="Interface">StacksNetwork</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="stacking.stackingclient.html" class="tsd-signature-type" data-tsd-kind="Class">StackingClient</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/stacking/src/index.ts#L158">packages/stacking/src/index.ts:158</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>
<li>
<h5>network: <a href="../interfaces/network.stacksnetwork.html" class="tsd-signature-type" data-tsd-kind="Interface">StacksNetwork</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="stacking.stackingclient.html" class="tsd-signature-type" data-tsd-kind="Class">StackingClient</a></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="address" class="tsd-anchor"></a>
<h3>address</h3>
<div class="tsd-signature tsd-kind-icon">address<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="network" class="tsd-anchor"></a>
<h3>network</h3>
<div class="tsd-signature tsd-kind-icon">network<span class="tsd-signature-symbol">:</span> <a href="../interfaces/network.stacksnetwork.html" class="tsd-signature-type" data-tsd-kind="Interface">StacksNetwork</a></div>
<aside class="tsd-sources">
</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">
<a name="canstack" class="tsd-anchor"></a>
<h3>can<wbr>Stack</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">can<wbr>Stack<span class="tsd-signature-symbol">(</span>__namedParameters<span class="tsd-signature-symbol">: </span><a href="../interfaces/stacking.canlockstxoptions.html" class="tsd-signature-type" data-tsd-kind="Interface">CanLockStxOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/stacking.stackingeligibility.html" class="tsd-signature-type" data-tsd-kind="Interface">StackingEligibility</a><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/stacking/src/index.ts#L281">packages/stacking/src/index.ts:281</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Check if account can lock stx</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>__namedParameters: <a href="../interfaces/stacking.canlockstxoptions.html" class="tsd-signature-type" data-tsd-kind="Interface">CanLockStxOptions</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/stacking.stackingeligibility.html" class="tsd-signature-type" data-tsd-kind="Interface">StackingEligibility</a><span class="tsd-signature-symbol">&gt;</span></h4>
<p>that resolves to a StackingEligibility object if the operation succeeds</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="delegatestackstx" class="tsd-anchor"></a>
<h3>delegate<wbr>Stack<wbr>Stx</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">delegate<wbr>Stack<wbr>Stx<span class="tsd-signature-symbol">(</span>__namedParameters<span class="tsd-signature-symbol">: </span><a href="../interfaces/stacking.delegatestackstxoptions.html" class="tsd-signature-type" data-tsd-kind="Interface">DelegateStackStxOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../modules/transactions.html#txbroadcastresult" class="tsd-signature-type" data-tsd-kind="Type alias">TxBroadcastResult</a><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/stacking/src/index.ts#L398">packages/stacking/src/index.ts:398</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>As a delegator, generate and broadcast transactions to stack for multiple delegatees. This will lock up tokens owned by the delegatees.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>__namedParameters: <a href="../interfaces/stacking.delegatestackstxoptions.html" class="tsd-signature-type" data-tsd-kind="Interface">DelegateStackStxOptions</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../modules/transactions.html#txbroadcastresult" class="tsd-signature-type" data-tsd-kind="Type alias">TxBroadcastResult</a><span class="tsd-signature-symbol">&gt;</span></h4>
<p>that resolves to a broadcasted txid if the operation succeeds</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="delegatestx" class="tsd-anchor"></a>
<h3>delegate<wbr>Stx</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">delegate<wbr>Stx<span class="tsd-signature-symbol">(</span>__namedParameters<span class="tsd-signature-symbol">: </span><a href="../interfaces/stacking.delegatestxoptions.html" class="tsd-signature-type" data-tsd-kind="Interface">DelegateStxOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../modules/transactions.html#txbroadcastresult" class="tsd-signature-type" data-tsd-kind="Type alias">TxBroadcastResult</a><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/stacking/src/index.ts#L365">packages/stacking/src/index.ts:365</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>As a delegatee, generate and broadcast a transaction to create a delegation relationship</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>__namedParameters: <a href="../interfaces/stacking.delegatestxoptions.html" class="tsd-signature-type" data-tsd-kind="Interface">DelegateStxOptions</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../modules/transactions.html#txbroadcastresult" class="tsd-signature-type" data-tsd-kind="Type alias">TxBroadcastResult</a><span class="tsd-signature-symbol">&gt;</span></h4>
<p>that resolves to a broadcasted txid if the operation succeeds</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<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">
<li class="tsd-signature tsd-kind-icon">get<wbr>Account<wbr>Balance<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">BN</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/stacking/src/index.ts#L207">packages/stacking/src/index.ts:207</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Get account balance</p>
</div>
</div>
<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>that resolves to a BigNum if the operation succeeds</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<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">
<li class="tsd-signature tsd-kind-icon">get<wbr>Account<wbr>Status<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">
<ul>
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/stacking/src/index.ts#L197">packages/stacking/src/index.ts:197</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">
<a name="getcoreinfo" class="tsd-anchor"></a>
<h3>get<wbr>Core<wbr>Info</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Core<wbr>Info<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/stacking.coreinfo.html" class="tsd-signature-type" data-tsd-kind="Interface">CoreInfo</a><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/stacking/src/index.ts#L166">packages/stacking/src/index.ts:166</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Get stacks node info</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/stacking.coreinfo.html" class="tsd-signature-type" data-tsd-kind="Interface">CoreInfo</a><span class="tsd-signature-symbol">&gt;</span></h4>
<p>that resolves to a CoreInfo response if the operation succeeds</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="getcycleduration" class="tsd-anchor"></a>
<h3>get<wbr>Cycle<wbr>Duration</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Cycle<wbr>Duration<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">
<ul>
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/stacking/src/index.ts#L222">packages/stacking/src/index.ts:222</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Get reward cycle duration in seconds</p>
</div>
</div>
<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>that resolves to a number if the operation succeeds</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="getdelegateoptions" class="tsd-anchor"></a>
<h3>get<wbr>Delegate<wbr>Options</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Delegate<wbr>Options<span class="tsd-signature-symbol">(</span>__namedParameters<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>amountMicroStx<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BN</span><span class="tsd-signature-symbol">; </span>contract<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>delegateTo<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>poxAddress<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>untilBurnBlockHeight<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-symbol">: </span><a href="../interfaces/transactions.contractcalloptions.html" class="tsd-signature-type" data-tsd-kind="Interface">ContractCallOptions</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/stacking/src/index.ts#L516">packages/stacking/src/index.ts:516</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>__namedParameters: <span class="tsd-signature-symbol">{ </span>amountMicroStx<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BN</span><span class="tsd-signature-symbol">; </span>contract<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>delegateTo<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>poxAddress<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>untilBurnBlockHeight<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span></h5>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5>amount<wbr>Micro<wbr>Stx<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BN</span></h5>
</li>
<li class="tsd-parameter">
<h5>contract<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
</li>
<li class="tsd-parameter">
<h5>delegate<wbr>To<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
</li>
<li class="tsd-parameter">
<h5><span class="tsd-flag ts-flagOptional">Optional</span> pox<wbr>Address<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5>
</li>
<li class="tsd-parameter">
<h5><span class="tsd-flag ts-flagOptional">Optional</span> until<wbr>Burn<wbr>Block<wbr>Height<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5>
</li>
</ul>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="../interfaces/transactions.contractcalloptions.html" class="tsd-signature-type" data-tsd-kind="Interface">ContractCallOptions</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="getdelegatestackoptions" class="tsd-anchor"></a>
<h3>get<wbr>Delegate<wbr>Stack<wbr>Options</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Delegate<wbr>Stack<wbr>Options<span class="tsd-signature-symbol">(</span>__namedParameters<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>amountMicroStx<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BN</span><span class="tsd-signature-symbol">; </span>burnBlockHeight<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>contract<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>cycles<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>nonce<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">BN</span><span class="tsd-signature-symbol">; </span>poxAddress<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>stacker<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/transactions.contractcalloptions.html" class="tsd-signature-type" data-tsd-kind="Interface">ContractCallOptions</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/stacking/src/index.ts#L562">packages/stacking/src/index.ts:562</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>__namedParameters: <span class="tsd-signature-symbol">{ </span>amountMicroStx<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BN</span><span class="tsd-signature-symbol">; </span>burnBlockHeight<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>contract<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>cycles<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>nonce<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">BN</span><span class="tsd-signature-symbol">; </span>poxAddress<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>stacker<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></h5>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5>amount<wbr>Micro<wbr>Stx<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BN</span></h5>
</li>
<li class="tsd-parameter">
<h5>burn<wbr>Block<wbr>Height<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
</li>
<li class="tsd-parameter">
<h5>contract<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
</li>
<li class="tsd-parameter">
<h5>cycles<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
</li>
<li class="tsd-parameter">
<h5><span class="tsd-flag ts-flagOptional">Optional</span> nonce<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">BN</span></h5>
</li>
<li class="tsd-parameter">
<h5>pox<wbr>Address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
</li>
<li class="tsd-parameter">
<h5>stacker<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
</li>
</ul>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="../interfaces/transactions.contractcalloptions.html" class="tsd-signature-type" data-tsd-kind="Interface">ContractCallOptions</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="getpoxinfo" class="tsd-anchor"></a>
<h3>get<wbr>Pox<wbr>Info</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Pox<wbr>Info<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/stacking.poxinfo.html" class="tsd-signature-type" data-tsd-kind="Interface">PoxInfo</a><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/stacking/src/index.ts#L176">packages/stacking/src/index.ts:176</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Get stacks node pox info</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/stacking.poxinfo.html" class="tsd-signature-type" data-tsd-kind="Interface">PoxInfo</a><span class="tsd-signature-symbol">&gt;</span></h4>
<p>that resolves to a PoxInfo response if the operation succeeds</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="getrevokedelegatestxoptions" class="tsd-anchor"></a>
<h3>get<wbr>Revoke<wbr>Delegate<wbr>Stx<wbr>Options</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Revoke<wbr>Delegate<wbr>Stx<wbr>Options<span class="tsd-signature-symbol">(</span>contract<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><a href="../interfaces/transactions.contractcalloptions.html" class="tsd-signature-type" data-tsd-kind="Interface">ContractCallOptions</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/stacking/src/index.ts#L643">packages/stacking/src/index.ts:643</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>contract: <span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="../interfaces/transactions.contractcalloptions.html" class="tsd-signature-type" data-tsd-kind="Interface">ContractCallOptions</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="getsecondsuntilnextcycle" class="tsd-anchor"></a>
<h3>get<wbr>Seconds<wbr>Until<wbr>Next<wbr>Cycle</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Seconds<wbr>Until<wbr>Next<wbr>Cycle<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">
<ul>
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/stacking/src/index.ts#L238">packages/stacking/src/index.ts:238</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Get number of seconds until next reward cycle</p>
</div>
</div>
<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>that resolves to a number if the operation succeeds</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="getstackaggregationcommitoptions" class="tsd-anchor"></a>
<h3>get<wbr>Stack<wbr>Aggregation<wbr>Commit<wbr>Options</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Stack<wbr>Aggregation<wbr>Commit<wbr>Options<span class="tsd-signature-symbol">(</span>__namedParameters<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>contract<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>poxAddress<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>rewardCycle<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-symbol">: </span><a href="../interfaces/transactions.contractcalloptions.html" class="tsd-signature-type" data-tsd-kind="Interface">ContractCallOptions</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/stacking/src/index.ts#L612">packages/stacking/src/index.ts:612</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>__namedParameters: <span class="tsd-signature-symbol">{ </span>contract<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>poxAddress<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>rewardCycle<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span></h5>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5>contract<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
</li>
<li class="tsd-parameter">
<h5>pox<wbr>Address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
</li>
<li class="tsd-parameter">
<h5>reward<wbr>Cycle<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
</li>
</ul>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="../interfaces/transactions.contractcalloptions.html" class="tsd-signature-type" data-tsd-kind="Interface">ContractCallOptions</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="getstackoptions" class="tsd-anchor"></a>
<h3>get<wbr>Stack<wbr>Options</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Stack<wbr>Options<span class="tsd-signature-symbol">(</span>__namedParameters<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>amountMicroStx<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BN</span><span class="tsd-signature-symbol">; </span>burnBlockHeight<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>contract<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>cycles<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>poxAddress<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/transactions.contractcalloptions.html" class="tsd-signature-type" data-tsd-kind="Interface">ContractCallOptions</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/stacking/src/index.ts#L476">packages/stacking/src/index.ts:476</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>__namedParameters: <span class="tsd-signature-symbol">{ </span>amountMicroStx<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BN</span><span class="tsd-signature-symbol">; </span>burnBlockHeight<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>contract<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>cycles<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>poxAddress<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></h5>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5>amount<wbr>Micro<wbr>Stx<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BN</span></h5>
</li>
<li class="tsd-parameter">
<h5>burn<wbr>Block<wbr>Height<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
</li>
<li class="tsd-parameter">
<h5>contract<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
</li>
<li class="tsd-parameter">
<h5>cycles<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
</li>
<li class="tsd-parameter">
<h5>pox<wbr>Address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
</li>
</ul>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="../interfaces/transactions.contractcalloptions.html" class="tsd-signature-type" data-tsd-kind="Interface">ContractCallOptions</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="getstatus" class="tsd-anchor"></a>
<h3>get<wbr>Status</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Status<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../modules/stacking.html#stackerinfo" class="tsd-signature-type" data-tsd-kind="Type alias">StackerInfo</a><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/stacking/src/index.ts#L663">packages/stacking/src/index.ts:663</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Check stacking status</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../modules/stacking.html#stackerinfo" class="tsd-signature-type" data-tsd-kind="Type alias">StackerInfo</a><span class="tsd-signature-symbol">&gt;</span></h4>
<p>that resolves to a StackerInfo object if the operation succeeds</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="gettargetblocktime" class="tsd-anchor"></a>
<h3>get<wbr>Target<wbr>Block<wbr>Time</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Target<wbr>Block<wbr>Time<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">
<ul>
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/stacking/src/index.ts#L186">packages/stacking/src/index.ts:186</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Get stacks node target block time</p>
</div>
</div>
<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>that resolves to a number if the operation succeeds</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="hasminimumstx" class="tsd-anchor"></a>
<h3>has<wbr>Minimum<wbr>Stx</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">has<wbr>Minimum<wbr>Stx<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">boolean</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/stacking/src/index.ts#L268">packages/stacking/src/index.ts:268</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Check if account has minimum require amount of Stacks for stacking</p>
</div>
</div>
<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">boolean</span><span class="tsd-signature-symbol">&gt;</span></h4>
<p>that resolves to a bool if the operation succeeds</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="isstackingenablednextcycle" class="tsd-anchor"></a>
<h3>is<wbr>Stacking<wbr>Enabled<wbr>Next<wbr>Cycle</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">is<wbr>Stacking<wbr>Enabled<wbr>Next<wbr>Cycle<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">boolean</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/stacking/src/index.ts#L259">packages/stacking/src/index.ts:259</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Check if stacking is enabled for next reward cycle</p>
</div>
</div>
<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">boolean</span><span class="tsd-signature-symbol">&gt;</span></h4>
<p>that resolves to a bool if the operation succeeds</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="modifylocktxfee" class="tsd-anchor"></a>
<h3>modify<wbr>Lock<wbr>TxFee</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">modify<wbr>Lock<wbr>TxFee<span class="tsd-signature-symbol">(</span>__namedParameters<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>amountMicroStx<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BN</span><span class="tsd-signature-symbol">; </span>tx<span class="tsd-signature-symbol">: </span><a href="transactions.stackstransaction.html" class="tsd-signature-type" data-tsd-kind="Class">StacksTransaction</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="transactions.stackstransaction.html" class="tsd-signature-type" data-tsd-kind="Class">StacksTransaction</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/stacking/src/index.ts#L715">packages/stacking/src/index.ts:715</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Adjust microstacks amount for locking after taking into account transaction fees</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>__namedParameters: <span class="tsd-signature-symbol">{ </span>amountMicroStx<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BN</span><span class="tsd-signature-symbol">; </span>tx<span class="tsd-signature-symbol">: </span><a href="transactions.stackstransaction.html" class="tsd-signature-type" data-tsd-kind="Class">StacksTransaction</a><span class="tsd-signature-symbol"> }</span></h5>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5>amount<wbr>Micro<wbr>Stx<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BN</span></h5>
</li>
<li class="tsd-parameter">
<h5>tx<span class="tsd-signature-symbol">: </span><a href="transactions.stackstransaction.html" class="tsd-signature-type" data-tsd-kind="Class">StacksTransaction</a></h5>
</li>
</ul>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="transactions.stackstransaction.html" class="tsd-signature-type" data-tsd-kind="Class">StacksTransaction</a></h4>
<p>that resolves to a transaction object if the operation succeeds</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="parsecontractid" class="tsd-anchor"></a>
<h3>parse<wbr>Contract<wbr>Id</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">parse<wbr>Contract<wbr>Id<span class="tsd-signature-symbol">(</span>contract<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><span class="tsd-signature-symbol">[]</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/stacking/src/index.ts#L728">packages/stacking/src/index.ts:728</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Parses a contract identifier and ensures it is formatted correctly</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>contract: <span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4>
<p>a contract address and name</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="revokedelegatestx" class="tsd-anchor"></a>
<h3>revoke<wbr>Delegate<wbr>Stx</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">revoke<wbr>Delegate<wbr>Stx<span class="tsd-signature-symbol">(</span>privateKey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../modules/transactions.html#txbroadcastresult" class="tsd-signature-type" data-tsd-kind="Type alias">TxBroadcastResult</a><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/stacking/src/index.ts#L462">packages/stacking/src/index.ts:462</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>As a delegatee, generate and broadcast a transaction to terminate the delegation relationship</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>privateKey: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>the private key to be used for the revoke call</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../modules/transactions.html#txbroadcastresult" class="tsd-signature-type" data-tsd-kind="Type alias">TxBroadcastResult</a><span class="tsd-signature-symbol">&gt;</span></h4>
<p>that resolves to a broadcasted txid if the operation succeeds</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="stack" class="tsd-anchor"></a>
<h3>stack</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">stack<span class="tsd-signature-symbol">(</span>__namedParameters<span class="tsd-signature-symbol">: </span><a href="../interfaces/stacking.lockstxoptions.html" class="tsd-signature-type" data-tsd-kind="Interface">LockStxOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../modules/transactions.html#txbroadcastresult" class="tsd-signature-type" data-tsd-kind="Type alias">TxBroadcastResult</a><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/stacking/src/index.ts#L333">packages/stacking/src/index.ts:333</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Generate and broadcast a stacking transaction to lock STX</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>__namedParameters: <a href="../interfaces/stacking.lockstxoptions.html" class="tsd-signature-type" data-tsd-kind="Interface">LockStxOptions</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../modules/transactions.html#txbroadcastresult" class="tsd-signature-type" data-tsd-kind="Type alias">TxBroadcastResult</a><span class="tsd-signature-symbol">&gt;</span></h4>
<p>that resolves to a broadcasted txid if the operation succeeds</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="stackaggregationcommit" class="tsd-anchor"></a>
<h3>stack<wbr>Aggregation<wbr>Commit</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">stack<wbr>Aggregation<wbr>Commit<span class="tsd-signature-symbol">(</span>__namedParameters<span class="tsd-signature-symbol">: </span><a href="../interfaces/stacking.stackaggregationcommitoptions.html" class="tsd-signature-type" data-tsd-kind="Interface">StackAggregationCommitOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../modules/transactions.html#txbroadcastresult" class="tsd-signature-type" data-tsd-kind="Type alias">TxBroadcastResult</a><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/stacking/src/index.ts#L434">packages/stacking/src/index.ts:434</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>As a delegator, generate and broadcast a transaction to commit partially committed delegatee tokens</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>__namedParameters: <a href="../interfaces/stacking.stackaggregationcommitoptions.html" class="tsd-signature-type" data-tsd-kind="Interface">StackAggregationCommitOptions</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../modules/transactions.html#txbroadcastresult" class="tsd-signature-type" data-tsd-kind="Type alias">TxBroadcastResult</a><span class="tsd-signature-symbol">&gt;</span></h4>
<p>that resolves to a broadcasted txid if the operation succeeds</p>
</li>
</ul>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../modules.html">Modules</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/auth.html">auth</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/bns.html">bns</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/cli.html">cli</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/common.html">common</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/encryption.html">encryption</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/keychain.html">keychain</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/network.html">network</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/profile.html">profile</a>
</li>
<li class="current tsd-kind-module">
<a href="../modules/stacking.html">stacking</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/storage.html">storage</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/transactions.html">transactions</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
<li class=" tsd-kind-module">
<a href="../modules/auth.html" class="tsd-kind-icon">auth</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/bns.html" class="tsd-kind-icon">bns</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/cli.html" class="tsd-kind-icon">cli</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/common.html" class="tsd-kind-icon">common</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/encryption.html" class="tsd-kind-icon">encryption</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/keychain.html" class="tsd-kind-icon">keychain</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/network.html" class="tsd-kind-icon">network</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/profile.html" class="tsd-kind-icon">profile</a>
</li>
</ul>
<ul class="current">
<li class="current tsd-kind-module">
<a href="../modules/stacking.html" class="tsd-kind-icon">stacking</a>
<ul>
<li class=" tsd-kind-class tsd-parent-kind-module">
<a href="stacking.invalidaddresserror.html" class="tsd-kind-icon">Invalid<wbr>Address<wbr>Error</a>
</li>
<li class="current tsd-kind-class tsd-parent-kind-module">
<a href="stacking.stackingclient.html" class="tsd-kind-icon">Stacking<wbr>Client</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class">
<a href="stacking.stackingclient.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="stacking.stackingclient.html#address" class="tsd-kind-icon">address</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="stacking.stackingclient.html#network" class="tsd-kind-icon">network</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="stacking.stackingclient.html#canstack" class="tsd-kind-icon">can<wbr>Stack</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="stacking.stackingclient.html#delegatestackstx" class="tsd-kind-icon">delegate<wbr>Stack<wbr>Stx</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="stacking.stackingclient.html#delegatestx" class="tsd-kind-icon">delegate<wbr>Stx</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="stacking.stackingclient.html#getaccountbalance" class="tsd-kind-icon">get<wbr>Account<wbr>Balance</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="stacking.stackingclient.html#getaccountstatus" class="tsd-kind-icon">get<wbr>Account<wbr>Status</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="stacking.stackingclient.html#getcoreinfo" class="tsd-kind-icon">get<wbr>Core<wbr>Info</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="stacking.stackingclient.html#getcycleduration" class="tsd-kind-icon">get<wbr>Cycle<wbr>Duration</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="stacking.stackingclient.html#getdelegateoptions" class="tsd-kind-icon">get<wbr>Delegate<wbr>Options</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="stacking.stackingclient.html#getdelegatestackoptions" class="tsd-kind-icon">get<wbr>Delegate<wbr>Stack<wbr>Options</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="stacking.stackingclient.html#getpoxinfo" class="tsd-kind-icon">get<wbr>Pox<wbr>Info</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="stacking.stackingclient.html#getrevokedelegatestxoptions" class="tsd-kind-icon">get<wbr>Revoke<wbr>Delegate<wbr>Stx<wbr>Options</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="stacking.stackingclient.html#getsecondsuntilnextcycle" class="tsd-kind-icon">get<wbr>Seconds<wbr>Until<wbr>Next<wbr>Cycle</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="stacking.stackingclient.html#getstackaggregationcommitoptions" class="tsd-kind-icon">get<wbr>Stack<wbr>Aggregation<wbr>Commit<wbr>Options</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="stacking.stackingclient.html#getstackoptions" class="tsd-kind-icon">get<wbr>Stack<wbr>Options</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="stacking.stackingclient.html#getstatus" class="tsd-kind-icon">get<wbr>Status</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="stacking.stackingclient.html#gettargetblocktime" class="tsd-kind-icon">get<wbr>Target<wbr>Block<wbr>Time</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="stacking.stackingclient.html#hasminimumstx" class="tsd-kind-icon">has<wbr>Minimum<wbr>Stx</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="stacking.stackingclient.html#isstackingenablednextcycle" class="tsd-kind-icon">is<wbr>Stacking<wbr>Enabled<wbr>Next<wbr>Cycle</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="stacking.stackingclient.html#modifylocktxfee" class="tsd-kind-icon">modify<wbr>Lock<wbr>TxFee</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="stacking.stackingclient.html#parsecontractid" class="tsd-kind-icon">parse<wbr>Contract<wbr>Id</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="stacking.stackingclient.html#revokedelegatestx" class="tsd-kind-icon">revoke<wbr>Delegate<wbr>Stx</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="stacking.stackingclient.html#stack" class="tsd-kind-icon">stack</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="stacking.stackingclient.html#stackaggregationcommit" class="tsd-kind-icon">stack<wbr>Aggregation<wbr>Commit</a>
</li>
</ul>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="../interfaces/stacking.balanceinfo.html" class="tsd-kind-icon">Balance<wbr>Info</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="../interfaces/stacking.blocktimeinfo.html" class="tsd-kind-icon">Block<wbr>Time<wbr>Info</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="../interfaces/stacking.canlockstxoptions.html" class="tsd-kind-icon">Can<wbr>Lock<wbr>Stx<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="../interfaces/stacking.coreinfo.html" class="tsd-kind-icon">Core<wbr>Info</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="../interfaces/stacking.delegatestackstxoptions.html" class="tsd-kind-icon">Delegate<wbr>Stack<wbr>Stx<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="../interfaces/stacking.delegatestxoptions.html" class="tsd-kind-icon">Delegate<wbr>Stx<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="../interfaces/stacking.lockstxoptions.html" class="tsd-kind-icon">Lock<wbr>Stx<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="../interfaces/stacking.poxinfo.html" class="tsd-kind-icon">Pox<wbr>Info</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="../interfaces/stacking.stackaggregationcommitoptions.html" class="tsd-kind-icon">Stack<wbr>Aggregation<wbr>Commit<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="../interfaces/stacking.stackingeligibility.html" class="tsd-kind-icon">Stacking<wbr>Eligibility</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
<a href="../modules/stacking.html#poxaddressargs" class="tsd-kind-icon">Pox<wbr>Address<wbr>Args</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
<a href="../modules/stacking.html#stackerinfo" class="tsd-kind-icon">Stacker<wbr>Info</a>
</li>
<li class=" tsd-kind-variable tsd-parent-kind-module">
<a href="../modules/stacking.html#bitcoinnetworkversion" class="tsd-kind-icon">Bitcoin<wbr>Network<wbr>Version</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-module">
<a href="../modules/stacking.html#btcaddressversiontohashmode" class="tsd-kind-icon">btc<wbr>Address<wbr>Version<wbr>ToHash<wbr>Mode</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-module">
<a href="../modules/stacking.html#decodebtcaddress" class="tsd-kind-icon">decode<wbr>Btc<wbr>Address</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-module">
<a href="../modules/stacking.html#extractpoxaddressfromclarityvalue" class="tsd-kind-icon">extract<wbr>Pox<wbr>Address<wbr>From<wbr>Clarity<wbr>Value</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-module">
<a href="../modules/stacking.html#getaddresshashmode" class="tsd-kind-icon">get<wbr>Address<wbr>Hash<wbr>Mode</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-module">
<a href="../modules/stacking.html#getbtcaddress" class="tsd-kind-icon">getBTCAddress</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-module">
<a href="../modules/stacking.html#geterrorstring" class="tsd-kind-icon">get<wbr>Error<wbr>String</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-module">
<a href="../modules/stacking.html#hashmodetobtcaddressversion" class="tsd-kind-icon">hash<wbr>Mode<wbr>ToBtc<wbr>Address<wbr>Version</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-module">
<a href="../modules/stacking.html#poxaddresstobtcaddress" class="tsd-kind-icon">pox<wbr>Address<wbr>ToBtc<wbr>Address</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
<li class=" tsd-kind-module">
<a href="../modules/storage.html" class="tsd-kind-icon">storage</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/transactions.html" class="tsd-kind-icon">transactions</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<footer class="with-border-bottom">
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
<li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</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>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
</ul>
</div>
</div>
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink