mirror of
https://github.com/alexgo-io/stacks.js.git
synced 2026-06-13 01:38:20 +08:00
3016 lines
214 KiB
HTML
Vendored
3016 lines
214 KiB
HTML
Vendored
<!doctype html>
|
|
<html class="default no-js">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
<title>cli | 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>
|
|
<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.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>
|
|
</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="cli.html">cli</a>
|
|
</li>
|
|
</ul>
|
|
<h1>Module cli</h1>
|
|
</div>
|
|
</div>
|
|
</header>
|
|
<div class="container container-main">
|
|
<div class="row">
|
|
<div class="col-8 col-content">
|
|
<section class="tsd-panel tsd-comment">
|
|
<div class="tsd-comment tsd-typography">
|
|
<a href="#stackscli" id="stackscli" style="color: inherit; text-decoration: none;">
|
|
<h1>@stacks/cli</h1>
|
|
</a>
|
|
<p>Command line interface to interact with auth, storage and Stacks transactions.</p>
|
|
<a href="#installation" id="installation" style="color: inherit; text-decoration: none;">
|
|
<h2>Installation</h2>
|
|
</a>
|
|
<pre><code><span style="color: #001080">npm</span><span style="color: #000000"> </span><span style="color: #001080">install</span><span style="color: #000000"> @</span><span style="color: #001080">stacks</span><span style="color: #000000">/</span><span style="color: #001080">cli</span>
|
|
</code></pre>
|
|
<a href="#usage" id="usage" style="color: inherit; text-decoration: none;">
|
|
<h2>Usage</h2>
|
|
</a>
|
|
<p>See <a href="https://docs.blockstack.org/references/stacks-cli">documentation</a></p>
|
|
</div>
|
|
</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>Classes</h3>
|
|
<ul class="tsd-index-list">
|
|
<li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/cli.clinetworkadapter.html" class="tsd-kind-icon">CLINetwork<wbr>Adapter</a></li>
|
|
<li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/cli.multisigkeysigner.html" class="tsd-kind-icon">Multi<wbr>Sig<wbr>Key<wbr>Signer</a></li>
|
|
<li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/cli.nullsigner.html" class="tsd-kind-icon">Null<wbr>Signer</a></li>
|
|
<li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/cli.safetyerror.html" class="tsd-kind-icon">Safety<wbr>Error</a></li>
|
|
<li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/cli.segwitp2shkeysigner.html" class="tsd-kind-icon">Segwit<wbr>P2SHKey<wbr>Signer</a></li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-index-section ">
|
|
<h3>Interfaces</h3>
|
|
<ul class="tsd-index-list">
|
|
<li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/cli.cli_config_type.html" class="tsd-kind-icon">CLI_<wbr>CONFIG_<wbr>TYPE</a></li>
|
|
<li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/cli.cli_log_config_type.html" class="tsd-kind-icon">CLI_<wbr>LOG_<wbr>CONFIG_<wbr>TYPE</a></li>
|
|
<li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/cli.cli_network_opts.html" class="tsd-kind-icon">CLI_<wbr>NETWORK_<wbr>OPTS</a></li>
|
|
<li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/cli.checkargsfailtype.html" class="tsd-kind-icon">Check<wbr>Args<wbr>Fail<wbr>Type</a></li>
|
|
<li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/cli.checkargssuccesstype.html" class="tsd-kind-icon">Check<wbr>Args<wbr>Success<wbr>Type</a></li>
|
|
<li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/cli.clarityfunctionarg.html" class="tsd-kind-icon">Clarity<wbr>Function<wbr>Arg</a></li>
|
|
<li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/cli.idappkeys.html" class="tsd-kind-icon">IDApp<wbr>Keys</a></li>
|
|
<li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/cli.namedidentitytype.html" class="tsd-kind-icon">Named<wbr>Identity<wbr>Type</a></li>
|
|
<li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/cli.pricetype.html" class="tsd-kind-icon">Price<wbr>Type</a></li>
|
|
<li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/cli.utxo.html" class="tsd-kind-icon">UTXO</a></li>
|
|
<li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/cli.whoisinfotype.html" class="tsd-kind-icon">Whois<wbr>Info<wbr>Type</a></li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-index-section ">
|
|
<h3>Type aliases</h3>
|
|
<ul class="tsd-index-list">
|
|
<li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="cli.html#appkeyinfotype" class="tsd-kind-icon">App<wbr>Key<wbr>Info<wbr>Type</a></li>
|
|
<li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="cli.html#nameinfotype" class="tsd-kind-icon">Name<wbr>Info<wbr>Type</a></li>
|
|
<li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="cli.html#ownerkeyinfotype" class="tsd-kind-icon">Owner<wbr>Key<wbr>Info<wbr>Type</a></li>
|
|
<li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="cli.html#paymentkeyinfotype" class="tsd-kind-icon">Payment<wbr>Key<wbr>Info<wbr>Type</a></li>
|
|
<li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="cli.html#stackskeyinfotype" class="tsd-kind-icon">Stacks<wbr>Key<wbr>Info<wbr>Type</a></li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-index-section ">
|
|
<h3>Variables</h3>
|
|
<ul class="tsd-index-list">
|
|
<li class="tsd-kind-variable tsd-parent-kind-module"><a href="cli.html#address_chars" class="tsd-kind-icon">ADDRESS_<wbr>CHARS</a></li>
|
|
<li class="tsd-kind-variable tsd-parent-kind-module"><a href="cli.html#address_pattern" class="tsd-kind-icon">ADDRESS_<wbr>PATTERN</a></li>
|
|
<li class="tsd-kind-variable tsd-parent-kind-module"><a href="cli.html#boolean_pattern" class="tsd-kind-icon">BOOLEAN_<wbr>PATTERN</a></li>
|
|
<li class="tsd-kind-variable tsd-parent-kind-module"><a href="cli.html#c32_address_chars" class="tsd-kind-icon">C32_<wbr>ADDRESS_<wbr>CHARS</a></li>
|
|
<li class="tsd-kind-variable tsd-parent-kind-module"><a href="cli.html#cli_args" class="tsd-kind-icon">CLI_<wbr>ARGS</a></li>
|
|
<li class="tsd-kind-variable tsd-parent-kind-module"><a href="cli.html#default_config_path" class="tsd-kind-icon">DEFAULT_<wbr>CONFIG_<wbr>PATH</a></li>
|
|
<li class="tsd-kind-variable tsd-parent-kind-module"><a href="cli.html#default_config_regtest_path" class="tsd-kind-icon">DEFAULT_<wbr>CONFIG_<wbr>REGTEST_<wbr>PATH</a></li>
|
|
<li class="tsd-kind-variable tsd-parent-kind-module"><a href="cli.html#default_config_testnet_path" class="tsd-kind-icon">DEFAULT_<wbr>CONFIG_<wbr>TESTNET_<wbr>PATH</a></li>
|
|
<li class="tsd-kind-variable tsd-parent-kind-module"><a href="cli.html#default_max_id_search_index" class="tsd-kind-icon">DEFAULT_<wbr>MAX_<wbr>ID_<wbr>SEARCH_<wbr>INDEX</a></li>
|
|
<li class="tsd-kind-variable tsd-parent-kind-module"><a href="cli.html#derivation_path" class="tsd-kind-icon">DERIVATION_<wbr>PATH</a></li>
|
|
<li class="tsd-kind-variable tsd-parent-kind-module"><a href="cli.html#id_address_pattern" class="tsd-kind-icon">ID_<wbr>ADDRESS_<wbr>PATTERN</a></li>
|
|
<li class="tsd-kind-variable tsd-parent-kind-module"><a href="cli.html#int_pattern" class="tsd-kind-icon">INT_<wbr>PATTERN</a></li>
|
|
<li class="tsd-kind-variable tsd-parent-kind-module"><a href="cli.html#namespace_pattern" class="tsd-kind-icon">NAMESPACE_<wbr>PATTERN</a></li>
|
|
<li class="tsd-kind-variable tsd-parent-kind-module"><a href="cli.html#name_pattern" class="tsd-kind-icon">NAME_<wbr>PATTERN</a></li>
|
|
<li class="tsd-kind-variable tsd-parent-kind-module"><a href="cli.html#private_key_multisig_pattern" class="tsd-kind-icon">PRIVATE_<wbr>KEY_<wbr>MULTISIG_<wbr>PATTERN</a></li>
|
|
<li class="tsd-kind-variable tsd-parent-kind-module"><a href="cli.html#private_key_nosign_pattern" class="tsd-kind-icon">PRIVATE_<wbr>KEY_<wbr>NOSIGN_<wbr>PATTERN</a></li>
|
|
<li class="tsd-kind-variable tsd-parent-kind-module"><a href="cli.html#private_key_pattern" class="tsd-kind-icon">PRIVATE_<wbr>KEY_<wbr>PATTERN</a></li>
|
|
<li class="tsd-kind-variable tsd-parent-kind-module"><a href="cli.html#private_key_pattern_any" class="tsd-kind-icon">PRIVATE_<wbr>KEY_<wbr>PATTERN_<wbr>ANY</a></li>
|
|
<li class="tsd-kind-variable tsd-parent-kind-module"><a href="cli.html#private_key_segwit_p2sh_pattern" class="tsd-kind-icon">PRIVATE_<wbr>KEY_<wbr>SEGWIT_<wbr><wbr>P2SH_<wbr>PATTERN</a></li>
|
|
<li class="tsd-kind-variable tsd-parent-kind-module"><a href="cli.html#private_key_uncompressed_pattern" class="tsd-kind-icon">PRIVATE_<wbr>KEY_<wbr>UNCOMPRESSED_<wbr>PATTERN</a></li>
|
|
<li class="tsd-kind-variable tsd-parent-kind-module"><a href="cli.html#public_key_pattern" class="tsd-kind-icon">PUBLIC_<wbr>KEY_<wbr>PATTERN</a></li>
|
|
<li class="tsd-kind-variable tsd-parent-kind-module"><a href="cli.html#signin_css" class="tsd-kind-icon">SIGNIN_<wbr>CSS</a></li>
|
|
<li class="tsd-kind-variable tsd-parent-kind-module"><a href="cli.html#signin_desc" class="tsd-kind-icon">SIGNIN_<wbr>DESC</a></li>
|
|
<li class="tsd-kind-variable tsd-parent-kind-module"><a href="cli.html#signin_fmt_id" class="tsd-kind-icon">SIGNIN_<wbr>FMT_<wbr>ID</a></li>
|
|
<li class="tsd-kind-variable tsd-parent-kind-module"><a href="cli.html#signin_fmt_name" class="tsd-kind-icon">SIGNIN_<wbr>FMT_<wbr>NAME</a></li>
|
|
<li class="tsd-kind-variable tsd-parent-kind-module"><a href="cli.html#signin_footer" class="tsd-kind-icon">SIGNIN_<wbr>FOOTER</a></li>
|
|
<li class="tsd-kind-variable tsd-parent-kind-module"><a href="cli.html#signin_header" class="tsd-kind-icon">SIGNIN_<wbr>HEADER</a></li>
|
|
<li class="tsd-kind-variable tsd-parent-kind-module"><a href="cli.html#signin_scopes" class="tsd-kind-icon">SIGNIN_<wbr>SCOPES</a></li>
|
|
<li class="tsd-kind-variable tsd-parent-kind-module"><a href="cli.html#stacks_address_pattern" class="tsd-kind-icon">STACKS_<wbr>ADDRESS_<wbr>PATTERN</a></li>
|
|
<li class="tsd-kind-variable tsd-parent-kind-module"><a href="cli.html#strength" class="tsd-kind-icon">STRENGTH</a></li>
|
|
<li class="tsd-kind-variable tsd-parent-kind-module"><a href="cli.html#stx_wallet_compatible_seed_strength" class="tsd-kind-icon">STX_<wbr>WALLET_<wbr>COMPATIBLE_<wbr>SEED_<wbr>STRENGTH</a></li>
|
|
<li class="tsd-kind-variable tsd-parent-kind-module"><a href="cli.html#subdomain_pattern" class="tsd-kind-icon">SUBDOMAIN_<wbr>PATTERN</a></li>
|
|
<li class="tsd-kind-variable tsd-parent-kind-module"><a href="cli.html#txid_pattern" class="tsd-kind-icon">TXID_<wbr>PATTERN</a></li>
|
|
<li class="tsd-kind-variable tsd-parent-kind-module"><a href="cli.html#url_pattern" class="tsd-kind-icon">URL_<wbr>PATTERN</a></li>
|
|
<li class="tsd-kind-variable tsd-parent-kind-module"><a href="cli.html#usage" class="tsd-kind-icon">USAGE</a></li>
|
|
<li class="tsd-kind-variable tsd-parent-kind-module"><a href="cli.html#zonefile_hash_pattern" class="tsd-kind-icon">ZONEFILE_<wbr>HASH_<wbr>PATTERN</a></li>
|
|
<li class="tsd-kind-variable tsd-parent-kind-module"><a href="cli.html#testables" class="tsd-kind-icon">testables</a></li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-index-section ">
|
|
<h3>Functions</h3>
|
|
<ul class="tsd-index-list">
|
|
<li class="tsd-kind-function tsd-parent-kind-module"><a href="cli.html#climain" class="tsd-kind-icon">CLIMain</a></li>
|
|
<li class="tsd-kind-function tsd-parent-kind-module"><a href="cli.html#clioptasbool" class="tsd-kind-icon">CLIOpt<wbr>AsBool</a></li>
|
|
<li class="tsd-kind-function tsd-parent-kind-module"><a href="cli.html#clioptasstring" class="tsd-kind-icon">CLIOpt<wbr>AsString</a></li>
|
|
<li class="tsd-kind-function tsd-parent-kind-module"><a href="cli.html#clioptasstringarray" class="tsd-kind-icon">CLIOpt<wbr>AsString<wbr>Array</a></li>
|
|
<li class="tsd-kind-function tsd-parent-kind-module"><a href="cli.html#jsonstringify" class="tsd-kind-icon">JSONStringify</a></li>
|
|
<li class="tsd-kind-function tsd-parent-kind-module"><a href="cli.html#answertoclarityvalue" class="tsd-kind-icon">answer<wbr>ToClarity<wbr>Value</a></li>
|
|
<li class="tsd-kind-function tsd-parent-kind-module"><a href="cli.html#argtoprompt" class="tsd-kind-icon">arg<wbr>ToPrompt</a></li>
|
|
<li class="tsd-kind-function tsd-parent-kind-module"><a href="cli.html#broadcasttransactionandzonefile" class="tsd-kind-icon">broadcast<wbr>Transaction<wbr>And<wbr>Zone<wbr>File</a></li>
|
|
<li class="tsd-kind-function tsd-parent-kind-module"><a href="cli.html#canonicalprivatekey" class="tsd-kind-icon">canonical<wbr>Private<wbr>Key</a></li>
|
|
<li class="tsd-kind-function tsd-parent-kind-module"><a href="cli.html#checkargs" class="tsd-kind-icon">check<wbr>Args</a></li>
|
|
<li class="tsd-kind-function tsd-parent-kind-module"><a href="cli.html#checkurl" class="tsd-kind-icon">check<wbr>Url</a></li>
|
|
<li class="tsd-kind-function tsd-parent-kind-module"><a href="cli.html#decodeprivatekey" class="tsd-kind-icon">decode<wbr>Private<wbr>Key</a></li>
|
|
<li class="tsd-kind-function tsd-parent-kind-module"><a href="cli.html#decryptbackupphrase" class="tsd-kind-icon">decrypt<wbr>Backup<wbr>Phrase</a></li>
|
|
<li class="tsd-kind-function tsd-parent-kind-module"><a href="cli.html#encryptbackupphrase" class="tsd-kind-icon">encrypt<wbr>Backup<wbr>Phrase</a></li>
|
|
<li class="tsd-kind-function tsd-parent-kind-module"><a href="cli.html#extractappkey" class="tsd-kind-icon">extract<wbr>App<wbr>Key</a></li>
|
|
<li class="tsd-kind-function tsd-parent-kind-module"><a href="cli.html#findidentityindex" class="tsd-kind-icon">find<wbr>Identity<wbr>Index</a></li>
|
|
<li class="tsd-kind-function tsd-parent-kind-module"><a href="cli.html#gaiaauth" class="tsd-kind-icon">gaia<wbr>Auth</a></li>
|
|
<li class="tsd-kind-function tsd-parent-kind-module"><a href="cli.html#gaiaconnect" class="tsd-kind-icon">gaia<wbr>Connect</a></li>
|
|
<li class="tsd-kind-function tsd-parent-kind-module"><a href="cli.html#gaiauploadprofile" class="tsd-kind-icon">gaia<wbr>Upload<wbr>Profile</a></li>
|
|
<li class="tsd-kind-function tsd-parent-kind-module"><a href="cli.html#gaiauploadprofileall" class="tsd-kind-icon">gaia<wbr>Upload<wbr>Profile<wbr>All</a></li>
|
|
<li class="tsd-kind-function tsd-parent-kind-module"><a href="cli.html#generateexplorertxpageurl" class="tsd-kind-icon">generate<wbr>Explorer<wbr>TxPage<wbr>Url</a></li>
|
|
<li class="tsd-kind-function tsd-parent-kind-module"><a href="cli.html#getapplicationkeyinfo" class="tsd-kind-icon">get<wbr>Application<wbr>Key<wbr>Info</a></li>
|
|
<li class="tsd-kind-function tsd-parent-kind-module"><a href="cli.html#getbackupphrase" class="tsd-kind-icon">get<wbr>Backup<wbr>Phrase</a></li>
|
|
<li class="tsd-kind-function tsd-parent-kind-module"><a href="cli.html#getcliopts" class="tsd-kind-icon">getCLIOpts</a></li>
|
|
<li class="tsd-kind-function tsd-parent-kind-module"><a href="cli.html#getcommandargs" class="tsd-kind-icon">get<wbr>Command<wbr>Args</a></li>
|
|
<li class="tsd-kind-function tsd-parent-kind-module"><a href="cli.html#getgaiaaddressfromprofile" class="tsd-kind-icon">get<wbr>Gaia<wbr>Address<wbr>From<wbr>Profile</a></li>
|
|
<li class="tsd-kind-function tsd-parent-kind-module"><a href="cli.html#getgaiaaddressfromurl" class="tsd-kind-icon">get<wbr>Gaia<wbr>Address<wbr>FromURL</a></li>
|
|
<li class="tsd-kind-function tsd-parent-kind-module"><a href="cli.html#getidaddress" class="tsd-kind-icon">getIDAddress</a></li>
|
|
<li class="tsd-kind-function tsd-parent-kind-module"><a href="cli.html#getidappkeys" class="tsd-kind-icon">getIDApp<wbr>Keys</a></li>
|
|
<li class="tsd-kind-function tsd-parent-kind-module"><a href="cli.html#getmaxidsearchindex" class="tsd-kind-icon">get<wbr>MaxIDSearch<wbr>Index</a></li>
|
|
<li class="tsd-kind-function tsd-parent-kind-module"><a href="cli.html#getnameinfoeasy" class="tsd-kind-icon">get<wbr>Name<wbr>Info<wbr>Easy</a></li>
|
|
<li class="tsd-kind-function tsd-parent-kind-module"><a href="cli.html#getnetwork" class="tsd-kind-icon">get<wbr>Network</a></li>
|
|
<li class="tsd-kind-function tsd-parent-kind-module"><a href="cli.html#getownerkeyfromidaddress" class="tsd-kind-icon">get<wbr>Owner<wbr>Key<wbr>FromIDAddress</a></li>
|
|
<li class="tsd-kind-function tsd-parent-kind-module"><a href="cli.html#getownerkeyinfo" class="tsd-kind-icon">get<wbr>Owner<wbr>Key<wbr>Info</a></li>
|
|
<li class="tsd-kind-function tsd-parent-kind-module"><a href="cli.html#getpaymentkeyinfo" class="tsd-kind-icon">get<wbr>Payment<wbr>Key<wbr>Info</a></li>
|
|
<li class="tsd-kind-function tsd-parent-kind-module"><a href="cli.html#getprivatekeyaddress" class="tsd-kind-icon">get<wbr>Private<wbr>Key<wbr>Address</a></li>
|
|
<li class="tsd-kind-function tsd-parent-kind-module"><a href="cli.html#getpublickeyfromprivatekey" class="tsd-kind-icon">get<wbr>Public<wbr>Key<wbr>From<wbr>Private<wbr>Key</a></li>
|
|
<li class="tsd-kind-function tsd-parent-kind-module"><a href="cli.html#getstackswalletkeyinfo" class="tsd-kind-icon">get<wbr>Stacks<wbr>Wallet<wbr>Key<wbr>Info</a></li>
|
|
<li class="tsd-kind-function tsd-parent-kind-module"><a href="cli.html#getpass" class="tsd-kind-icon">getpass</a></li>
|
|
<li class="tsd-kind-function tsd-parent-kind-module"><a href="cli.html#handleauth" class="tsd-kind-icon">handle<wbr>Auth</a></li>
|
|
<li class="tsd-kind-function tsd-parent-kind-module"><a href="cli.html#handlesignin" class="tsd-kind-icon">handle<wbr>Sign<wbr>In</a></li>
|
|
<li class="tsd-kind-function tsd-parent-kind-module"><a href="cli.html#haskeys" class="tsd-kind-icon">has<wbr>Keys</a></li>
|
|
<li class="tsd-kind-function tsd-parent-kind-module"><a href="cli.html#hash160" class="tsd-kind-icon">hash160</a></li>
|
|
<li class="tsd-kind-function tsd-parent-kind-module"><a href="cli.html#issubdomain" class="tsd-kind-icon">is<wbr>Subdomain</a></li>
|
|
<li class="tsd-kind-function tsd-parent-kind-module"><a href="cli.html#istestnetaddress" class="tsd-kind-icon">is<wbr>Testnet<wbr>Address</a></li>
|
|
<li class="tsd-kind-function tsd-parent-kind-module"><a href="cli.html#loadconfig" class="tsd-kind-icon">load<wbr>Config</a></li>
|
|
<li class="tsd-kind-function tsd-parent-kind-module"><a href="cli.html#loadnamedidentities" class="tsd-kind-icon">load<wbr>Named<wbr>Identities</a></li>
|
|
<li class="tsd-kind-function tsd-parent-kind-module"><a href="cli.html#makeallcommandshelp" class="tsd-kind-icon">make<wbr>All<wbr>Commands<wbr>Help</a></li>
|
|
<li class="tsd-kind-function tsd-parent-kind-module"><a href="cli.html#makeallcommandslist" class="tsd-kind-icon">make<wbr>All<wbr>Commands<wbr>List</a></li>
|
|
<li class="tsd-kind-function tsd-parent-kind-module"><a href="cli.html#makeassociationtoken" class="tsd-kind-icon">make<wbr>Association<wbr>Token</a></li>
|
|
<li class="tsd-kind-function tsd-parent-kind-module"><a href="cli.html#makecommandusagestring" class="tsd-kind-icon">make<wbr>Command<wbr>Usage<wbr>String</a></li>
|
|
<li class="tsd-kind-function tsd-parent-kind-module"><a href="cli.html#makedidconfiguration" class="tsd-kind-icon">makeDIDConfiguration</a></li>
|
|
<li class="tsd-kind-function tsd-parent-kind-module"><a href="cli.html#makeprofilejwt" class="tsd-kind-icon">make<wbr>ProfileJWT</a></li>
|
|
<li class="tsd-kind-function tsd-parent-kind-module"><a href="cli.html#makepromptsfromarglist" class="tsd-kind-icon">make<wbr>Prompts<wbr>From<wbr>Arg<wbr>List</a></li>
|
|
<li class="tsd-kind-function tsd-parent-kind-module"><a href="cli.html#makeusagestring" class="tsd-kind-icon">make<wbr>Usage<wbr>String</a></li>
|
|
<li class="tsd-kind-function tsd-parent-kind-module"><a href="cli.html#makezonefilefromgaiaurl" class="tsd-kind-icon">make<wbr>Zone<wbr>File<wbr>From<wbr>Gaia<wbr>Url</a></li>
|
|
<li class="tsd-kind-function tsd-parent-kind-module"><a href="cli.html#mkdirs" class="tsd-kind-icon">mkdirs</a></li>
|
|
<li class="tsd-kind-function tsd-parent-kind-module"><a href="cli.html#namelookup" class="tsd-kind-icon">name<wbr>Lookup</a></li>
|
|
<li class="tsd-kind-function tsd-parent-kind-module"><a href="cli.html#parseclarityfunctionarganswers" class="tsd-kind-icon">parse<wbr>Clarity<wbr>Function<wbr>Arg<wbr>Answers</a></li>
|
|
<li class="tsd-kind-function tsd-parent-kind-module"><a href="cli.html#parsemultisigkeys" class="tsd-kind-icon">parse<wbr>Multi<wbr>Sig<wbr>Keys</a></li>
|
|
<li class="tsd-kind-function tsd-parent-kind-module"><a href="cli.html#parsenullsigner" class="tsd-kind-icon">parse<wbr>Null<wbr>Signer</a></li>
|
|
<li class="tsd-kind-function tsd-parent-kind-module"><a href="cli.html#parsesegwitp2shkeys" class="tsd-kind-icon">parse<wbr>Segwit<wbr>P2SHKeys</a></li>
|
|
<li class="tsd-kind-function tsd-parent-kind-module"><a href="cli.html#printusage" class="tsd-kind-icon">print<wbr>Usage</a></li>
|
|
<li class="tsd-kind-function tsd-parent-kind-module"><a href="cli.html#sumutxos" class="tsd-kind-icon">sumUTXOs</a></li>
|
|
</ul>
|
|
</section>
|
|
</div>
|
|
</section>
|
|
</section>
|
|
<section class="tsd-panel-group tsd-member-group ">
|
|
<h2>Type aliases</h2>
|
|
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module">
|
|
<a name="appkeyinfotype" class="tsd-anchor"></a>
|
|
<h3>App<wbr>Key<wbr>Info<wbr>Type</h3>
|
|
<div class="tsd-signature tsd-kind-icon">App<wbr>Key<wbr>Info<wbr>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>keyInfo<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>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>legacyKeyInfo<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>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>ownerKeyIndex<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/cli/src/keys.ts#L48">packages/cli/src/keys.ts:48</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-type-declaration">
|
|
<h4>Type declaration</h4>
|
|
<ul class="tsd-parameters">
|
|
<li class="tsd-parameter">
|
|
<h5>key<wbr>Info<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>privateKey<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>address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li class="tsd-parameter">
|
|
<h5>private<wbr>Key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="tsd-parameter">
|
|
<h5>legacy<wbr>Key<wbr>Info<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>privateKey<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>address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li class="tsd-parameter">
|
|
<h5>private<wbr>Key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="tsd-parameter">
|
|
<h5>owner<wbr>Key<wbr>Index<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module">
|
|
<a name="nameinfotype" class="tsd-anchor"></a>
|
|
<h3>Name<wbr>Info<wbr>Type</h3>
|
|
<div class="tsd-signature tsd-kind-icon">Name<wbr>Info<wbr>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>blockchain<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>did<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>expire_block<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>grace_period<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>last_txid<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>renewal_deadline<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>resolver<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">; </span>status<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>zonefile<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">; </span>zonefile_hash<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> }</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/cli/src/network.ts#L30">packages/cli/src/network.ts:30</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-type-declaration">
|
|
<h4>Type declaration</h4>
|
|
<ul class="tsd-parameters">
|
|
<li class="tsd-parameter">
|
|
<h5>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> blockchain<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> did<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> expire_<wbr>block<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> grace_<wbr>period<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> last_<wbr>txid<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> renewal_<wbr>deadline<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> resolver<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></h5>
|
|
</li>
|
|
<li class="tsd-parameter">
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> status<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> zonefile<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></h5>
|
|
</li>
|
|
<li class="tsd-parameter">
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> zonefile_<wbr>hash<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></h5>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module">
|
|
<a name="ownerkeyinfotype" class="tsd-anchor"></a>
|
|
<h3>Owner<wbr>Key<wbr>Info<wbr>Type</h3>
|
|
<div class="tsd-signature tsd-kind-icon">Owner<wbr>Key<wbr>Info<wbr>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>idAddress<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>index<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><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>version<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/cli/src/keys.ts#L24">packages/cli/src/keys.ts:24</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-type-declaration">
|
|
<h4>Type declaration</h4>
|
|
<ul class="tsd-parameters">
|
|
<li class="tsd-parameter">
|
|
<h5>id<wbr>Address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li class="tsd-parameter">
|
|
<h5>index<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
|
|
</li>
|
|
<li class="tsd-parameter">
|
|
<h5>private<wbr>Key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li class="tsd-parameter">
|
|
<h5>version<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module">
|
|
<a name="paymentkeyinfotype" class="tsd-anchor"></a>
|
|
<h3>Payment<wbr>Key<wbr>Info<wbr>Type</h3>
|
|
<div class="tsd-signature tsd-kind-icon">Payment<wbr>Key<wbr>Info<wbr>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>BTC<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>STACKS<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>index<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><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></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/cli/src/keys.ts#L31">packages/cli/src/keys.ts:31</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-type-declaration">
|
|
<h4>Type declaration</h4>
|
|
<ul class="tsd-parameters">
|
|
<li class="tsd-parameter">
|
|
<h5>address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>BTC<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>STACKS<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>BTC<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li class="tsd-parameter">
|
|
<h5>STACKS<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="tsd-parameter">
|
|
<h5>index<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
|
|
</li>
|
|
<li class="tsd-parameter">
|
|
<h5>private<wbr>Key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module">
|
|
<a name="stackskeyinfotype" class="tsd-anchor"></a>
|
|
<h3>Stacks<wbr>Key<wbr>Info<wbr>Type</h3>
|
|
<div class="tsd-signature tsd-kind-icon">Stacks<wbr>Key<wbr>Info<wbr>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>btcAddress<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>index<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><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>wif<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/cli/src/keys.ts#L40">packages/cli/src/keys.ts:40</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-type-declaration">
|
|
<h4>Type declaration</h4>
|
|
<ul class="tsd-parameters">
|
|
<li class="tsd-parameter">
|
|
<h5>address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li class="tsd-parameter">
|
|
<h5>btc<wbr>Address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li class="tsd-parameter">
|
|
<h5>index<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
|
|
</li>
|
|
<li class="tsd-parameter">
|
|
<h5>private<wbr>Key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li class="tsd-parameter">
|
|
<h5>wif<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</section>
|
|
</section>
|
|
<section class="tsd-panel-group tsd-member-group ">
|
|
<h2>Variables</h2>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-module">
|
|
<a name="address_chars" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> ADDRESS_<wbr>CHARS</h3>
|
|
<div class="tsd-signature tsd-kind-icon">ADDRESS_<wbr>CHARS<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{1,35}"</span><span class="tsd-signature-symbol"> = '[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{1,35}'</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/cli/src/argparse.ts#L9">packages/cli/src/argparse.ts:9</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-module">
|
|
<a name="address_pattern" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> ADDRESS_<wbr>PATTERN</h3>
|
|
<div class="tsd-signature tsd-kind-icon">ADDRESS_<wbr>PATTERN<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = ...</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/cli/src/argparse.ts#L13">packages/cli/src/argparse.ts:13</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-module">
|
|
<a name="boolean_pattern" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> BOOLEAN_<wbr>PATTERN</h3>
|
|
<div class="tsd-signature tsd-kind-icon">BOOLEAN_<wbr>PATTERN<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"^(0|1|true|false)$"</span><span class="tsd-signature-symbol"> = '^(0|1|true|false)$'</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/cli/src/argparse.ts#L50">packages/cli/src/argparse.ts:50</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-module">
|
|
<a name="c32_address_chars" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> C32_<wbr>ADDRESS_<wbr>CHARS</h3>
|
|
<div class="tsd-signature tsd-kind-icon">C32_<wbr>ADDRESS_<wbr>CHARS<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"[0123456789ABCDEFGHJKMNPQRSTVWXYZ]+"</span><span class="tsd-signature-symbol"> = '[0123456789ABCDEFGHJKMNPQRSTVWXYZ]+'</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/cli/src/argparse.ts#L11">packages/cli/src/argparse.ts:11</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-module">
|
|
<a name="cli_args" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> CLI_<wbr>ARGS</h3>
|
|
<div class="tsd-signature tsd-kind-icon">CLI_<wbr>ARGS<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>additionalProperties<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>properties<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">CLI_PROP</span><span class="tsd-signature-symbol">; </span>strict<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>type<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></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/cli/src/argparse.ts#L133">packages/cli/src/argparse.ts:133</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-type-declaration">
|
|
<h4>Type declaration</h4>
|
|
<ul class="tsd-parameters">
|
|
<li class="tsd-parameter">
|
|
<h5>additional<wbr>Properties<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5>
|
|
</li>
|
|
<li class="tsd-parameter">
|
|
<h5>properties<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">CLI_PROP</span></h5>
|
|
</li>
|
|
<li class="tsd-parameter">
|
|
<h5>strict<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5>
|
|
</li>
|
|
<li class="tsd-parameter">
|
|
<h5>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-module">
|
|
<a name="default_config_path" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> DEFAULT_<wbr>CONFIG_<wbr>PATH</h3>
|
|
<div class="tsd-signature tsd-kind-icon">DEFAULT_<wbr>CONFIG_<wbr>PATH<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"~/.blockstack-cli.conf"</span><span class="tsd-signature-symbol"> = '~/.blockstack-cli.conf'</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/cli/src/argparse.ts#L108">packages/cli/src/argparse.ts:108</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-module">
|
|
<a name="default_config_regtest_path" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> DEFAULT_<wbr>CONFIG_<wbr>REGTEST_<wbr>PATH</h3>
|
|
<div class="tsd-signature tsd-kind-icon">DEFAULT_<wbr>CONFIG_<wbr>REGTEST_<wbr>PATH<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"~/.blockstack-cli-regtest.conf"</span><span class="tsd-signature-symbol"> = '~/.blockstack-cli-regtest.conf'</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/cli/src/argparse.ts#L109">packages/cli/src/argparse.ts:109</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-module">
|
|
<a name="default_config_testnet_path" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> DEFAULT_<wbr>CONFIG_<wbr>TESTNET_<wbr>PATH</h3>
|
|
<div class="tsd-signature tsd-kind-icon">DEFAULT_<wbr>CONFIG_<wbr>TESTNET_<wbr>PATH<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"~/.blockstack-cli-testnet.conf"</span><span class="tsd-signature-symbol"> = '~/.blockstack-cli-testnet.conf'</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/cli/src/argparse.ts#L110">packages/cli/src/argparse.ts:110</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-module">
|
|
<a name="default_max_id_search_index" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> DEFAULT_<wbr>MAX_<wbr>ID_<wbr>SEARCH_<wbr>INDEX</h3>
|
|
<div class="tsd-signature tsd-kind-icon">DEFAULT_<wbr>MAX_<wbr>ID_<wbr>SEARCH_<wbr>INDEX<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">256</span><span class="tsd-signature-symbol"> = 256</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/cli/src/argparse.ts#L112">packages/cli/src/argparse.ts:112</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-module">
|
|
<a name="derivation_path" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> DERIVATION_<wbr>PATH</h3>
|
|
<div class="tsd-signature tsd-kind-icon">DERIVATION_<wbr>PATH<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"m/44'/5757'/0'/0/0"</span><span class="tsd-signature-symbol"> = "m/44'/5757'/0'/0/0"</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/cli/src/keys.ts#L22">packages/cli/src/keys.ts:22</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-module">
|
|
<a name="id_address_pattern" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> ID_<wbr>ADDRESS_<wbr>PATTERN</h3>
|
|
<div class="tsd-signature tsd-kind-icon">ID_<wbr>ADDRESS_<wbr>PATTERN<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = ...</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/cli/src/argparse.ts#L15">packages/cli/src/argparse.ts:15</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-module">
|
|
<a name="int_pattern" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> INT_<wbr>PATTERN</h3>
|
|
<div class="tsd-signature tsd-kind-icon">INT_<wbr>PATTERN<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"^-?[0-9]+$"</span><span class="tsd-signature-symbol"> = '^-?[0-9]+$'</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/cli/src/argparse.ts#L40">packages/cli/src/argparse.ts:40</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-module">
|
|
<a name="namespace_pattern" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> NAMESPACE_<wbr>PATTERN</h3>
|
|
<div class="tsd-signature tsd-kind-icon">NAMESPACE_<wbr>PATTERN<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"^([0-9a-z_-]{1,19})$"</span><span class="tsd-signature-symbol"> = '^([0-9a-z_-]{1,19})$'</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/cli/src/argparse.ts#L7">packages/cli/src/argparse.ts:7</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-module">
|
|
<a name="name_pattern" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> NAME_<wbr>PATTERN</h3>
|
|
<div class="tsd-signature tsd-kind-icon">NAME_<wbr>PATTERN<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"^([0-9a-z_.+-]{3,37})$"</span><span class="tsd-signature-symbol"> = '^([0-9a-z_.+-]{3,37})$'</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/cli/src/argparse.ts#L5">packages/cli/src/argparse.ts:5</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-module">
|
|
<a name="private_key_multisig_pattern" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> PRIVATE_<wbr>KEY_<wbr>MULTISIG_<wbr>PATTERN</h3>
|
|
<div class="tsd-signature tsd-kind-icon">PRIVATE_<wbr>KEY_<wbr>MULTISIG_<wbr>PATTERN<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"^([0-9]+),([0-9a-f]{64,66},)*([0-9a-f]{64,66})$"</span><span class="tsd-signature-symbol"> = '^([0-9]+),([0-9a-f]{64,66},)*([0-9a-f]{64,66})$'</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/cli/src/argparse.ts#L29">packages/cli/src/argparse.ts:29</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-module">
|
|
<a name="private_key_nosign_pattern" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> PRIVATE_<wbr>KEY_<wbr>NOSIGN_<wbr>PATTERN</h3>
|
|
<div class="tsd-signature tsd-kind-icon">PRIVATE_<wbr>KEY_<wbr>NOSIGN_<wbr>PATTERN<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = ...</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/cli/src/argparse.ts#L26">packages/cli/src/argparse.ts:26</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-module">
|
|
<a name="private_key_pattern" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> PRIVATE_<wbr>KEY_<wbr>PATTERN</h3>
|
|
<div class="tsd-signature tsd-kind-icon">PRIVATE_<wbr>KEY_<wbr>PATTERN<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"^([0-9a-f]{64,66})$"</span><span class="tsd-signature-symbol"> = '^([0-9a-f]{64,66})$'</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/cli/src/argparse.ts#L20">packages/cli/src/argparse.ts:20</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-module">
|
|
<a name="private_key_pattern_any" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> PRIVATE_<wbr>KEY_<wbr>PATTERN_<wbr>ANY</h3>
|
|
<div class="tsd-signature tsd-kind-icon">PRIVATE_<wbr>KEY_<wbr>PATTERN_<wbr>ANY<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = ...</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/cli/src/argparse.ts#L36">packages/cli/src/argparse.ts:36</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-module">
|
|
<a name="private_key_segwit_p2sh_pattern" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> PRIVATE_<wbr>KEY_<wbr>SEGWIT_<wbr><wbr>P2SH_<wbr>PATTERN</h3>
|
|
<div class="tsd-signature tsd-kind-icon">PRIVATE_<wbr>KEY_<wbr>SEGWIT_<wbr><wbr>P2SH_<wbr>PATTERN<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"^segwit:p2sh:([0-9]+),([0-9a-f]{64,66},)*([0-9a-f]{64,66})$"</span><span class="tsd-signature-symbol"> = '^segwit:p2sh:([0-9]+),([0-9a-f]{64,66},)*([0-9a-f]{64,66})$'</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/cli/src/argparse.ts#L32">packages/cli/src/argparse.ts:32</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-module">
|
|
<a name="private_key_uncompressed_pattern" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> PRIVATE_<wbr>KEY_<wbr>UNCOMPRESSED_<wbr>PATTERN</h3>
|
|
<div class="tsd-signature tsd-kind-icon">PRIVATE_<wbr>KEY_<wbr>UNCOMPRESSED_<wbr>PATTERN<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"^([0-9a-f]{64})$"</span><span class="tsd-signature-symbol"> = '^([0-9a-f]{64})$'</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/cli/src/argparse.ts#L23">packages/cli/src/argparse.ts:23</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-module">
|
|
<a name="public_key_pattern" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> PUBLIC_<wbr>KEY_<wbr>PATTERN</h3>
|
|
<div class="tsd-signature tsd-kind-icon">PUBLIC_<wbr>KEY_<wbr>PATTERN<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"^([0-9a-f]{66,130})$"</span><span class="tsd-signature-symbol"> = '^([0-9a-f]{66,130})$'</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/cli/src/argparse.ts#L38">packages/cli/src/argparse.ts:38</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-module">
|
|
<a name="signin_css" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> SIGNIN_<wbr>CSS</h3>
|
|
<div class="tsd-signature tsd-kind-icon">SIGNIN_<wbr>CSS<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"\nh1 { \n font-family: monospace; \n font-size: 24px; \n font-style: normal; \n font-variant: normal; \n font-weight: 700; \n line-height: 26.4px; \n} \nh3 { \n font-family: monospace; \n font-size: 14px; \n font-style: normal; \n font-variant: normal; \n font-weight: 700; \n line-height: 15.4px; \n}\np { \n font-family: monospace; \n font-size: 14px; \n font-style: normal; \n font-variant: normal; \n font-weight: 400; \n line-height: 20px; \n}\nb {\n background-color: #e8e8e8;\n}\npre { \n font-family: monospace; \n font-size: 13px; \n font-style: normal; \n font-variant: normal; \n font-weight: 400; \n line-height: 18.5714px;\n}"</span><span class="tsd-signature-symbol"> = ...</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/cli/src/auth.ts#L22">packages/cli/src/auth.ts:22</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-module">
|
|
<a name="signin_desc" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> SIGNIN_<wbr>DESC</h3>
|
|
<div class="tsd-signature tsd-kind-icon">SIGNIN_<wbr>DESC<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"<p>Sign-in request for <b>\"{appName}\"</b></p>"</span><span class="tsd-signature-symbol"> = '<p>Sign-in request for <b>"{appName}"</b></p>'</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/cli/src/auth.ts#L60">packages/cli/src/auth.ts:60</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-module">
|
|
<a name="signin_fmt_id" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> SIGNIN_<wbr>FMT_<wbr>ID</h3>
|
|
<div class="tsd-signature tsd-kind-icon">SIGNIN_<wbr>FMT_<wbr>ID<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"<p><a href=\"{authRedirect}\">{idAddress}</a> (anonymous)</p>"</span><span class="tsd-signature-symbol"> = '<p><a href="{authRedirect}">{idAddress}</a> (anonymous)</p>'</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/cli/src/auth.ts#L63">packages/cli/src/auth.ts:63</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-module">
|
|
<a name="signin_fmt_name" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> SIGNIN_<wbr>FMT_<wbr>NAME</h3>
|
|
<div class="tsd-signature tsd-kind-icon">SIGNIN_<wbr>FMT_<wbr>NAME<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"<p><a href=\"{authRedirect}\">{blockstackID}</a> ({idAddress})</p>"</span><span class="tsd-signature-symbol"> = '<p><a href="{authRedirect}">{blockstackID}</a> ({idAddress})</p>'</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/cli/src/auth.ts#L62">packages/cli/src/auth.ts:62</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-module">
|
|
<a name="signin_footer" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> SIGNIN_<wbr>FOOTER</h3>
|
|
<div class="tsd-signature tsd-kind-icon">SIGNIN_<wbr>FOOTER<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"</body></html>"</span><span class="tsd-signature-symbol"> = '</body></html>'</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/cli/src/auth.ts#L64">packages/cli/src/auth.ts:64</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-module">
|
|
<a name="signin_header" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> SIGNIN_<wbr>HEADER</h3>
|
|
<div class="tsd-signature tsd-kind-icon">SIGNIN_<wbr>HEADER<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = ...</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/cli/src/auth.ts#L59">packages/cli/src/auth.ts:59</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-module">
|
|
<a name="signin_scopes" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> SIGNIN_<wbr>SCOPES</h3>
|
|
<div class="tsd-signature tsd-kind-icon">SIGNIN_<wbr>SCOPES<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"<p>Requested scopes: <b>\"{appScopes}\"</b></p>"</span><span class="tsd-signature-symbol"> = '<p>Requested scopes: <b>"{appScopes}"</b></p>'</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/cli/src/auth.ts#L61">packages/cli/src/auth.ts:61</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-module">
|
|
<a name="stacks_address_pattern" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> STACKS_<wbr>ADDRESS_<wbr>PATTERN</h3>
|
|
<div class="tsd-signature tsd-kind-icon">STACKS_<wbr>ADDRESS_<wbr>PATTERN<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = ...</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/cli/src/argparse.ts#L17">packages/cli/src/argparse.ts:17</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-module">
|
|
<a name="strength" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> STRENGTH</h3>
|
|
<div class="tsd-signature tsd-kind-icon">STRENGTH<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">128</span><span class="tsd-signature-symbol"> = 128</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/cli/src/keys.ts#L20">packages/cli/src/keys.ts:20</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-module">
|
|
<a name="stx_wallet_compatible_seed_strength" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> STX_<wbr>WALLET_<wbr>COMPATIBLE_<wbr>SEED_<wbr>STRENGTH</h3>
|
|
<div class="tsd-signature tsd-kind-icon">STX_<wbr>WALLET_<wbr>COMPATIBLE_<wbr>SEED_<wbr>STRENGTH<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">256</span><span class="tsd-signature-symbol"> = 256</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/cli/src/keys.ts#L21">packages/cli/src/keys.ts:21</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-module">
|
|
<a name="subdomain_pattern" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> SUBDOMAIN_<wbr>PATTERN</h3>
|
|
<div class="tsd-signature tsd-kind-icon">SUBDOMAIN_<wbr>PATTERN<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"^([0-9a-z_+-]{1,37}).([0-9a-z_.+-]{3,37})$"</span><span class="tsd-signature-symbol"> = '^([0-9a-z_+-]{1,37}).([0-9a-z_.+-]{3,37})$'</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/cli/src/argparse.ts#L46">packages/cli/src/argparse.ts:46</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-module">
|
|
<a name="txid_pattern" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> TXID_<wbr>PATTERN</h3>
|
|
<div class="tsd-signature tsd-kind-icon">TXID_<wbr>PATTERN<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"^([0-9a-f]{64})$"</span><span class="tsd-signature-symbol"> = '^([0-9a-f]{64})$'</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/cli/src/argparse.ts#L48">packages/cli/src/argparse.ts:48</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-module">
|
|
<a name="url_pattern" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> URL_<wbr>PATTERN</h3>
|
|
<div class="tsd-signature tsd-kind-icon">URL_<wbr>PATTERN<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"^http[s]?://.+$"</span><span class="tsd-signature-symbol"> = '^http[s]?://.+$'</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/cli/src/argparse.ts#L44">packages/cli/src/argparse.ts:44</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-module">
|
|
<a name="usage" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> USAGE</h3>
|
|
<div class="tsd-signature tsd-kind-icon">USAGE<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = ...</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/cli/src/argparse.ts#L2757">packages/cli/src/argparse.ts:2757</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-module">
|
|
<a name="zonefile_hash_pattern" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> ZONEFILE_<wbr>HASH_<wbr>PATTERN</h3>
|
|
<div class="tsd-signature tsd-kind-icon">ZONEFILE_<wbr>HASH_<wbr>PATTERN<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"^([0-9a-f]{40})$"</span><span class="tsd-signature-symbol"> = '^([0-9a-f]{40})$'</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/cli/src/argparse.ts#L42">packages/cli/src/argparse.ts:42</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-module">
|
|
<a name="testables" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> testables</h3>
|
|
<div class="tsd-signature tsd-kind-icon">testables<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span>addressConvert<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>network<span class="tsd-signature-symbol">: </span><a href="../classes/cli.clinetworkadapter.html" class="tsd-signature-type" data-tsd-kind="Class">CLINetworkAdapter</a>, args<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><span class="tsd-signature-type">Promise</span><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></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/cli/src/cli.ts#L1923">packages/cli/src/cli.ts:1923</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
</section>
|
|
<section class="tsd-panel-group tsd-member-group ">
|
|
<h2>Functions</h2>
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
|
|
<a name="climain" class="tsd-anchor"></a>
|
|
<h3>CLIMain</h3>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
|
|
<li class="tsd-signature tsd-kind-icon">CLIMain<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/cli/src/cli.ts#L1764">packages/cli/src/cli.ts:1764</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
|
|
<a name="clioptasbool" class="tsd-anchor"></a>
|
|
<h3>CLIOpt<wbr>AsBool</h3>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
|
|
<li class="tsd-signature tsd-kind-icon">CLIOpt<wbr>AsBool<span class="tsd-signature-symbol">(</span>opts<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">CLI_OPTS</span>, key<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">boolean</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/cli/src/argparse.ts#L3161">packages/cli/src/argparse.ts:3161</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>opts: <span class="tsd-signature-type">CLI_OPTS</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>key: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
|
|
<a name="clioptasstring" class="tsd-anchor"></a>
|
|
<h3>CLIOpt<wbr>AsString</h3>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
|
|
<li class="tsd-signature tsd-kind-icon">CLIOpt<wbr>AsString<span class="tsd-signature-symbol">(</span>opts<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">CLI_OPTS</span>, key<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><span class="tsd-signature-type">null</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/cli/src/argparse.ts#L3151">packages/cli/src/argparse.ts:3151</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>opts: <span class="tsd-signature-type">CLI_OPTS</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>key: <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><span class="tsd-signature-type">null</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
|
|
<a name="clioptasstringarray" class="tsd-anchor"></a>
|
|
<h3>CLIOpt<wbr>AsString<wbr>Array</h3>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
|
|
<li class="tsd-signature tsd-kind-icon">CLIOpt<wbr>AsString<wbr>Array<span class="tsd-signature-symbol">(</span>opts<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">CLI_OPTS</span>, key<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><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</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/cli/src/argparse.ts#L3179">packages/cli/src/argparse.ts:3179</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>opts: <span class="tsd-signature-type">CLI_OPTS</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>key: <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><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
|
|
<a name="jsonstringify" class="tsd-anchor"></a>
|
|
<h3>JSONStringify</h3>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
|
|
<li class="tsd-signature tsd-kind-icon">JSONStringify<span class="tsd-signature-symbol">(</span>obj<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AnyJson</span>, stderr<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/cli/src/utils.ts#L385">packages/cli/src/utils.ts:385</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>obj: <span class="tsd-signature-type">AnyJson</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>stderr: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
|
|
<a name="answertoclarityvalue" class="tsd-anchor"></a>
|
|
<h3>answer<wbr>ToClarity<wbr>Value</h3>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
|
|
<li class="tsd-signature tsd-kind-icon">answer<wbr>ToClarity<wbr>Value<span class="tsd-signature-symbol">(</span>answer<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, arg<span class="tsd-signature-symbol">: </span><a href="../interfaces/cli.clarityfunctionarg.html" class="tsd-signature-type" data-tsd-kind="Interface">ClarityFunctionArg</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ClarityValue</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/cli/src/utils.ts#L866">packages/cli/src/utils.ts:866</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>answer: <span class="tsd-signature-type">any</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>arg: <a href="../interfaces/cli.clarityfunctionarg.html" class="tsd-signature-type" data-tsd-kind="Interface">ClarityFunctionArg</a></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">ClarityValue</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
|
|
<a name="argtoprompt" class="tsd-anchor"></a>
|
|
<h3>arg<wbr>ToPrompt</h3>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
|
|
<li class="tsd-signature tsd-kind-icon">arg<wbr>ToPrompt<span class="tsd-signature-symbol">(</span>arg<span class="tsd-signature-symbol">: </span><a href="../interfaces/cli.clarityfunctionarg.html" class="tsd-signature-type" data-tsd-kind="Interface">ClarityFunctionArg</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">InquirerPrompt</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/cli/src/utils.ts#L801">packages/cli/src/utils.ts:801</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>arg: <a href="../interfaces/cli.clarityfunctionarg.html" class="tsd-signature-type" data-tsd-kind="Interface">ClarityFunctionArg</a></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">InquirerPrompt</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
|
|
<a name="broadcasttransactionandzonefile" class="tsd-anchor"></a>
|
|
<h3>broadcast<wbr>Transaction<wbr>And<wbr>Zone<wbr>File</h3>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
|
|
<li class="tsd-signature tsd-kind-icon">broadcast<wbr>Transaction<wbr>And<wbr>Zone<wbr>File<span class="tsd-signature-symbol">(</span>network<span class="tsd-signature-symbol">: </span><a href="../classes/cli.clinetworkadapter.html" class="tsd-signature-type" data-tsd-kind="Class">CLINetworkAdapter</a>, tx<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, zonefile<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>error<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>status<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>txid<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>error<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">; </span>status<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>txid<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>error<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>message<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>stacktrace<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>status<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> }</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/cli/src/utils.ts#L511">packages/cli/src/utils.ts:511</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>network: <a href="../classes/cli.clinetworkadapter.html" class="tsd-signature-type" data-tsd-kind="Class">CLINetworkAdapter</a></h5>
|
|
</li>
|
|
<li>
|
|
<h5>tx: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> zonefile: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>error<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>status<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>txid<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>error<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">; </span>status<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>txid<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>error<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>message<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>stacktrace<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>status<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
|
|
<a name="canonicalprivatekey" class="tsd-anchor"></a>
|
|
<h3>canonical<wbr>Private<wbr>Key</h3>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
|
|
<li class="tsd-signature tsd-kind-icon">canonical<wbr>Private<wbr>Key<span class="tsd-signature-symbol">(</span>privkey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/cli/src/utils.ts#L431">packages/cli/src/utils.ts:431</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>privkey: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
|
|
<a name="checkargs" class="tsd-anchor"></a>
|
|
<h3>check<wbr>Args</h3>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
|
|
<li class="tsd-signature tsd-kind-icon">check<wbr>Args<span class="tsd-signature-symbol">(</span>argList<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/cli.checkargssuccesstype.html" class="tsd-signature-type" data-tsd-kind="Interface">CheckArgsSuccessType</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/cli.checkargsfailtype.html" class="tsd-signature-type" data-tsd-kind="Interface">CheckArgsFailType</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/cli/src/argparse.ts#L3299">packages/cli/src/argparse.ts:3299</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>argList: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="../interfaces/cli.checkargssuccesstype.html" class="tsd-signature-type" data-tsd-kind="Interface">CheckArgsSuccessType</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/cli.checkargsfailtype.html" class="tsd-signature-type" data-tsd-kind="Interface">CheckArgsFailType</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
|
|
<a name="checkurl" class="tsd-anchor"></a>
|
|
<h3>check<wbr>Url</h3>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
|
|
<li class="tsd-signature tsd-kind-icon">check<wbr>Url<span class="tsd-signature-symbol">(</span>url<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/cli/src/utils.ts#L457">packages/cli/src/utils.ts:457</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>url: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
|
|
<a name="decodeprivatekey" class="tsd-anchor"></a>
|
|
<h3>decode<wbr>Private<wbr>Key</h3>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
|
|
<li class="tsd-signature tsd-kind-icon">decode<wbr>Private<wbr>Key<span class="tsd-signature-symbol">(</span>serializedPrivateKey<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><span class="tsd-signature-type">CLITransactionSigner</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/cli/src/utils.ts#L350">packages/cli/src/utils.ts:350</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>serializedPrivateKey: <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><span class="tsd-signature-type">CLITransactionSigner</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
|
|
<a name="decryptbackupphrase" class="tsd-anchor"></a>
|
|
<h3>decrypt<wbr>Backup<wbr>Phrase</h3>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
|
|
<li class="tsd-signature tsd-kind-icon">decrypt<wbr>Backup<wbr>Phrase<span class="tsd-signature-symbol">(</span>dataBuffer<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Buffer</span>, password<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"><</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/cli/src/encrypt.ts#L9">packages/cli/src/encrypt.ts:9</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>dataBuffer: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Buffer</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>password: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
|
|
<a name="encryptbackupphrase" class="tsd-anchor"></a>
|
|
<h3>encrypt<wbr>Backup<wbr>Phrase</h3>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
|
|
<li class="tsd-signature tsd-kind-icon">encrypt<wbr>Backup<wbr>Phrase<span class="tsd-signature-symbol">(</span>plaintextBuffer<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, password<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"><</span><span class="tsd-signature-type">Buffer</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/cli/src/encrypt.ts#L5">packages/cli/src/encrypt.ts:5</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>plaintextBuffer: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>password: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
|
|
<a name="extractappkey" class="tsd-anchor"></a>
|
|
<h3>extract<wbr>App<wbr>Key</h3>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
|
|
<li class="tsd-signature tsd-kind-icon">extract<wbr>App<wbr>Key<span class="tsd-signature-symbol">(</span>network<span class="tsd-signature-symbol">: </span><a href="../classes/cli.clinetworkadapter.html" class="tsd-signature-type" data-tsd-kind="Class">CLINetworkAdapter</a>, appKeyInfo<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>keyInfo<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>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>legacyKeyInfo<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>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>, appAddress<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/cli/src/keys.ts#L267">packages/cli/src/keys.ts:267</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>network: <a href="../classes/cli.clinetworkadapter.html" class="tsd-signature-type" data-tsd-kind="Class">CLINetworkAdapter</a></h5>
|
|
</li>
|
|
<li>
|
|
<h5>appKeyInfo: <span class="tsd-signature-symbol">{ </span>keyInfo<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>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>legacyKeyInfo<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>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></h5>
|
|
<ul class="tsd-parameters">
|
|
<li class="tsd-parameter">
|
|
<h5>key<wbr>Info<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>privateKey<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>address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li class="tsd-parameter">
|
|
<h5>private<wbr>Key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="tsd-parameter">
|
|
<h5>legacy<wbr>Key<wbr>Info<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>privateKey<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>address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li class="tsd-parameter">
|
|
<h5>private<wbr>Key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> appAddress: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
|
|
<a name="findidentityindex" class="tsd-anchor"></a>
|
|
<h3>find<wbr>Identity<wbr>Index</h3>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
|
|
<li class="tsd-signature tsd-kind-icon">find<wbr>Identity<wbr>Index<span class="tsd-signature-symbol">(</span>network<span class="tsd-signature-symbol">: </span><a href="../classes/cli.clinetworkadapter.html" class="tsd-signature-type" data-tsd-kind="Class">CLINetworkAdapter</a>, mnemonic<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, idAddress<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, maxIndex<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</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/cli/src/keys.ts#L177">packages/cli/src/keys.ts:177</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>network: <a href="../classes/cli.clinetworkadapter.html" class="tsd-signature-type" data-tsd-kind="Class">CLINetworkAdapter</a></h5>
|
|
</li>
|
|
<li>
|
|
<h5>mnemonic: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>idAddress: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> maxIndex: <span class="tsd-signature-type">number</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
|
|
<a name="gaiaauth" class="tsd-anchor"></a>
|
|
<h3>gaia<wbr>Auth</h3>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
|
|
<li class="tsd-signature tsd-kind-icon">gaia<wbr>Auth<span class="tsd-signature-symbol">(</span>network<span class="tsd-signature-symbol">: </span><a href="../classes/cli.clinetworkadapter.html" class="tsd-signature-type" data-tsd-kind="Class">CLINetworkAdapter</a>, appPrivateKey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span>, hubUrl<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span>, ownerPrivateKey<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"><</span><span class="tsd-signature-type">UserData</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/cli/src/data.ts#L85">packages/cli/src/data.ts:85</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>network: <a href="../classes/cli.clinetworkadapter.html" class="tsd-signature-type" data-tsd-kind="Class">CLINetworkAdapter</a></h5>
|
|
</li>
|
|
<li>
|
|
<h5>appPrivateKey: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>hubUrl: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> ownerPrivateKey: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">UserData</span><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
|
|
<a name="gaiaconnect" class="tsd-anchor"></a>
|
|
<h3>gaia<wbr>Connect</h3>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
|
|
<li class="tsd-signature tsd-kind-icon">gaia<wbr>Connect<span class="tsd-signature-symbol">(</span>network<span class="tsd-signature-symbol">: </span><a href="../classes/cli.clinetworkadapter.html" class="tsd-signature-type" data-tsd-kind="Class">CLINetworkAdapter</a>, gaiaHubUrl<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, privateKey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, ownerPrivateKey<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"><</span><span class="tsd-signature-type">GaiaHubConfig</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/cli/src/data.ts#L114">packages/cli/src/data.ts:114</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>network: <a href="../classes/cli.clinetworkadapter.html" class="tsd-signature-type" data-tsd-kind="Class">CLINetworkAdapter</a></h5>
|
|
</li>
|
|
<li>
|
|
<h5>gaiaHubUrl: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>privateKey: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> ownerPrivateKey: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">GaiaHubConfig</span><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
|
|
<a name="gaiauploadprofile" class="tsd-anchor"></a>
|
|
<h3>gaia<wbr>Upload<wbr>Profile</h3>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
|
|
<li class="tsd-signature tsd-kind-icon">gaia<wbr>Upload<wbr>Profile<span class="tsd-signature-symbol">(</span>network<span class="tsd-signature-symbol">: </span><a href="../classes/cli.clinetworkadapter.html" class="tsd-signature-type" data-tsd-kind="Class">CLINetworkAdapter</a>, gaiaHubURL<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, gaiaData<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, privateKey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, blockstackID<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"><</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/cli/src/data.ts#L221">packages/cli/src/data.ts:221</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>network: <a href="../classes/cli.clinetworkadapter.html" class="tsd-signature-type" data-tsd-kind="Class">CLINetworkAdapter</a></h5>
|
|
</li>
|
|
<li>
|
|
<h5>gaiaHubURL: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>gaiaData: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>privateKey: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> blockstackID: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
|
|
<a name="gaiauploadprofileall" class="tsd-anchor"></a>
|
|
<h3>gaia<wbr>Upload<wbr>Profile<wbr>All</h3>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
|
|
<li class="tsd-signature tsd-kind-icon">gaia<wbr>Upload<wbr>Profile<wbr>All<span class="tsd-signature-symbol">(</span>network<span class="tsd-signature-symbol">: </span><a href="../classes/cli.clinetworkadapter.html" class="tsd-signature-type" data-tsd-kind="Class">CLINetworkAdapter</a>, gaiaUrls<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span>, gaiaData<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, privateKey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, blockstackID<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"><</span><span class="tsd-signature-symbol">{ </span>dataUrls<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">null</span><span class="tsd-signature-symbol">; </span>error<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> }</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/cli/src/data.ts#L251">packages/cli/src/data.ts:251</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>network: <a href="../classes/cli.clinetworkadapter.html" class="tsd-signature-type" data-tsd-kind="Class">CLINetworkAdapter</a></h5>
|
|
</li>
|
|
<li>
|
|
<h5>gaiaUrls: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>gaiaData: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>privateKey: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> blockstackID: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>dataUrls<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">null</span><span class="tsd-signature-symbol">; </span>error<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
|
|
<a name="generateexplorertxpageurl" class="tsd-anchor"></a>
|
|
<h3>generate<wbr>Explorer<wbr>TxPage<wbr>Url</h3>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
|
|
<li class="tsd-signature tsd-kind-icon">generate<wbr>Explorer<wbr>TxPage<wbr>Url<span class="tsd-signature-symbol">(</span>txid<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, network<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">StacksNetwork</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/cli/src/utils.ts#L897">packages/cli/src/utils.ts:897</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>txid: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>network: <span class="tsd-signature-type">StacksNetwork</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
|
|
<a name="getapplicationkeyinfo" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Application<wbr>Key<wbr>Info</h3>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
|
|
<li class="tsd-signature tsd-kind-icon">get<wbr>Application<wbr>Key<wbr>Info<span class="tsd-signature-symbol">(</span>network<span class="tsd-signature-symbol">: </span><a href="../classes/cli.clinetworkadapter.html" class="tsd-signature-type" data-tsd-kind="Class">CLINetworkAdapter</a>, mnemonic<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, idAddress<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, appDomain<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, idIndex<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="cli.html#appkeyinfotype" class="tsd-signature-type" data-tsd-kind="Type alias">AppKeyInfoType</a><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/cli/src/keys.ts#L219">packages/cli/src/keys.ts:219</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>network: <a href="../classes/cli.clinetworkadapter.html" class="tsd-signature-type" data-tsd-kind="Class">CLINetworkAdapter</a></h5>
|
|
</li>
|
|
<li>
|
|
<h5>mnemonic: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>idAddress: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>appDomain: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> idIndex: <span class="tsd-signature-type">number</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="cli.html#appkeyinfotype" class="tsd-signature-type" data-tsd-kind="Type alias">AppKeyInfoType</a><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
|
|
<a name="getbackupphrase" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Backup<wbr>Phrase</h3>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
|
|
<li class="tsd-signature tsd-kind-icon">get<wbr>Backup<wbr>Phrase<span class="tsd-signature-symbol">(</span>backupPhraseOrCiphertext<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, password<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"><</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/cli/src/utils.ts#L660">packages/cli/src/utils.ts:660</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>backupPhraseOrCiphertext: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> password: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
|
|
<a name="getcliopts" class="tsd-anchor"></a>
|
|
<h3>getCLIOpts</h3>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
|
|
<li class="tsd-signature tsd-kind-icon">getCLIOpts<span class="tsd-signature-symbol">(</span>argv<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span>, opts<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">CLI_OPTS</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/cli/src/argparse.ts#L3094">packages/cli/src/argparse.ts:3094</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>argv: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>opts: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = 'deitUxC:F:B:P:D:G:N:H:T:I:m:M:X:u:p:'</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">CLI_OPTS</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
|
|
<a name="getcommandargs" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Command<wbr>Args</h3>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
|
|
<li class="tsd-signature tsd-kind-icon">get<wbr>Command<wbr>Args<span class="tsd-signature-symbol">(</span>command<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, argsList<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><span class="tsd-signature-symbol">{ </span>arguments<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">; </span>error<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>status<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span>arguments<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>error<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">; </span>status<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</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/cli/src/argparse.ts#L3194">packages/cli/src/argparse.ts:3194</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>command: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>argsList: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{ </span>arguments<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">; </span>error<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>status<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span>arguments<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>error<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">; </span>status<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> }</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
|
|
<a name="getgaiaaddressfromprofile" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Gaia<wbr>Address<wbr>From<wbr>Profile</h3>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
|
|
<li class="tsd-signature tsd-kind-icon">get<wbr>Gaia<wbr>Address<wbr>From<wbr>Profile<span class="tsd-signature-symbol">(</span>network<span class="tsd-signature-symbol">: </span><a href="../classes/cli.clinetworkadapter.html" class="tsd-signature-type" data-tsd-kind="Class">CLINetworkAdapter</a>, profile<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, appOrigin<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/cli/src/data.ts#L343">packages/cli/src/data.ts:343</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>network: <a href="../classes/cli.clinetworkadapter.html" class="tsd-signature-type" data-tsd-kind="Class">CLINetworkAdapter</a></h5>
|
|
</li>
|
|
<li>
|
|
<h5>profile: <span class="tsd-signature-type">any</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>appOrigin: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
|
|
<a name="getgaiaaddressfromurl" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Gaia<wbr>Address<wbr>FromURL</h3>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
|
|
<li class="tsd-signature tsd-kind-icon">get<wbr>Gaia<wbr>Address<wbr>FromURL<span class="tsd-signature-symbol">(</span>appUrl<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/cli/src/data.ts#L330">packages/cli/src/data.ts:330</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>appUrl: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
|
|
<a name="getidaddress" class="tsd-anchor"></a>
|
|
<h3>getIDAddress</h3>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
|
|
<li class="tsd-signature tsd-kind-icon">getIDAddress<span class="tsd-signature-symbol">(</span>network<span class="tsd-signature-symbol">: </span><a href="../classes/cli.clinetworkadapter.html" class="tsd-signature-type" data-tsd-kind="Class">CLINetworkAdapter</a>, nameOrIDAddress<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"><</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/cli/src/utils.ts#L719">packages/cli/src/utils.ts:719</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>network: <a href="../classes/cli.clinetworkadapter.html" class="tsd-signature-type" data-tsd-kind="Class">CLINetworkAdapter</a></h5>
|
|
</li>
|
|
<li>
|
|
<h5>nameOrIDAddress: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
|
|
<a name="getidappkeys" class="tsd-anchor"></a>
|
|
<h3>getIDApp<wbr>Keys</h3>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
|
|
<li class="tsd-signature tsd-kind-icon">getIDApp<wbr>Keys<span class="tsd-signature-symbol">(</span>network<span class="tsd-signature-symbol">: </span><a href="../classes/cli.clinetworkadapter.html" class="tsd-signature-type" data-tsd-kind="Class">CLINetworkAdapter</a>, nameOrIDAddress<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, appOrigin<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, mnemonicOrCiphertext<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"><</span><a href="../interfaces/cli.idappkeys.html" class="tsd-signature-type" data-tsd-kind="Interface">IDAppKeys</a><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/cli/src/utils.ts#L762">packages/cli/src/utils.ts:762</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>network: <a href="../classes/cli.clinetworkadapter.html" class="tsd-signature-type" data-tsd-kind="Class">CLINetworkAdapter</a></h5>
|
|
</li>
|
|
<li>
|
|
<h5>nameOrIDAddress: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>appOrigin: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>mnemonicOrCiphertext: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/cli.idappkeys.html" class="tsd-signature-type" data-tsd-kind="Interface">IDAppKeys</a><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
|
|
<a name="getmaxidsearchindex" class="tsd-anchor"></a>
|
|
<h3>get<wbr>MaxIDSearch<wbr>Index</h3>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
|
|
<li class="tsd-signature tsd-kind-icon">get<wbr>MaxIDSearch<wbr>Index<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</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/cli/src/cli.ts#L126">packages/cli/src/cli.ts:126</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
|
|
<a name="getnameinfoeasy" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Name<wbr>Info<wbr>Easy</h3>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
|
|
<li class="tsd-signature tsd-kind-icon">get<wbr>Name<wbr>Info<wbr>Easy<span class="tsd-signature-symbol">(</span>network<span class="tsd-signature-symbol">: </span><a href="../classes/cli.clinetworkadapter.html" class="tsd-signature-type" data-tsd-kind="Class">CLINetworkAdapter</a>, name<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"><</span><a href="cli.html#nameinfotype" class="tsd-signature-type" data-tsd-kind="Type alias">NameInfoType</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</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/cli/src/utils.ts#L556">packages/cli/src/utils.ts:556</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>network: <a href="../classes/cli.clinetworkadapter.html" class="tsd-signature-type" data-tsd-kind="Class">CLINetworkAdapter</a></h5>
|
|
</li>
|
|
<li>
|
|
<h5>name: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="cli.html#nameinfotype" class="tsd-signature-type" data-tsd-kind="Type alias">NameInfoType</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
|
|
<a name="getnetwork" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Network</h3>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
|
|
<li class="tsd-signature tsd-kind-icon">get<wbr>Network<span class="tsd-signature-symbol">(</span>configData<span class="tsd-signature-symbol">: </span><a href="../interfaces/cli.cli_config_type.html" class="tsd-signature-type" data-tsd-kind="Interface">CLI_CONFIG_TYPE</a>, regTest<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BlockstackNetwork</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/cli/src/network.ts#L333">packages/cli/src/network.ts:333</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>configData: <a href="../interfaces/cli.cli_config_type.html" class="tsd-signature-type" data-tsd-kind="Interface">CLI_CONFIG_TYPE</a></h5>
|
|
</li>
|
|
<li>
|
|
<h5>regTest: <span class="tsd-signature-type">boolean</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">BlockstackNetwork</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
|
|
<a name="getownerkeyfromidaddress" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Owner<wbr>Key<wbr>FromIDAddress</h3>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
|
|
<li class="tsd-signature tsd-kind-icon">get<wbr>Owner<wbr>Key<wbr>FromIDAddress<span class="tsd-signature-symbol">(</span>network<span class="tsd-signature-symbol">: </span><a href="../classes/cli.clinetworkadapter.html" class="tsd-signature-type" data-tsd-kind="Class">CLINetworkAdapter</a>, mnemonic<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, idAddress<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"><</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/cli/src/utils.ts#L736">packages/cli/src/utils.ts:736</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>network: <a href="../classes/cli.clinetworkadapter.html" class="tsd-signature-type" data-tsd-kind="Class">CLINetworkAdapter</a></h5>
|
|
</li>
|
|
<li>
|
|
<h5>mnemonic: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>idAddress: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
|
|
<a name="getownerkeyinfo" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Owner<wbr>Key<wbr>Info</h3>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
|
|
<li class="tsd-signature tsd-kind-icon">get<wbr>Owner<wbr>Key<wbr>Info<span class="tsd-signature-symbol">(</span>network<span class="tsd-signature-symbol">: </span><a href="../classes/cli.clinetworkadapter.html" class="tsd-signature-type" data-tsd-kind="Class">CLINetworkAdapter</a>, mnemonic<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, index<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, version<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"><</span><a href="cli.html#ownerkeyinfotype" class="tsd-signature-type" data-tsd-kind="Type alias">OwnerKeyInfoType</a><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/cli/src/keys.ts#L81">packages/cli/src/keys.ts:81</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>network: <a href="../classes/cli.clinetworkadapter.html" class="tsd-signature-type" data-tsd-kind="Class">CLINetworkAdapter</a></h5>
|
|
</li>
|
|
<li>
|
|
<h5>mnemonic: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>index: <span class="tsd-signature-type">number</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>version: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = 'v0.10-current'</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="cli.html#ownerkeyinfotype" class="tsd-signature-type" data-tsd-kind="Type alias">OwnerKeyInfoType</a><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
|
|
<a name="getpaymentkeyinfo" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Payment<wbr>Key<wbr>Info</h3>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
|
|
<li class="tsd-signature tsd-kind-icon">get<wbr>Payment<wbr>Key<wbr>Info<span class="tsd-signature-symbol">(</span>network<span class="tsd-signature-symbol">: </span><a href="../classes/cli.clinetworkadapter.html" class="tsd-signature-type" data-tsd-kind="Class">CLINetworkAdapter</a>, mnemonic<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"><</span><a href="cli.html#paymentkeyinfotype" class="tsd-signature-type" data-tsd-kind="Type alias">PaymentKeyInfoType</a><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/cli/src/keys.ts#L108">packages/cli/src/keys.ts:108</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>network: <a href="../classes/cli.clinetworkadapter.html" class="tsd-signature-type" data-tsd-kind="Class">CLINetworkAdapter</a></h5>
|
|
</li>
|
|
<li>
|
|
<h5>mnemonic: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="cli.html#paymentkeyinfotype" class="tsd-signature-type" data-tsd-kind="Type alias">PaymentKeyInfoType</a><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
|
|
<a name="getprivatekeyaddress" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Private<wbr>Key<wbr>Address</h3>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
|
|
<li class="tsd-signature tsd-kind-icon">get<wbr>Private<wbr>Key<wbr>Address<span class="tsd-signature-symbol">(</span>network<span class="tsd-signature-symbol">: </span><a href="../classes/cli.clinetworkadapter.html" class="tsd-signature-type" data-tsd-kind="Class">CLINetworkAdapter</a>, privateKey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">CLITransactionSigner</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/cli/src/utils.ts#L406">packages/cli/src/utils.ts:406</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>network: <a href="../classes/cli.clinetworkadapter.html" class="tsd-signature-type" data-tsd-kind="Class">CLINetworkAdapter</a></h5>
|
|
</li>
|
|
<li>
|
|
<h5>privateKey: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">CLITransactionSigner</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
|
|
<a name="getpublickeyfromprivatekey" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Public<wbr>Key<wbr>From<wbr>Private<wbr>Key</h3>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
|
|
<li class="tsd-signature tsd-kind-icon">get<wbr>Public<wbr>Key<wbr>From<wbr>Private<wbr>Key<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">string</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/cli/src/utils.ts#L397">packages/cli/src/utils.ts:397</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>privateKey: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
|
|
<a name="getstackswalletkeyinfo" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Stacks<wbr>Wallet<wbr>Key<wbr>Info</h3>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
|
|
<li class="tsd-signature tsd-kind-icon">get<wbr>Stacks<wbr>Wallet<wbr>Key<wbr>Info<span class="tsd-signature-symbol">(</span>network<span class="tsd-signature-symbol">: </span><a href="../classes/cli.clinetworkadapter.html" class="tsd-signature-type" data-tsd-kind="Class">CLINetworkAdapter</a>, mnemonic<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"><</span><a href="cli.html#stackskeyinfotype" class="tsd-signature-type" data-tsd-kind="Type alias">StacksKeyInfoType</a><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/cli/src/keys.ts#L135">packages/cli/src/keys.ts:135</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>network: <a href="../classes/cli.clinetworkadapter.html" class="tsd-signature-type" data-tsd-kind="Class">CLINetworkAdapter</a></h5>
|
|
</li>
|
|
<li>
|
|
<h5>mnemonic: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="cli.html#stackskeyinfotype" class="tsd-signature-type" data-tsd-kind="Type alias">StacksKeyInfoType</a><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
|
|
<a name="getpass" class="tsd-anchor"></a>
|
|
<h3>getpass</h3>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
|
|
<li class="tsd-signature tsd-kind-icon">getpass<span class="tsd-signature-symbol">(</span>promptStr<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, cb<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>passwd<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/cli/src/utils.ts#L632">packages/cli/src/utils.ts:632</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>promptStr: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>cb: <span class="tsd-signature-symbol">(</span>passwd<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></h5>
|
|
<ul class="tsd-parameters">
|
|
<li class="tsd-parameter-signature">
|
|
<ul class="tsd-signatures tsd-kind-type-literal">
|
|
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>passwd<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>passwd: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
|
|
<a name="handleauth" class="tsd-anchor"></a>
|
|
<h3>handle<wbr>Auth</h3>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
|
|
<li class="tsd-signature tsd-kind-icon">handle<wbr>Auth<span class="tsd-signature-symbol">(</span>network<span class="tsd-signature-symbol">: </span><a href="../classes/cli.clinetworkadapter.html" class="tsd-signature-type" data-tsd-kind="Class">CLINetworkAdapter</a>, mnemonic<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, gaiaHubUrl<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, profileGaiaHub<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, port<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, req<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">express.Request</span>, res<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">express.Response</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"><</span><span class="tsd-signature-type">any</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/cli/src/auth.ts#L367">packages/cli/src/auth.ts:367</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>network: <a href="../classes/cli.clinetworkadapter.html" class="tsd-signature-type" data-tsd-kind="Class">CLINetworkAdapter</a></h5>
|
|
</li>
|
|
<li>
|
|
<h5>mnemonic: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>gaiaHubUrl: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>profileGaiaHub: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>port: <span class="tsd-signature-type">number</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>req: <span class="tsd-signature-type">express.Request</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>res: <span class="tsd-signature-type">express.Response</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
|
|
<a name="handlesignin" class="tsd-anchor"></a>
|
|
<h3>handle<wbr>Sign<wbr>In</h3>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
|
|
<li class="tsd-signature tsd-kind-icon">handle<wbr>Sign<wbr>In<span class="tsd-signature-symbol">(</span>network<span class="tsd-signature-symbol">: </span><a href="../classes/cli.clinetworkadapter.html" class="tsd-signature-type" data-tsd-kind="Class">CLINetworkAdapter</a>, mnemonic<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, appGaiaHub<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, profileGaiaHub<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, req<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">express.Request</span>, res<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">express.Response</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"><</span><span class="tsd-signature-type">any</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/cli/src/auth.ts#L590">packages/cli/src/auth.ts:590</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>network: <a href="../classes/cli.clinetworkadapter.html" class="tsd-signature-type" data-tsd-kind="Class">CLINetworkAdapter</a></h5>
|
|
</li>
|
|
<li>
|
|
<h5>mnemonic: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>appGaiaHub: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>profileGaiaHub: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>req: <span class="tsd-signature-type">express.Request</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>res: <span class="tsd-signature-type">express.Response</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
|
|
<a name="haskeys" class="tsd-anchor"></a>
|
|
<h3>has<wbr>Keys</h3>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
|
|
<li class="tsd-signature tsd-kind-icon">has<wbr>Keys<span class="tsd-signature-symbol">(</span>signer<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">CLITransactionSigner</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</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/cli/src/utils.ts#L227">packages/cli/src/utils.ts:227</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>signer: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">CLITransactionSigner</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
|
|
<a name="hash160" class="tsd-anchor"></a>
|
|
<h3>hash160</h3>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
|
|
<li class="tsd-signature tsd-kind-icon">hash160<span class="tsd-signature-symbol">(</span>buff<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</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/cli/src/utils.ts#L449">packages/cli/src/utils.ts:449</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>buff: <span class="tsd-signature-type">Buffer</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Buffer</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
|
|
<a name="issubdomain" class="tsd-anchor"></a>
|
|
<h3>is<wbr>Subdomain</h3>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
|
|
<li class="tsd-signature tsd-kind-icon">is<wbr>Subdomain<span class="tsd-signature-symbol">(</span>name<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">boolean</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/cli/src/utils.ts#L423">packages/cli/src/utils.ts:423</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>name: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
|
|
<a name="istestnetaddress" class="tsd-anchor"></a>
|
|
<h3>is<wbr>Testnet<wbr>Address</h3>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
|
|
<li class="tsd-signature tsd-kind-icon">is<wbr>Testnet<wbr>Address<span class="tsd-signature-symbol">(</span>address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</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/cli/src/utils.ts#L905">packages/cli/src/utils.ts:905</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>address: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
|
|
<a name="loadconfig" class="tsd-anchor"></a>
|
|
<h3>load<wbr>Config</h3>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
|
|
<li class="tsd-signature tsd-kind-icon">load<wbr>Config<span class="tsd-signature-symbol">(</span>configFile<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, networkType<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/cli.cli_config_type.html" class="tsd-signature-type" data-tsd-kind="Interface">CLI_CONFIG_TYPE</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/cli/src/argparse.ts#L3383">packages/cli/src/argparse.ts:3383</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Load the config file and return a config dict.
|
|
If no config file exists, then return the default config.</p>
|
|
</div>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>configpath</dt>
|
|
<dd><p>(string) the path to the config file.</p>
|
|
</dd>
|
|
<dt>networktype</dt>
|
|
<dd><p>(sring) 'mainnet', 'regtest', or 'testnet'</p>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>configFile: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>networkType: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="../interfaces/cli.cli_config_type.html" class="tsd-signature-type" data-tsd-kind="Interface">CLI_CONFIG_TYPE</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
|
|
<a name="loadnamedidentities" class="tsd-anchor"></a>
|
|
<h3>load<wbr>Named<wbr>Identities</h3>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
|
|
<li class="tsd-signature tsd-kind-icon">load<wbr>Named<wbr>Identities<span class="tsd-signature-symbol">(</span>network<span class="tsd-signature-symbol">: </span><a href="../classes/cli.clinetworkadapter.html" class="tsd-signature-type" data-tsd-kind="Class">CLINetworkAdapter</a>, mnemonic<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"><</span><a href="../interfaces/cli.namedidentitytype.html" class="tsd-signature-type" data-tsd-kind="Interface">NamedIdentityType</a><span class="tsd-signature-symbol">[]</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/cli/src/auth.ts#L262">packages/cli/src/auth.ts:262</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>network: <a href="../classes/cli.clinetworkadapter.html" class="tsd-signature-type" data-tsd-kind="Class">CLINetworkAdapter</a></h5>
|
|
</li>
|
|
<li>
|
|
<h5>mnemonic: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/cli.namedidentitytype.html" class="tsd-signature-type" data-tsd-kind="Interface">NamedIdentityType</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
|
|
<a name="makeallcommandshelp" class="tsd-anchor"></a>
|
|
<h3>make<wbr>All<wbr>Commands<wbr>Help</h3>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
|
|
<li class="tsd-signature tsd-kind-icon">make<wbr>All<wbr>Commands<wbr>Help<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/cli/src/argparse.ts#L2990">packages/cli/src/argparse.ts:2990</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
|
|
<a name="makeallcommandslist" class="tsd-anchor"></a>
|
|
<h3>make<wbr>All<wbr>Commands<wbr>List</h3>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
|
|
<li class="tsd-signature tsd-kind-icon">make<wbr>All<wbr>Commands<wbr>List<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/cli/src/argparse.ts#L2959">packages/cli/src/argparse.ts:2959</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
|
|
<a name="makeassociationtoken" class="tsd-anchor"></a>
|
|
<h3>make<wbr>Association<wbr>Token</h3>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
|
|
<li class="tsd-signature tsd-kind-icon">make<wbr>Association<wbr>Token<span class="tsd-signature-symbol">(</span>appPrivateKey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, identityKey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/cli/src/data.ts#L63">packages/cli/src/data.ts:63</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>appPrivateKey: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>identityKey: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
|
|
<a name="makecommandusagestring" class="tsd-anchor"></a>
|
|
<h3>make<wbr>Command<wbr>Usage<wbr>String</h3>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
|
|
<li class="tsd-signature tsd-kind-icon">make<wbr>Command<wbr>Usage<wbr>String<span class="tsd-signature-symbol">(</span>command<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/cli/src/argparse.ts#L3013">packages/cli/src/argparse.ts:3013</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> command: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
|
|
<a name="makedidconfiguration" class="tsd-anchor"></a>
|
|
<h3>makeDIDConfiguration</h3>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
|
|
<li class="tsd-signature tsd-kind-icon">makeDIDConfiguration<span class="tsd-signature-symbol">(</span>network<span class="tsd-signature-symbol">: </span><a href="../classes/cli.clinetworkadapter.html" class="tsd-signature-type" data-tsd-kind="Class">CLINetworkAdapter</a>, blockstackID<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, domain<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</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"><</span><span class="tsd-signature-symbol">{ </span>entries<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>did<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>jwt<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><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/cli/src/utils.ts#L481">packages/cli/src/utils.ts:481</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>network: <a href="../classes/cli.clinetworkadapter.html" class="tsd-signature-type" data-tsd-kind="Class">CLINetworkAdapter</a></h5>
|
|
</li>
|
|
<li>
|
|
<h5>blockstackID: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>domain: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>privateKey: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>entries<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>did<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>jwt<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><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
|
|
<a name="makeprofilejwt" class="tsd-anchor"></a>
|
|
<h3>make<wbr>ProfileJWT</h3>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
|
|
<li class="tsd-signature tsd-kind-icon">make<wbr>ProfileJWT<span class="tsd-signature-symbol">(</span>profileData<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Object</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">string</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/cli/src/utils.ts#L474">packages/cli/src/utils.ts:474</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>profileData: <span class="tsd-signature-type">Object</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>privateKey: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
|
|
<a name="makepromptsfromarglist" class="tsd-anchor"></a>
|
|
<h3>make<wbr>Prompts<wbr>From<wbr>Arg<wbr>List</h3>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
|
|
<li class="tsd-signature tsd-kind-icon">make<wbr>Prompts<wbr>From<wbr>Arg<wbr>List<span class="tsd-signature-symbol">(</span>expectedArgs<span class="tsd-signature-symbol">: </span><a href="../interfaces/cli.clarityfunctionarg.html" class="tsd-signature-type" data-tsd-kind="Interface">ClarityFunctionArg</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">InquirerPrompt</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/cli/src/utils.ts#L788">packages/cli/src/utils.ts:788</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>expectedArgs: <a href="../interfaces/cli.clarityfunctionarg.html" class="tsd-signature-type" data-tsd-kind="Interface">ClarityFunctionArg</a><span class="tsd-signature-symbol">[]</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">InquirerPrompt</span><span class="tsd-signature-symbol">[]</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
|
|
<a name="makeusagestring" class="tsd-anchor"></a>
|
|
<h3>make<wbr>Usage<wbr>String</h3>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
|
|
<li class="tsd-signature tsd-kind-icon">make<wbr>Usage<wbr>String<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/cli/src/argparse.ts#L3044">packages/cli/src/argparse.ts:3044</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
|
|
<a name="makezonefilefromgaiaurl" class="tsd-anchor"></a>
|
|
<h3>make<wbr>Zone<wbr>File<wbr>From<wbr>Gaia<wbr>Url</h3>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
|
|
<li class="tsd-signature tsd-kind-icon">make<wbr>Zone<wbr>File<wbr>From<wbr>Gaia<wbr>Url<span class="tsd-signature-symbol">(</span>network<span class="tsd-signature-symbol">: </span><a href="../classes/cli.clinetworkadapter.html" class="tsd-signature-type" data-tsd-kind="Class">CLINetworkAdapter</a>, name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, gaiaHubUrl<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, ownerKey<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"><</span><span class="tsd-signature-type">any</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/cli/src/data.ts#L296">packages/cli/src/data.ts:296</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>network: <a href="../classes/cli.clinetworkadapter.html" class="tsd-signature-type" data-tsd-kind="Class">CLINetworkAdapter</a></h5>
|
|
</li>
|
|
<li>
|
|
<h5>name: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>gaiaHubUrl: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>ownerKey: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
|
|
<a name="mkdirs" class="tsd-anchor"></a>
|
|
<h3>mkdirs</h3>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
|
|
<li class="tsd-signature tsd-kind-icon">mkdirs<span class="tsd-signature-symbol">(</span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/cli/src/utils.ts#L688">packages/cli/src/utils.ts:688</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>path: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
|
|
<a name="namelookup" class="tsd-anchor"></a>
|
|
<h3>name<wbr>Lookup</h3>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
|
|
<li class="tsd-signature tsd-kind-icon">name<wbr>Lookup<span class="tsd-signature-symbol">(</span>network<span class="tsd-signature-symbol">: </span><a href="../classes/cli.clinetworkadapter.html" class="tsd-signature-type" data-tsd-kind="Class">CLINetworkAdapter</a>, name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, includeProfile<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</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"><</span><span class="tsd-signature-symbol">{ </span>profile<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>profileUrl<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>zonefile<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">></span></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/cli/src/utils.ts#L578">packages/cli/src/utils.ts:578</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>network: <a href="../classes/cli.clinetworkadapter.html" class="tsd-signature-type" data-tsd-kind="Class">CLINetworkAdapter</a></h5>
|
|
</li>
|
|
<li>
|
|
<h5>name: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>includeProfile: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>profile<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>profileUrl<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>zonefile<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
|
|
<a name="parseclarityfunctionarganswers" class="tsd-anchor"></a>
|
|
<h3>parse<wbr>Clarity<wbr>Function<wbr>Arg<wbr>Answers</h3>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
|
|
<li class="tsd-signature tsd-kind-icon">parse<wbr>Clarity<wbr>Function<wbr>Arg<wbr>Answers<span class="tsd-signature-symbol">(</span>answers<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, expectedArgs<span class="tsd-signature-symbol">: </span><a href="../interfaces/cli.clarityfunctionarg.html" class="tsd-signature-type" data-tsd-kind="Interface">ClarityFunctionArg</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ClarityValue</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/cli/src/utils.ts#L853">packages/cli/src/utils.ts:853</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>answers: <span class="tsd-signature-type">any</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>expectedArgs: <a href="../interfaces/cli.clarityfunctionarg.html" class="tsd-signature-type" data-tsd-kind="Interface">ClarityFunctionArg</a><span class="tsd-signature-symbol">[]</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">ClarityValue</span><span class="tsd-signature-symbol">[]</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
|
|
<a name="parsemultisigkeys" class="tsd-anchor"></a>
|
|
<h3>parse<wbr>Multi<wbr>Sig<wbr>Keys</h3>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
|
|
<li class="tsd-signature tsd-kind-icon">parse<wbr>Multi<wbr>Sig<wbr>Keys<span class="tsd-signature-symbol">(</span>serializedPrivateKeys<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="../classes/cli.multisigkeysigner.html" class="tsd-signature-type" data-tsd-kind="Class">MultiSigKeySigner</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/cli/src/utils.ts#L256">packages/cli/src/utils.ts:256</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>serializedPrivateKeys: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="../classes/cli.multisigkeysigner.html" class="tsd-signature-type" data-tsd-kind="Class">MultiSigKeySigner</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
|
|
<a name="parsenullsigner" class="tsd-anchor"></a>
|
|
<h3>parse<wbr>Null<wbr>Signer</h3>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
|
|
<li class="tsd-signature tsd-kind-icon">parse<wbr>Null<wbr>Signer<span class="tsd-signature-symbol">(</span>addrString<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="../classes/cli.nullsigner.html" class="tsd-signature-type" data-tsd-kind="Class">NullSigner</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/cli/src/utils.ts#L241">packages/cli/src/utils.ts:241</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>addrString: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="../classes/cli.nullsigner.html" class="tsd-signature-type" data-tsd-kind="Class">NullSigner</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
|
|
<a name="parsesegwitp2shkeys" class="tsd-anchor"></a>
|
|
<h3>parse<wbr>Segwit<wbr>P2SHKeys</h3>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
|
|
<li class="tsd-signature tsd-kind-icon">parse<wbr>Segwit<wbr>P2SHKeys<span class="tsd-signature-symbol">(</span>serializedPrivateKeys<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="../classes/cli.segwitp2shkeysigner.html" class="tsd-signature-type" data-tsd-kind="Class">SegwitP2SHKeySigner</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/cli/src/utils.ts#L294">packages/cli/src/utils.ts:294</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>serializedPrivateKeys: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="../classes/cli.segwitp2shkeysigner.html" class="tsd-signature-type" data-tsd-kind="Class">SegwitP2SHKeySigner</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
|
|
<a name="printusage" class="tsd-anchor"></a>
|
|
<h3>print<wbr>Usage</h3>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
|
|
<li class="tsd-signature tsd-kind-icon">print<wbr>Usage<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/cli/src/argparse.ts#L3079">packages/cli/src/argparse.ts:3079</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
|
|
<a name="sumutxos" class="tsd-anchor"></a>
|
|
<h3>sumUTXOs</h3>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
|
|
<li class="tsd-signature tsd-kind-icon">sumUTXOs<span class="tsd-signature-symbol">(</span>utxos<span class="tsd-signature-symbol">: </span><a href="../interfaces/cli.utxo.html" class="tsd-signature-type" data-tsd-kind="Interface">UTXO</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</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/cli/src/utils.ts#L442">packages/cli/src/utils.ts:442</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>utxos: <a href="../interfaces/cli.utxo.html" class="tsd-signature-type" data-tsd-kind="Interface">UTXO</a><span class="tsd-signature-symbol">[]</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</section>
|
|
</div>
|
|
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
|
<nav class="tsd-navigation primary">
|
|
<ul>
|
|
<li class=" ">
|
|
<a href="../modules.html">Modules</a>
|
|
</li>
|
|
<li class=" tsd-kind-module">
|
|
<a href="auth.html">auth</a>
|
|
</li>
|
|
<li class=" tsd-kind-module">
|
|
<a href="bns.html">bns</a>
|
|
</li>
|
|
<li class="current tsd-kind-module">
|
|
<a href="cli.html">cli</a>
|
|
</li>
|
|
<li class=" tsd-kind-module">
|
|
<a href="common.html">common</a>
|
|
</li>
|
|
<li class=" tsd-kind-module">
|
|
<a href="encryption.html">encryption</a>
|
|
</li>
|
|
<li class=" tsd-kind-module">
|
|
<a href="keychain.html">keychain</a>
|
|
</li>
|
|
<li class=" tsd-kind-module">
|
|
<a href="network.html">network</a>
|
|
</li>
|
|
<li class=" tsd-kind-module">
|
|
<a href="profile.html">profile</a>
|
|
</li>
|
|
<li class=" tsd-kind-module">
|
|
<a href="stacking.html">stacking</a>
|
|
</li>
|
|
<li class=" tsd-kind-module">
|
|
<a href="storage.html">storage</a>
|
|
</li>
|
|
<li class=" tsd-kind-module">
|
|
<a href="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="auth.html" class="tsd-kind-icon">auth</a>
|
|
</li>
|
|
<li class=" tsd-kind-module">
|
|
<a href="bns.html" class="tsd-kind-icon">bns</a>
|
|
</li>
|
|
</ul>
|
|
<ul class="current">
|
|
<li class="current tsd-kind-module">
|
|
<a href="cli.html" class="tsd-kind-icon">cli</a>
|
|
<ul>
|
|
<li class=" tsd-kind-class tsd-parent-kind-module">
|
|
<a href="../classes/cli.clinetworkadapter.html" class="tsd-kind-icon">CLINetwork<wbr>Adapter</a>
|
|
</li>
|
|
<li class=" tsd-kind-class tsd-parent-kind-module">
|
|
<a href="../classes/cli.multisigkeysigner.html" class="tsd-kind-icon">Multi<wbr>Sig<wbr>Key<wbr>Signer</a>
|
|
</li>
|
|
<li class=" tsd-kind-class tsd-parent-kind-module">
|
|
<a href="../classes/cli.nullsigner.html" class="tsd-kind-icon">Null<wbr>Signer</a>
|
|
</li>
|
|
<li class=" tsd-kind-class tsd-parent-kind-module">
|
|
<a href="../classes/cli.safetyerror.html" class="tsd-kind-icon">Safety<wbr>Error</a>
|
|
</li>
|
|
<li class=" tsd-kind-class tsd-parent-kind-module">
|
|
<a href="../classes/cli.segwitp2shkeysigner.html" class="tsd-kind-icon">Segwit<wbr>P2SHKey<wbr>Signer</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface tsd-parent-kind-module">
|
|
<a href="../interfaces/cli.cli_config_type.html" class="tsd-kind-icon">CLI_<wbr>CONFIG_<wbr>TYPE</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface tsd-parent-kind-module">
|
|
<a href="../interfaces/cli.cli_log_config_type.html" class="tsd-kind-icon">CLI_<wbr>LOG_<wbr>CONFIG_<wbr>TYPE</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface tsd-parent-kind-module">
|
|
<a href="../interfaces/cli.cli_network_opts.html" class="tsd-kind-icon">CLI_<wbr>NETWORK_<wbr>OPTS</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface tsd-parent-kind-module">
|
|
<a href="../interfaces/cli.checkargsfailtype.html" class="tsd-kind-icon">Check<wbr>Args<wbr>Fail<wbr>Type</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface tsd-parent-kind-module">
|
|
<a href="../interfaces/cli.checkargssuccesstype.html" class="tsd-kind-icon">Check<wbr>Args<wbr>Success<wbr>Type</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface tsd-parent-kind-module">
|
|
<a href="../interfaces/cli.clarityfunctionarg.html" class="tsd-kind-icon">Clarity<wbr>Function<wbr>Arg</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface tsd-parent-kind-module">
|
|
<a href="../interfaces/cli.idappkeys.html" class="tsd-kind-icon">IDApp<wbr>Keys</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface tsd-parent-kind-module">
|
|
<a href="../interfaces/cli.namedidentitytype.html" class="tsd-kind-icon">Named<wbr>Identity<wbr>Type</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface tsd-parent-kind-module">
|
|
<a href="../interfaces/cli.pricetype.html" class="tsd-kind-icon">Price<wbr>Type</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface tsd-parent-kind-module">
|
|
<a href="../interfaces/cli.utxo.html" class="tsd-kind-icon">UTXO</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface tsd-parent-kind-module">
|
|
<a href="../interfaces/cli.whoisinfotype.html" class="tsd-kind-icon">Whois<wbr>Info<wbr>Type</a>
|
|
</li>
|
|
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
|
|
<a href="cli.html#appkeyinfotype" class="tsd-kind-icon">App<wbr>Key<wbr>Info<wbr>Type</a>
|
|
</li>
|
|
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
|
|
<a href="cli.html#nameinfotype" class="tsd-kind-icon">Name<wbr>Info<wbr>Type</a>
|
|
</li>
|
|
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
|
|
<a href="cli.html#ownerkeyinfotype" class="tsd-kind-icon">Owner<wbr>Key<wbr>Info<wbr>Type</a>
|
|
</li>
|
|
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
|
|
<a href="cli.html#paymentkeyinfotype" class="tsd-kind-icon">Payment<wbr>Key<wbr>Info<wbr>Type</a>
|
|
</li>
|
|
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
|
|
<a href="cli.html#stackskeyinfotype" class="tsd-kind-icon">Stacks<wbr>Key<wbr>Info<wbr>Type</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable tsd-parent-kind-module">
|
|
<a href="cli.html#address_chars" class="tsd-kind-icon">ADDRESS_<wbr>CHARS</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable tsd-parent-kind-module">
|
|
<a href="cli.html#address_pattern" class="tsd-kind-icon">ADDRESS_<wbr>PATTERN</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable tsd-parent-kind-module">
|
|
<a href="cli.html#boolean_pattern" class="tsd-kind-icon">BOOLEAN_<wbr>PATTERN</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable tsd-parent-kind-module">
|
|
<a href="cli.html#c32_address_chars" class="tsd-kind-icon">C32_<wbr>ADDRESS_<wbr>CHARS</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable tsd-parent-kind-module">
|
|
<a href="cli.html#cli_args" class="tsd-kind-icon">CLI_<wbr>ARGS</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable tsd-parent-kind-module">
|
|
<a href="cli.html#default_config_path" class="tsd-kind-icon">DEFAULT_<wbr>CONFIG_<wbr>PATH</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable tsd-parent-kind-module">
|
|
<a href="cli.html#default_config_regtest_path" class="tsd-kind-icon">DEFAULT_<wbr>CONFIG_<wbr>REGTEST_<wbr>PATH</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable tsd-parent-kind-module">
|
|
<a href="cli.html#default_config_testnet_path" class="tsd-kind-icon">DEFAULT_<wbr>CONFIG_<wbr>TESTNET_<wbr>PATH</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable tsd-parent-kind-module">
|
|
<a href="cli.html#default_max_id_search_index" class="tsd-kind-icon">DEFAULT_<wbr>MAX_<wbr>ID_<wbr>SEARCH_<wbr>INDEX</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable tsd-parent-kind-module">
|
|
<a href="cli.html#derivation_path" class="tsd-kind-icon">DERIVATION_<wbr>PATH</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable tsd-parent-kind-module">
|
|
<a href="cli.html#id_address_pattern" class="tsd-kind-icon">ID_<wbr>ADDRESS_<wbr>PATTERN</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable tsd-parent-kind-module">
|
|
<a href="cli.html#int_pattern" class="tsd-kind-icon">INT_<wbr>PATTERN</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable tsd-parent-kind-module">
|
|
<a href="cli.html#namespace_pattern" class="tsd-kind-icon">NAMESPACE_<wbr>PATTERN</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable tsd-parent-kind-module">
|
|
<a href="cli.html#name_pattern" class="tsd-kind-icon">NAME_<wbr>PATTERN</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable tsd-parent-kind-module">
|
|
<a href="cli.html#private_key_multisig_pattern" class="tsd-kind-icon">PRIVATE_<wbr>KEY_<wbr>MULTISIG_<wbr>PATTERN</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable tsd-parent-kind-module">
|
|
<a href="cli.html#private_key_nosign_pattern" class="tsd-kind-icon">PRIVATE_<wbr>KEY_<wbr>NOSIGN_<wbr>PATTERN</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable tsd-parent-kind-module">
|
|
<a href="cli.html#private_key_pattern" class="tsd-kind-icon">PRIVATE_<wbr>KEY_<wbr>PATTERN</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable tsd-parent-kind-module">
|
|
<a href="cli.html#private_key_pattern_any" class="tsd-kind-icon">PRIVATE_<wbr>KEY_<wbr>PATTERN_<wbr>ANY</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable tsd-parent-kind-module">
|
|
<a href="cli.html#private_key_segwit_p2sh_pattern" class="tsd-kind-icon">PRIVATE_<wbr>KEY_<wbr>SEGWIT_<wbr><wbr>P2SH_<wbr>PATTERN</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable tsd-parent-kind-module">
|
|
<a href="cli.html#private_key_uncompressed_pattern" class="tsd-kind-icon">PRIVATE_<wbr>KEY_<wbr>UNCOMPRESSED_<wbr>PATTERN</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable tsd-parent-kind-module">
|
|
<a href="cli.html#public_key_pattern" class="tsd-kind-icon">PUBLIC_<wbr>KEY_<wbr>PATTERN</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable tsd-parent-kind-module">
|
|
<a href="cli.html#signin_css" class="tsd-kind-icon">SIGNIN_<wbr>CSS</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable tsd-parent-kind-module">
|
|
<a href="cli.html#signin_desc" class="tsd-kind-icon">SIGNIN_<wbr>DESC</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable tsd-parent-kind-module">
|
|
<a href="cli.html#signin_fmt_id" class="tsd-kind-icon">SIGNIN_<wbr>FMT_<wbr>ID</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable tsd-parent-kind-module">
|
|
<a href="cli.html#signin_fmt_name" class="tsd-kind-icon">SIGNIN_<wbr>FMT_<wbr>NAME</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable tsd-parent-kind-module">
|
|
<a href="cli.html#signin_footer" class="tsd-kind-icon">SIGNIN_<wbr>FOOTER</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable tsd-parent-kind-module">
|
|
<a href="cli.html#signin_header" class="tsd-kind-icon">SIGNIN_<wbr>HEADER</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable tsd-parent-kind-module">
|
|
<a href="cli.html#signin_scopes" class="tsd-kind-icon">SIGNIN_<wbr>SCOPES</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable tsd-parent-kind-module">
|
|
<a href="cli.html#stacks_address_pattern" class="tsd-kind-icon">STACKS_<wbr>ADDRESS_<wbr>PATTERN</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable tsd-parent-kind-module">
|
|
<a href="cli.html#strength" class="tsd-kind-icon">STRENGTH</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable tsd-parent-kind-module">
|
|
<a href="cli.html#stx_wallet_compatible_seed_strength" class="tsd-kind-icon">STX_<wbr>WALLET_<wbr>COMPATIBLE_<wbr>SEED_<wbr>STRENGTH</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable tsd-parent-kind-module">
|
|
<a href="cli.html#subdomain_pattern" class="tsd-kind-icon">SUBDOMAIN_<wbr>PATTERN</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable tsd-parent-kind-module">
|
|
<a href="cli.html#txid_pattern" class="tsd-kind-icon">TXID_<wbr>PATTERN</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable tsd-parent-kind-module">
|
|
<a href="cli.html#url_pattern" class="tsd-kind-icon">URL_<wbr>PATTERN</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable tsd-parent-kind-module">
|
|
<a href="cli.html#usage" class="tsd-kind-icon">USAGE</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable tsd-parent-kind-module">
|
|
<a href="cli.html#zonefile_hash_pattern" class="tsd-kind-icon">ZONEFILE_<wbr>HASH_<wbr>PATTERN</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable tsd-parent-kind-module">
|
|
<a href="cli.html#testables" class="tsd-kind-icon">testables</a>
|
|
</li>
|
|
<li class=" tsd-kind-function tsd-parent-kind-module">
|
|
<a href="cli.html#climain" class="tsd-kind-icon">CLIMain</a>
|
|
</li>
|
|
<li class=" tsd-kind-function tsd-parent-kind-module">
|
|
<a href="cli.html#clioptasbool" class="tsd-kind-icon">CLIOpt<wbr>AsBool</a>
|
|
</li>
|
|
<li class=" tsd-kind-function tsd-parent-kind-module">
|
|
<a href="cli.html#clioptasstring" class="tsd-kind-icon">CLIOpt<wbr>AsString</a>
|
|
</li>
|
|
<li class=" tsd-kind-function tsd-parent-kind-module">
|
|
<a href="cli.html#clioptasstringarray" class="tsd-kind-icon">CLIOpt<wbr>AsString<wbr>Array</a>
|
|
</li>
|
|
<li class=" tsd-kind-function tsd-parent-kind-module">
|
|
<a href="cli.html#jsonstringify" class="tsd-kind-icon">JSONStringify</a>
|
|
</li>
|
|
<li class=" tsd-kind-function tsd-parent-kind-module">
|
|
<a href="cli.html#answertoclarityvalue" class="tsd-kind-icon">answer<wbr>ToClarity<wbr>Value</a>
|
|
</li>
|
|
<li class=" tsd-kind-function tsd-parent-kind-module">
|
|
<a href="cli.html#argtoprompt" class="tsd-kind-icon">arg<wbr>ToPrompt</a>
|
|
</li>
|
|
<li class=" tsd-kind-function tsd-parent-kind-module">
|
|
<a href="cli.html#broadcasttransactionandzonefile" class="tsd-kind-icon">broadcast<wbr>Transaction<wbr>And<wbr>Zone<wbr>File</a>
|
|
</li>
|
|
<li class=" tsd-kind-function tsd-parent-kind-module">
|
|
<a href="cli.html#canonicalprivatekey" class="tsd-kind-icon">canonical<wbr>Private<wbr>Key</a>
|
|
</li>
|
|
<li class=" tsd-kind-function tsd-parent-kind-module">
|
|
<a href="cli.html#checkargs" class="tsd-kind-icon">check<wbr>Args</a>
|
|
</li>
|
|
<li class=" tsd-kind-function tsd-parent-kind-module">
|
|
<a href="cli.html#checkurl" class="tsd-kind-icon">check<wbr>Url</a>
|
|
</li>
|
|
<li class=" tsd-kind-function tsd-parent-kind-module">
|
|
<a href="cli.html#decodeprivatekey" class="tsd-kind-icon">decode<wbr>Private<wbr>Key</a>
|
|
</li>
|
|
<li class=" tsd-kind-function tsd-parent-kind-module">
|
|
<a href="cli.html#decryptbackupphrase" class="tsd-kind-icon">decrypt<wbr>Backup<wbr>Phrase</a>
|
|
</li>
|
|
<li class=" tsd-kind-function tsd-parent-kind-module">
|
|
<a href="cli.html#encryptbackupphrase" class="tsd-kind-icon">encrypt<wbr>Backup<wbr>Phrase</a>
|
|
</li>
|
|
<li class=" tsd-kind-function tsd-parent-kind-module">
|
|
<a href="cli.html#extractappkey" class="tsd-kind-icon">extract<wbr>App<wbr>Key</a>
|
|
</li>
|
|
<li class=" tsd-kind-function tsd-parent-kind-module">
|
|
<a href="cli.html#findidentityindex" class="tsd-kind-icon">find<wbr>Identity<wbr>Index</a>
|
|
</li>
|
|
<li class=" tsd-kind-function tsd-parent-kind-module">
|
|
<a href="cli.html#gaiaauth" class="tsd-kind-icon">gaia<wbr>Auth</a>
|
|
</li>
|
|
<li class=" tsd-kind-function tsd-parent-kind-module">
|
|
<a href="cli.html#gaiaconnect" class="tsd-kind-icon">gaia<wbr>Connect</a>
|
|
</li>
|
|
<li class=" tsd-kind-function tsd-parent-kind-module">
|
|
<a href="cli.html#gaiauploadprofile" class="tsd-kind-icon">gaia<wbr>Upload<wbr>Profile</a>
|
|
</li>
|
|
<li class=" tsd-kind-function tsd-parent-kind-module">
|
|
<a href="cli.html#gaiauploadprofileall" class="tsd-kind-icon">gaia<wbr>Upload<wbr>Profile<wbr>All</a>
|
|
</li>
|
|
<li class=" tsd-kind-function tsd-parent-kind-module">
|
|
<a href="cli.html#generateexplorertxpageurl" class="tsd-kind-icon">generate<wbr>Explorer<wbr>TxPage<wbr>Url</a>
|
|
</li>
|
|
<li class=" tsd-kind-function tsd-parent-kind-module">
|
|
<a href="cli.html#getapplicationkeyinfo" class="tsd-kind-icon">get<wbr>Application<wbr>Key<wbr>Info</a>
|
|
</li>
|
|
<li class=" tsd-kind-function tsd-parent-kind-module">
|
|
<a href="cli.html#getbackupphrase" class="tsd-kind-icon">get<wbr>Backup<wbr>Phrase</a>
|
|
</li>
|
|
<li class=" tsd-kind-function tsd-parent-kind-module">
|
|
<a href="cli.html#getcliopts" class="tsd-kind-icon">getCLIOpts</a>
|
|
</li>
|
|
<li class=" tsd-kind-function tsd-parent-kind-module">
|
|
<a href="cli.html#getcommandargs" class="tsd-kind-icon">get<wbr>Command<wbr>Args</a>
|
|
</li>
|
|
<li class=" tsd-kind-function tsd-parent-kind-module">
|
|
<a href="cli.html#getgaiaaddressfromprofile" class="tsd-kind-icon">get<wbr>Gaia<wbr>Address<wbr>From<wbr>Profile</a>
|
|
</li>
|
|
<li class=" tsd-kind-function tsd-parent-kind-module">
|
|
<a href="cli.html#getgaiaaddressfromurl" class="tsd-kind-icon">get<wbr>Gaia<wbr>Address<wbr>FromURL</a>
|
|
</li>
|
|
<li class=" tsd-kind-function tsd-parent-kind-module">
|
|
<a href="cli.html#getidaddress" class="tsd-kind-icon">getIDAddress</a>
|
|
</li>
|
|
<li class=" tsd-kind-function tsd-parent-kind-module">
|
|
<a href="cli.html#getidappkeys" class="tsd-kind-icon">getIDApp<wbr>Keys</a>
|
|
</li>
|
|
<li class=" tsd-kind-function tsd-parent-kind-module">
|
|
<a href="cli.html#getmaxidsearchindex" class="tsd-kind-icon">get<wbr>MaxIDSearch<wbr>Index</a>
|
|
</li>
|
|
<li class=" tsd-kind-function tsd-parent-kind-module">
|
|
<a href="cli.html#getnameinfoeasy" class="tsd-kind-icon">get<wbr>Name<wbr>Info<wbr>Easy</a>
|
|
</li>
|
|
<li class=" tsd-kind-function tsd-parent-kind-module">
|
|
<a href="cli.html#getnetwork" class="tsd-kind-icon">get<wbr>Network</a>
|
|
</li>
|
|
<li class=" tsd-kind-function tsd-parent-kind-module">
|
|
<a href="cli.html#getownerkeyfromidaddress" class="tsd-kind-icon">get<wbr>Owner<wbr>Key<wbr>FromIDAddress</a>
|
|
</li>
|
|
<li class=" tsd-kind-function tsd-parent-kind-module">
|
|
<a href="cli.html#getownerkeyinfo" class="tsd-kind-icon">get<wbr>Owner<wbr>Key<wbr>Info</a>
|
|
</li>
|
|
<li class=" tsd-kind-function tsd-parent-kind-module">
|
|
<a href="cli.html#getpaymentkeyinfo" class="tsd-kind-icon">get<wbr>Payment<wbr>Key<wbr>Info</a>
|
|
</li>
|
|
<li class=" tsd-kind-function tsd-parent-kind-module">
|
|
<a href="cli.html#getprivatekeyaddress" class="tsd-kind-icon">get<wbr>Private<wbr>Key<wbr>Address</a>
|
|
</li>
|
|
<li class=" tsd-kind-function tsd-parent-kind-module">
|
|
<a href="cli.html#getpublickeyfromprivatekey" class="tsd-kind-icon">get<wbr>Public<wbr>Key<wbr>From<wbr>Private<wbr>Key</a>
|
|
</li>
|
|
<li class=" tsd-kind-function tsd-parent-kind-module">
|
|
<a href="cli.html#getstackswalletkeyinfo" class="tsd-kind-icon">get<wbr>Stacks<wbr>Wallet<wbr>Key<wbr>Info</a>
|
|
</li>
|
|
<li class=" tsd-kind-function tsd-parent-kind-module">
|
|
<a href="cli.html#getpass" class="tsd-kind-icon">getpass</a>
|
|
</li>
|
|
<li class=" tsd-kind-function tsd-parent-kind-module">
|
|
<a href="cli.html#handleauth" class="tsd-kind-icon">handle<wbr>Auth</a>
|
|
</li>
|
|
<li class=" tsd-kind-function tsd-parent-kind-module">
|
|
<a href="cli.html#handlesignin" class="tsd-kind-icon">handle<wbr>Sign<wbr>In</a>
|
|
</li>
|
|
<li class=" tsd-kind-function tsd-parent-kind-module">
|
|
<a href="cli.html#haskeys" class="tsd-kind-icon">has<wbr>Keys</a>
|
|
</li>
|
|
<li class=" tsd-kind-function tsd-parent-kind-module">
|
|
<a href="cli.html#hash160" class="tsd-kind-icon">hash160</a>
|
|
</li>
|
|
<li class=" tsd-kind-function tsd-parent-kind-module">
|
|
<a href="cli.html#issubdomain" class="tsd-kind-icon">is<wbr>Subdomain</a>
|
|
</li>
|
|
<li class=" tsd-kind-function tsd-parent-kind-module">
|
|
<a href="cli.html#istestnetaddress" class="tsd-kind-icon">is<wbr>Testnet<wbr>Address</a>
|
|
</li>
|
|
<li class=" tsd-kind-function tsd-parent-kind-module">
|
|
<a href="cli.html#loadconfig" class="tsd-kind-icon">load<wbr>Config</a>
|
|
</li>
|
|
<li class=" tsd-kind-function tsd-parent-kind-module">
|
|
<a href="cli.html#loadnamedidentities" class="tsd-kind-icon">load<wbr>Named<wbr>Identities</a>
|
|
</li>
|
|
<li class=" tsd-kind-function tsd-parent-kind-module">
|
|
<a href="cli.html#makeallcommandshelp" class="tsd-kind-icon">make<wbr>All<wbr>Commands<wbr>Help</a>
|
|
</li>
|
|
<li class=" tsd-kind-function tsd-parent-kind-module">
|
|
<a href="cli.html#makeallcommandslist" class="tsd-kind-icon">make<wbr>All<wbr>Commands<wbr>List</a>
|
|
</li>
|
|
<li class=" tsd-kind-function tsd-parent-kind-module">
|
|
<a href="cli.html#makeassociationtoken" class="tsd-kind-icon">make<wbr>Association<wbr>Token</a>
|
|
</li>
|
|
<li class=" tsd-kind-function tsd-parent-kind-module">
|
|
<a href="cli.html#makecommandusagestring" class="tsd-kind-icon">make<wbr>Command<wbr>Usage<wbr>String</a>
|
|
</li>
|
|
<li class=" tsd-kind-function tsd-parent-kind-module">
|
|
<a href="cli.html#makedidconfiguration" class="tsd-kind-icon">makeDIDConfiguration</a>
|
|
</li>
|
|
<li class=" tsd-kind-function tsd-parent-kind-module">
|
|
<a href="cli.html#makeprofilejwt" class="tsd-kind-icon">make<wbr>ProfileJWT</a>
|
|
</li>
|
|
<li class=" tsd-kind-function tsd-parent-kind-module">
|
|
<a href="cli.html#makepromptsfromarglist" class="tsd-kind-icon">make<wbr>Prompts<wbr>From<wbr>Arg<wbr>List</a>
|
|
</li>
|
|
<li class=" tsd-kind-function tsd-parent-kind-module">
|
|
<a href="cli.html#makeusagestring" class="tsd-kind-icon">make<wbr>Usage<wbr>String</a>
|
|
</li>
|
|
<li class=" tsd-kind-function tsd-parent-kind-module">
|
|
<a href="cli.html#makezonefilefromgaiaurl" class="tsd-kind-icon">make<wbr>Zone<wbr>File<wbr>From<wbr>Gaia<wbr>Url</a>
|
|
</li>
|
|
<li class=" tsd-kind-function tsd-parent-kind-module">
|
|
<a href="cli.html#mkdirs" class="tsd-kind-icon">mkdirs</a>
|
|
</li>
|
|
<li class=" tsd-kind-function tsd-parent-kind-module">
|
|
<a href="cli.html#namelookup" class="tsd-kind-icon">name<wbr>Lookup</a>
|
|
</li>
|
|
<li class=" tsd-kind-function tsd-parent-kind-module">
|
|
<a href="cli.html#parseclarityfunctionarganswers" class="tsd-kind-icon">parse<wbr>Clarity<wbr>Function<wbr>Arg<wbr>Answers</a>
|
|
</li>
|
|
<li class=" tsd-kind-function tsd-parent-kind-module">
|
|
<a href="cli.html#parsemultisigkeys" class="tsd-kind-icon">parse<wbr>Multi<wbr>Sig<wbr>Keys</a>
|
|
</li>
|
|
<li class=" tsd-kind-function tsd-parent-kind-module">
|
|
<a href="cli.html#parsenullsigner" class="tsd-kind-icon">parse<wbr>Null<wbr>Signer</a>
|
|
</li>
|
|
<li class=" tsd-kind-function tsd-parent-kind-module">
|
|
<a href="cli.html#parsesegwitp2shkeys" class="tsd-kind-icon">parse<wbr>Segwit<wbr>P2SHKeys</a>
|
|
</li>
|
|
<li class=" tsd-kind-function tsd-parent-kind-module">
|
|
<a href="cli.html#printusage" class="tsd-kind-icon">print<wbr>Usage</a>
|
|
</li>
|
|
<li class=" tsd-kind-function tsd-parent-kind-module">
|
|
<a href="cli.html#sumutxos" class="tsd-kind-icon">sumUTXOs</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<ul class="after-current">
|
|
<li class=" tsd-kind-module">
|
|
<a href="common.html" class="tsd-kind-icon">common</a>
|
|
</li>
|
|
<li class=" tsd-kind-module">
|
|
<a href="encryption.html" class="tsd-kind-icon">encryption</a>
|
|
</li>
|
|
<li class=" tsd-kind-module">
|
|
<a href="keychain.html" class="tsd-kind-icon">keychain</a>
|
|
</li>
|
|
<li class=" tsd-kind-module">
|
|
<a href="network.html" class="tsd-kind-icon">network</a>
|
|
</li>
|
|
<li class=" tsd-kind-module">
|
|
<a href="profile.html" class="tsd-kind-icon">profile</a>
|
|
</li>
|
|
<li class=" tsd-kind-module">
|
|
<a href="stacking.html" class="tsd-kind-icon">stacking</a>
|
|
</li>
|
|
<li class=" tsd-kind-module">
|
|
<a href="storage.html" class="tsd-kind-icon">storage</a>
|
|
</li>
|
|
<li class=" tsd-kind-module">
|
|
<a href="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>
|
|
</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-interface"><span class="tsd-kind-icon">Interface</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> |