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

396 lines
19 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>PoxInfo | 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.poxinfo.html">PoxInfo</a>
</li>
</ul>
<h1>Interface PoxInfo</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">PoxInfo</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>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="stacking.poxinfo.html#contract_id" class="tsd-kind-icon">contract_<wbr>id</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="stacking.poxinfo.html#first_burnchain_block_height" class="tsd-kind-icon">first_<wbr>burnchain_<wbr>block_<wbr>height</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="stacking.poxinfo.html#min_amount_ustx" class="tsd-kind-icon">min_<wbr>amount_<wbr>ustx</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="stacking.poxinfo.html#registration_window_length" class="tsd-kind-icon">registration_<wbr>window_<wbr>length</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="stacking.poxinfo.html#rejection_fraction" class="tsd-kind-icon">rejection_<wbr>fraction</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="stacking.poxinfo.html#rejection_votes_left_required" class="tsd-kind-icon">rejection_<wbr>votes_<wbr>left_<wbr>required</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="stacking.poxinfo.html#reward_cycle_id" class="tsd-kind-icon">reward_<wbr>cycle_<wbr>id</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="stacking.poxinfo.html#reward_cycle_length" class="tsd-kind-icon">reward_<wbr>cycle_<wbr>length</a></li>
</ul>
</section>
</div>
</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-interface">
<a name="contract_id" class="tsd-anchor"></a>
<h3>contract_<wbr>id</h3>
<div class="tsd-signature tsd-kind-icon">contract_<wbr>id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/stacking/src/index.ts#L34">packages/stacking/src/index.ts:34</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="first_burnchain_block_height" class="tsd-anchor"></a>
<h3>first_<wbr>burnchain_<wbr>block_<wbr>height</h3>
<div class="tsd-signature tsd-kind-icon">first_<wbr>burnchain_<wbr>block_<wbr>height<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/stacking/src/index.ts#L35">packages/stacking/src/index.ts:35</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="min_amount_ustx" class="tsd-anchor"></a>
<h3>min_<wbr>amount_<wbr>ustx</h3>
<div class="tsd-signature tsd-kind-icon">min_<wbr>amount_<wbr>ustx<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/stacking/src/index.ts#L36">packages/stacking/src/index.ts:36</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="registration_window_length" class="tsd-anchor"></a>
<h3>registration_<wbr>window_<wbr>length</h3>
<div class="tsd-signature tsd-kind-icon">registration_<wbr>window_<wbr>length<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">250</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/stacking/src/index.ts#L37">packages/stacking/src/index.ts:37</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="rejection_fraction" class="tsd-anchor"></a>
<h3>rejection_<wbr>fraction</h3>
<div class="tsd-signature tsd-kind-icon">rejection_<wbr>fraction<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/stacking/src/index.ts#L38">packages/stacking/src/index.ts:38</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="rejection_votes_left_required" class="tsd-anchor"></a>
<h3>rejection_<wbr>votes_<wbr>left_<wbr>required</h3>
<div class="tsd-signature tsd-kind-icon">rejection_<wbr>votes_<wbr>left_<wbr>required<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/stacking/src/index.ts#L41">packages/stacking/src/index.ts:41</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="reward_cycle_id" class="tsd-anchor"></a>
<h3>reward_<wbr>cycle_<wbr>id</h3>
<div class="tsd-signature tsd-kind-icon">reward_<wbr>cycle_<wbr>id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/stacking/src/index.ts#L39">packages/stacking/src/index.ts:39</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="reward_cycle_length" class="tsd-anchor"></a>
<h3>reward_<wbr>cycle_<wbr>length</h3>
<div class="tsd-signature tsd-kind-icon">reward_<wbr>cycle_<wbr>length<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/stacking/src/index.ts#L40">packages/stacking/src/index.ts:40</a></li>
</ul>
</aside>
</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="../classes/stacking.invalidaddresserror.html" class="tsd-kind-icon">Invalid<wbr>Address<wbr>Error</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-module">
<a href="../classes/stacking.stackingclient.html" class="tsd-kind-icon">Stacking<wbr>Client</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="stacking.balanceinfo.html" class="tsd-kind-icon">Balance<wbr>Info</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="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="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="stacking.coreinfo.html" class="tsd-kind-icon">Core<wbr>Info</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="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="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="stacking.lockstxoptions.html" class="tsd-kind-icon">Lock<wbr>Stx<wbr>Options</a>
</li>
<li class="current tsd-kind-interface tsd-parent-kind-module">
<a href="stacking.poxinfo.html" class="tsd-kind-icon">Pox<wbr>Info</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="stacking.poxinfo.html#contract_id" class="tsd-kind-icon">contract_<wbr>id</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="stacking.poxinfo.html#first_burnchain_block_height" class="tsd-kind-icon">first_<wbr>burnchain_<wbr>block_<wbr>height</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="stacking.poxinfo.html#min_amount_ustx" class="tsd-kind-icon">min_<wbr>amount_<wbr>ustx</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="stacking.poxinfo.html#registration_window_length" class="tsd-kind-icon">registration_<wbr>window_<wbr>length</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="stacking.poxinfo.html#rejection_fraction" class="tsd-kind-icon">rejection_<wbr>fraction</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="stacking.poxinfo.html#rejection_votes_left_required" class="tsd-kind-icon">rejection_<wbr>votes_<wbr>left_<wbr>required</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="stacking.poxinfo.html#reward_cycle_id" class="tsd-kind-icon">reward_<wbr>cycle_<wbr>id</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="stacking.poxinfo.html#reward_cycle_length" class="tsd-kind-icon">reward_<wbr>cycle_<wbr>length</a>
</li>
</ul>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="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="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-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-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
</ul>
</div>
</div>
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink