Skip to content

Commit

Permalink
docs: rebuild docs
Browse files Browse the repository at this point in the history
  • Loading branch information
yknl committed Nov 20, 2020
1 parent ca4d596 commit faa8172
Show file tree
Hide file tree
Showing 18 changed files with 12,079 additions and 4,775 deletions.
2 changes: 1 addition & 1 deletion docs/assets/js/search.json

Large diffs are not rendered by default.

661 changes: 661 additions & 0 deletions docs/classes/stackingclient.html

Large diffs are not rendered by default.

143 changes: 129 additions & 14 deletions docs/classes/stacksmainnet.html

Large diffs are not rendered by default.

148 changes: 134 additions & 14 deletions docs/classes/stacksmocknet.html

Large diffs are not rendered by default.

150 changes: 135 additions & 15 deletions docs/classes/stackstestnet.html

Large diffs are not rendered by default.

13,396 changes: 8,671 additions & 4,725 deletions docs/docs.json

Large diffs are not rendered by default.

405 changes: 405 additions & 0 deletions docs/enums/stackingerrors.html

Large diffs are not rendered by default.

159 changes: 159 additions & 0 deletions docs/globals.html

Large diffs are not rendered by default.

43 changes: 43 additions & 0 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,7 @@ <h1>Stacks.js Monorepo <a href="https://circleci.com/gh/blockstack/blockstack.js
<li><a href="https://github.com/blockstack/stacks.js/tree/master/packages/storage"><code>@stacks/storage</code></a> Store and fetch files with Gaia, the decentralized storage system.</li>
<li><a href="https://github.com/blockstack/stacks.js/tree/master/packages/transactions"><code>@stacks/transactions</code></a> Construct, decode transactions and work with Clarity smart contracts on the Stacks blockchain.</li>
<li><a href="https://github.com/blockstack/stacks.js/tree/master/packages/cli"><code>@stacks/cli</code></a> Command line interface to interact with auth, storage and Stacks transactions.</li>
<li><a href="https://github.com/blockstack/stacks.js/tree/master/packages/stacking"><code>@stacks/stacking</code></a> Library for PoX stacking.</li>
<li><a href="https://github.com/blockstack/stacks.js/tree/master/packages/keychain"><code>@stacks/keychain</code></a> Create and manage keys/wallets for the Stacks blockchain.</li>
<li><a href="https://github.com/blockstack/stacks.js/tree/master/packages/network"><code>@stacks/network</code></a> Network and API library for working with Stacks blockchain nodes.</li>
<li><a href="https://github.com/blockstack/stacks.js/tree/master/packages/encryption"><code>@stacks/encryption</code></a> Encryption functions used by Stacks.js packages.</li>
Expand Down Expand Up @@ -170,6 +171,9 @@ <h2>Contributing</h2>
<li class=" tsd-kind-enum">
<a href="enums/pubkeyencoding.html" class="tsd-kind-icon">Pub<wbr>Key<wbr>Encoding</a>
</li>
<li class=" tsd-kind-enum">
<a href="enums/stackingerrors.html" class="tsd-kind-icon">Stacking<wbr>Errors</a>
</li>
<li class=" tsd-kind-enum">
<a href="enums/stacksmessagetype.html" class="tsd-kind-icon">Stacks<wbr>Message<wbr>Type</a>
</li>
Expand Down Expand Up @@ -263,6 +267,9 @@ <h2>Contributing</h2>
<li class=" tsd-kind-class">
<a href="classes/sponsoredauthorization.html" class="tsd-kind-icon">Sponsored<wbr>Authorization</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/stackingclient.html" class="tsd-kind-icon">Stacking<wbr>Client</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/stacksmainnet.html" class="tsd-kind-icon">Stacks<wbr>Mainnet</a>
</li>
Expand Down Expand Up @@ -329,6 +336,12 @@ <h2>Contributing</h2>
<li class=" tsd-kind-interface">
<a href="interfaces/authrequesttype.html" class="tsd-kind-icon">Auth<wbr>Request<wbr>Type</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/balanceinfo.html" class="tsd-kind-icon">Balance<wbr>Info</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/blocktimeinfo.html" class="tsd-kind-icon">Block<wbr>Time<wbr>Info</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/buffercv.html" class="tsd-kind-icon">BufferCV</a>
</li>
Expand Down Expand Up @@ -359,6 +372,9 @@ <h2>Contributing</h2>
<li class=" tsd-kind-interface">
<a href="interfaces/cli_prop_item.html" class="tsd-kind-icon">CLI_<wbr>PROP_<wbr>ITEM</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/canlockstxoptions.html" class="tsd-kind-icon">Can<wbr>Lock<wbr>Stx<wbr>Options</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/checkargsfailtype.html" class="tsd-kind-icon">Check<wbr>Args<wbr>Fail<wbr>Type</a>
</li>
Expand Down Expand Up @@ -416,6 +432,9 @@ <h2>Contributing</h2>
<li class=" tsd-kind-interface">
<a href="interfaces/contractprincipalcv.html" class="tsd-kind-icon">Contract<wbr>PrincipalCV</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/coreinfo.html" class="tsd-kind-icon">Core<wbr>Info</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/encryptcontentoptions.html" class="tsd-kind-icon">Encrypt<wbr>Content<wbr>Options</a>
</li>
Expand Down Expand Up @@ -476,6 +495,9 @@ <h2>Contributing</h2>
<li class=" tsd-kind-interface">
<a href="interfaces/listcv.html" class="tsd-kind-icon">ListCV</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/lockstxoptions.html" class="tsd-kind-icon">Lock<wbr>Stx<wbr>Options</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/memostring.html" class="tsd-kind-icon">Memo<wbr>String</a>
</li>
Expand Down Expand Up @@ -509,6 +531,9 @@ <h2>Contributing</h2>
<li class=" tsd-kind-interface">
<a href="interfaces/poisonpayload.html" class="tsd-kind-icon">Poison<wbr>Payload</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/poxinfo.html" class="tsd-kind-icon">Pox<wbr>Info</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/pricetype.html" class="tsd-kind-icon">Price<wbr>Type</a>
</li>
Expand Down Expand Up @@ -587,6 +612,12 @@ <h2>Contributing</h2>
<li class=" tsd-kind-interface">
<a href="interfaces/sponsoroptions.html" class="tsd-kind-icon">Sponsor<wbr>Options</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/stackerinfo.html" class="tsd-kind-icon">Stacker<wbr>Info</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/stackingeligibility.html" class="tsd-kind-icon">Stacking<wbr>Eligibility</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/stacksnetwork.html" class="tsd-kind-icon">Stacks<wbr>Network</a>
</li>
Expand Down Expand Up @@ -1292,6 +1323,9 @@ <h2>Contributing</h2>
<li class=" tsd-kind-function">
<a href="globals.html#cvtostring" class="tsd-kind-icon">cv<wbr>ToString</a>
</li>
<li class=" tsd-kind-function">
<a href="globals.html#decodebtcaddress" class="tsd-kind-icon">decode<wbr>Btc<wbr>Address</a>
</li>
<li class=" tsd-kind-function">
<a href="globals.html#decodeprivatekey" class="tsd-kind-icon">decode<wbr>Private<wbr>Key</a>
</li>
Expand Down Expand Up @@ -1478,6 +1512,9 @@ <h2>Contributing</h2>
<li class=" tsd-kind-function">
<a href="globals.html#getaddressfrompublickey" class="tsd-kind-icon">get<wbr>Address<wbr>From<wbr>Public<wbr>Key</a>
</li>
<li class=" tsd-kind-function">
<a href="globals.html#getaddresshashmode" class="tsd-kind-icon">get<wbr>Address<wbr>Hash<wbr>Mode</a>
</li>
<li class=" tsd-kind-function">
<a href="globals.html#getappkeys" class="tsd-kind-icon">get<wbr>App<wbr>Keys</a>
</li>
Expand All @@ -1487,6 +1524,9 @@ <h2>Contributing</h2>
<li class=" tsd-kind-function">
<a href="globals.html#getapplicationkeyinfo" class="tsd-kind-icon">get<wbr>Application<wbr>Key<wbr>Info</a>
</li>
<li class=" tsd-kind-function">
<a href="globals.html#getbtcaddress" class="tsd-kind-icon">getBTCAddress</a>
</li>
<li class=" tsd-kind-function">
<a href="globals.html#getbackupphrase" class="tsd-kind-icon">get<wbr>Backup<wbr>Phrase</a>
</li>
Expand Down Expand Up @@ -1523,6 +1563,9 @@ <h2>Contributing</h2>
<li class=" tsd-kind-function">
<a href="globals.html#getderivationpath" class="tsd-kind-icon">get<wbr>Derivation<wbr>Path</a>
</li>
<li class=" tsd-kind-function">
<a href="globals.html#geterrorstring" class="tsd-kind-icon">get<wbr>Error<wbr>String</a>
</li>
<li class=" tsd-kind-function">
<a href="globals.html#getgaiaaddressfromprofile" class="tsd-kind-icon">get<wbr>Gaia<wbr>Address<wbr>From<wbr>Profile</a>
</li>
Expand Down
175 changes: 175 additions & 0 deletions docs/interfaces/balanceinfo.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,175 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>BalanceInfo | Stacks.js 1.0.0 Library Reference</title>
<meta name="description" content="Documentation for Stacks.js 1.0.0 Library Reference">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
</head>
<body>
<link rel="stylesheet" href="../assets/css/custom-style.css">
<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.0.0 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-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="../globals.html">Globals</a>
</li>
<li>
<a href="balanceinfo.html">BalanceInfo</a>
</li>
</ul>
<h1>Interface BalanceInfo</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">BalanceInfo</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="balanceinfo.html#balance" class="tsd-kind-icon">balance</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="balanceinfo.html#nonce" class="tsd-kind-icon">nonce</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="balance" class="tsd-anchor"></a>
<h3>balance</h3>
<div class="tsd-signature tsd-kind-icon">balance<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#L71">packages/stacking/src/index.ts:71</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="nonce" class="tsd-anchor"></a>
<h3>nonce</h3>
<div class="tsd-signature tsd-kind-icon">nonce<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#L72">packages/stacking/src/index.ts:72</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="globals ">
<a href="../globals.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-interface">
<a href="balanceinfo.html" class="tsd-kind-icon">Balance<wbr>Info</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="balanceinfo.html#balance" class="tsd-kind-icon">balance</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="balanceinfo.html#nonce" class="tsd-kind-icon">nonce</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-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-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>
</ul>
<ul class="tsd-legend">
<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>
</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-method 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="https://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>
Loading

0 comments on commit faa8172

Please sign in to comment.