mirror of
https://github.com/alexgo-io/stacks.js.git
synced 2026-01-12 22:52:34 +08:00
16828 lines
1.2 MiB
Vendored
16828 lines
1.2 MiB
Vendored
<!doctype html>
|
|
<html class="default no-js">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
<title>Stacks.js 1.0.0 Library Reference</title>
|
|
<meta name="description" content="Documentation for Stacks.js 1.0.0 Library Reference">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
<link rel="stylesheet" href="assets/css/main.css">
|
|
</head>
|
|
<body>
|
|
<link rel="stylesheet" href="assets/css/custom-style.css">
|
|
<header>
|
|
<div class="tsd-page-toolbar">
|
|
<div class="container">
|
|
<div class="table-wrap">
|
|
<div class="table-cell" id="tsd-search" data-index="assets/js/search.json" data-base=".">
|
|
<div class="field">
|
|
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
|
|
<input id="tsd-search-field" type="text" />
|
|
</div>
|
|
<ul class="results">
|
|
<li class="state loading">Preparing search index...</li>
|
|
<li class="state failure">The search index is not available</li>
|
|
</ul>
|
|
<a href="index.html" class="title">Stacks.js 1.0.0 Library Reference</a>
|
|
</div>
|
|
<div class="table-cell" id="tsd-widgets">
|
|
<div id="tsd-filter">
|
|
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
|
|
<div class="tsd-filter-group">
|
|
<div class="tsd-select" id="tsd-filter-visibility">
|
|
<span class="tsd-select-label">All</span>
|
|
<ul class="tsd-select-list">
|
|
<li data-value="public">Public</li>
|
|
<li data-value="protected">Public/Protected</li>
|
|
<li data-value="private" class="selected">All</li>
|
|
</ul>
|
|
</div>
|
|
<input type="checkbox" id="tsd-filter-inherited" checked />
|
|
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
|
|
<input type="checkbox" id="tsd-filter-only-exported" />
|
|
<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
|
|
</div>
|
|
</div>
|
|
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="tsd-page-title">
|
|
<div class="container">
|
|
<ul class="tsd-breadcrumb">
|
|
<li>
|
|
<a href="globals.html">Globals</a>
|
|
</li>
|
|
</ul>
|
|
<h1>Stacks.js 1.0.0 Library Reference</h1>
|
|
</div>
|
|
</div>
|
|
</header>
|
|
<div class="container container-main">
|
|
<div class="row">
|
|
<div class="col-8 col-content">
|
|
<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>Enumerations</h3>
|
|
<ul class="tsd-index-list">
|
|
<li class="tsd-kind-enum"><a href="enums/addresshashmode.html" class="tsd-kind-icon">Address<wbr>Hash<wbr>Mode</a></li>
|
|
<li class="tsd-kind-enum"><a href="enums/addressversion.html" class="tsd-kind-icon">Address<wbr>Version</a></li>
|
|
<li class="tsd-kind-enum"><a href="enums/anchormode.html" class="tsd-kind-icon">Anchor<wbr>Mode</a></li>
|
|
<li class="tsd-kind-enum"><a href="enums/assettype.html" class="tsd-kind-icon">Asset<wbr>Type</a></li>
|
|
<li class="tsd-kind-enum"><a href="enums/authfieldtype.html" class="tsd-kind-icon">Auth<wbr>Field<wbr>Type</a></li>
|
|
<li class="tsd-kind-enum"><a href="enums/authscope.html" class="tsd-kind-icon">Auth<wbr>Scope</a></li>
|
|
<li class="tsd-kind-enum"><a href="enums/authtype.html" class="tsd-kind-icon">Auth<wbr>Type</a></li>
|
|
<li class="tsd-kind-enum"><a href="enums/chainid.html" class="tsd-kind-icon">ChainID</a></li>
|
|
<li class="tsd-kind-enum"><a href="enums/clarityabitypeid.html" class="tsd-kind-icon">Clarity<wbr>Abi<wbr>Type<wbr>Id</a></li>
|
|
<li class="tsd-kind-enum"><a href="enums/claritytype.html" class="tsd-kind-icon">Clarity<wbr>Type</a></li>
|
|
<li class="tsd-kind-enum"><a href="enums/fungibleconditioncode.html" class="tsd-kind-icon">Fungible<wbr>Condition<wbr>Code</a></li>
|
|
<li class="tsd-kind-enum"><a href="enums/identitynamevalidityerror.html" class="tsd-kind-icon">Identity<wbr>Name<wbr>Validity<wbr>Error</a></li>
|
|
<li class="tsd-kind-enum"><a href="enums/nonfungibleconditioncode.html" class="tsd-kind-icon">Non<wbr>Fungible<wbr>Condition<wbr>Code</a></li>
|
|
<li class="tsd-kind-enum"><a href="enums/payloadtype.html" class="tsd-kind-icon">Payload<wbr>Type</a></li>
|
|
<li class="tsd-kind-enum"><a href="enums/postconditionmode.html" class="tsd-kind-icon">Post<wbr>Condition<wbr>Mode</a></li>
|
|
<li class="tsd-kind-enum"><a href="enums/postconditionprincipalid.html" class="tsd-kind-icon">Post<wbr>Condition<wbr>PrincipalID</a></li>
|
|
<li class="tsd-kind-enum"><a href="enums/postconditiontype.html" class="tsd-kind-icon">Post<wbr>Condition<wbr>Type</a></li>
|
|
<li class="tsd-kind-enum"><a href="enums/pubkeyencoding.html" class="tsd-kind-icon">Pub<wbr>Key<wbr>Encoding</a></li>
|
|
<li class="tsd-kind-enum"><a href="enums/stackingerrors.html" class="tsd-kind-icon">Stacking<wbr>Errors</a></li>
|
|
<li class="tsd-kind-enum"><a href="enums/stacksmessagetype.html" class="tsd-kind-icon">Stacks<wbr>Message<wbr>Type</a></li>
|
|
<li class="tsd-kind-enum"><a href="enums/subdomains.html" class="tsd-kind-icon">Subdomains</a></li>
|
|
<li class="tsd-kind-enum"><a href="enums/transactionversion.html" class="tsd-kind-icon">Transaction<wbr>Version</a></li>
|
|
<li class="tsd-kind-enum"><a href="enums/txrejectedreason.html" class="tsd-kind-icon">Tx<wbr>Rejected<wbr>Reason</a></li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-index-section ">
|
|
<h3>Classes</h3>
|
|
<ul class="tsd-index-list">
|
|
<li class="tsd-kind-class"><a href="classes/appconfig.html" class="tsd-kind-icon">App<wbr>Config</a></li>
|
|
<li class="tsd-kind-class"><a href="classes/authorization.html" class="tsd-kind-icon">Authorization</a></li>
|
|
<li class="tsd-kind-class"><a href="classes/bufferarray.html" class="tsd-kind-icon">Buffer<wbr>Array</a></li>
|
|
<li class="tsd-kind-class"><a href="classes/bufferreader.html" class="tsd-kind-icon">Buffer<wbr>Reader</a></li>
|
|
<li class="tsd-kind-class"><a href="classes/clinetworkadapter.html" class="tsd-kind-icon">CLINetwork<wbr>Adapter</a></li>
|
|
<li class="tsd-kind-class"><a href="classes/clitransactionsigner.html" class="tsd-kind-icon">CLITransaction<wbr>Signer</a></li>
|
|
<li class="tsd-kind-class"><a href="classes/deserializable.html" class="tsd-kind-icon">Deserializable</a></li>
|
|
<li class="tsd-kind-class"><a href="classes/deserializationerror.html" class="tsd-kind-icon">Deserialization<wbr>Error</a></li>
|
|
<li class="tsd-kind-class"><a href="classes/identity.html" class="tsd-kind-icon">Identity</a></li>
|
|
<li class="tsd-kind-class"><a href="classes/identityaddressownernode.html" class="tsd-kind-icon">Identity<wbr>Address<wbr>Owner<wbr>Node</a></li>
|
|
<li class="tsd-kind-class"><a href="classes/multisigkeysigner.html" class="tsd-kind-icon">Multi<wbr>Sig<wbr>Key<wbr>Signer</a></li>
|
|
<li class="tsd-kind-class"><a href="classes/nodecryptoaescipher.html" class="tsd-kind-icon">Node<wbr>Crypto<wbr>Aes<wbr>Cipher</a></li>
|
|
<li class="tsd-kind-class"><a href="classes/nodecryptohmacsha256.html" class="tsd-kind-icon">Node<wbr>Crypto<wbr>Hmac<wbr>Sha256</a></li>
|
|
<li class="tsd-kind-class"><a href="classes/nodecryptopbkdf2.html" class="tsd-kind-icon">Node<wbr>Crypto<wbr>Pbkdf2</a></li>
|
|
<li class="tsd-kind-class"><a href="classes/nodecryptoripemd160digest.html" class="tsd-kind-icon">Node<wbr>Crypto<wbr>Ripemd160<wbr>Digest</a></li>
|
|
<li class="tsd-kind-class"><a href="classes/nodecryptosha2hash.html" class="tsd-kind-icon">Node<wbr>Crypto<wbr>Sha2<wbr>Hash</a></li>
|
|
<li class="tsd-kind-class"><a href="classes/notimplementederror.html" class="tsd-kind-icon">Not<wbr>Implemented<wbr>Error</a></li>
|
|
<li class="tsd-kind-class"><a href="classes/nullsigner.html" class="tsd-kind-icon">Null<wbr>Signer</a></li>
|
|
<li class="tsd-kind-class"><a href="classes/passworderror.html" class="tsd-kind-icon">Password<wbr>Error</a></li>
|
|
<li class="tsd-kind-class"><a href="classes/profile.html" class="tsd-kind-icon">Profile</a></li>
|
|
<li class="tsd-kind-class"><a href="classes/ripemd160polyfilldigest.html" class="tsd-kind-icon">Ripemd160<wbr>Polyfill<wbr>Digest</a></li>
|
|
<li class="tsd-kind-class"><a href="classes/safetyerror.html" class="tsd-kind-icon">Safety<wbr>Error</a></li>
|
|
<li class="tsd-kind-class"><a href="classes/segwitp2shkeysigner.html" class="tsd-kind-icon">Segwit<wbr>P2SHKey<wbr>Signer</a></li>
|
|
<li class="tsd-kind-class"><a href="classes/serializationerror.html" class="tsd-kind-icon">Serialization<wbr>Error</a></li>
|
|
<li class="tsd-kind-class"><a href="classes/sessiondatastore.html" class="tsd-kind-icon">Session<wbr>Data<wbr>Store</a></li>
|
|
<li class="tsd-kind-class"><a href="classes/signingerror.html" class="tsd-kind-icon">Signing<wbr>Error</a></li>
|
|
<li class="tsd-kind-class"><a href="classes/sponsoredauthorization.html" class="tsd-kind-icon">Sponsored<wbr>Authorization</a></li>
|
|
<li class="tsd-kind-class"><a href="classes/stackingclient.html" class="tsd-kind-icon">Stacking<wbr>Client</a></li>
|
|
<li class="tsd-kind-class"><a href="classes/stacksmainnet.html" class="tsd-kind-icon">Stacks<wbr>Mainnet</a></li>
|
|
<li class="tsd-kind-class"><a href="classes/stacksmocknet.html" class="tsd-kind-icon">Stacks<wbr>Mocknet</a></li>
|
|
<li class="tsd-kind-class"><a href="classes/stackstestnet.html" class="tsd-kind-icon">Stacks<wbr>Testnet</a></li>
|
|
<li class="tsd-kind-class"><a href="classes/stackstransaction.html" class="tsd-kind-icon">Stacks<wbr>Transaction</a></li>
|
|
<li class="tsd-kind-class"><a href="classes/stackstransactionerror.html" class="tsd-kind-icon">Stacks<wbr>Transaction<wbr>Error</a></li>
|
|
<li class="tsd-kind-class"><a href="classes/standardauthorization.html" class="tsd-kind-icon">Standard<wbr>Authorization</a></li>
|
|
<li class="tsd-kind-class"><a href="classes/storage.html" class="tsd-kind-icon">Storage</a></li>
|
|
<li class="tsd-kind-class"><a href="classes/transactionsigner.html" class="tsd-kind-icon">Transaction<wbr>Signer</a></li>
|
|
<li class="tsd-kind-class"><a href="classes/usersession.html" class="tsd-kind-icon">User<wbr>Session</a></li>
|
|
<li class="tsd-kind-class"><a href="classes/verificationerror.html" class="tsd-kind-icon">Verification<wbr>Error</a></li>
|
|
<li class="tsd-kind-class"><a href="classes/wallet.html" class="tsd-kind-icon">Wallet</a></li>
|
|
<li class="tsd-kind-class"><a href="classes/walletsigner.html" class="tsd-kind-icon">Wallet<wbr>Signer</a></li>
|
|
<li class="tsd-kind-class"><a href="classes/webcryptoaescipher.html" class="tsd-kind-icon">Web<wbr>Crypto<wbr>Aes<wbr>Cipher</a></li>
|
|
<li class="tsd-kind-class"><a href="classes/webcryptohmacsha256.html" class="tsd-kind-icon">Web<wbr>Crypto<wbr>Hmac<wbr>Sha256</a></li>
|
|
<li class="tsd-kind-class"><a href="classes/webcryptopartialpbkdf2.html" class="tsd-kind-icon">Web<wbr>Crypto<wbr>Partial<wbr>Pbkdf2</a></li>
|
|
<li class="tsd-kind-class"><a href="classes/webcryptopbkdf2.html" class="tsd-kind-icon">Web<wbr>Crypto<wbr>Pbkdf2</a></li>
|
|
<li class="tsd-kind-class"><a href="classes/webcryptosha2hash.html" class="tsd-kind-icon">Web<wbr>Crypto<wbr>Sha2<wbr>Hash</a></li>
|
|
<li class="tsd-kind-class"><a href="classes/sha512_256.html" class="tsd-kind-icon">sha512_<wbr>256</a></li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-index-section ">
|
|
<h3>Interfaces</h3>
|
|
<ul class="tsd-index-list">
|
|
<li class="tsd-kind-interface"><a href="interfaces/address.html" class="tsd-kind-icon">Address</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/aescipher.html" class="tsd-kind-icon">Aes<wbr>Cipher</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/assetinfo.html" class="tsd-kind-icon">Asset<wbr>Info</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/authrequesttype.html" class="tsd-kind-icon">Auth<wbr>Request<wbr>Type</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/balanceinfo.html" class="tsd-kind-icon">Balance<wbr>Info</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/blocktimeinfo.html" class="tsd-kind-icon">Block<wbr>Time<wbr>Info</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/buffercv.html" class="tsd-kind-icon">BufferCV</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/cli_command_group.html" class="tsd-kind-icon">CLI_<wbr>COMMAND_<wbr>GROUP</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/cli_command_group_item.html" class="tsd-kind-icon">CLI_<wbr>COMMAND_<wbr>GROUP_<wbr>ITEM</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/cli_command_help.html" class="tsd-kind-icon">CLI_<wbr>COMMAND_<wbr>HELP</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/cli_config_type.html" class="tsd-kind-icon">CLI_<wbr>CONFIG_<wbr>TYPE</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/cli_log_config_type.html" class="tsd-kind-icon">CLI_<wbr>LOG_<wbr>CONFIG_<wbr>TYPE</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/cli_network_opts.html" class="tsd-kind-icon">CLI_<wbr>NETWORK_<wbr>OPTS</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/cli_opts.html" class="tsd-kind-icon">CLI_<wbr>OPTS</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/cli_prop.html" class="tsd-kind-icon">CLI_<wbr>PROP</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/cli_prop_item.html" class="tsd-kind-icon">CLI_<wbr>PROP_<wbr>ITEM</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/canlockstxoptions.html" class="tsd-kind-icon">Can<wbr>Lock<wbr>Stx<wbr>Options</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/checkargsfailtype.html" class="tsd-kind-icon">Check<wbr>Args<wbr>Fail<wbr>Type</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/checkargssuccesstype.html" class="tsd-kind-icon">Check<wbr>Args<wbr>Success<wbr>Type</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/clarityabi.html" class="tsd-kind-icon">Clarity<wbr>Abi</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/clarityabifunction.html" class="tsd-kind-icon">Clarity<wbr>Abi<wbr>Function</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/clarityabimap.html" class="tsd-kind-icon">Clarity<wbr>Abi<wbr>Map</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/clarityabitypefungibletoken.html" class="tsd-kind-icon">Clarity<wbr>Abi<wbr>Type<wbr>Fungible<wbr>Token</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/clarityabitypenonfungibletoken.html" class="tsd-kind-icon">Clarity<wbr>Abi<wbr>Type<wbr>Non<wbr>Fungible<wbr>Token</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/clarityabivariable.html" class="tsd-kind-icon">Clarity<wbr>Abi<wbr>Variable</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/clarityfunctionarg.html" class="tsd-kind-icon">Clarity<wbr>Function<wbr>Arg</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/coinbasepayload.html" class="tsd-kind-icon">Coinbase<wbr>Payload</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/configapp.html" class="tsd-kind-icon">Config<wbr>App</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/configidentity.html" class="tsd-kind-icon">Config<wbr>Identity</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/connecttogaiaoptions.html" class="tsd-kind-icon">Connect<wbr>ToGaia<wbr>Options</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/constructoroptions.html" class="tsd-kind-icon">Constructor<wbr>Options</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/contractcalloptions.html" class="tsd-kind-icon">Contract<wbr>Call<wbr>Options</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/contractcallpayload.html" class="tsd-kind-icon">Contract<wbr>Call<wbr>Payload</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/contractdeployoptions.html" class="tsd-kind-icon">Contract<wbr>Deploy<wbr>Options</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/contractprincipal.html" class="tsd-kind-icon">Contract<wbr>Principal</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/contractprincipalcv.html" class="tsd-kind-icon">Contract<wbr>PrincipalCV</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/coreinfo.html" class="tsd-kind-icon">Core<wbr>Info</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/delegatestackstxoptions.html" class="tsd-kind-icon">Delegate<wbr>Stack<wbr>Stx<wbr>Options</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/delegatestxoptions.html" class="tsd-kind-icon">Delegate<wbr>Stx<wbr>Options</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/encryptcontentoptions.html" class="tsd-kind-icon">Encrypt<wbr>Content<wbr>Options</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/encryptionoptions.html" class="tsd-kind-icon">Encryption<wbr>Options</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/falsecv.html" class="tsd-kind-icon">FalseCV</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/fungiblepostcondition.html" class="tsd-kind-icon">Fungible<wbr>Post<wbr>Condition</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/gaiaauthpayload.html" class="tsd-kind-icon">Gaia<wbr>Auth<wbr>Payload</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/gaiahubconfig.html" class="tsd-kind-icon">Gaia<wbr>Hub<wbr>Config</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/getfileoptions.html" class="tsd-kind-icon">Get<wbr>File<wbr>Options</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/getfileurloptions.html" class="tsd-kind-icon">Get<wbr>File<wbr>Url<wbr>Options</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/getglobalobjectoptions.html" class="tsd-kind-icon">Get<wbr>Global<wbr>Object<wbr>Options</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/hmac.html" class="tsd-kind-icon">Hmac</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/huberrordetails.html" class="tsd-kind-icon">Hub<wbr>Error<wbr>Details</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/hubinfo.html" class="tsd-kind-icon">Hub<wbr>Info</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/idappkeys.html" class="tsd-kind-icon">IDApp<wbr>Keys</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/identityconstructoroptions.html" class="tsd-kind-icon">Identity<wbr>Constructor<wbr>Options</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/identitykeypair.html" class="tsd-kind-icon">Identity<wbr>Key<wbr>Pair</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/inquirerprompt.html" class="tsd-kind-icon">Inquirer<wbr>Prompt</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/intcv.html" class="tsd-kind-icon">IntCV</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/lengthprefixedlist.html" class="tsd-kind-icon">Length<wbr>Prefixed<wbr>List</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/lengthprefixedstring.html" class="tsd-kind-icon">Length<wbr>Prefixed<wbr>String</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/listcv.html" class="tsd-kind-icon">ListCV</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/lockstxoptions.html" class="tsd-kind-icon">Lock<wbr>Stx<wbr>Options</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/memostring.html" class="tsd-kind-icon">Memo<wbr>String</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/messagesignature.html" class="tsd-kind-icon">Message<wbr>Signature</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/multisigoptions.html" class="tsd-kind-icon">Multi<wbr>Sig<wbr>Options</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/multisigspendingcondition.html" class="tsd-kind-icon">Multi<wbr>Sig<wbr>Spending<wbr>Condition</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/nameinforesponse.html" class="tsd-kind-icon">Name<wbr>Info<wbr>Response</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/namedidentitytype.html" class="tsd-kind-icon">Named<wbr>Identity<wbr>Type</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/nodecryptolib.html" class="tsd-kind-icon">Node<wbr>Crypto<wbr>Lib</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/nonfungiblepostcondition.html" class="tsd-kind-icon">Non<wbr>Fungible<wbr>Post<wbr>Condition</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/nonecv.html" class="tsd-kind-icon">NoneCV</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/pbkdf2.html" class="tsd-kind-icon">Pbkdf2</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/poisonpayload.html" class="tsd-kind-icon">Poison<wbr>Payload</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/poxinfo.html" class="tsd-kind-icon">Pox<wbr>Info</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/pricetype.html" class="tsd-kind-icon">Price<wbr>Type</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/profileimage.html" class="tsd-kind-icon">Profile<wbr>Image</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/profilelookupoptions.html" class="tsd-kind-icon">Profile<wbr>Lookup<wbr>Options</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/putfileoptions.html" class="tsd-kind-icon">Put<wbr>File<wbr>Options</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/readonlyfunctionerrorresponse.html" class="tsd-kind-icon">Read<wbr>Only<wbr>Function<wbr>Error<wbr>Response</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/readonlyfunctionoptions.html" class="tsd-kind-icon">Read<wbr>Only<wbr>Function<wbr>Options</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/readonlyfunctionsuccessresponse.html" class="tsd-kind-icon">Read<wbr>Only<wbr>Function<wbr>Success<wbr>Response</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/readonlygaiaconfigoptions.html" class="tsd-kind-icon">Read<wbr>Only<wbr>Gaia<wbr>Config<wbr>Options</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/recursivemakeidentitiesoptions.html" class="tsd-kind-icon">Recursive<wbr>Make<wbr>Identities<wbr>Options</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/refreshoptions.html" class="tsd-kind-icon">Refresh<wbr>Options</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/registerparams.html" class="tsd-kind-icon">Register<wbr>Params</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/responseerrorcv.html" class="tsd-kind-icon">Response<wbr>ErrorCV</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/responseokcv.html" class="tsd-kind-icon">Response<wbr>OkCV</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/ripemd160digest.html" class="tsd-kind-icon">Ripemd160<wbr>Digest</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/stxpostcondition.html" class="tsd-kind-icon">STXPost<wbr>Condition</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/stxtransferoptions.html" class="tsd-kind-icon">STXTransfer<wbr>Options</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/sendtoregistrarparams.html" class="tsd-kind-icon">Send<wbr>ToRegistrar<wbr>Params</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/sessionoptions.html" class="tsd-kind-icon">Session<wbr>Options</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/sha2hash.html" class="tsd-kind-icon">Sha2<wbr>Hash</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/signedcontractcalloptions.html" class="tsd-kind-icon">Signed<wbr>Contract<wbr>Call<wbr>Options</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/signedmultisigcontractcalloptions.html" class="tsd-kind-icon">Signed<wbr>Multi<wbr>Sig<wbr>Contract<wbr>Call<wbr>Options</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/signedmultisigtokentransferoptions.html" class="tsd-kind-icon">Signed<wbr>Multi<wbr>Sig<wbr>Token<wbr>Transfer<wbr>Options</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/signedtokentransferoptions.html" class="tsd-kind-icon">Signed<wbr>Token<wbr>Transfer<wbr>Options</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/singlesigspendingcondition.html" class="tsd-kind-icon">Single<wbr>Sig<wbr>Spending<wbr>Condition</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/smartcontractpayload.html" class="tsd-kind-icon">Smart<wbr>Contract<wbr>Payload</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/somecv.html" class="tsd-kind-icon">SomeCV</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/sponsoroptions.html" class="tsd-kind-icon">Sponsor<wbr>Options</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/stackaggregationcommitoptions.html" class="tsd-kind-icon">Stack<wbr>Aggregation<wbr>Commit<wbr>Options</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/stackingeligibility.html" class="tsd-kind-icon">Stacking<wbr>Eligibility</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/stacksnetwork.html" class="tsd-kind-icon">Stacks<wbr>Network</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/stacksprivatekey.html" class="tsd-kind-icon">Stacks<wbr>Private<wbr>Key</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/stackspublickey.html" class="tsd-kind-icon">Stacks<wbr>Public<wbr>Key</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/standardprincipal.html" class="tsd-kind-icon">Standard<wbr>Principal</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/standardprincipalcv.html" class="tsd-kind-icon">Standard<wbr>PrincipalCV</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/storageoptions.html" class="tsd-kind-icon">Storage<wbr>Options</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/stringasciicv.html" class="tsd-kind-icon">String<wbr>AsciiCV</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/stringutf8cv.html" class="tsd-kind-icon">String<wbr>Utf8CV</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/tokentransferoptions.html" class="tsd-kind-icon">Token<wbr>Transfer<wbr>Options</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/tokentransferpayload.html" class="tsd-kind-icon">Token<wbr>Transfer<wbr>Payload</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/transactionauthfield.html" class="tsd-kind-icon">Transaction<wbr>Auth<wbr>Field</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/truecv.html" class="tsd-kind-icon">TrueCV</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/tuplecv.html" class="tsd-kind-icon">TupleCV</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/uintcv.html" class="tsd-kind-icon">UIntCV</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/utxo.html" class="tsd-kind-icon">UTXO</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/unsignedcontractcalloptions.html" class="tsd-kind-icon">Unsigned<wbr>Contract<wbr>Call<wbr>Options</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/unsignedmultisigcontractcalloptions.html" class="tsd-kind-icon">Unsigned<wbr>Multi<wbr>Sig<wbr>Contract<wbr>Call<wbr>Options</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/unsignedmultisigtokentransferoptions.html" class="tsd-kind-icon">Unsigned<wbr>Multi<wbr>Sig<wbr>Token<wbr>Transfer<wbr>Options</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/unsignedtokentransferoptions.html" class="tsd-kind-icon">Unsigned<wbr>Token<wbr>Transfer<wbr>Options</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/uploadresponse.html" class="tsd-kind-icon">Upload<wbr>Response</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/userdata.html" class="tsd-kind-icon">User<wbr>Data</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/walletconfig.html" class="tsd-kind-icon">Wallet<wbr>Config</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/webcryptolib.html" class="tsd-kind-icon">Web<wbr>Crypto<wbr>Lib</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/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"><a href="globals.html#allowedkeyentropybits" class="tsd-kind-icon">Allowed<wbr>Key<wbr>Entropy<wbr>Bits</a></li>
|
|
<li class="tsd-kind-type-alias"><a href="globals.html#anyjson" class="tsd-kind-icon">Any<wbr>Json</a></li>
|
|
<li class="tsd-kind-type-alias"><a href="globals.html#appkeyinfotype" class="tsd-kind-icon">App<wbr>Key<wbr>Info<wbr>Type</a></li>
|
|
<li class="tsd-kind-type-alias"><a href="globals.html#authmetadata" class="tsd-kind-icon">Auth<wbr>Metadata</a></li>
|
|
<li class="tsd-kind-type-alias"><a href="globals.html#booleancv" class="tsd-kind-icon">BooleanCV</a></li>
|
|
<li class="tsd-kind-type-alias"><a href="globals.html#cipheralgorithm" class="tsd-kind-icon">Cipher<wbr>Algorithm</a></li>
|
|
<li class="tsd-kind-type-alias"><a href="globals.html#clarityabitype" class="tsd-kind-icon">Clarity<wbr>Abi<wbr>Type</a></li>
|
|
<li class="tsd-kind-type-alias"><a href="globals.html#clarityabitypebool" class="tsd-kind-icon">Clarity<wbr>Abi<wbr>Type<wbr>Bool</a></li>
|
|
<li class="tsd-kind-type-alias"><a href="globals.html#clarityabitypebuffer" class="tsd-kind-icon">Clarity<wbr>Abi<wbr>Type<wbr>Buffer</a></li>
|
|
<li class="tsd-kind-type-alias"><a href="globals.html#clarityabitypeint128" class="tsd-kind-icon">Clarity<wbr>Abi<wbr>Type<wbr>Int128</a></li>
|
|
<li class="tsd-kind-type-alias"><a href="globals.html#clarityabitypelist" class="tsd-kind-icon">Clarity<wbr>Abi<wbr>Type<wbr>List</a></li>
|
|
<li class="tsd-kind-type-alias"><a href="globals.html#clarityabitypenone" class="tsd-kind-icon">Clarity<wbr>Abi<wbr>Type<wbr>None</a></li>
|
|
<li class="tsd-kind-type-alias"><a href="globals.html#clarityabitypeoptional" class="tsd-kind-icon">Clarity<wbr>Abi<wbr>Type<wbr>Optional</a></li>
|
|
<li class="tsd-kind-type-alias"><a href="globals.html#clarityabitypeprimitive" class="tsd-kind-icon">Clarity<wbr>Abi<wbr>Type<wbr>Primitive</a></li>
|
|
<li class="tsd-kind-type-alias"><a href="globals.html#clarityabitypeprincipal" class="tsd-kind-icon">Clarity<wbr>Abi<wbr>Type<wbr>Principal</a></li>
|
|
<li class="tsd-kind-type-alias"><a href="globals.html#clarityabityperesponse" class="tsd-kind-icon">Clarity<wbr>Abi<wbr>Type<wbr>Response</a></li>
|
|
<li class="tsd-kind-type-alias"><a href="globals.html#clarityabitypestringascii" class="tsd-kind-icon">Clarity<wbr>Abi<wbr>Type<wbr>String<wbr>Ascii</a></li>
|
|
<li class="tsd-kind-type-alias"><a href="globals.html#clarityabitypestringutf8" class="tsd-kind-icon">Clarity<wbr>Abi<wbr>Type<wbr>String<wbr>Utf8</a></li>
|
|
<li class="tsd-kind-type-alias"><a href="globals.html#clarityabitypetraitreference" class="tsd-kind-icon">Clarity<wbr>Abi<wbr>Type<wbr>Trait<wbr>Reference</a></li>
|
|
<li class="tsd-kind-type-alias"><a href="globals.html#clarityabitypetuple" class="tsd-kind-icon">Clarity<wbr>Abi<wbr>Type<wbr>Tuple</a></li>
|
|
<li class="tsd-kind-type-alias"><a href="globals.html#clarityabitypeuint128" class="tsd-kind-icon">Clarity<wbr>Abi<wbr>TypeUInt128</a></li>
|
|
<li class="tsd-kind-type-alias"><a href="globals.html#clarityabitypeunion" class="tsd-kind-icon">Clarity<wbr>Abi<wbr>Type<wbr>Union</a></li>
|
|
<li class="tsd-kind-type-alias"><a href="globals.html#clarityvalue" class="tsd-kind-icon">Clarity<wbr>Value</a></li>
|
|
<li class="tsd-kind-type-alias"><a href="globals.html#commandfunction" class="tsd-kind-icon">Command<wbr>Function</a></li>
|
|
<li class="tsd-kind-type-alias"><a href="globals.html#docsargstype" class="tsd-kind-icon">Docs<wbr>Args<wbr>Type</a></li>
|
|
<li class="tsd-kind-type-alias"><a href="globals.html#etagmap" class="tsd-kind-icon">Etag<wbr>Map</a></li>
|
|
<li class="tsd-kind-type-alias"><a href="globals.html#formatteddocstype" class="tsd-kind-icon">Formatted<wbr>Docs<wbr>Type</a></li>
|
|
<li class="tsd-kind-type-alias"><a href="globals.html#getrandombytes" class="tsd-kind-icon">Get<wbr>Random<wbr>Bytes</a></li>
|
|
<li class="tsd-kind-type-alias"><a href="globals.html#multisighashmode" class="tsd-kind-icon">Multi<wbr>Sig<wbr>Hash<wbr>Mode</a></li>
|
|
<li class="tsd-kind-type-alias"><a href="globals.html#nameinfotype" class="tsd-kind-icon">Name<wbr>Info<wbr>Type</a></li>
|
|
<li class="tsd-kind-type-alias"><a href="globals.html#nodecryptocreatecipher" class="tsd-kind-icon">Node<wbr>Crypto<wbr>Create<wbr>Cipher</a></li>
|
|
<li class="tsd-kind-type-alias"><a href="globals.html#nodecryptocreatedecipher" class="tsd-kind-icon">Node<wbr>Crypto<wbr>Create<wbr>Decipher</a></li>
|
|
<li class="tsd-kind-type-alias"><a href="globals.html#nodecryptocreatehash" class="tsd-kind-icon">Node<wbr>Crypto<wbr>Create<wbr>Hash</a></li>
|
|
<li class="tsd-kind-type-alias"><a href="globals.html#nodecryptocreatehmac" class="tsd-kind-icon">Node<wbr>Crypto<wbr>Create<wbr>Hmac</a></li>
|
|
<li class="tsd-kind-type-alias"><a href="globals.html#nodepbkdf2fn" class="tsd-kind-icon">Node<wbr>Pbkdf2<wbr>Fn</a></li>
|
|
<li class="tsd-kind-type-alias"><a href="globals.html#optionalcv" class="tsd-kind-icon">OptionalCV</a></li>
|
|
<li class="tsd-kind-type-alias"><a href="globals.html#ownerkeyinfotype" class="tsd-kind-icon">Owner<wbr>Key<wbr>Info<wbr>Type</a></li>
|
|
<li class="tsd-kind-type-alias"><a href="globals.html#payload" class="tsd-kind-icon">Payload</a></li>
|
|
<li class="tsd-kind-type-alias"><a href="globals.html#paymentkeyinfotype" class="tsd-kind-icon">Payment<wbr>Key<wbr>Info<wbr>Type</a></li>
|
|
<li class="tsd-kind-type-alias"><a href="globals.html#pbkdf2digests" class="tsd-kind-icon">Pbkdf2<wbr>Digests</a></li>
|
|
<li class="tsd-kind-type-alias"><a href="globals.html#postcondition" class="tsd-kind-icon">Post<wbr>Condition</a></li>
|
|
<li class="tsd-kind-type-alias"><a href="globals.html#postconditionprincipal" class="tsd-kind-icon">Post<wbr>Condition<wbr>Principal</a></li>
|
|
<li class="tsd-kind-type-alias"><a href="globals.html#principalcv" class="tsd-kind-icon">PrincipalCV</a></li>
|
|
<li class="tsd-kind-type-alias"><a href="globals.html#putfilecontent" class="tsd-kind-icon">Put<wbr>File<wbr>Content</a></li>
|
|
<li class="tsd-kind-type-alias"><a href="globals.html#readonlyfunctionresponse" class="tsd-kind-icon">Read<wbr>Only<wbr>Function<wbr>Response</a></li>
|
|
<li class="tsd-kind-type-alias"><a href="globals.html#responsecv" class="tsd-kind-icon">ResponseCV</a></li>
|
|
<li class="tsd-kind-type-alias"><a href="globals.html#singlesighashmode" class="tsd-kind-icon">Single<wbr>Sig<wbr>Hash<wbr>Mode</a></li>
|
|
<li class="tsd-kind-type-alias"><a href="globals.html#spendingcondition" class="tsd-kind-icon">Spending<wbr>Condition</a></li>
|
|
<li class="tsd-kind-type-alias"><a href="globals.html#stackerinfo" class="tsd-kind-icon">Stacker<wbr>Info</a></li>
|
|
<li class="tsd-kind-type-alias"><a href="globals.html#stackskeyinfotype" class="tsd-kind-icon">Stacks<wbr>Key<wbr>Info<wbr>Type</a></li>
|
|
<li class="tsd-kind-type-alias"><a href="globals.html#stacksmessage" class="tsd-kind-icon">Stacks<wbr>Message</a></li>
|
|
<li class="tsd-kind-type-alias"><a href="globals.html#transactionauthfieldcontents" class="tsd-kind-icon">Transaction<wbr>Auth<wbr>Field<wbr>Contents</a></li>
|
|
<li class="tsd-kind-type-alias"><a href="globals.html#triplesecdecryptsignature" class="tsd-kind-icon">Triplesec<wbr>Decrypt<wbr>Signature</a></li>
|
|
<li class="tsd-kind-type-alias"><a href="globals.html#tupledata" class="tsd-kind-icon">Tuple<wbr>Data</a></li>
|
|
<li class="tsd-kind-type-alias"><a href="globals.html#txbroadcastresult" class="tsd-kind-icon">Tx<wbr>Broadcast<wbr>Result</a></li>
|
|
<li class="tsd-kind-type-alias"><a href="globals.html#txbroadcastresultok" class="tsd-kind-icon">Tx<wbr>Broadcast<wbr>Result<wbr>Ok</a></li>
|
|
<li class="tsd-kind-type-alias"><a href="globals.html#txbroadcastresultrejected" class="tsd-kind-icon">Tx<wbr>Broadcast<wbr>Result<wbr>Rejected</a></li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-index-section ">
|
|
<h3>Variables</h3>
|
|
<ul class="tsd-index-list">
|
|
<li class="tsd-kind-variable"><a href="globals.html#address_chars" class="tsd-kind-icon">ADDRESS_<wbr>CHARS</a></li>
|
|
<li class="tsd-kind-variable"><a href="globals.html#address_pattern" class="tsd-kind-icon">ADDRESS_<wbr>PATTERN</a></li>
|
|
<li class="tsd-kind-variable"><a href="globals.html#apps_node_index" class="tsd-kind-icon">APPS_<wbr>NODE_<wbr>INDEX</a></li>
|
|
<li class="tsd-kind-variable"><a href="globals.html#auth_continuation_param" class="tsd-kind-icon">AUTH_<wbr>CONTINUATION_<wbr>PARAM</a></li>
|
|
<li class="tsd-kind-variable"><a href="globals.html#blockstack_on_bitcoin" class="tsd-kind-icon">BLOCKSTACK_<wbr>ON_<wbr>BITCOIN</a></li>
|
|
<li class="tsd-kind-variable"><a href="globals.html#blockstack_test" class="tsd-kind-icon">BLOCKSTACK_<wbr>TEST</a></li>
|
|
<li class="tsd-kind-variable"><a href="globals.html#bn" class="tsd-kind-icon">BN</a></li>
|
|
<li class="tsd-kind-variable"><a href="globals.html#boolean_pattern" class="tsd-kind-icon">BOOLEAN_<wbr>PATTERN</a></li>
|
|
<li class="tsd-kind-variable"><a href="globals.html#c32_address_chars" class="tsd-kind-icon">C32_<wbr>ADDRESS_<wbr>CHARS</a></li>
|
|
<li class="tsd-kind-variable"><a href="globals.html#change_address" class="tsd-kind-icon">CHANGE_<wbr>ADDRESS</a></li>
|
|
<li class="tsd-kind-variable"><a href="globals.html#clarity_int_size" class="tsd-kind-icon">CLARITY_<wbr>INT_<wbr>SIZE</a></li>
|
|
<li class="tsd-kind-variable"><a href="globals.html#coinbase_buffer_length_bytes" class="tsd-kind-icon">COINBASE_<wbr>BUFFER_<wbr>LENGTH_<wbr>BYTES</a></li>
|
|
<li class="tsd-kind-variable"><a href="globals.html#compressed_pubkey_length_bytes" class="tsd-kind-icon">COMPRESSED_<wbr>PUBKEY_<wbr>LENGTH_<wbr>BYTES</a></li>
|
|
<li class="tsd-kind-variable"><a href="globals.html#config_index" class="tsd-kind-icon">CONFIG_<wbr>INDEX</a></li>
|
|
<li class="tsd-kind-variable"><a href="globals.html#context" class="tsd-kind-icon">CONTEXT</a></li>
|
|
<li class="tsd-kind-variable"><a href="globals.html#default_blockstack_host" class="tsd-kind-icon">DEFAULT_<wbr>BLOCKSTACK_<wbr>HOST</a></li>
|
|
<li class="tsd-kind-variable"><a href="globals.html#default_chain_id" class="tsd-kind-icon">DEFAULT_<wbr>CHAIN_<wbr>ID</a></li>
|
|
<li class="tsd-kind-variable"><a href="globals.html#default_config_path" class="tsd-kind-icon">DEFAULT_<wbr>CONFIG_<wbr>PATH</a></li>
|
|
<li class="tsd-kind-variable"><a href="globals.html#default_config_regtest_path" class="tsd-kind-icon">DEFAULT_<wbr>CONFIG_<wbr>REGTEST_<wbr>PATH</a></li>
|
|
<li class="tsd-kind-variable"><a href="globals.html#default_config_testnet_path" class="tsd-kind-icon">DEFAULT_<wbr>CONFIG_<wbr>TESTNET_<wbr>PATH</a></li>
|
|
<li class="tsd-kind-variable"><a href="globals.html#default_core_node_api_url" class="tsd-kind-icon">DEFAULT_<wbr>CORE_<wbr>NODE_<wbr>API_<wbr>URL</a></li>
|
|
<li class="tsd-kind-variable"><a href="globals.html#default_gaia_hub" class="tsd-kind-icon">DEFAULT_<wbr>GAIA_<wbr>HUB</a></li>
|
|
<li class="tsd-kind-variable"><a href="globals.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"><a href="globals.html#default_profile_file_name" class="tsd-kind-icon">DEFAULT_<wbr>PROFILE_<wbr>FILE_<wbr>NAME</a></li>
|
|
<li class="tsd-kind-variable"><a href="globals.html#default_transaction_version" class="tsd-kind-icon">DEFAULT_<wbr>TRANSACTION_<wbr>VERSION</a></li>
|
|
<li class="tsd-kind-variable"><a href="globals.html#derivation_path" class="tsd-kind-icon">DERIVATION_<wbr>PATH</a></li>
|
|
<li class="tsd-kind-variable"><a href="globals.html#echo_reply_param" class="tsd-kind-icon">ECHO_<wbr>REPLY_<wbr>PARAM</a></li>
|
|
<li class="tsd-kind-variable"><a href="globals.html#encryption_node_index" class="tsd-kind-icon">ENCRYPTION_<wbr>NODE_<wbr>INDEX</a></li>
|
|
<li class="tsd-kind-variable"><a href="globals.html#external_address" class="tsd-kind-icon">EXTERNAL_<wbr>ADDRESS</a></li>
|
|
<li class="tsd-kind-variable"><a href="globals.html#global_detection_cache_key" class="tsd-kind-icon">GLOBAL_<wbr>DETECTION_<wbr>CACHE_<wbr>KEY</a></li>
|
|
<li class="tsd-kind-variable"><a href="globals.html#identity_keychain" class="tsd-kind-icon">IDENTITY_<wbr>KEYCHAIN</a></li>
|
|
<li class="tsd-kind-variable"><a href="globals.html#id_address_pattern" class="tsd-kind-icon">ID_<wbr>ADDRESS_<wbr>PATTERN</a></li>
|
|
<li class="tsd-kind-variable"><a href="globals.html#image_type" class="tsd-kind-icon">IMAGE_<wbr>TYPE</a></li>
|
|
<li class="tsd-kind-variable"><a href="globals.html#int_pattern" class="tsd-kind-icon">INT_<wbr>PATTERN</a></li>
|
|
<li class="tsd-kind-variable"><a href="globals.html#max_string_length_bytes" class="tsd-kind-icon">MAX_<wbr>STRING_<wbr>LENGTH_<wbr>BYTES</a></li>
|
|
<li class="tsd-kind-variable"><a href="globals.html#memo_max_length_bytes" class="tsd-kind-icon">MEMO_<wbr>MAX_<wbr>LENGTH_<wbr>BYTES</a></li>
|
|
<li class="tsd-kind-variable"><a href="globals.html#namespace_pattern" class="tsd-kind-icon">NAMESPACE_<wbr>PATTERN</a></li>
|
|
<li class="tsd-kind-variable"><a href="globals.html#name_pattern" class="tsd-kind-icon">NAME_<wbr>PATTERN</a></li>
|
|
<li class="tsd-kind-variable"><a href="globals.html#no_crypto_lib" class="tsd-kind-icon">NO_<wbr>CRYPTO_<wbr>LIB</a></li>
|
|
<li class="tsd-kind-variable"><a href="globals.html#person_type" class="tsd-kind-icon">PERSON_<wbr>TYPE</a></li>
|
|
<li class="tsd-kind-variable"><a href="globals.html#private_key_multisig_pattern" class="tsd-kind-icon">PRIVATE_<wbr>KEY_<wbr>MULTISIG_<wbr>PATTERN</a></li>
|
|
<li class="tsd-kind-variable"><a href="globals.html#private_key_nosign_pattern" class="tsd-kind-icon">PRIVATE_<wbr>KEY_<wbr>NOSIGN_<wbr>PATTERN</a></li>
|
|
<li class="tsd-kind-variable"><a href="globals.html#private_key_pattern" class="tsd-kind-icon">PRIVATE_<wbr>KEY_<wbr>PATTERN</a></li>
|
|
<li class="tsd-kind-variable"><a href="globals.html#private_key_pattern_any" class="tsd-kind-icon">PRIVATE_<wbr>KEY_<wbr>PATTERN_<wbr>ANY</a></li>
|
|
<li class="tsd-kind-variable"><a href="globals.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"><a href="globals.html#private_key_uncompressed_pattern" class="tsd-kind-icon">PRIVATE_<wbr>KEY_<wbr>UNCOMPRESSED_<wbr>PATTERN</a></li>
|
|
<li class="tsd-kind-variable"><a href="globals.html#public_key_pattern" class="tsd-kind-icon">PUBLIC_<wbr>KEY_<wbr>PATTERN</a></li>
|
|
<li class="tsd-kind-variable"><a href="globals.html#public_testnet_host" class="tsd-kind-icon">PUBLIC_<wbr>TESTNET_<wbr>HOST</a></li>
|
|
<li class="tsd-kind-variable"><a href="globals.html#recoverable_ecdsa_sig_length_bytes" class="tsd-kind-icon">RECOVERABLE_<wbr>ECDSA_<wbr>SIG_<wbr>LENGTH_<wbr>BYTES</a></li>
|
|
<li class="tsd-kind-variable"><a href="globals.html#satoshis_per_btc" class="tsd-kind-icon">SATOSHIS_<wbr>PER_<wbr>BTC</a></li>
|
|
<li class="tsd-kind-variable"><a href="globals.html#session_version" class="tsd-kind-icon">SESSION_<wbr>VERSION</a></li>
|
|
<li class="tsd-kind-variable"><a href="globals.html#signature_file_suffix" class="tsd-kind-icon">SIGNATURE_<wbr>FILE_<wbr>SUFFIX</a></li>
|
|
<li class="tsd-kind-variable"><a href="globals.html#signing_node_index" class="tsd-kind-icon">SIGNING_<wbr>NODE_<wbr>INDEX</a></li>
|
|
<li class="tsd-kind-variable"><a href="globals.html#signin_css" class="tsd-kind-icon">SIGNIN_<wbr>CSS</a></li>
|
|
<li class="tsd-kind-variable"><a href="globals.html#signin_desc" class="tsd-kind-icon">SIGNIN_<wbr>DESC</a></li>
|
|
<li class="tsd-kind-variable"><a href="globals.html#signin_fmt_id" class="tsd-kind-icon">SIGNIN_<wbr>FMT_<wbr>ID</a></li>
|
|
<li class="tsd-kind-variable"><a href="globals.html#signin_fmt_name" class="tsd-kind-icon">SIGNIN_<wbr>FMT_<wbr>NAME</a></li>
|
|
<li class="tsd-kind-variable"><a href="globals.html#signin_footer" class="tsd-kind-icon">SIGNIN_<wbr>FOOTER</a></li>
|
|
<li class="tsd-kind-variable"><a href="globals.html#signin_header" class="tsd-kind-icon">SIGNIN_<wbr>HEADER</a></li>
|
|
<li class="tsd-kind-variable"><a href="globals.html#signin_scopes" class="tsd-kind-icon">SIGNIN_<wbr>SCOPES</a></li>
|
|
<li class="tsd-kind-variable"><a href="globals.html#stacks_address_pattern" class="tsd-kind-icon">STACKS_<wbr>ADDRESS_<wbr>PATTERN</a></li>
|
|
<li class="tsd-kind-variable"><a href="globals.html#strength" class="tsd-kind-icon">STRENGTH</a></li>
|
|
<li class="tsd-kind-variable"><a href="globals.html#stx_node_index" class="tsd-kind-icon">STX_<wbr>NODE_<wbr>INDEX</a></li>
|
|
<li class="tsd-kind-variable"><a href="globals.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"><a href="globals.html#subdomain_pattern" class="tsd-kind-icon">SUBDOMAIN_<wbr>PATTERN</a></li>
|
|
<li class="tsd-kind-variable"><a href="globals.html#txid_pattern" class="tsd-kind-icon">TXID_<wbr>PATTERN</a></li>
|
|
<li class="tsd-kind-variable"><a href="globals.html#uncompressed_pubkey_length_bytes" class="tsd-kind-icon">UNCOMPRESSED_<wbr>PUBKEY_<wbr>LENGTH_<wbr>BYTES</a></li>
|
|
<li class="tsd-kind-variable"><a href="globals.html#url_pattern" class="tsd-kind-icon">URL_<wbr>PATTERN</a></li>
|
|
<li class="tsd-kind-variable"><a href="globals.html#usage" class="tsd-kind-icon">USAGE</a></li>
|
|
<li class="tsd-kind-variable"><a href="globals.html#version" class="tsd-kind-icon">VERSION</a></li>
|
|
<li class="tsd-kind-variable"><a href="globals.html#zonefile_hash_pattern" class="tsd-kind-icon">ZONEFILE_<wbr>HASH_<wbr>PATTERN</a></li>
|
|
<li class="tsd-kind-variable"><a href="globals.html#zonefile" class="tsd-kind-icon">Zone<wbr>File</a></li>
|
|
<li class="tsd-kind-variable"><a href="globals.html#authtransitnonce" class="tsd-kind-icon">auth<wbr>Transit<wbr>Nonce</a></li>
|
|
<li class="tsd-kind-variable"><a href="globals.html#c32check" class="tsd-kind-icon">c32check</a></li>
|
|
<li class="tsd-kind-variable"><a href="globals.html#ecurve" class="tsd-kind-icon">ecurve</a></li>
|
|
<li class="tsd-kind-variable"><a href="globals.html#enumcheckfunctions" class="tsd-kind-icon">enum<wbr>Check<wbr>Functions</a></li>
|
|
<li class="tsd-kind-variable"><a href="globals.html#estimateonly" class="tsd-kind-icon">estimate<wbr>Only</a></li>
|
|
<li class="tsd-kind-variable"><a href="globals.html#global" class="tsd-kind-icon">global</a></li>
|
|
<li class="tsd-kind-variable"><a href="globals.html#graceperiod" class="tsd-kind-icon">grace<wbr>Period</a></li>
|
|
<li class="tsd-kind-variable"><a href="globals.html#inttolevel" class="tsd-kind-icon">int<wbr>ToLevel</a></li>
|
|
<li class="tsd-kind-variable"><a href="globals.html#leveltoint" class="tsd-kind-icon">level<wbr>ToInt</a></li>
|
|
<li class="tsd-kind-variable"><a href="globals.html#levels" class="tsd-kind-icon">levels</a></li>
|
|
<li class="tsd-kind-variable"><a href="globals.html#localstorageram" class="tsd-kind-icon">local<wbr>StorageRAM</a></li>
|
|
<li class="tsd-kind-variable"><a href="globals.html#maxidsearchindex" class="tsd-kind-icon">maxIDSearch<wbr>Index</a></li>
|
|
<li class="tsd-kind-variable"><a href="globals.html#networkderivationpath" class="tsd-kind-icon">network<wbr>Derivation<wbr>Path</a></li>
|
|
<li class="tsd-kind-variable"><a href="globals.html#noexit" class="tsd-kind-icon">no<wbr>Exit</a></li>
|
|
<li class="tsd-kind-variable"><a href="globals.html#receivefeesperiod" class="tsd-kind-icon">receive<wbr>Fees<wbr>Period</a></li>
|
|
<li class="tsd-kind-variable"><a href="globals.html#safetychecks" class="tsd-kind-icon">safety<wbr>Checks</a></li>
|
|
<li class="tsd-kind-variable"><a href="globals.html#txonly" class="tsd-kind-icon">tx<wbr>Only</a></li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-index-section ">
|
|
<h3>Functions</h3>
|
|
<ul class="tsd-index-list">
|
|
<li class="tsd-kind-function"><a href="globals.html#climain" class="tsd-kind-icon">CLIMain</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#clioptasbool" class="tsd-kind-icon">CLIOpt<wbr>AsBool</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#clioptasstring" class="tsd-kind-icon">CLIOpt<wbr>AsString</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#clioptasstringarray" class="tsd-kind-icon">CLIOpt<wbr>AsString<wbr>Array</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#jsonstringify" class="tsd-kind-icon">JSONStringify</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#abifunctiontostring" class="tsd-kind-icon">abi<wbr>Function<wbr>ToString</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#addressconvert" class="tsd-kind-icon">address<wbr>Convert</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#addressfromhashmode" class="tsd-kind-icon">address<wbr>From<wbr>Hash<wbr>Mode</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#addressfrompublickeys" class="tsd-kind-icon">address<wbr>From<wbr>Public<wbr>Keys</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#addressfromversionhash" class="tsd-kind-icon">address<wbr>From<wbr>Version<wbr>Hash</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#addresshashmodetoversion" class="tsd-kind-icon">address<wbr>Hash<wbr>Mode<wbr>ToVersion</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#addresstostring" class="tsd-kind-icon">address<wbr>ToString</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#answertoclarityvalue" class="tsd-kind-icon">answer<wbr>ToClarity<wbr>Value</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#argtoprompt" class="tsd-kind-icon">arg<wbr>ToPrompt</a></li>
|
|
<li class="tsd-kind-function tsd-has-type-parameter"><a href="globals.html#assertistruthy" class="tsd-kind-icon">assert<wbr>IsTruthy</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#authdaemon" class="tsd-kind-icon">auth<wbr>Daemon</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#balance" class="tsd-kind-icon">balance</a></li>
|
|
<li class="tsd-kind-function tsd-has-type-parameter"><a href="globals.html#batchify" class="tsd-kind-icon">batchify</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#broadcastrawtransaction" class="tsd-kind-icon">broadcast<wbr>Raw<wbr>Transaction</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#broadcasttransaction" class="tsd-kind-icon">broadcast<wbr>Transaction</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#broadcasttransactionandzonefile" class="tsd-kind-icon">broadcast<wbr>Transaction<wbr>And<wbr>Zone<wbr>File</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#buffercv" class="tsd-kind-icon">bufferCV</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#buffercvfromstring" class="tsd-kind-icon">bufferCVFrom<wbr>String</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#bufferwithtypeid" class="tsd-kind-icon">buffer<wbr>With<wbr>TypeID</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#callreadonlyfunction" class="tsd-kind-icon">call<wbr>Read<wbr>Only<wbr>Function</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#canstack" class="tsd-kind-icon">can<wbr>Stack</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#canonicalprivatekey" class="tsd-kind-icon">canonical<wbr>Private<wbr>Key</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#checkargs" class="tsd-kind-icon">check<wbr>Args</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#checkurl" class="tsd-kind-icon">check<wbr>Url</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#clearcondition" class="tsd-kind-icon">clear<wbr>Condition</a></li>
|
|
<li class="tsd-kind-function tsd-has-type-parameter"><a href="globals.html#clonedeep" class="tsd-kind-icon">clone<wbr>Deep</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#codebodystring" class="tsd-kind-icon">code<wbr>Body<wbr>String</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#connecttogaiahubwithconfig" class="tsd-kind-icon">connect<wbr>ToGaia<wbr>Hub<wbr>With<wbr>Config</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#containslegalcharacters" class="tsd-kind-icon">contains<wbr>Legal<wbr>Characters</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#contractdeploy" class="tsd-kind-icon">contract<wbr>Deploy</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#contractfunctioncall" class="tsd-kind-icon">contract<wbr>Function<wbr>Call</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#contractprincipalcv" class="tsd-kind-icon">contract<wbr>PrincipalCV</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#contractprincipalcvfromaddress" class="tsd-kind-icon">contract<wbr>PrincipalCVFrom<wbr>Address</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#contractprincipalcvfromstandard" class="tsd-kind-icon">contract<wbr>PrincipalCVFrom<wbr>Standard</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#createaddress" class="tsd-kind-icon">create<wbr>Address</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#createassetinfo" class="tsd-kind-icon">create<wbr>Asset<wbr>Info</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#createcipher" class="tsd-kind-icon">create<wbr>Cipher</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#createcoinbasepayload" class="tsd-kind-icon">create<wbr>Coinbase<wbr>Payload</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#createcontractcallpayload" class="tsd-kind-icon">create<wbr>Contract<wbr>Call<wbr>Payload</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#createcontractprincipal" class="tsd-kind-icon">create<wbr>Contract<wbr>Principal</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#createemptyaddress" class="tsd-kind-icon">create<wbr>Empty<wbr>Address</a></li>
|
|
<li class="tsd-kind-function tsd-has-type-parameter"><a href="globals.html#createenumchecker" class="tsd-kind-icon">create<wbr>Enum<wbr>Checker</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#createfungiblepostcondition" class="tsd-kind-icon">create<wbr>Fungible<wbr>Post<wbr>Condition</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#createhashripemd160" class="tsd-kind-icon">create<wbr>Hash<wbr>Ripemd160</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#createhmacsha256" class="tsd-kind-icon">create<wbr>Hmac<wbr>Sha256</a></li>
|
|
<li class="tsd-kind-function tsd-has-type-parameter"><a href="globals.html#createlplist" class="tsd-kind-icon">createLPList</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#createlpstring" class="tsd-kind-icon">createLPString</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#creatememostring" class="tsd-kind-icon">create<wbr>Memo<wbr>String</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#createmessagesignature" class="tsd-kind-icon">create<wbr>Message<wbr>Signature</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#createmultisigspendingcondition" class="tsd-kind-icon">create<wbr>Multi<wbr>Sig<wbr>Spending<wbr>Condition</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#createnonfungiblepostcondition" class="tsd-kind-icon">create<wbr>Non<wbr>Fungible<wbr>Post<wbr>Condition</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#createpbkdf2" class="tsd-kind-icon">create<wbr>Pbkdf2</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#createpoisonpayload" class="tsd-kind-icon">create<wbr>Poison<wbr>Payload</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#createstxpostcondition" class="tsd-kind-icon">createSTXPost<wbr>Condition</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#createsha2hash" class="tsd-kind-icon">create<wbr>Sha2<wbr>Hash</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#createsinglesigspendingcondition" class="tsd-kind-icon">create<wbr>Single<wbr>Sig<wbr>Spending<wbr>Condition</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#createsmartcontractpayload" class="tsd-kind-icon">create<wbr>Smart<wbr>Contract<wbr>Payload</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#createstacksprivatekey" class="tsd-kind-icon">create<wbr>Stacks<wbr>Private<wbr>Key</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#createstackspublickey" class="tsd-kind-icon">create<wbr>Stacks<wbr>Public<wbr>Key</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#createstandardprincipal" class="tsd-kind-icon">create<wbr>Standard<wbr>Principal</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#createtokentransferpayload" class="tsd-kind-icon">create<wbr>Token<wbr>Transfer<wbr>Payload</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#createtransactionauthfield" class="tsd-kind-icon">create<wbr>Transaction<wbr>Auth<wbr>Field</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#cvtohex" class="tsd-kind-icon">cv<wbr>ToHex</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#cvtojson" class="tsd-kind-icon">cv<wbr>ToJSON</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#cvtostring" class="tsd-kind-icon">cv<wbr>ToString</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#cvtovalue" class="tsd-kind-icon">cv<wbr>ToValue</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#decodebtcaddress" class="tsd-kind-icon">decode<wbr>Btc<wbr>Address</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#decodeprivatekey" class="tsd-kind-icon">decode<wbr>Private<wbr>Key</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#decrypt" class="tsd-kind-icon">decrypt</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#decryptbackupphrase" class="tsd-kind-icon">decrypt<wbr>Backup<wbr>Phrase</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#decryptcontent" class="tsd-kind-icon">decrypt<wbr>Content</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#deletefromgaiahub" class="tsd-kind-icon">delete<wbr>From<wbr>Gaia<wbr>Hub</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#deriveidentitykeypair" class="tsd-kind-icon">derive<wbr>Identity<wbr>Key<wbr>Pair</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#deriverootkeychainfrommnemonic" class="tsd-kind-icon">derive<wbr>Root<wbr>Keychain<wbr>From<wbr>Mnemonic</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#derivestxaddresschain" class="tsd-kind-icon">derive<wbr>Stx<wbr>Address<wbr>Chain</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#deserializeaddress" class="tsd-kind-icon">deserialize<wbr>Address</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#deserializeassetinfo" class="tsd-kind-icon">deserialize<wbr>Asset<wbr>Info</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#deserializecv" class="tsd-kind-icon">deserializeCV</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#deserializelplist" class="tsd-kind-icon">deserializeLPList</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#deserializelpstring" class="tsd-kind-icon">deserializeLPString</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#deserializememostring" class="tsd-kind-icon">deserialize<wbr>Memo<wbr>String</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#deserializemessagesignature" class="tsd-kind-icon">deserialize<wbr>Message<wbr>Signature</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#deserializemultisigspendingcondition" class="tsd-kind-icon">deserialize<wbr>Multi<wbr>Sig<wbr>Spending<wbr>Condition</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#deserializepayload" class="tsd-kind-icon">deserialize<wbr>Payload</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#deserializepostcondition" class="tsd-kind-icon">deserialize<wbr>Post<wbr>Condition</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#deserializeprincipal" class="tsd-kind-icon">deserialize<wbr>Principal</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#deserializepublickey" class="tsd-kind-icon">deserialize<wbr>Public<wbr>Key</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#deserializesinglesigspendingcondition" class="tsd-kind-icon">deserialize<wbr>Single<wbr>Sig<wbr>Spending<wbr>Condition</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#deserializespendingcondition" class="tsd-kind-icon">deserialize<wbr>Spending<wbr>Condition</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#deserializestacksmessage" class="tsd-kind-icon">deserialize<wbr>Stacks<wbr>Message</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#deserializetransaction" class="tsd-kind-icon">deserialize<wbr>Transaction</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#deserializetransactionauthfield" class="tsd-kind-icon">deserialize<wbr>Transaction<wbr>Auth<wbr>Field</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#emptymessagesignature" class="tsd-kind-icon">empty<wbr>Message<wbr>Signature</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#encodeclarityvalue" class="tsd-kind-icon">encode<wbr>Clarity<wbr>Value</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#encrypt" class="tsd-kind-icon">encrypt</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#encryptbackupphrase" class="tsd-kind-icon">encrypt<wbr>Backup<wbr>Phrase</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#encryptcontent" class="tsd-kind-icon">encrypt<wbr>Content</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#encryptmnemonicformatted" class="tsd-kind-icon">encrypt<wbr>Mnemonic<wbr>Formatted</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#estimatecontractdeploy" class="tsd-kind-icon">estimate<wbr>Contract<wbr>Deploy</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#estimatecontractfunctioncall" class="tsd-kind-icon">estimate<wbr>Contract<wbr>Function<wbr>Call</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#estimatetransfer" class="tsd-kind-icon">estimate<wbr>Transfer</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#exceedsmaxlengthbytes" class="tsd-kind-icon">exceeds<wbr>Max<wbr>Length<wbr>Bytes</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#extractappkey" class="tsd-kind-icon">extract<wbr>App<wbr>Key</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#extractprofile" class="tsd-kind-icon">extract<wbr>Profile</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#falsecv" class="tsd-kind-icon">falseCV</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#faucetcall" class="tsd-kind-icon">faucet<wbr>Call</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#fetchprofile" class="tsd-kind-icon">fetch<wbr>Profile</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#findidentityindex" class="tsd-kind-icon">find<wbr>Identity<wbr>Index</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#formatcommandhelplines" class="tsd-kind-icon">format<wbr>Command<wbr>Help<wbr>Lines</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#formathelpstring" class="tsd-kind-icon">format<wbr>Help<wbr>String</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#gaiaauth" class="tsd-kind-icon">gaia<wbr>Auth</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#gaiaconnect" class="tsd-kind-icon">gaia<wbr>Connect</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#gaiadeletefile" class="tsd-kind-icon">gaia<wbr>Delete<wbr>File</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#gaiadumpbucket" class="tsd-kind-icon">gaia<wbr>Dump<wbr>Bucket</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#gaiafindprofilename" class="tsd-kind-icon">gaia<wbr>Find<wbr>Profile<wbr>Name</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#gaiagetfile" class="tsd-kind-icon">gaia<wbr>Get<wbr>File</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#gaialistfiles" class="tsd-kind-icon">gaia<wbr>List<wbr>Files</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#gaiaputfile" class="tsd-kind-icon">gaia<wbr>Put<wbr>File</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#gaiarestorebucket" class="tsd-kind-icon">gaia<wbr>Restore<wbr>Bucket</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#gaiasethub" class="tsd-kind-icon">gaia<wbr>Set<wbr>Hub</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#gaiauploadprofile" class="tsd-kind-icon">gaia<wbr>Upload<wbr>Profile</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#gaiauploadprofileall" class="tsd-kind-icon">gaia<wbr>Upload<wbr>Profile<wbr>All</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#generateencryptedmnemonicrootkeychain" class="tsd-kind-icon">generate<wbr>Encrypted<wbr>Mnemonic<wbr>Root<wbr>Keychain</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#generateexplorertxpageurl" class="tsd-kind-icon">generate<wbr>Explorer<wbr>TxPage<wbr>Url</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#generatemnemonicrootkeychain" class="tsd-kind-icon">generate<wbr>Mnemonic<wbr>Root<wbr>Keychain</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#getapiusageerrormessage" class="tsd-kind-icon">getAPIUsage<wbr>Error<wbr>Message</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#getabi" class="tsd-kind-icon">get<wbr>Abi</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#getaccounthistory" class="tsd-kind-icon">get<wbr>Account<wbr>History</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#getaddressfromprivatekey" class="tsd-kind-icon">get<wbr>Address<wbr>From<wbr>Private<wbr>Key</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#getaddressfrompublickey" class="tsd-kind-icon">get<wbr>Address<wbr>From<wbr>Public<wbr>Key</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#getaddresshashmode" class="tsd-kind-icon">get<wbr>Address<wbr>Hash<wbr>Mode</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#getappkeys" class="tsd-kind-icon">get<wbr>App<wbr>Keys</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#getappprivatekey" class="tsd-kind-icon">get<wbr>App<wbr>Private<wbr>Key</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#getapplicationkeyinfo" class="tsd-kind-icon">get<wbr>Application<wbr>Key<wbr>Info</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#getbtcaddress" class="tsd-kind-icon">getBTCAddress</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#getbackupphrase" class="tsd-kind-icon">get<wbr>Backup<wbr>Phrase</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#getbase64outputlength" class="tsd-kind-icon">get<wbr>Base64<wbr>Output<wbr>Length</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#getbitcoinaddressnode" class="tsd-kind-icon">get<wbr>Bitcoin<wbr>Address<wbr>Node</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#getbitcoinprivatekeychain" class="tsd-kind-icon">get<wbr>Bitcoin<wbr>Private<wbr>Keychain</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#getblockchainidentities" class="tsd-kind-icon">get<wbr>Blockchain<wbr>Identities</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#getblockstackerrorfromresponse" class="tsd-kind-icon">get<wbr>Blockstack<wbr>Error<wbr>From<wbr>Response</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#getcliopts" class="tsd-kind-icon">getCLIOpts</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#getcvtypestring" class="tsd-kind-icon">getCVType<wbr>String</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#getcommandargs" class="tsd-kind-icon">get<wbr>Command<wbr>Args</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#getcommandgroups" class="tsd-kind-icon">get<wbr>Command<wbr>Groups</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#getcryptolib" class="tsd-kind-icon">get<wbr>Crypto<wbr>Lib</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#getderivationpath" class="tsd-kind-icon">get<wbr>Derivation<wbr>Path</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#geterrorstring" class="tsd-kind-icon">get<wbr>Error<wbr>String</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#getgaiaaddressfromprofile" class="tsd-kind-icon">get<wbr>Gaia<wbr>Address<wbr>From<wbr>Profile</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#getgaiaaddressfromurl" class="tsd-kind-icon">get<wbr>Gaia<wbr>Address<wbr>FromURL</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#getgaiaerrorresponse" class="tsd-kind-icon">get<wbr>Gaia<wbr>Error<wbr>Response</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#gethubinfo" class="tsd-kind-icon">get<wbr>Hub<wbr>Info</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#gethubprefix" class="tsd-kind-icon">get<wbr>Hub<wbr>Prefix</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#getidaddress" class="tsd-kind-icon">getIDAddress</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#getidappkeys" class="tsd-kind-icon">getIDApp<wbr>Keys</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#getidentityinfo" class="tsd-kind-icon">get<wbr>Identity<wbr>Info</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#getidentityowneraddressnode" class="tsd-kind-icon">get<wbr>Identity<wbr>Owner<wbr>Address<wbr>Node</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#getidentityprivatekeychain" class="tsd-kind-icon">get<wbr>Identity<wbr>Private<wbr>Keychain</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#getkeyaddress" class="tsd-kind-icon">get<wbr>Key<wbr>Address</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#getmaxidsearchindex" class="tsd-kind-icon">get<wbr>MaxIDSearch<wbr>Index</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#getname" class="tsd-kind-icon">get<wbr>Name</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#getnameinfoeasy" class="tsd-kind-icon">get<wbr>Name<wbr>Info<wbr>Easy</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#getnetwork" class="tsd-kind-icon">get<wbr>Network</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#getnodeprivatekey" class="tsd-kind-icon">get<wbr>Node<wbr>Private<wbr>Key</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#getnonce" class="tsd-kind-icon">get<wbr>Nonce</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#getownerkeyfromidaddress" class="tsd-kind-icon">get<wbr>Owner<wbr>Key<wbr>FromIDAddress</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#getownerkeyinfo" class="tsd-kind-icon">get<wbr>Owner<wbr>Key<wbr>Info</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#getownerkeys" class="tsd-kind-icon">get<wbr>Owner<wbr>Keys</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#getpaymentkey" class="tsd-kind-icon">get<wbr>Payment<wbr>Key</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#getpaymentkeyinfo" class="tsd-kind-icon">get<wbr>Payment<wbr>Key<wbr>Info</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#getprivatekeyaddress" class="tsd-kind-icon">get<wbr>Private<wbr>Key<wbr>Address</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#getprofileurlfromzonefile" class="tsd-kind-icon">get<wbr>ProfileURLFrom<wbr>Zone<wbr>File</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#getpublickey" class="tsd-kind-icon">get<wbr>Public<wbr>Key</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#getpublickeyfromprivatekey" class="tsd-kind-icon">get<wbr>Public<wbr>Key<wbr>From<wbr>Private<wbr>Key</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#getquerystringparams" class="tsd-kind-icon">get<wbr>Query<wbr>String<wbr>Params</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#getsignaturerecoveryparam" class="tsd-kind-icon">get<wbr>Signature<wbr>Recovery<wbr>Param</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#getstackswalletkey" class="tsd-kind-icon">get<wbr>Stacks<wbr>Wallet<wbr>Key</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#getstackswalletkeyinfo" class="tsd-kind-icon">get<wbr>Stacks<wbr>Wallet<wbr>Key<wbr>Info</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#gettypestring" class="tsd-kind-icon">get<wbr>Type<wbr>String</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#gettypeunion" class="tsd-kind-icon">get<wbr>Type<wbr>Union</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#getpass" class="tsd-kind-icon">getpass</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#handleauth" class="tsd-kind-icon">handle<wbr>Auth</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#handlesignin" class="tsd-kind-icon">handle<wbr>Sign<wbr>In</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#haskeys" class="tsd-kind-icon">has<wbr>Keys</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#hash160" class="tsd-kind-icon">hash160</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#hashp2pkh" class="tsd-kind-icon">hash<wbr>P2PKH</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#hashp2sh" class="tsd-kind-icon">hash<wbr>P2SH</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#hashripemd160" class="tsd-kind-icon">hash<wbr>Ripemd160</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#hashsha256sync" class="tsd-kind-icon">hash<wbr>Sha256<wbr>Sync</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#hashsha512sync" class="tsd-kind-icon">hash<wbr>Sha512<wbr>Sync</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#hexstringtoint" class="tsd-kind-icon">hex<wbr>String<wbr>ToInt</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#hextocv" class="tsd-kind-icon">hex<wbr>ToCV</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#intcv" class="tsd-kind-icon">intCV</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#inttohexstring" class="tsd-kind-icon">int<wbr>ToHex<wbr>String</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#isclitransactionsigner" class="tsd-kind-icon">isCLITransaction<wbr>Signer</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#isclarityabibuffer" class="tsd-kind-icon">is<wbr>Clarity<wbr>Abi<wbr>Buffer</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#isclarityabilist" class="tsd-kind-icon">is<wbr>Clarity<wbr>Abi<wbr>List</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#isclarityabioptional" class="tsd-kind-icon">is<wbr>Clarity<wbr>Abi<wbr>Optional</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#isclarityabiprimitive" class="tsd-kind-icon">is<wbr>Clarity<wbr>Abi<wbr>Primitive</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#isclarityabiresponse" class="tsd-kind-icon">is<wbr>Clarity<wbr>Abi<wbr>Response</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#isclarityabistringascii" class="tsd-kind-icon">is<wbr>Clarity<wbr>Abi<wbr>String<wbr>Ascii</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#isclarityabistringutf8" class="tsd-kind-icon">is<wbr>Clarity<wbr>Abi<wbr>String<wbr>Utf8</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#isclarityabituple" class="tsd-kind-icon">is<wbr>Clarity<wbr>Abi<wbr>Tuple</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#isclarityname" class="tsd-kind-icon">is<wbr>Clarity<wbr>Name</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#iscompressed" class="tsd-kind-icon">is<wbr>Compressed</a></li>
|
|
<li class="tsd-kind-function tsd-has-type-parameter"><a href="globals.html#isenum" class="tsd-kind-icon">is<wbr>Enum</a></li>
|
|
<li class="tsd-kind-function tsd-has-type-parameter"><a href="globals.html#isnodecryptoavailable" class="tsd-kind-icon">is<wbr>Node<wbr>Crypto<wbr>Available</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#isrecoverablegaiaerror" class="tsd-kind-icon">is<wbr>Recoverable<wbr>Gaia<wbr>Error</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#issinglesig" class="tsd-kind-icon">is<wbr>Single<wbr>Sig</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#isstringarray" class="tsd-kind-icon">is<wbr>String<wbr>Array</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#issubdomain" class="tsd-kind-icon">is<wbr>Subdomain</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#issubtlecryptoavailable" class="tsd-kind-icon">is<wbr>Subtle<wbr>Crypto<wbr>Available</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#leftpadhex" class="tsd-kind-icon">left<wbr>Pad<wbr>Hex</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#leftpadhextolength" class="tsd-kind-icon">left<wbr>Pad<wbr>Hex<wbr>ToLength</a></li>
|
|
<li class="tsd-kind-function tsd-has-type-parameter"><a href="globals.html#listcv" class="tsd-kind-icon">listCV</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#loadconfig" class="tsd-kind-icon">load<wbr>Config</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#loadnamedidentities" class="tsd-kind-icon">load<wbr>Named<wbr>Identities</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#loadnamedidentitiesloop" class="tsd-kind-icon">load<wbr>Named<wbr>Identities<wbr>Loop</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#loadunnamedidentity" class="tsd-kind-icon">load<wbr>Unnamed<wbr>Identity</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#lookupprofile" class="tsd-kind-icon">lookup<wbr>Profile</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#makeallcommandshelp" class="tsd-kind-icon">make<wbr>All<wbr>Commands<wbr>Help</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#makeallcommandslist" class="tsd-kind-icon">make<wbr>All<wbr>Commands<wbr>List</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#makeassociationtoken" class="tsd-kind-icon">make<wbr>Association<wbr>Token</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#makeauthpage" class="tsd-kind-icon">make<wbr>Auth<wbr>Page</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#makeauthrequest" class="tsd-kind-icon">make<wbr>Auth<wbr>Request</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#makecommandusagestring" class="tsd-kind-icon">make<wbr>Command<wbr>Usage<wbr>String</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#makecontractcall" class="tsd-kind-icon">make<wbr>Contract<wbr>Call</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#makecontractdeploy" class="tsd-kind-icon">make<wbr>Contract<wbr>Deploy</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#makecontractfungiblepostcondition" class="tsd-kind-icon">make<wbr>Contract<wbr>Fungible<wbr>Post<wbr>Condition</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#makecontractnonfungiblepostcondition" class="tsd-kind-icon">make<wbr>Contract<wbr>Non<wbr>Fungible<wbr>Post<wbr>Condition</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#makecontractstxpostcondition" class="tsd-kind-icon">make<wbr>ContractSTXPost<wbr>Condition</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#makedidconfiguration" class="tsd-kind-icon">makeDIDConfiguration</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#makefakeauthresponsetoken" class="tsd-kind-icon">make<wbr>Fake<wbr>Auth<wbr>Response<wbr>Token</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#makegaiaassociationtoken" class="tsd-kind-icon">make<wbr>Gaia<wbr>Association<wbr>Token</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#makegaiaauthtoken" class="tsd-kind-icon">make<wbr>Gaia<wbr>Auth<wbr>Token</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#makeidentity" class="tsd-kind-icon">make<wbr>Identity</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#makekeychain" class="tsd-kind-icon">make<wbr>Keychain</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#makeprofilejwt" class="tsd-kind-icon">make<wbr>ProfileJWT</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#makepromptsfromarglist" class="tsd-kind-icon">make<wbr>Prompts<wbr>From<wbr>Arg<wbr>List</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#makerandomprivkey" class="tsd-kind-icon">make<wbr>Random<wbr>Priv<wbr>Key</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#makereadonlygaiaconfig" class="tsd-kind-icon">make<wbr>Read<wbr>Only<wbr>Gaia<wbr>Config</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#makestxtokentransfer" class="tsd-kind-icon">makeSTXToken<wbr>Transfer</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#makesighashpostsign" class="tsd-kind-icon">make<wbr>Sig<wbr>Hash<wbr>Post<wbr>Sign</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#makesighashpresign" class="tsd-kind-icon">make<wbr>Sig<wbr>Hash<wbr>Pre<wbr>Sign</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#makesigninlink" class="tsd-kind-icon">make<wbr>Sign<wbr>InLink</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#makestandardfungiblepostcondition" class="tsd-kind-icon">make<wbr>Standard<wbr>Fungible<wbr>Post<wbr>Condition</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#makestandardnonfungiblepostcondition" class="tsd-kind-icon">make<wbr>Standard<wbr>Non<wbr>Fungible<wbr>Post<wbr>Condition</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#makestandardstxpostcondition" class="tsd-kind-icon">make<wbr>StandardSTXPost<wbr>Condition</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#makeunsignedcontractcall" class="tsd-kind-icon">make<wbr>Unsigned<wbr>Contract<wbr>Call</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#makeunsignedstxtokentransfer" class="tsd-kind-icon">make<wbr>UnsignedSTXToken<wbr>Transfer</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#makeusagestring" class="tsd-kind-icon">make<wbr>Usage<wbr>String</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#makezonefilefromgaiaurl" class="tsd-kind-icon">make<wbr>Zone<wbr>File<wbr>From<wbr>Gaia<wbr>Url</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#matchtype" class="tsd-kind-icon">match<wbr>Type</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#mkdirs" class="tsd-kind-icon">mkdirs</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#namelookup" class="tsd-kind-icon">name<wbr>Lookup</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#newinitialsighash" class="tsd-kind-icon">new<wbr>Initial<wbr>Sig<wbr>Hash</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#nextsignature" class="tsd-kind-icon">next<wbr>Signature</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#nextverification" class="tsd-kind-icon">next<wbr>Verification</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#nonecv" class="tsd-kind-icon">noneCV</a></li>
|
|
<li class="tsd-kind-function tsd-has-type-parameter"><a href="globals.html#omit" class="tsd-kind-icon">omit</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#optionalcvof" class="tsd-kind-icon">optionalCVOf</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#parseassetinfostring" class="tsd-kind-icon">parse<wbr>Asset<wbr>Info<wbr>String</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#parseclarityfunctionarganswers" class="tsd-kind-icon">parse<wbr>Clarity<wbr>Function<wbr>Arg<wbr>Answers</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#parsemultisigkeys" class="tsd-kind-icon">parse<wbr>Multi<wbr>Sig<wbr>Keys</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#parsenullsigner" class="tsd-kind-icon">parse<wbr>Null<wbr>Signer</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#parseprincipalstring" class="tsd-kind-icon">parse<wbr>Principal<wbr>String</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#parsereadonlyresponse" class="tsd-kind-icon">parse<wbr>Read<wbr>Only<wbr>Response</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#parserecoverablesignature" class="tsd-kind-icon">parse<wbr>Recoverable<wbr>Signature</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#parsesegwitp2shkeys" class="tsd-kind-icon">parse<wbr>Segwit<wbr>P2SHKeys</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#parsetocv" class="tsd-kind-icon">parse<wbr>ToCV</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#principalcv" class="tsd-kind-icon">principalCV</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#principaltostring" class="tsd-kind-icon">principal<wbr>ToString</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#printdocs" class="tsd-kind-icon">print<wbr>Docs</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#printusage" class="tsd-kind-icon">print<wbr>Usage</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#privatekeytostring" class="tsd-kind-icon">private<wbr>Key<wbr>ToString</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#profilesign" class="tsd-kind-icon">profile<wbr>Sign</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#profilestore" class="tsd-kind-icon">profile<wbr>Store</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#profileverify" class="tsd-kind-icon">profile<wbr>Verify</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#pubkeyfromprivkey" class="tsd-kind-icon">pub<wbr>Keyfrom<wbr>Priv<wbr>Key</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#publickeyfrombuffer" class="tsd-kind-icon">public<wbr>Key<wbr>From<wbr>Buffer</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#publickeyfromsignature" class="tsd-kind-icon">public<wbr>Key<wbr>From<wbr>Signature</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#publickeytostring" class="tsd-kind-icon">public<wbr>Key<wbr>ToString</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#readonlycontractfunctioncall" class="tsd-kind-icon">read<wbr>Only<wbr>Contract<wbr>Function<wbr>Call</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#recursiverestoreidentities" class="tsd-kind-icon">recursive<wbr>Restore<wbr>Identities</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#registersubdomain" class="tsd-kind-icon">register<wbr>Subdomain</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#responseerrorcv" class="tsd-kind-icon">response<wbr>ErrorCV</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#responseokcv" class="tsd-kind-icon">response<wbr>OkCV</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#rightpadhextolength" class="tsd-kind-icon">right<wbr>Pad<wbr>Hex<wbr>ToLength</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#sendjson" class="tsd-kind-icon">sendJSON</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#sendtokens" class="tsd-kind-icon">send<wbr>Tokens</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#sendusernametoregistrar" class="tsd-kind-icon">send<wbr>Username<wbr>ToRegistrar</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#serializeaddress" class="tsd-kind-icon">serialize<wbr>Address</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#serializeassetinfo" class="tsd-kind-icon">serialize<wbr>Asset<wbr>Info</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#serializeboolcv" class="tsd-kind-icon">serialize<wbr>BoolCV</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#serializebuffercv" class="tsd-kind-icon">serialize<wbr>BufferCV</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#serializecv" class="tsd-kind-icon">serializeCV</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#serializecontractprincipalcv" class="tsd-kind-icon">serialize<wbr>Contract<wbr>PrincipalCV</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#serializeintcv" class="tsd-kind-icon">serialize<wbr>IntCV</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#serializelplist" class="tsd-kind-icon">serializeLPList</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#serializelpstring" class="tsd-kind-icon">serializeLPString</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#serializelistcv" class="tsd-kind-icon">serialize<wbr>ListCV</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#serializememostring" class="tsd-kind-icon">serialize<wbr>Memo<wbr>String</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#serializemessagesignature" class="tsd-kind-icon">serialize<wbr>Message<wbr>Signature</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#serializemultisigspendingcondition" class="tsd-kind-icon">serialize<wbr>Multi<wbr>Sig<wbr>Spending<wbr>Condition</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#serializeoptionalcv" class="tsd-kind-icon">serialize<wbr>OptionalCV</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#serializepayload" class="tsd-kind-icon">serialize<wbr>Payload</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#serializepostcondition" class="tsd-kind-icon">serialize<wbr>Post<wbr>Condition</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#serializeprincipal" class="tsd-kind-icon">serialize<wbr>Principal</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#serializepublickey" class="tsd-kind-icon">serialize<wbr>Public<wbr>Key</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#serializeresponsecv" class="tsd-kind-icon">serialize<wbr>ResponseCV</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#serializesinglesigspendingcondition" class="tsd-kind-icon">serialize<wbr>Single<wbr>Sig<wbr>Spending<wbr>Condition</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#serializespendingcondition" class="tsd-kind-icon">serialize<wbr>Spending<wbr>Condition</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#serializestacksmessage" class="tsd-kind-icon">serialize<wbr>Stacks<wbr>Message</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#serializestandardprincipalcv" class="tsd-kind-icon">serialize<wbr>Standard<wbr>PrincipalCV</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#serializestringasciicv" class="tsd-kind-icon">serialize<wbr>String<wbr>AsciiCV</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#serializestringcv" class="tsd-kind-icon">serialize<wbr>StringCV</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#serializestringutf8cv" class="tsd-kind-icon">serialize<wbr>String<wbr>Utf8CV</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#serializetransactionauthfield" class="tsd-kind-icon">serialize<wbr>Transaction<wbr>Auth<wbr>Field</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#serializetuplecv" class="tsd-kind-icon">serialize<wbr>TupleCV</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#signanduploadprofile" class="tsd-kind-icon">sign<wbr>And<wbr>Upload<wbr>Profile</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#signprofileforupload" class="tsd-kind-icon">sign<wbr>Profile<wbr>For<wbr>Upload</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#signprofiletoken" class="tsd-kind-icon">sign<wbr>Profile<wbr>Token</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#signwithkey" class="tsd-kind-icon">sign<wbr>With<wbr>Key</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#somecv" class="tsd-kind-icon">someCV</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#sponsortransaction" class="tsd-kind-icon">sponsor<wbr>Transaction</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#stack" class="tsd-kind-icon">stack</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#stackingstatus" class="tsd-kind-icon">stacking<wbr>Status</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#standardprincipalcv" class="tsd-kind-icon">standard<wbr>PrincipalCV</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#standardprincipalcvfromaddress" class="tsd-kind-icon">standard<wbr>PrincipalCVFrom<wbr>Address</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#stringasciicv" class="tsd-kind-icon">string<wbr>AsciiCV</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#stringcv" class="tsd-kind-icon">stringCV</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#stringutf8cv" class="tsd-kind-icon">string<wbr>Utf8CV</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#sumutxos" class="tsd-kind-icon">sumUTXOs</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#truecv" class="tsd-kind-icon">trueCV</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#tuplecv" class="tsd-kind-icon">tupleCV</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#txidfromdata" class="tsd-kind-icon">txid<wbr>From<wbr>Data</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#uintcv" class="tsd-kind-icon">uintCV</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#updateprofileapisettings" class="tsd-kind-icon">update<wbr>ProfileAPISettings</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#updateprofileapps" class="tsd-kind-icon">update<wbr>Profile<wbr>Apps</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#uploadprofile" class="tsd-kind-icon">upload<wbr>Profile</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#validatecontractcall" class="tsd-kind-icon">validate<wbr>Contract<wbr>Call</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#validatestacksaddress" class="tsd-kind-icon">validate<wbr>Stacks<wbr>Address</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#validatesubdomain" class="tsd-kind-icon">validate<wbr>Subdomain</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#validatesubdomainavailability" class="tsd-kind-icon">validate<wbr>Subdomain<wbr>Availability</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#validatesubdomainformat" class="tsd-kind-icon">validate<wbr>Subdomain<wbr>Format</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#verify" class="tsd-kind-icon">verify</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#verifyprofiletoken" class="tsd-kind-icon">verify<wbr>Profile<wbr>Token</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#verifysinglesig" class="tsd-kind-icon">verify<wbr>Single<wbr>Sig</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#walletfrommnemonic" class="tsd-kind-icon">wallet<wbr>From<wbr>Mnemonic</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#wrapprofiletoken" class="tsd-kind-icon">wrap<wbr>Profile<wbr>Token</a></li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-index-section ">
|
|
<h3>Object literals</h3>
|
|
<ul class="tsd-index-list">
|
|
<li class="tsd-kind-object-literal"><a href="globals.html#cli_args" class="tsd-kind-icon">CLI_<wbr>ARGS</a></li>
|
|
<li class="tsd-kind-object-literal"><a href="globals.html#commands" class="tsd-kind-icon">COMMANDS</a></li>
|
|
<li class="tsd-kind-object-literal"><a href="globals.html#config_defaults" class="tsd-kind-icon">CONFIG_<wbr>DEFAULTS</a></li>
|
|
<li class="tsd-kind-object-literal"><a href="globals.html#config_regtest_defaults" class="tsd-kind-icon">CONFIG_<wbr>REGTEST_<wbr>DEFAULTS</a></li>
|
|
<li class="tsd-kind-object-literal"><a href="globals.html#config_testnet_defaults" class="tsd-kind-icon">CONFIG_<wbr>TESTNET_<wbr>DEFAULTS</a></li>
|
|
<li class="tsd-kind-object-literal"><a href="globals.html#default_profile" class="tsd-kind-icon">DEFAULT_<wbr>PROFILE</a></li>
|
|
<li class="tsd-kind-object-literal"><a href="globals.html#log_config_defaults" class="tsd-kind-icon">LOG_<wbr>CONFIG_<wbr>DEFAULTS</a></li>
|
|
<li class="tsd-kind-object-literal"><a href="globals.html#derivationpaths" class="tsd-kind-icon">derivation<wbr>Paths</a></li>
|
|
<li class="tsd-kind-object-literal"><a href="globals.html#personschemadefinition" class="tsd-kind-icon">person<wbr>Schema<wbr>Definition</a></li>
|
|
<li class="tsd-kind-object-literal"><a href="globals.html#registrars" class="tsd-kind-icon">registrars</a></li>
|
|
<li class="tsd-kind-object-literal"><a href="globals.html#schemadefinition" class="tsd-kind-icon">schema<wbr>Definition</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">
|
|
<a name="allowedkeyentropybits" class="tsd-anchor"></a>
|
|
<h3>Allowed<wbr>Key<wbr>Entropy<wbr>Bits</h3>
|
|
<div class="tsd-signature tsd-kind-icon">Allowed<wbr>Key<wbr>Entropy<wbr>Bits<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">128</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">256</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/keychain/src/mnemonic/index.ts#L8">packages/keychain/src/mnemonic/index.ts:8</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-type-alias">
|
|
<a name="anyjson" class="tsd-anchor"></a>
|
|
<h3>Any<wbr>Json</h3>
|
|
<div class="tsd-signature tsd-kind-icon">Any<wbr>Json<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">boolean</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><span class="tsd-signature-symbol"> | </span><a href="globals.html#anyjson" class="tsd-signature-type">AnyJson</a><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/utils.ts#L375">packages/cli/src/utils.ts:375</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-type-alias">
|
|
<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#L46">packages/cli/src/keys.ts:46</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">
|
|
<a name="authmetadata" class="tsd-anchor"></a>
|
|
<h3>Auth<wbr>Metadata</h3>
|
|
<div class="tsd-signature tsd-kind-icon">Auth<wbr>Metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>email<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>profileUrl<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><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/auth/src/messages.ts#L17">packages/auth/src/messages.ts:17</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-type-declaration">
|
|
<h4>Type declaration</h4>
|
|
<ul class="tsd-parameters">
|
|
<li class="tsd-parameter">
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> email<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><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> profile<wbr>Url<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><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">
|
|
<a name="booleancv" class="tsd-anchor"></a>
|
|
<h3>BooleanCV</h3>
|
|
<div class="tsd-signature tsd-kind-icon">BooleanCV<span class="tsd-signature-symbol">:</span> <a href="interfaces/truecv.html" class="tsd-signature-type">TrueCV</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/falsecv.html" class="tsd-signature-type">FalseCV</a></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/transactions/src/clarity/types/booleanCV.ts#L3">packages/transactions/src/clarity/types/booleanCV.ts:3</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-type-alias">
|
|
<a name="cipheralgorithm" class="tsd-anchor"></a>
|
|
<h3>Cipher<wbr>Algorithm</h3>
|
|
<div class="tsd-signature tsd-kind-icon">Cipher<wbr>Algorithm<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"aes-256-cbc"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"aes-128-cbc"</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/encryption/src/aesCipher.ts#L6">packages/encryption/src/aesCipher.ts:6</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-type-alias">
|
|
<a name="clarityabitype" class="tsd-anchor"></a>
|
|
<h3>Clarity<wbr>Abi<wbr>Type</h3>
|
|
<div class="tsd-signature tsd-kind-icon">Clarity<wbr>Abi<wbr>Type<span class="tsd-signature-symbol">:</span> <a href="globals.html#clarityabitypeprimitive" class="tsd-signature-type">ClarityAbiTypePrimitive</a><span class="tsd-signature-symbol"> | </span><a href="enums/clarityabitypeid.html#clarityabitypebuffer" class="tsd-signature-type">ClarityAbiTypeBuffer</a><span class="tsd-signature-symbol"> | </span><a href="enums/clarityabitypeid.html#clarityabityperesponse" class="tsd-signature-type">ClarityAbiTypeResponse</a><span class="tsd-signature-symbol"> | </span><a href="enums/clarityabitypeid.html#clarityabitypeoptional" class="tsd-signature-type">ClarityAbiTypeOptional</a><span class="tsd-signature-symbol"> | </span><a href="enums/clarityabitypeid.html#clarityabitypetuple" class="tsd-signature-type">ClarityAbiTypeTuple</a><span class="tsd-signature-symbol"> | </span><a href="enums/clarityabitypeid.html#clarityabitypelist" class="tsd-signature-type">ClarityAbiTypeList</a><span class="tsd-signature-symbol"> | </span><a href="enums/clarityabitypeid.html#clarityabitypestringascii" class="tsd-signature-type">ClarityAbiTypeStringAscii</a><span class="tsd-signature-symbol"> | </span><a href="enums/clarityabitypeid.html#clarityabitypestringutf8" class="tsd-signature-type">ClarityAbiTypeStringUtf8</a><span class="tsd-signature-symbol"> | </span><a href="enums/clarityabitypeid.html#clarityabitypetraitreference" class="tsd-signature-type">ClarityAbiTypeTraitReference</a></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/transactions/src/contract-abi.ts#L45">packages/transactions/src/contract-abi.ts:45</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-type-alias">
|
|
<a name="clarityabitypebool" class="tsd-anchor"></a>
|
|
<h3>Clarity<wbr>Abi<wbr>Type<wbr>Bool</h3>
|
|
<div class="tsd-signature tsd-kind-icon">Clarity<wbr>Abi<wbr>Type<wbr>Bool<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"bool"</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/transactions/src/contract-abi.ts#L32">packages/transactions/src/contract-abi.ts:32</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-type-alias">
|
|
<a name="clarityabitypebuffer" class="tsd-anchor"></a>
|
|
<h3>Clarity<wbr>Abi<wbr>Type<wbr>Buffer</h3>
|
|
<div class="tsd-signature tsd-kind-icon">Clarity<wbr>Abi<wbr>Type<wbr>Buffer<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>buffer<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>length<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></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/transactions/src/contract-abi.ts#L22">packages/transactions/src/contract-abi.ts:22</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-type-declaration">
|
|
<h4>Type declaration</h4>
|
|
<ul class="tsd-parameters">
|
|
<li class="tsd-parameter">
|
|
<h5>buffer<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>length<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span></h5>
|
|
<ul class="tsd-parameters">
|
|
<li class="tsd-parameter">
|
|
<h5>length<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-type-alias">
|
|
<a name="clarityabitypeint128" class="tsd-anchor"></a>
|
|
<h3>Clarity<wbr>Abi<wbr>Type<wbr>Int128</h3>
|
|
<div class="tsd-signature tsd-kind-icon">Clarity<wbr>Abi<wbr>Type<wbr>Int128<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"int128"</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/transactions/src/contract-abi.ts#L31">packages/transactions/src/contract-abi.ts:31</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-type-alias">
|
|
<a name="clarityabitypelist" class="tsd-anchor"></a>
|
|
<h3>Clarity<wbr>Abi<wbr>Type<wbr>List</h3>
|
|
<div class="tsd-signature tsd-kind-icon">Clarity<wbr>Abi<wbr>Type<wbr>List<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>list<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>length<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>type<span class="tsd-signature-symbol">: </span><a href="globals.html#clarityabitype" class="tsd-signature-type">ClarityAbiType</a><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/transactions/src/contract-abi.ts#L28">packages/transactions/src/contract-abi.ts:28</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-type-declaration">
|
|
<h4>Type declaration</h4>
|
|
<ul class="tsd-parameters">
|
|
<li class="tsd-parameter">
|
|
<h5>list<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>length<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>type<span class="tsd-signature-symbol">: </span><a href="globals.html#clarityabitype" class="tsd-signature-type">ClarityAbiType</a><span class="tsd-signature-symbol"> }</span></h5>
|
|
<ul class="tsd-parameters">
|
|
<li class="tsd-parameter">
|
|
<h5>length<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
|
|
</li>
|
|
<li class="tsd-parameter">
|
|
<h5>type<span class="tsd-signature-symbol">: </span><a href="globals.html#clarityabitype" class="tsd-signature-type">ClarityAbiType</a></h5>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-type-alias">
|
|
<a name="clarityabitypenone" class="tsd-anchor"></a>
|
|
<h3>Clarity<wbr>Abi<wbr>Type<wbr>None</h3>
|
|
<div class="tsd-signature tsd-kind-icon">Clarity<wbr>Abi<wbr>Type<wbr>None<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"none"</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/transactions/src/contract-abi.ts#L35">packages/transactions/src/contract-abi.ts:35</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-type-alias">
|
|
<a name="clarityabitypeoptional" class="tsd-anchor"></a>
|
|
<h3>Clarity<wbr>Abi<wbr>Type<wbr>Optional</h3>
|
|
<div class="tsd-signature tsd-kind-icon">Clarity<wbr>Abi<wbr>Type<wbr>Optional<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>optional<span class="tsd-signature-symbol">: </span><a href="globals.html#clarityabitype" class="tsd-signature-type">ClarityAbiType</a><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/transactions/src/contract-abi.ts#L26">packages/transactions/src/contract-abi.ts:26</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-type-declaration">
|
|
<h4>Type declaration</h4>
|
|
<ul class="tsd-parameters">
|
|
<li class="tsd-parameter">
|
|
<h5>optional<span class="tsd-signature-symbol">: </span><a href="globals.html#clarityabitype" class="tsd-signature-type">ClarityAbiType</a></h5>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-type-alias">
|
|
<a name="clarityabitypeprimitive" class="tsd-anchor"></a>
|
|
<h3>Clarity<wbr>Abi<wbr>Type<wbr>Primitive</h3>
|
|
<div class="tsd-signature tsd-kind-icon">Clarity<wbr>Abi<wbr>Type<wbr>Primitive<span class="tsd-signature-symbol">:</span> <a href="enums/clarityabitypeid.html#clarityabitypeuint128" class="tsd-signature-type">ClarityAbiTypeUInt128</a><span class="tsd-signature-symbol"> | </span><a href="enums/clarityabitypeid.html#clarityabitypeint128" class="tsd-signature-type">ClarityAbiTypeInt128</a><span class="tsd-signature-symbol"> | </span><a href="enums/clarityabitypeid.html#clarityabitypebool" class="tsd-signature-type">ClarityAbiTypeBool</a><span class="tsd-signature-symbol"> | </span><a href="enums/clarityabitypeid.html#clarityabitypeprincipal" class="tsd-signature-type">ClarityAbiTypePrincipal</a><span class="tsd-signature-symbol"> | </span><a href="enums/clarityabitypeid.html#clarityabitypetraitreference" class="tsd-signature-type">ClarityAbiTypeTraitReference</a><span class="tsd-signature-symbol"> | </span><a href="enums/clarityabitypeid.html#clarityabitypenone" class="tsd-signature-type">ClarityAbiTypeNone</a></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/transactions/src/contract-abi.ts#L37">packages/transactions/src/contract-abi.ts:37</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-type-alias">
|
|
<a name="clarityabitypeprincipal" class="tsd-anchor"></a>
|
|
<h3>Clarity<wbr>Abi<wbr>Type<wbr>Principal</h3>
|
|
<div class="tsd-signature tsd-kind-icon">Clarity<wbr>Abi<wbr>Type<wbr>Principal<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"principal"</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/transactions/src/contract-abi.ts#L33">packages/transactions/src/contract-abi.ts:33</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-type-alias">
|
|
<a name="clarityabityperesponse" class="tsd-anchor"></a>
|
|
<h3>Clarity<wbr>Abi<wbr>Type<wbr>Response</h3>
|
|
<div class="tsd-signature tsd-kind-icon">Clarity<wbr>Abi<wbr>Type<wbr>Response<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>response<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>error<span class="tsd-signature-symbol">: </span><a href="globals.html#clarityabitype" class="tsd-signature-type">ClarityAbiType</a><span class="tsd-signature-symbol">; </span>ok<span class="tsd-signature-symbol">: </span><a href="globals.html#clarityabitype" class="tsd-signature-type">ClarityAbiType</a><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/transactions/src/contract-abi.ts#L25">packages/transactions/src/contract-abi.ts:25</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-type-declaration">
|
|
<h4>Type declaration</h4>
|
|
<ul class="tsd-parameters">
|
|
<li class="tsd-parameter">
|
|
<h5>response<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>error<span class="tsd-signature-symbol">: </span><a href="globals.html#clarityabitype" class="tsd-signature-type">ClarityAbiType</a><span class="tsd-signature-symbol">; </span>ok<span class="tsd-signature-symbol">: </span><a href="globals.html#clarityabitype" class="tsd-signature-type">ClarityAbiType</a><span class="tsd-signature-symbol"> }</span></h5>
|
|
<ul class="tsd-parameters">
|
|
<li class="tsd-parameter">
|
|
<h5>error<span class="tsd-signature-symbol">: </span><a href="globals.html#clarityabitype" class="tsd-signature-type">ClarityAbiType</a></h5>
|
|
</li>
|
|
<li class="tsd-parameter">
|
|
<h5>ok<span class="tsd-signature-symbol">: </span><a href="globals.html#clarityabitype" class="tsd-signature-type">ClarityAbiType</a></h5>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-type-alias">
|
|
<a name="clarityabitypestringascii" class="tsd-anchor"></a>
|
|
<h3>Clarity<wbr>Abi<wbr>Type<wbr>String<wbr>Ascii</h3>
|
|
<div class="tsd-signature tsd-kind-icon">Clarity<wbr>Abi<wbr>Type<wbr>String<wbr>Ascii<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>string-ascii<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>length<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></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/transactions/src/contract-abi.ts#L23">packages/transactions/src/contract-abi.ts:23</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-type-declaration">
|
|
<h4>Type declaration</h4>
|
|
<ul class="tsd-parameters">
|
|
<li class="tsd-parameter">
|
|
<h5>string-<wbr>ascii<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>length<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span></h5>
|
|
<ul class="tsd-parameters">
|
|
<li class="tsd-parameter">
|
|
<h5>length<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-type-alias">
|
|
<a name="clarityabitypestringutf8" class="tsd-anchor"></a>
|
|
<h3>Clarity<wbr>Abi<wbr>Type<wbr>String<wbr>Utf8</h3>
|
|
<div class="tsd-signature tsd-kind-icon">Clarity<wbr>Abi<wbr>Type<wbr>String<wbr>Utf8<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>string-utf8<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>length<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></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/transactions/src/contract-abi.ts#L24">packages/transactions/src/contract-abi.ts:24</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-type-declaration">
|
|
<h4>Type declaration</h4>
|
|
<ul class="tsd-parameters">
|
|
<li class="tsd-parameter">
|
|
<h5>string-<wbr>utf8<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>length<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span></h5>
|
|
<ul class="tsd-parameters">
|
|
<li class="tsd-parameter">
|
|
<h5>length<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-type-alias">
|
|
<a name="clarityabitypetraitreference" class="tsd-anchor"></a>
|
|
<h3>Clarity<wbr>Abi<wbr>Type<wbr>Trait<wbr>Reference</h3>
|
|
<div class="tsd-signature tsd-kind-icon">Clarity<wbr>Abi<wbr>Type<wbr>Trait<wbr>Reference<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"trait_reference"</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/transactions/src/contract-abi.ts#L34">packages/transactions/src/contract-abi.ts:34</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-type-alias">
|
|
<a name="clarityabitypetuple" class="tsd-anchor"></a>
|
|
<h3>Clarity<wbr>Abi<wbr>Type<wbr>Tuple</h3>
|
|
<div class="tsd-signature tsd-kind-icon">Clarity<wbr>Abi<wbr>Type<wbr>Tuple<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>tuple<span class="tsd-signature-symbol">: </span><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>type<span class="tsd-signature-symbol">: </span><a href="globals.html#clarityabitype" class="tsd-signature-type">ClarityAbiType</a><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/transactions/src/contract-abi.ts#L27">packages/transactions/src/contract-abi.ts:27</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-type-declaration">
|
|
<h4>Type declaration</h4>
|
|
<ul class="tsd-parameters">
|
|
<li class="tsd-parameter">
|
|
<h5>tuple<span class="tsd-signature-symbol">: </span><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>type<span class="tsd-signature-symbol">: </span><a href="globals.html#clarityabitype" class="tsd-signature-type">ClarityAbiType</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">[]</span></h5>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-type-alias">
|
|
<a name="clarityabitypeuint128" class="tsd-anchor"></a>
|
|
<h3>Clarity<wbr>Abi<wbr>TypeUInt128</h3>
|
|
<div class="tsd-signature tsd-kind-icon">Clarity<wbr>Abi<wbr>TypeUInt128<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"uint128"</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/transactions/src/contract-abi.ts#L30">packages/transactions/src/contract-abi.ts:30</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-type-alias">
|
|
<a name="clarityabitypeunion" class="tsd-anchor"></a>
|
|
<h3>Clarity<wbr>Abi<wbr>Type<wbr>Union</h3>
|
|
<div class="tsd-signature tsd-kind-icon">Clarity<wbr>Abi<wbr>Type<wbr>Union<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>id<span class="tsd-signature-symbol">: </span><a href="enums/clarityabitypeid.html#clarityabitypeuint128" class="tsd-signature-type">ClarityAbiTypeUInt128</a><span class="tsd-signature-symbol">; </span>type<span class="tsd-signature-symbol">: </span><a href="enums/clarityabitypeid.html#clarityabitypeuint128" class="tsd-signature-type">ClarityAbiTypeUInt128</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span>id<span class="tsd-signature-symbol">: </span><a href="enums/clarityabitypeid.html#clarityabitypeint128" class="tsd-signature-type">ClarityAbiTypeInt128</a><span class="tsd-signature-symbol">; </span>type<span class="tsd-signature-symbol">: </span><a href="enums/clarityabitypeid.html#clarityabitypeint128" class="tsd-signature-type">ClarityAbiTypeInt128</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span>id<span class="tsd-signature-symbol">: </span><a href="enums/clarityabitypeid.html#clarityabitypebool" class="tsd-signature-type">ClarityAbiTypeBool</a><span class="tsd-signature-symbol">; </span>type<span class="tsd-signature-symbol">: </span><a href="enums/clarityabitypeid.html#clarityabitypebool" class="tsd-signature-type">ClarityAbiTypeBool</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span>id<span class="tsd-signature-symbol">: </span><a href="enums/clarityabitypeid.html#clarityabitypeprincipal" class="tsd-signature-type">ClarityAbiTypePrincipal</a><span class="tsd-signature-symbol">; </span>type<span class="tsd-signature-symbol">: </span><a href="enums/clarityabitypeid.html#clarityabitypeprincipal" class="tsd-signature-type">ClarityAbiTypePrincipal</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span>id<span class="tsd-signature-symbol">: </span><a href="enums/clarityabitypeid.html#clarityabitypetraitreference" class="tsd-signature-type">ClarityAbiTypeTraitReference</a><span class="tsd-signature-symbol">; </span>type<span class="tsd-signature-symbol">: </span><a href="enums/clarityabitypeid.html#clarityabitypetraitreference" class="tsd-signature-type">ClarityAbiTypeTraitReference</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span>id<span class="tsd-signature-symbol">: </span><a href="enums/clarityabitypeid.html#clarityabitypenone" class="tsd-signature-type">ClarityAbiTypeNone</a><span class="tsd-signature-symbol">; </span>type<span class="tsd-signature-symbol">: </span><a href="enums/clarityabitypeid.html#clarityabitypenone" class="tsd-signature-type">ClarityAbiTypeNone</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span>id<span class="tsd-signature-symbol">: </span><a href="enums/clarityabitypeid.html#clarityabitypebuffer" class="tsd-signature-type">ClarityAbiTypeBuffer</a><span class="tsd-signature-symbol">; </span>type<span class="tsd-signature-symbol">: </span><a href="enums/clarityabitypeid.html#clarityabitypebuffer" class="tsd-signature-type">ClarityAbiTypeBuffer</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span>id<span class="tsd-signature-symbol">: </span><a href="enums/clarityabitypeid.html#clarityabityperesponse" class="tsd-signature-type">ClarityAbiTypeResponse</a><span class="tsd-signature-symbol">; </span>type<span class="tsd-signature-symbol">: </span><a href="enums/clarityabitypeid.html#clarityabityperesponse" class="tsd-signature-type">ClarityAbiTypeResponse</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span>id<span class="tsd-signature-symbol">: </span><a href="enums/clarityabitypeid.html#clarityabitypeoptional" class="tsd-signature-type">ClarityAbiTypeOptional</a><span class="tsd-signature-symbol">; </span>type<span class="tsd-signature-symbol">: </span><a href="enums/clarityabitypeid.html#clarityabitypeoptional" class="tsd-signature-type">ClarityAbiTypeOptional</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span>id<span class="tsd-signature-symbol">: </span><a href="enums/clarityabitypeid.html#clarityabitypetuple" class="tsd-signature-type">ClarityAbiTypeTuple</a><span class="tsd-signature-symbol">; </span>type<span class="tsd-signature-symbol">: </span><a href="enums/clarityabitypeid.html#clarityabitypetuple" class="tsd-signature-type">ClarityAbiTypeTuple</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span>id<span class="tsd-signature-symbol">: </span><a href="enums/clarityabitypeid.html#clarityabitypelist" class="tsd-signature-type">ClarityAbiTypeList</a><span class="tsd-signature-symbol">; </span>type<span class="tsd-signature-symbol">: </span><a href="enums/clarityabitypeid.html#clarityabitypelist" class="tsd-signature-type">ClarityAbiTypeList</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span>id<span class="tsd-signature-symbol">: </span><a href="enums/clarityabitypeid.html#clarityabitypestringascii" class="tsd-signature-type">ClarityAbiTypeStringAscii</a><span class="tsd-signature-symbol">; </span>type<span class="tsd-signature-symbol">: </span><a href="enums/clarityabitypeid.html#clarityabitypestringascii" class="tsd-signature-type">ClarityAbiTypeStringAscii</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span>id<span class="tsd-signature-symbol">: </span><a href="enums/clarityabitypeid.html#clarityabitypestringutf8" class="tsd-signature-type">ClarityAbiTypeStringUtf8</a><span class="tsd-signature-symbol">; </span>type<span class="tsd-signature-symbol">: </span><a href="enums/clarityabitypeid.html#clarityabitypestringutf8" class="tsd-signature-type">ClarityAbiTypeStringUtf8</a><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/transactions/src/contract-abi.ts#L89">packages/transactions/src/contract-abi.ts:89</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-type-alias">
|
|
<a name="clarityvalue" class="tsd-anchor"></a>
|
|
<h3>Clarity<wbr>Value</h3>
|
|
<div class="tsd-signature tsd-kind-icon">Clarity<wbr>Value<span class="tsd-signature-symbol">:</span> <a href="globals.html#booleancv" class="tsd-signature-type">BooleanCV</a><span class="tsd-signature-symbol"> | </span><a href="globals.html#optionalcv" class="tsd-signature-type">OptionalCV</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/buffercv.html" class="tsd-signature-type">BufferCV</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/intcv.html" class="tsd-signature-type">IntCV</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/uintcv.html" class="tsd-signature-type">UIntCV</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/standardprincipalcv.html" class="tsd-signature-type">StandardPrincipalCV</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/contractprincipalcv.html" class="tsd-signature-type">ContractPrincipalCV</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/responseerrorcv.html" class="tsd-signature-type">ResponseErrorCV</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/responseokcv.html" class="tsd-signature-type">ResponseOkCV</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/listcv.html" class="tsd-signature-type">ListCV</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/tuplecv.html" class="tsd-signature-type">TupleCV</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/stringasciicv.html" class="tsd-signature-type">StringAsciiCV</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/stringutf8cv.html" class="tsd-signature-type">StringUtf8CV</a></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/transactions/src/clarity/clarityValue.ts#L42">packages/transactions/src/clarity/clarityValue.ts:42</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-type-alias">
|
|
<a name="commandfunction" class="tsd-anchor"></a>
|
|
<h3>Command<wbr>Function</h3>
|
|
<div class="tsd-signature tsd-kind-icon">Command<wbr>Function<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>network<span class="tsd-signature-symbol">: </span><a href="classes/clinetworkadapter.html" class="tsd-signature-type">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-type">Buffer</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#L1714">packages/cli/src/cli.ts:1714</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-type-declaration">
|
|
<h4>Type declaration</h4>
|
|
<ul class="tsd-parameters">
|
|
<li class="tsd-parameter-signature">
|
|
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-alias">
|
|
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>network<span class="tsd-signature-symbol">: </span><a href="classes/clinetworkadapter.html" class="tsd-signature-type">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-type">Buffer</span><span class="tsd-signature-symbol">></span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>network: <a href="classes/clinetworkadapter.html" class="tsd-signature-type">CLINetworkAdapter</a></h5>
|
|
</li>
|
|
<li>
|
|
<h5>args: <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-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-type">Buffer</span><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-type-alias">
|
|
<a name="docsargstype" class="tsd-anchor"></a>
|
|
<h3>Docs<wbr>Args<wbr>Type</h3>
|
|
<div class="tsd-signature tsd-kind-icon">Docs<wbr>Args<wbr>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>format<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><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>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>value<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/cli.ts#L1669">packages/cli/src/cli.ts:1669</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-type-declaration">
|
|
<h4>Type declaration</h4>
|
|
<ul class="tsd-parameters">
|
|
<li class="tsd-parameter">
|
|
<h5>format<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li class="tsd-parameter">
|
|
<h5>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li class="tsd-parameter">
|
|
<h5>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li class="tsd-parameter">
|
|
<h5>value<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">
|
|
<a name="etagmap" class="tsd-anchor"></a>
|
|
<h3>Etag<wbr>Map</h3>
|
|
<div class="tsd-signature tsd-kind-icon">Etag<wbr>Map<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/auth/src/sessionData.ts#L6">packages/auth/src/sessionData.ts:6</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-type-declaration">
|
|
<h4>Type declaration</h4>
|
|
<ul class="tsd-parameters">
|
|
<li class="tsd-parameter-index-signature">
|
|
<h5><span class="tsd-signature-symbol">[</span>key: <span class="tsd-signature-type">string</span><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">
|
|
<a name="formatteddocstype" class="tsd-anchor"></a>
|
|
<h3>Formatted<wbr>Docs<wbr>Type</h3>
|
|
<div class="tsd-signature tsd-kind-icon">Formatted<wbr>Docs<wbr>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>args<span class="tsd-signature-symbol">: </span><a href="globals.html#docsargstype" class="tsd-signature-type">DocsArgsType</a><span class="tsd-signature-symbol">[]</span><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>group<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>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/cli.ts#L1676">packages/cli/src/cli.ts:1676</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-type-declaration">
|
|
<h4>Type declaration</h4>
|
|
<ul class="tsd-parameters">
|
|
<li class="tsd-parameter">
|
|
<h5>args<span class="tsd-signature-symbol">: </span><a href="globals.html#docsargstype" class="tsd-signature-type">DocsArgsType</a><span class="tsd-signature-symbol">[]</span></h5>
|
|
</li>
|
|
<li class="tsd-parameter">
|
|
<h5>command<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li class="tsd-parameter">
|
|
<h5>group<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li class="tsd-parameter">
|
|
<h5>usage<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">
|
|
<a name="getrandombytes" class="tsd-anchor"></a>
|
|
<h3>Get<wbr>Random<wbr>Bytes</h3>
|
|
<div class="tsd-signature tsd-kind-icon">Get<wbr>Random<wbr>Bytes<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>count<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">Buffer</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/encryption/src/cryptoRandom.ts#L6">packages/encryption/src/cryptoRandom.ts:6</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Optional function to generate cryptographically secure random bytes</p>
|
|
</div>
|
|
</div>
|
|
<div class="tsd-type-declaration">
|
|
<h4>Type declaration</h4>
|
|
<ul class="tsd-parameters">
|
|
<li class="tsd-parameter-signature">
|
|
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-alias">
|
|
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>count<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">Buffer</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>count: <span class="tsd-signature-type">number</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Buffer</span></h4>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-type-alias">
|
|
<a name="multisighashmode" class="tsd-anchor"></a>
|
|
<h3>Multi<wbr>Sig<wbr>Hash<wbr>Mode</h3>
|
|
<div class="tsd-signature tsd-kind-icon">Multi<wbr>Sig<wbr>Hash<wbr>Mode<span class="tsd-signature-symbol">:</span> <a href="enums/addresshashmode.html#serializep2sh" class="tsd-signature-type">SerializeP2SH</a><span class="tsd-signature-symbol"> | </span><a href="enums/addresshashmode.html#serializep2wsh" class="tsd-signature-type">SerializeP2WSH</a></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/transactions/src/constants.ts#L84">packages/transactions/src/constants.ts:84</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-type-alias">
|
|
<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">undefined</span><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">undefined</span><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">undefined</span><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">undefined</span><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">undefined</span><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">undefined</span><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">undefined</span><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">undefined</span><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">undefined</span><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">undefined</span><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">undefined</span><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">undefined</span><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">undefined</span><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">undefined</span><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">
|
|
<a name="nodecryptocreatecipher" class="tsd-anchor"></a>
|
|
<h3>Node<wbr>Crypto<wbr>Create<wbr>Cipher</h3>
|
|
<div class="tsd-signature tsd-kind-icon">Node<wbr>Crypto<wbr>Create<wbr>Cipher<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">createCipheriv</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/encryption/src/aesCipher.ts#L3">packages/encryption/src/aesCipher.ts:3</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-type-alias">
|
|
<a name="nodecryptocreatedecipher" class="tsd-anchor"></a>
|
|
<h3>Node<wbr>Crypto<wbr>Create<wbr>Decipher</h3>
|
|
<div class="tsd-signature tsd-kind-icon">Node<wbr>Crypto<wbr>Create<wbr>Decipher<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">createDecipheriv</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/encryption/src/aesCipher.ts#L4">packages/encryption/src/aesCipher.ts:4</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-type-alias">
|
|
<a name="nodecryptocreatehash" class="tsd-anchor"></a>
|
|
<h3>Node<wbr>Crypto<wbr>Create<wbr>Hash</h3>
|
|
<div class="tsd-signature tsd-kind-icon">Node<wbr>Crypto<wbr>Create<wbr>Hash<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">createHash</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/encryption/src/sha2Hash.ts#L4">packages/encryption/src/sha2Hash.ts:4</a></li>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/encryption/src/hashRipemd160.ts#L4">packages/encryption/src/hashRipemd160.ts:4</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-type-alias">
|
|
<a name="nodecryptocreatehmac" class="tsd-anchor"></a>
|
|
<h3>Node<wbr>Crypto<wbr>Create<wbr>Hmac</h3>
|
|
<div class="tsd-signature tsd-kind-icon">Node<wbr>Crypto<wbr>Create<wbr>Hmac<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">createHmac</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/encryption/src/hmacSha256.ts#L7">packages/encryption/src/hmacSha256.ts:7</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-type-alias">
|
|
<a name="nodepbkdf2fn" class="tsd-anchor"></a>
|
|
<h3>Node<wbr>Pbkdf2<wbr>Fn</h3>
|
|
<div class="tsd-signature tsd-kind-icon">Node<wbr>Pbkdf2<wbr>Fn<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">pbkdf2</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/encryption/src/pbkdf2.ts#L15">packages/encryption/src/pbkdf2.ts:15</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-type-alias">
|
|
<a name="optionalcv" class="tsd-anchor"></a>
|
|
<h3>OptionalCV</h3>
|
|
<div class="tsd-signature tsd-kind-icon">OptionalCV<span class="tsd-signature-symbol">:</span> <a href="interfaces/nonecv.html" class="tsd-signature-type">NoneCV</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/somecv.html" class="tsd-signature-type">SomeCV</a></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/transactions/src/clarity/types/optionalCV.ts#L3">packages/transactions/src/clarity/types/optionalCV.ts:3</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-type-alias">
|
|
<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#L23">packages/cli/src/keys.ts:23</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">
|
|
<a name="payload" class="tsd-anchor"></a>
|
|
<h3>Payload</h3>
|
|
<div class="tsd-signature tsd-kind-icon">Payload<span class="tsd-signature-symbol">:</span> <a href="interfaces/tokentransferpayload.html" class="tsd-signature-type">TokenTransferPayload</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/contractcallpayload.html" class="tsd-signature-type">ContractCallPayload</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/smartcontractpayload.html" class="tsd-signature-type">SmartContractPayload</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/poisonpayload.html" class="tsd-signature-type">PoisonPayload</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/coinbasepayload.html" class="tsd-signature-type">CoinbasePayload</a></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/transactions/src/payload.ts#L25">packages/transactions/src/payload.ts:25</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-type-alias">
|
|
<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#L30">packages/cli/src/keys.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-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">
|
|
<a name="pbkdf2digests" class="tsd-anchor"></a>
|
|
<h3>Pbkdf2<wbr>Digests</h3>
|
|
<div class="tsd-signature tsd-kind-icon">Pbkdf2<wbr>Digests<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"sha512"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"sha256"</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/encryption/src/pbkdf2.ts#L3">packages/encryption/src/pbkdf2.ts:3</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-type-alias">
|
|
<a name="postcondition" class="tsd-anchor"></a>
|
|
<h3>Post<wbr>Condition</h3>
|
|
<div class="tsd-signature tsd-kind-icon">Post<wbr>Condition<span class="tsd-signature-symbol">:</span> <a href="interfaces/stxpostcondition.html" class="tsd-signature-type">STXPostCondition</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/fungiblepostcondition.html" class="tsd-signature-type">FungiblePostCondition</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/nonfungiblepostcondition.html" class="tsd-signature-type">NonFungiblePostCondition</a></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/transactions/src/postcondition.ts#L26">packages/transactions/src/postcondition.ts:26</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-type-alias">
|
|
<a name="postconditionprincipal" class="tsd-anchor"></a>
|
|
<h3>Post<wbr>Condition<wbr>Principal</h3>
|
|
<div class="tsd-signature tsd-kind-icon">Post<wbr>Condition<wbr>Principal<span class="tsd-signature-symbol">:</span> <a href="interfaces/standardprincipal.html" class="tsd-signature-type">StandardPrincipal</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/contractprincipal.html" class="tsd-signature-type">ContractPrincipal</a></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/transactions/src/types.ts#L240">packages/transactions/src/types.ts:240</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-type-alias">
|
|
<a name="principalcv" class="tsd-anchor"></a>
|
|
<h3>PrincipalCV</h3>
|
|
<div class="tsd-signature tsd-kind-icon">PrincipalCV<span class="tsd-signature-symbol">:</span> <a href="interfaces/standardprincipalcv.html" class="tsd-signature-type">StandardPrincipalCV</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/contractprincipalcv.html" class="tsd-signature-type">ContractPrincipalCV</a></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/transactions/src/clarity/types/principalCV.ts#L10">packages/transactions/src/clarity/types/principalCV.ts:10</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-type-alias">
|
|
<a name="putfilecontent" class="tsd-anchor"></a>
|
|
<h3>Put<wbr>File<wbr>Content</h3>
|
|
<div class="tsd-signature tsd-kind-icon">Put<wbr>File<wbr>Content<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><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">ArrayBufferView</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">ArrayBufferLike</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Blob</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/storage/src/fileContentLoader.ts#L8">packages/storage/src/fileContentLoader.ts:8</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Retrieves the specified file from the app's data store.</p>
|
|
</div>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>param</dt>
|
|
<dd><p>the path to the file to read</p>
|
|
</dd>
|
|
<dt>returns</dt>
|
|
<dd><p>that resolves to the raw data in the file
|
|
or rejects with an error</p>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-type-alias">
|
|
<a name="readonlyfunctionresponse" class="tsd-anchor"></a>
|
|
<h3>Read<wbr>Only<wbr>Function<wbr>Response</h3>
|
|
<div class="tsd-signature tsd-kind-icon">Read<wbr>Only<wbr>Function<wbr>Response<span class="tsd-signature-symbol">:</span> <a href="interfaces/readonlyfunctionsuccessresponse.html" class="tsd-signature-type">ReadOnlyFunctionSuccessResponse</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/readonlyfunctionerrorresponse.html" class="tsd-signature-type">ReadOnlyFunctionErrorResponse</a></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/transactions/src/utils.ts#L186">packages/transactions/src/utils.ts:186</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-type-alias">
|
|
<a name="responsecv" class="tsd-anchor"></a>
|
|
<h3>ResponseCV</h3>
|
|
<div class="tsd-signature tsd-kind-icon">ResponseCV<span class="tsd-signature-symbol">:</span> <a href="interfaces/responseerrorcv.html" class="tsd-signature-type">ResponseErrorCV</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/responseokcv.html" class="tsd-signature-type">ResponseOkCV</a></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/transactions/src/clarity/types/responseCV.ts#L3">packages/transactions/src/clarity/types/responseCV.ts:3</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-type-alias">
|
|
<a name="singlesighashmode" class="tsd-anchor"></a>
|
|
<h3>Single<wbr>Sig<wbr>Hash<wbr>Mode</h3>
|
|
<div class="tsd-signature tsd-kind-icon">Single<wbr>Sig<wbr>Hash<wbr>Mode<span class="tsd-signature-symbol">:</span> <a href="enums/addresshashmode.html#serializep2pkh" class="tsd-signature-type">SerializeP2PKH</a><span class="tsd-signature-symbol"> | </span><a href="enums/addresshashmode.html#serializep2wpkh" class="tsd-signature-type">SerializeP2WPKH</a></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/transactions/src/constants.ts#L83">packages/transactions/src/constants.ts:83</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-type-alias">
|
|
<a name="spendingcondition" class="tsd-anchor"></a>
|
|
<h3>Spending<wbr>Condition</h3>
|
|
<div class="tsd-signature tsd-kind-icon">Spending<wbr>Condition<span class="tsd-signature-symbol">:</span> <a href="interfaces/singlesigspendingcondition.html" class="tsd-signature-type">SingleSigSpendingCondition</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/multisigspendingcondition.html" class="tsd-signature-type">MultiSigSpendingCondition</a></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/transactions/src/authorization.ts#L154">packages/transactions/src/authorization.ts:154</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-type-alias">
|
|
<a name="stackerinfo" class="tsd-anchor"></a>
|
|
<h3>Stacker<wbr>Info</h3>
|
|
<div class="tsd-signature tsd-kind-icon">Stacker<wbr>Info<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>stacked<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span>details<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>amount_microstx<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>first_reward_cycle<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>lock_period<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>pox_address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>hashbytes<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">; </span>version<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>unlock_height<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>stacked<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">true</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/stacking/src/index.ts#L42">packages/stacking/src/index.ts:42</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-type-alias">
|
|
<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></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/cli/src/keys.ts#L39">packages/cli/src/keys.ts:39</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>
|
|
</ul>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-type-alias">
|
|
<a name="stacksmessage" class="tsd-anchor"></a>
|
|
<h3>Stacks<wbr>Message</h3>
|
|
<div class="tsd-signature tsd-kind-icon">Stacks<wbr>Message<span class="tsd-signature-symbol">:</span> <a href="interfaces/address.html" class="tsd-signature-type">Address</a><span class="tsd-signature-symbol"> | </span><a href="globals.html#postconditionprincipal" class="tsd-signature-type">PostConditionPrincipal</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/lengthprefixedstring.html" class="tsd-signature-type">LengthPrefixedString</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/lengthprefixedlist.html" class="tsd-signature-type">LengthPrefixedList</a><span class="tsd-signature-symbol"> | </span><a href="enums/stacksmessagetype.html#payload" class="tsd-signature-type">Payload</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/memostring.html" class="tsd-signature-type">MemoString</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/assetinfo.html" class="tsd-signature-type">AssetInfo</a><span class="tsd-signature-symbol"> | </span><a href="enums/stacksmessagetype.html#postcondition" class="tsd-signature-type">PostCondition</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/stackspublickey.html" class="tsd-signature-type">StacksPublicKey</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/transactionauthfield.html" class="tsd-signature-type">TransactionAuthField</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/messagesignature.html" class="tsd-signature-type">MessageSignature</a></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/transactions/src/types.ts#L37">packages/transactions/src/types.ts:37</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-type-alias">
|
|
<a name="transactionauthfieldcontents" class="tsd-anchor"></a>
|
|
<h3>Transaction<wbr>Auth<wbr>Field<wbr>Contents</h3>
|
|
<div class="tsd-signature tsd-kind-icon">Transaction<wbr>Auth<wbr>Field<wbr>Contents<span class="tsd-signature-symbol">:</span> <a href="interfaces/stackspublickey.html" class="tsd-signature-type">StacksPublicKey</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/messagesignature.html" class="tsd-signature-type">MessageSignature</a></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/transactions/src/authorization.ts#L88">packages/transactions/src/authorization.ts:88</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-type-alias">
|
|
<a name="triplesecdecryptsignature" class="tsd-anchor"></a>
|
|
<h3>Triplesec<wbr>Decrypt<wbr>Signature</h3>
|
|
<div class="tsd-signature tsd-kind-icon">Triplesec<wbr>Decrypt<wbr>Signature<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>arg<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">; </span>key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol"> }</span>, cb<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><a href="classes/safetyerror.html#error" class="tsd-signature-type">Error</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</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-type">null</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></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/encryption/src/cryptoUtils.ts#L34">packages/encryption/src/cryptoUtils.ts:34</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-type-declaration">
|
|
<h4>Type declaration</h4>
|
|
<ul class="tsd-parameters">
|
|
<li class="tsd-parameter-signature">
|
|
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-alias">
|
|
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>arg<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">; </span>key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol"> }</span>, cb<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><a href="classes/safetyerror.html#error" class="tsd-signature-type">Error</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</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-type">null</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">
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>arg: <span class="tsd-signature-symbol">{ </span>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">; </span>key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol"> }</span></h5>
|
|
<ul class="tsd-parameters">
|
|
<li class="tsd-parameter">
|
|
<h5>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span></h5>
|
|
</li>
|
|
<li class="tsd-parameter">
|
|
<h5>key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span></h5>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<h5>cb: <span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><a href="classes/safetyerror.html#error" class="tsd-signature-type">Error</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</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-type">null</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>err<span class="tsd-signature-symbol">: </span><a href="classes/safetyerror.html#error" class="tsd-signature-type">Error</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</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-type">null</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>err: <a href="classes/safetyerror.html#error" class="tsd-signature-type">Error</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>buff: <span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</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>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-type-alias">
|
|
<a name="tupledata" class="tsd-anchor"></a>
|
|
<h3>Tuple<wbr>Data</h3>
|
|
<div class="tsd-signature tsd-kind-icon">Tuple<wbr>Data<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/transactions/src/clarity/types/tupleCV.ts#L4">packages/transactions/src/clarity/types/tupleCV.ts:4</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-type-declaration">
|
|
<h4>Type declaration</h4>
|
|
<ul class="tsd-parameters">
|
|
<li class="tsd-parameter-index-signature">
|
|
<h5><span class="tsd-signature-symbol">[</span>key: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><a href="globals.html#clarityvalue" class="tsd-signature-type">ClarityValue</a></h5>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-type-alias">
|
|
<a name="txbroadcastresult" class="tsd-anchor"></a>
|
|
<h3>Tx<wbr>Broadcast<wbr>Result</h3>
|
|
<div class="tsd-signature tsd-kind-icon">Tx<wbr>Broadcast<wbr>Result<span class="tsd-signature-symbol">:</span> <a href="globals.html#txbroadcastresultok" class="tsd-signature-type">TxBroadcastResultOk</a><span class="tsd-signature-symbol"> | </span><a href="globals.html#txbroadcastresultrejected" class="tsd-signature-type">TxBroadcastResultRejected</a></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/transactions/src/builders.ts#L148">packages/transactions/src/builders.ts:148</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-type-alias">
|
|
<a name="txbroadcastresultok" class="tsd-anchor"></a>
|
|
<h3>Tx<wbr>Broadcast<wbr>Result<wbr>Ok</h3>
|
|
<div class="tsd-signature tsd-kind-icon">Tx<wbr>Broadcast<wbr>Result<wbr>Ok<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/transactions/src/builders.ts#L141">packages/transactions/src/builders.ts:141</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-type-alias">
|
|
<a name="txbroadcastresultrejected" class="tsd-anchor"></a>
|
|
<h3>Tx<wbr>Broadcast<wbr>Result<wbr>Rejected</h3>
|
|
<div class="tsd-signature tsd-kind-icon">Tx<wbr>Broadcast<wbr>Result<wbr>Rejected<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>reason<span class="tsd-signature-symbol">: </span><a href="enums/txrejectedreason.html" class="tsd-signature-type">TxRejectedReason</a><span class="tsd-signature-symbol">; </span>reason_data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</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></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/transactions/src/builders.ts#L142">packages/transactions/src/builders.ts:142</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-type-declaration">
|
|
<h4>Type declaration</h4>
|
|
<ul class="tsd-parameters">
|
|
<li class="tsd-parameter">
|
|
<h5>error<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li class="tsd-parameter">
|
|
<h5>reason<span class="tsd-signature-symbol">: </span><a href="enums/txrejectedreason.html" class="tsd-signature-type">TxRejectedReason</a></h5>
|
|
</li>
|
|
<li class="tsd-parameter">
|
|
<h5>reason_<wbr>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></h5>
|
|
</li>
|
|
<li class="tsd-parameter">
|
|
<h5>txid<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">
|
|
<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">
|
|
<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"> = `^(${ADDRESS_CHARS})$`</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">
|
|
<a name="apps_node_index" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> APPS_<wbr>NODE_<wbr>INDEX</h3>
|
|
<div class="tsd-signature tsd-kind-icon">APPS_<wbr>NODE_<wbr>INDEX<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">0</span><span class="tsd-signature-symbol"> = 0</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/keychain/src/nodes/identity-address-owner-node.ts#L6">packages/keychain/src/nodes/identity-address-owner-node.ts:6</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable">
|
|
<a name="auth_continuation_param" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> AUTH_<wbr>CONTINUATION_<wbr>PARAM</h3>
|
|
<div class="tsd-signature tsd-kind-icon">AUTH_<wbr>CONTINUATION_<wbr>PARAM<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"authContinuation"</span><span class="tsd-signature-symbol"> = "authContinuation"</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/auth/src/protocolEchoDetection.ts#L10">packages/auth/src/protocolEchoDetection.ts:10</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable">
|
|
<a name="blockstack_on_bitcoin" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> BLOCKSTACK_<wbr>ON_<wbr>BITCOIN</h3>
|
|
<div class="tsd-signature tsd-kind-icon">BLOCKSTACK_<wbr>ON_<wbr>BITCOIN<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">0</span><span class="tsd-signature-symbol"> = 0</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/keychain/src/utils/index.ts#L10">packages/keychain/src/utils/index.ts:10</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable">
|
|
<a name="blockstack_test" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagLet">Let</span> BLOCKSTACK_<wbr>TEST</h3>
|
|
<div class="tsd-signature tsd-kind-icon">BLOCKSTACK_<wbr>TEST<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = !!process.env.BLOCKSTACK_TEST</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#L121">packages/cli/src/cli.ts:121</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable">
|
|
<a name="bn" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> BN</h3>
|
|
<div class="tsd-signature tsd-kind-icon">BN<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> = require('bn.js')</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#L3">packages/cli/src/network.ts:3</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable">
|
|
<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">
|
|
<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">
|
|
<a name="change_address" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> CHANGE_<wbr>ADDRESS</h3>
|
|
<div class="tsd-signature tsd-kind-icon">CHANGE_<wbr>ADDRESS<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"CHANGE_ADDRESS"</span><span class="tsd-signature-symbol"> = "CHANGE_ADDRESS"</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/keychain/src/utils/index.ts#L17">packages/keychain/src/utils/index.ts:17</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable">
|
|
<a name="clarity_int_size" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> CLARITY_<wbr>INT_<wbr>SIZE</h3>
|
|
<div class="tsd-signature tsd-kind-icon">CLARITY_<wbr>INT_<wbr>SIZE<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/transactions/src/constants.ts#L11">packages/transactions/src/constants.ts:11</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable">
|
|
<a name="coinbase_buffer_length_bytes" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> COINBASE_<wbr>BUFFER_<wbr>LENGTH_<wbr>BYTES</h3>
|
|
<div class="tsd-signature tsd-kind-icon">COINBASE_<wbr>BUFFER_<wbr>LENGTH_<wbr>BYTES<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">32</span><span class="tsd-signature-symbol"> = 32</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/transactions/src/constants.ts#L12">packages/transactions/src/constants.ts:12</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable">
|
|
<a name="compressed_pubkey_length_bytes" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> COMPRESSED_<wbr>PUBKEY_<wbr>LENGTH_<wbr>BYTES</h3>
|
|
<div class="tsd-signature tsd-kind-icon">COMPRESSED_<wbr>PUBKEY_<wbr>LENGTH_<wbr>BYTES<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">32</span><span class="tsd-signature-symbol"> = 32</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/transactions/src/constants.ts#L14">packages/transactions/src/constants.ts:14</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable">
|
|
<a name="config_index" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> CONFIG_<wbr>INDEX</h3>
|
|
<div class="tsd-signature tsd-kind-icon">CONFIG_<wbr>INDEX<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">45</span><span class="tsd-signature-symbol"> = 45</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/keychain/src/wallet/index.ts#L27">packages/keychain/src/wallet/index.ts:27</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable">
|
|
<a name="context" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> CONTEXT</h3>
|
|
<div class="tsd-signature tsd-kind-icon">CONTEXT<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"http://schema.org"</span><span class="tsd-signature-symbol"> = "http://schema.org"</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/keychain/src/profiles.ts#L9">packages/keychain/src/profiles.ts:9</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable">
|
|
<a name="default_blockstack_host" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> DEFAULT_<wbr>BLOCKSTACK_<wbr>HOST</h3>
|
|
<div class="tsd-signature tsd-kind-icon">DEFAULT_<wbr>BLOCKSTACK_<wbr>HOST<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"https://browser.blockstack.org/auth"</span><span class="tsd-signature-symbol"> = "https://browser.blockstack.org/auth"</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/auth/src/constants.ts#L12">packages/auth/src/constants.ts:12</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>This constant is used in the [[redirectToSignInWithAuthRequest]]</p>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable">
|
|
<a name="default_chain_id" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> DEFAULT_<wbr>CHAIN_<wbr>ID</h3>
|
|
<div class="tsd-signature tsd-kind-icon">DEFAULT_<wbr>CHAIN_<wbr>ID<span class="tsd-signature-symbol">:</span> <a href="enums/chainid.html#mainnet" class="tsd-signature-type">Mainnet</a><span class="tsd-signature-symbol"> = ChainID.Mainnet</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/transactions/src/constants.ts#L9">packages/transactions/src/constants.ts:9</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable">
|
|
<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">
|
|
<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">
|
|
<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">
|
|
<a name="default_core_node_api_url" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> DEFAULT_<wbr>CORE_<wbr>NODE_<wbr>API_<wbr>URL</h3>
|
|
<div class="tsd-signature tsd-kind-icon">DEFAULT_<wbr>CORE_<wbr>NODE_<wbr>API_<wbr>URL<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"https://stacks-node-api.mainnet.stacks.co"</span><span class="tsd-signature-symbol"> = "https://stacks-node-api.mainnet.stacks.co"</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/transactions/src/constants.ts#L17">packages/transactions/src/constants.ts:17</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable">
|
|
<a name="default_gaia_hub" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> DEFAULT_<wbr>GAIA_<wbr>HUB</h3>
|
|
<div class="tsd-signature tsd-kind-icon">DEFAULT_<wbr>GAIA_<wbr>HUB<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"https://gaia.blockstack.org/hub/"</span><span class="tsd-signature-symbol"> = "https://gaia.blockstack.org/hub/"</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/keychain/src/utils/gaia.ts#L6">packages/keychain/src/utils/gaia.ts:6</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable">
|
|
<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">
|
|
<a name="default_profile_file_name" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> DEFAULT_<wbr>PROFILE_<wbr>FILE_<wbr>NAME</h3>
|
|
<div class="tsd-signature tsd-kind-icon">DEFAULT_<wbr>PROFILE_<wbr>FILE_<wbr>NAME<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"profile.json"</span><span class="tsd-signature-symbol"> = "profile.json"</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/keychain/src/profiles.ts#L40">packages/keychain/src/profiles.ts:40</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable">
|
|
<a name="default_transaction_version" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> DEFAULT_<wbr>TRANSACTION_<wbr>VERSION</h3>
|
|
<div class="tsd-signature tsd-kind-icon">DEFAULT_<wbr>TRANSACTION_<wbr>VERSION<span class="tsd-signature-symbol">:</span> <a href="enums/transactionversion.html#mainnet" class="tsd-signature-type">Mainnet</a><span class="tsd-signature-symbol"> = TransactionVersion.Mainnet</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/transactions/src/constants.ts#L52">packages/transactions/src/constants.ts:52</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable">
|
|
<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#L21">packages/cli/src/keys.ts:21</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable">
|
|
<a name="echo_reply_param" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> ECHO_<wbr>REPLY_<wbr>PARAM</h3>
|
|
<div class="tsd-signature tsd-kind-icon">ECHO_<wbr>REPLY_<wbr>PARAM<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"echoReply"</span><span class="tsd-signature-symbol"> = "echoReply"</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/auth/src/protocolEchoDetection.ts#L9">packages/auth/src/protocolEchoDetection.ts:9</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable">
|
|
<a name="encryption_node_index" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> ENCRYPTION_<wbr>NODE_<wbr>INDEX</h3>
|
|
<div class="tsd-signature tsd-kind-icon">ENCRYPTION_<wbr>NODE_<wbr>INDEX<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">2</span><span class="tsd-signature-symbol"> = 2</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/keychain/src/nodes/identity-address-owner-node.ts#L8">packages/keychain/src/nodes/identity-address-owner-node.ts:8</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable">
|
|
<a name="external_address" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> EXTERNAL_<wbr>ADDRESS</h3>
|
|
<div class="tsd-signature tsd-kind-icon">EXTERNAL_<wbr>ADDRESS<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"EXTERNAL_ADDRESS"</span><span class="tsd-signature-symbol"> = "EXTERNAL_ADDRESS"</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/keychain/src/utils/index.ts#L16">packages/keychain/src/utils/index.ts:16</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable">
|
|
<a name="global_detection_cache_key" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> GLOBAL_<wbr>DETECTION_<wbr>CACHE_<wbr>KEY</h3>
|
|
<div class="tsd-signature tsd-kind-icon">GLOBAL_<wbr>DETECTION_<wbr>CACHE_<wbr>KEY<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"_blockstackDidCheckEchoReply"</span><span class="tsd-signature-symbol"> = "_blockstackDidCheckEchoReply"</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/auth/src/protocolEchoDetection.ts#L8">packages/auth/src/protocolEchoDetection.ts:8</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>This logic is in a separate file with no dependencies so that it can be
|
|
loaded and executed as soon as possible to fulfill the purpose of the protocol
|
|
detection technique. The effectiveness of this is obviously subject to how web
|
|
apps bundle/consume the blockstack.js lib.</p>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable">
|
|
<a name="identity_keychain" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> IDENTITY_<wbr>KEYCHAIN</h3>
|
|
<div class="tsd-signature tsd-kind-icon">IDENTITY_<wbr>KEYCHAIN<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">888</span><span class="tsd-signature-symbol"> = 888</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/keychain/src/utils/index.ts#L9">packages/keychain/src/utils/index.ts:9</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable">
|
|
<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"> = `^ID-${ADDRESS_CHARS}$`</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">
|
|
<a name="image_type" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> IMAGE_<wbr>TYPE</h3>
|
|
<div class="tsd-signature tsd-kind-icon">IMAGE_<wbr>TYPE<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ImageObject"</span><span class="tsd-signature-symbol"> = "ImageObject"</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/keychain/src/profiles.ts#L10">packages/keychain/src/profiles.ts:10</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable">
|
|
<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">
|
|
<a name="max_string_length_bytes" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> MAX_<wbr>STRING_<wbr>LENGTH_<wbr>BYTES</h3>
|
|
<div class="tsd-signature tsd-kind-icon">MAX_<wbr>STRING_<wbr>LENGTH_<wbr>BYTES<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/transactions/src/constants.ts#L10">packages/transactions/src/constants.ts:10</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable">
|
|
<a name="memo_max_length_bytes" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> MEMO_<wbr>MAX_<wbr>LENGTH_<wbr>BYTES</h3>
|
|
<div class="tsd-signature tsd-kind-icon">MEMO_<wbr>MAX_<wbr>LENGTH_<wbr>BYTES<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">34</span><span class="tsd-signature-symbol"> = 34</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/transactions/src/constants.ts#L16">packages/transactions/src/constants.ts:16</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable">
|
|
<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">
|
|
<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">
|
|
<a name="no_crypto_lib" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> NO_<wbr>CRYPTO_<wbr>LIB</h3>
|
|
<div class="tsd-signature tsd-kind-icon">NO_<wbr>CRYPTO_<wbr>LIB<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"Crypto lib not found. Either the WebCrypto "crypto.subtle" or Node.js "crypto" module must be available."</span><span class="tsd-signature-symbol"> = "Crypto lib not found. Either the WebCrypto "crypto.subtle" or Node.js "crypto" module must be available."</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/encryption/src/cryptoUtils.ts#L31">packages/encryption/src/cryptoUtils.ts:31</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable">
|
|
<a name="person_type" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> PERSON_<wbr>TYPE</h3>
|
|
<div class="tsd-signature tsd-kind-icon">PERSON_<wbr>TYPE<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"Person"</span><span class="tsd-signature-symbol"> = "Person"</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/keychain/src/profiles.ts#L8">packages/keychain/src/profiles.ts:8</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable">
|
|
<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">
|
|
<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"> = `^nosign:${ADDRESS_CHARS}$`</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">
|
|
<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">
|
|
<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"> = `${PRIVATE_KEY_PATTERN}|${PRIVATE_KEY_MULTISIG_PATTERN}|${PRIVATE_KEY_SEGWIT_P2SH_PATTERN}|${PRIVATE_KEY_NOSIGN_PATTERN}`</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">
|
|
<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">
|
|
<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">
|
|
<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">
|
|
<a name="public_testnet_host" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> PUBLIC_<wbr>TESTNET_<wbr>HOST</h3>
|
|
<div class="tsd-signature tsd-kind-icon">PUBLIC_<wbr>TESTNET_<wbr>HOST<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"testnet-master.blockstack.org"</span><span class="tsd-signature-symbol"> = "testnet-master.blockstack.org"</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#L98">packages/cli/src/argparse.ts:98</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable">
|
|
<a name="recoverable_ecdsa_sig_length_bytes" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> RECOVERABLE_<wbr>ECDSA_<wbr>SIG_<wbr>LENGTH_<wbr>BYTES</h3>
|
|
<div class="tsd-signature tsd-kind-icon">RECOVERABLE_<wbr>ECDSA_<wbr>SIG_<wbr>LENGTH_<wbr>BYTES<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">65</span><span class="tsd-signature-symbol"> = 65</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/transactions/src/constants.ts#L13">packages/transactions/src/constants.ts:13</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable">
|
|
<a name="satoshis_per_btc" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> SATOSHIS_<wbr>PER_<wbr>BTC</h3>
|
|
<div class="tsd-signature tsd-kind-icon">SATOSHIS_<wbr>PER_<wbr>BTC<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">100000000</span><span class="tsd-signature-symbol"> = 100000000</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#L10">packages/cli/src/network.ts:10</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable">
|
|
<a name="session_version" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> SESSION_<wbr>VERSION</h3>
|
|
<div class="tsd-signature tsd-kind-icon">SESSION_<wbr>VERSION<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"1.0.0"</span><span class="tsd-signature-symbol"> = "1.0.0"</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/auth/src/sessionData.ts#L4">packages/auth/src/sessionData.ts:4</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable">
|
|
<a name="signature_file_suffix" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> SIGNATURE_<wbr>FILE_<wbr>SUFFIX</h3>
|
|
<div class="tsd-signature tsd-kind-icon">SIGNATURE_<wbr>FILE_<wbr>SUFFIX<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">".sig"</span><span class="tsd-signature-symbol"> = ".sig"</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/storage/src/storage.ts#L60">packages/storage/src/storage.ts:60</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable">
|
|
<a name="signing_node_index" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> SIGNING_<wbr>NODE_<wbr>INDEX</h3>
|
|
<div class="tsd-signature tsd-kind-icon">SIGNING_<wbr>NODE_<wbr>INDEX<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">1</span><span class="tsd-signature-symbol"> = 1</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/keychain/src/nodes/identity-address-owner-node.ts#L7">packages/keychain/src/nodes/identity-address-owner-node.ts:7</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable">
|
|
<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">"h1 {font-family: monospace;font-size: 24px;font-style: normal;font-variant: normal;font-weight: 700;line-height: 26.4px;}h3 {font-family: monospace;font-size: 14px;font-style: normal;font-variant: normal;font-weight: 700;line-height: 15.4px;}p {font-family: monospace;font-size: 14px;font-style: normal;font-variant: normal;font-weight: 400;line-height: 20px;}b {background-color: #e8e8e8;}pre {font-family: monospace;font-size: 13px;font-style: normal;font-variant: normal;font-weight: 400;line-height: 18.5714px;}"</span><span class="tsd-signature-symbol"> = `h1 {font-family: monospace;font-size: 24px;font-style: normal;font-variant: normal;font-weight: 700;line-height: 26.4px;}h3 {font-family: monospace;font-size: 14px;font-style: normal;font-variant: normal;font-weight: 700;line-height: 15.4px;}p {font-family: monospace;font-size: 14px;font-style: normal;font-variant: normal;font-weight: 400;line-height: 20px;}b {background-color: #e8e8e8;}pre {font-family: monospace;font-size: 13px;font-style: normal;font-variant: normal;font-weight: 400;line-height: 18.5714px;}`</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">
|
|
<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">
|
|
<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">
|
|
<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">
|
|
<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">
|
|
<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"> = `<html><head><style>${SIGNIN_CSS}</style></head></body><h3>Blockstack CLI Sign-in</h3><br>`</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">
|
|
<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">
|
|
<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"> = `^(${C32_ADDRESS_CHARS})$`</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">
|
|
<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#L19">packages/cli/src/keys.ts:19</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable">
|
|
<a name="stx_node_index" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> STX_<wbr>NODE_<wbr>INDEX</h3>
|
|
<div class="tsd-signature tsd-kind-icon">STX_<wbr>NODE_<wbr>INDEX<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">6</span><span class="tsd-signature-symbol"> = 6</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/keychain/src/nodes/identity-address-owner-node.ts#L9">packages/keychain/src/nodes/identity-address-owner-node.ts:9</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable">
|
|
<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#L20">packages/cli/src/keys.ts:20</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable">
|
|
<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">
|
|
<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">
|
|
<a name="uncompressed_pubkey_length_bytes" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> UNCOMPRESSED_<wbr>PUBKEY_<wbr>LENGTH_<wbr>BYTES</h3>
|
|
<div class="tsd-signature tsd-kind-icon">UNCOMPRESSED_<wbr>PUBKEY_<wbr>LENGTH_<wbr>BYTES<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">64</span><span class="tsd-signature-symbol"> = 64</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/transactions/src/constants.ts#L15">packages/transactions/src/constants.ts:15</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable">
|
|
<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">
|
|
<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"> = `Usage: ${process.argv[1]} [options] command [command arguments]Options can be:-c Path to a config file (defaults to${DEFAULT_CONFIG_PATH})-d Print verbose debugging output-e Estimate the BTC cost of an transaction (in satoshis).Do not generate or send any transactions.-m MAGIC_BYTES Use an alternative magic byte string instead of "id".-t Use the public testnet instead of mainnet.-i Use integration test framework instead of mainnet.-U Unsafe mode. No safety checks will be performed.-x Do not broadcast a transaction. Only generate andprint them to stdout.-B BURN_ADDR Use the given namespace burn address instead of the oneobtained from the Blockstack network (DANGEROUS)-D DENOMINATION Denominate the price to pay in the given units(DANGEROUS)-C CONSENSUS_HASH Use the given consensus hash instead of one obtainedfrom the network-F FEE_RATE Use the given transaction fee rate instead of the oneobtained from the Bitcoin network-G GRACE_PERIOD Number of blocks in which a name can be renewed after itexpires (DANGEROUS)-H URL Use an alternative Blockstack Core API endpoint.-I URL Use an alternative Blockstack Core Indexer endpoint.-M MAX_INDEX Maximum keychain index to use when searching for an identity address(default is ${DEFAULT_MAX_ID_SEARCH_INDEX}).-N PAY2NS_PERIOD Number of blocks in which a namespace receives the registrationand renewal fees after it is created (DANGEROUS)-P PRICE Use the given price to pay for names or namespaces(DANGEROUS)-T URL Use an alternative Blockstack transaction broadcaster.-X URL Use an alternative UTXO service endpoint.-u USERNAME A username to be passed to bitcoind RPC endpoints-p PASSWORD A password to be passed to bitcoind RPC endpoints`</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#L2730">packages/cli/src/argparse.ts:2730</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable">
|
|
<a name="version" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> VERSION</h3>
|
|
<div class="tsd-signature tsd-kind-icon">VERSION<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"1.3.1"</span><span class="tsd-signature-symbol"> = "1.3.1"</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/auth/src/messages.ts#L15">packages/auth/src/messages.ts:15</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable">
|
|
<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">
|
|
<a name="zonefile" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> Zone<wbr>File</h3>
|
|
<div class="tsd-signature tsd-kind-icon">Zone<wbr>File<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> = require('zone-file')</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/cli/src/utils.ts#L30">packages/cli/src/utils.ts:30</a></li>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/cli/src/data.ts#L6">packages/cli/src/data.ts:6</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable">
|
|
<a name="authtransitnonce" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> auth<wbr>Transit<wbr>Nonce</h3>
|
|
<div class="tsd-signature tsd-kind-icon">auth<wbr>Transit<wbr>Nonce<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = crypto.randomBytes(32).toString('hex')</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#L91">packages/cli/src/auth.ts:91</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable">
|
|
<a name="c32check" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> c32check</h3>
|
|
<div class="tsd-signature tsd-kind-icon">c32check<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> = require('c32check')</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#L43">packages/cli/src/cli.ts:43</a></li>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/cli/src/keys.ts#L8">packages/cli/src/keys.ts:8</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable">
|
|
<a name="ecurve" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> ecurve</h3>
|
|
<div class="tsd-signature tsd-kind-icon">ecurve<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">ec</span><span class="tsd-signature-symbol"> = new EllipticCurve('secp256k1')</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/encryption/src/ec.ts#L11">packages/encryption/src/ec.ts:11</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable">
|
|
<a name="enumcheckfunctions" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> enum<wbr>Check<wbr>Functions</h3>
|
|
<div class="tsd-signature tsd-kind-icon">enum<wbr>Check<wbr>Functions<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Map</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">(</span>value<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">boolean</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> = new Map<object, (value: number) => boolean>()</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/transactions/src/bufferReader.ts#L13">packages/transactions/src/bufferReader.ts:13</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable">
|
|
<a name="estimateonly" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagLet">Let</span> estimate<wbr>Only</h3>
|
|
<div class="tsd-signature tsd-kind-icon">estimate<wbr>Only<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</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#L114">packages/cli/src/cli.ts:114</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable">
|
|
<a name="global" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagLet">Let</span> global</h3>
|
|
<div class="tsd-signature tsd-kind-icon">global<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/cli/src/index.ts#L11">packages/cli/src/index.ts:11</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable">
|
|
<a name="graceperiod" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagLet">Let</span> grace<wbr>Period</h3>
|
|
<div class="tsd-signature tsd-kind-icon">grace<wbr>Period<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 5000</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#L117">packages/cli/src/cli.ts:117</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable">
|
|
<a name="inttolevel" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> int<wbr>ToLevel</h3>
|
|
<div class="tsd-signature tsd-kind-icon">int<wbr>ToLevel<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/common/src/logger.ts#L6">packages/common/src/logger.ts:6</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-type-declaration">
|
|
<h4>Type declaration</h4>
|
|
<ul class="tsd-parameters">
|
|
<li class="tsd-parameter-index-signature">
|
|
<h5><span class="tsd-signature-symbol">[</span>int: <span class="tsd-signature-type">number</span><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">
|
|
<a name="leveltoint" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> level<wbr>ToInt</h3>
|
|
<div class="tsd-signature tsd-kind-icon">level<wbr>ToInt<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/common/src/logger.ts#L5">packages/common/src/logger.ts:5</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-type-declaration">
|
|
<h4>Type declaration</h4>
|
|
<ul class="tsd-parameters">
|
|
<li class="tsd-parameter-index-signature">
|
|
<h5><span class="tsd-signature-symbol">[</span>level: <span class="tsd-signature-type">string</span><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-variable">
|
|
<a name="levels" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> levels</h3>
|
|
<div class="tsd-signature tsd-kind-icon">levels<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = ['debug', 'info', 'warn', 'error', 'none']</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/common/src/logger.ts#L3">packages/common/src/logger.ts:3</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable">
|
|
<a name="localstorageram" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> local<wbr>StorageRAM</h3>
|
|
<div class="tsd-signature tsd-kind-icon">local<wbr>StorageRAM<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Record</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">any</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/index.ts#L8">packages/cli/src/index.ts:8</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable">
|
|
<a name="maxidsearchindex" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagLet">Let</span> maxIDSearch<wbr>Index</h3>
|
|
<div class="tsd-signature tsd-kind-icon">maxIDSearch<wbr>Index<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = DEFAULT_MAX_ID_SEARCH_INDEX</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#L119">packages/cli/src/cli.ts:119</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable">
|
|
<a name="networkderivationpath" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> network<wbr>Derivation<wbr>Path</h3>
|
|
<div class="tsd-signature tsd-kind-icon">network<wbr>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/keychain/src/address-derivation/index.ts#L5">packages/keychain/src/address-derivation/index.ts:5</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable">
|
|
<a name="noexit" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagLet">Let</span> no<wbr>Exit</h3>
|
|
<div class="tsd-signature tsd-kind-icon">no<wbr>Exit<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</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#L118">packages/cli/src/cli.ts:118</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable">
|
|
<a name="receivefeesperiod" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagLet">Let</span> receive<wbr>Fees<wbr>Period</h3>
|
|
<div class="tsd-signature tsd-kind-icon">receive<wbr>Fees<wbr>Period<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 52595</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#L116">packages/cli/src/cli.ts:116</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable">
|
|
<a name="safetychecks" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagLet">Let</span> safety<wbr>Checks</h3>
|
|
<div class="tsd-signature tsd-kind-icon">safety<wbr>Checks<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</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#L115">packages/cli/src/cli.ts:115</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable">
|
|
<a name="txonly" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagLet">Let</span> tx<wbr>Only</h3>
|
|
<div class="tsd-signature tsd-kind-icon">tx<wbr>Only<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</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#L113">packages/cli/src/cli.ts:113</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">
|
|
<a name="climain" class="tsd-anchor"></a>
|
|
<h3>CLIMain</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<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#L1762">packages/cli/src/cli.ts:1762</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">
|
|
<a name="clioptasbool" class="tsd-anchor"></a>
|
|
<h3>CLIOpt<wbr>AsBool</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">CLIOpt<wbr>AsBool<span class="tsd-signature-symbol">(</span>opts<span class="tsd-signature-symbol">: </span><a href="interfaces/cli_opts.html" class="tsd-signature-type">CLI_OPTS</a>, 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#L3134">packages/cli/src/argparse.ts:3134</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>opts: <a href="interfaces/cli_opts.html" class="tsd-signature-type">CLI_OPTS</a></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">
|
|
<a name="clioptasstring" class="tsd-anchor"></a>
|
|
<h3>CLIOpt<wbr>AsString</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">CLIOpt<wbr>AsString<span class="tsd-signature-symbol">(</span>opts<span class="tsd-signature-symbol">: </span><a href="interfaces/cli_opts.html" class="tsd-signature-type">CLI_OPTS</a>, 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#L3124">packages/cli/src/argparse.ts:3124</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>opts: <a href="interfaces/cli_opts.html" class="tsd-signature-type">CLI_OPTS</a></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">
|
|
<a name="clioptasstringarray" class="tsd-anchor"></a>
|
|
<h3>CLIOpt<wbr>AsString<wbr>Array</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<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><a href="interfaces/cli_opts.html" class="tsd-signature-type">CLI_OPTS</a>, 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#L3152">packages/cli/src/argparse.ts:3152</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>opts: <a href="interfaces/cli_opts.html" class="tsd-signature-type">CLI_OPTS</a></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">
|
|
<a name="jsonstringify" class="tsd-anchor"></a>
|
|
<h3>JSONStringify</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">JSONStringify<span class="tsd-signature-symbol">(</span>obj<span class="tsd-signature-symbol">: </span><a href="globals.html#anyjson" class="tsd-signature-type">AnyJson</a>, 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#L382">packages/cli/src/utils.ts:382</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>obj: <a href="globals.html#anyjson" class="tsd-signature-type">AnyJson</a></h5>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> 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">
|
|
<a name="abifunctiontostring" class="tsd-anchor"></a>
|
|
<h3>abi<wbr>Function<wbr>ToString</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">abi<wbr>Function<wbr>ToString<span class="tsd-signature-symbol">(</span>func<span class="tsd-signature-symbol">: </span><a href="interfaces/clarityabifunction.html" class="tsd-signature-type">ClarityAbiFunction</a><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/transactions/src/contract-abi.ts#L232">packages/transactions/src/contract-abi.ts:232</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>func: <a href="interfaces/clarityabifunction.html" class="tsd-signature-type">ClarityAbiFunction</a></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">
|
|
<a name="addressconvert" class="tsd-anchor"></a>
|
|
<h3>address<wbr>Convert</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">address<wbr>Convert<span class="tsd-signature-symbol">(</span>network<span class="tsd-signature-symbol">: </span><a href="classes/clinetworkadapter.html" class="tsd-signature-type">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></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#L1298">packages/cli/src/cli.ts:1298</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>network: <a href="classes/clinetworkadapter.html" class="tsd-signature-type">CLINetworkAdapter</a></h5>
|
|
</li>
|
|
<li>
|
|
<h5>args: <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-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">
|
|
<a name="addressfromhashmode" class="tsd-anchor"></a>
|
|
<h3>address<wbr>From<wbr>Hash<wbr>Mode</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">address<wbr>From<wbr>Hash<wbr>Mode<span class="tsd-signature-symbol">(</span>hashMode<span class="tsd-signature-symbol">: </span><a href="enums/addresshashmode.html" class="tsd-signature-type">AddressHashMode</a>, txVersion<span class="tsd-signature-symbol">: </span><a href="enums/transactionversion.html" class="tsd-signature-type">TransactionVersion</a>, data<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/address.html" class="tsd-signature-type">Address</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/transactions/src/types.ts#L176">packages/transactions/src/types.ts:176</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>hashMode: <a href="enums/addresshashmode.html" class="tsd-signature-type">AddressHashMode</a></h5>
|
|
</li>
|
|
<li>
|
|
<h5>txVersion: <a href="enums/transactionversion.html" class="tsd-signature-type">TransactionVersion</a></h5>
|
|
</li>
|
|
<li>
|
|
<h5>data: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="interfaces/address.html" class="tsd-signature-type">Address</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="addressfrompublickeys" class="tsd-anchor"></a>
|
|
<h3>address<wbr>From<wbr>Public<wbr>Keys</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">address<wbr>From<wbr>Public<wbr>Keys<span class="tsd-signature-symbol">(</span>version<span class="tsd-signature-symbol">: </span><a href="enums/addressversion.html" class="tsd-signature-type">AddressVersion</a>, hashMode<span class="tsd-signature-symbol">: </span><a href="enums/addresshashmode.html" class="tsd-signature-type">AddressHashMode</a>, numSigs<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, publicKeys<span class="tsd-signature-symbol">: </span><a href="interfaces/stackspublickey.html" class="tsd-signature-type">StacksPublicKey</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="interfaces/address.html" class="tsd-signature-type">Address</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/transactions/src/types.ts#L185">packages/transactions/src/types.ts:185</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>version: <a href="enums/addressversion.html" class="tsd-signature-type">AddressVersion</a></h5>
|
|
</li>
|
|
<li>
|
|
<h5>hashMode: <a href="enums/addresshashmode.html" class="tsd-signature-type">AddressHashMode</a></h5>
|
|
</li>
|
|
<li>
|
|
<h5>numSigs: <span class="tsd-signature-type">number</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>publicKeys: <a href="interfaces/stackspublickey.html" class="tsd-signature-type">StacksPublicKey</a><span class="tsd-signature-symbol">[]</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="interfaces/address.html" class="tsd-signature-type">Address</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="addressfromversionhash" class="tsd-anchor"></a>
|
|
<h3>address<wbr>From<wbr>Version<wbr>Hash</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">address<wbr>From<wbr>Version<wbr>Hash<span class="tsd-signature-symbol">(</span>version<span class="tsd-signature-symbol">: </span><a href="enums/addressversion.html" class="tsd-signature-type">AddressVersion</a>, hash<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/address.html" class="tsd-signature-type">Address</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/transactions/src/types.ts#L134">packages/transactions/src/types.ts:134</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>version: <a href="enums/addressversion.html" class="tsd-signature-type">AddressVersion</a></h5>
|
|
</li>
|
|
<li>
|
|
<h5>hash: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="interfaces/address.html" class="tsd-signature-type">Address</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="addresshashmodetoversion" class="tsd-anchor"></a>
|
|
<h3>address<wbr>Hash<wbr>Mode<wbr>ToVersion</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">address<wbr>Hash<wbr>Mode<wbr>ToVersion<span class="tsd-signature-symbol">(</span>hashMode<span class="tsd-signature-symbol">: </span><a href="enums/addresshashmode.html" class="tsd-signature-type">AddressHashMode</a>, txVersion<span class="tsd-signature-symbol">: </span><a href="enums/transactionversion.html" class="tsd-signature-type">TransactionVersion</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="enums/addressversion.html" class="tsd-signature-type">AddressVersion</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/transactions/src/types.ts#L142">packages/transactions/src/types.ts:142</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Translates the tx auth hash mode to the corresponding address version.</p>
|
|
</div>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>see</dt>
|
|
<dd><p><a href="https://github.com/blockstack/stacks-blockchain/blob/master/sip/sip-005-blocks-and-transactions.md#transaction-authorization">https://github.com/blockstack/stacks-blockchain/blob/master/sip/sip-005-blocks-and-transactions.md#transaction-authorization</a></p>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>hashMode: <a href="enums/addresshashmode.html" class="tsd-signature-type">AddressHashMode</a></h5>
|
|
</li>
|
|
<li>
|
|
<h5>txVersion: <a href="enums/transactionversion.html" class="tsd-signature-type">TransactionVersion</a></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="enums/addressversion.html" class="tsd-signature-type">AddressVersion</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="addresstostring" class="tsd-anchor"></a>
|
|
<h3>address<wbr>ToString</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">address<wbr>ToString<span class="tsd-signature-symbol">(</span>address<span class="tsd-signature-symbol">: </span><a href="interfaces/address.html" class="tsd-signature-type">Address</a><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/transactions/src/types.ts#L221">packages/transactions/src/types.ts:221</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>address: <a href="interfaces/address.html" class="tsd-signature-type">Address</a></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">
|
|
<a name="answertoclarityvalue" class="tsd-anchor"></a>
|
|
<h3>answer<wbr>ToClarity<wbr>Value</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<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/clarityfunctionarg.html" class="tsd-signature-type">ClarityFunctionArg</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="globals.html#clarityvalue" class="tsd-signature-type">ClarityValue</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#L862">packages/cli/src/utils.ts:862</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/clarityfunctionarg.html" class="tsd-signature-type">ClarityFunctionArg</a></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="globals.html#clarityvalue" class="tsd-signature-type">ClarityValue</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="argtoprompt" class="tsd-anchor"></a>
|
|
<h3>arg<wbr>ToPrompt</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<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/clarityfunctionarg.html" class="tsd-signature-type">ClarityFunctionArg</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="interfaces/inquirerprompt.html" class="tsd-signature-type">InquirerPrompt</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#L797">packages/cli/src/utils.ts:797</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>arg: <a href="interfaces/clarityfunctionarg.html" class="tsd-signature-type">ClarityFunctionArg</a></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="interfaces/inquirerprompt.html" class="tsd-signature-type">InquirerPrompt</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-has-type-parameter">
|
|
<a name="assertistruthy" class="tsd-anchor"></a>
|
|
<h3>assert<wbr>IsTruthy</h3>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-has-type-parameter">
|
|
<li class="tsd-signature tsd-kind-icon">assert<wbr>IsTruthy<T><span class="tsd-signature-symbol">(</span>val<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">asserts</span><span class="tsd-signature-type">val</span><span class="tsd-signature-symbol"> is </span><span class="tsd-signature-type">NonNullable</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</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/keychain/src/utils/index.ts#L150">packages/keychain/src/utils/index.ts:150</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-type-parameters-title">Type parameters</h4>
|
|
<ul class="tsd-type-parameters">
|
|
<li>
|
|
<h4>T</h4>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>val: <span class="tsd-signature-type">any</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">asserts</span><span class="tsd-signature-type">val</span><span class="tsd-signature-symbol"> is </span><span class="tsd-signature-type">NonNullable</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="authdaemon" class="tsd-anchor"></a>
|
|
<h3>auth<wbr>Daemon</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">auth<wbr>Daemon<span class="tsd-signature-symbol">(</span>network<span class="tsd-signature-symbol">: </span><a href="classes/clinetworkadapter.html" class="tsd-signature-type">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></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#L1350">packages/cli/src/cli.ts:1350</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>network: <a href="classes/clinetworkadapter.html" class="tsd-signature-type">CLINetworkAdapter</a></h5>
|
|
</li>
|
|
<li>
|
|
<h5>args: <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-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">
|
|
<a name="balance" class="tsd-anchor"></a>
|
|
<h3>balance</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">balance<span class="tsd-signature-symbol">(</span>network<span class="tsd-signature-symbol">: </span><a href="classes/clinetworkadapter.html" class="tsd-signature-type">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></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#L355">packages/cli/src/cli.ts:355</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>network: <a href="classes/clinetworkadapter.html" class="tsd-signature-type">CLINetworkAdapter</a></h5>
|
|
</li>
|
|
<li>
|
|
<h5>args: <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-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-has-type-parameter">
|
|
<a name="batchify" class="tsd-anchor"></a>
|
|
<h3>batchify</h3>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-has-type-parameter">
|
|
<li class="tsd-signature tsd-kind-icon">batchify<T><span class="tsd-signature-symbol">(</span>input<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">[]</span>, batchSize<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">T</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/cli.ts#L987">packages/cli/src/cli.ts:987</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-type-parameters-title">Type parameters</h4>
|
|
<ul class="tsd-type-parameters">
|
|
<li>
|
|
<h4>T</h4>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>input: <span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">[]</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> batchSize: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 50</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">T</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">
|
|
<a name="broadcastrawtransaction" class="tsd-anchor"></a>
|
|
<h3>broadcast<wbr>Raw<wbr>Transaction</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">broadcast<wbr>Raw<wbr>Transaction<span class="tsd-signature-symbol">(</span>rawTx<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</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">Promise</span><span class="tsd-signature-symbol"><</span><a href="globals.html#txbroadcastresult" class="tsd-signature-type">TxBroadcastResult</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/transactions/src/builders.ts#L176">packages/transactions/src/builders.ts:176</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Broadcast the signed transaction to a core node</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>rawTx: <span class="tsd-signature-type">Buffer</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>the raw serialized transaction buffer to broadcast</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5>url: <span class="tsd-signature-type">string</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>the broadcast endpoint URL</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="globals.html#txbroadcastresult" class="tsd-signature-type">TxBroadcastResult</a><span class="tsd-signature-symbol">></span></h4>
|
|
<p>that resolves to a response if the operation succeeds</p>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="broadcasttransaction" class="tsd-anchor"></a>
|
|
<h3>broadcast<wbr>Transaction</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">broadcast<wbr>Transaction<span class="tsd-signature-symbol">(</span>transaction<span class="tsd-signature-symbol">: </span><a href="classes/stackstransaction.html" class="tsd-signature-type">StacksTransaction</a>, 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">Promise</span><span class="tsd-signature-symbol"><</span><a href="globals.html#txbroadcastresult" class="tsd-signature-type">TxBroadcastResult</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/transactions/src/builders.ts#L158">packages/transactions/src/builders.ts:158</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Broadcast the signed transaction to a core node</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>transaction: <a href="classes/stackstransaction.html" class="tsd-signature-type">StacksTransaction</a></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>the token transfer transaction to broadcast</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5>network: <span class="tsd-signature-type">StacksNetwork</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>the Stacks network to broadcast transaction to</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="globals.html#txbroadcastresult" class="tsd-signature-type">TxBroadcastResult</a><span class="tsd-signature-symbol">></span></h4>
|
|
<p>that resolves to a response if the operation succeeds</p>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<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">
|
|
<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/clinetworkadapter.html" class="tsd-signature-type">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">undefined</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">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">false</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>status<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">true</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">false</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#L507">packages/cli/src/utils.ts:507</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>network: <a href="classes/clinetworkadapter.html" class="tsd-signature-type">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">undefined</span><span class="tsd-signature-symbol"> | </span><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">false</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>status<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">true</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">false</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">
|
|
<a name="buffercv" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> bufferCV</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">bufferCV<span class="tsd-signature-symbol">(</span>buffer<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><a href="interfaces/buffercv.html" class="tsd-signature-type">BufferCV</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/transactions/src/clarity/types/bufferCV.ts#L8">packages/transactions/src/clarity/types/bufferCV.ts:8</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>buffer: <span class="tsd-signature-type">Buffer</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="interfaces/buffercv.html" class="tsd-signature-type">BufferCV</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="buffercvfromstring" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> bufferCVFrom<wbr>String</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">bufferCVFrom<wbr>String<span class="tsd-signature-symbol">(</span>str<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/buffercv.html" class="tsd-signature-type">BufferCV</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/transactions/src/clarity/types/bufferCV.ts#L16">packages/transactions/src/clarity/types/bufferCV.ts:16</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>str: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="interfaces/buffercv.html" class="tsd-signature-type">BufferCV</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="bufferwithtypeid" class="tsd-anchor"></a>
|
|
<h3>buffer<wbr>With<wbr>TypeID</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">buffer<wbr>With<wbr>TypeID<span class="tsd-signature-symbol">(</span>typeId<span class="tsd-signature-symbol">: </span><a href="enums/claritytype.html" class="tsd-signature-type">ClarityType</a>, buffer<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/transactions/src/clarity/serialize.ts#L20">packages/transactions/src/clarity/serialize.ts:20</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>typeId: <a href="enums/claritytype.html" class="tsd-signature-type">ClarityType</a></h5>
|
|
</li>
|
|
<li>
|
|
<h5>buffer: <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">
|
|
<a name="callreadonlyfunction" class="tsd-anchor"></a>
|
|
<h3>call<wbr>Read<wbr>Only<wbr>Function</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">call<wbr>Read<wbr>Only<wbr>Function<span class="tsd-signature-symbol">(</span>readOnlyFunctionOptions<span class="tsd-signature-symbol">: </span><a href="interfaces/readonlyfunctionoptions.html" class="tsd-signature-type">ReadOnlyFunctionOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="globals.html#clarityvalue" class="tsd-signature-type">ClarityValue</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/transactions/src/builders.ts#L1029">packages/transactions/src/builders.ts:1029</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Calls a read only function from a contract interface</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>readOnlyFunctionOptions: <a href="interfaces/readonlyfunctionoptions.html" class="tsd-signature-type">ReadOnlyFunctionOptions</a></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>the options object</p>
|
|
<p>Returns an object with a status bool (okay) and a result string that is a serialized clarity value in hex format.</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="globals.html#clarityvalue" class="tsd-signature-type">ClarityValue</a><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="canstack" class="tsd-anchor"></a>
|
|
<h3>can<wbr>Stack</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">can<wbr>Stack<span class="tsd-signature-symbol">(</span>network<span class="tsd-signature-symbol">: </span><a href="classes/clinetworkadapter.html" class="tsd-signature-type">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></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#L1508">packages/cli/src/cli.ts:1508</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>network: <a href="classes/clinetworkadapter.html" class="tsd-signature-type">CLINetworkAdapter</a></h5>
|
|
</li>
|
|
<li>
|
|
<h5>args: <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-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">
|
|
<a name="canonicalprivatekey" class="tsd-anchor"></a>
|
|
<h3>canonical<wbr>Private<wbr>Key</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<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#L428">packages/cli/src/utils.ts:428</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">
|
|
<a name="checkargs" class="tsd-anchor"></a>
|
|
<h3>check<wbr>Args</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<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">Array</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><a href="interfaces/checkargssuccesstype.html" class="tsd-signature-type">CheckArgsSuccessType</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/checkargsfailtype.html" class="tsd-signature-type">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#L3272">packages/cli/src/argparse.ts:3272</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>argList: <span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><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/checkargssuccesstype.html" class="tsd-signature-type">CheckArgsSuccessType</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/checkargsfailtype.html" class="tsd-signature-type">CheckArgsFailType</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="checkurl" class="tsd-anchor"></a>
|
|
<h3>check<wbr>Url</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<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#L454">packages/cli/src/utils.ts:454</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">
|
|
<a name="clearcondition" class="tsd-anchor"></a>
|
|
<h3>clear<wbr>Condition</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">clear<wbr>Condition<span class="tsd-signature-symbol">(</span>condition<span class="tsd-signature-symbol">: </span><a href="globals.html#spendingcondition" class="tsd-signature-type">SpendingCondition</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="globals.html#spendingcondition" class="tsd-signature-type">SpendingCondition</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/transactions/src/authorization.ts#L204">packages/transactions/src/authorization.ts:204</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>condition: <a href="globals.html#spendingcondition" class="tsd-signature-type">SpendingCondition</a></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="globals.html#spendingcondition" class="tsd-signature-type">SpendingCondition</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-has-type-parameter">
|
|
<a name="clonedeep" class="tsd-anchor"></a>
|
|
<h3>clone<wbr>Deep</h3>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-has-type-parameter">
|
|
<li class="tsd-signature tsd-kind-icon">clone<wbr>Deep<T><span class="tsd-signature-symbol">(</span>obj<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</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/transactions/src/utils.ts#L53">packages/transactions/src/utils.ts:53</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-type-parameters-title">Type parameters</h4>
|
|
<ul class="tsd-type-parameters">
|
|
<li>
|
|
<h4>T</h4>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>obj: <span class="tsd-signature-type">T</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">T</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="codebodystring" class="tsd-anchor"></a>
|
|
<h3>code<wbr>Body<wbr>String</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">code<wbr>Body<wbr>String<span class="tsd-signature-symbol">(</span>content<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/lengthprefixedstring.html" class="tsd-signature-type">LengthPrefixedString</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/transactions/src/types.ts#L374">packages/transactions/src/types.ts:374</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>content: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="interfaces/lengthprefixedstring.html" class="tsd-signature-type">LengthPrefixedString</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="connecttogaiahubwithconfig" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> connect<wbr>ToGaia<wbr>Hub<wbr>With<wbr>Config</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">connect<wbr>ToGaia<wbr>Hub<wbr>With<wbr>Config<span class="tsd-signature-symbol">(</span>__namedParameters<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>gaiaHubUrl<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>hubInfo<span class="tsd-signature-symbol">: </span><a href="interfaces/hubinfo.html" class="tsd-signature-type">HubInfo</a><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-symbol">: </span><span class="tsd-signature-type">GaiaHubConfig</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/keychain/src/utils/gaia.ts#L51">packages/keychain/src/utils/gaia.ts:51</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>__namedParameters: <span class="tsd-signature-symbol">{ </span>gaiaHubUrl<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>hubInfo<span class="tsd-signature-symbol">: </span><a href="interfaces/hubinfo.html" class="tsd-signature-type">HubInfo</a><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>gaia<wbr>Hub<wbr>Url<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li class="tsd-parameter">
|
|
<h5>hub<wbr>Info<span class="tsd-signature-symbol">: </span><a href="interfaces/hubinfo.html" class="tsd-signature-type">HubInfo</a></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>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">GaiaHubConfig</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="containslegalcharacters" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> contains<wbr>Legal<wbr>Characters</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">contains<wbr>Legal<wbr>Characters<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/keychain/src/utils/index.ts#L163">packages/keychain/src/utils/index.ts:163</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">
|
|
<a name="contractdeploy" class="tsd-anchor"></a>
|
|
<h3>contract<wbr>Deploy</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">contract<wbr>Deploy<span class="tsd-signature-symbol">(</span>network<span class="tsd-signature-symbol">: </span><a href="classes/clinetworkadapter.html" class="tsd-signature-type">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></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#L597">packages/cli/src/cli.ts:597</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>network: <a href="classes/clinetworkadapter.html" class="tsd-signature-type">CLINetworkAdapter</a></h5>
|
|
</li>
|
|
<li>
|
|
<h5>args: <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-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">
|
|
<a name="contractfunctioncall" class="tsd-anchor"></a>
|
|
<h3>contract<wbr>Function<wbr>Call</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">contract<wbr>Function<wbr>Call<span class="tsd-signature-symbol">(</span>network<span class="tsd-signature-symbol">: </span><a href="classes/clinetworkadapter.html" class="tsd-signature-type">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></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#L657">packages/cli/src/cli.ts:657</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>network: <a href="classes/clinetworkadapter.html" class="tsd-signature-type">CLINetworkAdapter</a></h5>
|
|
</li>
|
|
<li>
|
|
<h5>args: <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-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">
|
|
<a name="contractprincipalcv" class="tsd-anchor"></a>
|
|
<h3>contract<wbr>PrincipalCV</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">contract<wbr>PrincipalCV<span class="tsd-signature-symbol">(</span>addressString<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, contractName<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/contractprincipalcv.html" class="tsd-signature-type">ContractPrincipalCV</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/transactions/src/clarity/types/principalCV.ts#L52">packages/transactions/src/clarity/types/principalCV.ts:52</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>addressString: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>contractName: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="interfaces/contractprincipalcv.html" class="tsd-signature-type">ContractPrincipalCV</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="contractprincipalcvfromaddress" class="tsd-anchor"></a>
|
|
<h3>contract<wbr>PrincipalCVFrom<wbr>Address</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">contract<wbr>PrincipalCVFrom<wbr>Address<span class="tsd-signature-symbol">(</span>address<span class="tsd-signature-symbol">: </span><a href="interfaces/address.html" class="tsd-signature-type">Address</a>, contractName<span class="tsd-signature-symbol">: </span><a href="interfaces/lengthprefixedstring.html" class="tsd-signature-type">LengthPrefixedString</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="interfaces/contractprincipalcv.html" class="tsd-signature-type">ContractPrincipalCV</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/transactions/src/clarity/types/principalCV.ts#L58">packages/transactions/src/clarity/types/principalCV.ts:58</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>address: <a href="interfaces/address.html" class="tsd-signature-type">Address</a></h5>
|
|
</li>
|
|
<li>
|
|
<h5>contractName: <a href="interfaces/lengthprefixedstring.html" class="tsd-signature-type">LengthPrefixedString</a></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="interfaces/contractprincipalcv.html" class="tsd-signature-type">ContractPrincipalCV</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="contractprincipalcvfromstandard" class="tsd-anchor"></a>
|
|
<h3>contract<wbr>PrincipalCVFrom<wbr>Standard</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">contract<wbr>PrincipalCVFrom<wbr>Standard<span class="tsd-signature-symbol">(</span>sp<span class="tsd-signature-symbol">: </span><a href="interfaces/standardprincipalcv.html" class="tsd-signature-type">StandardPrincipalCV</a>, contractName<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/contractprincipalcv.html" class="tsd-signature-type">ContractPrincipalCV</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/transactions/src/clarity/types/principalCV.ts#L68">packages/transactions/src/clarity/types/principalCV.ts:68</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>sp: <a href="interfaces/standardprincipalcv.html" class="tsd-signature-type">StandardPrincipalCV</a></h5>
|
|
</li>
|
|
<li>
|
|
<h5>contractName: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="interfaces/contractprincipalcv.html" class="tsd-signature-type">ContractPrincipalCV</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="createaddress" class="tsd-anchor"></a>
|
|
<h3>create<wbr>Address</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">create<wbr>Address<span class="tsd-signature-symbol">(</span>c32AddressString<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/address.html" class="tsd-signature-type">Address</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/transactions/src/types.ts#L117">packages/transactions/src/types.ts:117</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>c32AddressString: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="interfaces/address.html" class="tsd-signature-type">Address</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="createassetinfo" class="tsd-anchor"></a>
|
|
<h3>create<wbr>Asset<wbr>Info</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">create<wbr>Asset<wbr>Info<span class="tsd-signature-symbol">(</span>addressString<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, contractName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, assetName<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/assetinfo.html" class="tsd-signature-type">AssetInfo</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/transactions/src/types.ts#L424">packages/transactions/src/types.ts:424</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>addressString: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>contractName: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>assetName: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="interfaces/assetinfo.html" class="tsd-signature-type">AssetInfo</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="createcipher" class="tsd-anchor"></a>
|
|
<h3>create<wbr>Cipher</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">create<wbr>Cipher<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><a href="interfaces/aescipher.html" class="tsd-signature-type">AesCipher</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/encryption/src/aesCipher.ts#L109">packages/encryption/src/aesCipher.ts:109</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="interfaces/aescipher.html" class="tsd-signature-type">AesCipher</a><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="createcoinbasepayload" class="tsd-anchor"></a>
|
|
<h3>create<wbr>Coinbase<wbr>Payload</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">create<wbr>Coinbase<wbr>Payload<span class="tsd-signature-symbol">(</span>coinbaseBuffer<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><a href="interfaces/coinbasepayload.html" class="tsd-signature-type">CoinbasePayload</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/transactions/src/payload.ts#L137">packages/transactions/src/payload.ts:137</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>coinbaseBuffer: <span class="tsd-signature-type">Buffer</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="interfaces/coinbasepayload.html" class="tsd-signature-type">CoinbasePayload</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="createcontractcallpayload" class="tsd-anchor"></a>
|
|
<h3>create<wbr>Contract<wbr>Call<wbr>Payload</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">create<wbr>Contract<wbr>Call<wbr>Payload<span class="tsd-signature-symbol">(</span>contractAddress<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="interfaces/address.html" class="tsd-signature-type">Address</a>, contractName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="interfaces/lengthprefixedstring.html" class="tsd-signature-type">LengthPrefixedString</a>, functionName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="interfaces/lengthprefixedstring.html" class="tsd-signature-type">LengthPrefixedString</a>, functionArgs<span class="tsd-signature-symbol">: </span><a href="globals.html#clarityvalue" class="tsd-signature-type">ClarityValue</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="interfaces/contractcallpayload.html" class="tsd-signature-type">ContractCallPayload</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/transactions/src/payload.ts#L70">packages/transactions/src/payload.ts:70</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>contractAddress: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="interfaces/address.html" class="tsd-signature-type">Address</a></h5>
|
|
</li>
|
|
<li>
|
|
<h5>contractName: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="interfaces/lengthprefixedstring.html" class="tsd-signature-type">LengthPrefixedString</a></h5>
|
|
</li>
|
|
<li>
|
|
<h5>functionName: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="interfaces/lengthprefixedstring.html" class="tsd-signature-type">LengthPrefixedString</a></h5>
|
|
</li>
|
|
<li>
|
|
<h5>functionArgs: <a href="globals.html#clarityvalue" class="tsd-signature-type">ClarityValue</a><span class="tsd-signature-symbol">[]</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="interfaces/contractcallpayload.html" class="tsd-signature-type">ContractCallPayload</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="createcontractprincipal" class="tsd-anchor"></a>
|
|
<h3>create<wbr>Contract<wbr>Principal</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">create<wbr>Contract<wbr>Principal<span class="tsd-signature-symbol">(</span>addressString<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, contractName<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/contractprincipal.html" class="tsd-signature-type">ContractPrincipal</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/transactions/src/types.ts#L281">packages/transactions/src/types.ts:281</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>addressString: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>contractName: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="interfaces/contractprincipal.html" class="tsd-signature-type">ContractPrincipal</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="createemptyaddress" class="tsd-anchor"></a>
|
|
<h3>create<wbr>Empty<wbr>Address</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">create<wbr>Empty<wbr>Address<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="interfaces/address.html" class="tsd-signature-type">Address</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/transactions/src/types.ts#L126">packages/transactions/src/types.ts:126</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-returns-title">Returns <a href="interfaces/address.html" class="tsd-signature-type">Address</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-has-type-parameter">
|
|
<a name="createenumchecker" class="tsd-anchor"></a>
|
|
<h3>create<wbr>Enum<wbr>Checker</h3>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-has-type-parameter">
|
|
<li class="tsd-signature tsd-kind-icon">create<wbr>Enum<wbr>Checker<T, TEnumValue><span class="tsd-signature-symbol">(</span>enumVariable<span class="tsd-signature-symbol">: </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>value<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">value</span><span class="tsd-signature-symbol"> is </span><span class="tsd-signature-type">TEnumValue</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/transactions/src/bufferReader.ts#L3">packages/transactions/src/bufferReader.ts:3</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-type-parameters-title">Type parameters</h4>
|
|
<ul class="tsd-type-parameters">
|
|
<li>
|
|
<h4>T<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h4>
|
|
</li>
|
|
<li>
|
|
<h4>TEnumValue<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h4>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>enumVariable: <span class="tsd-signature-symbol">{}</span></h5>
|
|
<ul class="tsd-parameters">
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">(</span>value<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">value</span><span class="tsd-signature-symbol"> is </span><span class="tsd-signature-type">TEnumValue</span></h4>
|
|
<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>value<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">value</span><span class="tsd-signature-symbol"> is </span><span class="tsd-signature-type">TEnumValue</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>value: <span class="tsd-signature-type">number</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">value</span><span class="tsd-signature-symbol"> is </span><span class="tsd-signature-type">TEnumValue</span></h4>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="createfungiblepostcondition" class="tsd-anchor"></a>
|
|
<h3>create<wbr>Fungible<wbr>Post<wbr>Condition</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">create<wbr>Fungible<wbr>Post<wbr>Condition<span class="tsd-signature-symbol">(</span>principal<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="globals.html#postconditionprincipal" class="tsd-signature-type">PostConditionPrincipal</a>, conditionCode<span class="tsd-signature-symbol">: </span><a href="enums/fungibleconditioncode.html" class="tsd-signature-type">FungibleConditionCode</a>, amount<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BigNum</span>, assetInfo<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="interfaces/assetinfo.html" class="tsd-signature-type">AssetInfo</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="interfaces/fungiblepostcondition.html" class="tsd-signature-type">FungiblePostCondition</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/transactions/src/postcondition.ts#L63">packages/transactions/src/postcondition.ts:63</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>principal: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="globals.html#postconditionprincipal" class="tsd-signature-type">PostConditionPrincipal</a></h5>
|
|
</li>
|
|
<li>
|
|
<h5>conditionCode: <a href="enums/fungibleconditioncode.html" class="tsd-signature-type">FungibleConditionCode</a></h5>
|
|
</li>
|
|
<li>
|
|
<h5>amount: <span class="tsd-signature-type">BigNum</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>assetInfo: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="interfaces/assetinfo.html" class="tsd-signature-type">AssetInfo</a></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="interfaces/fungiblepostcondition.html" class="tsd-signature-type">FungiblePostCondition</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="createhashripemd160" class="tsd-anchor"></a>
|
|
<h3>create<wbr>Hash<wbr>Ripemd160</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">create<wbr>Hash<wbr>Ripemd160<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="classes/ripemd160polyfilldigest.html" class="tsd-signature-type">Ripemd160PolyfillDigest</a><span class="tsd-signature-symbol"> | </span><a href="classes/nodecryptoripemd160digest.html" class="tsd-signature-type">NodeCryptoRipemd160Digest</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/encryption/src/hashRipemd160.ts#L52">packages/encryption/src/hashRipemd160.ts:52</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-returns-title">Returns <a href="classes/ripemd160polyfilldigest.html" class="tsd-signature-type">Ripemd160PolyfillDigest</a><span class="tsd-signature-symbol"> | </span><a href="classes/nodecryptoripemd160digest.html" class="tsd-signature-type">NodeCryptoRipemd160Digest</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="createhmacsha256" class="tsd-anchor"></a>
|
|
<h3>create<wbr>Hmac<wbr>Sha256</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">create<wbr>Hmac<wbr>Sha256<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><a href="interfaces/hmac.html" class="tsd-signature-type">Hmac</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/encryption/src/hmacSha256.ts#L49">packages/encryption/src/hmacSha256.ts:49</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="interfaces/hmac.html" class="tsd-signature-type">Hmac</a><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-has-type-parameter">
|
|
<a name="createlplist" class="tsd-anchor"></a>
|
|
<h3>createLPList</h3>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-has-type-parameter">
|
|
<li class="tsd-signature tsd-kind-icon">createLPList<T><span class="tsd-signature-symbol">(</span>values<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">[]</span>, lengthPrefixBytes<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><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><a href="interfaces/lengthprefixedlist.html" class="tsd-signature-type">LengthPrefixedList</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/transactions/src/types.ts#L460">packages/transactions/src/types.ts:460</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-type-parameters-title">Type parameters</h4>
|
|
<ul class="tsd-type-parameters">
|
|
<li>
|
|
<h4>T<span class="tsd-signature-symbol">: </span><a href="globals.html#stacksmessage" class="tsd-signature-type">StacksMessage</a></h4>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>values: <span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">[]</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> lengthPrefixBytes: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="interfaces/lengthprefixedlist.html" class="tsd-signature-type">LengthPrefixedList</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="createlpstring" class="tsd-anchor"></a>
|
|
<h3>createLPString</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">createLPString<span class="tsd-signature-symbol">(</span>content<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/lengthprefixedstring.html" class="tsd-signature-type">LengthPrefixedString</a></li>
|
|
<li class="tsd-signature tsd-kind-icon">createLPString<span class="tsd-signature-symbol">(</span>content<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, lengthPrefixBytes<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><a href="interfaces/lengthprefixedstring.html" class="tsd-signature-type">LengthPrefixedString</a></li>
|
|
<li class="tsd-signature tsd-kind-icon">createLPString<span class="tsd-signature-symbol">(</span>content<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, lengthPrefixBytes<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, maxLengthBytes<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><a href="interfaces/lengthprefixedstring.html" class="tsd-signature-type">LengthPrefixedString</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/transactions/src/types.ts#L329">packages/transactions/src/types.ts:329</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>content: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="interfaces/lengthprefixedstring.html" class="tsd-signature-type">LengthPrefixedString</a></h4>
|
|
</li>
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/transactions/src/types.ts#L330">packages/transactions/src/types.ts:330</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>content: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>lengthPrefixBytes: <span class="tsd-signature-type">number</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="interfaces/lengthprefixedstring.html" class="tsd-signature-type">LengthPrefixedString</a></h4>
|
|
</li>
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/transactions/src/types.ts#L331">packages/transactions/src/types.ts:331</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>content: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>lengthPrefixBytes: <span class="tsd-signature-type">number</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>maxLengthBytes: <span class="tsd-signature-type">number</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="interfaces/lengthprefixedstring.html" class="tsd-signature-type">LengthPrefixedString</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="creatememostring" class="tsd-anchor"></a>
|
|
<h3>create<wbr>Memo<wbr>String</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">create<wbr>Memo<wbr>String<span class="tsd-signature-symbol">(</span>content<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/memostring.html" class="tsd-signature-type">MemoString</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/transactions/src/types.ts#L383">packages/transactions/src/types.ts:383</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>content: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="interfaces/memostring.html" class="tsd-signature-type">MemoString</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="createmessagesignature" class="tsd-anchor"></a>
|
|
<h3>create<wbr>Message<wbr>Signature</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">create<wbr>Message<wbr>Signature<span class="tsd-signature-symbol">(</span>signature<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/messagesignature.html" class="tsd-signature-type">MessageSignature</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/transactions/src/authorization.ts#L52">packages/transactions/src/authorization.ts:52</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>signature: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="interfaces/messagesignature.html" class="tsd-signature-type">MessageSignature</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="createmultisigspendingcondition" class="tsd-anchor"></a>
|
|
<h3>create<wbr>Multi<wbr>Sig<wbr>Spending<wbr>Condition</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">create<wbr>Multi<wbr>Sig<wbr>Spending<wbr>Condition<span class="tsd-signature-symbol">(</span>hashMode<span class="tsd-signature-symbol">: </span><a href="globals.html#multisighashmode" class="tsd-signature-type">MultiSigHashMode</a>, numSigs<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, pubKeys<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span>, nonce<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BigNum</span>, fee<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BigNum</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="interfaces/multisigspendingcondition.html" class="tsd-signature-type">MultiSigSpendingCondition</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/transactions/src/authorization.ts#L178">packages/transactions/src/authorization.ts:178</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>hashMode: <a href="globals.html#multisighashmode" class="tsd-signature-type">MultiSigHashMode</a></h5>
|
|
</li>
|
|
<li>
|
|
<h5>numSigs: <span class="tsd-signature-type">number</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>pubKeys: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>nonce: <span class="tsd-signature-type">BigNum</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>fee: <span class="tsd-signature-type">BigNum</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="interfaces/multisigspendingcondition.html" class="tsd-signature-type">MultiSigSpendingCondition</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="createnonfungiblepostcondition" class="tsd-anchor"></a>
|
|
<h3>create<wbr>Non<wbr>Fungible<wbr>Post<wbr>Condition</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">create<wbr>Non<wbr>Fungible<wbr>Post<wbr>Condition<span class="tsd-signature-symbol">(</span>principal<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="globals.html#postconditionprincipal" class="tsd-signature-type">PostConditionPrincipal</a>, conditionCode<span class="tsd-signature-symbol">: </span><a href="enums/nonfungibleconditioncode.html" class="tsd-signature-type">NonFungibleConditionCode</a>, assetInfo<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="interfaces/assetinfo.html" class="tsd-signature-type">AssetInfo</a>, assetName<span class="tsd-signature-symbol">: </span><a href="globals.html#clarityvalue" class="tsd-signature-type">ClarityValue</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="interfaces/nonfungiblepostcondition.html" class="tsd-signature-type">NonFungiblePostCondition</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/transactions/src/postcondition.ts#L97">packages/transactions/src/postcondition.ts:97</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>principal: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="globals.html#postconditionprincipal" class="tsd-signature-type">PostConditionPrincipal</a></h5>
|
|
</li>
|
|
<li>
|
|
<h5>conditionCode: <a href="enums/nonfungibleconditioncode.html" class="tsd-signature-type">NonFungibleConditionCode</a></h5>
|
|
</li>
|
|
<li>
|
|
<h5>assetInfo: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="interfaces/assetinfo.html" class="tsd-signature-type">AssetInfo</a></h5>
|
|
</li>
|
|
<li>
|
|
<h5>assetName: <a href="globals.html#clarityvalue" class="tsd-signature-type">ClarityValue</a></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="interfaces/nonfungiblepostcondition.html" class="tsd-signature-type">NonFungiblePostCondition</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="createpbkdf2" class="tsd-anchor"></a>
|
|
<h3>create<wbr>Pbkdf2</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">create<wbr>Pbkdf2<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><a href="interfaces/pbkdf2.html" class="tsd-signature-type">Pbkdf2</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/encryption/src/pbkdf2.ts#L160">packages/encryption/src/pbkdf2.ts:160</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="interfaces/pbkdf2.html" class="tsd-signature-type">Pbkdf2</a><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="createpoisonpayload" class="tsd-anchor"></a>
|
|
<h3>create<wbr>Poison<wbr>Payload</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">create<wbr>Poison<wbr>Payload<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="interfaces/poisonpayload.html" class="tsd-signature-type">PoisonPayload</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/transactions/src/payload.ts#L127">packages/transactions/src/payload.ts:127</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-returns-title">Returns <a href="interfaces/poisonpayload.html" class="tsd-signature-type">PoisonPayload</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="createstxpostcondition" class="tsd-anchor"></a>
|
|
<h3>createSTXPost<wbr>Condition</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">createSTXPost<wbr>Condition<span class="tsd-signature-symbol">(</span>principal<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="globals.html#postconditionprincipal" class="tsd-signature-type">PostConditionPrincipal</a>, conditionCode<span class="tsd-signature-symbol">: </span><a href="enums/fungibleconditioncode.html" class="tsd-signature-type">FungibleConditionCode</a>, amount<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BigNum</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="interfaces/stxpostcondition.html" class="tsd-signature-type">STXPostCondition</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/transactions/src/postcondition.ts#L36">packages/transactions/src/postcondition.ts:36</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>principal: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="globals.html#postconditionprincipal" class="tsd-signature-type">PostConditionPrincipal</a></h5>
|
|
</li>
|
|
<li>
|
|
<h5>conditionCode: <a href="enums/fungibleconditioncode.html" class="tsd-signature-type">FungibleConditionCode</a></h5>
|
|
</li>
|
|
<li>
|
|
<h5>amount: <span class="tsd-signature-type">BigNum</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="interfaces/stxpostcondition.html" class="tsd-signature-type">STXPostCondition</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="createsha2hash" class="tsd-anchor"></a>
|
|
<h3>create<wbr>Sha2<wbr>Hash</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">create<wbr>Sha2<wbr>Hash<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="interfaces/sha2hash.html" class="tsd-signature-type">Sha2Hash</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/encryption/src/sha2Hash.ts#L62">packages/encryption/src/sha2Hash.ts:62</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="interfaces/sha2hash.html" class="tsd-signature-type">Sha2Hash</a><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="createsinglesigspendingcondition" class="tsd-anchor"></a>
|
|
<h3>create<wbr>Single<wbr>Sig<wbr>Spending<wbr>Condition</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">create<wbr>Single<wbr>Sig<wbr>Spending<wbr>Condition<span class="tsd-signature-symbol">(</span>hashMode<span class="tsd-signature-symbol">: </span><a href="globals.html#singlesighashmode" class="tsd-signature-type">SingleSigHashMode</a>, pubKey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, nonce<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BigNum</span>, fee<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BigNum</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="interfaces/singlesigspendingcondition.html" class="tsd-signature-type">SingleSigSpendingCondition</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/transactions/src/authorization.ts#L156">packages/transactions/src/authorization.ts:156</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>hashMode: <a href="globals.html#singlesighashmode" class="tsd-signature-type">SingleSigHashMode</a></h5>
|
|
</li>
|
|
<li>
|
|
<h5>pubKey: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>nonce: <span class="tsd-signature-type">BigNum</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>fee: <span class="tsd-signature-type">BigNum</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="interfaces/singlesigspendingcondition.html" class="tsd-signature-type">SingleSigSpendingCondition</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="createsmartcontractpayload" class="tsd-anchor"></a>
|
|
<h3>create<wbr>Smart<wbr>Contract<wbr>Payload</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">create<wbr>Smart<wbr>Contract<wbr>Payload<span class="tsd-signature-symbol">(</span>contractName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="interfaces/lengthprefixedstring.html" class="tsd-signature-type">LengthPrefixedString</a>, codeBody<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="interfaces/lengthprefixedstring.html" class="tsd-signature-type">LengthPrefixedString</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="interfaces/smartcontractpayload.html" class="tsd-signature-type">SmartContractPayload</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/transactions/src/payload.ts#L103">packages/transactions/src/payload.ts:103</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>contractName: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="interfaces/lengthprefixedstring.html" class="tsd-signature-type">LengthPrefixedString</a></h5>
|
|
</li>
|
|
<li>
|
|
<h5>codeBody: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="interfaces/lengthprefixedstring.html" class="tsd-signature-type">LengthPrefixedString</a></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="interfaces/smartcontractpayload.html" class="tsd-signature-type">SmartContractPayload</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="createstacksprivatekey" class="tsd-anchor"></a>
|
|
<h3>create<wbr>Stacks<wbr>Private<wbr>Key</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">create<wbr>Stacks<wbr>Private<wbr>Key<span class="tsd-signature-symbol">(</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-type">Buffer</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="interfaces/stacksprivatekey.html" class="tsd-signature-type">StacksPrivateKey</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/transactions/src/keys.ts#L121">packages/transactions/src/keys.ts:121</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>key: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Buffer</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="interfaces/stacksprivatekey.html" class="tsd-signature-type">StacksPrivateKey</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="createstackspublickey" class="tsd-anchor"></a>
|
|
<h3>create<wbr>Stacks<wbr>Public<wbr>Key</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">create<wbr>Stacks<wbr>Public<wbr>Key<span class="tsd-signature-symbol">(</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><a href="interfaces/stackspublickey.html" class="tsd-signature-type">StacksPublicKey</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/transactions/src/keys.ts#L55">packages/transactions/src/keys.ts:55</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>key: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="interfaces/stackspublickey.html" class="tsd-signature-type">StacksPublicKey</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="createstandardprincipal" class="tsd-anchor"></a>
|
|
<h3>create<wbr>Standard<wbr>Principal</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">create<wbr>Standard<wbr>Principal<span class="tsd-signature-symbol">(</span>addressString<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/standardprincipal.html" class="tsd-signature-type">StandardPrincipal</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/transactions/src/types.ts#L272">packages/transactions/src/types.ts:272</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>addressString: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="interfaces/standardprincipal.html" class="tsd-signature-type">StandardPrincipal</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="createtokentransferpayload" class="tsd-anchor"></a>
|
|
<h3>create<wbr>Token<wbr>Transfer<wbr>Payload</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">create<wbr>Token<wbr>Transfer<wbr>Payload<span class="tsd-signature-symbol">(</span>recipient<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="globals.html#principalcv" class="tsd-signature-type">PrincipalCV</a>, amount<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BigNum</span>, memo<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="interfaces/memostring.html" class="tsd-signature-type">MemoString</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="interfaces/tokentransferpayload.html" class="tsd-signature-type">TokenTransferPayload</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/transactions/src/payload.ts#L40">packages/transactions/src/payload.ts:40</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>recipient: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="globals.html#principalcv" class="tsd-signature-type">PrincipalCV</a></h5>
|
|
</li>
|
|
<li>
|
|
<h5>amount: <span class="tsd-signature-type">BigNum</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> memo: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="interfaces/memostring.html" class="tsd-signature-type">MemoString</a></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="interfaces/tokentransferpayload.html" class="tsd-signature-type">TokenTransferPayload</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="createtransactionauthfield" class="tsd-anchor"></a>
|
|
<h3>create<wbr>Transaction<wbr>Auth<wbr>Field</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">create<wbr>Transaction<wbr>Auth<wbr>Field<span class="tsd-signature-symbol">(</span>contents<span class="tsd-signature-symbol">: </span><a href="globals.html#transactionauthfieldcontents" class="tsd-signature-type">TransactionAuthFieldContents</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="interfaces/transactionauthfield.html" class="tsd-signature-type">TransactionAuthField</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/transactions/src/authorization.ts#L95">packages/transactions/src/authorization.ts:95</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>contents: <a href="globals.html#transactionauthfieldcontents" class="tsd-signature-type">TransactionAuthFieldContents</a></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="interfaces/transactionauthfield.html" class="tsd-signature-type">TransactionAuthField</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="cvtohex" class="tsd-anchor"></a>
|
|
<h3>cv<wbr>ToHex</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">cv<wbr>ToHex<span class="tsd-signature-symbol">(</span>cv<span class="tsd-signature-symbol">: </span><a href="globals.html#clarityvalue" class="tsd-signature-type">ClarityValue</a><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/transactions/src/utils.ts#L155">packages/transactions/src/utils.ts:155</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Converts a clarity value to a hex encoded string with <code>0x</code> prefix</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>cv: <a href="globals.html#clarityvalue" class="tsd-signature-type">ClarityValue</a></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>the clarity value to convert</p>
|
|
</div>
|
|
</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">
|
|
<a name="cvtojson" class="tsd-anchor"></a>
|
|
<h3>cv<wbr>ToJSON</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">cv<wbr>ToJSON<span class="tsd-signature-symbol">(</span>val<span class="tsd-signature-symbol">: </span><a href="globals.html#clarityvalue" class="tsd-signature-type">ClarityValue</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</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/transactions/src/clarity/clarityValue.ts#L137">packages/transactions/src/clarity/clarityValue.ts:137</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>val: <a href="globals.html#clarityvalue" class="tsd-signature-type">ClarityValue</a></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="cvtostring" class="tsd-anchor"></a>
|
|
<h3>cv<wbr>ToString</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">cv<wbr>ToString<span class="tsd-signature-symbol">(</span>val<span class="tsd-signature-symbol">: </span><a href="globals.html#clarityvalue" class="tsd-signature-type">ClarityValue</a>, encoding<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">"tryAscii"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"hex"</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/transactions/src/clarity/clarityValue.ts#L57">packages/transactions/src/clarity/clarityValue.ts:57</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>val: <a href="globals.html#clarityvalue" class="tsd-signature-type">ClarityValue</a></h5>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> encoding: <span class="tsd-signature-type">"tryAscii"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"hex"</span><span class="tsd-signature-symbol"> = "hex"</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">
|
|
<a name="cvtovalue" class="tsd-anchor"></a>
|
|
<h3>cv<wbr>ToValue</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">cv<wbr>ToValue<span class="tsd-signature-symbol">(</span>val<span class="tsd-signature-symbol">: </span><a href="globals.html#clarityvalue" class="tsd-signature-type">ClarityValue</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</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/transactions/src/clarity/clarityValue.ts#L99">packages/transactions/src/clarity/clarityValue.ts:99</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>val: <a href="globals.html#clarityvalue" class="tsd-signature-type">ClarityValue</a></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="decodebtcaddress" class="tsd-anchor"></a>
|
|
<h3>decode<wbr>Btc<wbr>Address</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">decode<wbr>Btc<wbr>Address<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><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">; </span>hashMode<span class="tsd-signature-symbol">: </span><a href="enums/addresshashmode.html" class="tsd-signature-type">AddressHashMode</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/stacking/src/utils.ts#L31">packages/stacking/src/utils.ts:31</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>btcAddress: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{ </span>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">; </span>hashMode<span class="tsd-signature-symbol">: </span><a href="enums/addresshashmode.html" class="tsd-signature-type">AddressHashMode</a><span class="tsd-signature-symbol"> }</span></h4>
|
|
<ul class="tsd-parameters">
|
|
<li class="tsd-parameter">
|
|
<h5>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span></h5>
|
|
</li>
|
|
<li class="tsd-parameter">
|
|
<h5>hash<wbr>Mode<span class="tsd-signature-symbol">: </span><a href="enums/addresshashmode.html" class="tsd-signature-type">AddressHashMode</a></h5>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="decodeprivatekey" class="tsd-anchor"></a>
|
|
<h3>decode<wbr>Private<wbr>Key</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<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><a href="classes/clitransactionsigner.html" class="tsd-signature-type">CLITransactionSigner</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#L347">packages/cli/src/utils.ts:347</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><a href="classes/clitransactionsigner.html" class="tsd-signature-type">CLITransactionSigner</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="decrypt" class="tsd-anchor"></a>
|
|
<h3>decrypt</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">decrypt<span class="tsd-signature-symbol">(</span>dataBuffer<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span><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/keychain/src/encryption/decrypt.ts#L11">packages/keychain/src/encryption/decrypt.ts:11</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Decrypt an encrypted mnemonic phrase with a password.
|
|
Legacy triplesec encrypted payloads are also supported.</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>dataBuffer: <span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>password: <span class="tsd-signature-type">string</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Password for data</p>
|
|
</div>
|
|
</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>
|
|
<p>the raw mnemonic phrase</p>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="decryptbackupphrase" class="tsd-anchor"></a>
|
|
<h3>decrypt<wbr>Backup<wbr>Phrase</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<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#L7">packages/cli/src/encrypt.ts:7</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">
|
|
<a name="decryptcontent" class="tsd-anchor"></a>
|
|
<h3>decrypt<wbr>Content</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">decrypt<wbr>Content<span class="tsd-signature-symbol">(</span>content<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<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>privateKey<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</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><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-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/encryption/src/encryption.ts#L110">packages/encryption/src/encryption.ts:110</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Decrypts data encrypted with <code>encryptContent</code> with the
|
|
transit private key.</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>content: <span class="tsd-signature-type">string</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>encrypted content.</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span>privateKey<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><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-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-type">Buffer</span><span class="tsd-signature-symbol">></span></h4>
|
|
<p>decrypted content.</p>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="deletefromgaiahub" class="tsd-anchor"></a>
|
|
<h3>delete<wbr>From<wbr>Gaia<wbr>Hub</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">delete<wbr>From<wbr>Gaia<wbr>Hub<span class="tsd-signature-symbol">(</span>filename<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, hubConfig<span class="tsd-signature-symbol">: </span><a href="interfaces/gaiahubconfig.html" class="tsd-signature-type">GaiaHubConfig</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</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/storage/src/hub.ts#L104">packages/storage/src/hub.ts:104</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>filename: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>hubConfig: <a href="interfaces/gaiahubconfig.html" class="tsd-signature-type">GaiaHubConfig</a></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
</div>
|
|
</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">void</span><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="deriveidentitykeypair" class="tsd-anchor"></a>
|
|
<h3>derive<wbr>Identity<wbr>Key<wbr>Pair</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">derive<wbr>Identity<wbr>Key<wbr>Pair<span class="tsd-signature-symbol">(</span>identityOwnerAddressNode<span class="tsd-signature-symbol">: </span><a href="classes/identityaddressownernode.html" class="tsd-signature-type">IdentityAddressOwnerNode</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="interfaces/identitykeypair.html" class="tsd-signature-type">IdentityKeyPair</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/keychain/src/utils/index.ts#L78">packages/keychain/src/utils/index.ts:78</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>identityOwnerAddressNode: <a href="classes/identityaddressownernode.html" class="tsd-signature-type">IdentityAddressOwnerNode</a></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="interfaces/identitykeypair.html" class="tsd-signature-type">IdentityKeyPair</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="deriverootkeychainfrommnemonic" class="tsd-anchor"></a>
|
|
<h3>derive<wbr>Root<wbr>Keychain<wbr>From<wbr>Mnemonic</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">derive<wbr>Root<wbr>Keychain<wbr>From<wbr>Mnemonic<span class="tsd-signature-symbol">(</span>plaintextMnemonic<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">BIP32Interface</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/keychain/src/mnemonic/index.ts#L35">packages/keychain/src/mnemonic/index.ts:35</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>plaintextMnemonic: <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">BIP32Interface</span><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="derivestxaddresschain" class="tsd-anchor"></a>
|
|
<h3>derive<wbr>Stx<wbr>Address<wbr>Chain</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">derive<wbr>Stx<wbr>Address<wbr>Chain<span class="tsd-signature-symbol">(</span>chain<span class="tsd-signature-symbol">: </span><a href="enums/chainid.html" class="tsd-signature-type">ChainID</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">(Anonymous function)</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/keychain/src/address-derivation/index.ts#L16">packages/keychain/src/address-derivation/index.ts:16</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>chain: <a href="enums/chainid.html" class="tsd-signature-type">ChainID</a></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">(Anonymous function)</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="deserializeaddress" class="tsd-anchor"></a>
|
|
<h3>deserialize<wbr>Address</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">deserialize<wbr>Address<span class="tsd-signature-symbol">(</span>bufferReader<span class="tsd-signature-symbol">: </span><a href="classes/bufferreader.html" class="tsd-signature-type">BufferReader</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="interfaces/address.html" class="tsd-signature-type">Address</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/transactions/src/types.ts#L233">packages/transactions/src/types.ts:233</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>bufferReader: <a href="classes/bufferreader.html" class="tsd-signature-type">BufferReader</a></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="interfaces/address.html" class="tsd-signature-type">Address</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="deserializeassetinfo" class="tsd-anchor"></a>
|
|
<h3>deserialize<wbr>Asset<wbr>Info</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">deserialize<wbr>Asset<wbr>Info<span class="tsd-signature-symbol">(</span>bufferReader<span class="tsd-signature-symbol">: </span><a href="classes/bufferreader.html" class="tsd-signature-type">BufferReader</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="interfaces/assetinfo.html" class="tsd-signature-type">AssetInfo</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/transactions/src/types.ts#L445">packages/transactions/src/types.ts:445</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>bufferReader: <a href="classes/bufferreader.html" class="tsd-signature-type">BufferReader</a></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="interfaces/assetinfo.html" class="tsd-signature-type">AssetInfo</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="deserializecv" class="tsd-anchor"></a>
|
|
<h3>deserializeCV</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">deserializeCV<span class="tsd-signature-symbol">(</span>buffer<span class="tsd-signature-symbol">: </span><a href="classes/bufferreader.html" class="tsd-signature-type">BufferReader</a><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><a href="globals.html#clarityvalue" class="tsd-signature-type">ClarityValue</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/transactions/src/clarity/deserialize.ts#L23">packages/transactions/src/clarity/deserialize.ts:23</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>buffer: <a href="classes/bufferreader.html" class="tsd-signature-type">BufferReader</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Buffer</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="globals.html#clarityvalue" class="tsd-signature-type">ClarityValue</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="deserializelplist" class="tsd-anchor"></a>
|
|
<h3>deserializeLPList</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">deserializeLPList<span class="tsd-signature-symbol">(</span>bufferReader<span class="tsd-signature-symbol">: </span><a href="classes/bufferreader.html" class="tsd-signature-type">BufferReader</a>, type<span class="tsd-signature-symbol">: </span><a href="enums/stacksmessagetype.html" class="tsd-signature-type">StacksMessageType</a>, lengthPrefixBytes<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><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><a href="interfaces/lengthprefixedlist.html" class="tsd-signature-type">LengthPrefixedList</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/transactions/src/types.ts#L481">packages/transactions/src/types.ts:481</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>bufferReader: <a href="classes/bufferreader.html" class="tsd-signature-type">BufferReader</a></h5>
|
|
</li>
|
|
<li>
|
|
<h5>type: <a href="enums/stacksmessagetype.html" class="tsd-signature-type">StacksMessageType</a></h5>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> lengthPrefixBytes: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="interfaces/lengthprefixedlist.html" class="tsd-signature-type">LengthPrefixedList</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="deserializelpstring" class="tsd-anchor"></a>
|
|
<h3>deserializeLPString</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">deserializeLPString<span class="tsd-signature-symbol">(</span>bufferReader<span class="tsd-signature-symbol">: </span><a href="classes/bufferreader.html" class="tsd-signature-type">BufferReader</a>, prefixBytes<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span>, maxLength<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><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><a href="interfaces/lengthprefixedstring.html" class="tsd-signature-type">LengthPrefixedString</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/transactions/src/types.ts#L363">packages/transactions/src/types.ts:363</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>bufferReader: <a href="classes/bufferreader.html" class="tsd-signature-type">BufferReader</a></h5>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> prefixBytes: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> maxLength: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="interfaces/lengthprefixedstring.html" class="tsd-signature-type">LengthPrefixedString</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="deserializememostring" class="tsd-anchor"></a>
|
|
<h3>deserialize<wbr>Memo<wbr>String</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">deserialize<wbr>Memo<wbr>String<span class="tsd-signature-symbol">(</span>bufferReader<span class="tsd-signature-symbol">: </span><a href="classes/bufferreader.html" class="tsd-signature-type">BufferReader</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="interfaces/memostring.html" class="tsd-signature-type">MemoString</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/transactions/src/types.ts#L401">packages/transactions/src/types.ts:401</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>bufferReader: <a href="classes/bufferreader.html" class="tsd-signature-type">BufferReader</a></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="interfaces/memostring.html" class="tsd-signature-type">MemoString</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="deserializemessagesignature" class="tsd-anchor"></a>
|
|
<h3>deserialize<wbr>Message<wbr>Signature</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">deserialize<wbr>Message<wbr>Signature<span class="tsd-signature-symbol">(</span>bufferReader<span class="tsd-signature-symbol">: </span><a href="classes/bufferreader.html" class="tsd-signature-type">BufferReader</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="interfaces/messagesignature.html" class="tsd-signature-type">MessageSignature</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/transactions/src/authorization.ts#L77">packages/transactions/src/authorization.ts:77</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>bufferReader: <a href="classes/bufferreader.html" class="tsd-signature-type">BufferReader</a></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="interfaces/messagesignature.html" class="tsd-signature-type">MessageSignature</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="deserializemultisigspendingcondition" class="tsd-anchor"></a>
|
|
<h3>deserialize<wbr>Multi<wbr>Sig<wbr>Spending<wbr>Condition</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">deserialize<wbr>Multi<wbr>Sig<wbr>Spending<wbr>Condition<span class="tsd-signature-symbol">(</span>hashMode<span class="tsd-signature-symbol">: </span><a href="globals.html#multisighashmode" class="tsd-signature-type">MultiSigHashMode</a>, bufferReader<span class="tsd-signature-symbol">: </span><a href="classes/bufferreader.html" class="tsd-signature-type">BufferReader</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="interfaces/multisigspendingcondition.html" class="tsd-signature-type">MultiSigSpendingCondition</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/transactions/src/authorization.ts#L268">packages/transactions/src/authorization.ts:268</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>hashMode: <a href="globals.html#multisighashmode" class="tsd-signature-type">MultiSigHashMode</a></h5>
|
|
</li>
|
|
<li>
|
|
<h5>bufferReader: <a href="classes/bufferreader.html" class="tsd-signature-type">BufferReader</a></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="interfaces/multisigspendingcondition.html" class="tsd-signature-type">MultiSigSpendingCondition</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="deserializepayload" class="tsd-anchor"></a>
|
|
<h3>deserialize<wbr>Payload</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">deserialize<wbr>Payload<span class="tsd-signature-symbol">(</span>bufferReader<span class="tsd-signature-symbol">: </span><a href="classes/bufferreader.html" class="tsd-signature-type">BufferReader</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="enums/stacksmessagetype.html#payload" class="tsd-signature-type">Payload</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/transactions/src/payload.ts#L180">packages/transactions/src/payload.ts:180</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>bufferReader: <a href="classes/bufferreader.html" class="tsd-signature-type">BufferReader</a></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="enums/stacksmessagetype.html#payload" class="tsd-signature-type">Payload</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="deserializepostcondition" class="tsd-anchor"></a>
|
|
<h3>deserialize<wbr>Post<wbr>Condition</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">deserialize<wbr>Post<wbr>Condition<span class="tsd-signature-symbol">(</span>bufferReader<span class="tsd-signature-symbol">: </span><a href="classes/bufferreader.html" class="tsd-signature-type">BufferReader</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="enums/stacksmessagetype.html#postcondition" class="tsd-signature-type">PostCondition</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/transactions/src/postcondition.ts#L148">packages/transactions/src/postcondition.ts:148</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>bufferReader: <a href="classes/bufferreader.html" class="tsd-signature-type">BufferReader</a></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="enums/stacksmessagetype.html#postcondition" class="tsd-signature-type">PostCondition</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="deserializeprincipal" class="tsd-anchor"></a>
|
|
<h3>deserialize<wbr>Principal</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">deserialize<wbr>Principal<span class="tsd-signature-symbol">(</span>bufferReader<span class="tsd-signature-symbol">: </span><a href="classes/bufferreader.html" class="tsd-signature-type">BufferReader</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="globals.html#postconditionprincipal" class="tsd-signature-type">PostConditionPrincipal</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/transactions/src/types.ts#L305">packages/transactions/src/types.ts:305</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>bufferReader: <a href="classes/bufferreader.html" class="tsd-signature-type">BufferReader</a></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="globals.html#postconditionprincipal" class="tsd-signature-type">PostConditionPrincipal</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="deserializepublickey" class="tsd-anchor"></a>
|
|
<h3>deserialize<wbr>Public<wbr>Key</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">deserialize<wbr>Public<wbr>Key<span class="tsd-signature-symbol">(</span>bufferReader<span class="tsd-signature-symbol">: </span><a href="classes/bufferreader.html" class="tsd-signature-type">BufferReader</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="interfaces/stackspublickey.html" class="tsd-signature-type">StacksPublicKey</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/transactions/src/keys.ts#L107">packages/transactions/src/keys.ts:107</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>bufferReader: <a href="classes/bufferreader.html" class="tsd-signature-type">BufferReader</a></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="interfaces/stackspublickey.html" class="tsd-signature-type">StacksPublicKey</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="deserializesinglesigspendingcondition" class="tsd-anchor"></a>
|
|
<h3>deserialize<wbr>Single<wbr>Sig<wbr>Spending<wbr>Condition</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">deserialize<wbr>Single<wbr>Sig<wbr>Spending<wbr>Condition<span class="tsd-signature-symbol">(</span>hashMode<span class="tsd-signature-symbol">: </span><a href="globals.html#singlesighashmode" class="tsd-signature-type">SingleSigHashMode</a>, bufferReader<span class="tsd-signature-symbol">: </span><a href="classes/bufferreader.html" class="tsd-signature-type">BufferReader</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="interfaces/singlesigspendingcondition.html" class="tsd-signature-type">SingleSigSpendingCondition</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/transactions/src/authorization.ts#L245">packages/transactions/src/authorization.ts:245</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>hashMode: <a href="globals.html#singlesighashmode" class="tsd-signature-type">SingleSigHashMode</a></h5>
|
|
</li>
|
|
<li>
|
|
<h5>bufferReader: <a href="classes/bufferreader.html" class="tsd-signature-type">BufferReader</a></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="interfaces/singlesigspendingcondition.html" class="tsd-signature-type">SingleSigSpendingCondition</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="deserializespendingcondition" class="tsd-anchor"></a>
|
|
<h3>deserialize<wbr>Spending<wbr>Condition</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">deserialize<wbr>Spending<wbr>Condition<span class="tsd-signature-symbol">(</span>bufferReader<span class="tsd-signature-symbol">: </span><a href="classes/bufferreader.html" class="tsd-signature-type">BufferReader</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="globals.html#spendingcondition" class="tsd-signature-type">SpendingCondition</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/transactions/src/authorization.ts#L299">packages/transactions/src/authorization.ts:299</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>bufferReader: <a href="classes/bufferreader.html" class="tsd-signature-type">BufferReader</a></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="globals.html#spendingcondition" class="tsd-signature-type">SpendingCondition</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="deserializestacksmessage" class="tsd-anchor"></a>
|
|
<h3>deserialize<wbr>Stacks<wbr>Message</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">deserialize<wbr>Stacks<wbr>Message<span class="tsd-signature-symbol">(</span>bufferReader<span class="tsd-signature-symbol">: </span><a href="classes/bufferreader.html" class="tsd-signature-type">BufferReader</a>, type<span class="tsd-signature-symbol">: </span><a href="enums/stacksmessagetype.html" class="tsd-signature-type">StacksMessageType</a>, listType<span class="tsd-signature-symbol">?: </span><a href="enums/stacksmessagetype.html" class="tsd-signature-type">StacksMessageType</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="globals.html#stacksmessage" class="tsd-signature-type">StacksMessage</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/transactions/src/types.ts#L77">packages/transactions/src/types.ts:77</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>bufferReader: <a href="classes/bufferreader.html" class="tsd-signature-type">BufferReader</a></h5>
|
|
</li>
|
|
<li>
|
|
<h5>type: <a href="enums/stacksmessagetype.html" class="tsd-signature-type">StacksMessageType</a></h5>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> listType: <a href="enums/stacksmessagetype.html" class="tsd-signature-type">StacksMessageType</a></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="globals.html#stacksmessage" class="tsd-signature-type">StacksMessage</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="deserializetransaction" class="tsd-anchor"></a>
|
|
<h3>deserialize<wbr>Transaction</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">deserialize<wbr>Transaction<span class="tsd-signature-symbol">(</span>bufferReader<span class="tsd-signature-symbol">: </span><a href="classes/bufferreader.html" class="tsd-signature-type">BufferReader</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="classes/stackstransaction.html" class="tsd-signature-type">StacksTransaction</a></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/transactions/src/transaction.ts#L236">packages/transactions/src/transaction.ts:236</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>bufferReader: <a href="classes/bufferreader.html" class="tsd-signature-type">BufferReader</a></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="classes/stackstransaction.html" class="tsd-signature-type">StacksTransaction</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="deserializetransactionauthfield" class="tsd-anchor"></a>
|
|
<h3>deserialize<wbr>Transaction<wbr>Auth<wbr>Field</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">deserialize<wbr>Transaction<wbr>Auth<wbr>Field<span class="tsd-signature-symbol">(</span>bufferReader<span class="tsd-signature-symbol">: </span><a href="classes/bufferreader.html" class="tsd-signature-type">BufferReader</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="interfaces/transactionauthfield.html" class="tsd-signature-type">TransactionAuthField</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/transactions/src/authorization.ts#L121">packages/transactions/src/authorization.ts:121</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>bufferReader: <a href="classes/bufferreader.html" class="tsd-signature-type">BufferReader</a></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="interfaces/transactionauthfield.html" class="tsd-signature-type">TransactionAuthField</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="emptymessagesignature" class="tsd-anchor"></a>
|
|
<h3>empty<wbr>Message<wbr>Signature</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">empty<wbr>Message<wbr>Signature<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="interfaces/messagesignature.html" class="tsd-signature-type">MessageSignature</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/transactions/src/authorization.ts#L64">packages/transactions/src/authorization.ts:64</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-returns-title">Returns <a href="interfaces/messagesignature.html" class="tsd-signature-type">MessageSignature</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="encodeclarityvalue" class="tsd-anchor"></a>
|
|
<h3>encode<wbr>Clarity<wbr>Value</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">encode<wbr>Clarity<wbr>Value<span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><a href="globals.html#clarityabitype" class="tsd-signature-type">ClarityAbiType</a>, val<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="globals.html#clarityvalue" class="tsd-signature-type">ClarityValue</a></li>
|
|
<li class="tsd-signature tsd-kind-icon">encode<wbr>Clarity<wbr>Value<span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><a href="globals.html#clarityabitypeunion" class="tsd-signature-type">ClarityAbiTypeUnion</a>, val<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="globals.html#clarityvalue" class="tsd-signature-type">ClarityValue</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/transactions/src/contract-abi.ts#L140">packages/transactions/src/contract-abi.ts:140</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>type: <a href="globals.html#clarityabitype" class="tsd-signature-type">ClarityAbiType</a></h5>
|
|
</li>
|
|
<li>
|
|
<h5>val: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="globals.html#clarityvalue" class="tsd-signature-type">ClarityValue</a></h4>
|
|
</li>
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/transactions/src/contract-abi.ts#L141">packages/transactions/src/contract-abi.ts:141</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>type: <a href="globals.html#clarityabitypeunion" class="tsd-signature-type">ClarityAbiTypeUnion</a></h5>
|
|
</li>
|
|
<li>
|
|
<h5>val: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="globals.html#clarityvalue" class="tsd-signature-type">ClarityValue</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="encrypt" class="tsd-anchor"></a>
|
|
<h3>encrypt</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">encrypt<span class="tsd-signature-symbol">(</span>phrase<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/keychain/src/encryption/encrypt.ts#L9">packages/keychain/src/encryption/encrypt.ts:9</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Encrypt a raw mnemonic phrase to be password protected</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>phrase: <span class="tsd-signature-type">string</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Raw mnemonic phrase</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5>password: <span class="tsd-signature-type">string</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Password to encrypt mnemonic with</p>
|
|
</div>
|
|
</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>
|
|
<p>The encrypted phrase</p>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="encryptbackupphrase" class="tsd-anchor"></a>
|
|
<h3>encrypt<wbr>Backup<wbr>Phrase</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<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#L3">packages/cli/src/encrypt.ts:3</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">
|
|
<a name="encryptcontent" class="tsd-anchor"></a>
|
|
<h3>encrypt<wbr>Content</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">encrypt<wbr>Content<span class="tsd-signature-symbol">(</span>content<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>, options<span class="tsd-signature-symbol">?: </span><a href="interfaces/encryptcontentoptions.html" class="tsd-signature-type">EncryptContentOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</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/encryption/src/encryption.ts#L58">packages/encryption/src/encryption.ts:58</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Encrypts the data provided with the app public key.</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>content: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Buffer</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>data to encrypt</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <a href="interfaces/encryptcontentoptions.html" class="tsd-signature-type">EncryptContentOptions</a></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>
|
|
<p>Stringified ciphertext object</p>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="encryptmnemonicformatted" class="tsd-anchor"></a>
|
|
<h3>encrypt<wbr>Mnemonic<wbr>Formatted</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">encrypt<wbr>Mnemonic<wbr>Formatted<span class="tsd-signature-symbol">(</span>plaintextMnemonic<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-symbol">{ </span>encryptedMnemonic<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">; </span>encryptedMnemonicHex<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/keychain/src/mnemonic/index.ts#L41">packages/keychain/src/mnemonic/index.ts:41</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>plaintextMnemonic: <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-symbol">{ </span>encryptedMnemonic<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">; </span>encryptedMnemonicHex<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">
|
|
<a name="estimatecontractdeploy" class="tsd-anchor"></a>
|
|
<h3>estimate<wbr>Contract<wbr>Deploy</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">estimate<wbr>Contract<wbr>Deploy<span class="tsd-signature-symbol">(</span>transaction<span class="tsd-signature-symbol">: </span><a href="classes/stackstransaction.html" class="tsd-signature-type">StacksTransaction</a>, network<span class="tsd-signature-symbol">?: </span><a href="interfaces/stacksnetwork.html" class="tsd-signature-type">StacksNetwork</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">BigNum</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/transactions/src/builders.ts#L466">packages/transactions/src/builders.ts:466</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Estimate the total transaction fee in microstacks for a contract deploy</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>transaction: <a href="classes/stackstransaction.html" class="tsd-signature-type">StacksTransaction</a></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>the token transfer transaction to estimate fees for</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> network: <a href="interfaces/stacksnetwork.html" class="tsd-signature-type">StacksNetwork</a></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>the Stacks network to estimate transaction for</p>
|
|
</div>
|
|
</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">BigNum</span><span class="tsd-signature-symbol">></span></h4>
|
|
<p>a promise that resolves to number of microstacks per byte</p>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="estimatecontractfunctioncall" class="tsd-anchor"></a>
|
|
<h3>estimate<wbr>Contract<wbr>Function<wbr>Call</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">estimate<wbr>Contract<wbr>Function<wbr>Call<span class="tsd-signature-symbol">(</span>transaction<span class="tsd-signature-symbol">: </span><a href="classes/stackstransaction.html" class="tsd-signature-type">StacksTransaction</a>, network<span class="tsd-signature-symbol">?: </span><a href="interfaces/stacksnetwork.html" class="tsd-signature-type">StacksNetwork</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">BigNum</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/transactions/src/builders.ts#L655">packages/transactions/src/builders.ts:655</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Estimate the total transaction fee in microstacks for a contract function call</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>transaction: <a href="classes/stackstransaction.html" class="tsd-signature-type">StacksTransaction</a></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>the token transfer transaction to estimate fees for</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> network: <a href="interfaces/stacksnetwork.html" class="tsd-signature-type">StacksNetwork</a></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>the Stacks network to estimate transaction for</p>
|
|
</div>
|
|
</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">BigNum</span><span class="tsd-signature-symbol">></span></h4>
|
|
<p>a promise that resolves to number of microstacks per byte</p>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="estimatetransfer" class="tsd-anchor"></a>
|
|
<h3>estimate<wbr>Transfer</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">estimate<wbr>Transfer<span class="tsd-signature-symbol">(</span>transaction<span class="tsd-signature-symbol">: </span><a href="classes/stackstransaction.html" class="tsd-signature-type">StacksTransaction</a>, network<span class="tsd-signature-symbol">?: </span><a href="interfaces/stacksnetwork.html" class="tsd-signature-type">StacksNetwork</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">BigNum</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/transactions/src/builders.ts#L99">packages/transactions/src/builders.ts:99</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Estimate the total transaction fee in microstacks for a token transfer</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>transaction: <a href="classes/stackstransaction.html" class="tsd-signature-type">StacksTransaction</a></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>the token transfer transaction to estimate fees for</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> network: <a href="interfaces/stacksnetwork.html" class="tsd-signature-type">StacksNetwork</a></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>the Stacks network to estimate transaction for</p>
|
|
</div>
|
|
</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">BigNum</span><span class="tsd-signature-symbol">></span></h4>
|
|
<p>a promise that resolves to number of microstacks per byte</p>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="exceedsmaxlengthbytes" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> exceeds<wbr>Max<wbr>Length<wbr>Bytes</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">exceeds<wbr>Max<wbr>Length<wbr>Bytes<span class="tsd-signature-symbol">(</span>string<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, maxLengthBytes<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">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/transactions/src/utils.ts#L50">packages/transactions/src/utils.ts:50</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>string: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>maxLengthBytes: <span class="tsd-signature-type">number</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">
|
|
<a name="extractappkey" class="tsd-anchor"></a>
|
|
<h3>extract<wbr>App<wbr>Key</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<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/clinetworkadapter.html" class="tsd-signature-type">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">undefined</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">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#L263">packages/cli/src/keys.ts:263</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>network: <a href="classes/clinetworkadapter.html" class="tsd-signature-type">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">undefined</span><span class="tsd-signature-symbol"> | </span><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">
|
|
<a name="extractprofile" class="tsd-anchor"></a>
|
|
<h3>extract<wbr>Profile</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">extract<wbr>Profile<span class="tsd-signature-symbol">(</span>token<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, publicKeyOrAddress<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><span class="tsd-signature-type">Record</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">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/profile/src/profileTokens.ts#L147">packages/profile/src/profileTokens.ts:147</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Extracts a profile from an encoded token and optionally verifies it,
|
|
if <code>publicKeyOrAddress</code> is provided.</p>
|
|
</div>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>throws</dt>
|
|
<dd><p>{Error} - if the token isn't signed by the provided <code>publicKeyOrAddress</code></p>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>token: <span class="tsd-signature-type">string</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>the token to be extracted</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> publicKeyOrAddress: <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"> = null</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>the public key or address of the
|
|
keypair that is thought to have signed the token</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Record</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">any</span><span class="tsd-signature-symbol">></span></h4>
|
|
<ul>
|
|
<li>the profile extracted from the encoded token</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="falsecv" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> falseCV</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">falseCV<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="globals.html#booleancv" class="tsd-signature-type">BooleanCV</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/transactions/src/clarity/types/booleanCV.ts#L14">packages/transactions/src/clarity/types/booleanCV.ts:14</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-returns-title">Returns <a href="globals.html#booleancv" class="tsd-signature-type">BooleanCV</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="faucetcall" class="tsd-anchor"></a>
|
|
<h3>faucet<wbr>Call</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">faucet<wbr>Call<span class="tsd-signature-symbol">(</span>_<span class="tsd-signature-symbol">: </span><a href="classes/clinetworkadapter.html" class="tsd-signature-type">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></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#L1645">packages/cli/src/cli.ts:1645</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>_: <a href="classes/clinetworkadapter.html" class="tsd-signature-type">CLINetworkAdapter</a></h5>
|
|
</li>
|
|
<li>
|
|
<h5>args: <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-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">
|
|
<a name="fetchprofile" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> fetch<wbr>Profile</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">fetch<wbr>Profile<span class="tsd-signature-symbol">(</span>__namedParameters<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>gaiaUrl<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>identity<span class="tsd-signature-symbol">: </span><a href="classes/identity.html" class="tsd-signature-type">Identity</a><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">null</span><span class="tsd-signature-symbol"> | </span><a href="classes/profile.html" class="tsd-signature-type">Profile</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/keychain/src/profiles.ts#L177">packages/keychain/src/profiles.ts:177</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>__namedParameters: <span class="tsd-signature-symbol">{ </span>gaiaUrl<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>identity<span class="tsd-signature-symbol">: </span><a href="classes/identity.html" class="tsd-signature-type">Identity</a><span class="tsd-signature-symbol"> }</span></h5>
|
|
<ul class="tsd-parameters">
|
|
<li class="tsd-parameter">
|
|
<h5>gaia<wbr>Url<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li class="tsd-parameter">
|
|
<h5>identity<span class="tsd-signature-symbol">: </span><a href="classes/identity.html" class="tsd-signature-type">Identity</a></h5>
|
|
</li>
|
|
</ul>
|
|
</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">null</span><span class="tsd-signature-symbol"> | </span><a href="classes/profile.html" class="tsd-signature-type">Profile</a><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="findidentityindex" class="tsd-anchor"></a>
|
|
<h3>find<wbr>Identity<wbr>Index</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<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/clinetworkadapter.html" class="tsd-signature-type">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">undefined</span><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#L173">packages/cli/src/keys.ts:173</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>network: <a href="classes/clinetworkadapter.html" class="tsd-signature-type">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">undefined</span><span class="tsd-signature-symbol"> | </span><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">
|
|
<a name="formatcommandhelplines" class="tsd-anchor"></a>
|
|
<h3>format<wbr>Command<wbr>Help<wbr>Lines</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">format<wbr>Command<wbr>Help<wbr>Lines<span class="tsd-signature-symbol">(</span>commandName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, commandArgs<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><a href="interfaces/cli_prop_item.html" class="tsd-signature-type">CLI_PROP_ITEM</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="interfaces/cli_command_help.html" class="tsd-signature-type">CLI_COMMAND_HELP</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#L2847">packages/cli/src/argparse.ts:2847</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>commandName: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>commandArgs: <span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><a href="interfaces/cli_prop_item.html" class="tsd-signature-type">CLI_PROP_ITEM</a><span class="tsd-signature-symbol">></span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="interfaces/cli_command_help.html" class="tsd-signature-type">CLI_COMMAND_HELP</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="formathelpstring" class="tsd-anchor"></a>
|
|
<h3>format<wbr>Help<wbr>String</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">format<wbr>Help<wbr>String<span class="tsd-signature-symbol">(</span>indent<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, limit<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, helpString<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#L2791">packages/cli/src/argparse.ts:2791</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>indent: <span class="tsd-signature-type">number</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>limit: <span class="tsd-signature-type">number</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>helpString: <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">
|
|
<a name="gaiaauth" class="tsd-anchor"></a>
|
|
<h3>gaia<wbr>Auth</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<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/clinetworkadapter.html" class="tsd-signature-type">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">undefined</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">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/clinetworkadapter.html" class="tsd-signature-type">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">undefined</span><span class="tsd-signature-symbol"> | </span><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">
|
|
<a name="gaiaconnect" class="tsd-anchor"></a>
|
|
<h3>gaia<wbr>Connect</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<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/clinetworkadapter.html" class="tsd-signature-type">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">undefined</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">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/clinetworkadapter.html" class="tsd-signature-type">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">undefined</span><span class="tsd-signature-symbol"> | </span><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">
|
|
<a name="gaiadeletefile" class="tsd-anchor"></a>
|
|
<h3>gaia<wbr>Delete<wbr>File</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">gaia<wbr>Delete<wbr>File<span class="tsd-signature-symbol">(</span>network<span class="tsd-signature-symbol">: </span><a href="classes/clinetworkadapter.html" class="tsd-signature-type">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></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#L935">packages/cli/src/cli.ts:935</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>network: <a href="classes/clinetworkadapter.html" class="tsd-signature-type">CLINetworkAdapter</a></h5>
|
|
</li>
|
|
<li>
|
|
<h5>args: <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-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">
|
|
<a name="gaiadumpbucket" class="tsd-anchor"></a>
|
|
<h3>gaia<wbr>Dump<wbr>Bucket</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">gaia<wbr>Dump<wbr>Bucket<span class="tsd-signature-symbol">(</span>network<span class="tsd-signature-symbol">: </span><a href="classes/clinetworkadapter.html" class="tsd-signature-type">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></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#L1012">packages/cli/src/cli.ts:1012</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>network: <a href="classes/clinetworkadapter.html" class="tsd-signature-type">CLINetworkAdapter</a></h5>
|
|
</li>
|
|
<li>
|
|
<h5>args: <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-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">
|
|
<a name="gaiafindprofilename" class="tsd-anchor"></a>
|
|
<h3>gaia<wbr>Find<wbr>Profile<wbr>Name</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">gaia<wbr>Find<wbr>Profile<wbr>Name<span class="tsd-signature-symbol">(</span>network<span class="tsd-signature-symbol">: </span><a href="classes/clinetworkadapter.html" class="tsd-signature-type">CLINetworkAdapter</a>, hubConfig<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">GaiaHubConfig</span>, blockstackID<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</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">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#L159">packages/cli/src/data.ts:159</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>network: <a href="classes/clinetworkadapter.html" class="tsd-signature-type">CLINetworkAdapter</a></h5>
|
|
</li>
|
|
<li>
|
|
<h5>hubConfig: <span class="tsd-signature-type">GaiaHubConfig</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> blockstackID: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><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">
|
|
<a name="gaiagetfile" class="tsd-anchor"></a>
|
|
<h3>gaia<wbr>Get<wbr>File</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">gaia<wbr>Get<wbr>File<span class="tsd-signature-symbol">(</span>network<span class="tsd-signature-symbol">: </span><a href="classes/clinetworkadapter.html" class="tsd-signature-type">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-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/cli.ts#L846">packages/cli/src/cli.ts:846</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>network: <a href="classes/clinetworkadapter.html" class="tsd-signature-type">CLINetworkAdapter</a></h5>
|
|
</li>
|
|
<li>
|
|
<h5>args: <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-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-type">Buffer</span><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="gaialistfiles" class="tsd-anchor"></a>
|
|
<h3>gaia<wbr>List<wbr>Files</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">gaia<wbr>List<wbr>Files<span class="tsd-signature-symbol">(</span>network<span class="tsd-signature-symbol">: </span><a href="classes/clinetworkadapter.html" class="tsd-signature-type">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></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#L964">packages/cli/src/cli.ts:964</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>network: <a href="classes/clinetworkadapter.html" class="tsd-signature-type">CLINetworkAdapter</a></h5>
|
|
</li>
|
|
<li>
|
|
<h5>args: <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-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">
|
|
<a name="gaiaputfile" class="tsd-anchor"></a>
|
|
<h3>gaia<wbr>Put<wbr>File</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">gaia<wbr>Put<wbr>File<span class="tsd-signature-symbol">(</span>network<span class="tsd-signature-symbol">: </span><a href="classes/clinetworkadapter.html" class="tsd-signature-type">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></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#L897">packages/cli/src/cli.ts:897</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>network: <a href="classes/clinetworkadapter.html" class="tsd-signature-type">CLINetworkAdapter</a></h5>
|
|
</li>
|
|
<li>
|
|
<h5>args: <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-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">
|
|
<a name="gaiarestorebucket" class="tsd-anchor"></a>
|
|
<h3>gaia<wbr>Restore<wbr>Bucket</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">gaia<wbr>Restore<wbr>Bucket<span class="tsd-signature-symbol">(</span>network<span class="tsd-signature-symbol">: </span><a href="classes/clinetworkadapter.html" class="tsd-signature-type">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></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#L1114">packages/cli/src/cli.ts:1114</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>network: <a href="classes/clinetworkadapter.html" class="tsd-signature-type">CLINetworkAdapter</a></h5>
|
|
</li>
|
|
<li>
|
|
<h5>args: <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-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">
|
|
<a name="gaiasethub" class="tsd-anchor"></a>
|
|
<h3>gaia<wbr>Set<wbr>Hub</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">gaia<wbr>Set<wbr>Hub<span class="tsd-signature-symbol">(</span>network<span class="tsd-signature-symbol">: </span><a href="classes/clinetworkadapter.html" class="tsd-signature-type">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></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#L1175">packages/cli/src/cli.ts:1175</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>network: <a href="classes/clinetworkadapter.html" class="tsd-signature-type">CLINetworkAdapter</a></h5>
|
|
</li>
|
|
<li>
|
|
<h5>args: <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-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">
|
|
<a name="gaiauploadprofile" class="tsd-anchor"></a>
|
|
<h3>gaia<wbr>Upload<wbr>Profile</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<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/clinetworkadapter.html" class="tsd-signature-type">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">undefined</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">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/clinetworkadapter.html" class="tsd-signature-type">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">undefined</span><span class="tsd-signature-symbol"> | </span><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">
|
|
<a name="gaiauploadprofileall" class="tsd-anchor"></a>
|
|
<h3>gaia<wbr>Upload<wbr>Profile<wbr>All</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<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/clinetworkadapter.html" class="tsd-signature-type">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">undefined</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">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/clinetworkadapter.html" class="tsd-signature-type">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">undefined</span><span class="tsd-signature-symbol"> | </span><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">
|
|
<a name="generateencryptedmnemonicrootkeychain" class="tsd-anchor"></a>
|
|
<h3>generate<wbr>Encrypted<wbr>Mnemonic<wbr>Root<wbr>Keychain</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">generate<wbr>Encrypted<wbr>Mnemonic<wbr>Root<wbr>Keychain<span class="tsd-signature-symbol">(</span>password<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, entropy<span class="tsd-signature-symbol">: </span><a href="globals.html#allowedkeyentropybits" class="tsd-signature-type">AllowedKeyEntropyBits</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>encryptedMnemonicPhrase<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>rootNode<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BIP32Interface</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/keychain/src/mnemonic/index.ts#L20">packages/keychain/src/mnemonic/index.ts:20</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>password: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>entropy: <a href="globals.html#allowedkeyentropybits" class="tsd-signature-type">AllowedKeyEntropyBits</a></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>encryptedMnemonicPhrase<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>rootNode<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BIP32Interface</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">
|
|
<a name="generateexplorertxpageurl" class="tsd-anchor"></a>
|
|
<h3>generate<wbr>Explorer<wbr>TxPage<wbr>Url</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<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#L893">packages/cli/src/utils.ts:893</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">
|
|
<a name="generatemnemonicrootkeychain" class="tsd-anchor"></a>
|
|
<h3>generate<wbr>Mnemonic<wbr>Root<wbr>Keychain</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">generate<wbr>Mnemonic<wbr>Root<wbr>Keychain<span class="tsd-signature-symbol">(</span>entropy<span class="tsd-signature-symbol">: </span><a href="globals.html#allowedkeyentropybits" class="tsd-signature-type">AllowedKeyEntropyBits</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>plaintextMnemonic<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>rootNode<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BIP32Interface</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/keychain/src/mnemonic/index.ts#L10">packages/keychain/src/mnemonic/index.ts:10</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>entropy: <a href="globals.html#allowedkeyentropybits" class="tsd-signature-type">AllowedKeyEntropyBits</a></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>plaintextMnemonic<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>rootNode<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BIP32Interface</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">
|
|
<a name="getapiusageerrormessage" class="tsd-anchor"></a>
|
|
<h3>getAPIUsage<wbr>Error<wbr>Message</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">getAPIUsage<wbr>Error<wbr>Message<span class="tsd-signature-symbol">(</span>scopeObject<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">unknown</span>, apiName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, usageDesc<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</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">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/common/src/utils.ts#L216">packages/common/src/utils.ts:216</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>scopeObject: <span class="tsd-signature-type">unknown</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>apiName: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> usageDesc: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><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">
|
|
<a name="getabi" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Abi</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">get<wbr>Abi<span class="tsd-signature-symbol">(</span>address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, contractName<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">Promise</span><span class="tsd-signature-symbol"><</span><a href="interfaces/clarityabi.html" class="tsd-signature-type">ClarityAbi</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/transactions/src/builders.ts#L216">packages/transactions/src/builders.ts:216</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Fetch a contract's ABI</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>address: <span class="tsd-signature-type">string</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>the contracts address</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5>contractName: <span class="tsd-signature-type">string</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>the contracts name</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5>network: <span class="tsd-signature-type">StacksNetwork</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>the Stacks network to broadcast transaction to</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="interfaces/clarityabi.html" class="tsd-signature-type">ClarityAbi</a><span class="tsd-signature-symbol">></span></h4>
|
|
<p>that resolves to a ClarityAbi if the operation succeeds</p>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="getaccounthistory" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Account<wbr>History</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">get<wbr>Account<wbr>History<span class="tsd-signature-symbol">(</span>network<span class="tsd-signature-symbol">: </span><a href="classes/clinetworkadapter.html" class="tsd-signature-type">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></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#L397">packages/cli/src/cli.ts:397</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>network: <a href="classes/clinetworkadapter.html" class="tsd-signature-type">CLINetworkAdapter</a></h5>
|
|
</li>
|
|
<li>
|
|
<h5>args: <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-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">
|
|
<a name="getaddressfromprivatekey" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Address<wbr>From<wbr>Private<wbr>Key</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">get<wbr>Address<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-type">Buffer</span>, transactionVersion<span class="tsd-signature-symbol">?: </span><a href="enums/transactionversion.html" class="tsd-signature-type">TransactionVersion</a><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/transactions/src/keys.ts#L33">packages/transactions/src/keys.ts:33</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Creates a P2PKH address string from the given private key and tx version.</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>privateKey: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Buffer</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> transactionVersion: <a href="enums/transactionversion.html" class="tsd-signature-type">TransactionVersion</a><span class="tsd-signature-symbol"> = TransactionVersion.Mainnet</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">
|
|
<a name="getaddressfrompublickey" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Address<wbr>From<wbr>Public<wbr>Key</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">get<wbr>Address<wbr>From<wbr>Public<wbr>Key<span class="tsd-signature-symbol">(</span>publicKey<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>, transactionVersion<span class="tsd-signature-symbol">?: </span><a href="enums/transactionversion.html" class="tsd-signature-type">TransactionVersion</a><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/transactions/src/keys.ts#L43">packages/transactions/src/keys.ts:43</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Creates a P2PKH address string from the given public key and tx version.</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>publicKey: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Buffer</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> transactionVersion: <a href="enums/transactionversion.html" class="tsd-signature-type">TransactionVersion</a><span class="tsd-signature-symbol"> = TransactionVersion.Mainnet</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">
|
|
<a name="getaddresshashmode" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Address<wbr>Hash<wbr>Mode</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">get<wbr>Address<wbr>Hash<wbr>Mode<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><span class="tsd-signature-symbol">: </span><a href="enums/addresshashmode.html#serializep2pkh" class="tsd-signature-type">SerializeP2PKH</a><span class="tsd-signature-symbol"> | </span><a href="enums/addresshashmode.html#serializep2sh" class="tsd-signature-type">SerializeP2SH</a><span class="tsd-signature-symbol"> | </span><a href="enums/addresshashmode.html#serializep2wpkh" class="tsd-signature-type">SerializeP2WPKH</a><span class="tsd-signature-symbol"> | </span><a href="enums/addresshashmode.html#serializep2wsh" class="tsd-signature-type">SerializeP2WSH</a></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/stacking/src/utils.ts#L6">packages/stacking/src/utils.ts:6</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>btcAddress: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="enums/addresshashmode.html#serializep2pkh" class="tsd-signature-type">SerializeP2PKH</a><span class="tsd-signature-symbol"> | </span><a href="enums/addresshashmode.html#serializep2sh" class="tsd-signature-type">SerializeP2SH</a><span class="tsd-signature-symbol"> | </span><a href="enums/addresshashmode.html#serializep2wpkh" class="tsd-signature-type">SerializeP2WPKH</a><span class="tsd-signature-symbol"> | </span><a href="enums/addresshashmode.html#serializep2wsh" class="tsd-signature-type">SerializeP2WSH</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="getappkeys" class="tsd-anchor"></a>
|
|
<h3>get<wbr>App<wbr>Keys</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">get<wbr>App<wbr>Keys<span class="tsd-signature-symbol">(</span>network<span class="tsd-signature-symbol">: </span><a href="classes/clinetworkadapter.html" class="tsd-signature-type">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></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#L268">packages/cli/src/cli.ts:268</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>network: <a href="classes/clinetworkadapter.html" class="tsd-signature-type">CLINetworkAdapter</a></h5>
|
|
</li>
|
|
<li>
|
|
<h5>args: <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-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">
|
|
<a name="getappprivatekey" class="tsd-anchor"></a>
|
|
<h3>get<wbr>App<wbr>Private<wbr>Key</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">get<wbr>App<wbr>Private<wbr>Key<span class="tsd-signature-symbol">(</span>network<span class="tsd-signature-symbol">: </span><a href="classes/clinetworkadapter.html" class="tsd-signature-type">CLINetworkAdapter</a>, mnemonic<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, id<span class="tsd-signature-symbol">: </span><a href="interfaces/namedidentitytype.html" class="tsd-signature-type">NamedIdentityType</a>, 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">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/auth.ts#L96">packages/cli/src/auth.ts:96</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>network: <a href="classes/clinetworkadapter.html" class="tsd-signature-type">CLINetworkAdapter</a></h5>
|
|
</li>
|
|
<li>
|
|
<h5>mnemonic: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>id: <a href="interfaces/namedidentitytype.html" class="tsd-signature-type">NamedIdentityType</a></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">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">
|
|
<a name="getapplicationkeyinfo" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Application<wbr>Key<wbr>Info</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<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/clinetworkadapter.html" class="tsd-signature-type">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">undefined</span><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="globals.html#appkeyinfotype" class="tsd-signature-type">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#L215">packages/cli/src/keys.ts:215</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>network: <a href="classes/clinetworkadapter.html" class="tsd-signature-type">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">undefined</span><span class="tsd-signature-symbol"> | </span><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="globals.html#appkeyinfotype" class="tsd-signature-type">AppKeyInfoType</a><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="getbtcaddress" class="tsd-anchor"></a>
|
|
<h3>getBTCAddress</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">getBTCAddress<span class="tsd-signature-symbol">(</span>version<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span>, checksum<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">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/stacking/src/utils.ts#L48">packages/stacking/src/utils.ts:48</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>version: <span class="tsd-signature-type">Buffer</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>checksum: <span class="tsd-signature-type">Buffer</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">
|
|
<a name="getbackupphrase" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Backup<wbr>Phrase</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<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">undefined</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">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#L656">packages/cli/src/utils.ts:656</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">undefined</span><span class="tsd-signature-symbol"> | </span><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">
|
|
<a name="getbase64outputlength" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Base64<wbr>Output<wbr>Length</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">get<wbr>Base64<wbr>Output<wbr>Length<span class="tsd-signature-symbol">(</span>inputByteLength<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">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/common/src/utils.ts#L63">packages/common/src/utils.ts:63</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Calculate the base64 encoded string length for a given input length.
|
|
This is equivalent to the byte length when the string is ASCII or UTF8-8
|
|
encoded.</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>inputByteLength: <span class="tsd-signature-type">number</span></h5>
|
|
</li>
|
|
</ul>
|
|
<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">
|
|
<a name="getbitcoinaddressnode" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Bitcoin<wbr>Address<wbr>Node</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">get<wbr>Bitcoin<wbr>Address<wbr>Node<span class="tsd-signature-symbol">(</span>bitcoinKeychain<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BIP32Interface</span>, addressIndex<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, chainType<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">BIP32Interface</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/keychain/src/utils/index.ts#L30">packages/keychain/src/utils/index.ts:30</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>bitcoinKeychain: <span class="tsd-signature-type">BIP32Interface</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> addressIndex: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 0</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> chainType: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = EXTERNAL_ADDRESS</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">BIP32Interface</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="getbitcoinprivatekeychain" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Bitcoin<wbr>Private<wbr>Keychain</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">get<wbr>Bitcoin<wbr>Private<wbr>Keychain<span class="tsd-signature-symbol">(</span>rootNode<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BIP32Interface</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BIP32Interface</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/keychain/src/utils/index.ts#L19">packages/keychain/src/utils/index.ts:19</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>rootNode: <span class="tsd-signature-type">BIP32Interface</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">BIP32Interface</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="getblockchainidentities" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Blockchain<wbr>Identities</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">get<wbr>Blockchain<wbr>Identities<span class="tsd-signature-symbol">(</span>rootNode<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BIP32Interface</span>, identitiesToGenerate<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-symbol">{ </span>bitcoinPublicKeychain<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>firstBitcoinAddress<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>identities<span class="tsd-signature-symbol">: </span><a href="classes/identity.html" class="tsd-signature-type">Identity</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>identityAddresses<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>identityKeypairs<span class="tsd-signature-symbol">: </span><a href="interfaces/identitykeypair.html" class="tsd-signature-type">IdentityKeyPair</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>identityPublicKeychain<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/keychain/src/utils/index.ts#L97">packages/keychain/src/utils/index.ts:97</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>rootNode: <span class="tsd-signature-type">BIP32Interface</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>identitiesToGenerate: <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-symbol">{ </span>bitcoinPublicKeychain<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>firstBitcoinAddress<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>identities<span class="tsd-signature-symbol">: </span><a href="classes/identity.html" class="tsd-signature-type">Identity</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>identityAddresses<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>identityKeypairs<span class="tsd-signature-symbol">: </span><a href="interfaces/identitykeypair.html" class="tsd-signature-type">IdentityKeyPair</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>identityPublicKeychain<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">
|
|
<a name="getblockstackerrorfromresponse" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Blockstack<wbr>Error<wbr>From<wbr>Response</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">get<wbr>Blockstack<wbr>Error<wbr>From<wbr>Response<span class="tsd-signature-symbol">(</span>response<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Response</span>, errorMsg<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, hubConfig<span class="tsd-signature-symbol">: </span><a href="interfaces/gaiahubconfig.html" class="tsd-signature-type">GaiaHubConfig</a><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><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="classes/safetyerror.html#error" class="tsd-signature-type">Error</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/storage/src/hub.ts#L276">packages/storage/src/hub.ts:276</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Returns a BlockstackError correlating to the given HTTP response,
|
|
with the provided errorMsg. Throws if the HTTP response is 'ok'.</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>response: <span class="tsd-signature-type">Response</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>errorMsg: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>hubConfig: <a href="interfaces/gaiahubconfig.html" class="tsd-signature-type">GaiaHubConfig</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</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="classes/safetyerror.html#error" class="tsd-signature-type">Error</a><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="getcliopts" class="tsd-anchor"></a>
|
|
<h3>getCLIOpts</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<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><a href="interfaces/cli_opts.html" class="tsd-signature-type">CLI_OPTS</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#L3067">packages/cli/src/argparse.ts:3067</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><span class="tsd-flag ts-flagDefault value">Default value</span> 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 <a href="interfaces/cli_opts.html" class="tsd-signature-type">CLI_OPTS</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="getcvtypestring" class="tsd-anchor"></a>
|
|
<h3>getCVType<wbr>String</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">getCVType<wbr>String<span class="tsd-signature-symbol">(</span>val<span class="tsd-signature-symbol">: </span><a href="globals.html#clarityvalue" class="tsd-signature-type">ClarityValue</a><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/transactions/src/clarity/clarityValue.ts#L148">packages/transactions/src/clarity/clarityValue.ts:148</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>val: <a href="globals.html#clarityvalue" class="tsd-signature-type">ClarityValue</a></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">
|
|
<a name="getcommandargs" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Command<wbr>Args</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<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">Array</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><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>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#L3167">packages/cli/src/argparse.ts:3167</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">Array</span><span class="tsd-signature-symbol"><</span><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>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>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">
|
|
<a name="getcommandgroups" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Command<wbr>Groups</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">get<wbr>Command<wbr>Groups<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="interfaces/cli_command_group.html" class="tsd-signature-type">CLI_COMMAND_GROUP</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#L2905">packages/cli/src/argparse.ts:2905</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-returns-title">Returns <a href="interfaces/cli_command_group.html" class="tsd-signature-type">CLI_COMMAND_GROUP</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="getcryptolib" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Crypto<wbr>Lib</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">get<wbr>Crypto<wbr>Lib<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><a href="interfaces/webcryptolib.html" class="tsd-signature-type">WebCryptoLib</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/nodecryptolib.html" class="tsd-signature-type">NodeCryptoLib</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/encryption/src/cryptoUtils.ts#L51">packages/encryption/src/cryptoUtils.ts:51</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="interfaces/webcryptolib.html" class="tsd-signature-type">WebCryptoLib</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/nodecryptolib.html" class="tsd-signature-type">NodeCryptoLib</a><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="getderivationpath" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Derivation<wbr>Path</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">get<wbr>Derivation<wbr>Path<span class="tsd-signature-symbol">(</span>chain<span class="tsd-signature-symbol">: </span><a href="enums/chainid.html" class="tsd-signature-type">ChainID</a><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/keychain/src/address-derivation/index.ts#L12">packages/keychain/src/address-derivation/index.ts:12</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>chain: <a href="enums/chainid.html" class="tsd-signature-type">ChainID</a></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">
|
|
<a name="geterrorstring" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Error<wbr>String</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">get<wbr>Error<wbr>String<span class="tsd-signature-symbol">(</span>error<span class="tsd-signature-symbol">: </span><a href="enums/stackingerrors.html" class="tsd-signature-type">StackingErrors</a><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/stacking/src/utils.ts#L53">packages/stacking/src/utils.ts:53</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>error: <a href="enums/stackingerrors.html" class="tsd-signature-type">StackingErrors</a></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">
|
|
<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">
|
|
<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/clinetworkadapter.html" class="tsd-signature-type">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/clinetworkadapter.html" class="tsd-signature-type">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">
|
|
<a name="getgaiaaddressfromurl" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Gaia<wbr>Address<wbr>FromURL</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<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">
|
|
<a name="getgaiaerrorresponse" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Gaia<wbr>Error<wbr>Response</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">get<wbr>Gaia<wbr>Error<wbr>Response<span class="tsd-signature-symbol">(</span>response<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">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">GaiaHubErrorResponse</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/storage/src/hub.ts#L253">packages/storage/src/hub.ts:253</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>response: <span class="tsd-signature-type">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">GaiaHubErrorResponse</span><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="gethubinfo" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> get<wbr>Hub<wbr>Info</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">get<wbr>Hub<wbr>Info<span class="tsd-signature-symbol">(</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-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="interfaces/hubinfo.html" class="tsd-signature-type">HubInfo</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/keychain/src/utils/gaia.ts#L13">packages/keychain/src/utils/gaia.ts:13</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>hubUrl: <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/hubinfo.html" class="tsd-signature-type">HubInfo</a><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="gethubprefix" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> get<wbr>Hub<wbr>Prefix</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">get<wbr>Hub<wbr>Prefix<span class="tsd-signature-symbol">(</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-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/keychain/src/utils/gaia.ts#L19">packages/keychain/src/utils/gaia.ts:19</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>hubUrl: <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">
|
|
<a name="getidaddress" class="tsd-anchor"></a>
|
|
<h3>getIDAddress</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">getIDAddress<span class="tsd-signature-symbol">(</span>network<span class="tsd-signature-symbol">: </span><a href="classes/clinetworkadapter.html" class="tsd-signature-type">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#L715">packages/cli/src/utils.ts:715</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>network: <a href="classes/clinetworkadapter.html" class="tsd-signature-type">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">
|
|
<a name="getidappkeys" class="tsd-anchor"></a>
|
|
<h3>getIDApp<wbr>Keys</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<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/clinetworkadapter.html" class="tsd-signature-type">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/idappkeys.html" class="tsd-signature-type">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#L758">packages/cli/src/utils.ts:758</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>network: <a href="classes/clinetworkadapter.html" class="tsd-signature-type">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/idappkeys.html" class="tsd-signature-type">IDAppKeys</a><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="getidentityinfo" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Identity<wbr>Info</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">get<wbr>Identity<wbr>Info<span class="tsd-signature-symbol">(</span>network<span class="tsd-signature-symbol">: </span><a href="classes/clinetworkadapter.html" class="tsd-signature-type">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><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/namedidentitytype.html" class="tsd-signature-type">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#L304">packages/cli/src/auth.ts:304</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>network: <a href="classes/clinetworkadapter.html" class="tsd-signature-type">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>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="interfaces/namedidentitytype.html" class="tsd-signature-type">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">
|
|
<a name="getidentityowneraddressnode" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Identity<wbr>Owner<wbr>Address<wbr>Node</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">get<wbr>Identity<wbr>Owner<wbr>Address<wbr>Node<span class="tsd-signature-symbol">(</span>identityPrivateKeychain<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BIP32Interface</span>, identityIndex<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="classes/identityaddressownernode.html" class="tsd-signature-type">IdentityAddressOwnerNode</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/keychain/src/utils/index.ts#L48">packages/keychain/src/utils/index.ts:48</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>identityPrivateKeychain: <span class="tsd-signature-type">BIP32Interface</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> identityIndex: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 0</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="classes/identityaddressownernode.html" class="tsd-signature-type">IdentityAddressOwnerNode</a><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="getidentityprivatekeychain" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Identity<wbr>Private<wbr>Keychain</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">get<wbr>Identity<wbr>Private<wbr>Keychain<span class="tsd-signature-symbol">(</span>rootNode<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BIP32Interface</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BIP32Interface</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/keychain/src/utils/index.ts#L12">packages/keychain/src/utils/index.ts:12</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>rootNode: <span class="tsd-signature-type">BIP32Interface</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">BIP32Interface</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="getkeyaddress" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Key<wbr>Address</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">get<wbr>Key<wbr>Address<span class="tsd-signature-symbol">(</span>network<span class="tsd-signature-symbol">: </span><a href="classes/clinetworkadapter.html" class="tsd-signature-type">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></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#L824">packages/cli/src/cli.ts:824</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>network: <a href="classes/clinetworkadapter.html" class="tsd-signature-type">CLINetworkAdapter</a></h5>
|
|
</li>
|
|
<li>
|
|
<h5>args: <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-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">
|
|
<a name="getmaxidsearchindex" class="tsd-anchor"></a>
|
|
<h3>get<wbr>MaxIDSearch<wbr>Index</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<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#L123">packages/cli/src/cli.ts:123</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">
|
|
<a name="getname" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Name</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">get<wbr>Name<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><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</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/profile/src/profileSchemas/personUtils.ts#L1">packages/profile/src/profileSchemas/personUtils.ts:1</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>profile: <span class="tsd-signature-type">any</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="getnameinfoeasy" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Name<wbr>Info<wbr>Easy</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<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/clinetworkadapter.html" class="tsd-signature-type">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="globals.html#nameinfotype" class="tsd-signature-type">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#L552">packages/cli/src/utils.ts:552</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>network: <a href="classes/clinetworkadapter.html" class="tsd-signature-type">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="globals.html#nameinfotype" class="tsd-signature-type">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">
|
|
<a name="getnetwork" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Network</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<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_config_type.html" class="tsd-signature-type">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#L332">packages/cli/src/network.ts:332</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>configData: <a href="interfaces/cli_config_type.html" class="tsd-signature-type">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">
|
|
<a name="getnodeprivatekey" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Node<wbr>Private<wbr>Key</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">get<wbr>Node<wbr>Private<wbr>Key<span class="tsd-signature-symbol">(</span>node<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BIP32Interface</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#L63">packages/cli/src/keys.ts:63</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>node: <span class="tsd-signature-type">BIP32Interface</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">
|
|
<a name="getnonce" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Nonce</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">get<wbr>Nonce<span class="tsd-signature-symbol">(</span>address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, network<span class="tsd-signature-symbol">?: </span><a href="interfaces/stacksnetwork.html" class="tsd-signature-type">StacksNetwork</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">BigNum</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/transactions/src/builders.ts#L71">packages/transactions/src/builders.ts:71</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Lookup the nonce for an address from a core node</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>address: <span class="tsd-signature-type">string</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>the c32check address to look up</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> network: <a href="interfaces/stacksnetwork.html" class="tsd-signature-type">StacksNetwork</a></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>the Stacks network to look up address on</p>
|
|
</div>
|
|
</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">BigNum</span><span class="tsd-signature-symbol">></span></h4>
|
|
<p>a promise that resolves to an integer</p>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="getownerkeyfromidaddress" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Owner<wbr>Key<wbr>FromIDAddress</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<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/clinetworkadapter.html" class="tsd-signature-type">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#L732">packages/cli/src/utils.ts:732</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>network: <a href="classes/clinetworkadapter.html" class="tsd-signature-type">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">
|
|
<a name="getownerkeyinfo" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Owner<wbr>Key<wbr>Info</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<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/clinetworkadapter.html" class="tsd-signature-type">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="globals.html#ownerkeyinfotype" class="tsd-signature-type">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#L79">packages/cli/src/keys.ts:79</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>network: <a href="classes/clinetworkadapter.html" class="tsd-signature-type">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><span class="tsd-flag ts-flagDefault value">Default value</span> 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="globals.html#ownerkeyinfotype" class="tsd-signature-type">OwnerKeyInfoType</a><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="getownerkeys" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Owner<wbr>Keys</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">get<wbr>Owner<wbr>Keys<span class="tsd-signature-symbol">(</span>network<span class="tsd-signature-symbol">: </span><a href="classes/clinetworkadapter.html" class="tsd-signature-type">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></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#L283">packages/cli/src/cli.ts:283</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>network: <a href="classes/clinetworkadapter.html" class="tsd-signature-type">CLINetworkAdapter</a></h5>
|
|
</li>
|
|
<li>
|
|
<h5>args: <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-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">
|
|
<a name="getpaymentkey" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Payment<wbr>Key</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">get<wbr>Payment<wbr>Key<span class="tsd-signature-symbol">(</span>network<span class="tsd-signature-symbol">: </span><a href="classes/clinetworkadapter.html" class="tsd-signature-type">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></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#L303">packages/cli/src/cli.ts:303</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>network: <a href="classes/clinetworkadapter.html" class="tsd-signature-type">CLINetworkAdapter</a></h5>
|
|
</li>
|
|
<li>
|
|
<h5>args: <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-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">
|
|
<a name="getpaymentkeyinfo" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Payment<wbr>Key<wbr>Info</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<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/clinetworkadapter.html" class="tsd-signature-type">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="globals.html#paymentkeyinfotype" class="tsd-signature-type">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#L106">packages/cli/src/keys.ts:106</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>network: <a href="classes/clinetworkadapter.html" class="tsd-signature-type">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="globals.html#paymentkeyinfotype" class="tsd-signature-type">PaymentKeyInfoType</a><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="getprivatekeyaddress" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Private<wbr>Key<wbr>Address</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<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/clinetworkadapter.html" class="tsd-signature-type">CLINetworkAdapter</a>, privateKey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="classes/clitransactionsigner.html" class="tsd-signature-type">CLITransactionSigner</a><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#L403">packages/cli/src/utils.ts:403</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>network: <a href="classes/clinetworkadapter.html" class="tsd-signature-type">CLINetworkAdapter</a></h5>
|
|
</li>
|
|
<li>
|
|
<h5>privateKey: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="classes/clitransactionsigner.html" class="tsd-signature-type">CLITransactionSigner</a></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">
|
|
<a name="getprofileurlfromzonefile" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> get<wbr>ProfileURLFrom<wbr>Zone<wbr>File</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">get<wbr>ProfileURLFrom<wbr>Zone<wbr>File<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">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">undefined</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/keychain/src/utils/index.ts#L250">packages/keychain/src/utils/index.ts:250</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">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">undefined</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">
|
|
<a name="getpublickey" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Public<wbr>Key</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">get<wbr>Public<wbr>Key<span class="tsd-signature-symbol">(</span>privateKey<span class="tsd-signature-symbol">: </span><a href="interfaces/stacksprivatekey.html" class="tsd-signature-type">StacksPrivateKey</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="interfaces/stackspublickey.html" class="tsd-signature-type">StacksPublicKey</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/transactions/src/keys.ts#L190">packages/transactions/src/keys.ts:190</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>privateKey: <a href="interfaces/stacksprivatekey.html" class="tsd-signature-type">StacksPrivateKey</a></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="interfaces/stackspublickey.html" class="tsd-signature-type">StacksPublicKey</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<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">
|
|
<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#L394">packages/cli/src/utils.ts:394</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">
|
|
<a name="getquerystringparams" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Query<wbr>String<wbr>Params</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">get<wbr>Query<wbr>String<wbr>Params<span class="tsd-signature-symbol">(</span>query<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">Record</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">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/auth/src/protocolEchoDetection.ts#L12">packages/auth/src/protocolEchoDetection.ts:12</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>query: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Record</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">string</span><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="getsignaturerecoveryparam" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Signature<wbr>Recovery<wbr>Param</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">get<wbr>Signature<wbr>Recovery<wbr>Param<span class="tsd-signature-symbol">(</span>signature<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">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/transactions/src/keys.ts#L166">packages/transactions/src/keys.ts:166</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>signature: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
</ul>
|
|
<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">
|
|
<a name="getstackswalletkey" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Stacks<wbr>Wallet<wbr>Key</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">get<wbr>Stacks<wbr>Wallet<wbr>Key<span class="tsd-signature-symbol">(</span>network<span class="tsd-signature-symbol">: </span><a href="classes/clinetworkadapter.html" class="tsd-signature-type">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></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#L317">packages/cli/src/cli.ts:317</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>network: <a href="classes/clinetworkadapter.html" class="tsd-signature-type">CLINetworkAdapter</a></h5>
|
|
</li>
|
|
<li>
|
|
<h5>args: <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-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">
|
|
<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">
|
|
<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/clinetworkadapter.html" class="tsd-signature-type">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="globals.html#stackskeyinfotype" class="tsd-signature-type">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#L133">packages/cli/src/keys.ts:133</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>network: <a href="classes/clinetworkadapter.html" class="tsd-signature-type">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="globals.html#stackskeyinfotype" class="tsd-signature-type">StacksKeyInfoType</a><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="gettypestring" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Type<wbr>String</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">get<wbr>Type<wbr>String<span class="tsd-signature-symbol">(</span>val<span class="tsd-signature-symbol">: </span><a href="globals.html#clarityabitype" class="tsd-signature-type">ClarityAbiType</a><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/transactions/src/contract-abi.ts#L193">packages/transactions/src/contract-abi.ts:193</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>val: <a href="globals.html#clarityabitype" class="tsd-signature-type">ClarityAbiType</a></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">
|
|
<a name="gettypeunion" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Type<wbr>Union</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">get<wbr>Type<wbr>Union<span class="tsd-signature-symbol">(</span>val<span class="tsd-signature-symbol">: </span><a href="globals.html#clarityabitype" class="tsd-signature-type">ClarityAbiType</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="globals.html#clarityabitypeunion" class="tsd-signature-type">ClarityAbiTypeUnion</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/transactions/src/contract-abi.ts#L104">packages/transactions/src/contract-abi.ts:104</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>val: <a href="globals.html#clarityabitype" class="tsd-signature-type">ClarityAbiType</a></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="globals.html#clarityabitypeunion" class="tsd-signature-type">ClarityAbiTypeUnion</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="getpass" class="tsd-anchor"></a>
|
|
<h3>getpass</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<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#L628">packages/cli/src/utils.ts:628</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">
|
|
<a name="handleauth" class="tsd-anchor"></a>
|
|
<h3>handle<wbr>Auth</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<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/clinetworkadapter.html" class="tsd-signature-type">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#L365">packages/cli/src/auth.ts:365</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>network: <a href="classes/clinetworkadapter.html" class="tsd-signature-type">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">
|
|
<a name="handlesignin" class="tsd-anchor"></a>
|
|
<h3>handle<wbr>Sign<wbr>In</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<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/clinetworkadapter.html" class="tsd-signature-type">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#L588">packages/cli/src/auth.ts:588</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>network: <a href="classes/clinetworkadapter.html" class="tsd-signature-type">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">
|
|
<a name="haskeys" class="tsd-anchor"></a>
|
|
<h3>has<wbr>Keys</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<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><a href="classes/clitransactionsigner.html" class="tsd-signature-type">CLITransactionSigner</a><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#L224">packages/cli/src/utils.ts:224</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><a href="classes/clitransactionsigner.html" class="tsd-signature-type">CLITransactionSigner</a></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">
|
|
<a name="hash160" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> hash160</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<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>
|
|
<li class="tsd-signature tsd-kind-icon">hash160<span class="tsd-signature-symbol">(</span>input<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#L446">packages/cli/src/utils.ts:446</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>
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/transactions/src/utils.ts#L99">packages/transactions/src/utils.ts:99</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>input: <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">
|
|
<a name="hashp2pkh" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> hash<wbr>P2PKH</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">hash<wbr>P2PKH<span class="tsd-signature-symbol">(</span>input<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">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/transactions/src/utils.ts#L106">packages/transactions/src/utils.ts:106</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>input: <span class="tsd-signature-type">Buffer</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">
|
|
<a name="hashp2sh" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> hash<wbr>P2SH</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">hash<wbr>P2SH<span class="tsd-signature-symbol">(</span>numSigs<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, pubKeys<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-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/transactions/src/utils.ts#L112">packages/transactions/src/utils.ts:112</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>numSigs: <span class="tsd-signature-type">number</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>pubKeys: <span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">[]</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">
|
|
<a name="hashripemd160" class="tsd-anchor"></a>
|
|
<h3>hash<wbr>Ripemd160</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">hash<wbr>Ripemd160<span class="tsd-signature-symbol">(</span>data<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/encryption/src/hashRipemd160.ts#L66">packages/encryption/src/hashRipemd160.ts:66</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>data: <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">
|
|
<a name="hashsha256sync" class="tsd-anchor"></a>
|
|
<h3>hash<wbr>Sha256<wbr>Sync</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">hash<wbr>Sha256<wbr>Sync<span class="tsd-signature-symbol">(</span>data<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/encryption/src/sha2Hash.ts#L71">packages/encryption/src/sha2Hash.ts:71</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>data: <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">
|
|
<a name="hashsha512sync" class="tsd-anchor"></a>
|
|
<h3>hash<wbr>Sha512<wbr>Sync</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">hash<wbr>Sha512<wbr>Sync<span class="tsd-signature-symbol">(</span>data<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/encryption/src/sha2Hash.ts#L77">packages/encryption/src/sha2Hash.ts:77</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>data: <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">
|
|
<a name="hexstringtoint" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> hex<wbr>String<wbr>ToInt</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">hex<wbr>String<wbr>ToInt<span class="tsd-signature-symbol">(</span>hexString<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">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/transactions/src/utils.ts#L48">packages/transactions/src/utils.ts:48</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>hexString: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
</ul>
|
|
<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">
|
|
<a name="hextocv" class="tsd-anchor"></a>
|
|
<h3>hex<wbr>ToCV</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">hex<wbr>ToCV<span class="tsd-signature-symbol">(</span>hex<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="globals.html#clarityvalue" class="tsd-signature-type">ClarityValue</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/transactions/src/utils.ts#L164">packages/transactions/src/utils.ts:164</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Converts a hex encoded string to a clarity value</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>hex: <span class="tsd-signature-type">string</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>the hex encoded string with or without <code>0x</code> prefix</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="globals.html#clarityvalue" class="tsd-signature-type">ClarityValue</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="intcv" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> intCV</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">intCV<span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</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">Buffer</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="interfaces/intcv.html" class="tsd-signature-type">IntCV</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/transactions/src/clarity/types/intCV.ts#L10">packages/transactions/src/clarity/types/intCV.ts:10</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>value: <span class="tsd-signature-type">number</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">Buffer</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="interfaces/intcv.html" class="tsd-signature-type">IntCV</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="inttohexstring" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> int<wbr>ToHex<wbr>String</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">int<wbr>ToHex<wbr>String<span class="tsd-signature-symbol">(</span>integer<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, lengthBytes<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">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/transactions/src/utils.ts#L45">packages/transactions/src/utils.ts:45</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>integer: <span class="tsd-signature-type">number</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> lengthBytes: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 8</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">
|
|
<a name="isclitransactionsigner" class="tsd-anchor"></a>
|
|
<h3>isCLITransaction<wbr>Signer</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">isCLITransaction<wbr>Signer<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><a href="classes/clitransactionsigner.html" class="tsd-signature-type">CLITransactionSigner</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">signer</span><span class="tsd-signature-symbol"> is </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#L218">packages/cli/src/utils.ts:218</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><a href="classes/clitransactionsigner.html" class="tsd-signature-type">CLITransactionSigner</a></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">signer</span><span class="tsd-signature-symbol"> is </span><span class="tsd-signature-type">CLITransactionSigner</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="isclarityabibuffer" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> is<wbr>Clarity<wbr>Abi<wbr>Buffer</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">is<wbr>Clarity<wbr>Abi<wbr>Buffer<span class="tsd-signature-symbol">(</span>val<span class="tsd-signature-symbol">: </span><a href="globals.html#clarityabitype" class="tsd-signature-type">ClarityAbiType</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">val</span><span class="tsd-signature-symbol"> is </span><span class="tsd-signature-type">ClarityAbiTypeBuffer</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/transactions/src/contract-abi.ts#L74">packages/transactions/src/contract-abi.ts:74</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>val: <a href="globals.html#clarityabitype" class="tsd-signature-type">ClarityAbiType</a></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">val</span><span class="tsd-signature-symbol"> is </span><span class="tsd-signature-type">ClarityAbiTypeBuffer</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="isclarityabilist" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> is<wbr>Clarity<wbr>Abi<wbr>List</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">is<wbr>Clarity<wbr>Abi<wbr>List<span class="tsd-signature-symbol">(</span>val<span class="tsd-signature-symbol">: </span><a href="globals.html#clarityabitype" class="tsd-signature-type">ClarityAbiType</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">val</span><span class="tsd-signature-symbol"> is </span><span class="tsd-signature-type">ClarityAbiTypeList</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/transactions/src/contract-abi.ts#L86">packages/transactions/src/contract-abi.ts:86</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>val: <a href="globals.html#clarityabitype" class="tsd-signature-type">ClarityAbiType</a></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">val</span><span class="tsd-signature-symbol"> is </span><span class="tsd-signature-type">ClarityAbiTypeList</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="isclarityabioptional" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> is<wbr>Clarity<wbr>Abi<wbr>Optional</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">is<wbr>Clarity<wbr>Abi<wbr>Optional<span class="tsd-signature-symbol">(</span>val<span class="tsd-signature-symbol">: </span><a href="globals.html#clarityabitype" class="tsd-signature-type">ClarityAbiType</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">val</span><span class="tsd-signature-symbol"> is </span><span class="tsd-signature-type">ClarityAbiTypeOptional</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/transactions/src/contract-abi.ts#L82">packages/transactions/src/contract-abi.ts:82</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>val: <a href="globals.html#clarityabitype" class="tsd-signature-type">ClarityAbiType</a></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">val</span><span class="tsd-signature-symbol"> is </span><span class="tsd-signature-type">ClarityAbiTypeOptional</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="isclarityabiprimitive" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> is<wbr>Clarity<wbr>Abi<wbr>Primitive</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">is<wbr>Clarity<wbr>Abi<wbr>Primitive<span class="tsd-signature-symbol">(</span>val<span class="tsd-signature-symbol">: </span><a href="globals.html#clarityabitype" class="tsd-signature-type">ClarityAbiType</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">val</span><span class="tsd-signature-symbol"> is </span><span class="tsd-signature-type">ClarityAbiTypePrimitive</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/transactions/src/contract-abi.ts#L72">packages/transactions/src/contract-abi.ts:72</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>val: <a href="globals.html#clarityabitype" class="tsd-signature-type">ClarityAbiType</a></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">val</span><span class="tsd-signature-symbol"> is </span><span class="tsd-signature-type">ClarityAbiTypePrimitive</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="isclarityabiresponse" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> is<wbr>Clarity<wbr>Abi<wbr>Response</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">is<wbr>Clarity<wbr>Abi<wbr>Response<span class="tsd-signature-symbol">(</span>val<span class="tsd-signature-symbol">: </span><a href="globals.html#clarityabitype" class="tsd-signature-type">ClarityAbiType</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">val</span><span class="tsd-signature-symbol"> is </span><span class="tsd-signature-type">ClarityAbiTypeResponse</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/transactions/src/contract-abi.ts#L80">packages/transactions/src/contract-abi.ts:80</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>val: <a href="globals.html#clarityabitype" class="tsd-signature-type">ClarityAbiType</a></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">val</span><span class="tsd-signature-symbol"> is </span><span class="tsd-signature-type">ClarityAbiTypeResponse</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="isclarityabistringascii" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> is<wbr>Clarity<wbr>Abi<wbr>String<wbr>Ascii</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">is<wbr>Clarity<wbr>Abi<wbr>String<wbr>Ascii<span class="tsd-signature-symbol">(</span>val<span class="tsd-signature-symbol">: </span><a href="globals.html#clarityabitype" class="tsd-signature-type">ClarityAbiType</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">val</span><span class="tsd-signature-symbol"> is </span><span class="tsd-signature-type">ClarityAbiTypeStringAscii</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/transactions/src/contract-abi.ts#L76">packages/transactions/src/contract-abi.ts:76</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>val: <a href="globals.html#clarityabitype" class="tsd-signature-type">ClarityAbiType</a></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">val</span><span class="tsd-signature-symbol"> is </span><span class="tsd-signature-type">ClarityAbiTypeStringAscii</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="isclarityabistringutf8" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> is<wbr>Clarity<wbr>Abi<wbr>String<wbr>Utf8</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">is<wbr>Clarity<wbr>Abi<wbr>String<wbr>Utf8<span class="tsd-signature-symbol">(</span>val<span class="tsd-signature-symbol">: </span><a href="globals.html#clarityabitype" class="tsd-signature-type">ClarityAbiType</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">val</span><span class="tsd-signature-symbol"> is </span><span class="tsd-signature-type">ClarityAbiTypeStringUtf8</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/transactions/src/contract-abi.ts#L78">packages/transactions/src/contract-abi.ts:78</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>val: <a href="globals.html#clarityabitype" class="tsd-signature-type">ClarityAbiType</a></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">val</span><span class="tsd-signature-symbol"> is </span><span class="tsd-signature-type">ClarityAbiTypeStringUtf8</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="isclarityabituple" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> is<wbr>Clarity<wbr>Abi<wbr>Tuple</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">is<wbr>Clarity<wbr>Abi<wbr>Tuple<span class="tsd-signature-symbol">(</span>val<span class="tsd-signature-symbol">: </span><a href="globals.html#clarityabitype" class="tsd-signature-type">ClarityAbiType</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">val</span><span class="tsd-signature-symbol"> is </span><span class="tsd-signature-type">ClarityAbiTypeTuple</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/transactions/src/contract-abi.ts#L84">packages/transactions/src/contract-abi.ts:84</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>val: <a href="globals.html#clarityabitype" class="tsd-signature-type">ClarityAbiType</a></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">val</span><span class="tsd-signature-symbol"> is </span><span class="tsd-signature-type">ClarityAbiTypeTuple</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="isclarityname" class="tsd-anchor"></a>
|
|
<h3>is<wbr>Clarity<wbr>Name</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">is<wbr>Clarity<wbr>Name<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/transactions/src/utils.ts#L136">packages/transactions/src/utils.ts:136</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">
|
|
<a name="iscompressed" class="tsd-anchor"></a>
|
|
<h3>is<wbr>Compressed</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">is<wbr>Compressed<span class="tsd-signature-symbol">(</span>key<span class="tsd-signature-symbol">: </span><a href="interfaces/stackspublickey.html" class="tsd-signature-type">StacksPublicKey</a><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/transactions/src/keys.ts#L85">packages/transactions/src/keys.ts:85</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>key: <a href="interfaces/stackspublickey.html" class="tsd-signature-type">StacksPublicKey</a></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-has-type-parameter">
|
|
<a name="isenum" class="tsd-anchor"></a>
|
|
<h3>is<wbr>Enum</h3>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-has-type-parameter">
|
|
<li class="tsd-signature tsd-kind-icon">is<wbr>Enum<T, TEnumValue><span class="tsd-signature-symbol">(</span>enumVariable<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{}</span>, value<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">value</span><span class="tsd-signature-symbol"> is </span><span class="tsd-signature-type">TEnumValue</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/transactions/src/bufferReader.ts#L32">packages/transactions/src/bufferReader.ts:32</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Type guard to check if a given value is a valid enum value.</p>
|
|
</div>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>example</dt>
|
|
<dd><pre><code class="language-ts"><span class="hljs-built_in">enum</span> Color {
|
|
Purple = <span class="hljs-number">3</span>,
|
|
Orange = <span class="hljs-number">5</span>
|
|
}
|
|
<span class="hljs-keyword">const</span> val: <span class="hljs-built_in">number</span> = <span class="hljs-number">3</span>;
|
|
<span class="hljs-keyword">if</span> (isEnum(Color, val)) {
|
|
<span class="hljs-comment">// `val` is known as enum type `Color`, e.g.:</span>
|
|
<span class="hljs-keyword">const</span> colorVal: Color = val;
|
|
}</code></pre>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
<h4 class="tsd-type-parameters-title">Type parameters</h4>
|
|
<ul class="tsd-type-parameters">
|
|
<li>
|
|
<h4>T<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h4>
|
|
</li>
|
|
<li>
|
|
<h4>TEnumValue<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h4>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>enumVariable: <span class="tsd-signature-symbol">{}</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Literal <code>enum</code> type.</p>
|
|
</div>
|
|
<ul class="tsd-parameters">
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<h5>value: <span class="tsd-signature-type">number</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>A value to check against the enum's values.</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">value</span><span class="tsd-signature-symbol"> is </span><span class="tsd-signature-type">TEnumValue</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-has-type-parameter">
|
|
<a name="isnodecryptoavailable" class="tsd-anchor"></a>
|
|
<h3>is<wbr>Node<wbr>Crypto<wbr>Available</h3>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-has-type-parameter">
|
|
<li class="tsd-signature tsd-kind-icon">is<wbr>Node<wbr>Crypto<wbr>Available<T><span class="tsd-signature-symbol">(</span>withFeature<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>nodeCrypto<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"crypto"</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">T</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/encryption/src/cryptoUtils.ts#L5">packages/encryption/src/cryptoUtils.ts:5</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-type-parameters-title">Type parameters</h4>
|
|
<ul class="tsd-type-parameters">
|
|
<li>
|
|
<h4>T</h4>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>withFeature: <span class="tsd-signature-symbol">(</span>nodeCrypto<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"crypto"</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">T</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>nodeCrypto<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"crypto"</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">T</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>nodeCrypto: <span class="tsd-signature-type">"crypto"</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">T</span></h4>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">false</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">T</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="isrecoverablegaiaerror" class="tsd-anchor"></a>
|
|
<h3>is<wbr>Recoverable<wbr>Gaia<wbr>Error</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">is<wbr>Recoverable<wbr>Gaia<wbr>Error<span class="tsd-signature-symbol">(</span>error<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">GaiaHubError</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/storage/src/storage.ts#L880">packages/storage/src/storage.ts:880</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Determines if a gaia error response is possible to recover from
|
|
by refreshing the gaiaHubConfig, and retrying the request.</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>error: <span class="tsd-signature-type">GaiaHubError</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">
|
|
<a name="issinglesig" class="tsd-anchor"></a>
|
|
<h3>is<wbr>Single<wbr>Sig</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">is<wbr>Single<wbr>Sig<span class="tsd-signature-symbol">(</span>condition<span class="tsd-signature-symbol">: </span><a href="globals.html#spendingcondition" class="tsd-signature-type">SpendingCondition</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">condition</span><span class="tsd-signature-symbol"> is </span><span class="tsd-signature-type">SingleSigSpendingCondition</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/transactions/src/authorization.ts#L200">packages/transactions/src/authorization.ts:200</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>condition: <a href="globals.html#spendingcondition" class="tsd-signature-type">SpendingCondition</a></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">condition</span><span class="tsd-signature-symbol"> is </span><span class="tsd-signature-type">SingleSigSpendingCondition</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="isstringarray" class="tsd-anchor"></a>
|
|
<h3>is<wbr>String<wbr>Array</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">is<wbr>String<wbr>Array<span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">value</span><span class="tsd-signature-symbol"> is </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/argparse.ts#L3142">packages/cli/src/argparse.ts:3142</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>value: <span class="tsd-signature-type">any</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">value</span><span class="tsd-signature-symbol"> is </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">
|
|
<a name="issubdomain" class="tsd-anchor"></a>
|
|
<h3>is<wbr>Subdomain</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<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#L420">packages/cli/src/utils.ts:420</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">
|
|
<a name="issubtlecryptoavailable" class="tsd-anchor"></a>
|
|
<h3>is<wbr>Subtle<wbr>Crypto<wbr>Available</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">is<wbr>Subtle<wbr>Crypto<wbr>Available<span class="tsd-signature-symbol">(</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/encryption/src/cryptoUtils.ts#L1">packages/encryption/src/cryptoUtils.ts:1</a></li>
|
|
</ul>
|
|
</aside>
|
|
<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">
|
|
<a name="leftpadhex" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> left<wbr>Pad<wbr>Hex</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">left<wbr>Pad<wbr>Hex<span class="tsd-signature-symbol">(</span>hexString<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/transactions/src/utils.ts#L36">packages/transactions/src/utils.ts:36</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>hexString: <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">
|
|
<a name="leftpadhextolength" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> left<wbr>Pad<wbr>Hex<wbr>ToLength</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">left<wbr>Pad<wbr>Hex<wbr>ToLength<span class="tsd-signature-symbol">(</span>hexString<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, length<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">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/transactions/src/utils.ts#L39">packages/transactions/src/utils.ts:39</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>hexString: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>length: <span class="tsd-signature-type">number</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-has-type-parameter">
|
|
<a name="listcv" class="tsd-anchor"></a>
|
|
<h3>listCV</h3>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-has-type-parameter">
|
|
<li class="tsd-signature tsd-kind-icon">listCV<T><span class="tsd-signature-symbol">(</span>values<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="interfaces/listcv.html" class="tsd-signature-type">ListCV</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/transactions/src/clarity/types/listCV.ts#L8">packages/transactions/src/clarity/types/listCV.ts:8</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-type-parameters-title">Type parameters</h4>
|
|
<ul class="tsd-type-parameters">
|
|
<li>
|
|
<h4>T<span class="tsd-signature-symbol">: </span><a href="globals.html#clarityvalue" class="tsd-signature-type">ClarityValue</a></h4>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>values: <span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">[]</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="interfaces/listcv.html" class="tsd-signature-type">ListCV</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="loadconfig" class="tsd-anchor"></a>
|
|
<h3>load<wbr>Config</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<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_config_type.html" class="tsd-signature-type">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#L3356">packages/cli/src/argparse.ts:3356</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_config_type.html" class="tsd-signature-type">CLI_CONFIG_TYPE</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="loadnamedidentities" class="tsd-anchor"></a>
|
|
<h3>load<wbr>Named<wbr>Identities</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<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/clinetworkadapter.html" class="tsd-signature-type">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><span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><a href="interfaces/namedidentitytype.html" class="tsd-signature-type">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#L261">packages/cli/src/auth.ts:261</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>network: <a href="classes/clinetworkadapter.html" class="tsd-signature-type">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><span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><a href="interfaces/namedidentitytype.html" class="tsd-signature-type">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">
|
|
<a name="loadnamedidentitiesloop" class="tsd-anchor"></a>
|
|
<h3>load<wbr>Named<wbr>Identities<wbr>Loop</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">load<wbr>Named<wbr>Identities<wbr>Loop<span class="tsd-signature-symbol">(</span>network<span class="tsd-signature-symbol">: </span><a href="classes/clinetworkadapter.html" class="tsd-signature-type">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>, identities<span class="tsd-signature-symbol">: </span><a href="interfaces/namedidentitytype.html" class="tsd-signature-type">NamedIdentityType</a><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><a href="interfaces/namedidentitytype.html" class="tsd-signature-type">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#L226">packages/cli/src/auth.ts:226</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>network: <a href="classes/clinetworkadapter.html" class="tsd-signature-type">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>identities: <a href="interfaces/namedidentitytype.html" class="tsd-signature-type">NamedIdentityType</a><span class="tsd-signature-symbol">[]</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/namedidentitytype.html" class="tsd-signature-type">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">
|
|
<a name="loadunnamedidentity" class="tsd-anchor"></a>
|
|
<h3>load<wbr>Unnamed<wbr>Identity</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">load<wbr>Unnamed<wbr>Identity<span class="tsd-signature-symbol">(</span>network<span class="tsd-signature-symbol">: </span><a href="classes/clinetworkadapter.html" class="tsd-signature-type">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><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/namedidentitytype.html" class="tsd-signature-type">NamedIdentityType</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/auth.ts#L271">packages/cli/src/auth.ts:271</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>network: <a href="classes/clinetworkadapter.html" class="tsd-signature-type">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>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="interfaces/namedidentitytype.html" class="tsd-signature-type">NamedIdentityType</a><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="lookupprofile" class="tsd-anchor"></a>
|
|
<h3>lookup<wbr>Profile</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">lookup<wbr>Profile<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">: </span><a href="interfaces/profilelookupoptions.html" class="tsd-signature-type">ProfileLookupOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Record</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">any</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/auth/src/profile.ts#L20">packages/auth/src/profile.ts:20</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Look up a user profile by blockstack ID</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>options: <a href="interfaces/profilelookupoptions.html" class="tsd-signature-type">ProfileLookupOptions</a></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">Record</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">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4>
|
|
<p>that resolves to a profile object</p>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="makeallcommandshelp" class="tsd-anchor"></a>
|
|
<h3>make<wbr>All<wbr>Commands<wbr>Help</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<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#L2963">packages/cli/src/argparse.ts:2963</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">
|
|
<a name="makeallcommandslist" class="tsd-anchor"></a>
|
|
<h3>make<wbr>All<wbr>Commands<wbr>List</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<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#L2932">packages/cli/src/argparse.ts:2932</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">
|
|
<a name="makeassociationtoken" class="tsd-anchor"></a>
|
|
<h3>make<wbr>Association<wbr>Token</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<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">
|
|
<a name="makeauthpage" class="tsd-anchor"></a>
|
|
<h3>make<wbr>Auth<wbr>Page</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">make<wbr>Auth<wbr>Page<span class="tsd-signature-symbol">(</span>network<span class="tsd-signature-symbol">: </span><a href="classes/clinetworkadapter.html" class="tsd-signature-type">CLINetworkAdapter</a>, authPort<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, mnemonic<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, hubUrl<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, manifest<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, authRequest<span class="tsd-signature-symbol">: </span><a href="interfaces/authrequesttype.html" class="tsd-signature-type">AuthRequestType</a>, ids<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><a href="interfaces/namedidentitytype.html" class="tsd-signature-type">NamedIdentityType</a><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></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#L180">packages/cli/src/auth.ts:180</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>network: <a href="classes/clinetworkadapter.html" class="tsd-signature-type">CLINetworkAdapter</a></h5>
|
|
</li>
|
|
<li>
|
|
<h5>authPort: <span class="tsd-signature-type">number</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>mnemonic: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>hubUrl: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>manifest: <span class="tsd-signature-type">any</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>authRequest: <a href="interfaces/authrequesttype.html" class="tsd-signature-type">AuthRequestType</a></h5>
|
|
</li>
|
|
<li>
|
|
<h5>ids: <span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><a href="interfaces/namedidentitytype.html" class="tsd-signature-type">NamedIdentityType</a><span class="tsd-signature-symbol">></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">
|
|
<a name="makeauthrequest" class="tsd-anchor"></a>
|
|
<h3>make<wbr>Auth<wbr>Request</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">make<wbr>Auth<wbr>Request<span class="tsd-signature-symbol">(</span>transitPrivateKey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, redirectURI<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span>, manifestURI<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span>, scopes<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span><a href="enums/authscope.html" class="tsd-signature-type">AuthScope</a><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>, appDomain<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span>, expiresAt<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, extraParams<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">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/auth/src/messages.ts#L56">packages/auth/src/messages.ts:56</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Generates an authentication request that can be sent to the Blockstack
|
|
browser for the user to approve sign in. This authentication request can
|
|
then be used for sign in by passing it to the <code>redirectToSignInWithAuthRequest</code>
|
|
method.</p>
|
|
</div>
|
|
<p><em>Note: This method should only be used if you want to roll your own authentication
|
|
flow. Typically you'd use <code>redirectToSignIn</code> which takes care of this
|
|
under the hood.</em></p>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>transitPrivateKey: <span class="tsd-signature-type">string</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>hex encoded transit private key</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> redirectURI: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>location to redirect user to after sign in approval</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> manifestURI: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>location of this app's manifest file</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> scopes: <span class="tsd-signature-symbol">(</span><a href="enums/authscope.html" class="tsd-signature-type">AuthScope</a><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"> = DEFAULT_SCOPE.slice()</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>the permissions this app is requesting</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> appDomain: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>the origin of this app</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> expiresAt: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = nextMonth().getTime()</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>the time at which this request is no longer valid</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> extraParams: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> = {}</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Any extra parameters you'd like to pass to the authenticator.
|
|
Use this to pass options that aren't part of the Blockstack auth spec, but might be supported
|
|
by special authenticators.</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
|
|
<p>the authentication request</p>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="makecommandusagestring" class="tsd-anchor"></a>
|
|
<h3>make<wbr>Command<wbr>Usage<wbr>String</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<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">undefined</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">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#L2986">packages/cli/src/argparse.ts:2986</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">undefined</span><span class="tsd-signature-symbol"> | </span><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">
|
|
<a name="makecontractcall" class="tsd-anchor"></a>
|
|
<h3>make<wbr>Contract<wbr>Call</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">make<wbr>Contract<wbr>Call<span class="tsd-signature-symbol">(</span>txOptions<span class="tsd-signature-symbol">: </span><a href="interfaces/signedcontractcalloptions.html" class="tsd-signature-type">SignedContractCallOptions</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/signedmultisigcontractcalloptions.html" class="tsd-signature-type">SignedMultiSigContractCallOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="classes/stackstransaction.html" class="tsd-signature-type">StacksTransaction</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/transactions/src/builders.ts#L815">packages/transactions/src/builders.ts:815</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Generates a Clarity smart contract function call transaction</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>txOptions: <a href="interfaces/signedcontractcalloptions.html" class="tsd-signature-type">SignedContractCallOptions</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/signedmultisigcontractcalloptions.html" class="tsd-signature-type">SignedMultiSigContractCallOptions</a></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>an options object for the contract function call</p>
|
|
<p>Returns a signed Stacks smart contract function call transaction.</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="classes/stackstransaction.html" class="tsd-signature-type">StacksTransaction</a><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="makecontractdeploy" class="tsd-anchor"></a>
|
|
<h3>make<wbr>Contract<wbr>Deploy</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">make<wbr>Contract<wbr>Deploy<span class="tsd-signature-symbol">(</span>txOptions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ContractDeployOptions</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="classes/stackstransaction.html" class="tsd-signature-type">StacksTransaction</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/transactions/src/builders.ts#L519">packages/transactions/src/builders.ts:519</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Generates a Clarity smart contract deploy transaction</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>txOptions: <span class="tsd-signature-type">ContractDeployOptions</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>an options object for the contract deploy</p>
|
|
<p>Returns a signed Stacks smart contract deploy transaction.</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="classes/stackstransaction.html" class="tsd-signature-type">StacksTransaction</a><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="makecontractfungiblepostcondition" class="tsd-anchor"></a>
|
|
<h3>make<wbr>Contract<wbr>Fungible<wbr>Post<wbr>Condition</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">make<wbr>Contract<wbr>Fungible<wbr>Post<wbr>Condition<span class="tsd-signature-symbol">(</span>address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, contractName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, conditionCode<span class="tsd-signature-symbol">: </span><a href="enums/fungibleconditioncode.html" class="tsd-signature-type">FungibleConditionCode</a>, amount<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BigNum</span>, assetInfo<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="interfaces/assetinfo.html" class="tsd-signature-type">AssetInfo</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="interfaces/fungiblepostcondition.html" class="tsd-signature-type">FungiblePostCondition</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/transactions/src/builders.ts#L931">packages/transactions/src/builders.ts:931</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Generates a fungible token post condition with a contract principal</p>
|
|
</div>
|
|
<p>Returns a fungible token post condition object</p>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>address: <span class="tsd-signature-type">string</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>the c32check address</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5>contractName: <span class="tsd-signature-type">string</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>the name of the contract</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5>conditionCode: <a href="enums/fungibleconditioncode.html" class="tsd-signature-type">FungibleConditionCode</a></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>the condition code</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5>amount: <span class="tsd-signature-type">BigNum</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>the amount of fungible tokens</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5>assetInfo: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="interfaces/assetinfo.html" class="tsd-signature-type">AssetInfo</a></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>asset info describing the fungible token</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="interfaces/fungiblepostcondition.html" class="tsd-signature-type">FungiblePostCondition</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="makecontractnonfungiblepostcondition" class="tsd-anchor"></a>
|
|
<h3>make<wbr>Contract<wbr>Non<wbr>Fungible<wbr>Post<wbr>Condition</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">make<wbr>Contract<wbr>Non<wbr>Fungible<wbr>Post<wbr>Condition<span class="tsd-signature-symbol">(</span>address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, contractName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, conditionCode<span class="tsd-signature-symbol">: </span><a href="enums/nonfungibleconditioncode.html" class="tsd-signature-type">NonFungibleConditionCode</a>, assetInfo<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="interfaces/assetinfo.html" class="tsd-signature-type">AssetInfo</a>, assetName<span class="tsd-signature-symbol">: </span><a href="globals.html#clarityvalue" class="tsd-signature-type">ClarityValue</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="interfaces/nonfungiblepostcondition.html" class="tsd-signature-type">NonFungiblePostCondition</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/transactions/src/builders.ts#L985">packages/transactions/src/builders.ts:985</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Generates a non-fungible token post condition with a contract principal</p>
|
|
</div>
|
|
<p>Returns a non-fungible token post condition object</p>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>address: <span class="tsd-signature-type">string</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>the c32check address</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5>contractName: <span class="tsd-signature-type">string</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>the name of the contract</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5>conditionCode: <a href="enums/nonfungibleconditioncode.html" class="tsd-signature-type">NonFungibleConditionCode</a></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>the condition code</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5>assetInfo: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="interfaces/assetinfo.html" class="tsd-signature-type">AssetInfo</a></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>asset info describing the non-fungible token</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5>assetName: <a href="globals.html#clarityvalue" class="tsd-signature-type">ClarityValue</a></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>asset name describing the non-fungible token</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="interfaces/nonfungiblepostcondition.html" class="tsd-signature-type">NonFungiblePostCondition</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="makecontractstxpostcondition" class="tsd-anchor"></a>
|
|
<h3>make<wbr>ContractSTXPost<wbr>Condition</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">make<wbr>ContractSTXPost<wbr>Condition<span class="tsd-signature-symbol">(</span>address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, contractName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, conditionCode<span class="tsd-signature-symbol">: </span><a href="enums/fungibleconditioncode.html" class="tsd-signature-type">FungibleConditionCode</a>, amount<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BigNum</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="interfaces/stxpostcondition.html" class="tsd-signature-type">STXPostCondition</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/transactions/src/builders.ts#L879">packages/transactions/src/builders.ts:879</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Generates a STX post condition with a contract principal</p>
|
|
</div>
|
|
<p>Returns a STX post condition object</p>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>address: <span class="tsd-signature-type">string</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>the c32check address of the contract</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5>contractName: <span class="tsd-signature-type">string</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>the name of the contract</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5>conditionCode: <a href="enums/fungibleconditioncode.html" class="tsd-signature-type">FungibleConditionCode</a></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>the condition code</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5>amount: <span class="tsd-signature-type">BigNum</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>the amount of STX tokens</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="interfaces/stxpostcondition.html" class="tsd-signature-type">STXPostCondition</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="makedidconfiguration" class="tsd-anchor"></a>
|
|
<h3>makeDIDConfiguration</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">makeDIDConfiguration<span class="tsd-signature-symbol">(</span>network<span class="tsd-signature-symbol">: </span><a href="classes/clinetworkadapter.html" class="tsd-signature-type">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#L477">packages/cli/src/utils.ts:477</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>network: <a href="classes/clinetworkadapter.html" class="tsd-signature-type">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">
|
|
<a name="makefakeauthresponsetoken" class="tsd-anchor"></a>
|
|
<h3>make<wbr>Fake<wbr>Auth<wbr>Response<wbr>Token</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">make<wbr>Fake<wbr>Auth<wbr>Response<wbr>Token<span class="tsd-signature-symbol">(</span>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>, associationToken<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</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">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#L27">packages/cli/src/data.ts:27</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><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> associationToken: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><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">
|
|
<a name="makegaiaassociationtoken" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> make<wbr>Gaia<wbr>Association<wbr>Token</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">make<wbr>Gaia<wbr>Association<wbr>Token<span class="tsd-signature-symbol">(</span>secretKeyHex<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, childPublicKeyHex<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/keychain/src/utils/gaia.ts#L24">packages/keychain/src/utils/gaia.ts:24</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>secretKeyHex: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>childPublicKeyHex: <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">
|
|
<a name="makegaiaauthtoken" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> make<wbr>Gaia<wbr>Auth<wbr>Token</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">make<wbr>Gaia<wbr>Auth<wbr>Token<span class="tsd-signature-symbol">(</span>__namedParameters<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>gaiaHubUrl<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>hubInfo<span class="tsd-signature-symbol">: </span><a href="interfaces/hubinfo.html" class="tsd-signature-type">HubInfo</a><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-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/keychain/src/utils/gaia.ts#L101">packages/keychain/src/utils/gaia.ts:101</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>__namedParameters: <span class="tsd-signature-symbol">{ </span>gaiaHubUrl<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>hubInfo<span class="tsd-signature-symbol">: </span><a href="interfaces/hubinfo.html" class="tsd-signature-type">HubInfo</a><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>gaia<wbr>Hub<wbr>Url<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li class="tsd-parameter">
|
|
<h5>hub<wbr>Info<span class="tsd-signature-symbol">: </span><a href="interfaces/hubinfo.html" class="tsd-signature-type">HubInfo</a></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>
|
|
<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">
|
|
<a name="makeidentity" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> make<wbr>Identity</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">make<wbr>Identity<span class="tsd-signature-symbol">(</span>rootNode<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BIP32Interface</span>, index<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="classes/identity.html" class="tsd-signature-type">Identity</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/keychain/src/utils/index.ts#L135">packages/keychain/src/utils/index.ts:135</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>rootNode: <span class="tsd-signature-type">BIP32Interface</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>index: <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="classes/identity.html" class="tsd-signature-type">Identity</a><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="makekeychain" class="tsd-anchor"></a>
|
|
<h3>make<wbr>Keychain</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">make<wbr>Keychain<span class="tsd-signature-symbol">(</span>network<span class="tsd-signature-symbol">: </span><a href="classes/clinetworkadapter.html" class="tsd-signature-type">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></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#L331">packages/cli/src/cli.ts:331</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>network: <a href="classes/clinetworkadapter.html" class="tsd-signature-type">CLINetworkAdapter</a></h5>
|
|
</li>
|
|
<li>
|
|
<h5>args: <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-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">
|
|
<a name="makeprofilejwt" class="tsd-anchor"></a>
|
|
<h3>make<wbr>ProfileJWT</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<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#L470">packages/cli/src/utils.ts:470</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">
|
|
<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">
|
|
<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/clarityfunctionarg.html" class="tsd-signature-type">ClarityFunctionArg</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="interfaces/inquirerprompt.html" class="tsd-signature-type">InquirerPrompt</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#L784">packages/cli/src/utils.ts:784</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>expectedArgs: <a href="interfaces/clarityfunctionarg.html" class="tsd-signature-type">ClarityFunctionArg</a><span class="tsd-signature-symbol">[]</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="interfaces/inquirerprompt.html" class="tsd-signature-type">InquirerPrompt</a><span class="tsd-signature-symbol">[]</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="makerandomprivkey" class="tsd-anchor"></a>
|
|
<h3>make<wbr>Random<wbr>Priv<wbr>Key</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">make<wbr>Random<wbr>Priv<wbr>Key<span class="tsd-signature-symbol">(</span>entropy<span class="tsd-signature-symbol">?: </span><a href="enums/claritytype.html#buffer" class="tsd-signature-type">Buffer</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="interfaces/stacksprivatekey.html" class="tsd-signature-type">StacksPrivateKey</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/transactions/src/keys.ts#L142">packages/transactions/src/keys.ts:142</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> entropy: <a href="enums/claritytype.html#buffer" class="tsd-signature-type">Buffer</a></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="interfaces/stacksprivatekey.html" class="tsd-signature-type">StacksPrivateKey</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="makereadonlygaiaconfig" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> make<wbr>Read<wbr>Only<wbr>Gaia<wbr>Config</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">make<wbr>Read<wbr>Only<wbr>Gaia<wbr>Config<span class="tsd-signature-symbol">(</span>__namedParameters<span class="tsd-signature-symbol">: </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>readURL<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">GaiaHubConfig</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/keychain/src/utils/gaia.ts#L78">packages/keychain/src/utils/gaia.ts:78</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>When you already know the Gaia read URL, make a Gaia config that doesn't have to fetch <code>/hub_info</code></p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>__namedParameters: <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>readURL<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>private<wbr>Key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li class="tsd-parameter">
|
|
<h5>readURL<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">GaiaHubConfig</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="makestxtokentransfer" class="tsd-anchor"></a>
|
|
<h3>makeSTXToken<wbr>Transfer</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">makeSTXToken<wbr>Transfer<span class="tsd-signature-symbol">(</span>txOptions<span class="tsd-signature-symbol">: </span><a href="interfaces/signedtokentransferoptions.html" class="tsd-signature-type">SignedTokenTransferOptions</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/signedmultisigtokentransferoptions.html" class="tsd-signature-type">SignedMultiSigTokenTransferOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="classes/stackstransaction.html" class="tsd-signature-type">StacksTransaction</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/transactions/src/builders.ts#L396">packages/transactions/src/builders.ts:396</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Generates a signed Stacks token transfer transaction</p>
|
|
</div>
|
|
<p>Returns a signed Stacks token transfer transaction.</p>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>txOptions: <a href="interfaces/signedtokentransferoptions.html" class="tsd-signature-type">SignedTokenTransferOptions</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/signedmultisigtokentransferoptions.html" class="tsd-signature-type">SignedMultiSigTokenTransferOptions</a></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>an options object for the token transfer</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="classes/stackstransaction.html" class="tsd-signature-type">StacksTransaction</a><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="makesighashpostsign" class="tsd-anchor"></a>
|
|
<h3>make<wbr>Sig<wbr>Hash<wbr>Post<wbr>Sign</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">make<wbr>Sig<wbr>Hash<wbr>Post<wbr>Sign<span class="tsd-signature-symbol">(</span>curSigHash<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, pubKeyEncoding<span class="tsd-signature-symbol">: </span><a href="enums/pubkeyencoding.html" class="tsd-signature-type">PubKeyEncoding</a>, signature<span class="tsd-signature-symbol">: </span><a href="interfaces/messagesignature.html" class="tsd-signature-type">MessageSignature</a><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/transactions/src/authorization.ts#L338">packages/transactions/src/authorization.ts:338</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>curSigHash: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>pubKeyEncoding: <a href="enums/pubkeyencoding.html" class="tsd-signature-type">PubKeyEncoding</a></h5>
|
|
</li>
|
|
<li>
|
|
<h5>signature: <a href="interfaces/messagesignature.html" class="tsd-signature-type">MessageSignature</a></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">
|
|
<a name="makesighashpresign" class="tsd-anchor"></a>
|
|
<h3>make<wbr>Sig<wbr>Hash<wbr>Pre<wbr>Sign</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">make<wbr>Sig<wbr>Hash<wbr>Pre<wbr>Sign<span class="tsd-signature-symbol">(</span>curSigHash<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, authType<span class="tsd-signature-symbol">: </span><a href="enums/authtype.html" class="tsd-signature-type">AuthType</a>, fee<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BigNum</span>, nonce<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BigNum</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/transactions/src/authorization.ts#L311">packages/transactions/src/authorization.ts:311</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>curSigHash: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>authType: <a href="enums/authtype.html" class="tsd-signature-type">AuthType</a></h5>
|
|
</li>
|
|
<li>
|
|
<h5>fee: <span class="tsd-signature-type">BigNum</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>nonce: <span class="tsd-signature-type">BigNum</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">
|
|
<a name="makesigninlink" class="tsd-anchor"></a>
|
|
<h3>make<wbr>Sign<wbr>InLink</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">make<wbr>Sign<wbr>InLink<span class="tsd-signature-symbol">(</span>network<span class="tsd-signature-symbol">: </span><a href="classes/clinetworkadapter.html" class="tsd-signature-type">CLINetworkAdapter</a>, authPort<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, mnemonic<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, authRequest<span class="tsd-signature-symbol">: </span><a href="interfaces/authrequesttype.html" class="tsd-signature-type">AuthRequestType</a>, hubUrl<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, id<span class="tsd-signature-symbol">: </span><a href="interfaces/namedidentitytype.html" class="tsd-signature-type">NamedIdentityType</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</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/auth.ts#L123">packages/cli/src/auth.ts:123</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>network: <a href="classes/clinetworkadapter.html" class="tsd-signature-type">CLINetworkAdapter</a></h5>
|
|
</li>
|
|
<li>
|
|
<h5>authPort: <span class="tsd-signature-type">number</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>mnemonic: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>authRequest: <a href="interfaces/authrequesttype.html" class="tsd-signature-type">AuthRequestType</a></h5>
|
|
</li>
|
|
<li>
|
|
<h5>hubUrl: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>id: <a href="interfaces/namedidentitytype.html" class="tsd-signature-type">NamedIdentityType</a></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">
|
|
<a name="makestandardfungiblepostcondition" class="tsd-anchor"></a>
|
|
<h3>make<wbr>Standard<wbr>Fungible<wbr>Post<wbr>Condition</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">make<wbr>Standard<wbr>Fungible<wbr>Post<wbr>Condition<span class="tsd-signature-symbol">(</span>address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, conditionCode<span class="tsd-signature-symbol">: </span><a href="enums/fungibleconditioncode.html" class="tsd-signature-type">FungibleConditionCode</a>, amount<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BigNum</span>, assetInfo<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="interfaces/assetinfo.html" class="tsd-signature-type">AssetInfo</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="interfaces/fungiblepostcondition.html" class="tsd-signature-type">FungiblePostCondition</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/transactions/src/builders.ts#L904">packages/transactions/src/builders.ts:904</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Generates a fungible token post condition with a standard principal</p>
|
|
</div>
|
|
<p>Returns a fungible token post condition object</p>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>address: <span class="tsd-signature-type">string</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>the c32check address</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5>conditionCode: <a href="enums/fungibleconditioncode.html" class="tsd-signature-type">FungibleConditionCode</a></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>the condition code</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5>amount: <span class="tsd-signature-type">BigNum</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>the amount of fungible tokens</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5>assetInfo: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="interfaces/assetinfo.html" class="tsd-signature-type">AssetInfo</a></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>asset info describing the fungible token</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="interfaces/fungiblepostcondition.html" class="tsd-signature-type">FungiblePostCondition</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="makestandardnonfungiblepostcondition" class="tsd-anchor"></a>
|
|
<h3>make<wbr>Standard<wbr>Non<wbr>Fungible<wbr>Post<wbr>Condition</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">make<wbr>Standard<wbr>Non<wbr>Fungible<wbr>Post<wbr>Condition<span class="tsd-signature-symbol">(</span>address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, conditionCode<span class="tsd-signature-symbol">: </span><a href="enums/nonfungibleconditioncode.html" class="tsd-signature-type">NonFungibleConditionCode</a>, assetInfo<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="interfaces/assetinfo.html" class="tsd-signature-type">AssetInfo</a>, assetName<span class="tsd-signature-symbol">: </span><a href="globals.html#clarityvalue" class="tsd-signature-type">ClarityValue</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="interfaces/nonfungiblepostcondition.html" class="tsd-signature-type">NonFungiblePostCondition</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/transactions/src/builders.ts#L958">packages/transactions/src/builders.ts:958</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Generates a non-fungible token post condition with a standard principal</p>
|
|
</div>
|
|
<p>Returns a non-fungible token post condition object</p>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>address: <span class="tsd-signature-type">string</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>the c32check address</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5>conditionCode: <a href="enums/nonfungibleconditioncode.html" class="tsd-signature-type">NonFungibleConditionCode</a></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>the condition code</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5>assetInfo: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="interfaces/assetinfo.html" class="tsd-signature-type">AssetInfo</a></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>asset info describing the non-fungible token</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5>assetName: <a href="globals.html#clarityvalue" class="tsd-signature-type">ClarityValue</a></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>asset name describing the non-fungible token</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="interfaces/nonfungiblepostcondition.html" class="tsd-signature-type">NonFungiblePostCondition</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="makestandardstxpostcondition" class="tsd-anchor"></a>
|
|
<h3>make<wbr>StandardSTXPost<wbr>Condition</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">make<wbr>StandardSTXPost<wbr>Condition<span class="tsd-signature-symbol">(</span>address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, conditionCode<span class="tsd-signature-symbol">: </span><a href="enums/fungibleconditioncode.html" class="tsd-signature-type">FungibleConditionCode</a>, amount<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BigNum</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="interfaces/stxpostcondition.html" class="tsd-signature-type">STXPostCondition</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/transactions/src/builders.ts#L859">packages/transactions/src/builders.ts:859</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Generates a STX post condition with a standard principal</p>
|
|
</div>
|
|
<p>Returns a STX post condition object</p>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>address: <span class="tsd-signature-type">string</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>the c32check address</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5>conditionCode: <a href="enums/fungibleconditioncode.html" class="tsd-signature-type">FungibleConditionCode</a></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>the condition code</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5>amount: <span class="tsd-signature-type">BigNum</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>the amount of STX tokens</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="interfaces/stxpostcondition.html" class="tsd-signature-type">STXPostCondition</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="makeunsignedcontractcall" class="tsd-anchor"></a>
|
|
<h3>make<wbr>Unsigned<wbr>Contract<wbr>Call</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">make<wbr>Unsigned<wbr>Contract<wbr>Call<span class="tsd-signature-symbol">(</span>txOptions<span class="tsd-signature-symbol">: </span><a href="interfaces/unsignedcontractcalloptions.html" class="tsd-signature-type">UnsignedContractCallOptions</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/unsignedmultisigcontractcalloptions.html" class="tsd-signature-type">UnsignedMultiSigContractCallOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="classes/stackstransaction.html" class="tsd-signature-type">StacksTransaction</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/transactions/src/builders.ts#L706">packages/transactions/src/builders.ts:706</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Generates an unsigned Clarity smart contract function call transaction</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>txOptions: <a href="interfaces/unsignedcontractcalloptions.html" class="tsd-signature-type">UnsignedContractCallOptions</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/unsignedmultisigcontractcalloptions.html" class="tsd-signature-type">UnsignedMultiSigContractCallOptions</a></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>an options object for the contract call</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="classes/stackstransaction.html" class="tsd-signature-type">StacksTransaction</a><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="makeunsignedstxtokentransfer" class="tsd-anchor"></a>
|
|
<h3>make<wbr>UnsignedSTXToken<wbr>Transfer</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">make<wbr>UnsignedSTXToken<wbr>Transfer<span class="tsd-signature-symbol">(</span>txOptions<span class="tsd-signature-symbol">: </span><a href="interfaces/unsignedtokentransferoptions.html" class="tsd-signature-type">UnsignedTokenTransferOptions</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/unsignedmultisigtokentransferoptions.html" class="tsd-signature-type">UnsignedMultiSigTokenTransferOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="classes/stackstransaction.html" class="tsd-signature-type">StacksTransaction</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/transactions/src/builders.ts#L306">packages/transactions/src/builders.ts:306</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Generates an unsigned Stacks token transfer transaction</p>
|
|
</div>
|
|
<p>Returns a Stacks token transfer transaction.</p>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>txOptions: <a href="interfaces/unsignedtokentransferoptions.html" class="tsd-signature-type">UnsignedTokenTransferOptions</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/unsignedmultisigtokentransferoptions.html" class="tsd-signature-type">UnsignedMultiSigTokenTransferOptions</a></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>an options object for the token transfer</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="classes/stackstransaction.html" class="tsd-signature-type">StacksTransaction</a><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="makeusagestring" class="tsd-anchor"></a>
|
|
<h3>make<wbr>Usage<wbr>String</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<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#L3017">packages/cli/src/argparse.ts:3017</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">
|
|
<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">
|
|
<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/clinetworkadapter.html" class="tsd-signature-type">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/clinetworkadapter.html" class="tsd-signature-type">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">
|
|
<a name="matchtype" class="tsd-anchor"></a>
|
|
<h3>match<wbr>Type</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">match<wbr>Type<span class="tsd-signature-symbol">(</span>cv<span class="tsd-signature-symbol">: </span><a href="globals.html#clarityvalue" class="tsd-signature-type">ClarityValue</a>, abiType<span class="tsd-signature-symbol">: </span><a href="globals.html#clarityabitype" class="tsd-signature-type">ClarityAbiType</a><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/transactions/src/contract-abi.ts#L274">packages/transactions/src/contract-abi.ts:274</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>cv: <a href="globals.html#clarityvalue" class="tsd-signature-type">ClarityValue</a></h5>
|
|
</li>
|
|
<li>
|
|
<h5>abiType: <a href="globals.html#clarityabitype" class="tsd-signature-type">ClarityAbiType</a></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">
|
|
<a name="mkdirs" class="tsd-anchor"></a>
|
|
<h3>mkdirs</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<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#L684">packages/cli/src/utils.ts:684</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">
|
|
<a name="namelookup" class="tsd-anchor"></a>
|
|
<h3>name<wbr>Lookup</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<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/clinetworkadapter.html" class="tsd-signature-type">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">undefined</span><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">undefined</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></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#L574">packages/cli/src/utils.ts:574</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>network: <a href="classes/clinetworkadapter.html" class="tsd-signature-type">CLINetworkAdapter</a></h5>
|
|
</li>
|
|
<li>
|
|
<h5>name: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> 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">undefined</span><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">undefined</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></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="newinitialsighash" class="tsd-anchor"></a>
|
|
<h3>new<wbr>Initial<wbr>Sig<wbr>Hash</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">new<wbr>Initial<wbr>Sig<wbr>Hash<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="globals.html#spendingcondition" class="tsd-signature-type">SpendingCondition</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/transactions/src/authorization.ts#L404">packages/transactions/src/authorization.ts:404</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-returns-title">Returns <a href="globals.html#spendingcondition" class="tsd-signature-type">SpendingCondition</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="nextsignature" class="tsd-anchor"></a>
|
|
<h3>next<wbr>Signature</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">next<wbr>Signature<span class="tsd-signature-symbol">(</span>curSigHash<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, authType<span class="tsd-signature-symbol">: </span><a href="enums/authtype.html" class="tsd-signature-type">AuthType</a>, fee<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BigNum</span>, nonce<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BigNum</span>, privateKey<span class="tsd-signature-symbol">: </span><a href="interfaces/stacksprivatekey.html" class="tsd-signature-type">StacksPrivateKey</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>nextSig<span class="tsd-signature-symbol">: </span><a href="interfaces/messagesignature.html" class="tsd-signature-type">MessageSignature</a><span class="tsd-signature-symbol">; </span>nextSigHash<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/transactions/src/authorization.ts#L358">packages/transactions/src/authorization.ts:358</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>curSigHash: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>authType: <a href="enums/authtype.html" class="tsd-signature-type">AuthType</a></h5>
|
|
</li>
|
|
<li>
|
|
<h5>fee: <span class="tsd-signature-type">BigNum</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>nonce: <span class="tsd-signature-type">BigNum</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>privateKey: <a href="interfaces/stacksprivatekey.html" class="tsd-signature-type">StacksPrivateKey</a></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{ </span>nextSig<span class="tsd-signature-symbol">: </span><a href="interfaces/messagesignature.html" class="tsd-signature-type">MessageSignature</a><span class="tsd-signature-symbol">; </span>nextSigHash<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></h4>
|
|
<ul class="tsd-parameters">
|
|
<li class="tsd-parameter">
|
|
<h5>next<wbr>Sig<span class="tsd-signature-symbol">: </span><a href="interfaces/messagesignature.html" class="tsd-signature-type">MessageSignature</a></h5>
|
|
</li>
|
|
<li class="tsd-parameter">
|
|
<h5>next<wbr>Sig<wbr>Hash<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="nextverification" class="tsd-anchor"></a>
|
|
<h3>next<wbr>Verification</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">next<wbr>Verification<span class="tsd-signature-symbol">(</span>initialSigHash<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, authType<span class="tsd-signature-symbol">: </span><a href="enums/authtype.html" class="tsd-signature-type">AuthType</a>, fee<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BigNum</span>, nonce<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BigNum</span>, pubKeyEncoding<span class="tsd-signature-symbol">: </span><a href="enums/pubkeyencoding.html" class="tsd-signature-type">PubKeyEncoding</a>, signature<span class="tsd-signature-symbol">: </span><a href="interfaces/messagesignature.html" class="tsd-signature-type">MessageSignature</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>nextSigHash<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>pubKey<span class="tsd-signature-symbol">: </span><a href="interfaces/stackspublickey.html" class="tsd-signature-type">StacksPublicKey</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/transactions/src/authorization.ts#L383">packages/transactions/src/authorization.ts:383</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>initialSigHash: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>authType: <a href="enums/authtype.html" class="tsd-signature-type">AuthType</a></h5>
|
|
</li>
|
|
<li>
|
|
<h5>fee: <span class="tsd-signature-type">BigNum</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>nonce: <span class="tsd-signature-type">BigNum</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>pubKeyEncoding: <a href="enums/pubkeyencoding.html" class="tsd-signature-type">PubKeyEncoding</a></h5>
|
|
</li>
|
|
<li>
|
|
<h5>signature: <a href="interfaces/messagesignature.html" class="tsd-signature-type">MessageSignature</a></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{ </span>nextSigHash<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>pubKey<span class="tsd-signature-symbol">: </span><a href="interfaces/stackspublickey.html" class="tsd-signature-type">StacksPublicKey</a><span class="tsd-signature-symbol"> }</span></h4>
|
|
<ul class="tsd-parameters">
|
|
<li class="tsd-parameter">
|
|
<h5>next<wbr>Sig<wbr>Hash<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li class="tsd-parameter">
|
|
<h5>pub<wbr>Key<span class="tsd-signature-symbol">: </span><a href="interfaces/stackspublickey.html" class="tsd-signature-type">StacksPublicKey</a></h5>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="nonecv" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> noneCV</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">noneCV<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="globals.html#optionalcv" class="tsd-signature-type">OptionalCV</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/transactions/src/clarity/types/optionalCV.ts#L14">packages/transactions/src/clarity/types/optionalCV.ts:14</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-returns-title">Returns <a href="globals.html#optionalcv" class="tsd-signature-type">OptionalCV</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-has-type-parameter">
|
|
<a name="omit" class="tsd-anchor"></a>
|
|
<h3>omit</h3>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-has-type-parameter">
|
|
<li class="tsd-signature tsd-kind-icon">omit<T, K><span class="tsd-signature-symbol">(</span>obj<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span>, prop<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">K</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Omit</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">K</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/transactions/src/utils.ts#L57">packages/transactions/src/utils.ts:57</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-type-parameters-title">Type parameters</h4>
|
|
<ul class="tsd-type-parameters">
|
|
<li>
|
|
<h4>T</h4>
|
|
</li>
|
|
<li>
|
|
<h4>K<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">keyof </span><span class="tsd-signature-type">any</span></h4>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>obj: <span class="tsd-signature-type">T</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>prop: <span class="tsd-signature-type">K</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Omit</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">K</span><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="optionalcvof" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> optionalCVOf</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">optionalCVOf<span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">?: </span><a href="globals.html#clarityvalue" class="tsd-signature-type">ClarityValue</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="globals.html#optionalcv" class="tsd-signature-type">OptionalCV</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/transactions/src/clarity/types/optionalCV.ts#L16">packages/transactions/src/clarity/types/optionalCV.ts:16</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> value: <a href="globals.html#clarityvalue" class="tsd-signature-type">ClarityValue</a></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="globals.html#optionalcv" class="tsd-signature-type">OptionalCV</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="parseassetinfostring" class="tsd-anchor"></a>
|
|
<h3>parse<wbr>Asset<wbr>Info<wbr>String</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">parse<wbr>Asset<wbr>Info<wbr>String<span class="tsd-signature-symbol">(</span>id<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/assetinfo.html" class="tsd-signature-type">AssetInfo</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/transactions/src/types.ts#L418">packages/transactions/src/types.ts:418</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Parse a fully qualified string that identifies the token type.</p>
|
|
</div>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>example</dt>
|
|
<dd><p>"SP13N5TE1FBBGRZD1FCM49QDGN32WAXM2E5F8WT2G.example-contract::example-token"</p>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>id: <span class="tsd-signature-type">string</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>String in the format <code>{address}.{contractName}::{assetName}</code></p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="interfaces/assetinfo.html" class="tsd-signature-type">AssetInfo</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<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">
|
|
<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/clarityfunctionarg.html" class="tsd-signature-type">ClarityFunctionArg</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="globals.html#clarityvalue" class="tsd-signature-type">ClarityValue</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#L849">packages/cli/src/utils.ts:849</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/clarityfunctionarg.html" class="tsd-signature-type">ClarityFunctionArg</a><span class="tsd-signature-symbol">[]</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="globals.html#clarityvalue" class="tsd-signature-type">ClarityValue</a><span class="tsd-signature-symbol">[]</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="parsemultisigkeys" class="tsd-anchor"></a>
|
|
<h3>parse<wbr>Multi<wbr>Sig<wbr>Keys</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<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/multisigkeysigner.html" class="tsd-signature-type">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#L253">packages/cli/src/utils.ts:253</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/multisigkeysigner.html" class="tsd-signature-type">MultiSigKeySigner</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="parsenullsigner" class="tsd-anchor"></a>
|
|
<h3>parse<wbr>Null<wbr>Signer</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<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/nullsigner.html" class="tsd-signature-type">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#L238">packages/cli/src/utils.ts:238</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/nullsigner.html" class="tsd-signature-type">NullSigner</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="parseprincipalstring" class="tsd-anchor"></a>
|
|
<h3>parse<wbr>Principal<wbr>String</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">parse<wbr>Principal<wbr>String<span class="tsd-signature-symbol">(</span>principalString<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/standardprincipal.html" class="tsd-signature-type">StandardPrincipal</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/contractprincipal.html" class="tsd-signature-type">ContractPrincipal</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/transactions/src/types.ts#L261">packages/transactions/src/types.ts:261</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Parses a principal string for either a standard principal or contract principal.</p>
|
|
</div>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>example</dt>
|
|
<dd><p>"SP13N5TE1FBBGRZD1FCM49QDGN32WAXM2E5F8WT2G.example-contract"</p>
|
|
</dd>
|
|
<dt>example</dt>
|
|
<dd><p>"SP13N5TE1FBBGRZD1FCM49QDGN32WAXM2E5F8WT2G"</p>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>principalString: <span class="tsd-signature-type">string</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>String in the format <code>{address}.{contractName}</code></p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="interfaces/standardprincipal.html" class="tsd-signature-type">StandardPrincipal</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/contractprincipal.html" class="tsd-signature-type">ContractPrincipal</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="parsereadonlyresponse" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> parse<wbr>Read<wbr>Only<wbr>Response</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">parse<wbr>Read<wbr>Only<wbr>Response<span class="tsd-signature-symbol">(</span>response<span class="tsd-signature-symbol">: </span><a href="globals.html#readonlyfunctionresponse" class="tsd-signature-type">ReadOnlyFunctionResponse</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="globals.html#clarityvalue" class="tsd-signature-type">ClarityValue</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/transactions/src/utils.ts#L194">packages/transactions/src/utils.ts:194</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Converts the response of a read-only function call into its Clarity Value</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>response: <a href="globals.html#readonlyfunctionresponse" class="tsd-signature-type">ReadOnlyFunctionResponse</a></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="globals.html#clarityvalue" class="tsd-signature-type">ClarityValue</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="parserecoverablesignature" class="tsd-anchor"></a>
|
|
<h3>parse<wbr>Recoverable<wbr>Signature</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">parse<wbr>Recoverable<wbr>Signature<span class="tsd-signature-symbol">(</span>signature<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>r<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>recoveryParam<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>s<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/transactions/src/keys.ts#L175">packages/transactions/src/keys.ts:175</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>signature: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{ </span>r<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>recoveryParam<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>s<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></h4>
|
|
<ul class="tsd-parameters">
|
|
<li class="tsd-parameter">
|
|
<h5>r<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li class="tsd-parameter">
|
|
<h5>recovery<wbr>Param<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
|
|
</li>
|
|
<li class="tsd-parameter">
|
|
<h5>s<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="parsesegwitp2shkeys" class="tsd-anchor"></a>
|
|
<h3>parse<wbr>Segwit<wbr>P2SHKeys</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<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/segwitp2shkeysigner.html" class="tsd-signature-type">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#L291">packages/cli/src/utils.ts:291</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/segwitp2shkeysigner.html" class="tsd-signature-type">SegwitP2SHKeySigner</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="parsetocv" class="tsd-anchor"></a>
|
|
<h3>parse<wbr>ToCV</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">parse<wbr>ToCV<span class="tsd-signature-symbol">(</span>input<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, type<span class="tsd-signature-symbol">: </span><a href="globals.html#clarityabitype" class="tsd-signature-type">ClarityAbiType</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="globals.html#clarityvalue" class="tsd-signature-type">ClarityValue</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/transactions/src/contract-abi.ts#L416">packages/transactions/src/contract-abi.ts:416</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Convert string input to Clarity value based on contract ABI data. Only handles Clarity
|
|
primitives and buffers. Responses, optionals, tuples and lists are not supported.</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>input: <span class="tsd-signature-type">string</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>string to be parsed into Clarity value</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5>type: <a href="globals.html#clarityabitype" class="tsd-signature-type">ClarityAbiType</a></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>the contract function argument object</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="globals.html#clarityvalue" class="tsd-signature-type">ClarityValue</a></h4>
|
|
<p>returns a Clarity value</p>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="principalcv" class="tsd-anchor"></a>
|
|
<h3>principalCV</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">principalCV<span class="tsd-signature-symbol">(</span>principal<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="globals.html#principalcv" class="tsd-signature-type">PrincipalCV</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/transactions/src/clarity/types/principalCV.ts#L34">packages/transactions/src/clarity/types/principalCV.ts:34</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>principal: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="globals.html#principalcv" class="tsd-signature-type">PrincipalCV</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="principaltostring" class="tsd-anchor"></a>
|
|
<h3>principal<wbr>ToString</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">principal<wbr>ToString<span class="tsd-signature-symbol">(</span>principal<span class="tsd-signature-symbol">: </span><a href="globals.html#principalcv" class="tsd-signature-type">PrincipalCV</a><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/transactions/src/clarity/types/principalCV.ts#L23">packages/transactions/src/clarity/types/principalCV.ts:23</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>principal: <a href="globals.html#principalcv" class="tsd-signature-type">PrincipalCV</a></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">
|
|
<a name="printdocs" class="tsd-anchor"></a>
|
|
<h3>print<wbr>Docs</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">print<wbr>Docs<span class="tsd-signature-symbol">(</span>_network<span class="tsd-signature-symbol">: </span><a href="classes/clinetworkadapter.html" class="tsd-signature-type">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></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#L1683">packages/cli/src/cli.ts:1683</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>_network: <a href="classes/clinetworkadapter.html" class="tsd-signature-type">CLINetworkAdapter</a></h5>
|
|
</li>
|
|
<li>
|
|
<h5>_args: <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-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">
|
|
<a name="printusage" class="tsd-anchor"></a>
|
|
<h3>print<wbr>Usage</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<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#L3052">packages/cli/src/argparse.ts:3052</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">
|
|
<a name="privatekeytostring" class="tsd-anchor"></a>
|
|
<h3>private<wbr>Key<wbr>ToString</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">private<wbr>Key<wbr>ToString<span class="tsd-signature-symbol">(</span>privateKey<span class="tsd-signature-symbol">: </span><a href="interfaces/stacksprivatekey.html" class="tsd-signature-type">StacksPrivateKey</a><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/transactions/src/keys.ts#L194">packages/transactions/src/keys.ts:194</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>privateKey: <a href="interfaces/stacksprivatekey.html" class="tsd-signature-type">StacksPrivateKey</a></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">
|
|
<a name="profilesign" class="tsd-anchor"></a>
|
|
<h3>profile<wbr>Sign</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">profile<wbr>Sign<span class="tsd-signature-symbol">(</span>network<span class="tsd-signature-symbol">: </span><a href="classes/clinetworkadapter.html" class="tsd-signature-type">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></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#L152">packages/cli/src/cli.ts:152</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>network: <a href="classes/clinetworkadapter.html" class="tsd-signature-type">CLINetworkAdapter</a></h5>
|
|
</li>
|
|
<li>
|
|
<h5>args: <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-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">
|
|
<a name="profilestore" class="tsd-anchor"></a>
|
|
<h3>profile<wbr>Store</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">profile<wbr>Store<span class="tsd-signature-symbol">(</span>network<span class="tsd-signature-symbol">: </span><a href="classes/clinetworkadapter.html" class="tsd-signature-type">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></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#L206">packages/cli/src/cli.ts:206</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>network: <a href="classes/clinetworkadapter.html" class="tsd-signature-type">CLINetworkAdapter</a></h5>
|
|
</li>
|
|
<li>
|
|
<h5>args: <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-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">
|
|
<a name="profileverify" class="tsd-anchor"></a>
|
|
<h3>profile<wbr>Verify</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">profile<wbr>Verify<span class="tsd-signature-symbol">(</span>network<span class="tsd-signature-symbol">: </span><a href="classes/clinetworkadapter.html" class="tsd-signature-type">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></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#L163">packages/cli/src/cli.ts:163</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>network: <a href="classes/clinetworkadapter.html" class="tsd-signature-type">CLINetworkAdapter</a></h5>
|
|
</li>
|
|
<li>
|
|
<h5>args: <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-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">
|
|
<a name="pubkeyfromprivkey" class="tsd-anchor"></a>
|
|
<h3>pub<wbr>Keyfrom<wbr>Priv<wbr>Key</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">pub<wbr>Keyfrom<wbr>Priv<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-type">Buffer</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="interfaces/stackspublickey.html" class="tsd-signature-type">StacksPublicKey</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/transactions/src/keys.ts#L99">packages/transactions/src/keys.ts:99</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><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Buffer</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="interfaces/stackspublickey.html" class="tsd-signature-type">StacksPublicKey</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="publickeyfrombuffer" class="tsd-anchor"></a>
|
|
<h3>public<wbr>Key<wbr>From<wbr>Buffer</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">public<wbr>Key<wbr>From<wbr>Buffer<span class="tsd-signature-symbol">(</span>data<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><a href="interfaces/stackspublickey.html" class="tsd-signature-type">StacksPublicKey</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/transactions/src/keys.ts#L81">packages/transactions/src/keys.ts:81</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>data: <span class="tsd-signature-type">Buffer</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="interfaces/stackspublickey.html" class="tsd-signature-type">StacksPublicKey</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="publickeyfromsignature" class="tsd-anchor"></a>
|
|
<h3>public<wbr>Key<wbr>From<wbr>Signature</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">public<wbr>Key<wbr>From<wbr>Signature<span class="tsd-signature-symbol">(</span>message<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, messageSignature<span class="tsd-signature-symbol">: </span><a href="interfaces/messagesignature.html" class="tsd-signature-type">MessageSignature</a><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/transactions/src/keys.ts#L62">packages/transactions/src/keys.ts:62</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>message: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>messageSignature: <a href="interfaces/messagesignature.html" class="tsd-signature-type">MessageSignature</a></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">
|
|
<a name="publickeytostring" class="tsd-anchor"></a>
|
|
<h3>public<wbr>Key<wbr>ToString</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">public<wbr>Key<wbr>ToString<span class="tsd-signature-symbol">(</span>key<span class="tsd-signature-symbol">: </span><a href="interfaces/stackspublickey.html" class="tsd-signature-type">StacksPublicKey</a><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/transactions/src/keys.ts#L89">packages/transactions/src/keys.ts:89</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>key: <a href="interfaces/stackspublickey.html" class="tsd-signature-type">StacksPublicKey</a></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">
|
|
<a name="readonlycontractfunctioncall" class="tsd-anchor"></a>
|
|
<h3>read<wbr>Only<wbr>Contract<wbr>Function<wbr>Call</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">read<wbr>Only<wbr>Contract<wbr>Function<wbr>Call<span class="tsd-signature-symbol">(</span>network<span class="tsd-signature-symbol">: </span><a href="classes/clinetworkadapter.html" class="tsd-signature-type">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></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#L741">packages/cli/src/cli.ts:741</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>network: <a href="classes/clinetworkadapter.html" class="tsd-signature-type">CLINetworkAdapter</a></h5>
|
|
</li>
|
|
<li>
|
|
<h5>args: <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-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">
|
|
<a name="recursiverestoreidentities" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> recursive<wbr>Restore<wbr>Identities</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">recursive<wbr>Restore<wbr>Identities<span class="tsd-signature-symbol">(</span>__namedParameters<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>identities<span class="tsd-signature-symbol">: </span><a href="classes/identity.html" class="tsd-signature-type">Identity</a><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>rootNode<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BIP32Interface</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><a href="classes/identity.html" class="tsd-signature-type">Identity</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/keychain/src/utils/index.ts#L204">packages/keychain/src/utils/index.ts:204</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Restore identities by recursively making a new identity, and checking if it has a username.</p>
|
|
</div>
|
|
<p>As soon as a username is not found for an identity, the recursion stops.</p>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>__namedParameters: <span class="tsd-signature-symbol">{ </span>identities<span class="tsd-signature-symbol">: </span><a href="classes/identity.html" class="tsd-signature-type">Identity</a><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>rootNode<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BIP32Interface</span><span class="tsd-signature-symbol"> }</span></h5>
|
|
<ul class="tsd-parameters">
|
|
<li class="tsd-parameter">
|
|
<h5>identities<span class="tsd-signature-symbol">: </span><a href="classes/identity.html" class="tsd-signature-type">Identity</a><span class="tsd-signature-symbol">[]</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>root<wbr>Node<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BIP32Interface</span></h5>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="classes/identity.html" class="tsd-signature-type">Identity</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">
|
|
<a name="registersubdomain" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> register<wbr>Subdomain</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">register<wbr>Subdomain<span class="tsd-signature-symbol">(</span>__namedParameters<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>gaiaHubUrl<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>identity<span class="tsd-signature-symbol">: </span><a href="classes/identity.html" class="tsd-signature-type">Identity</a><span class="tsd-signature-symbol">; </span>subdomain<span class="tsd-signature-symbol">: </span><a href="enums/subdomains.html" class="tsd-signature-type">Subdomains</a><span class="tsd-signature-symbol">; </span>username<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><a href="classes/identity.html" class="tsd-signature-type">Identity</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/keychain/src/profiles.ts#L140">packages/keychain/src/profiles.ts:140</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Register a subdomain for a given identity</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>__namedParameters: <span class="tsd-signature-symbol">{ </span>gaiaHubUrl<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>identity<span class="tsd-signature-symbol">: </span><a href="classes/identity.html" class="tsd-signature-type">Identity</a><span class="tsd-signature-symbol">; </span>subdomain<span class="tsd-signature-symbol">: </span><a href="enums/subdomains.html" class="tsd-signature-type">Subdomains</a><span class="tsd-signature-symbol">; </span>username<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>gaia<wbr>Hub<wbr>Url<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li class="tsd-parameter">
|
|
<h5>identity<span class="tsd-signature-symbol">: </span><a href="classes/identity.html" class="tsd-signature-type">Identity</a></h5>
|
|
</li>
|
|
<li class="tsd-parameter">
|
|
<h5>subdomain<span class="tsd-signature-symbol">: </span><a href="enums/subdomains.html" class="tsd-signature-type">Subdomains</a></h5>
|
|
</li>
|
|
<li class="tsd-parameter">
|
|
<h5>username<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="classes/identity.html" class="tsd-signature-type">Identity</a><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="responseerrorcv" class="tsd-anchor"></a>
|
|
<h3>response<wbr>ErrorCV</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">response<wbr>ErrorCV<span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">: </span><a href="globals.html#clarityvalue" class="tsd-signature-type">ClarityValue</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="interfaces/responseerrorcv.html" class="tsd-signature-type">ResponseErrorCV</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/transactions/src/clarity/types/responseCV.ts#L15">packages/transactions/src/clarity/types/responseCV.ts:15</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>value: <a href="globals.html#clarityvalue" class="tsd-signature-type">ClarityValue</a></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="interfaces/responseerrorcv.html" class="tsd-signature-type">ResponseErrorCV</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="responseokcv" class="tsd-anchor"></a>
|
|
<h3>response<wbr>OkCV</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">response<wbr>OkCV<span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">: </span><a href="globals.html#clarityvalue" class="tsd-signature-type">ClarityValue</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="interfaces/responseokcv.html" class="tsd-signature-type">ResponseOkCV</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/transactions/src/clarity/types/responseCV.ts#L19">packages/transactions/src/clarity/types/responseCV.ts:19</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>value: <a href="globals.html#clarityvalue" class="tsd-signature-type">ClarityValue</a></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="interfaces/responseokcv.html" class="tsd-signature-type">ResponseOkCV</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="rightpadhextolength" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> right<wbr>Pad<wbr>Hex<wbr>ToLength</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">right<wbr>Pad<wbr>Hex<wbr>ToLength<span class="tsd-signature-symbol">(</span>hexString<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, length<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">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/transactions/src/utils.ts#L42">packages/transactions/src/utils.ts:42</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>hexString: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>length: <span class="tsd-signature-type">number</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">
|
|
<a name="sendjson" class="tsd-anchor"></a>
|
|
<h3>sendJSON</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">sendJSON<span class="tsd-signature-symbol">(</span>res<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">express.Response</span>, data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Object</span>, statusCode<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">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/auth.ts#L291">packages/cli/src/auth.ts:291</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>res: <span class="tsd-signature-type">express.Response</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>data: <span class="tsd-signature-type">Object</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>statusCode: <span class="tsd-signature-type">number</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">
|
|
<a name="sendtokens" class="tsd-anchor"></a>
|
|
<h3>send<wbr>Tokens</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">send<wbr>Tokens<span class="tsd-signature-symbol">(</span>network<span class="tsd-signature-symbol">: </span><a href="classes/clinetworkadapter.html" class="tsd-signature-type">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></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#L534">packages/cli/src/cli.ts:534</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>network: <a href="classes/clinetworkadapter.html" class="tsd-signature-type">CLINetworkAdapter</a></h5>
|
|
</li>
|
|
<li>
|
|
<h5>args: <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-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">
|
|
<a name="sendusernametoregistrar" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> send<wbr>Username<wbr>ToRegistrar</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">send<wbr>Username<wbr>ToRegistrar<span class="tsd-signature-symbol">(</span>__namedParameters<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>identity<span class="tsd-signature-symbol">: </span><a href="classes/identity.html" class="tsd-signature-type">Identity</a><span class="tsd-signature-symbol">; </span>subdomain<span class="tsd-signature-symbol">: </span><a href="enums/subdomains.html" class="tsd-signature-type">Subdomains</a><span class="tsd-signature-symbol">; </span>username<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><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/keychain/src/profiles.ts#L92">packages/keychain/src/profiles.ts:92</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>__namedParameters: <span class="tsd-signature-symbol">{ </span>identity<span class="tsd-signature-symbol">: </span><a href="classes/identity.html" class="tsd-signature-type">Identity</a><span class="tsd-signature-symbol">; </span>subdomain<span class="tsd-signature-symbol">: </span><a href="enums/subdomains.html" class="tsd-signature-type">Subdomains</a><span class="tsd-signature-symbol">; </span>username<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></h5>
|
|
<ul class="tsd-parameters">
|
|
<li class="tsd-parameter">
|
|
<h5>identity<span class="tsd-signature-symbol">: </span><a href="classes/identity.html" class="tsd-signature-type">Identity</a></h5>
|
|
</li>
|
|
<li class="tsd-parameter">
|
|
<h5>subdomain<span class="tsd-signature-symbol">: </span><a href="enums/subdomains.html" class="tsd-signature-type">Subdomains</a></h5>
|
|
</li>
|
|
<li class="tsd-parameter">
|
|
<h5>username<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li class="tsd-parameter">
|
|
<h5>zone<wbr>File<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
</ul>
|
|
</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">
|
|
<a name="serializeaddress" class="tsd-anchor"></a>
|
|
<h3>serialize<wbr>Address</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">serialize<wbr>Address<span class="tsd-signature-symbol">(</span>address<span class="tsd-signature-symbol">: </span><a href="interfaces/address.html" class="tsd-signature-type">Address</a><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/transactions/src/types.ts#L225">packages/transactions/src/types.ts:225</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>address: <a href="interfaces/address.html" class="tsd-signature-type">Address</a></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">
|
|
<a name="serializeassetinfo" class="tsd-anchor"></a>
|
|
<h3>serialize<wbr>Asset<wbr>Info</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">serialize<wbr>Asset<wbr>Info<span class="tsd-signature-symbol">(</span>info<span class="tsd-signature-symbol">: </span><a href="interfaces/assetinfo.html" class="tsd-signature-type">AssetInfo</a><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/transactions/src/types.ts#L437">packages/transactions/src/types.ts:437</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>info: <a href="interfaces/assetinfo.html" class="tsd-signature-type">AssetInfo</a></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">
|
|
<a name="serializeboolcv" class="tsd-anchor"></a>
|
|
<h3>serialize<wbr>BoolCV</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">serialize<wbr>BoolCV<span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">: </span><a href="globals.html#booleancv" class="tsd-signature-type">BooleanCV</a><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/transactions/src/clarity/serialize.ts#L25">packages/transactions/src/clarity/serialize.ts:25</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>value: <a href="globals.html#booleancv" class="tsd-signature-type">BooleanCV</a></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">
|
|
<a name="serializebuffercv" class="tsd-anchor"></a>
|
|
<h3>serialize<wbr>BufferCV</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">serialize<wbr>BufferCV<span class="tsd-signature-symbol">(</span>cv<span class="tsd-signature-symbol">: </span><a href="interfaces/buffercv.html" class="tsd-signature-type">BufferCV</a><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/transactions/src/clarity/serialize.ts#L37">packages/transactions/src/clarity/serialize.ts:37</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>cv: <a href="interfaces/buffercv.html" class="tsd-signature-type">BufferCV</a></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">
|
|
<a name="serializecv" class="tsd-anchor"></a>
|
|
<h3>serializeCV</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">serializeCV<span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">: </span><a href="globals.html#clarityvalue" class="tsd-signature-type">ClarityValue</a><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/transactions/src/clarity/serialize.ts#L123">packages/transactions/src/clarity/serialize.ts:123</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>value: <a href="globals.html#clarityvalue" class="tsd-signature-type">ClarityValue</a></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">
|
|
<a name="serializecontractprincipalcv" class="tsd-anchor"></a>
|
|
<h3>serialize<wbr>Contract<wbr>PrincipalCV</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">serialize<wbr>Contract<wbr>PrincipalCV<span class="tsd-signature-symbol">(</span>cv<span class="tsd-signature-symbol">: </span><a href="interfaces/contractprincipalcv.html" class="tsd-signature-type">ContractPrincipalCV</a><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/transactions/src/clarity/serialize.ts#L52">packages/transactions/src/clarity/serialize.ts:52</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>cv: <a href="interfaces/contractprincipalcv.html" class="tsd-signature-type">ContractPrincipalCV</a></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">
|
|
<a name="serializeintcv" class="tsd-anchor"></a>
|
|
<h3>serialize<wbr>IntCV</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">serialize<wbr>IntCV<span class="tsd-signature-symbol">(</span>cv<span class="tsd-signature-symbol">: </span><a href="interfaces/intcv.html" class="tsd-signature-type">IntCV</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/uintcv.html" class="tsd-signature-type">UIntCV</a><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/transactions/src/clarity/serialize.ts#L43">packages/transactions/src/clarity/serialize.ts:43</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>cv: <a href="interfaces/intcv.html" class="tsd-signature-type">IntCV</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/uintcv.html" class="tsd-signature-type">UIntCV</a></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">
|
|
<a name="serializelplist" class="tsd-anchor"></a>
|
|
<h3>serializeLPList</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">serializeLPList<span class="tsd-signature-symbol">(</span>lpList<span class="tsd-signature-symbol">: </span><a href="interfaces/lengthprefixedlist.html" class="tsd-signature-type">LengthPrefixedList</a><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/transactions/src/types.ts#L471">packages/transactions/src/types.ts:471</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>lpList: <a href="interfaces/lengthprefixedlist.html" class="tsd-signature-type">LengthPrefixedList</a></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">
|
|
<a name="serializelpstring" class="tsd-anchor"></a>
|
|
<h3>serializeLPString</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">serializeLPString<span class="tsd-signature-symbol">(</span>lps<span class="tsd-signature-symbol">: </span><a href="interfaces/lengthprefixedstring.html" class="tsd-signature-type">LengthPrefixedString</a><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/transactions/src/types.ts#L354">packages/transactions/src/types.ts:354</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>lps: <a href="interfaces/lengthprefixedstring.html" class="tsd-signature-type">LengthPrefixedString</a></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">
|
|
<a name="serializelistcv" class="tsd-anchor"></a>
|
|
<h3>serialize<wbr>ListCV</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">serialize<wbr>ListCV<span class="tsd-signature-symbol">(</span>cv<span class="tsd-signature-symbol">: </span><a href="interfaces/listcv.html" class="tsd-signature-type">ListCV</a><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/transactions/src/clarity/serialize.ts#L63">packages/transactions/src/clarity/serialize.ts:63</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>cv: <a href="interfaces/listcv.html" class="tsd-signature-type">ListCV</a></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">
|
|
<a name="serializememostring" class="tsd-anchor"></a>
|
|
<h3>serialize<wbr>Memo<wbr>String</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">serialize<wbr>Memo<wbr>String<span class="tsd-signature-symbol">(</span>memoString<span class="tsd-signature-symbol">: </span><a href="interfaces/memostring.html" class="tsd-signature-type">MemoString</a><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/transactions/src/types.ts#L390">packages/transactions/src/types.ts:390</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>memoString: <a href="interfaces/memostring.html" class="tsd-signature-type">MemoString</a></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">
|
|
<a name="serializemessagesignature" class="tsd-anchor"></a>
|
|
<h3>serialize<wbr>Message<wbr>Signature</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">serialize<wbr>Message<wbr>Signature<span class="tsd-signature-symbol">(</span>messageSignature<span class="tsd-signature-symbol">: </span><a href="interfaces/messagesignature.html" class="tsd-signature-type">MessageSignature</a><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/transactions/src/authorization.ts#L71">packages/transactions/src/authorization.ts:71</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>messageSignature: <a href="interfaces/messagesignature.html" class="tsd-signature-type">MessageSignature</a></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">
|
|
<a name="serializemultisigspendingcondition" class="tsd-anchor"></a>
|
|
<h3>serialize<wbr>Multi<wbr>Sig<wbr>Spending<wbr>Condition</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">serialize<wbr>Multi<wbr>Sig<wbr>Spending<wbr>Condition<span class="tsd-signature-symbol">(</span>condition<span class="tsd-signature-symbol">: </span><a href="interfaces/multisigspendingcondition.html" class="tsd-signature-type">MultiSigSpendingCondition</a><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/transactions/src/authorization.ts#L229">packages/transactions/src/authorization.ts:229</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>condition: <a href="interfaces/multisigspendingcondition.html" class="tsd-signature-type">MultiSigSpendingCondition</a></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">
|
|
<a name="serializeoptionalcv" class="tsd-anchor"></a>
|
|
<h3>serialize<wbr>OptionalCV</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">serialize<wbr>OptionalCV<span class="tsd-signature-symbol">(</span>cv<span class="tsd-signature-symbol">: </span><a href="globals.html#optionalcv" class="tsd-signature-type">OptionalCV</a><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/transactions/src/clarity/serialize.ts#L29">packages/transactions/src/clarity/serialize.ts:29</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>cv: <a href="globals.html#optionalcv" class="tsd-signature-type">OptionalCV</a></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">
|
|
<a name="serializepayload" class="tsd-anchor"></a>
|
|
<h3>serialize<wbr>Payload</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">serialize<wbr>Payload<span class="tsd-signature-symbol">(</span>payload<span class="tsd-signature-symbol">: </span><a href="enums/stacksmessagetype.html#payload" class="tsd-signature-type">Payload</a><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/transactions/src/payload.ts#L144">packages/transactions/src/payload.ts:144</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>payload: <a href="enums/stacksmessagetype.html#payload" class="tsd-signature-type">Payload</a></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">
|
|
<a name="serializepostcondition" class="tsd-anchor"></a>
|
|
<h3>serialize<wbr>Post<wbr>Condition</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">serialize<wbr>Post<wbr>Condition<span class="tsd-signature-symbol">(</span>postCondition<span class="tsd-signature-symbol">: </span><a href="enums/stacksmessagetype.html#postcondition" class="tsd-signature-type">PostCondition</a><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/transactions/src/postcondition.ts#L120">packages/transactions/src/postcondition.ts:120</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>postCondition: <a href="enums/stacksmessagetype.html#postcondition" class="tsd-signature-type">PostCondition</a></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">
|
|
<a name="serializeprincipal" class="tsd-anchor"></a>
|
|
<h3>serialize<wbr>Principal</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">serialize<wbr>Principal<span class="tsd-signature-symbol">(</span>principal<span class="tsd-signature-symbol">: </span><a href="globals.html#postconditionprincipal" class="tsd-signature-type">PostConditionPrincipal</a><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/transactions/src/types.ts#L295">packages/transactions/src/types.ts:295</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>principal: <a href="globals.html#postconditionprincipal" class="tsd-signature-type">PostConditionPrincipal</a></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">
|
|
<a name="serializepublickey" class="tsd-anchor"></a>
|
|
<h3>serialize<wbr>Public<wbr>Key</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">serialize<wbr>Public<wbr>Key<span class="tsd-signature-symbol">(</span>key<span class="tsd-signature-symbol">: </span><a href="interfaces/stackspublickey.html" class="tsd-signature-type">StacksPublicKey</a><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/transactions/src/keys.ts#L93">packages/transactions/src/keys.ts:93</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>key: <a href="interfaces/stackspublickey.html" class="tsd-signature-type">StacksPublicKey</a></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">
|
|
<a name="serializeresponsecv" class="tsd-anchor"></a>
|
|
<h3>serialize<wbr>ResponseCV</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">serialize<wbr>ResponseCV<span class="tsd-signature-symbol">(</span>cv<span class="tsd-signature-symbol">: </span><a href="globals.html#responsecv" class="tsd-signature-type">ResponseCV</a><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/transactions/src/clarity/serialize.ts#L59">packages/transactions/src/clarity/serialize.ts:59</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>cv: <a href="globals.html#responsecv" class="tsd-signature-type">ResponseCV</a></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">
|
|
<a name="serializesinglesigspendingcondition" class="tsd-anchor"></a>
|
|
<h3>serialize<wbr>Single<wbr>Sig<wbr>Spending<wbr>Condition</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">serialize<wbr>Single<wbr>Sig<wbr>Spending<wbr>Condition<span class="tsd-signature-symbol">(</span>condition<span class="tsd-signature-symbol">: </span><a href="interfaces/singlesigspendingcondition.html" class="tsd-signature-type">SingleSigSpendingCondition</a><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/transactions/src/authorization.ts#L218">packages/transactions/src/authorization.ts:218</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>condition: <a href="interfaces/singlesigspendingcondition.html" class="tsd-signature-type">SingleSigSpendingCondition</a></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">
|
|
<a name="serializespendingcondition" class="tsd-anchor"></a>
|
|
<h3>serialize<wbr>Spending<wbr>Condition</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">serialize<wbr>Spending<wbr>Condition<span class="tsd-signature-symbol">(</span>condition<span class="tsd-signature-symbol">: </span><a href="globals.html#spendingcondition" class="tsd-signature-type">SpendingCondition</a><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/transactions/src/authorization.ts#L291">packages/transactions/src/authorization.ts:291</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>condition: <a href="globals.html#spendingcondition" class="tsd-signature-type">SpendingCondition</a></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">
|
|
<a name="serializestacksmessage" class="tsd-anchor"></a>
|
|
<h3>serialize<wbr>Stacks<wbr>Message</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">serialize<wbr>Stacks<wbr>Message<span class="tsd-signature-symbol">(</span>message<span class="tsd-signature-symbol">: </span><a href="globals.html#stacksmessage" class="tsd-signature-type">StacksMessage</a><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/transactions/src/types.ts#L50">packages/transactions/src/types.ts:50</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>message: <a href="globals.html#stacksmessage" class="tsd-signature-type">StacksMessage</a></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">
|
|
<a name="serializestandardprincipalcv" class="tsd-anchor"></a>
|
|
<h3>serialize<wbr>Standard<wbr>PrincipalCV</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">serialize<wbr>Standard<wbr>PrincipalCV<span class="tsd-signature-symbol">(</span>cv<span class="tsd-signature-symbol">: </span><a href="interfaces/standardprincipalcv.html" class="tsd-signature-type">StandardPrincipalCV</a><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/transactions/src/clarity/serialize.ts#L48">packages/transactions/src/clarity/serialize.ts:48</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>cv: <a href="interfaces/standardprincipalcv.html" class="tsd-signature-type">StandardPrincipalCV</a></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">
|
|
<a name="serializestringasciicv" class="tsd-anchor"></a>
|
|
<h3>serialize<wbr>String<wbr>AsciiCV</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">serialize<wbr>String<wbr>AsciiCV<span class="tsd-signature-symbol">(</span>cv<span class="tsd-signature-symbol">: </span><a href="interfaces/stringasciicv.html" class="tsd-signature-type">StringAsciiCV</a><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/transactions/src/clarity/serialize.ts#L115">packages/transactions/src/clarity/serialize.ts:115</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>cv: <a href="interfaces/stringasciicv.html" class="tsd-signature-type">StringAsciiCV</a></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">
|
|
<a name="serializestringcv" class="tsd-anchor"></a>
|
|
<h3>serialize<wbr>StringCV</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">serialize<wbr>StringCV<span class="tsd-signature-symbol">(</span>cv<span class="tsd-signature-symbol">: </span><a href="interfaces/stringasciicv.html" class="tsd-signature-type">StringAsciiCV</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/stringutf8cv.html" class="tsd-signature-type">StringUtf8CV</a>, encoding<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"ascii"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"utf8"</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/transactions/src/clarity/serialize.ts#L102">packages/transactions/src/clarity/serialize.ts:102</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>cv: <a href="interfaces/stringasciicv.html" class="tsd-signature-type">StringAsciiCV</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/stringutf8cv.html" class="tsd-signature-type">StringUtf8CV</a></h5>
|
|
</li>
|
|
<li>
|
|
<h5>encoding: <span class="tsd-signature-type">"ascii"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"utf8"</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">
|
|
<a name="serializestringutf8cv" class="tsd-anchor"></a>
|
|
<h3>serialize<wbr>String<wbr>Utf8CV</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">serialize<wbr>String<wbr>Utf8CV<span class="tsd-signature-symbol">(</span>cv<span class="tsd-signature-symbol">: </span><a href="interfaces/stringutf8cv.html" class="tsd-signature-type">StringUtf8CV</a><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/transactions/src/clarity/serialize.ts#L119">packages/transactions/src/clarity/serialize.ts:119</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>cv: <a href="interfaces/stringutf8cv.html" class="tsd-signature-type">StringUtf8CV</a></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">
|
|
<a name="serializetransactionauthfield" class="tsd-anchor"></a>
|
|
<h3>serialize<wbr>Transaction<wbr>Auth<wbr>Field</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">serialize<wbr>Transaction<wbr>Auth<wbr>Field<span class="tsd-signature-symbol">(</span>field<span class="tsd-signature-symbol">: </span><a href="interfaces/transactionauthfield.html" class="tsd-signature-type">TransactionAuthField</a><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/transactions/src/authorization.ts#L104">packages/transactions/src/authorization.ts:104</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>field: <a href="interfaces/transactionauthfield.html" class="tsd-signature-type">TransactionAuthField</a></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">
|
|
<a name="serializetuplecv" class="tsd-anchor"></a>
|
|
<h3>serialize<wbr>TupleCV</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">serialize<wbr>TupleCV<span class="tsd-signature-symbol">(</span>cv<span class="tsd-signature-symbol">: </span><a href="interfaces/tuplecv.html" class="tsd-signature-type">TupleCV</a><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/transactions/src/clarity/serialize.ts#L78">packages/transactions/src/clarity/serialize.ts:78</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>cv: <a href="interfaces/tuplecv.html" class="tsd-signature-type">TupleCV</a></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">
|
|
<a name="signanduploadprofile" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> sign<wbr>And<wbr>Upload<wbr>Profile</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">sign<wbr>And<wbr>Upload<wbr>Profile<span class="tsd-signature-symbol">(</span>__namedParameters<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>gaiaHubConfig<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">GaiaHubConfig</span><span class="tsd-signature-symbol">; </span>gaiaHubUrl<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>identity<span class="tsd-signature-symbol">: </span><a href="classes/identity.html" class="tsd-signature-type">Identity</a><span class="tsd-signature-symbol">; </span>profile<span class="tsd-signature-symbol">: </span><a href="classes/profile.html" class="tsd-signature-type">Profile</a><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">void</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/keychain/src/profiles.ts#L162">packages/keychain/src/profiles.ts:162</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>__namedParameters: <span class="tsd-signature-symbol">{ </span>gaiaHubConfig<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">GaiaHubConfig</span><span class="tsd-signature-symbol">; </span>gaiaHubUrl<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>identity<span class="tsd-signature-symbol">: </span><a href="classes/identity.html" class="tsd-signature-type">Identity</a><span class="tsd-signature-symbol">; </span>profile<span class="tsd-signature-symbol">: </span><a href="classes/profile.html" class="tsd-signature-type">Profile</a><span class="tsd-signature-symbol"> }</span></h5>
|
|
<ul class="tsd-parameters">
|
|
<li class="tsd-parameter">
|
|
<h5>gaia<wbr>Hub<wbr>Config<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">GaiaHubConfig</span></h5>
|
|
</li>
|
|
<li class="tsd-parameter">
|
|
<h5>gaia<wbr>Hub<wbr>Url<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li class="tsd-parameter">
|
|
<h5>identity<span class="tsd-signature-symbol">: </span><a href="classes/identity.html" class="tsd-signature-type">Identity</a></h5>
|
|
</li>
|
|
<li class="tsd-parameter">
|
|
<h5>profile<span class="tsd-signature-symbol">: </span><a href="classes/profile.html" class="tsd-signature-type">Profile</a></h5>
|
|
</li>
|
|
</ul>
|
|
</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">void</span><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="signprofileforupload" class="tsd-anchor"></a>
|
|
<h3>sign<wbr>Profile<wbr>For<wbr>Upload</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">sign<wbr>Profile<wbr>For<wbr>Upload<span class="tsd-signature-symbol">(</span>profile<span class="tsd-signature-symbol">: </span><a href="classes/profile.html" class="tsd-signature-type">Profile</a>, keypair<span class="tsd-signature-symbol">: </span><a href="interfaces/identitykeypair.html" class="tsd-signature-type">IdentityKeyPair</a><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/keychain/src/profiles.ts#L58">packages/keychain/src/profiles.ts:58</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>profile: <a href="classes/profile.html" class="tsd-signature-type">Profile</a></h5>
|
|
</li>
|
|
<li>
|
|
<h5>keypair: <a href="interfaces/identitykeypair.html" class="tsd-signature-type">IdentityKeyPair</a></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">
|
|
<a name="signprofiletoken" class="tsd-anchor"></a>
|
|
<h3>sign<wbr>Profile<wbr>Token</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">sign<wbr>Profile<wbr>Token<span class="tsd-signature-symbol">(</span>profile<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, privateKey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, subject<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span>, issuer<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span>, signingAlgorithm<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, issuedAt<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Date</span>, expiresAt<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Date</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/profile/src/profileTokens.ts#L19">packages/profile/src/profileTokens.ts:19</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Signs a profile token</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>profile: <span class="tsd-signature-type">any</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>the JSON of the profile to be signed</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5>privateKey: <span class="tsd-signature-type">string</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>the signing private key</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> subject: <span class="tsd-signature-type">any</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>the entity that the information is about</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> issuer: <span class="tsd-signature-type">any</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>the entity that is issuing the token</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> signingAlgorithm: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "ES256K"</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>the signing algorithm to use</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> issuedAt: <span class="tsd-signature-type">Date</span><span class="tsd-signature-symbol"> = new Date()</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>the time of issuance of the token</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> expiresAt: <span class="tsd-signature-type">Date</span><span class="tsd-signature-symbol"> = nextYear()</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>the time of expiration of the token</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
|
|
<ul>
|
|
<li>the signed profile token</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="signwithkey" class="tsd-anchor"></a>
|
|
<h3>sign<wbr>With<wbr>Key</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">sign<wbr>With<wbr>Key<span class="tsd-signature-symbol">(</span>privateKey<span class="tsd-signature-symbol">: </span><a href="interfaces/stacksprivatekey.html" class="tsd-signature-type">StacksPrivateKey</a>, input<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/messagesignature.html" class="tsd-signature-type">MessageSignature</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/transactions/src/keys.ts#L150">packages/transactions/src/keys.ts:150</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>privateKey: <a href="interfaces/stacksprivatekey.html" class="tsd-signature-type">StacksPrivateKey</a></h5>
|
|
</li>
|
|
<li>
|
|
<h5>input: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="interfaces/messagesignature.html" class="tsd-signature-type">MessageSignature</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="somecv" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> someCV</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">someCV<span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">: </span><a href="globals.html#clarityvalue" class="tsd-signature-type">ClarityValue</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="globals.html#optionalcv" class="tsd-signature-type">OptionalCV</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/transactions/src/clarity/types/optionalCV.ts#L15">packages/transactions/src/clarity/types/optionalCV.ts:15</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>value: <a href="globals.html#clarityvalue" class="tsd-signature-type">ClarityValue</a></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="globals.html#optionalcv" class="tsd-signature-type">OptionalCV</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="sponsortransaction" class="tsd-anchor"></a>
|
|
<h3>sponsor<wbr>Transaction</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">sponsor<wbr>Transaction<span class="tsd-signature-symbol">(</span>sponsorOptions<span class="tsd-signature-symbol">: </span><a href="interfaces/sponsoroptions.html" class="tsd-signature-type">SponsorOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="classes/stackstransaction.html" class="tsd-signature-type">StacksTransaction</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/transactions/src/builders.ts#L1105">packages/transactions/src/builders.ts:1105</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Constructs and signs a sponsored transaction as the sponsor</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>sponsorOptions: <a href="interfaces/sponsoroptions.html" class="tsd-signature-type">SponsorOptions</a></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>the sponsor options object</p>
|
|
<p>Returns a signed sponsored transaction.</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="classes/stackstransaction.html" class="tsd-signature-type">StacksTransaction</a><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="stack" class="tsd-anchor"></a>
|
|
<h3>stack</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">stack<span class="tsd-signature-symbol">(</span>network<span class="tsd-signature-symbol">: </span><a href="classes/clinetworkadapter.html" class="tsd-signature-type">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></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#L1560">packages/cli/src/cli.ts:1560</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>network: <a href="classes/clinetworkadapter.html" class="tsd-signature-type">CLINetworkAdapter</a></h5>
|
|
</li>
|
|
<li>
|
|
<h5>args: <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-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">
|
|
<a name="stackingstatus" class="tsd-anchor"></a>
|
|
<h3>stacking<wbr>Status</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">stacking<wbr>Status<span class="tsd-signature-symbol">(</span>network<span class="tsd-signature-symbol">: </span><a href="classes/clinetworkadapter.html" class="tsd-signature-type">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></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#L1479">packages/cli/src/cli.ts:1479</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>network: <a href="classes/clinetworkadapter.html" class="tsd-signature-type">CLINetworkAdapter</a></h5>
|
|
</li>
|
|
<li>
|
|
<h5>args: <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-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">
|
|
<a name="standardprincipalcv" class="tsd-anchor"></a>
|
|
<h3>standard<wbr>PrincipalCV</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">standard<wbr>PrincipalCV<span class="tsd-signature-symbol">(</span>addressString<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/standardprincipalcv.html" class="tsd-signature-type">StandardPrincipalCV</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/transactions/src/clarity/types/principalCV.ts#L43">packages/transactions/src/clarity/types/principalCV.ts:43</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>addressString: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="interfaces/standardprincipalcv.html" class="tsd-signature-type">StandardPrincipalCV</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="standardprincipalcvfromaddress" class="tsd-anchor"></a>
|
|
<h3>standard<wbr>PrincipalCVFrom<wbr>Address</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">standard<wbr>PrincipalCVFrom<wbr>Address<span class="tsd-signature-symbol">(</span>address<span class="tsd-signature-symbol">: </span><a href="interfaces/address.html" class="tsd-signature-type">Address</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="interfaces/standardprincipalcv.html" class="tsd-signature-type">StandardPrincipalCV</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/transactions/src/clarity/types/principalCV.ts#L48">packages/transactions/src/clarity/types/principalCV.ts:48</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>address: <a href="interfaces/address.html" class="tsd-signature-type">Address</a></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="interfaces/standardprincipalcv.html" class="tsd-signature-type">StandardPrincipalCV</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="stringasciicv" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> string<wbr>AsciiCV</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">string<wbr>AsciiCV<span class="tsd-signature-symbol">(</span>data<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/stringasciicv.html" class="tsd-signature-type">StringAsciiCV</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/transactions/src/clarity/types/stringCV.ts#L13">packages/transactions/src/clarity/types/stringCV.ts:13</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>data: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="interfaces/stringasciicv.html" class="tsd-signature-type">StringAsciiCV</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="stringcv" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> stringCV</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">stringCV<span class="tsd-signature-symbol">(</span>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, encoding<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"ascii"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"utf8"</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="interfaces/stringasciicv.html" class="tsd-signature-type">StringAsciiCV</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/stringutf8cv.html" class="tsd-signature-type">StringUtf8CV</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/transactions/src/clarity/types/stringCV.ts#L21">packages/transactions/src/clarity/types/stringCV.ts:21</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>data: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>encoding: <span class="tsd-signature-type">"ascii"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"utf8"</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="interfaces/stringasciicv.html" class="tsd-signature-type">StringAsciiCV</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/stringutf8cv.html" class="tsd-signature-type">StringUtf8CV</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="stringutf8cv" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> string<wbr>Utf8CV</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">string<wbr>Utf8CV<span class="tsd-signature-symbol">(</span>data<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/stringutf8cv.html" class="tsd-signature-type">StringUtf8CV</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/transactions/src/clarity/types/stringCV.ts#L17">packages/transactions/src/clarity/types/stringCV.ts:17</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>data: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="interfaces/stringutf8cv.html" class="tsd-signature-type">StringUtf8CV</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="sumutxos" class="tsd-anchor"></a>
|
|
<h3>sumUTXOs</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">sumUTXOs<span class="tsd-signature-symbol">(</span>utxos<span class="tsd-signature-symbol">: </span><a href="interfaces/utxo.html" class="tsd-signature-type">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#L439">packages/cli/src/utils.ts:439</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>utxos: <a href="interfaces/utxo.html" class="tsd-signature-type">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 class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="truecv" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> trueCV</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">trueCV<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="globals.html#booleancv" class="tsd-signature-type">BooleanCV</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/transactions/src/clarity/types/booleanCV.ts#L13">packages/transactions/src/clarity/types/booleanCV.ts:13</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-returns-title">Returns <a href="globals.html#booleancv" class="tsd-signature-type">BooleanCV</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="tuplecv" class="tsd-anchor"></a>
|
|
<h3>tupleCV</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">tupleCV<span class="tsd-signature-symbol">(</span>data<span class="tsd-signature-symbol">: </span><a href="globals.html#tupledata" class="tsd-signature-type">TupleData</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="interfaces/tuplecv.html" class="tsd-signature-type">TupleCV</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/transactions/src/clarity/types/tupleCV.ts#L11">packages/transactions/src/clarity/types/tupleCV.ts:11</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>data: <a href="globals.html#tupledata" class="tsd-signature-type">TupleData</a></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="interfaces/tuplecv.html" class="tsd-signature-type">TupleCV</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="txidfromdata" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> txid<wbr>From<wbr>Data</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">txid<wbr>From<wbr>Data<span class="tsd-signature-symbol">(</span>data<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">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/transactions/src/utils.ts#L97">packages/transactions/src/utils.ts:97</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>data: <span class="tsd-signature-type">Buffer</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">
|
|
<a name="uintcv" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> uintCV</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">uintCV<span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</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">Buffer</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="interfaces/uintcv.html" class="tsd-signature-type">UIntCV</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/transactions/src/clarity/types/intCV.ts#L26">packages/transactions/src/clarity/types/intCV.ts:26</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>value: <span class="tsd-signature-type">number</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">Buffer</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="interfaces/uintcv.html" class="tsd-signature-type">UIntCV</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="updateprofileapisettings" class="tsd-anchor"></a>
|
|
<h3>update<wbr>ProfileAPISettings</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">update<wbr>ProfileAPISettings<span class="tsd-signature-symbol">(</span>network<span class="tsd-signature-symbol">: </span><a href="classes/clinetworkadapter.html" class="tsd-signature-type">CLINetworkAdapter</a>, id<span class="tsd-signature-symbol">: </span><a href="interfaces/namedidentitytype.html" class="tsd-signature-type">NamedIdentityType</a>, appGaiaConfig<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">GaiaHubConfig</span>, profile<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>changed<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</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><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#L506">packages/cli/src/auth.ts:506</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>network: <a href="classes/clinetworkadapter.html" class="tsd-signature-type">CLINetworkAdapter</a></h5>
|
|
</li>
|
|
<li>
|
|
<h5>id: <a href="interfaces/namedidentitytype.html" class="tsd-signature-type">NamedIdentityType</a></h5>
|
|
</li>
|
|
<li>
|
|
<h5>appGaiaConfig: <span class="tsd-signature-type">GaiaHubConfig</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> profile: <span class="tsd-signature-type">any</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>changed<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</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><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="updateprofileapps" class="tsd-anchor"></a>
|
|
<h3>update<wbr>Profile<wbr>Apps</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">update<wbr>Profile<wbr>Apps<span class="tsd-signature-symbol">(</span>network<span class="tsd-signature-symbol">: </span><a href="classes/clinetworkadapter.html" class="tsd-signature-type">CLINetworkAdapter</a>, id<span class="tsd-signature-symbol">: </span><a href="interfaces/namedidentitytype.html" class="tsd-signature-type">NamedIdentityType</a>, appOrigin<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, appGaiaConfig<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">GaiaHubConfig</span>, profile<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>changed<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</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><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#L436">packages/cli/src/auth.ts:436</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>network: <a href="classes/clinetworkadapter.html" class="tsd-signature-type">CLINetworkAdapter</a></h5>
|
|
</li>
|
|
<li>
|
|
<h5>id: <a href="interfaces/namedidentitytype.html" class="tsd-signature-type">NamedIdentityType</a></h5>
|
|
</li>
|
|
<li>
|
|
<h5>appOrigin: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>appGaiaConfig: <span class="tsd-signature-type">GaiaHubConfig</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> profile: <span class="tsd-signature-type">any</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>changed<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</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><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="uploadprofile" class="tsd-anchor"></a>
|
|
<h3>upload<wbr>Profile</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">upload<wbr>Profile<span class="tsd-signature-symbol">(</span>gaiaHubUrl<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, identity<span class="tsd-signature-symbol">: </span><a href="classes/identity.html" class="tsd-signature-type">Identity</a>, signedProfileTokenData<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, gaiaHubConfig<span class="tsd-signature-symbol">?: </span><a href="interfaces/gaiahubconfig.html" class="tsd-signature-type">GaiaHubConfig</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</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/keychain/src/profiles.ts#L68">packages/keychain/src/profiles.ts:68</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>gaiaHubUrl: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>identity: <a href="classes/identity.html" class="tsd-signature-type">Identity</a></h5>
|
|
</li>
|
|
<li>
|
|
<h5>signedProfileTokenData: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> gaiaHubConfig: <a href="interfaces/gaiahubconfig.html" class="tsd-signature-type">GaiaHubConfig</a></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">
|
|
<a name="validatecontractcall" class="tsd-anchor"></a>
|
|
<h3>validate<wbr>Contract<wbr>Call</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">validate<wbr>Contract<wbr>Call<span class="tsd-signature-symbol">(</span>payload<span class="tsd-signature-symbol">: </span><a href="interfaces/contractcallpayload.html" class="tsd-signature-type">ContractCallPayload</a>, abi<span class="tsd-signature-symbol">: </span><a href="interfaces/clarityabi.html" class="tsd-signature-type">ClarityAbi</a><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/transactions/src/contract-abi.ts#L369">packages/transactions/src/contract-abi.ts:369</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Validates a contract-call payload with a contract ABI</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>payload: <a href="interfaces/contractcallpayload.html" class="tsd-signature-type">ContractCallPayload</a></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>a contract-call payload</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5>abi: <a href="interfaces/clarityabi.html" class="tsd-signature-type">ClarityAbi</a></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>a contract ABI</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
|
|
<p>true if the payloads functionArgs type check against those in the ABI</p>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="validatestacksaddress" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> validate<wbr>Stacks<wbr>Address</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">validate<wbr>Stacks<wbr>Address<span class="tsd-signature-symbol">(</span>stacksAddress<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/transactions/src/utils.ts#L202">packages/transactions/src/utils.ts:202</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>stacksAddress: <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">
|
|
<a name="validatesubdomain" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> validate<wbr>Subdomain</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">validate<wbr>Subdomain<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, subdomain<span class="tsd-signature-symbol">?: </span><a href="enums/subdomains.html" class="tsd-signature-type">Subdomains</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="enums/identitynamevalidityerror.html#minimum_length" class="tsd-signature-type">MINIMUM_LENGTH</a><span class="tsd-signature-symbol"> | </span><a href="enums/identitynamevalidityerror.html#maximum_length" class="tsd-signature-type">MAXIMUM_LENGTH</a><span class="tsd-signature-symbol"> | </span><a href="enums/identitynamevalidityerror.html#illegal_character" class="tsd-signature-type">ILLEGAL_CHARACTER</a><span class="tsd-signature-symbol"> | </span><a href="enums/identitynamevalidityerror.html#unavailable" class="tsd-signature-type">UNAVAILABLE</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/keychain/src/utils/index.ts#L224">packages/keychain/src/utils/index.ts:224</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Validate the format and availability of a subdomain. Will return an error of enum
|
|
IdentityNameValidityError if an error is present. If no errors are found, will return null.</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>name: <span class="tsd-signature-type">string</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>the subdomain to be registered</p>
|
|
</div>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> subdomain: <a href="enums/subdomains.html" class="tsd-signature-type">Subdomains</a><span class="tsd-signature-symbol"> = Subdomains.BLOCKSTACK</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>a valid Subdomains enum</p>
|
|
</div>
|
|
</div>
|
|
</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">null</span><span class="tsd-signature-symbol"> | </span><a href="enums/identitynamevalidityerror.html#minimum_length" class="tsd-signature-type">MINIMUM_LENGTH</a><span class="tsd-signature-symbol"> | </span><a href="enums/identitynamevalidityerror.html#maximum_length" class="tsd-signature-type">MAXIMUM_LENGTH</a><span class="tsd-signature-symbol"> | </span><a href="enums/identitynamevalidityerror.html#illegal_character" class="tsd-signature-type">ILLEGAL_CHARACTER</a><span class="tsd-signature-symbol"> | </span><a href="enums/identitynamevalidityerror.html#unavailable" class="tsd-signature-type">UNAVAILABLE</a><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="validatesubdomainavailability" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> validate<wbr>Subdomain<wbr>Availability</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">validate<wbr>Subdomain<wbr>Availability<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, subdomain<span class="tsd-signature-symbol">?: </span><a href="enums/subdomains.html" class="tsd-signature-type">Subdomains</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</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/keychain/src/utils/index.ts#L183">packages/keychain/src/utils/index.ts:183</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>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> subdomain: <a href="enums/subdomains.html" class="tsd-signature-type">Subdomains</a><span class="tsd-signature-symbol"> = Subdomains.BLOCKSTACK</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">
|
|
<a name="validatesubdomainformat" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> validate<wbr>Subdomain<wbr>Format</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">validate<wbr>Subdomain<wbr>Format<span class="tsd-signature-symbol">(</span>identityName<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="enums/identitynamevalidityerror.html" class="tsd-signature-type">IdentityNameValidityError</a><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/keychain/src/utils/index.ts#L165">packages/keychain/src/utils/index.ts:165</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>identityName: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="enums/identitynamevalidityerror.html" class="tsd-signature-type">IdentityNameValidityError</a><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">
|
|
<a name="verify" class="tsd-anchor"></a>
|
|
<h3>verify</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">verify<span class="tsd-signature-symbol">(</span>condition<span class="tsd-signature-symbol">: </span><a href="globals.html#spendingcondition" class="tsd-signature-type">SpendingCondition</a>, initialSigHash<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, authType<span class="tsd-signature-symbol">: </span><a href="enums/authtype.html" class="tsd-signature-type">AuthType</a><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/transactions/src/authorization.ts#L417">packages/transactions/src/authorization.ts:417</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>condition: <a href="globals.html#spendingcondition" class="tsd-signature-type">SpendingCondition</a></h5>
|
|
</li>
|
|
<li>
|
|
<h5>initialSigHash: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>authType: <a href="enums/authtype.html" class="tsd-signature-type">AuthType</a></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">
|
|
<a name="verifyprofiletoken" class="tsd-anchor"></a>
|
|
<h3>verify<wbr>Profile<wbr>Token</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">verify<wbr>Profile<wbr>Token<span class="tsd-signature-symbol">(</span>token<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, publicKeyOrAddress<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">TokenInterface</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/profile/src/profileTokens.ts#L76">packages/profile/src/profileTokens.ts:76</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Verifies a profile token</p>
|
|
</div>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>throws</dt>
|
|
<dd><p>{Error} - throws an error if token verification fails</p>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>token: <span class="tsd-signature-type">string</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>the token to be verified</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5>publicKeyOrAddress: <span class="tsd-signature-type">string</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>the public key or address of the
|
|
keypair that is thought to have signed the token</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">TokenInterface</span></h4>
|
|
<ul>
|
|
<li>the verified, decoded profile token</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="verifysinglesig" class="tsd-anchor"></a>
|
|
<h3>verify<wbr>Single<wbr>Sig</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">verify<wbr>Single<wbr>Sig<span class="tsd-signature-symbol">(</span>condition<span class="tsd-signature-symbol">: </span><a href="interfaces/singlesigspendingcondition.html" class="tsd-signature-type">SingleSigSpendingCondition</a>, initialSigHash<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, authType<span class="tsd-signature-symbol">: </span><a href="enums/authtype.html" class="tsd-signature-type">AuthType</a><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/transactions/src/authorization.ts#L426">packages/transactions/src/authorization.ts:426</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>condition: <a href="interfaces/singlesigspendingcondition.html" class="tsd-signature-type">SingleSigSpendingCondition</a></h5>
|
|
</li>
|
|
<li>
|
|
<h5>initialSigHash: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>authType: <a href="enums/authtype.html" class="tsd-signature-type">AuthType</a></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">
|
|
<a name="walletfrommnemonic" class="tsd-anchor"></a>
|
|
<h3>wallet<wbr>From<wbr>Mnemonic</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">wallet<wbr>From<wbr>Mnemonic<span class="tsd-signature-symbol">(</span>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><span class="tsd-signature-type">BlockstackWallet</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#L58">packages/cli/src/keys.ts:58</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<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><span class="tsd-signature-type">BlockstackWallet</span><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="wrapprofiletoken" class="tsd-anchor"></a>
|
|
<h3>wrap<wbr>Profile<wbr>Token</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">wrap<wbr>Profile<wbr>Token<span class="tsd-signature-symbol">(</span>token<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>decodedToken<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">TokenInterface</span><span class="tsd-signature-symbol">; </span>token<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/profile/src/profileTokens.ts#L61">packages/profile/src/profileTokens.ts:61</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Wraps a token for a profile token file</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>token: <span class="tsd-signature-type">string</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>the token to be wrapped</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{ </span>decodedToken<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">TokenInterface</span><span class="tsd-signature-symbol">; </span>token<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></h4>
|
|
<ul>
|
|
<li>including <code>token</code> and <code>decodedToken</code></li>
|
|
</ul>
|
|
<ul class="tsd-parameters">
|
|
<li class="tsd-parameter">
|
|
<h5>decoded<wbr>Token<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">TokenInterface</span></h5>
|
|
</li>
|
|
<li class="tsd-parameter">
|
|
<h5>token<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</section>
|
|
<section class="tsd-panel-group tsd-member-group ">
|
|
<h2>Object literals</h2>
|
|
<section class="tsd-panel tsd-member tsd-kind-object-literal">
|
|
<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-type">object</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>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
|
<a name="cli_args.additionalproperties" class="tsd-anchor"></a>
|
|
<h3>additional<wbr>Properties</h3>
|
|
<div class="tsd-signature tsd-kind-icon">additional<wbr>Properties<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = 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#L2725">packages/cli/src/argparse.ts:2725</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
|
<a name="cli_args.properties" class="tsd-anchor"></a>
|
|
<h3>properties</h3>
|
|
<div class="tsd-signature tsd-kind-icon">properties<span class="tsd-signature-symbol">:</span> <a href="interfaces/cli_prop.html" class="tsd-signature-type">CLI_PROP</a><span class="tsd-signature-symbol"> = {announce: {type: 'array',items: [{name: 'message_hash',type: 'string',realtype: 'zonefile_hash',pattern: ZONEFILE_HASH_PATTERN,},{name: 'owner_key',type: 'string',realtype: 'private_key',pattern: `${PRIVATE_KEY_PATTERN_ANY}`,},],minItems: 2,maxItems: 2,help:'Broadcast a message on the blockchain for subscribers to read. ' +'The `MESSAGE_HASH` argument must be the hash of a previously-announced zone file. ' +'The `OWNER_KEY` used to sign the transaction must correspond to the Blockstack ID ' +'to which other users have already subscribed. `OWNER_KEY` can be a single private key ' +'or a serialized multisig private key bundle.\n' +'\n' +'If this command succeeds, it will print a transaction ID. The rest of the Blockstack peer ' +'network will process it once the transaction reaches 7 confirmations.\n' +'\n' +'Examples:\n' +'\n' +' $ # Tip: You can obtain the owner key with the get_owner_keys command\n' +' $ export OWNER_KEY="136ff26efa5db6f06b28f9c8c7a0216a1a52598045162abfe435d13036154a1b01"\n' +' $ stx announce 737c631c7c5d911c6617993c21fba731363f1cfe "$OWNER_KEY"\n' +' d51749aeec2803e91a2f8bdec8d3e413491fd816b4962372b214ab74acb0bba8\n' +'\n' +' $ export OWNER_KEY="2,136ff26efa5db6f06b28f9c8c7a0216a1a52598045162abfe435d13036154a1b01,1885cba486a42960499d1f137ef3a475725ceb11f45d74631f9928280196f67401,2418981c7f3a91d4467a65a518e14fafa30e07e6879c11fab7106ea72b49a7cb01"\n' +' $ stx announce 737c631c7c5d911c6617993c21fba731363f1cfe "$OWNER_KEY"\n' +' 8136a1114098893b28a693e8d84451abf99ee37ef8766f4bc59808eed76968c9\n' +'\n',group: 'Peer Services',},authenticator: {type: 'array',items: [{name: 'app_gaia_hub',type: 'string',realtype: 'url',pattern: URL_PATTERN,},{name: 'backup_phrase',type: 'string',realtype: '12_words_or_ciphertext',pattern: '.+',},{name: 'profile_gaia_hub',type: 'string',realtype: 'url',pattern: URL_PATTERN,},{name: 'port',type: 'string',realtype: 'portnum',pattern: '^[0-9]+',},],minItems: 2,maxItems: 4,help:'Run an authentication endpoint for the set of names owned ' +'by the given backup phrase. Send applications the given Gaia hub URL on sign-in, ' +'so the application will use it to read/write user data.\n' +'\n' +'You can supply your encrypted backup phrase instead of the raw backup phrase. If so, ' +'then you will be prompted for your password before any authentication takes place.\n' +'\n' +'Example:\n' +'\n' +' $ export BACKUP_PHRASE="oak indicate inside poet please share dinner monitor glow hire source perfect"\n' +' $ export APP_GAIA_HUB="https://1.2.3.4"\n' +' $ export PROFILE_GAIA_HUB="https://hub.blockstack.org"\n' +' $ stx authenticator "$APP_GAIA_HUB" "$BACKUP_PHRASE" "$PROFILE_GAIA_HUB" 8888\n' +' Press Ctrl+C to exit\n' +' Authentication server started on 8888\n',group: 'Authentication',},balance: {type: 'array',items: [{name: 'address',type: 'string',realtype: 'address',pattern: `${ADDRESS_PATTERN}|${STACKS_ADDRESS_PATTERN}`,},],minItems: 1,maxItems: 1,help:'Query the balance of an account. Returns the balances of each kind of token ' +'that the account owns. The balances will be in the *smallest possible units* of the ' +'token (i.e. satoshis for BTC, microStacks for Stacks, etc.).\n' +'\n' +'Example:\n' +'\n' +' $ stx balance 16pm276FpJYpm7Dv3GEaRqTVvGPTdceoY4\n' +' {\n' +' "BTC": "123456"\n' +' "STACKS": "123456"\n' +' }\n' +' $ stx balance SPZY1V53Z4TVRHHW9Z7SFG8CZNRAG7BD8WJ6SXD0\n' +' {\n' +' "BTC": "123456"\n' +' "STACKS": "123456"\n' +' }\n',group: 'Account Management',},can_stack: {type: 'array',items: [{name: 'amount',type: 'string',realtype: 'integer',pattern: '^[0-9]+$',},{name: 'cycles',type: 'string',realtype: 'integer',pattern: '^[0-9]+$',},{name: 'pox_address',type: 'string',realtype: 'address',pattern: `${ADDRESS_PATTERN}`,},{name: 'stx_address',type: 'string',realtype: 'address',pattern: `${STACKS_ADDRESS_PATTERN}`,},],minItems: 4,maxItems: 4,help:'Check if specified account can stack a number of Stacks tokens for given number of cycles.\n' +'\n' +'Example:\n' +'\n' +' $ stx can_stack 10000000 20 16pm276FpJYpm7Dv3GEaRqTVvGPTdceoY4 SPZY1V53Z4TVRHHW9Z7SFG8CZNRAG7BD8WJ6SXD0\n' +' {\n' +' "eligible": true\n' +' }\n',group: 'Account Management',},call_contract_func: {type: 'array',items: [{name: 'contract_address',type: 'string',realtype: 'address',pattern: `${STACKS_ADDRESS_PATTERN}`,},{name: 'contract_name',type: 'string',realtype: 'string',pattern: '^[a-zA-Z]([a-zA-Z0-9]|[-_])*$',},{name: 'function_name',type: 'string',realtype: 'string',pattern: '^[a-zA-Z]([a-zA-Z0-9]|[-_!?])*$',},{name: 'fee',type: 'string',realtype: 'integer',pattern: '^[0-9]+$',},{name: 'nonce',type: 'string',realtype: 'integer',pattern: '^[0-9]+$',},{name: 'payment_key',type: 'string',realtype: 'private_key',pattern: `${PRIVATE_KEY_PATTERN_ANY}`,},],minItems: 6,maxItems: 6,help:'Call a function in a deployed Clarity smart contract.\n' +'\n' +'If the command succeeds, it prints out a transaction ID.' +'\n' +'Example:\n' +' $ export PAYMENT="bfeffdf57f29b0cc1fab9ea197bb1413da2561fe4b83e962c7f02fbbe2b1cd5401"\n' +' $ stx call_contract_func SPBMRFRPPGCDE3F384WCJPK8PQJGZ8K9QKK7F59X contract_name' +' contract_function 1 0 "$PAYMENT"\n' +' {\n' +" txid: '0x2e33ad647a9cedacb718ce247967dc705bc0c878db899fdba5eae2437c6fa1e1'," +" transaction: 'https://explorer.stacks.co/txid/0x2e33ad647a9cedacb718ce247967dc705bc0c878db899fdba5eae2437c6fa1e1'" +' }\n' +'\n',group: 'Account Management',},call_read_only_contract_func: {type: 'array',items: [{name: 'contract_address',type: 'string',realtype: 'address',pattern: `${STACKS_ADDRESS_PATTERN}`,},{name: 'contract_name',type: 'string',realtype: 'string',pattern: '^[a-zA-Z]([a-zA-Z0-9]|[-_])*$',},{name: 'function_name',type: 'string',realtype: 'string',pattern: '^[a-zA-Z]([a-zA-Z0-9]|[-_!?])*$',},{name: 'sender_address',type: 'string',realtype: 'address',pattern: `${STACKS_ADDRESS_PATTERN}`,},],minItems: 4,maxItems: 4,help:'Call a read-only function in a deployed Clarity smart contract.\n' +'\n' +'If the command succeeds, it prints out a Clarity value.' +'\n' +'Example:\n' +' $ stx call_read_only_contract_func SPBMRFRPPGCDE3F384WCJPK8PQJGZ8K9QKK7F59X contract_name' +' contract_function SPBMRFRPPGCDE3F384WCJPK8PQJGZ8K9QKK7F59X\n' +' {\n' +" txid: '0x2e33ad647a9cedacb718ce247967dc705bc0c878db899fdba5eae2437c6fa1e1'," +" transaction: 'https://explorer.stacks.co/txid/0x2e33ad647a9cedacb718ce247967dc705bc0c878db899fdba5eae2437c6fa1e1'" +' }\n' +'\n',group: 'Account Management',},convert_address: {type: 'array',items: [{name: 'address',type: 'string',realtype: 'address',pattern: `${ADDRESS_PATTERN}|${STACKS_ADDRESS_PATTERN}`,},],minItems: 1,maxItems: 1,help:'Convert a Bitcoin address to a Stacks address and vice versa.\n' +'\n' +'Example:\n' +'\n' +' $ stx convert_address 12qdRgXxgNBNPnDeEChy3fYTbSHQ8nfZfD\n' +' {\n' +' "STACKS": "SPA2MZWV9N67TBYVWTE0PSSKMJ2F6YXW7CBE6YPW",\n' +' "BTC": "12qdRgXxgNBNPnDeEChy3fYTbSHQ8nfZfD"\n' +' }\n' +' $ stx convert_address SPA2MZWV9N67TBYVWTE0PSSKMJ2F6YXW7CBE6YPW\n' +' {\n' +' "STACKS": "SPA2MZWV9N67TBYVWTE0PSSKMJ2F6YXW7CBE6YPW",\n' +' "BTC": "12qdRgXxgNBNPnDeEChy3fYTbSHQ8nfZfD"\n' +' }\n',group: 'Account Management',},decrypt_keychain: {type: 'array',items: [{name: 'encrypted_backup_phrase',type: 'string',realtype: 'encrypted_backup_phrase',pattern: '^[^ ]+$',},{name: 'password',type: 'string',realtype: 'password',pattern: '.+',},],minItems: 1,maxItems: 2,help:'Decrypt an encrypted backup phrase with a password. Decrypts to a 12-word ' +'backup phrase if done correctly. The password will be prompted if not given.\n' +'\n' +'Example:\n' +'\n' +' $ # password is "asdf"\n' +' $ stx decrypt_keychain "bfMDtOucUGcJXjZo6vkrZWgEzue9fzPsZ7A6Pl4LQuxLI1xsVF0VPgBkMsnSLCmYS5YHh7R3mNtMmX45Bq9sNGPfPsseQMR0fD9XaHi+tBg=\n' +' Enter password:\n' +' section amount spend resemble spray verify night immune tattoo best emotion parrot',group: 'Key Management',},deploy_contract: {type: 'array',items: [{name: 'source_file',type: 'string',realtype: 'path',pattern: '.+',},{name: 'contract_name',type: 'string',realtype: 'string',pattern: '^[a-zA-Z]([a-zA-Z0-9]|[-_])*$',},{name: 'fee',type: 'string',realtype: 'integer',pattern: '^[0-9]+$',},{name: 'nonce',type: 'string',realtype: 'integer',pattern: '^[0-9]+$',},{name: 'payment_key',type: 'string',realtype: 'private_key',pattern: `${PRIVATE_KEY_PATTERN_ANY}`,},],minItems: 5,maxItems: 5,help:'Deploys a Clarity smart contract on the network.\n' +'\n' +'If the command succeeds, it prints out a transaction ID.' +'\n' +'Example:\n' +' $ export PAYMENT="bfeffdf57f29b0cc1fab9ea197bb1413da2561fe4b83e962c7f02fbbe2b1cd5401"\n' +' $ stx deploy_contract ./my_contract.clar my_contract 1 0 "$PAYMENT"\n' +' {\n' +" txid: '0x2e33ad647a9cedacb718ce247967dc705bc0c878db899fdba5eae2437c6fa1e1'," +" transaction: 'https://explorer.stacks.co/txid/0x2e33ad647a9cedacb718ce247967dc705bc0c878db899fdba5eae2437c6fa1e1'" +' }\n' +'\n',group: 'Account Management',},docs: {type: 'array',items: [{name: 'format',type: 'string',realtype: 'output_format',pattern: '^json$',},],minItems: 0,maxItems: 1,help: 'Dump the documentation for all commands as JSON to standard out.',group: 'CLI',},encrypt_keychain: {type: 'array',items: [{name: 'backup_phrase',type: 'string',realtype: 'backup_phrase',pattern: '.+',},{name: 'password',type: 'string',realtype: 'password',pattern: '.+',},],minItems: 1,maxItems: 2,help:'Encrypt a 12-word backup phrase, which can be decrypted later with the ' +'`decrypt_backup_phrase` command. The password will be prompted if not given.\n' +'\n' +'Example:\n' +'\n' +' $ # password is "asdf"\n' +' $ stx encrypt_keychain "section amount spend resemble spray verify night immune tattoo best emotion parrot"\n' +' Enter password:\n' +' Enter password again:\n' +' M+DnBHYb1fgw4N3oZ+5uTEAua5bAWkgTW/SjmmBhGGbJtjOtqVV+RrLJEJOgT35hBon4WKdGWye2vTdgqDo7+HIobwJwkQtN2YF9g3zPsKk=',group: 'Key Management',},faucet: {type: 'array',items: [{name: 'address',type: 'string',realtype: 'address',pattern: `${ADDRESS_PATTERN}|${STACKS_ADDRESS_PATTERN}`,},],minItems: 1,maxItems: 1,help:'Encrypt a 12-word backup phrase, which can be decrypted later with the ' +'`decrypt_backup_phrase` command. The password will be prompted if not given.\n' +'\n' +'Example:\n' +'\n' +' $ # password is "asdf"\n' +' $ blockstack-cli encrypt_keychain "section amount spend resemble spray verify night immune tattoo best emotion parrot"\n' +' Enter password:\n' +' Enter password again:\n' +' M+DnBHYb1fgw4N3oZ+5uTEAua5bAWkgTW/SjmmBhGGbJtjOtqVV+RrLJEJOgT35hBon4WKdGWye2vTdgqDo7+HIobwJwkQtN2YF9g3zPsKk=',group: 'Key Management',},gaia_dump_bucket: {type: 'array',items: [{name: 'name_or_id_address',type: 'string',realtype: 'name_or_id_address',pattern: `${ID_ADDRESS_PATTERN}|${NAME_PATTERN}|${SUBDOMAIN_PATTERN}`,},{name: 'app_origin',type: 'string',realtype: 'url',pattern: URL_PATTERN,},{name: 'gaia_hub',type: 'string',realtype: 'url',pattern: URL_PATTERN,},{name: 'backup_phrase',type: 'string',realtype: '12_words_or_ciphertext',},{name: 'dump_dir',type: 'string',realtype: 'path',pattern: '.+',},],minItems: 5,maxItems: 5,help:'Download the contents of a Gaia hub bucket to a given directory. The `GAIA_HUB` argument ' +'must correspond to the *write* endpoint of the Gaia hub -- that is, you should be able to fetch ' +'`$GAIA_HUB/hub_info`. If `DUMP_DIR` does not exist, it will be created.\n' +'\n' +'Example:\n' +'\n' +' $ export BACKUP_PHRASE="section amount spend resemble spray verify night immune tattoo best emotion parrot\n' +' $ stx gaia_dump_bucket hello.id.blockstack https://sample.app https://hub.blockstack.org "$BACKUP_PHRASE" ./backups\n' +' Download 3 files...\n' +' Download hello_world to ./backups/hello_world\n' +' Download dir/format to ./backups/dir\\x2fformat\n' +' Download /.dotfile to ./backups/\\x2f.dotfile\n' +' 3\n',group: 'Gaia',},gaia_getfile: {type: 'array',items: [{name: 'blockstack_id',type: 'string',realtype: 'blockstack_id',pattern: `${NAME_PATTERN}|${SUBDOMAIN_PATTERN}$`,},{name: 'app_origin',type: 'string',realtype: 'url',pattern: URL_PATTERN,},{name: 'filename',type: 'string',realtype: 'filename',pattern: '.+',},{name: 'app_private_key',type: 'string',realtype: 'private_key',pattern: PRIVATE_KEY_UNCOMPRESSED_PATTERN,},{name: 'decrypt',type: 'string',realtype: 'boolean',pattern: BOOLEAN_PATTERN,},{name: 'verify',type: 'string',realtype: 'boolean',pattern: BOOLEAN_PATTERN,},],minItems: 3,maxItems: 6,help:"Get a file from another user's Gaia hub. Prints the file data to stdout. If you " +'want to read an encrypted file, and/or verify a signed file, then you must pass an app ' +'private key, and pass 1 for `DECRYPT` and/or `VERIFY`. If the file is encrypted, and you do not ' +'pass an app private key, then this command downloads the ciphertext. If the file is signed, ' +'and you want to download its data and its signature, then you must run this command twice -- ' +'once to get the file contents at `FILENAME`, and once to get the signature (whose name will be `FILENAME`.sig).\n' +'\n' +'Gaia is a key-value store, so it does not have any built-in notion of directories. However, ' +'most underlying storage systems do -- directory separators in the name of a file in ' +"Gaia may be internally treated as first-class directories (it depends on the Gaia hub's driver)." +'As such, repeated directory separators will be treated as a single directory separator by this command. ' +'For example, the file name `a/b.txt`, `/a/b.txt`, and `///a////b.txt` will be treated as identical.\n' +'\n' +'Example without encryption:\n' +'\n' +' $ # Get an unencrypted, unsigned file\n' +' $ stx gaia_getfile ryan.id http://public.ykliao.com statuses.json\n' +' [{"id":0,"text":"Hello, Blockstack!","created_at":1515786983492}]\n' +'\n' +'Example with encryption:\n' +'\n' +' $ # Get an encrypted file without decrypting\n' +' $ stx gaia_getfile ryan.id https://app.graphitedocs.com documentscollection.json\n' +' ' +' $ # Get an encrypted file, and decrypt it\n' +' $ # Tip: You can obtain the app key with the get_app_keys command\n' +' $ export APP_KEY="3ac770e8c3d88b1003bf4a0a148ceb920a6172bdade8e0325a1ed1480ab4fb19"\n' +' $ stx gaia_getfile ryan.id https://app.graphitedocs.com documentscollection.json "$APP_KEY" 1 0\n',group: 'Gaia',},gaia_putfile: {type: 'array',items: [{name: 'gaia_hub',type: 'string',realtype: 'url',pattern: URL_PATTERN,},{name: 'app_private_key',type: 'string',realtype: 'private_key',pattern: PRIVATE_KEY_UNCOMPRESSED_PATTERN,},{name: 'data_path',type: 'string',realtype: 'path',pattern: '.+',},{name: 'gaia_filename',type: 'string',realtype: 'filename',pattern: '.+',},{name: 'encrypt',type: 'string',realtype: 'boolean',pattern: BOOLEAN_PATTERN,},{name: 'sign',type: 'string',realtype: 'boolean',pattern: BOOLEAN_PATTERN,},],minItems: 4,maxItems: 6,help:'Put a file into a given Gaia hub, authenticating with the given app private key. ' +'Optionally encrypt and/or sign the data with the given app private key. If the file is ' +'successfully stored, this command prints out the URLs at which it can be fetched.\n' +'\n' +'Gaia is a key-value store, so it does not have any built-in notion of directories. However, ' +'most underlying storage systems do -- directory separators in the name of a file in ' +"Gaia may be internally treated as first-class directories (it depends on the Gaia hub's driver)." +'As such, repeated directory separators will be treated as a single directory separator by this command. ' +'For example, the file name `a/b.txt`, `/a/b.txt`, and `///a////b.txt` will be treated as identical.\n' +'\n' +'Example:\n' +'\n' +' $ # Store 4 versions of a file: plaintext, encrypted, signed, and encrypted+signed\n' +' $ # Tip: You can obtain the app key with the get_app_keys command.\n' +' $ export APP_KEY="3ac770e8c3d88b1003bf4a0a148ceb920a6172bdade8e0325a1ed1480ab4fb19"\n' +' $ stx gaia_putfile https://hub.blockstack.org "$APP_KEY" /path/to/file.txt file.txt\n' +' {\n' +' "urls": "https://gaia.blockstack.org/hub/19KAzYp4kSKozeAGMUsnuqkEGdgQQLEvwo/file.txt"\n' +' }\n' +' $ stx gaia_putfile https://hub.blockstack.org "$APP_KEY" /path/to/file.txt file-encrypted.txt 1\n' +' {\n' +' "urls": "https://gaia.blockstack.org/hub/19KAzYp4kSKozeAGMUsnuqkEGdgQQLEvwo/file-encrypted.txt"\n' +' }\n' +' $ stx gaia_putfile https://hub.blockstack.org "$APP_KEY" /path/to/file.txt file-signed.txt 0 1\n' +' {\n' +' "urls": "https://gaia.blockstack.org/hub/19KAzYp4kSKozeAGMUsnuqkEGdgQQLEvwo/file-signed.txt"\n' +' }\n' +' $ stx gaia_putfile https://hub.blockstack.org "$APP_KEY" /path/to/file.txt file-encrypted-signed.txt 1 1\n' +' {\n' +' "urls": "https://gaia.blockstack.org/hub/19KAzYp4kSKozeAGMUsnuqkEGdgQQLEvwo/file-encrypted-signed.txt"\n' +' }\n',group: 'Gaia',},gaia_deletefile: {type: 'array',items: [{name: 'gaia_hub',type: 'string',realtype: 'url',pattern: URL_PATTERN,},{name: 'app_private_key',type: 'string',realtype: 'private_key',pattern: PRIVATE_KEY_UNCOMPRESSED_PATTERN,},{name: 'gaia_filename',type: 'string',realtype: 'filename',pattern: '.+',},{name: 'was_signed',type: 'string',realtype: 'boolean',pattern: BOOLEAN_PATTERN,},],minItems: 3,maxItems: 4,help:'Delete a file in a Gaia hub, as well as its signature metadata (which is stored in a separate file).' +'\n' +'Example:\n' +'\n' +' $ # Tip: You can obtain the app key with the get_app_keys command.\n' +' $ export APP_KEY="3ac770e8c3d88b1003bf4a0a148ceb920a6172bdade8e0325a1ed1480ab4fb19"\n' +' $ stx gaia_deletefile https://hub.blockstack.org "$APP_KEY" file.txt false\n' +' ok',group: 'Gaia',},gaia_listfiles: {type: 'array',items: [{name: 'gaia_hub',type: 'string',realtype: 'url',pattern: URL_PATTERN,},{name: 'app_private_key',type: 'string',realtype: 'private_key',pattern: PRIVATE_KEY_UNCOMPRESSED_PATTERN,},],minItems: 2,maxItems: 3,help:'List all the files in a Gaia hub bucket. You must have the private key for the bucket ' +'in order to list its contents. The command prints each file name on its own line, and when ' +'finished, it prints the number of files listed.\n' +'\n' +'Example:\n' +'\n' +' $ # Tip: You can obtain the app key with the get_app_keys command.\n' +' $ export APP_KEY="3ac770e8c3d88b1003bf4a0a148ceb920a6172bdade8e0325a1ed1480ab4fb19"\n' +' $ stx gaia_listfiles "https://hub.blockstack.org" "$APP_KEY"\n' +' hello_world\n' +' dir/format\n' +' /.dotfile\n' +' 3\n',group: 'Gaia',},gaia_restore_bucket: {type: 'array',items: [{name: 'name_or_id_address',type: 'string',realtype: 'name_or_id_address',pattern: `${ID_ADDRESS_PATTERN}|${NAME_PATTERN}|${SUBDOMAIN_PATTERN}`,},{name: 'app_origin',type: 'string',realtype: 'url',pattern: URL_PATTERN,},{name: 'gaia_hub',type: 'string',realtype: 'url',pattern: URL_PATTERN,},{name: 'backup_phrase',type: 'string',realtype: '12_words_or_ciphertext',},{name: 'dump_dir',type: 'string',realtype: 'path',pattern: '.+',},],minItems: 5,maxItems: 5,help:'Upload the contents of a previously-dumped Gaia bucket to a new Gaia hub. The `GAIA_HUB` argument ' +'must correspond to the *write* endpoint of the Gaia hub -- that is, you should be able to fetch ' +'`$GAIA_HUB/hub_info`. `DUMP_DIR` must contain the file contents created by a previous successful run of the gaia_dump_bucket command, ' +'and both `NAME_OR_ID_ADDRESS` and `APP_ORIGIN` must be the same as they were when it was run.\n' +'\n' +'Example:\n' +'\n' +' $ export BACKUP_PHRASE="section amount spend resemble spray verify night immune tattoo best emotion parrot"\n' +' $ stx gaia_restore_bucket hello.id.blockstack https://sample.app https://new.gaia.hub "$BACKUP_PHRASE" ./backups\n' +' Uploaded ./backups/hello_world to https://new.gaia.hub/hub/1Lr8ggSgdmfcb4764woYutUfFqQMjEoKHc/hello_world\n' +' Uploaded ./backups/dir\\x2fformat to https://new.gaia.hub/hub/1Lr8ggSgdmfcb4764woYutUfFqQMjEoKHc/dir/format\n' +' Uploaded ./backups/\\x2f.dotfile to https://new.gaia.hub/hub/1Lr8ggSgdmfcb4764woYutUfFqQMjEoKHc//.dotfile\n' +' 3\n',group: 'Gaia',},gaia_sethub: {type: 'array',items: [{name: 'blockstack_id',type: 'string',realtype: 'blockstack_id',pattern: `^${NAME_PATTERN}|${SUBDOMAIN_PATTERN}$`,},{name: 'owner_gaia_hub',type: 'string',realtype: 'url',pattern: URL_PATTERN,},{name: 'app_origin',type: 'string',realtype: 'url',pattern: URL_PATTERN,},{name: 'app_gaia_hub',type: 'string',realtype: 'url',pattern: URL_PATTERN,},{name: 'backup_phrase',type: 'string',realtype: '12_words_or_ciphertext',},],minItems: 5,maxItems: 5,help:'Set the Gaia hub for a particular application for a Blockstack ID. If the command succeeds, ' +'the URLs to your updated profile will be printed and your profile will contain an entry in its "apps" ' +'key that links the given `APP_ORIGIN` to the given `APP_GAIA_HUB`.\n' +'\n' +'NOTE: Both `OWNER_GAIA_HUB` and `APP_GAIA_HUB` must be the *write* endpoints of their respective Gaia hubs.\n' +'\n' +'Your 12-word phrase (in either raw or encrypted form) is required to re-sign and store your ' +'profile and to generate an app-specific key and Gaia bucket. If you give the encrypted backup phrase, you will be prompted for a password.\n' +'\n' +'Example:\n' +'\n' +' $ export BACKUP_PHRASE="soap fog wealth upon actual blossom neither timber phone exile monkey vocal"\n' +' $ stx gaia_sethub hello_world.id https://hub.blockstack.org https://my.cool.app https://my.app.gaia.hub "$BACKUP_PHRASE"\n' +' {\n' +' "profileUrls": {\n' +' "error": null,\n' +' "dataUrls": [\n' +' "https://gaia.blockstack.org/hub/1ArdkA2oLaKnbNbLccBaFhEV4pYju8hJ82/profile.json"\n' +' ]\n' +' }\n' +' }\n' +' \n' +' $ # You can check the new apps entry with curl and jq as follows:\n' +' $ curl -sL https://gaia.blockstack.org/hub/1ArdkA2oLaKnbNbLccBaFhEV4pYju8hJ82/profile.json | jq ".[0].decodedToken.payload.claim.apps"\n' +' {\n' +' "https://my.cool.app": "https://my.app.gaia.hub/hub/1EqzyQLJ15KG1WQmi5cf1HtmSeqS1Wb8tY/"\n' +' }\n' +'\n',group: 'Gaia',},get_account_history: {type: 'array',items: [{name: 'address',type: 'string',realtype: 'address',pattern: STACKS_ADDRESS_PATTERN,},{name: 'page',type: 'string',realtype: 'integer',pattern: '^[0-9]+$',},],minItems: 2,maxItems: 2,help:'Query the history of account debits and credits over a given block range. ' +'Returns the history one page at a time. An empty result indicates that the page ' +'number has exceeded the number of historic operations in the given block range.\n' +'\n' +'Example:\n' +'\n' +' $ stx get_account_history SP2H7VMY13ESQDAD5808QEY1EMGESMHZWBJRTN2YA 0\n' +' [\n' +' {\n' +' "address": "SP2H7VMY13ESQDAD5808QEY1EMGESMHZWBJRTN2YA",\n' +' "block_id": 56789\n' +' "credit_value": "100000000000",\n' +' "debit_value": "0",\n' +' "lock_transfer_block_id": 0,\n' +' "txid": "0e5db84d94adff5b771262b9df015164703b39bb4a70bf499a1602b858a0a5a1",\n' +' "type": "STACKS",\n' +' "vtxindex": 0\n' +' },\n' +' {\n' +' "address": "SP2H7VMY13ESQDAD5808QEY1EMGESMHZWBJRTN2YA",\n' +' "block_id": 56790,\n' +' "credit_value": "100000000000",\n' +' "debit_value": "64000000000",\n' +' "lock_transfer_block_id": 0,\n' +' "txid": "5a0c67144626f7bd4514e4de3f3bbf251383ca13887444f326bac4bc8b8060ee",\n' +' "type": "STACKS",\n' +' "vtxindex": 1\n' +' },\n' +' {\n' +' "address": "SP2H7VMY13ESQDAD5808QEY1EMGESMHZWBJRTN2YA",\n' +' "block_id": 56791,\n' +' "credit_value": "100000000000",\n' +' "debit_value": "70400000000",\n' +' "lock_transfer_block_id": 0,\n' +' "txid": "e54c271d6a9feb4d1859d32bc99ffd713493282adef5b4fbf50bca9e33fc0ecc",\n' +' "type": "STACKS",\n' +' "vtxindex": 2\n' +' },\n' +' {\n' +' "address": "SP2H7VMY13ESQDAD5808QEY1EMGESMHZWBJRTN2YA",\n' +' "block_id": 56792,\n' +' "credit_value": "100000000000",\n' +' "debit_value": "76800000000",\n' +' "lock_transfer_block_id": 0,\n' +' "txid": "06e0d313261baefec1e59783e256ab487e17e0e776e2fdab0920cc624537e3c8",\n' +' "type": "STACKS",\n' +' "vtxindex": 3\n' +' }\n' +' ]\n' +'\n',group: 'Account Management',},get_account_at: {type: 'array',items: [{name: 'address',type: 'string',realtype: 'address',pattern: STACKS_ADDRESS_PATTERN,},{name: 'blocknumber',type: 'string',realtype: 'integer',pattern: '^[0-9]+$',},],minItems: 2,maxItems: 2,help:'Query the list of token debits and credits on a given address that occurred ' +'at a particular block height. Does not include BTC debits and credits; only Stacks.\n' +'\n' +'Example\n' +'\n' +' $ stx -t get_account_at SP2NTAQFECYGSTE1W47P71FG21H8F00KZZWFGEVKQ 56789\n' +' [\n' +' {\n' +' "debit_value": "0",\n' +' "block_id": 56789\n' +' "lock_transfer_block_id": 0,\n' +' "txid": "291817c78a865c1f72938695218a48174265b2358e89b9448edc89ceefd66aa0",\n' +' "address": "SP2NTAQFECYGSTE1W47P71FG21H8F00KZZWFGEVKQ",\n' +' "credit_value": "1000000000000000000",\n' +' "type": "STACKS",\n' +' "vtxindex": 0\n' +' }\n' +' ]\n' +'\n',group: 'Account Management',},get_address: {type: 'array',items: [{name: 'private_key',type: 'string',realtype: 'private_key',pattern: `${PRIVATE_KEY_PATTERN_ANY}`,},],minItems: 1,maxItems: 1,help:'Get the address of a private key or multisig private key bundle. Gives the BTC and STACKS addresses\n' +'\n' +'Example:\n' +'\n' +' $ stx get_address f5185b9ca93bdcb5753fded3b097dab8547a8b47d2be578412d0687a9a0184cb01\n' +' {\n' +' "BTC": "1JFhWyVPpZQjbPcXFtpGtTmU22u4fhBVmq",\n' +' "STACKS": "SP2YM3J4KQK09V670TD6ZZ1XYNYCNGCWCVVKSDFWQ"\n' +' }\n' +' $ stx get_address 1,f5185b9ca93bdcb5753fded3b097dab8547a8b47d2be578412d0687a9a0184cb01,ff2ff4f4e7f8a1979ffad4fc869def1657fd5d48fc9cf40c1924725ead60942c01\n' +' {\n' +' "BTC": "363pKBhc5ipDws1k5181KFf6RSxhBZ7e3p",\n' +' "STACKS": "SMQWZ30EXVG6XEC1K4QTDP16C1CAWSK1JSWMS0QN"\n' +' }',group: 'Key Management',},get_blockchain_record: {type: 'array',items: [{name: 'blockstack_id',type: 'string',realtype: 'blockstack_id',pattern: `^${NAME_PATTERN}|${SUBDOMAIN_PATTERN}$`,},],minItems: 1,maxItems: 1,help:'Get the low-level blockchain-hosted state for a Blockstack ID. This command ' +'is used mainly for debugging and diagnostics. You should not rely on it to be stable.',group: 'Querying Blockstack IDs',},get_blockchain_history: {type: 'array',items: [{name: 'blockstack_id',type: 'string',realtype: 'blockstack_id',pattern: `${NAME_PATTERN}|${SUBDOMAIN_PATTERN}$`,},{name: 'page',type: 'string',realtype: 'page_number',pattern: '^[0-9]+$',},],minItems: 1,maxItems: 2,help:'Get the low-level blockchain-hosted history of operations on a Blockstack ID. ' +'This command is used mainly for debugging and diagnostics, and is not guaranteed to ' +'be stable across releases.',group: 'Querying Blockstack IDs',},get_confirmations: {type: 'array',items: [{name: 'txid',type: 'string',realtype: 'transaction_id',pattern: TXID_PATTERN,},],minItems: 1,maxItems: 1,help:'Get the block height and number of confirmations for a transaction.\n' +'\n' +'Example:\n' +'\n' +' $ stx get_confirmations e41ce043ab64fd5a5fd382fba21acba8c1f46cbb1d7c08771ada858ce7d29eea\n' +' {\n' +' "blockHeight": 567890,\n' +' "confirmations": 7,\n' +' }\n' +'\n',group: 'Peer Services',},get_namespace_blockchain_record: {type: 'array',items: [{name: 'namespace_id',type: 'string',realtype: 'namespace_id',pattern: NAMESPACE_PATTERN,},],minItems: 1,maxItems: 1,help:'Get the low-level blockchain-hosted state for a Blockstack namespace. This command ' +'is used mainly for debugging and diagnostics, and is not guaranteed to be stable across ' +'releases.',group: 'Namespace Operations',},get_app_keys: {type: 'array',items: [{name: 'backup_phrase',type: 'string',realtype: '12_words_or_ciphertext',},{name: 'name_or_id_address',type: 'string',realtype: 'name-or-id-address',pattern: `${NAME_PATTERN}|${SUBDOMAIN_PATTERN}|${ID_ADDRESS_PATTERN}`,},{name: 'app_origin',type: 'string',realtype: 'url',pattern: URL_PATTERN,},],minItems: 3,maxItems: 3,help:'Get the application private key from a 12-word backup phrase and a name or ID-address. ' +'This is the private key used to sign data in Gaia, and its address is the Gaia bucket ' +'address. If you provide your encrypted backup phrase, you will be asked to decrypt it. ' +'If you provide a name instead of an ID-address, its ID-address will be queried automatically ' +'(note that this means that the name must already be registered).\n' +'\n' +'NOTE: This command does NOT verify whether or not the name or ID-address was created by the ' +'backup phrase. You should do this yourself via the `get_owner_keys` command if you are not sure.\n' +'\n' +'There are two derivation paths emitted by this command: a `keyInfo` path and a `legacyKeyInfo`' +"path. You should use the one that matches the Gaia hub read URL's address, if you have already " +'signed in before. If not, then you should use the `keyInfo` path when possible.\n' +'\n' +'Example:\n' +'\n' +' $ export BACKUP_PHRASE="one race buffalo dynamic icon drip width lake extra forest fee kit"\n' +' $ stx get_app_keys "$BACKUP_PHRASE" example.id.blockstack https://my.cool.dapp\n' +' {\n' +' "keyInfo": {\n' +' "privateKey": "TODO",\n' +' "address": "TODO"\n' +' },\n' +' "legacyKeyInfo": {\n' +' "privateKey": "90f9ec4e13fb9a00243b4c1510075157229bda73076c7c721208c2edca28ea8b",\n' +' "address": "1Lr8ggSgdmfcb4764woYutUfFqQMjEoKHc"\n' +' },\n' +' "ownerKeyIndex": 0\n' +' }',group: 'Key Management',},get_owner_keys: {type: 'array',items: [{name: 'backup_phrase',type: 'string',realtype: '12_words_or_ciphertext',},{name: 'index',type: 'string',realtype: 'integer',pattern: '^[0-9]+$',},],minItems: 1,maxItems: 2,help:'Get the list of owner private keys and ID-addresses from a 12-word backup phrase. ' +'Pass non-zero values for INDEX to generate the sequence of ID-addresses that can be used ' +'to own Blockstack IDs. If you provide an encrypted 12-word backup phrase, you will be ' +'asked for your password to decrypt it.\n' +'\n' +'Example:\n' +'\n' +' $ # get the first 3 owner keys and addresses for a backup phrase\n' +' $ export BACKUP_PHRASE="soap fog wealth upon actual blossom neither timber phone exile monkey vocal"\n' +' $ stx get_owner_keys "$BACKUP_PHRASE" 3\n' +' [\n' +' {\n' +' "privateKey": "14b0811d5cd3486d47279d8f3a97008647c64586b121e99862c18863e2a4183501",\n' +' "version": "v0.10-current",\n' +' "index": 0,\n' +' "idAddress": "ID-1ArdkA2oLaKnbNbLccBaFhEV4pYju8hJ82"\n' +' },\n' +' {\n' +' "privateKey": "1b3572d8dd6866828281ac6cf135f04153210c1f9b123743eccb795fd3095e4901",\n' +' "version": "v0.10-current",\n' +' "index": 1,\n' +' "idAddress": "ID-18pR3UpD1KFrnk88a3MGZmG2dLuZmbJZ25"\n' +' },\n' +' {\n' +' "privateKey": "b19b6d62356db96d570fb5f08b78f0aa7f384525ba3bdcb96fbde29b8e11710d01",\n' +' "version": "v0.10-current",\n' +' "index": 2,\n' +' "idAddress": "ID-1Gx4s7ggkjENw3wSY6bNd1CwoQKk857AqN"\n' +' }\n' +' ]\n' +'\n',group: 'Key Management',},get_payment_key: {type: 'array',items: [{name: 'backup_phrase',type: 'string',realtype: '12_words_or_ciphertext',},],minItems: 1,maxItems: 1,help:'Get the payment private key from a 12-word backup phrase. If you provide an ' +'encrypted backup phrase, you will be asked for your password to decrypt it. This command ' +'will tell you your Bitcoin and Stacks token addresses as well.\n' +'\n' +'Example\n' +'\n' +' $ stx get_payment_key "soap fog wealth upon actual blossom neither timber phone exile monkey vocal"\n' +' [\n' +' {\n' +' "privateKey": "4023435e33da4aff0775f33e7b258f257fb20ecff039c919b5782313ab73afb401",\n' +' "address": {\n' +' "BTC": "1ybaP1gaRwRSWRE4f8JXo2W8fiTZmA4rV",\n' +' "STACKS": "SP5B89ZJAQHBRXVYP15YB5PAY5E24FEW9K4Q63PE"\n' +' },\n' +' "index": 0\n' +' }\n' +' ]\n' +'\n',group: 'Key Management',},get_stacks_wallet_key: {type: 'array',items: [{name: 'backup_phrase',type: 'string',realtype: '24_words_or_ciphertext',},],minItems: 1,maxItems: 1,help:'Get the payment private key from a 24-word backup phrase used by the Stacks wallet. If you provide an ' +'encrypted backup phrase, you will be asked for your password to decrypt it. This command ' +'will tell you your Bitcoin and Stacks token addresses as well.\n' +'\n' +'Example\n' +'\n' +' $ stx get_stacks_payment_key "toast canal educate tissue express melody produce later gospel victory meadow outdoor hollow catch liberty annual gasp hat hello april equip thank neck cruise"\n' +' [\n' +' {\n' +' "privateKey": "a25cea8d310ce656c6d427068c77bad58327334f73e39c296508b06589bc4fa201",\n' +' "address": {\n' +' "BTC": "1ATAW6TAbTCKgU3xPgAcWQwjW9Q26Eambx",\n' +' "STACKS": "SP1KTQR7CTQNA20SV2VNTF9YABMR6RJERSES3KC6Z"\n' +' },\n' +' "index": 0\n' +' }\n' +' ]\n' +'\n',group: 'Key Management',},get_zonefile: {type: 'array',items: [{name: 'zonefile_hash',type: 'string',realtype: 'zonefile_hash',pattern: ZONEFILE_HASH_PATTERN,},],minItems: 1,maxItems: 1,help:'Get a zone file by hash.\n' +'\n' +'Example:\n' +'\n' +' $ stx get_zonefile ee77ad484b7b229f09461e4c2b6d3bd3e152ba95\n' +' $ORIGIN ryanshea.id\n' +' $TTL 3600\n' +' _http._tcp URI 10 1 "https://gaia.blockstack.org/hub/15BcxePn59Y6mYD2fRLCLCaaHScefqW2No/1/profile.json"\n' +'\n',group: 'Peer Services',},help: {type: 'array',items: [{name: 'command',type: 'string',realtype: 'command',},],minItems: 0,maxItems: 1,help: 'Get the usage string for a CLI command',group: 'CLI',},lookup: {type: 'array',items: [{name: 'blockstack_id',type: 'string',realtype: 'blockstack_id',pattern: `${NAME_PATTERN}|${SUBDOMAIN_PATTERN}$`,},],minItems: 1,maxItems: 1,help:'Get and authenticate the profile and zone file for a Blockstack ID.\n' +'\n' +'Example:\n' +'\n' +' $ stx lookup example.id\n' +'\n',group: 'Querying Blockstack IDs',},names: {type: 'array',items: [{name: 'id_address',type: 'string',realtype: 'id-address',pattern: ID_ADDRESS_PATTERN,},],minItems: 1,maxItems: 1,help:'Get the list of Blockstack IDs owned by an ID-address.\n' +'\n' +'Example:\n' +'\n' +' $ stx names ID-1FpBChfzHG3TdQQRKWAipbLragCUArueG9\n' +'\n',group: 'Querying Blockstack IDs',},make_keychain: {type: 'array',items: [{name: 'backup_phrase',type: 'string',realtype: '12_words_or_ciphertext',},],minItems: 0,maxItems: 1,help:'Generate the owner and payment private keys, optionally from a given 12-word ' +'backup phrase. If no backup phrase is given, a new one will be generated. If you provide ' +'your encrypted backup phrase, you will be asked to decrypt it.\n' +'\n' +'Example:\n' +'\n' +' $ stx make_keychain\n' +' {\n' +' "mnemonic": "apart spin rich leader siren foil dish sausage fee pipe ethics bundle",\n' +' "keyInfo": {\n' +' "privateKey": "56d30f2b605ed114c7dc45599ae521c525d07e1286fbab67452a6586ea49332a01"\n' +' "address": "SP3G19B6J50FH6JGXAKS06N6WA1XPJCKKM4JCHC2D"\n' +' "btcAddress": "1Nixy2aB3miBreDTGTjieyh2hGng55k1rw"\n' +' "index": 0,\n' +' }\n' +' }\n' +'\n',group: 'Key Management',},make_zonefile: {type: 'array',items: [{name: 'blockstack_id',type: 'string',realtype: 'blockstack_id',pattern: `^${NAME_PATTERN}|${SUBDOMAIN_PATTERN}$`,},{name: 'id_address',type: 'string',realtype: 'ID-address',pattern: ID_ADDRESS_PATTERN,},{name: 'gaia_url_prefix',type: 'string',realtype: 'url',pattern: '.+',},{name: 'resolver_url',type: 'string',realtype: 'url',pattern: '.+',},],minItems: 3,maxItems: 4,help:'Generate a zone file for a Blockstack ID with the given profile URL. If you know ' +'the ID-address for the Blockstack ID, the profile URL usually takes the form of:\n' +'\n' +' {GAIA_URL_PREFIX}/{ADDRESS}/profile.json\n' +'\n' +'where `{GAIA_URL_PREFIX}` is the *read* endpoint of your Gaia hub (e.g. https://gaia.blockstack.org/hub) and ' +"`{ADDRESS}` is the base58check part of your ID-address (i.e. the string following 'ID-').\n" +'\n' +'Example:\n' +'\n' +' $ stx make_zonefile example.id ID-1ArdkA2oLaKnbNbLccBaFhEV4pYju8hJ82 https://my.gaia.hub/hub\n' +' $ORIGIN example.id\n' +' $TTL 3600\n' +' _http._tcp IN URI 10 1 "https://my.gaia.hub/hub/1ArdkA2oLaKnbNbLccBaFhEV4pYju8hJ82/profile.json"\n' +'\n',group: 'Peer Services',},name_import: {type: 'array',items: [{name: 'blockstack_id',type: 'string',realtype: 'blockstack_id',pattern: NAME_PATTERN,},{name: 'id_address',type: 'string',realtype: 'id-address',pattern: ID_ADDRESS_PATTERN,},{name: 'gaia_url_prefix',type: 'string',realtype: 'url',pattern: '.+',},{name: 'reveal_key',type: 'string',realtype: 'private_key',pattern: `${PRIVATE_KEY_PATTERN_ANY}`,},{name: 'zonefile',type: 'string',realtype: 'path',pattern: '.+',},{name: 'zonefile_hash',type: 'string',realtype: 'zonefile_hash',pattern: ZONEFILE_HASH_PATTERN,},],minItems: 4,maxItems: 6,help:'Import a name into a namespace you revealed. The `REVEAL_KEY` must be the same as ' +'the key that revealed the namespace. You can only import a name into a namespace if ' +'the namespace has not yet been launched (i.e. via `namespace_ready`), and if the ' +'namespace was revealed less than a year ago (52595 blocks ago).\n' +'\n' +'A zone file will be generated for this name automatically, if "ZONEFILE" is not given. By default, ' +"the zone file will have a URL to the name owner's profile prefixed by `GAIA_URL_PREFIX`. If you " +"know the *write* endpoint for the name owner's Gaia hub, you can find out the `GAIA_URL_PREFIX` " +'to use with `curl $GAIA_HUB/hub_info`".\n' +'\n' +'If you specify an argument for `ZONEFILE`, then the `GAIA_URL_PREFIX` argument is ignored in favor of ' +'your custom zone file on disk.\n' +'\n' +'If you specify a valid zone file hash for `ZONEFILE_HASH` then it will be used in favor of ' +'both `ZONEFILE` and `GAIA_URL_PREFIX`. The zone file hash will be incorporated directly into the ' +'name-import transaction.\n' +'\n' +'This command prints out a transaction ID if it succeeds, and it replicates the zone file (if given) ' +'to a transaction broadcaster (you can choose which one with -T). The zone file will be automatically ' +'broadcast to the Blockstack peer network when the transaction confirms. Alternatively, you can do so ' +'yourself with the `zonefile_push` command.\n' +'\n' +'Example:\n' +'\n' +' $ export REVEAL_KEY="bfeffdf57f29b0cc1fab9ea197bb1413da2561fe4b83e962c7f02fbbe2b1cd5401"\n' +' $ export ID_ADDRESS="ID-18e1bqU7B5qUPY3zJgMLxDnexyStTeSnvV"\n' +' $ stx name_import example.id "$ID_ADDRESS" https://gaia.blockstack.org/hub "$REVEAL_KEY"\n' +' f726309cea7a9db364307466dc0e0e759d5c0d6bad1405e2fd970740adc7dc45\n' +'\n',group: 'Namespace Operations',},namespace_preorder: {type: 'array',items: [{name: 'namespace_id',type: 'string',realtype: 'namespace_id',pattern: NAMESPACE_PATTERN,},{name: 'reveal_address',type: 'string',realtype: 'address',pattern: ADDRESS_PATTERN,},{name: 'payment_key',type: 'string',realtype: 'private_key',pattern: `${PRIVATE_KEY_PATTERN_ANY}`,},],minItems: 3,maxItems: 3,help:'Preorder a namespace. This is the first of three steps to creating a namespace. ' +'Once this transaction is confirmed, you will need to use the `namespace_reveal` command ' +'to reveal the namespace (within 24 hours, or 144 blocks).',group: 'Namespace Operations',},namespace_reveal: {type: 'array',items: [{name: 'namespace_id',type: 'string',realtype: 'namespace_id',pattern: NAMESPACE_PATTERN,},{name: 'reveal_address',type: 'string',realtype: 'address',pattern: ADDRESS_PATTERN,},{// versionname: 'version',type: 'string',realtype: '2-byte-integer',pattern: INT_PATTERN,},{// lifetimename: 'lifetime',type: 'string',realtype: '4-byte-integer',pattern: INT_PATTERN,},{// coeffname: 'coefficient',type: 'string',realtype: '1-byte-integer',pattern: INT_PATTERN,},{// basename: 'base',type: 'string',realtype: '1-byte-integer',pattern: INT_PATTERN,},{// bucketsname: 'price_buckets',type: 'string',realtype: 'csv-of-16-nybbles',pattern: '^([0-9]{1,2},){15}[0-9]{1,2}$',},{// non-alpha discountname: 'nonalpha_discount',type: 'string',realtype: 'nybble',pattern: INT_PATTERN,},{// no-vowel discountname: 'no_vowel_discount',type: 'string',realtype: 'nybble',pattern: INT_PATTERN,},{name: 'payment_key',type: 'string',realtype: 'private_key',pattern: `${PRIVATE_KEY_PATTERN_ANY}`,},],minItems: 10,maxItems: 10,help:'Reveal a preordered namespace, and set the price curve and payment options. ' +'This is the second of three steps required to create a namespace, and must be done ' +'shortly after the associated `namespace_preorder` command.',group: 'Namespace Operations',},namespace_ready: {type: 'array',items: [{name: 'namespace_id',type: 'string',realtype: 'namespace_id',pattern: NAMESPACE_PATTERN,},{name: 'reveal_key',type: 'string',realtype: 'private_key',pattern: `${PRIVATE_KEY_PATTERN_ANY}`,},],minItems: 2,maxItems: 2,help:'Launch a revealed namespace. This is the third and final step of creating a namespace. ' +'Once launched, you will not be able to import names anymore.',group: 'Namespace Operations',},price: {type: 'array',items: [{name: 'blockstack_id',type: 'string',realtype: 'blockstack_id',pattern: NAME_PATTERN,},],minItems: 1,maxItems: 1,help:'Get the price of an on-chain Blockstack ID. Its namespace must already exist.\n' +'\n' +'Example:\n' +'\n' +' $ stx price example.id\n' +' {\n' +' "units": "BTC",\n' +' "amount": "5500"\n' +' }\n' +'\n',group: 'Querying Blockstack IDs',},price_namespace: {type: 'array',items: [{name: 'namespace_id',type: 'string',realtype: 'namespace_id',pattern: NAMESPACE_PATTERN,},],minItems: 1,maxItems: 1,help:'Get the price of a namespace.\n' +'\n' +'Example:\n' +'\n' +' $ # get the price of the .hello namespace\n' +' $ stx price_namespace hello\n' +' {\n' +' "units": "BTC",\n' +' "amount": "40000000"\n' +' }\n' +'\n',group: 'Namespace Operations',},profile_sign: {type: 'array',items: [{name: 'profile',type: 'string',realtype: 'path',},{name: 'owner_key',type: 'string',realtype: 'private_key',pattern: PRIVATE_KEY_PATTERN,},],minItems: 2,maxItems: 2,help:'Sign a profile on disk with a given owner private key. Print out the signed profile JWT.\n' +'\n' +'Example:\n' +'\n' +' $ # Tip: you can get the owner key from your 12-word backup phrase using the get_owner_keys command\n' +' $ stx profile_sign /path/to/profile.json 0ffd299af9c257173be8486ef54a4dd1373407d0629ca25ca68ff24a76be09fb01\n' +'\n',group: 'Profiles',},profile_store: {type: 'array',items: [{name: 'user_id',type: 'string',realtype: 'name-or-id-address',pattern: `${NAME_PATTERN}|${SUBDOMAIN_PATTERN}|${ID_ADDRESS_PATTERN}`,},{name: 'profile',type: 'string',realtype: 'path',},{name: 'owner_key',type: 'string',realtype: 'private_key',pattern: PRIVATE_KEY_PATTERN,},{name: 'gaia_hub',type: 'string',realtype: 'url',},],minItems: 4,maxItems: 4,help:'Store a profile on disk to a Gaia hub. `USER_ID` can be either a Blockstack ID or ' +"an ID-address. The `GAIA_HUB` argument must be the *write* endpoint for the user's Gaia hub " +'(e.g. https://hub.blockstack.org). You can verify this by ensuring that you can run ' +'`curl "$GAIA_HUB/hub_info"` successfully.',group: 'Profiles',},profile_verify: {type: 'array',items: [{name: 'profile',type: 'string',realtype: 'path',},{name: 'id_address',type: 'string',realtype: 'id-address',pattern: `${ID_ADDRESS_PATTERN}|${PUBLIC_KEY_PATTERN}`,},],minItems: 2,maxItems: 2,help:'Verify a JWT encoding a profile on disk using an ID-address. Prints out the contained profile on success.\n' +'\n' +'Example:\n' +'\n' +' $ # get the raw profile JWT\n' +' $ curl -sL https://raw.githubusercontent.com/jcnelson/profile/master/judecn.id > /tmp/judecn.id.jwt\n' +' $ # Tip: you can get the ID-address for a name with the "whois" command\n' +' $ stx profile_verify /tmp/judecn.id.jwt ID-16EMaNw3pkn3v6f2BgnSSs53zAKH4Q8YJg\n' +'\n',group: 'Profiles',},renew: {type: 'array',items: [{name: 'blockstack_id',type: 'string',realtype: 'on-chain-blockstack_id',pattern: NAME_PATTERN,},{name: 'owner_key',type: 'string',realtype: 'private_key',pattern: `${PRIVATE_KEY_PATTERN_ANY}`,},{name: 'payment_key',type: 'string',realtype: 'private_key',pattern: `${PRIVATE_KEY_PATTERN_ANY}`,},{name: 'new_id_address',type: 'string',realtype: 'id-address',pattern: ID_ADDRESS_PATTERN,},{name: 'zonefile',type: 'string',realtype: 'path',},{name: 'zonefile_hash',type: 'string',realtype: 'zonefile_hash',pattern: ZONEFILE_HASH_PATTERN,},],minItems: 3,maxItems: 6,help:'Renew a name. Optionally transfer it to a new owner address (`NEW_ID_ADDRESS`), ' +'and optionally load up and give it a new zone file on disk (`ZONEFILE`). If the command ' +'succeeds, it prints out a transaction ID. You can use with the `get_confirmations` ' +'command to track its confirmations on the underlying blockchain -- once it reaches 7 ' +'confirmations, the rest of the Blockstack peer network will process it.\n' +'\n' +'If you create a new zonefile for your name, you will need ' +'to later use `zonefile_push` to replicate the zone file to the Blockstack peer network ' +'once the transaction reaches 7 confirmations.\n' +'\n' +'Example:\n' +'\n' +' $ # Tip: you can get your owner key from your backup phrase with "get_owner_keys".\n' +' $ # Tip: you can get your payment key from your backup phrase with "get_payment_key".\n' +' $ export OWNER="136ff26efa5db6f06b28f9c8c7a0216a1a52598045162abfe435d13036154a1b01"\n' +' $ export PAYMENT="bfeffdf57f29b0cc1fab9ea197bb1413da2561fe4b83e962c7f02fbbe2b1cd5401"\n' +' $ stx renew hello_world.id "$OWNER" "$PAYMENT"\n' +' 3d8945ce76d4261678d76592b472ed639a10d4298f9d730af4edbbc3ec02882e\n' +'\n' +' $ # Renew with a new owner\n' +' $ export NEW_OWNER="ID-141BcmFVbEuuMb7Bd6umXyV6ZD1WYomYDE"\n' +' $ stx renew hello_world.id "$OWNER" "$PAYMENT" "$NEW_OWNER"\n' +' 33865625ef3f1b607111c0dfba9e58604927173bd2e299a343e19aa6d2cfb263\n' +'\n' +' $ # Renew with a new zone file.\n' +' $ # Tip: you can create a new zonefile with the "make_zonefile" command.\n' +' $ export ZONEFILE_PATH="/path/to/new/zonefile.txt"\n' +' $ stx renew hello_world.id "$OWNER" "$PAYMENT" --zonefile "$ZONEFILE_PATH"\n' +' e41ce043ab64fd5a5fd382fba21acba8c1f46cbb1d7c08771ada858ce7d29eea\n' +' $ # wait 7 confirmations\n' +' $ stx get_confirmations e41ce043ab64fd5a5fd382fba21acba8c1f46cbb1d7c08771ada858ce7d29eea\n' +' {\n' +' "blockHeight": 567890,\n' +' "confirmations": 7,\n' +' }\n' +' $ stx -H https://core.blockstack.org zonefile_push "$ZONEFILE_PATH"\n' +' [\n' +' "https://core.blockstack.org"\n' +' ]\n' +'\n',group: 'Blockstack ID Management',},register: {type: 'array',items: [{name: 'blockstack_id',type: 'string',realtype: 'on-chain-blockstack_id',pattern: NAME_PATTERN,},{name: 'owner_key',type: 'string',realtype: 'private_key',pattern: PRIVATE_KEY_PATTERN,},{name: 'payment_key',type: 'string',realtype: 'private_key',pattern: `${PRIVATE_KEY_PATTERN_ANY}`,},{name: 'gaia_hub',type: 'string',realtype: 'url',},{name: 'zonefile',type: 'string',realtype: 'path',},],minItems: 4,maxItems: 5,help:'If you are trying to register a name for a *private key*, use this command.\n' +'\n' +'Register a name to a single name-owning private key. After successfully running this command, ' +'and after waiting a couple hours, your name will be ready to use and will resolve to a ' +'signed empty profile hosted on the given Gaia hub (`GAIA_HUB`).\n' +'\n' +'Behind the scenes, this will generate and send two transactions ' +'and generate and replicate a zone file with the given Gaia hub URL (`GAIA_HUB`). ' +'Note that the `GAIA_HUB` argument must correspond to the *write* endpoint of the Gaia hub ' +'(i.e. you should be able to run \'curl "$GAIA_HUB/hub_info"\' and get back data). If you ' +'are using Blockstack PBC\'s default Gaia hub, pass "https://hub.blockstack.org" for this ' +'argument.\n' +'\n' +"By default, this command generates a zone file automatically that points to the Gaia hub's " +'read endpoint (which is queried on-the-fly from `GAIA_HUB`). If you instead want to have a custom zone file for this name, ' +'you can specify a path to it on disk with the `ZONEFILE` argument.\n' +'\n' +'If this command completes successfully, your name will be ready to use once both transactions have 7+ confirmations. ' +'You can use the `get_confirmations` command to track the confirmations ' +'on the transaction IDs returned by this command.\n' +'\n' +'WARNING: You should *NOT* use the payment private key (`PAYMENT_KEY`) while the name is being confirmed. ' +'If you do so, you could double-spend one of the pending transactions and lose your name.\n' +'\n' +'Example:\n' +'\n' +' $ export OWNER="136ff26efa5db6f06b28f9c8c7a0216a1a52598045162abfe435d13036154a1b01"\n' +' $ export PAYMENT="bfeffdf57f29b0cc1fab9ea197bb1413da2561fe4b83e962c7f02fbbe2b1cd5401"\n' +' $ stx register example.id "$OWNER" "$PAYMENT" https://hub.blockstack.org\n' +' 9bb908bfd4ab221f0829167a461229172184fc825a012c4e551533aa283207b1\n' +'\n',group: 'Blockstack ID Management',},register_addr: {type: 'array',items: [{name: 'blockstack_id',type: 'string',realtype: 'blockstack_id',pattern: NAME_PATTERN,},{name: 'id-address',type: 'string',realtype: 'id-address',pattern: ID_ADDRESS_PATTERN,},{name: 'payment_key',type: 'string',realtype: 'private_key',pattern: `${PRIVATE_KEY_PATTERN_ANY}`,},{name: 'gaia_url_prefix',type: 'string',realtype: 'url',},{name: 'zonefile',type: 'string',realtype: 'path',},],minItems: 4,maxItems: 5,help:'If you are trying to register a name for an *ID-address*, use this command.\n' +'\n' +"Register a name to someone's ID-address. After successfully running this " +'command and waiting a couple of hours, the name will be registered on-chain and have a ' +"zone file with a URL to where the owner's profile should be. This command does NOT " +'generate, sign, or replicate a profile for the name---the name owner will need to do this ' +'separately, once the name is registered.\n' +'\n' +'Behind the scenes, this command will generate two ' +'transactions, and generate and replicate a zone file with the given Gaia hub read URL ' +'(`GAIA_URL_PREFIX`). Note that the `GAIA_URL_PREFIX` argument must correspond to the *read* endpoint of the Gaia hub ' +'(e.g. if you are using Blockstack PBC\'s default Gaia hub, this is "https://gaia.blockstack.org/hub"). ' +"If you know the *write* endpoint of the name owner's Gaia hub, you can find the right value for " +'`GAIA_URL_PREFIX` by running "curl $GAIA_HUB/hub_info".\n' +'\n' +'No profile will be generated or uploaded by this command. Instead, this command generates ' +'a zone file that will include the URL to a profile based on the `GAIA_URL_PREFIX` argument.\n' +'\n' +'The zone file will be generated automatically from the `GAIA_URL_PREFIX` argument. If you need ' +'to use a custom zone file, you can pass the path to it on disk via the `ZONEFILE` argument.\n' +'\n' +'If this command completes successfully, the name will be ready to use in a couple of ' +'hours---that is, once both transactions have 7+ confirmations. ' +'You can use the `get_confirmations` command to track the confirmations.\n' +'\n' +'WARNING: You should *NOT* use the payment private key (`PAYMENT_KEY`) while the name is being confirmed. ' +'If you do so, you could double-spend one of the pending transactions and lose the name.\n' +'\n' +'Example:\n' +'\n' +' $ export ID_ADDRESS="ID-18e1bqU7B5qUPY3zJgMLxDnexyStTeSnvV"\n' +' $ export PAYMENT="bfeffdf57f29b0cc1fab9ea197bb1413da2561fe4b83e962c7f02fbbe2b1cd5401"\n' +' $ stx register_addr example.id "$ID_ADDRESS" "$PAYMENT" https://gaia.blockstack.org/hub',group: 'Blockstack ID Management',},register_subdomain: {type: 'array',items: [{name: 'blockstack_id',type: 'string',realtype: 'blockstack_id',pattern: SUBDOMAIN_PATTERN,},{name: 'owner_key',type: 'string',realtype: 'private_key',pattern: PRIVATE_KEY_PATTERN,},{name: 'gaia_hub',type: 'string',realtype: 'url',},{name: 'registrar',type: 'string',realtype: 'url',},{name: 'zonefile',type: 'string',realtype: 'path',},],minItems: 4,maxItems: 5,help:'Register a subdomain. This will generate and sign a subdomain zone file record ' +'with the given `GAIA_HUB` URL and send it to the given subdomain registrar (`REGISTRAR`).\n' +'\n' +'This command generates, signs, and uploads a profile to the `GAIA_HUB` url. Note that the `GAIA_HUB` ' +'argument must correspond to the *write* endpoint of your Gaia hub (i.e. you should be able ' +"to run 'curl \"$GAIA_HUB/hub_info\"' successfully). If you are using Blockstack PBC's default " +'Gaia hub, this argument should be "https://hub.blockstack.org".\n' +'\n' +'WARNING: At this time, no validation will occur on the registrar URL. Be sure that the URL ' +'corresponds to the registrar for the on-chain name before running this command!\n' +'\n' +'Example:\n' +'\n' +' $ export OWNER="6e50431b955fe73f079469b24f06480aee44e4519282686433195b3c4b5336ef01"\n' +' $ # NOTE: https://registrar.blockstack.org is the registrar for personal.id!\n' +' $ stx register_subdomain hello.personal.id "$OWNER" https://hub.blockstack.org https://registrar.blockstack.org\n',group: 'Blockstack ID Management',},revoke: {type: 'array',items: [{name: 'blockstack_id',type: 'string',realtype: 'on-chain-blockstack_id',pattern: NAME_PATTERN,},{name: 'owner_key',type: 'string',realtype: 'private_key',pattern: `${PRIVATE_KEY_PATTERN_ANY}`,},{name: 'payment_key',type: 'string',realtype: 'private_key',pattern: `${PRIVATE_KEY_PATTERN_ANY}`,},],minItems: 3,maxItems: 3,help:'Revoke a name. This renders it unusable until it expires (if ever). This command ' +'prints out the transaction ID if it succeeds. Once the transaction confirms, the name will ' +'be revoked by each node in the peer network. This command only works for on-chain names, not ' +'subdomains.\n' +'\n' +'Example:\n' +'\n' +' $ # Tip: you can get your owner and payment keys from your 12-word backup phrase using the get_owner_keys and get_payment_key commands.\n' +' $ export OWNER="6e50431b955fe73f079469b24f06480aee44e4519282686433195b3c4b5336ef01"\n' +' $ export PAYMENT="bfeffdf57f29b0cc1fab9ea197bb1413da2561fe4b83e962c7f02fbbe2b1cd5401"\n' +' $ stx revoke example.id "$OWNER" "$PAYMENT"\n' +' 233b559c97891affa010567bd582110508d0236b4e3f88d3b1d0731629e030b0\n' +'\n',group: 'Blockstack ID Management',},send_btc: {type: 'array',items: [{name: 'recipient_address',type: 'string',realtype: 'address',pattern: ADDRESS_PATTERN,},{name: 'amount',type: 'string',realtype: 'satoshis',pattern: INT_PATTERN,},{name: 'payment_key',type: 'string',realtype: 'private_key',pattern: `${PRIVATE_KEY_PATTERN_ANY}`,},],minItems: 3,maxItems: 3,help:'Send some Bitcoin (in satoshis) from a payment key to an address. Up to the given ' +'amount will be spent, but likely less---the actual amount sent will be the amount given, ' +'minus the transaction fee. For example, if you want to send 10000 satoshis but the ' +'transaction fee is 2000 satoshis, then the resulting transaction will send 8000 satoshis ' +'to the given address. This is to ensure that this command does not *over*-spend your ' +'Bitcoin. If you want to check the amount before spending, pass the `-x` flag to see the ' +'raw transaction.\n' +'\n' +'If the command succeeds, it prints out the transaction ID. You can track its confirmations ' +'with the `get_confirmations` command.\n' +'\n' +'Example:\n' +'\n' +' $ export PAYMENT="bfeffdf57f29b0cc1fab9ea197bb1413da2561fe4b83e962c7f02fbbe2b1cd5401"\n' +' $ stx send_btc 18qTSE5PPQmypwKKej7QX5Db2XAttgYeA1 123456 "$PAYMENT"\n' +' c7e239fd24da30e36e011e6bc7db153574a5b40a3a8dc3b727adb54ad038acc5\n' +'\n',group: 'Account Management',},send_tokens: {type: 'array',items: [{name: 'address',type: 'string',realtype: 'address',pattern: STACKS_ADDRESS_PATTERN,},{name: 'amount',type: 'string',realtype: 'integer',pattern: '^[0-9]+$',},{name: 'fee',type: 'string',realtype: 'integer',pattern: '^[0-9]+$',},{name: 'nonce',type: 'string',realtype: 'integer',pattern: '^[0-9]+$',},{name: 'payment_key',type: 'string',realtype: 'private_key',pattern: `${PRIVATE_KEY_PATTERN_ANY}`,},{name: 'memo',type: 'string',realtype: 'string',pattern: '^.{0,34}$',},],minItems: 5,maxItems: 6,help:'Send a particular type of tokens to the given `ADDRESS`. Right now, only supported `TOKEN-TYPE` is `STACKS`. Optionally ' +'include a memo string (`MEMO`) up to 34 characters long.\n' +'\n' +'If the command succeeds, it prints out a transaction ID. You can track the confirmations on the transaction ' +'via the `get_confirmations` command. Once the transaction has 7 confirmations, the Blockstack peer network ' +'will have processed it, and your payment key balance and recipient balance will be updated.\n' +'\n' +'Example:\n' +'\n' +' $ # check balances of sender and recipient before sending.\n' +' $ # address of the key below is SP2SC16ASH76GX549PT7J5WQZA4GHMFBKYMBQFF9V\n' +' $ export PAYMENT="bfeffdf57f29b0cc1fab9ea197bb1413da2561fe4b83e962c7f02fbbe2b1cd5401"\n' +' $ stx balance SP2SC16ASH76GX549PT7J5WQZA4GHMFBKYMBQFF9V\n' +' {\n' +' "STACKS": "10000000"\n' +' }\n' +' $ stx balance SP1P10PS2T517S4SQGZT5WNX8R00G1ECTRKYCPMHY\n' +' {\n' +' "STACKS": "0"\n' +' }\n' +'\n' +' $ # send tokens\n' +' $ stx send_tokens SP1P10PS2T517S4SQGZT5WNX8R00G1ECTRKYCPMHY 12345 1 0 "$PAYMENT"\n' +' {\n' +" txid: '0x2e33ad647a9cedacb718ce247967dc705bc0c878db899fdba5eae2437c6fa1e1'," +" transaction: 'https://explorer.stacks.co/txid/0x2e33ad647a9cedacb718ce247967dc705bc0c878db899fdba5eae2437c6fa1e1'" +' }\n' +' a9d387a925fb0ba7a725fb1e11f2c3f1647473699dd5a147c312e6453d233456\n' +'\n' +' $ # wait for transaction to be confirmed\n' +'\n' +' $ stx balance SP2SC16ASH76GX549PT7J5WQZA4GHMFBKYMBQFF9V\n' +' {\n' +' "STACKS": "9987655"\n' +' }\n' +' $ stx balance SP1P10PS2T517S4SQGZT5WNX8R00G1ECTRKYCPMHY\n' +' {\n' +' "STACKS": "12345"\n' +' }\n' +'\n',group: 'Account Management',},stack: {type: 'array',items: [{name: 'amount',type: 'string',realtype: 'integer',pattern: '^[0-9]+$',},{name: 'cycles',type: 'string',realtype: 'integer',pattern: '^[0-9]+$',},{name: 'pox_address',type: 'string',realtype: 'integer',pattern: `${ADDRESS_PATTERN}`,},{name: 'private_key',type: 'string',realtype: 'private_key',pattern: `${PRIVATE_KEY_PATTERN_ANY}`,},{name: 'fee',type: 'string',realtype: 'integer',pattern: '^[0-9]+$',},{name: 'nonce',type: 'string',realtype: 'integer',pattern: '^[0-9]+$',},],minItems: 4,maxItems: 6,help:'Stack the specified number of Stacks tokens for given number of cycles.\n' +'\n' +'Example:\n' +'\n' +' $ stx stack 10000000 20 16pm276FpJYpm7Dv3GEaRqTVvGPTdceoY4 136ff26efa5db6f06b28f9c8c7a0216a1a52598045162abfe435d13036154a1b01\n' +' {\n' +" txid: '0x2e33ad647a9cedacb718ce247967dc705bc0c878db899fdba5eae2437c6fa1e1'," +" transaction: 'https://explorer.stacks.co/txid/0x2e33ad647a9cedacb718ce247967dc705bc0c878db899fdba5eae2437c6fa1e1'" +' }\n',group: 'Account Management',},stacking_status: {type: 'array',items: [{name: 'pox_address',type: 'string',realtype: 'integer',pattern: `${STACKS_ADDRESS_PATTERN}`,},],minItems: 1,maxItems: 1,help:'Get stacking status for specified address.\n' +'\n' +'Example:\n' +'\n' +' $ stx stacking_status SPZY1V53Z4TVRHHW9Z7SFG8CZNRAG7BD8WJ6SXD0\n',group: 'Account Management',},transfer: {type: 'array',items: [{name: 'blockstack_id',type: 'string',realtype: 'on-chain-blockstack_id',pattern: NAME_PATTERN,},{name: 'new_id_address',type: 'string',realtype: 'id-address',pattern: ID_ADDRESS_PATTERN,},{name: 'keep_zonefile',type: 'string',realtype: 'true-or-false',pattern: '^true$|^false$',},{name: 'owner_key',type: 'string',realtype: 'private_key',pattern: `${PRIVATE_KEY_PATTERN_ANY}`,},{name: 'payment_key',type: 'string',realtype: 'private_key',pattern: `${PRIVATE_KEY_PATTERN_ANY}`,},],minItems: 5,maxItems: 5,help:'Transfer a Blockstack ID to a new address (`NEW_ID_ADDRESS`). Optionally preserve ' +'its zone file (`KEEP_ZONEFILE`). If the command succeeds, it will print a transaction ID. ' +'Once the transaction reaches 7 confirmations, the Blockstack peer network will transfer the ' +"Blockstack ID to the new ID-address. You can track the transaction's confirmations with " +'the `get_confirmations` command.\n' +'\n' +'NOTE: This command only works for on-chain Blockstack IDs. It does not yet work for subdomains.\n' +'\n' +'An ID-address can only own up to 25 Blockstack IDs. In practice, you should generate a new ' +'owner key and ID-address for each name you receive (via the `get_owner_keys` command).\n' +'\n' +'Example:\n' +'\n' +' $ # Tip: you can get your owner key from your backup phrase with "get_owner_keys".\n' +' $ # Tip: you can get your payment key from your backup phrase with "get_payment_key".\n' +' $ export OWNER="136ff26efa5db6f06b28f9c8c7a0216a1a52598045162abfe435d13036154a1b01"\n' +' $ export PAYMENT="bfeffdf57f29b0cc1fab9ea197bb1413da2561fe4b83e962c7f02fbbe2b1cd5401"\n' +' $ stx transfer example.id ID-1HJA1AJvWef21XbQVL2AcTv71b6JHGPfDX true "$OWNER" "$PAYMENT"\n' +' e09dc158e586d0c09dbcdcba917ec394e6c6ac2b9c91c4b55f32f5973e4f08fc\n' +'\n',group: 'Blockstack ID Management',},tx_preorder: {type: 'array',items: [{name: 'blockstack_id',type: 'string',realtype: 'on-chain-blockstack_id',pattern: NAME_PATTERN,},{name: 'id_address',type: 'string',realtype: 'id-address',pattern: ID_ADDRESS_PATTERN,},{name: 'payment_key',type: 'string',realtype: 'private_key',pattern: `${PRIVATE_KEY_PATTERN_ANY}`,},],minItems: 3,maxItems: 3,help:'Generate and send `NAME_PREORDER` transaction, for a Blockstack ID to be owned ' +'by a given `ID_ADDRESS`. The name cost will be paid for by the gven `PAYMENT_KEY`. The ' +'ID-address should be a never-before-seen address, since it will be used as a salt when ' +'generating the name preorder hash.\n' +'\n' +'This is a low-level command that only experienced Blockstack developers should use. ' +'If you just want to register a name, use the "register" command.\n',group: 'Blockstack ID Management',},tx_register: {type: 'array',items: [{name: 'blockstack_id',type: 'string',realtype: 'on-chain-blockstack_id',pattern: NAME_PATTERN,},{name: 'id_address',type: 'string',realtype: 'id-address',pattern: ID_ADDRESS_PATTERN,},{name: 'payment_key',type: 'string',realtype: 'private_key',pattern: `${PRIVATE_KEY_PATTERN_ANY}`,},{name: 'zonefile',type: 'string',realtype: 'path',},{name: 'zonefile_hash',type: 'string',realtype: 'zoenfile_hash',pattern: ZONEFILE_HASH_PATTERN,},],minItems: 3,maxItems: 5,help:'Generate and send a NAME_REGISTRATION transaction, assigning the given `BLOCKSTACK_ID` ' +'to the given `ID_ADDRESS`. Optionally pair the Blockstack ID with a zone file (`ZONEFILE`) or ' +'the hash of the zone file (`ZONEFILE_HASH`). You will need to push the zone file to the peer ' +'network after the transaction confirms (i.e. with `zonefile_push`).\n' +'\n' +'This is a low-level command that only experienced Blockstack developers should use. If you ' +'just want to register a name, you should use the `register` command.',group: 'Blockstack ID Management',},update: {type: 'array',items: [{name: 'blockstack_id',type: 'string',realtype: 'on-chain-blockstack_id',pattern: NAME_PATTERN,},{name: 'zonefile',type: 'string',realtype: 'path',},{name: 'owner_key',type: 'string',realtype: 'private_key',pattern: `${PRIVATE_KEY_PATTERN_ANY}`,},{name: 'payment_key',type: 'string',realtype: 'private_key',pattern: `${PRIVATE_KEY_PATTERN_ANY}`,},{name: 'zonefile_hash',type: 'string',realtype: 'zonefile_hash',pattern: ZONEFILE_HASH_PATTERN,},],minItems: 4,maxItems: 5,help:'Update the zonefile for an on-chain Blockstack ID. You can generate a well-formed ' +'zone file using the `make_zonefile` command, or you can supply your own. Zone files can be ' +'up to 40Kb. Alternatively, if you only want to announce the hash of a zone file (or any ' +'arbitrary 20-byte hex string), you can do so by passing a value for `ZONEFILE_HASH`. If `ZONEFILE_HASH` ' +'is given, then the value for `ZONEFILE` will be ignored.\n' +'\n' +'If this command succeeds, it prints out a transaction ID. Once the transaction has 7 confirmations, ' +"the Blockstack peer network will set the name's zone file hash to the `RIPEMD160`(SHA256) hash of " +'the given zone file (or it will simply set it to the hash given in `ZONEFILE_HASH`).\n' +'\n' +'Once the transaction confirms, you will need to replicate the zone file to the Blockstack peer network. ' +'This can be done with the `zonefile_push` command. Until you do so, no Blockstack clients will be able ' +'to obtain the zone file announced by this command.\n' +'\n' +'Example:\n' +'\n' +' $ # Tip: you can get your owner and payment keys from your 12-word backup phrase using the get_owner_keys and get_payment_key commands.\n' +' $ export OWNER="6e50431b955fe73f079469b24f06480aee44e4519282686433195b3c4b5336ef01"\n' +' $ export PAYMENT="bfeffdf57f29b0cc1fab9ea197bb1413da2561fe4b83e962c7f02fbbe2b1cd5401"\n' +' $ # make a new zone file\n' +' $ stx make_zonefile example.id ID-1ArdkA2oLaKnbNbLccBaFhEV4pYju8hJ82 https://my.gaia.hub/hub > /tmp/zonefile.txt\n' +' \n' +' $ # update the name to reference this new zone file\n' +' $ stx update example.id /tmp/zonefile.txt "$OWNER" "$PAYMENT"\n' +' 8e94a5b6647276727a343713d3213d587836e1322b1e38bc158406f5f8ebe3fd\n' +' \n' +' $ # check confirmations\n' +' $ stx get_confirmations e41ce043ab64fd5a5fd382fba21acba8c1f46cbb1d7c08771ada858ce7d29eea\n' +' {\n' +' "blockHeight": 567890,\n' +' "confirmations": 7,\n' +' }\n' +' \n' +' $ # send out the new zone file to a Blockstack peer\n' +' $ stx -H https://core.blockstack.org zonefile_push /tmp/zonefile.txt\n' +' [\n' +' "https://core.blockstack.org"\n' +' ]\n' +'\n',group: 'Blockstack ID Management',},whois: {type: 'array',items: [{name: 'blockstack_id',type: 'string',realtype: 'blockstack_id',pattern: NAME_PATTERN + '|' + SUBDOMAIN_PATTERN,},],minItems: 1,maxItems: 1,help:'Look up the zone file and owner of a Blockstack ID. Works with both on-chain and off-chain names.\n' +'\n' +'Example:\n' +'\n' +' $ stx whois example.id\n' +' {\n' +' "address": "1ArdkA2oLaKnbNbLccBaFhEV4pYju8hJ82",\n' +' "block_renewed_at": 567890,\n' +' "blockchain": "bitcoin",\n' +' "expire_block": 687010,\n' +' "grace_period": false,\n' +' "last_transaction_height": "567891",\n' +' "last_txid": "a564aa482ee43eb2bdfb016e01ea3b950bab0cfa39eace627d632e73c7c93e48",\n' +' "owner_script": "76a9146c1c2fc3cf74d900c51e9b5628205130d7b98ae488ac",\n' +' "renewal_deadline": 692010,\n' +' "resolver": null,\n' +' "status": "registered",\n' +' "zonefile": "$ORIGIN example.id\\n$TTL 3600\\n_http._tcp URI 10 1 \\"https://gaia.blockstack.org/hub/1ArdkA2oLaKnbNbLccBaFhEV4pYju8hJ82/profile.json\\"\\n",\n' +' "zonefile_hash": "ae4ee8e7f30aa890468164e667e2c203266f726e"\n' +' }\n' +'\n',group: 'Querying Blockstack IDs',},zonefile_push: {type: 'array',items: [{name: 'zonefile',type: 'string',realtype: 'path',},],minItems: 1,maxItems: 1,help:'Push a zone file on disk to the Blockstack peer network. The zone file must ' +'correspond to a zone file hash that has already been announced. That is, you use this command ' +'in conjunction with the `register`, `update`, `renew`, or `name_import` commands.\n' +'\n' +'Example:\n' +'\n' +' $ stx -H https://core.blockstack.org zonefile_push /path/to/zonefile.txt\n' +' [\n' +' "https://core.blockstack.org"\n' +' ]\n' +'\n',group: 'Peer Services',},get_did_configuration: {type: 'array',items: [{name: 'blockstack_id',type: 'string',realtype: 'blockstack_id',pattern: NAME_PATTERN + '|' + SUBDOMAIN_PATTERN,},{name: 'domain',type: 'string',realtype: 'domain',pattern: NAME_PATTERN + '|' + SUBDOMAIN_PATTERN,},{name: 'owner_key',type: 'string',realtype: 'private_key',pattern: `${PRIVATE_KEY_PATTERN}`,},],minItems: 3,maxItems: 3,help:'Creates a DID configuration for the given blockstack id and domain to create a link between both.' +'The specification is define by the Decentralized Identity Foundation at https://identity.foundation/specs/did-configuration/\n' +'The DID configuration should be placed in the json file ".well_known/did_configuration"' +'\n' +'Example:\n' +'\n' +' $ # Tip: you can get your owner keys from your 12-word backup phrase using the get_owner_keys command.\n' +' $ export PRIVATE_OWNER_KEY="6e50431b955fe73f079469b24f06480aee44e4519282686433195b3c4b5336ef01"\n' +' $ stx get_did_configuration public_profile_for_testing.id.blockstack helloblockstack.com PRIVATE_OWNER_KEY\n' +' {\n' +' "entries": [\n' +' {\n' +' "did": "did:stack:v0:SewTRvPZUEQGdr45QvEnVMGHZBhx3FT1Jj-0",\n' +' "jwt": "eyJ0eXAiOiJKV1QiL...."\n' +' }\n' +' ]\n' +' }\n' +'\n' +'The decoded content of the jwt above is \n' +' {\n' +' "header": {\n' +' "typ": "JWT", "alg": "ES256K"\n' +' },\n' +' "payload": {\n' +' "iss": "did:stack:v0:SewTRvPZUEQGdr45QvEnVMGHZBhx3FT1Jj-0",\n' +' "domain": "helloblockstack.com",\n' +' "exp": "2020-12-07T13:05:28.375Z"\n' +' },\n' +' "signature": "NDY7ISzgAHKcZDvbxzTxQdVnf6xWMZ46w5vHcDpNx_1Fsyip0M6E6GMq_2YZ-gUcwmwlo8Ag9jgnfOkaBIFpoQ"\n' +' }\n' +'\n',group: 'DID',},} as CLI_PROP</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#L135">packages/cli/src/argparse.ts:135</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
|
<a name="cli_args.strict" class="tsd-anchor"></a>
|
|
<h3>strict</h3>
|
|
<div class="tsd-signature tsd-kind-icon">strict<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</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#L2726">packages/cli/src/argparse.ts:2726</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
|
<a name="cli_args.type" class="tsd-anchor"></a>
|
|
<h3>type</h3>
|
|
<div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "object"</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#L134">packages/cli/src/argparse.ts:134</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-object-literal">
|
|
<a name="commands" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> COMMANDS</h3>
|
|
<div class="tsd-signature tsd-kind-icon">COMMANDS<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</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#L1723">packages/cli/src/cli.ts:1723</a></li>
|
|
</ul>
|
|
</aside>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
|
<a name="commands.authenticator" class="tsd-anchor"></a>
|
|
<h3>authenticator</h3>
|
|
<div class="tsd-signature tsd-kind-icon">authenticator<span class="tsd-signature-symbol">:</span> <a href="globals.html#authdaemon" class="tsd-signature-type">authDaemon</a><span class="tsd-signature-symbol"> = authDaemon</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#L1724">packages/cli/src/cli.ts:1724</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
|
<a name="commands.balance" class="tsd-anchor"></a>
|
|
<h3>balance</h3>
|
|
<div class="tsd-signature tsd-kind-icon">balance<span class="tsd-signature-symbol">:</span> <a href="globals.html#balance" class="tsd-signature-type">balance</a><span class="tsd-signature-symbol"> = balance</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#L1726">packages/cli/src/cli.ts:1726</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
|
<a name="commands.call_contract_func" class="tsd-anchor"></a>
|
|
<h3>call_<wbr>contract_<wbr>func</h3>
|
|
<div class="tsd-signature tsd-kind-icon">call_<wbr>contract_<wbr>func<span class="tsd-signature-symbol">:</span> <a href="globals.html#contractfunctioncall" class="tsd-signature-type">contractFunctionCall</a><span class="tsd-signature-symbol"> = contractFunctionCall</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#L1728">packages/cli/src/cli.ts:1728</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
|
<a name="commands.call_read_only_contract_func" class="tsd-anchor"></a>
|
|
<h3>call_<wbr>read_<wbr>only_<wbr>contract_<wbr>func</h3>
|
|
<div class="tsd-signature tsd-kind-icon">call_<wbr>read_<wbr>only_<wbr>contract_<wbr>func<span class="tsd-signature-symbol">:</span> <a href="globals.html#readonlycontractfunctioncall" class="tsd-signature-type">readOnlyContractFunctionCall</a><span class="tsd-signature-symbol"> = readOnlyContractFunctionCall</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#L1729">packages/cli/src/cli.ts:1729</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
|
<a name="commands.can_stack" class="tsd-anchor"></a>
|
|
<h3>can_<wbr>stack</h3>
|
|
<div class="tsd-signature tsd-kind-icon">can_<wbr>stack<span class="tsd-signature-symbol">:</span> <a href="globals.html#canstack" class="tsd-signature-type">canStack</a><span class="tsd-signature-symbol"> = canStack</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#L1727">packages/cli/src/cli.ts:1727</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
|
<a name="commands.convert_address" class="tsd-anchor"></a>
|
|
<h3>convert_<wbr>address</h3>
|
|
<div class="tsd-signature tsd-kind-icon">convert_<wbr>address<span class="tsd-signature-symbol">:</span> <a href="globals.html#addressconvert" class="tsd-signature-type">addressConvert</a><span class="tsd-signature-symbol"> = addressConvert</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#L1730">packages/cli/src/cli.ts:1730</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
|
<a name="commands.decrypt_keychain" class="tsd-anchor"></a>
|
|
<h3>decrypt_<wbr>keychain</h3>
|
|
<div class="tsd-signature tsd-kind-icon">decrypt_<wbr>keychain<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">decryptMnemonic</span><span class="tsd-signature-symbol"> = decryptMnemonic</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#L1731">packages/cli/src/cli.ts:1731</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
|
<a name="commands.deploy_contract" class="tsd-anchor"></a>
|
|
<h3>deploy_<wbr>contract</h3>
|
|
<div class="tsd-signature tsd-kind-icon">deploy_<wbr>contract<span class="tsd-signature-symbol">:</span> <a href="globals.html#contractdeploy" class="tsd-signature-type">contractDeploy</a><span class="tsd-signature-symbol"> = contractDeploy</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#L1732">packages/cli/src/cli.ts:1732</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
|
<a name="commands.docs" class="tsd-anchor"></a>
|
|
<h3>docs</h3>
|
|
<div class="tsd-signature tsd-kind-icon">docs<span class="tsd-signature-symbol">:</span> <a href="globals.html#printdocs" class="tsd-signature-type">printDocs</a><span class="tsd-signature-symbol"> = printDocs</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#L1733">packages/cli/src/cli.ts:1733</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
|
<a name="commands.encrypt_keychain" class="tsd-anchor"></a>
|
|
<h3>encrypt_<wbr>keychain</h3>
|
|
<div class="tsd-signature tsd-kind-icon">encrypt_<wbr>keychain<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">encryptMnemonic</span><span class="tsd-signature-symbol"> = encryptMnemonic</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#L1734">packages/cli/src/cli.ts:1734</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
|
<a name="commands.faucet" class="tsd-anchor"></a>
|
|
<h3>faucet</h3>
|
|
<div class="tsd-signature tsd-kind-icon">faucet<span class="tsd-signature-symbol">:</span> <a href="globals.html#faucetcall" class="tsd-signature-type">faucetCall</a><span class="tsd-signature-symbol"> = faucetCall</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#L1756">packages/cli/src/cli.ts:1756</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
|
<a name="commands.gaia_deletefile" class="tsd-anchor"></a>
|
|
<h3>gaia_<wbr>deletefile</h3>
|
|
<div class="tsd-signature tsd-kind-icon">gaia_<wbr>deletefile<span class="tsd-signature-symbol">:</span> <a href="globals.html#gaiadeletefile" class="tsd-signature-type">gaiaDeleteFile</a><span class="tsd-signature-symbol"> = gaiaDeleteFile</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#L1735">packages/cli/src/cli.ts:1735</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
|
<a name="commands.gaia_dump_bucket" class="tsd-anchor"></a>
|
|
<h3>gaia_<wbr>dump_<wbr>bucket</h3>
|
|
<div class="tsd-signature tsd-kind-icon">gaia_<wbr>dump_<wbr>bucket<span class="tsd-signature-symbol">:</span> <a href="globals.html#gaiadumpbucket" class="tsd-signature-type">gaiaDumpBucket</a><span class="tsd-signature-symbol"> = gaiaDumpBucket</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#L1736">packages/cli/src/cli.ts:1736</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
|
<a name="commands.gaia_getfile" class="tsd-anchor"></a>
|
|
<h3>gaia_<wbr>getfile</h3>
|
|
<div class="tsd-signature tsd-kind-icon">gaia_<wbr>getfile<span class="tsd-signature-symbol">:</span> <a href="globals.html#gaiagetfile" class="tsd-signature-type">gaiaGetFile</a><span class="tsd-signature-symbol"> = gaiaGetFile</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#L1737">packages/cli/src/cli.ts:1737</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
|
<a name="commands.gaia_listfiles" class="tsd-anchor"></a>
|
|
<h3>gaia_<wbr>listfiles</h3>
|
|
<div class="tsd-signature tsd-kind-icon">gaia_<wbr>listfiles<span class="tsd-signature-symbol">:</span> <a href="globals.html#gaialistfiles" class="tsd-signature-type">gaiaListFiles</a><span class="tsd-signature-symbol"> = gaiaListFiles</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#L1738">packages/cli/src/cli.ts:1738</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
|
<a name="commands.gaia_putfile" class="tsd-anchor"></a>
|
|
<h3>gaia_<wbr>putfile</h3>
|
|
<div class="tsd-signature tsd-kind-icon">gaia_<wbr>putfile<span class="tsd-signature-symbol">:</span> <a href="globals.html#gaiaputfile" class="tsd-signature-type">gaiaPutFile</a><span class="tsd-signature-symbol"> = gaiaPutFile</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#L1739">packages/cli/src/cli.ts:1739</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
|
<a name="commands.gaia_restore_bucket" class="tsd-anchor"></a>
|
|
<h3>gaia_<wbr>restore_<wbr>bucket</h3>
|
|
<div class="tsd-signature tsd-kind-icon">gaia_<wbr>restore_<wbr>bucket<span class="tsd-signature-symbol">:</span> <a href="globals.html#gaiarestorebucket" class="tsd-signature-type">gaiaRestoreBucket</a><span class="tsd-signature-symbol"> = gaiaRestoreBucket</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#L1740">packages/cli/src/cli.ts:1740</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
|
<a name="commands.gaia_sethub" class="tsd-anchor"></a>
|
|
<h3>gaia_<wbr>sethub</h3>
|
|
<div class="tsd-signature tsd-kind-icon">gaia_<wbr>sethub<span class="tsd-signature-symbol">:</span> <a href="globals.html#gaiasethub" class="tsd-signature-type">gaiaSetHub</a><span class="tsd-signature-symbol"> = gaiaSetHub</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#L1741">packages/cli/src/cli.ts:1741</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
|
<a name="commands.get_account_history" class="tsd-anchor"></a>
|
|
<h3>get_<wbr>account_<wbr>history</h3>
|
|
<div class="tsd-signature tsd-kind-icon">get_<wbr>account_<wbr>history<span class="tsd-signature-symbol">:</span> <a href="globals.html#getaccounthistory" class="tsd-signature-type">getAccountHistory</a><span class="tsd-signature-symbol"> = getAccountHistory</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#L1743">packages/cli/src/cli.ts:1743</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
|
<a name="commands.get_address" class="tsd-anchor"></a>
|
|
<h3>get_<wbr>address</h3>
|
|
<div class="tsd-signature tsd-kind-icon">get_<wbr>address<span class="tsd-signature-symbol">:</span> <a href="globals.html#getkeyaddress" class="tsd-signature-type">getKeyAddress</a><span class="tsd-signature-symbol"> = getKeyAddress</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#L1742">packages/cli/src/cli.ts:1742</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
|
<a name="commands.get_app_keys" class="tsd-anchor"></a>
|
|
<h3>get_<wbr>app_<wbr>keys</h3>
|
|
<div class="tsd-signature tsd-kind-icon">get_<wbr>app_<wbr>keys<span class="tsd-signature-symbol">:</span> <a href="globals.html#getappkeys" class="tsd-signature-type">getAppKeys</a><span class="tsd-signature-symbol"> = getAppKeys</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#L1744">packages/cli/src/cli.ts:1744</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
|
<a name="commands.get_owner_keys" class="tsd-anchor"></a>
|
|
<h3>get_<wbr>owner_<wbr>keys</h3>
|
|
<div class="tsd-signature tsd-kind-icon">get_<wbr>owner_<wbr>keys<span class="tsd-signature-symbol">:</span> <a href="globals.html#getownerkeys" class="tsd-signature-type">getOwnerKeys</a><span class="tsd-signature-symbol"> = getOwnerKeys</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#L1745">packages/cli/src/cli.ts:1745</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
|
<a name="commands.get_payment_key" class="tsd-anchor"></a>
|
|
<h3>get_<wbr>payment_<wbr>key</h3>
|
|
<div class="tsd-signature tsd-kind-icon">get_<wbr>payment_<wbr>key<span class="tsd-signature-symbol">:</span> <a href="globals.html#getpaymentkey" class="tsd-signature-type">getPaymentKey</a><span class="tsd-signature-symbol"> = getPaymentKey</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#L1746">packages/cli/src/cli.ts:1746</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
|
<a name="commands.get_stacks_wallet_key" class="tsd-anchor"></a>
|
|
<h3>get_<wbr>stacks_<wbr>wallet_<wbr>key</h3>
|
|
<div class="tsd-signature tsd-kind-icon">get_<wbr>stacks_<wbr>wallet_<wbr>key<span class="tsd-signature-symbol">:</span> <a href="globals.html#getstackswalletkey" class="tsd-signature-type">getStacksWalletKey</a><span class="tsd-signature-symbol"> = getStacksWalletKey</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#L1747">packages/cli/src/cli.ts:1747</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
|
<a name="commands.make_keychain" class="tsd-anchor"></a>
|
|
<h3>make_<wbr>keychain</h3>
|
|
<div class="tsd-signature tsd-kind-icon">make_<wbr>keychain<span class="tsd-signature-symbol">:</span> <a href="globals.html#makekeychain" class="tsd-signature-type">makeKeychain</a><span class="tsd-signature-symbol"> = makeKeychain</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#L1748">packages/cli/src/cli.ts:1748</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
|
<a name="commands.profile_sign" class="tsd-anchor"></a>
|
|
<h3>profile_<wbr>sign</h3>
|
|
<div class="tsd-signature tsd-kind-icon">profile_<wbr>sign<span class="tsd-signature-symbol">:</span> <a href="globals.html#profilesign" class="tsd-signature-type">profileSign</a><span class="tsd-signature-symbol"> = profileSign</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#L1749">packages/cli/src/cli.ts:1749</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
|
<a name="commands.profile_store" class="tsd-anchor"></a>
|
|
<h3>profile_<wbr>store</h3>
|
|
<div class="tsd-signature tsd-kind-icon">profile_<wbr>store<span class="tsd-signature-symbol">:</span> <a href="globals.html#profilestore" class="tsd-signature-type">profileStore</a><span class="tsd-signature-symbol"> = profileStore</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#L1750">packages/cli/src/cli.ts:1750</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
|
<a name="commands.profile_verify" class="tsd-anchor"></a>
|
|
<h3>profile_<wbr>verify</h3>
|
|
<div class="tsd-signature tsd-kind-icon">profile_<wbr>verify<span class="tsd-signature-symbol">:</span> <a href="globals.html#profileverify" class="tsd-signature-type">profileVerify</a><span class="tsd-signature-symbol"> = profileVerify</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#L1751">packages/cli/src/cli.ts:1751</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
|
<a name="commands.send_tokens" class="tsd-anchor"></a>
|
|
<h3>send_<wbr>tokens</h3>
|
|
<div class="tsd-signature tsd-kind-icon">send_<wbr>tokens<span class="tsd-signature-symbol">:</span> <a href="globals.html#sendtokens" class="tsd-signature-type">sendTokens</a><span class="tsd-signature-symbol"> = sendTokens</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#L1753">packages/cli/src/cli.ts:1753</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
|
<a name="commands.stack" class="tsd-anchor"></a>
|
|
<h3>stack</h3>
|
|
<div class="tsd-signature tsd-kind-icon">stack<span class="tsd-signature-symbol">:</span> <a href="globals.html#stack" class="tsd-signature-type">stack</a><span class="tsd-signature-symbol"> = stack</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#L1754">packages/cli/src/cli.ts:1754</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
|
<a name="commands.stacking_status" class="tsd-anchor"></a>
|
|
<h3>stacking_<wbr>status</h3>
|
|
<div class="tsd-signature tsd-kind-icon">stacking_<wbr>status<span class="tsd-signature-symbol">:</span> <a href="globals.html#stackingstatus" class="tsd-signature-type">stackingStatus</a><span class="tsd-signature-symbol"> = stackingStatus</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#L1755">packages/cli/src/cli.ts:1755</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-object-literal">
|
|
<a name="config_defaults" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> CONFIG_<wbr>DEFAULTS</h3>
|
|
<div class="tsd-signature tsd-kind-icon">CONFIG_<wbr>DEFAULTS<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</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#L80">packages/cli/src/argparse.ts:80</a></li>
|
|
</ul>
|
|
</aside>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
|
<a name="config_defaults.blockstackapiurl" class="tsd-anchor"></a>
|
|
<h3>blockstackAPIUrl</h3>
|
|
<div class="tsd-signature tsd-kind-icon">blockstackAPIUrl<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "http://stacks-node-api.stacks.co"</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#L81">packages/cli/src/argparse.ts:81</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
|
<a name="config_defaults.blockstacknodeurl" class="tsd-anchor"></a>
|
|
<h3>blockstack<wbr>Node<wbr>Url</h3>
|
|
<div class="tsd-signature tsd-kind-icon">blockstack<wbr>Node<wbr>Url<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "http://stacks-node-api.stacks.co"</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#L82">packages/cli/src/argparse.ts:82</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
|
<a name="config_defaults.broadcastserviceurl" class="tsd-anchor"></a>
|
|
<h3>broadcast<wbr>Service<wbr>Url</h3>
|
|
<div class="tsd-signature tsd-kind-icon">broadcast<wbr>Service<wbr>Url<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "http://stacks-node-api.stacks.co/v2/transactions"</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#L83">packages/cli/src/argparse.ts:83</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
|
<a name="config_defaults.logconfig" class="tsd-anchor"></a>
|
|
<h3>log<wbr>Config</h3>
|
|
<div class="tsd-signature tsd-kind-icon">log<wbr>Config<span class="tsd-signature-symbol">:</span> <a href="interfaces/cli_log_config_type.html" class="tsd-signature-type">CLI_LOG_CONFIG_TYPE</a><span class="tsd-signature-symbol"> = LOG_CONFIG_DEFAULTS</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#L85">packages/cli/src/argparse.ts:85</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
|
<a name="config_defaults.utxoserviceurl" class="tsd-anchor"></a>
|
|
<h3>utxo<wbr>Service<wbr>Url</h3>
|
|
<div class="tsd-signature tsd-kind-icon">utxo<wbr>Service<wbr>Url<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "https://blockchain.info"</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#L84">packages/cli/src/argparse.ts:84</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-object-literal">
|
|
<a name="config_regtest_defaults" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> CONFIG_<wbr>REGTEST_<wbr>DEFAULTS</h3>
|
|
<div class="tsd-signature tsd-kind-icon">CONFIG_<wbr>REGTEST_<wbr>DEFAULTS<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</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#L88">packages/cli/src/argparse.ts:88</a></li>
|
|
</ul>
|
|
</aside>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
|
<a name="config_regtest_defaults.bitcoindpassword" class="tsd-anchor"></a>
|
|
<h3>bitcoind<wbr>Password</h3>
|
|
<div class="tsd-signature tsd-kind-icon">bitcoind<wbr>Password<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "blockstacksystem"</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#L94">packages/cli/src/argparse.ts:94</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
|
<a name="config_regtest_defaults.bitcoindusername" class="tsd-anchor"></a>
|
|
<h3>bitcoind<wbr>Username</h3>
|
|
<div class="tsd-signature tsd-kind-icon">bitcoind<wbr>Username<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "blockstack"</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#L95">packages/cli/src/argparse.ts:95</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
|
<a name="config_regtest_defaults.blockstackapiurl" class="tsd-anchor"></a>
|
|
<h3>blockstackAPIUrl</h3>
|
|
<div class="tsd-signature tsd-kind-icon">blockstackAPIUrl<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "http://localhost:16268"</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#L89">packages/cli/src/argparse.ts:89</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
|
<a name="config_regtest_defaults.blockstacknodeurl" class="tsd-anchor"></a>
|
|
<h3>blockstack<wbr>Node<wbr>Url</h3>
|
|
<div class="tsd-signature tsd-kind-icon">blockstack<wbr>Node<wbr>Url<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "http://localhost:16264"</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#L90">packages/cli/src/argparse.ts:90</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
|
<a name="config_regtest_defaults.broadcastserviceurl" class="tsd-anchor"></a>
|
|
<h3>broadcast<wbr>Service<wbr>Url</h3>
|
|
<div class="tsd-signature tsd-kind-icon">broadcast<wbr>Service<wbr>Url<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "http://localhost:16269"</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#L91">packages/cli/src/argparse.ts:91</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
|
<a name="config_regtest_defaults.logconfig" class="tsd-anchor"></a>
|
|
<h3>log<wbr>Config</h3>
|
|
<div class="tsd-signature tsd-kind-icon">log<wbr>Config<span class="tsd-signature-symbol">:</span> <a href="interfaces/cli_log_config_type.html" class="tsd-signature-type">CLI_LOG_CONFIG_TYPE</a><span class="tsd-signature-symbol"> = LOG_CONFIG_DEFAULTS</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#L93">packages/cli/src/argparse.ts:93</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
|
<a name="config_regtest_defaults.utxoserviceurl" class="tsd-anchor"></a>
|
|
<h3>utxo<wbr>Service<wbr>Url</h3>
|
|
<div class="tsd-signature tsd-kind-icon">utxo<wbr>Service<wbr>Url<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "http://localhost:18332"</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#L92">packages/cli/src/argparse.ts:92</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-object-literal">
|
|
<a name="config_testnet_defaults" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> CONFIG_<wbr>TESTNET_<wbr>DEFAULTS</h3>
|
|
<div class="tsd-signature tsd-kind-icon">CONFIG_<wbr>TESTNET_<wbr>DEFAULTS<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</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#L100">packages/cli/src/argparse.ts:100</a></li>
|
|
</ul>
|
|
</aside>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
|
<a name="config_testnet_defaults.blockstackapiurl" class="tsd-anchor"></a>
|
|
<h3>blockstackAPIUrl</h3>
|
|
<div class="tsd-signature tsd-kind-icon">blockstackAPIUrl<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = `http://${PUBLIC_TESTNET_HOST}:20443`</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#L101">packages/cli/src/argparse.ts:101</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
|
<a name="config_testnet_defaults.blockstacknodeurl" class="tsd-anchor"></a>
|
|
<h3>blockstack<wbr>Node<wbr>Url</h3>
|
|
<div class="tsd-signature tsd-kind-icon">blockstack<wbr>Node<wbr>Url<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = `http://${PUBLIC_TESTNET_HOST}:20443`</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#L102">packages/cli/src/argparse.ts:102</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
|
<a name="config_testnet_defaults.broadcastserviceurl" class="tsd-anchor"></a>
|
|
<h3>broadcast<wbr>Service<wbr>Url</h3>
|
|
<div class="tsd-signature tsd-kind-icon">broadcast<wbr>Service<wbr>Url<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = `http://${PUBLIC_TESTNET_HOST}:20443/v2/transactions`</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#L103">packages/cli/src/argparse.ts:103</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
|
<a name="config_testnet_defaults.logconfig" class="tsd-anchor"></a>
|
|
<h3>log<wbr>Config</h3>
|
|
<div class="tsd-signature tsd-kind-icon">log<wbr>Config<span class="tsd-signature-symbol">:</span> <a href="interfaces/cli_log_config_type.html" class="tsd-signature-type">CLI_LOG_CONFIG_TYPE</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span>level<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> = Object.assign({}, LOG_CONFIG_DEFAULTS, { level: 'debug' })</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#L105">packages/cli/src/argparse.ts:105</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
|
<a name="config_testnet_defaults.utxoserviceurl" class="tsd-anchor"></a>
|
|
<h3>utxo<wbr>Service<wbr>Url</h3>
|
|
<div class="tsd-signature tsd-kind-icon">utxo<wbr>Service<wbr>Url<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = `http://${PUBLIC_TESTNET_HOST}:18332`</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#L104">packages/cli/src/argparse.ts:104</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-object-literal">
|
|
<a name="default_profile" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> DEFAULT_<wbr>PROFILE</h3>
|
|
<div class="tsd-signature tsd-kind-icon">DEFAULT_<wbr>PROFILE<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/auth/src/constants.ts#L17">packages/auth/src/constants.ts:17</a></li>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/keychain/src/profiles.ts#L35">packages/keychain/src/profiles.ts:35</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Default user profile object</p>
|
|
</div>
|
|
</div>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
|
<a name="default_profile._context" class="tsd-anchor"></a>
|
|
<h3>@context</h3>
|
|
<div class="tsd-signature tsd-kind-icon">@context<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"http://schema.org"</span><span class="tsd-signature-symbol"> = "http://schema.org"</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/auth/src/constants.ts#L19">packages/auth/src/constants.ts:19</a></li>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/keychain/src/profiles.ts#L37">packages/keychain/src/profiles.ts:37</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
|
<a name="default_profile._type" class="tsd-anchor"></a>
|
|
<h3>@type</h3>
|
|
<div class="tsd-signature tsd-kind-icon">@type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"Person"</span><span class="tsd-signature-symbol"> = "Person"</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/auth/src/constants.ts#L18">packages/auth/src/constants.ts:18</a></li>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/keychain/src/profiles.ts#L36">packages/keychain/src/profiles.ts:36</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-object-literal">
|
|
<a name="log_config_defaults" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> LOG_<wbr>CONFIG_<wbr>DEFAULTS</h3>
|
|
<div class="tsd-signature tsd-kind-icon">LOG_<wbr>CONFIG_<wbr>DEFAULTS<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</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#L71">packages/cli/src/argparse.ts:71</a></li>
|
|
</ul>
|
|
</aside>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
|
<a name="log_config_defaults.colorize" class="tsd-anchor"></a>
|
|
<h3>colorize</h3>
|
|
<div class="tsd-signature tsd-kind-icon">colorize<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">true</span><span class="tsd-signature-symbol"> = true</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#L76">packages/cli/src/argparse.ts:76</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
|
<a name="log_config_defaults.handleexceptions" class="tsd-anchor"></a>
|
|
<h3>handle<wbr>Exceptions</h3>
|
|
<div class="tsd-signature tsd-kind-icon">handle<wbr>Exceptions<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">true</span><span class="tsd-signature-symbol"> = true</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#L73">packages/cli/src/argparse.ts:73</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
|
<a name="log_config_defaults.json" class="tsd-anchor"></a>
|
|
<h3>json</h3>
|
|
<div class="tsd-signature tsd-kind-icon">json<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">true</span><span class="tsd-signature-symbol"> = true</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#L77">packages/cli/src/argparse.ts:77</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
|
<a name="log_config_defaults.level" class="tsd-anchor"></a>
|
|
<h3>level</h3>
|
|
<div class="tsd-signature tsd-kind-icon">level<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "info"</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#L72">packages/cli/src/argparse.ts:72</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
|
<a name="log_config_defaults.stringify" class="tsd-anchor"></a>
|
|
<h3>stringify</h3>
|
|
<div class="tsd-signature tsd-kind-icon">stringify<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">true</span><span class="tsd-signature-symbol"> = true</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#L75">packages/cli/src/argparse.ts:75</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
|
<a name="log_config_defaults.timestamp" class="tsd-anchor"></a>
|
|
<h3>timestamp</h3>
|
|
<div class="tsd-signature tsd-kind-icon">timestamp<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">true</span><span class="tsd-signature-symbol"> = true</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#L74">packages/cli/src/argparse.ts:74</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-object-literal">
|
|
<a name="derivationpaths" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> derivation<wbr>Paths</h3>
|
|
<div class="tsd-signature tsd-kind-icon">derivation<wbr>Paths<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/keychain/src/address-derivation/index.ts#L7">packages/keychain/src/address-derivation/index.ts:7</a></li>
|
|
</ul>
|
|
</aside>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
|
<a name="derivationpaths._chainid_mainnet_" class="tsd-anchor"></a>
|
|
<h3>[<wbr>ChainID.<wbr>Mainnet]</h3>
|
|
<div class="tsd-signature tsd-kind-icon">[<wbr>ChainID.<wbr>Mainnet]<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = networkDerivationPath</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/keychain/src/address-derivation/index.ts#L8">packages/keychain/src/address-derivation/index.ts:8</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
|
<a name="derivationpaths._chainid_testnet_" class="tsd-anchor"></a>
|
|
<h3>[<wbr>ChainID.<wbr>Testnet]</h3>
|
|
<div class="tsd-signature tsd-kind-icon">[<wbr>ChainID.<wbr>Testnet]<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = networkDerivationPath</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/keychain/src/address-derivation/index.ts#L9">packages/keychain/src/address-derivation/index.ts:9</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-object-literal">
|
|
<a name="personschemadefinition" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> person<wbr>Schema<wbr>Definition</h3>
|
|
<div class="tsd-signature tsd-kind-icon">person<wbr>Schema<wbr>Definition<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/profile/src/profile.ts#L77">packages/profile/src/profile.ts:77</a></li>
|
|
</ul>
|
|
</aside>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
|
<a name="personschemadefinition.strict" class="tsd-anchor"></a>
|
|
<h3>strict</h3>
|
|
<div class="tsd-signature tsd-kind-icon">strict<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/profile/src/profile.ts#L79">packages/profile/src/profile.ts:79</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
|
<a name="personschemadefinition.type" class="tsd-anchor"></a>
|
|
<h3>type</h3>
|
|
<div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "object"</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/profile/src/profile.ts#L78">packages/profile/src/profile.ts:78</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-object-literal tsd-parent-kind-object-literal">
|
|
<a name="personschemadefinition.properties" class="tsd-anchor"></a>
|
|
<h3>properties</h3>
|
|
<div class="tsd-signature tsd-kind-icon">properties<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/profile/src/profile.ts#L80">packages/profile/src/profile.ts:80</a></li>
|
|
</ul>
|
|
</aside>
|
|
<section class="tsd-panel tsd-member tsd-kind-object-literal tsd-parent-kind-object-literal">
|
|
<a name="personschemadefinition.properties._context" class="tsd-anchor"></a>
|
|
<h3>@context</h3>
|
|
<div class="tsd-signature tsd-kind-icon">@context<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/profile/src/profile.ts#L81">packages/profile/src/profile.ts:81</a></li>
|
|
</ul>
|
|
</aside>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
|
<a name="personschemadefinition.properties._context.optional" class="tsd-anchor"></a>
|
|
<h3>optional</h3>
|
|
<div class="tsd-signature tsd-kind-icon">optional<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/profile/src/profile.ts#L81">packages/profile/src/profile.ts:81</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
|
<a name="personschemadefinition.properties._context.type-1" class="tsd-anchor"></a>
|
|
<h3>type</h3>
|
|
<div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "string"</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/profile/src/profile.ts#L81">packages/profile/src/profile.ts:81</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-object-literal tsd-parent-kind-object-literal">
|
|
<a name="personschemadefinition.properties._id" class="tsd-anchor"></a>
|
|
<h3>@id</h3>
|
|
<div class="tsd-signature tsd-kind-icon">@id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/profile/src/profile.ts#L83">packages/profile/src/profile.ts:83</a></li>
|
|
</ul>
|
|
</aside>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
|
<a name="personschemadefinition.properties._id.optional-1" class="tsd-anchor"></a>
|
|
<h3>optional</h3>
|
|
<div class="tsd-signature tsd-kind-icon">optional<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/profile/src/profile.ts#L83">packages/profile/src/profile.ts:83</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
|
<a name="personschemadefinition.properties._id.type-2" class="tsd-anchor"></a>
|
|
<h3>type</h3>
|
|
<div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "string"</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/profile/src/profile.ts#L83">packages/profile/src/profile.ts:83</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-object-literal tsd-parent-kind-object-literal">
|
|
<a name="personschemadefinition.properties._type" class="tsd-anchor"></a>
|
|
<h3>@type</h3>
|
|
<div class="tsd-signature tsd-kind-icon">@type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/profile/src/profile.ts#L82">packages/profile/src/profile.ts:82</a></li>
|
|
</ul>
|
|
</aside>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
|
<a name="personschemadefinition.properties._type.type-3" class="tsd-anchor"></a>
|
|
<h3>type</h3>
|
|
<div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "string"</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/profile/src/profile.ts#L82">packages/profile/src/profile.ts:82</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-object-literal tsd-parent-kind-object-literal">
|
|
<a name="personschemadefinition.properties.account" class="tsd-anchor"></a>
|
|
<h3>account</h3>
|
|
<div class="tsd-signature tsd-kind-icon">account<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/profile/src/profile.ts#L111">packages/profile/src/profile.ts:111</a></li>
|
|
</ul>
|
|
</aside>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
|
<a name="personschemadefinition.properties.account.optional-2" class="tsd-anchor"></a>
|
|
<h3>optional</h3>
|
|
<div class="tsd-signature tsd-kind-icon">optional<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/profile/src/profile.ts#L113">packages/profile/src/profile.ts:113</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
|
<a name="personschemadefinition.properties.account.type-4" class="tsd-anchor"></a>
|
|
<h3>type</h3>
|
|
<div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "array"</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/profile/src/profile.ts#L112">packages/profile/src/profile.ts:112</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-object-literal tsd-parent-kind-object-literal">
|
|
<a name="personschemadefinition.properties.account.items" class="tsd-anchor"></a>
|
|
<h3>items</h3>
|
|
<div class="tsd-signature tsd-kind-icon">items<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/profile/src/profile.ts#L114">packages/profile/src/profile.ts:114</a></li>
|
|
</ul>
|
|
</aside>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
|
<a name="personschemadefinition.properties.account.items.type-5" class="tsd-anchor"></a>
|
|
<h3>type</h3>
|
|
<div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "object"</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/profile/src/profile.ts#L115">packages/profile/src/profile.ts:115</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-object-literal tsd-parent-kind-object-literal">
|
|
<a name="personschemadefinition.properties.account.items.properties-1" class="tsd-anchor"></a>
|
|
<h3>properties</h3>
|
|
<div class="tsd-signature tsd-kind-icon">properties<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/profile/src/profile.ts#L116">packages/profile/src/profile.ts:116</a></li>
|
|
</ul>
|
|
</aside>
|
|
<section class="tsd-panel tsd-member tsd-kind-object-literal tsd-parent-kind-object-literal">
|
|
<a name="personschemadefinition.properties.account.items.properties-1._type-1" class="tsd-anchor"></a>
|
|
<h3>@type</h3>
|
|
<div class="tsd-signature tsd-kind-icon">@type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/profile/src/profile.ts#L117">packages/profile/src/profile.ts:117</a></li>
|
|
</ul>
|
|
</aside>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
|
<a name="personschemadefinition.properties.account.items.properties-1._type-1.type-6" class="tsd-anchor"></a>
|
|
<h3>type</h3>
|
|
<div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "string"</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/profile/src/profile.ts#L117">packages/profile/src/profile.ts:117</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-object-literal tsd-parent-kind-object-literal">
|
|
<a name="personschemadefinition.properties.account.items.properties-1.identifier" class="tsd-anchor"></a>
|
|
<h3>identifier</h3>
|
|
<div class="tsd-signature tsd-kind-icon">identifier<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/profile/src/profile.ts#L119">packages/profile/src/profile.ts:119</a></li>
|
|
</ul>
|
|
</aside>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
|
<a name="personschemadefinition.properties.account.items.properties-1.identifier.optional-3" class="tsd-anchor"></a>
|
|
<h3>optional</h3>
|
|
<div class="tsd-signature tsd-kind-icon">optional<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/profile/src/profile.ts#L119">packages/profile/src/profile.ts:119</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
|
<a name="personschemadefinition.properties.account.items.properties-1.identifier.type-7" class="tsd-anchor"></a>
|
|
<h3>type</h3>
|
|
<div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "string"</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/profile/src/profile.ts#L119">packages/profile/src/profile.ts:119</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-object-literal tsd-parent-kind-object-literal">
|
|
<a name="personschemadefinition.properties.account.items.properties-1.proofmessage" class="tsd-anchor"></a>
|
|
<h3>proof<wbr>Message</h3>
|
|
<div class="tsd-signature tsd-kind-icon">proof<wbr>Message<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/profile/src/profile.ts#L122">packages/profile/src/profile.ts:122</a></li>
|
|
</ul>
|
|
</aside>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
|
<a name="personschemadefinition.properties.account.items.properties-1.proofmessage.optional-4" class="tsd-anchor"></a>
|
|
<h3>optional</h3>
|
|
<div class="tsd-signature tsd-kind-icon">optional<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/profile/src/profile.ts#L122">packages/profile/src/profile.ts:122</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
|
<a name="personschemadefinition.properties.account.items.properties-1.proofmessage.type-8" class="tsd-anchor"></a>
|
|
<h3>type</h3>
|
|
<div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "string"</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/profile/src/profile.ts#L122">packages/profile/src/profile.ts:122</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-object-literal tsd-parent-kind-object-literal">
|
|
<a name="personschemadefinition.properties.account.items.properties-1.proofsignature" class="tsd-anchor"></a>
|
|
<h3>proof<wbr>Signature</h3>
|
|
<div class="tsd-signature tsd-kind-icon">proof<wbr>Signature<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/profile/src/profile.ts#L123">packages/profile/src/profile.ts:123</a></li>
|
|
</ul>
|
|
</aside>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
|
<a name="personschemadefinition.properties.account.items.properties-1.proofsignature.optional-5" class="tsd-anchor"></a>
|
|
<h3>optional</h3>
|
|
<div class="tsd-signature tsd-kind-icon">optional<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/profile/src/profile.ts#L123">packages/profile/src/profile.ts:123</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
|
<a name="personschemadefinition.properties.account.items.properties-1.proofsignature.type-9" class="tsd-anchor"></a>
|
|
<h3>type</h3>
|
|
<div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "string"</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/profile/src/profile.ts#L123">packages/profile/src/profile.ts:123</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-object-literal tsd-parent-kind-object-literal">
|
|
<a name="personschemadefinition.properties.account.items.properties-1.prooftype" class="tsd-anchor"></a>
|
|
<h3>proof<wbr>Type</h3>
|
|
<div class="tsd-signature tsd-kind-icon">proof<wbr>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/profile/src/profile.ts#L120">packages/profile/src/profile.ts:120</a></li>
|
|
</ul>
|
|
</aside>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
|
<a name="personschemadefinition.properties.account.items.properties-1.prooftype.optional-6" class="tsd-anchor"></a>
|
|
<h3>optional</h3>
|
|
<div class="tsd-signature tsd-kind-icon">optional<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/profile/src/profile.ts#L120">packages/profile/src/profile.ts:120</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
|
<a name="personschemadefinition.properties.account.items.properties-1.prooftype.type-10" class="tsd-anchor"></a>
|
|
<h3>type</h3>
|
|
<div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "string"</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/profile/src/profile.ts#L120">packages/profile/src/profile.ts:120</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-object-literal tsd-parent-kind-object-literal">
|
|
<a name="personschemadefinition.properties.account.items.properties-1.proofurl" class="tsd-anchor"></a>
|
|
<h3>proof<wbr>Url</h3>
|
|
<div class="tsd-signature tsd-kind-icon">proof<wbr>Url<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/profile/src/profile.ts#L121">packages/profile/src/profile.ts:121</a></li>
|
|
</ul>
|
|
</aside>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
|
<a name="personschemadefinition.properties.account.items.properties-1.proofurl.optional-7" class="tsd-anchor"></a>
|
|
<h3>optional</h3>
|
|
<div class="tsd-signature tsd-kind-icon">optional<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/profile/src/profile.ts#L121">packages/profile/src/profile.ts:121</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
|
<a name="personschemadefinition.properties.account.items.properties-1.proofurl.type-11" class="tsd-anchor"></a>
|
|
<h3>type</h3>
|
|
<div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "string"</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/profile/src/profile.ts#L121">packages/profile/src/profile.ts:121</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-object-literal tsd-parent-kind-object-literal">
|
|
<a name="personschemadefinition.properties.account.items.properties-1.service" class="tsd-anchor"></a>
|
|
<h3>service</h3>
|
|
<div class="tsd-signature tsd-kind-icon">service<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/profile/src/profile.ts#L118">packages/profile/src/profile.ts:118</a></li>
|
|
</ul>
|
|
</aside>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
|
<a name="personschemadefinition.properties.account.items.properties-1.service.optional-8" class="tsd-anchor"></a>
|
|
<h3>optional</h3>
|
|
<div class="tsd-signature tsd-kind-icon">optional<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/profile/src/profile.ts#L118">packages/profile/src/profile.ts:118</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
|
<a name="personschemadefinition.properties.account.items.properties-1.service.type-12" class="tsd-anchor"></a>
|
|
<h3>type</h3>
|
|
<div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "string"</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/profile/src/profile.ts#L118">packages/profile/src/profile.ts:118</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
</section>
|
|
</section>
|
|
</section>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-object-literal tsd-parent-kind-object-literal">
|
|
<a name="personschemadefinition.properties.address" class="tsd-anchor"></a>
|
|
<h3>address</h3>
|
|
<div class="tsd-signature tsd-kind-icon">address<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/profile/src/profile.ts#L149">packages/profile/src/profile.ts:149</a></li>
|
|
</ul>
|
|
</aside>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
|
<a name="personschemadefinition.properties.address.optional-9" class="tsd-anchor"></a>
|
|
<h3>optional</h3>
|
|
<div class="tsd-signature tsd-kind-icon">optional<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/profile/src/profile.ts#L151">packages/profile/src/profile.ts:151</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
|
<a name="personschemadefinition.properties.address.type-13" class="tsd-anchor"></a>
|
|
<h3>type</h3>
|
|
<div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "object"</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/profile/src/profile.ts#L150">packages/profile/src/profile.ts:150</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-object-literal tsd-parent-kind-object-literal">
|
|
<a name="personschemadefinition.properties.address.properties-2" class="tsd-anchor"></a>
|
|
<h3>properties</h3>
|
|
<div class="tsd-signature tsd-kind-icon">properties<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/profile/src/profile.ts#L152">packages/profile/src/profile.ts:152</a></li>
|
|
</ul>
|
|
</aside>
|
|
<section class="tsd-panel tsd-member tsd-kind-object-literal tsd-parent-kind-object-literal">
|
|
<a name="personschemadefinition.properties.address.properties-2._type-2" class="tsd-anchor"></a>
|
|
<h3>@type</h3>
|
|
<div class="tsd-signature tsd-kind-icon">@type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/profile/src/profile.ts#L153">packages/profile/src/profile.ts:153</a></li>
|
|
</ul>
|
|
</aside>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
|
<a name="personschemadefinition.properties.address.properties-2._type-2.type-14" class="tsd-anchor"></a>
|
|
<h3>type</h3>
|
|
<div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "string"</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/profile/src/profile.ts#L153">packages/profile/src/profile.ts:153</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-object-literal tsd-parent-kind-object-literal">
|
|
<a name="personschemadefinition.properties.address.properties-2.addresscountry" class="tsd-anchor"></a>
|
|
<h3>address<wbr>Country</h3>
|
|
<div class="tsd-signature tsd-kind-icon">address<wbr>Country<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/profile/src/profile.ts#L157">packages/profile/src/profile.ts:157</a></li>
|
|
</ul>
|
|
</aside>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
|
<a name="personschemadefinition.properties.address.properties-2.addresscountry.optional-10" class="tsd-anchor"></a>
|
|
<h3>optional</h3>
|
|
<div class="tsd-signature tsd-kind-icon">optional<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/profile/src/profile.ts#L157">packages/profile/src/profile.ts:157</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
|
<a name="personschemadefinition.properties.address.properties-2.addresscountry.type-15" class="tsd-anchor"></a>
|
|
<h3>type</h3>
|
|
<div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "string"</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/profile/src/profile.ts#L157">packages/profile/src/profile.ts:157</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-object-literal tsd-parent-kind-object-literal">
|
|
<a name="personschemadefinition.properties.address.properties-2.addresslocality" class="tsd-anchor"></a>
|
|
<h3>address<wbr>Locality</h3>
|
|
<div class="tsd-signature tsd-kind-icon">address<wbr>Locality<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/profile/src/profile.ts#L155">packages/profile/src/profile.ts:155</a></li>
|
|
</ul>
|
|
</aside>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
|
<a name="personschemadefinition.properties.address.properties-2.addresslocality.optional-11" class="tsd-anchor"></a>
|
|
<h3>optional</h3>
|
|
<div class="tsd-signature tsd-kind-icon">optional<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/profile/src/profile.ts#L155">packages/profile/src/profile.ts:155</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
|
<a name="personschemadefinition.properties.address.properties-2.addresslocality.type-16" class="tsd-anchor"></a>
|
|
<h3>type</h3>
|
|
<div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "string"</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/profile/src/profile.ts#L155">packages/profile/src/profile.ts:155</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-object-literal tsd-parent-kind-object-literal">
|
|
<a name="personschemadefinition.properties.address.properties-2.postalcode" class="tsd-anchor"></a>
|
|
<h3>postal<wbr>Code</h3>
|
|
<div class="tsd-signature tsd-kind-icon">postal<wbr>Code<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/profile/src/profile.ts#L156">packages/profile/src/profile.ts:156</a></li>
|
|
</ul>
|
|
</aside>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
|
<a name="personschemadefinition.properties.address.properties-2.postalcode.optional-12" class="tsd-anchor"></a>
|
|
<h3>optional</h3>
|
|
<div class="tsd-signature tsd-kind-icon">optional<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/profile/src/profile.ts#L156">packages/profile/src/profile.ts:156</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
|
<a name="personschemadefinition.properties.address.properties-2.postalcode.type-17" class="tsd-anchor"></a>
|
|
<h3>type</h3>
|
|
<div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "string"</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/profile/src/profile.ts#L156">packages/profile/src/profile.ts:156</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-object-literal tsd-parent-kind-object-literal">
|
|
<a name="personschemadefinition.properties.address.properties-2.streetaddress" class="tsd-anchor"></a>
|
|
<h3>street<wbr>Address</h3>
|
|
<div class="tsd-signature tsd-kind-icon">street<wbr>Address<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/profile/src/profile.ts#L154">packages/profile/src/profile.ts:154</a></li>
|
|
</ul>
|
|
</aside>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
|
<a name="personschemadefinition.properties.address.properties-2.streetaddress.optional-13" class="tsd-anchor"></a>
|
|
<h3>optional</h3>
|
|
<div class="tsd-signature tsd-kind-icon">optional<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/profile/src/profile.ts#L154">packages/profile/src/profile.ts:154</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
|
<a name="personschemadefinition.properties.address.properties-2.streetaddress.type-18" class="tsd-anchor"></a>
|
|
<h3>type</h3>
|
|
<div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "string"</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/profile/src/profile.ts#L154">packages/profile/src/profile.ts:154</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
</section>
|
|
</section>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-object-literal tsd-parent-kind-object-literal">
|
|
<a name="personschemadefinition.properties.birthdate" class="tsd-anchor"></a>
|
|
<h3>birth<wbr>Date</h3>
|
|
<div class="tsd-signature tsd-kind-icon">birth<wbr>Date<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/profile/src/profile.ts#L160">packages/profile/src/profile.ts:160</a></li>
|
|
</ul>
|
|
</aside>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
|
<a name="personschemadefinition.properties.birthdate.optional-14" class="tsd-anchor"></a>
|
|
<h3>optional</h3>
|
|
<div class="tsd-signature tsd-kind-icon">optional<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/profile/src/profile.ts#L160">packages/profile/src/profile.ts:160</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
|
<a name="personschemadefinition.properties.birthdate.type-19" class="tsd-anchor"></a>
|
|
<h3>type</h3>
|
|
<div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "string"</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/profile/src/profile.ts#L160">packages/profile/src/profile.ts:160</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-object-literal tsd-parent-kind-object-literal">
|
|
<a name="personschemadefinition.properties.description" class="tsd-anchor"></a>
|
|
<h3>description</h3>
|
|
<div class="tsd-signature tsd-kind-icon">description<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/profile/src/profile.ts#L87">packages/profile/src/profile.ts:87</a></li>
|
|
</ul>
|
|
</aside>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
|
<a name="personschemadefinition.properties.description.optional-15" class="tsd-anchor"></a>
|
|
<h3>optional</h3>
|
|
<div class="tsd-signature tsd-kind-icon">optional<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/profile/src/profile.ts#L87">packages/profile/src/profile.ts:87</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
|
<a name="personschemadefinition.properties.description.type-20" class="tsd-anchor"></a>
|
|
<h3>type</h3>
|
|
<div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "string"</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/profile/src/profile.ts#L87">packages/profile/src/profile.ts:87</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-object-literal tsd-parent-kind-object-literal">
|
|
<a name="personschemadefinition.properties.familyname" class="tsd-anchor"></a>
|
|
<h3>family<wbr>Name</h3>
|
|
<div class="tsd-signature tsd-kind-icon">family<wbr>Name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/profile/src/profile.ts#L86">packages/profile/src/profile.ts:86</a></li>
|
|
</ul>
|
|
</aside>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
|
<a name="personschemadefinition.properties.familyname.optional-16" class="tsd-anchor"></a>
|
|
<h3>optional</h3>
|
|
<div class="tsd-signature tsd-kind-icon">optional<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/profile/src/profile.ts#L86">packages/profile/src/profile.ts:86</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
|
<a name="personschemadefinition.properties.familyname.type-21" class="tsd-anchor"></a>
|
|
<h3>type</h3>
|
|
<div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "string"</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/profile/src/profile.ts#L86">packages/profile/src/profile.ts:86</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-object-literal tsd-parent-kind-object-literal">
|
|
<a name="personschemadefinition.properties.givenname" class="tsd-anchor"></a>
|
|
<h3>given<wbr>Name</h3>
|
|
<div class="tsd-signature tsd-kind-icon">given<wbr>Name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/profile/src/profile.ts#L85">packages/profile/src/profile.ts:85</a></li>
|
|
</ul>
|
|
</aside>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
|
<a name="personschemadefinition.properties.givenname.optional-17" class="tsd-anchor"></a>
|
|
<h3>optional</h3>
|
|
<div class="tsd-signature tsd-kind-icon">optional<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/profile/src/profile.ts#L85">packages/profile/src/profile.ts:85</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
|
<a name="personschemadefinition.properties.givenname.type-22" class="tsd-anchor"></a>
|
|
<h3>type</h3>
|
|
<div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "string"</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/profile/src/profile.ts#L85">packages/profile/src/profile.ts:85</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-object-literal tsd-parent-kind-object-literal">
|
|
<a name="personschemadefinition.properties.image" class="tsd-anchor"></a>
|
|
<h3>image</h3>
|
|
<div class="tsd-signature tsd-kind-icon">image<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/profile/src/profile.ts#L88">packages/profile/src/profile.ts:88</a></li>
|
|
</ul>
|
|
</aside>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
|
<a name="personschemadefinition.properties.image.optional-18" class="tsd-anchor"></a>
|
|
<h3>optional</h3>
|
|
<div class="tsd-signature tsd-kind-icon">optional<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/profile/src/profile.ts#L90">packages/profile/src/profile.ts:90</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
|
<a name="personschemadefinition.properties.image.type-23" class="tsd-anchor"></a>
|
|
<h3>type</h3>
|
|
<div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "array"</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/profile/src/profile.ts#L89">packages/profile/src/profile.ts:89</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-object-literal tsd-parent-kind-object-literal">
|
|
<a name="personschemadefinition.properties.image.items-1" class="tsd-anchor"></a>
|
|
<h3>items</h3>
|
|
<div class="tsd-signature tsd-kind-icon">items<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/profile/src/profile.ts#L91">packages/profile/src/profile.ts:91</a></li>
|
|
</ul>
|
|
</aside>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
|
<a name="personschemadefinition.properties.image.items-1.type-24" class="tsd-anchor"></a>
|
|
<h3>type</h3>
|
|
<div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "object"</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/profile/src/profile.ts#L92">packages/profile/src/profile.ts:92</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-object-literal tsd-parent-kind-object-literal">
|
|
<a name="personschemadefinition.properties.image.items-1.properties-3" class="tsd-anchor"></a>
|
|
<h3>properties</h3>
|
|
<div class="tsd-signature tsd-kind-icon">properties<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/profile/src/profile.ts#L93">packages/profile/src/profile.ts:93</a></li>
|
|
</ul>
|
|
</aside>
|
|
<section class="tsd-panel tsd-member tsd-kind-object-literal tsd-parent-kind-object-literal">
|
|
<a name="personschemadefinition.properties.image.items-1.properties-3._type-3" class="tsd-anchor"></a>
|
|
<h3>@type</h3>
|
|
<div class="tsd-signature tsd-kind-icon">@type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/profile/src/profile.ts#L94">packages/profile/src/profile.ts:94</a></li>
|
|
</ul>
|
|
</aside>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
|
<a name="personschemadefinition.properties.image.items-1.properties-3._type-3.type-25" class="tsd-anchor"></a>
|
|
<h3>type</h3>
|
|
<div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "string"</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/profile/src/profile.ts#L94">packages/profile/src/profile.ts:94</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-object-literal tsd-parent-kind-object-literal">
|
|
<a name="personschemadefinition.properties.image.items-1.properties-3.contenturl" class="tsd-anchor"></a>
|
|
<h3>content<wbr>Url</h3>
|
|
<div class="tsd-signature tsd-kind-icon">content<wbr>Url<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/profile/src/profile.ts#L96">packages/profile/src/profile.ts:96</a></li>
|
|
</ul>
|
|
</aside>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
|
<a name="personschemadefinition.properties.image.items-1.properties-3.contenturl.optional-19" class="tsd-anchor"></a>
|
|
<h3>optional</h3>
|
|
<div class="tsd-signature tsd-kind-icon">optional<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/profile/src/profile.ts#L96">packages/profile/src/profile.ts:96</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
|
<a name="personschemadefinition.properties.image.items-1.properties-3.contenturl.type-26" class="tsd-anchor"></a>
|
|
<h3>type</h3>
|
|
<div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "string"</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/profile/src/profile.ts#L96">packages/profile/src/profile.ts:96</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-object-literal tsd-parent-kind-object-literal">
|
|
<a name="personschemadefinition.properties.image.items-1.properties-3.name" class="tsd-anchor"></a>
|
|
<h3>name</h3>
|
|
<div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/profile/src/profile.ts#L95">packages/profile/src/profile.ts:95</a></li>
|
|
</ul>
|
|
</aside>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
|
<a name="personschemadefinition.properties.image.items-1.properties-3.name.optional-20" class="tsd-anchor"></a>
|
|
<h3>optional</h3>
|
|
<div class="tsd-signature tsd-kind-icon">optional<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/profile/src/profile.ts#L95">packages/profile/src/profile.ts:95</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
|
<a name="personschemadefinition.properties.image.items-1.properties-3.name.type-27" class="tsd-anchor"></a>
|
|
<h3>type</h3>
|
|
<div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "string"</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/profile/src/profile.ts#L95">packages/profile/src/profile.ts:95</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
</section>
|
|
</section>
|
|
</section>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-object-literal tsd-parent-kind-object-literal">
|
|
<a name="personschemadefinition.properties.knows" class="tsd-anchor"></a>
|
|
<h3>knows</h3>
|
|
<div class="tsd-signature tsd-kind-icon">knows<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/profile/src/profile.ts#L138">packages/profile/src/profile.ts:138</a></li>
|
|
</ul>
|
|
</aside>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
|
<a name="personschemadefinition.properties.knows.optional-21" class="tsd-anchor"></a>
|
|
<h3>optional</h3>
|
|
<div class="tsd-signature tsd-kind-icon">optional<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/profile/src/profile.ts#L140">packages/profile/src/profile.ts:140</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
|
<a name="personschemadefinition.properties.knows.type-28" class="tsd-anchor"></a>
|
|
<h3>type</h3>
|
|
<div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "array"</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/profile/src/profile.ts#L139">packages/profile/src/profile.ts:139</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-object-literal tsd-parent-kind-object-literal">
|
|
<a name="personschemadefinition.properties.knows.items-2" class="tsd-anchor"></a>
|
|
<h3>items</h3>
|
|
<div class="tsd-signature tsd-kind-icon">items<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/profile/src/profile.ts#L141">packages/profile/src/profile.ts:141</a></li>
|
|
</ul>
|
|
</aside>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
|
<a name="personschemadefinition.properties.knows.items-2.type-29" class="tsd-anchor"></a>
|
|
<h3>type</h3>
|
|
<div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "object"</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/profile/src/profile.ts#L142">packages/profile/src/profile.ts:142</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-object-literal tsd-parent-kind-object-literal">
|
|
<a name="personschemadefinition.properties.knows.items-2.properties-4" class="tsd-anchor"></a>
|
|
<h3>properties</h3>
|
|
<div class="tsd-signature tsd-kind-icon">properties<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/profile/src/profile.ts#L143">packages/profile/src/profile.ts:143</a></li>
|
|
</ul>
|
|
</aside>
|
|
<section class="tsd-panel tsd-member tsd-kind-object-literal tsd-parent-kind-object-literal">
|
|
<a name="personschemadefinition.properties.knows.items-2.properties-4._id-1" class="tsd-anchor"></a>
|
|
<h3>@id</h3>
|
|
<div class="tsd-signature tsd-kind-icon">@id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/profile/src/profile.ts#L145">packages/profile/src/profile.ts:145</a></li>
|
|
</ul>
|
|
</aside>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
|
<a name="personschemadefinition.properties.knows.items-2.properties-4._id-1.optional-22" class="tsd-anchor"></a>
|
|
<h3>optional</h3>
|
|
<div class="tsd-signature tsd-kind-icon">optional<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/profile/src/profile.ts#L145">packages/profile/src/profile.ts:145</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
|
<a name="personschemadefinition.properties.knows.items-2.properties-4._id-1.type-30" class="tsd-anchor"></a>
|
|
<h3>type</h3>
|
|
<div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "string"</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/profile/src/profile.ts#L145">packages/profile/src/profile.ts:145</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-object-literal tsd-parent-kind-object-literal">
|
|
<a name="personschemadefinition.properties.knows.items-2.properties-4._type-4" class="tsd-anchor"></a>
|
|
<h3>@type</h3>
|
|
<div class="tsd-signature tsd-kind-icon">@type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/profile/src/profile.ts#L144">packages/profile/src/profile.ts:144</a></li>
|
|
</ul>
|
|
</aside>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
|
<a name="personschemadefinition.properties.knows.items-2.properties-4._type-4.type-31" class="tsd-anchor"></a>
|
|
<h3>type</h3>
|
|
<div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "string"</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/profile/src/profile.ts#L144">packages/profile/src/profile.ts:144</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
</section>
|
|
</section>
|
|
</section>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-object-literal tsd-parent-kind-object-literal">
|
|
<a name="personschemadefinition.properties.name-1" class="tsd-anchor"></a>
|
|
<h3>name</h3>
|
|
<div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/profile/src/profile.ts#L84">packages/profile/src/profile.ts:84</a></li>
|
|
</ul>
|
|
</aside>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
|
<a name="personschemadefinition.properties.name-1.optional-23" class="tsd-anchor"></a>
|
|
<h3>optional</h3>
|
|
<div class="tsd-signature tsd-kind-icon">optional<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/profile/src/profile.ts#L84">packages/profile/src/profile.ts:84</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
|
<a name="personschemadefinition.properties.name-1.type-32" class="tsd-anchor"></a>
|
|
<h3>type</h3>
|
|
<div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "string"</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/profile/src/profile.ts#L84">packages/profile/src/profile.ts:84</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-object-literal tsd-parent-kind-object-literal">
|
|
<a name="personschemadefinition.properties.taxid" class="tsd-anchor"></a>
|
|
<h3>taxID</h3>
|
|
<div class="tsd-signature tsd-kind-icon">taxID<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/profile/src/profile.ts#L161">packages/profile/src/profile.ts:161</a></li>
|
|
</ul>
|
|
</aside>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
|
<a name="personschemadefinition.properties.taxid.optional-24" class="tsd-anchor"></a>
|
|
<h3>optional</h3>
|
|
<div class="tsd-signature tsd-kind-icon">optional<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/profile/src/profile.ts#L161">packages/profile/src/profile.ts:161</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
|
<a name="personschemadefinition.properties.taxid.type-33" class="tsd-anchor"></a>
|
|
<h3>type</h3>
|
|
<div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "string"</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/profile/src/profile.ts#L161">packages/profile/src/profile.ts:161</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-object-literal tsd-parent-kind-object-literal">
|
|
<a name="personschemadefinition.properties.website" class="tsd-anchor"></a>
|
|
<h3>website</h3>
|
|
<div class="tsd-signature tsd-kind-icon">website<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/profile/src/profile.ts#L100">packages/profile/src/profile.ts:100</a></li>
|
|
</ul>
|
|
</aside>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
|
<a name="personschemadefinition.properties.website.optional-25" class="tsd-anchor"></a>
|
|
<h3>optional</h3>
|
|
<div class="tsd-signature tsd-kind-icon">optional<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/profile/src/profile.ts#L102">packages/profile/src/profile.ts:102</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
|
<a name="personschemadefinition.properties.website.type-34" class="tsd-anchor"></a>
|
|
<h3>type</h3>
|
|
<div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "array"</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/profile/src/profile.ts#L101">packages/profile/src/profile.ts:101</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-object-literal tsd-parent-kind-object-literal">
|
|
<a name="personschemadefinition.properties.website.items-3" class="tsd-anchor"></a>
|
|
<h3>items</h3>
|
|
<div class="tsd-signature tsd-kind-icon">items<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/profile/src/profile.ts#L103">packages/profile/src/profile.ts:103</a></li>
|
|
</ul>
|
|
</aside>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
|
<a name="personschemadefinition.properties.website.items-3.type-35" class="tsd-anchor"></a>
|
|
<h3>type</h3>
|
|
<div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "object"</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/profile/src/profile.ts#L104">packages/profile/src/profile.ts:104</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-object-literal tsd-parent-kind-object-literal">
|
|
<a name="personschemadefinition.properties.website.items-3.properties-5" class="tsd-anchor"></a>
|
|
<h3>properties</h3>
|
|
<div class="tsd-signature tsd-kind-icon">properties<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/profile/src/profile.ts#L105">packages/profile/src/profile.ts:105</a></li>
|
|
</ul>
|
|
</aside>
|
|
<section class="tsd-panel tsd-member tsd-kind-object-literal tsd-parent-kind-object-literal">
|
|
<a name="personschemadefinition.properties.website.items-3.properties-5._type-5" class="tsd-anchor"></a>
|
|
<h3>@type</h3>
|
|
<div class="tsd-signature tsd-kind-icon">@type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/profile/src/profile.ts#L106">packages/profile/src/profile.ts:106</a></li>
|
|
</ul>
|
|
</aside>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
|
<a name="personschemadefinition.properties.website.items-3.properties-5._type-5.type-36" class="tsd-anchor"></a>
|
|
<h3>type</h3>
|
|
<div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "string"</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/profile/src/profile.ts#L106">packages/profile/src/profile.ts:106</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-object-literal tsd-parent-kind-object-literal">
|
|
<a name="personschemadefinition.properties.website.items-3.properties-5.url" class="tsd-anchor"></a>
|
|
<h3>url</h3>
|
|
<div class="tsd-signature tsd-kind-icon">url<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/profile/src/profile.ts#L107">packages/profile/src/profile.ts:107</a></li>
|
|
</ul>
|
|
</aside>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
|
<a name="personschemadefinition.properties.website.items-3.properties-5.url.optional-26" class="tsd-anchor"></a>
|
|
<h3>optional</h3>
|
|
<div class="tsd-signature tsd-kind-icon">optional<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/profile/src/profile.ts#L107">packages/profile/src/profile.ts:107</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
|
<a name="personschemadefinition.properties.website.items-3.properties-5.url.type-37" class="tsd-anchor"></a>
|
|
<h3>type</h3>
|
|
<div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "string"</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/profile/src/profile.ts#L107">packages/profile/src/profile.ts:107</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
</section>
|
|
</section>
|
|
</section>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-object-literal tsd-parent-kind-object-literal">
|
|
<a name="personschemadefinition.properties.worksfor" class="tsd-anchor"></a>
|
|
<h3>works<wbr>For</h3>
|
|
<div class="tsd-signature tsd-kind-icon">works<wbr>For<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/profile/src/profile.ts#L127">packages/profile/src/profile.ts:127</a></li>
|
|
</ul>
|
|
</aside>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
|
<a name="personschemadefinition.properties.worksfor.optional-27" class="tsd-anchor"></a>
|
|
<h3>optional</h3>
|
|
<div class="tsd-signature tsd-kind-icon">optional<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/profile/src/profile.ts#L129">packages/profile/src/profile.ts:129</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
|
<a name="personschemadefinition.properties.worksfor.type-38" class="tsd-anchor"></a>
|
|
<h3>type</h3>
|
|
<div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "array"</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/profile/src/profile.ts#L128">packages/profile/src/profile.ts:128</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-object-literal tsd-parent-kind-object-literal">
|
|
<a name="personschemadefinition.properties.worksfor.items-4" class="tsd-anchor"></a>
|
|
<h3>items</h3>
|
|
<div class="tsd-signature tsd-kind-icon">items<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/profile/src/profile.ts#L130">packages/profile/src/profile.ts:130</a></li>
|
|
</ul>
|
|
</aside>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
|
<a name="personschemadefinition.properties.worksfor.items-4.type-39" class="tsd-anchor"></a>
|
|
<h3>type</h3>
|
|
<div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "object"</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/profile/src/profile.ts#L131">packages/profile/src/profile.ts:131</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-object-literal tsd-parent-kind-object-literal">
|
|
<a name="personschemadefinition.properties.worksfor.items-4.properties-6" class="tsd-anchor"></a>
|
|
<h3>properties</h3>
|
|
<div class="tsd-signature tsd-kind-icon">properties<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/profile/src/profile.ts#L132">packages/profile/src/profile.ts:132</a></li>
|
|
</ul>
|
|
</aside>
|
|
<section class="tsd-panel tsd-member tsd-kind-object-literal tsd-parent-kind-object-literal">
|
|
<a name="personschemadefinition.properties.worksfor.items-4.properties-6._id-2" class="tsd-anchor"></a>
|
|
<h3>@id</h3>
|
|
<div class="tsd-signature tsd-kind-icon">@id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/profile/src/profile.ts#L134">packages/profile/src/profile.ts:134</a></li>
|
|
</ul>
|
|
</aside>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
|
<a name="personschemadefinition.properties.worksfor.items-4.properties-6._id-2.optional-28" class="tsd-anchor"></a>
|
|
<h3>optional</h3>
|
|
<div class="tsd-signature tsd-kind-icon">optional<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/profile/src/profile.ts#L134">packages/profile/src/profile.ts:134</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
|
<a name="personschemadefinition.properties.worksfor.items-4.properties-6._id-2.type-40" class="tsd-anchor"></a>
|
|
<h3>type</h3>
|
|
<div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "string"</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/profile/src/profile.ts#L134">packages/profile/src/profile.ts:134</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-object-literal tsd-parent-kind-object-literal">
|
|
<a name="personschemadefinition.properties.worksfor.items-4.properties-6._type-6" class="tsd-anchor"></a>
|
|
<h3>@type</h3>
|
|
<div class="tsd-signature tsd-kind-icon">@type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/profile/src/profile.ts#L133">packages/profile/src/profile.ts:133</a></li>
|
|
</ul>
|
|
</aside>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
|
<a name="personschemadefinition.properties.worksfor.items-4.properties-6._type-6.type-41" class="tsd-anchor"></a>
|
|
<h3>type</h3>
|
|
<div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "string"</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/profile/src/profile.ts#L133">packages/profile/src/profile.ts:133</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
</section>
|
|
</section>
|
|
</section>
|
|
</section>
|
|
</section>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-object-literal">
|
|
<a name="registrars" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> registrars</h3>
|
|
<div class="tsd-signature tsd-kind-icon">registrars<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/keychain/src/profiles.ts#L47">packages/keychain/src/profiles.ts:47</a></li>
|
|
</ul>
|
|
</aside>
|
|
<section class="tsd-panel tsd-member tsd-kind-object-literal tsd-parent-kind-object-literal">
|
|
<a name="registrars._subdomains_blockstack_" class="tsd-anchor"></a>
|
|
<h3>[<wbr>Subdomains.BLOCKSTACK]</h3>
|
|
<div class="tsd-signature tsd-kind-icon">[<wbr>Subdomains.BLOCKSTACK]<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/keychain/src/profiles.ts#L52">packages/keychain/src/profiles.ts:52</a></li>
|
|
</ul>
|
|
</aside>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
|
<a name="registrars._subdomains_blockstack_.apiurl" class="tsd-anchor"></a>
|
|
<h3>api<wbr>Url</h3>
|
|
<div class="tsd-signature tsd-kind-icon">api<wbr>Url<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "https://registrar.blockstack.org/v1/names"</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/keychain/src/profiles.ts#L54">packages/keychain/src/profiles.ts:54</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
|
<a name="registrars._subdomains_blockstack_.registerurl" class="tsd-anchor"></a>
|
|
<h3>register<wbr>Url</h3>
|
|
<div class="tsd-signature tsd-kind-icon">register<wbr>Url<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "https://registrar.blockstack.org/register"</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/keychain/src/profiles.ts#L53">packages/keychain/src/profiles.ts:53</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-object-literal tsd-parent-kind-object-literal">
|
|
<a name="registrars._subdomains_test_" class="tsd-anchor"></a>
|
|
<h3>[<wbr>Subdomains.TEST]</h3>
|
|
<div class="tsd-signature tsd-kind-icon">[<wbr>Subdomains.TEST]<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/keychain/src/profiles.ts#L48">packages/keychain/src/profiles.ts:48</a></li>
|
|
</ul>
|
|
</aside>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
|
<a name="registrars._subdomains_test_.apiurl-1" class="tsd-anchor"></a>
|
|
<h3>api<wbr>Url</h3>
|
|
<div class="tsd-signature tsd-kind-icon">api<wbr>Url<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "https://test-registrar.blockstack.org/v1/names"</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/keychain/src/profiles.ts#L50">packages/keychain/src/profiles.ts:50</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
|
<a name="registrars._subdomains_test_.registerurl-1" class="tsd-anchor"></a>
|
|
<h3>register<wbr>Url</h3>
|
|
<div class="tsd-signature tsd-kind-icon">register<wbr>Url<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "https://test-registrar.blockstack.org/register"</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/keychain/src/profiles.ts#L49">packages/keychain/src/profiles.ts:49</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
</section>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-object-literal">
|
|
<a name="schemadefinition" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> schema<wbr>Definition</h3>
|
|
<div class="tsd-signature tsd-kind-icon">schema<wbr>Definition<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/profile/src/profile.ts#L29">packages/profile/src/profile.ts:29</a></li>
|
|
</ul>
|
|
</aside>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
|
<a name="schemadefinition.type" class="tsd-anchor"></a>
|
|
<h3>type</h3>
|
|
<div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "object"</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/profile/src/profile.ts#L30">packages/profile/src/profile.ts:30</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-object-literal tsd-parent-kind-object-literal">
|
|
<a name="schemadefinition.properties" class="tsd-anchor"></a>
|
|
<h3>properties</h3>
|
|
<div class="tsd-signature tsd-kind-icon">properties<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/profile/src/profile.ts#L31">packages/profile/src/profile.ts:31</a></li>
|
|
</ul>
|
|
</aside>
|
|
<section class="tsd-panel tsd-member tsd-kind-object-literal tsd-parent-kind-object-literal">
|
|
<a name="schemadefinition.properties._context" class="tsd-anchor"></a>
|
|
<h3>@context</h3>
|
|
<div class="tsd-signature tsd-kind-icon">@context<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/profile/src/profile.ts#L32">packages/profile/src/profile.ts:32</a></li>
|
|
</ul>
|
|
</aside>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
|
<a name="schemadefinition.properties._context.optional" class="tsd-anchor"></a>
|
|
<h3>optional</h3>
|
|
<div class="tsd-signature tsd-kind-icon">optional<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/profile/src/profile.ts#L32">packages/profile/src/profile.ts:32</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
|
<a name="schemadefinition.properties._context.type-1" class="tsd-anchor"></a>
|
|
<h3>type</h3>
|
|
<div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "string"</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/profile/src/profile.ts#L32">packages/profile/src/profile.ts:32</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-object-literal tsd-parent-kind-object-literal">
|
|
<a name="schemadefinition.properties._type" class="tsd-anchor"></a>
|
|
<h3>@type</h3>
|
|
<div class="tsd-signature tsd-kind-icon">@type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/profile/src/profile.ts#L33">packages/profile/src/profile.ts:33</a></li>
|
|
</ul>
|
|
</aside>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
|
<a name="schemadefinition.properties._type.type-2" class="tsd-anchor"></a>
|
|
<h3>type</h3>
|
|
<div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "string"</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/profile/src/profile.ts#L33">packages/profile/src/profile.ts:33</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
</section>
|
|
</section>
|
|
</section>
|
|
</section>
|
|
</div>
|
|
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
|
<nav class="tsd-navigation primary">
|
|
<ul>
|
|
<li class="globals current ">
|
|
<a href="globals.html"><em>Globals</em></a>
|
|
</li>
|
|
</ul>
|
|
</nav>
|
|
<nav class="tsd-navigation secondary menu-sticky">
|
|
<ul class="before-current">
|
|
<li class=" tsd-kind-enum">
|
|
<a href="enums/addresshashmode.html" class="tsd-kind-icon">Address<wbr>Hash<wbr>Mode</a>
|
|
</li>
|
|
<li class=" tsd-kind-enum">
|
|
<a href="enums/addressversion.html" class="tsd-kind-icon">Address<wbr>Version</a>
|
|
</li>
|
|
<li class=" tsd-kind-enum">
|
|
<a href="enums/anchormode.html" class="tsd-kind-icon">Anchor<wbr>Mode</a>
|
|
</li>
|
|
<li class=" tsd-kind-enum">
|
|
<a href="enums/assettype.html" class="tsd-kind-icon">Asset<wbr>Type</a>
|
|
</li>
|
|
<li class=" tsd-kind-enum">
|
|
<a href="enums/authfieldtype.html" class="tsd-kind-icon">Auth<wbr>Field<wbr>Type</a>
|
|
</li>
|
|
<li class=" tsd-kind-enum">
|
|
<a href="enums/authscope.html" class="tsd-kind-icon">Auth<wbr>Scope</a>
|
|
</li>
|
|
<li class=" tsd-kind-enum">
|
|
<a href="enums/authtype.html" class="tsd-kind-icon">Auth<wbr>Type</a>
|
|
</li>
|
|
<li class=" tsd-kind-enum">
|
|
<a href="enums/chainid.html" class="tsd-kind-icon">ChainID</a>
|
|
</li>
|
|
<li class=" tsd-kind-enum">
|
|
<a href="enums/clarityabitypeid.html" class="tsd-kind-icon">Clarity<wbr>Abi<wbr>Type<wbr>Id</a>
|
|
</li>
|
|
<li class=" tsd-kind-enum">
|
|
<a href="enums/claritytype.html" class="tsd-kind-icon">Clarity<wbr>Type</a>
|
|
</li>
|
|
<li class=" tsd-kind-enum">
|
|
<a href="enums/fungibleconditioncode.html" class="tsd-kind-icon">Fungible<wbr>Condition<wbr>Code</a>
|
|
</li>
|
|
<li class=" tsd-kind-enum">
|
|
<a href="enums/identitynamevalidityerror.html" class="tsd-kind-icon">Identity<wbr>Name<wbr>Validity<wbr>Error</a>
|
|
</li>
|
|
<li class=" tsd-kind-enum">
|
|
<a href="enums/nonfungibleconditioncode.html" class="tsd-kind-icon">Non<wbr>Fungible<wbr>Condition<wbr>Code</a>
|
|
</li>
|
|
<li class=" tsd-kind-enum">
|
|
<a href="enums/payloadtype.html" class="tsd-kind-icon">Payload<wbr>Type</a>
|
|
</li>
|
|
<li class=" tsd-kind-enum">
|
|
<a href="enums/postconditionmode.html" class="tsd-kind-icon">Post<wbr>Condition<wbr>Mode</a>
|
|
</li>
|
|
<li class=" tsd-kind-enum">
|
|
<a href="enums/postconditionprincipalid.html" class="tsd-kind-icon">Post<wbr>Condition<wbr>PrincipalID</a>
|
|
</li>
|
|
<li class=" tsd-kind-enum">
|
|
<a href="enums/postconditiontype.html" class="tsd-kind-icon">Post<wbr>Condition<wbr>Type</a>
|
|
</li>
|
|
<li class=" tsd-kind-enum">
|
|
<a href="enums/pubkeyencoding.html" class="tsd-kind-icon">Pub<wbr>Key<wbr>Encoding</a>
|
|
</li>
|
|
<li class=" tsd-kind-enum">
|
|
<a href="enums/stackingerrors.html" class="tsd-kind-icon">Stacking<wbr>Errors</a>
|
|
</li>
|
|
<li class=" tsd-kind-enum">
|
|
<a href="enums/stacksmessagetype.html" class="tsd-kind-icon">Stacks<wbr>Message<wbr>Type</a>
|
|
</li>
|
|
<li class=" tsd-kind-enum">
|
|
<a href="enums/subdomains.html" class="tsd-kind-icon">Subdomains</a>
|
|
</li>
|
|
<li class=" tsd-kind-enum">
|
|
<a href="enums/transactionversion.html" class="tsd-kind-icon">Transaction<wbr>Version</a>
|
|
</li>
|
|
<li class=" tsd-kind-enum">
|
|
<a href="enums/txrejectedreason.html" class="tsd-kind-icon">Tx<wbr>Rejected<wbr>Reason</a>
|
|
</li>
|
|
<li class=" tsd-kind-class">
|
|
<a href="classes/appconfig.html" class="tsd-kind-icon">App<wbr>Config</a>
|
|
</li>
|
|
<li class=" tsd-kind-class">
|
|
<a href="classes/authorization.html" class="tsd-kind-icon">Authorization</a>
|
|
</li>
|
|
<li class=" tsd-kind-class">
|
|
<a href="classes/bufferarray.html" class="tsd-kind-icon">Buffer<wbr>Array</a>
|
|
</li>
|
|
<li class=" tsd-kind-class">
|
|
<a href="classes/bufferreader.html" class="tsd-kind-icon">Buffer<wbr>Reader</a>
|
|
</li>
|
|
<li class=" tsd-kind-class">
|
|
<a href="classes/clinetworkadapter.html" class="tsd-kind-icon">CLINetwork<wbr>Adapter</a>
|
|
</li>
|
|
<li class=" tsd-kind-class">
|
|
<a href="classes/clitransactionsigner.html" class="tsd-kind-icon">CLITransaction<wbr>Signer</a>
|
|
</li>
|
|
<li class=" tsd-kind-class">
|
|
<a href="classes/deserializable.html" class="tsd-kind-icon">Deserializable</a>
|
|
</li>
|
|
<li class=" tsd-kind-class">
|
|
<a href="classes/deserializationerror.html" class="tsd-kind-icon">Deserialization<wbr>Error</a>
|
|
</li>
|
|
<li class=" tsd-kind-class">
|
|
<a href="classes/identity.html" class="tsd-kind-icon">Identity</a>
|
|
</li>
|
|
<li class=" tsd-kind-class">
|
|
<a href="classes/identityaddressownernode.html" class="tsd-kind-icon">Identity<wbr>Address<wbr>Owner<wbr>Node</a>
|
|
</li>
|
|
<li class=" tsd-kind-class">
|
|
<a href="classes/multisigkeysigner.html" class="tsd-kind-icon">Multi<wbr>Sig<wbr>Key<wbr>Signer</a>
|
|
</li>
|
|
<li class=" tsd-kind-class">
|
|
<a href="classes/nodecryptoaescipher.html" class="tsd-kind-icon">Node<wbr>Crypto<wbr>Aes<wbr>Cipher</a>
|
|
</li>
|
|
<li class=" tsd-kind-class">
|
|
<a href="classes/nodecryptohmacsha256.html" class="tsd-kind-icon">Node<wbr>Crypto<wbr>Hmac<wbr>Sha256</a>
|
|
</li>
|
|
<li class=" tsd-kind-class">
|
|
<a href="classes/nodecryptopbkdf2.html" class="tsd-kind-icon">Node<wbr>Crypto<wbr>Pbkdf2</a>
|
|
</li>
|
|
<li class=" tsd-kind-class">
|
|
<a href="classes/nodecryptoripemd160digest.html" class="tsd-kind-icon">Node<wbr>Crypto<wbr>Ripemd160<wbr>Digest</a>
|
|
</li>
|
|
<li class=" tsd-kind-class">
|
|
<a href="classes/nodecryptosha2hash.html" class="tsd-kind-icon">Node<wbr>Crypto<wbr>Sha2<wbr>Hash</a>
|
|
</li>
|
|
<li class=" tsd-kind-class">
|
|
<a href="classes/notimplementederror.html" class="tsd-kind-icon">Not<wbr>Implemented<wbr>Error</a>
|
|
</li>
|
|
<li class=" tsd-kind-class">
|
|
<a href="classes/nullsigner.html" class="tsd-kind-icon">Null<wbr>Signer</a>
|
|
</li>
|
|
<li class=" tsd-kind-class">
|
|
<a href="classes/passworderror.html" class="tsd-kind-icon">Password<wbr>Error</a>
|
|
</li>
|
|
<li class=" tsd-kind-class">
|
|
<a href="classes/profile.html" class="tsd-kind-icon">Profile</a>
|
|
</li>
|
|
<li class=" tsd-kind-class">
|
|
<a href="classes/ripemd160polyfilldigest.html" class="tsd-kind-icon">Ripemd160<wbr>Polyfill<wbr>Digest</a>
|
|
</li>
|
|
<li class=" tsd-kind-class">
|
|
<a href="classes/safetyerror.html" class="tsd-kind-icon">Safety<wbr>Error</a>
|
|
</li>
|
|
<li class=" tsd-kind-class">
|
|
<a href="classes/segwitp2shkeysigner.html" class="tsd-kind-icon">Segwit<wbr>P2SHKey<wbr>Signer</a>
|
|
</li>
|
|
<li class=" tsd-kind-class">
|
|
<a href="classes/serializationerror.html" class="tsd-kind-icon">Serialization<wbr>Error</a>
|
|
</li>
|
|
<li class=" tsd-kind-class">
|
|
<a href="classes/sessiondatastore.html" class="tsd-kind-icon">Session<wbr>Data<wbr>Store</a>
|
|
</li>
|
|
<li class=" tsd-kind-class">
|
|
<a href="classes/signingerror.html" class="tsd-kind-icon">Signing<wbr>Error</a>
|
|
</li>
|
|
<li class=" tsd-kind-class">
|
|
<a href="classes/sponsoredauthorization.html" class="tsd-kind-icon">Sponsored<wbr>Authorization</a>
|
|
</li>
|
|
<li class=" tsd-kind-class">
|
|
<a href="classes/stackingclient.html" class="tsd-kind-icon">Stacking<wbr>Client</a>
|
|
</li>
|
|
<li class=" tsd-kind-class">
|
|
<a href="classes/stacksmainnet.html" class="tsd-kind-icon">Stacks<wbr>Mainnet</a>
|
|
</li>
|
|
<li class=" tsd-kind-class">
|
|
<a href="classes/stacksmocknet.html" class="tsd-kind-icon">Stacks<wbr>Mocknet</a>
|
|
</li>
|
|
<li class=" tsd-kind-class">
|
|
<a href="classes/stackstestnet.html" class="tsd-kind-icon">Stacks<wbr>Testnet</a>
|
|
</li>
|
|
<li class=" tsd-kind-class">
|
|
<a href="classes/stackstransaction.html" class="tsd-kind-icon">Stacks<wbr>Transaction</a>
|
|
</li>
|
|
<li class=" tsd-kind-class">
|
|
<a href="classes/stackstransactionerror.html" class="tsd-kind-icon">Stacks<wbr>Transaction<wbr>Error</a>
|
|
</li>
|
|
<li class=" tsd-kind-class">
|
|
<a href="classes/standardauthorization.html" class="tsd-kind-icon">Standard<wbr>Authorization</a>
|
|
</li>
|
|
<li class=" tsd-kind-class">
|
|
<a href="classes/storage.html" class="tsd-kind-icon">Storage</a>
|
|
</li>
|
|
<li class=" tsd-kind-class">
|
|
<a href="classes/transactionsigner.html" class="tsd-kind-icon">Transaction<wbr>Signer</a>
|
|
</li>
|
|
<li class=" tsd-kind-class">
|
|
<a href="classes/usersession.html" class="tsd-kind-icon">User<wbr>Session</a>
|
|
</li>
|
|
<li class=" tsd-kind-class">
|
|
<a href="classes/verificationerror.html" class="tsd-kind-icon">Verification<wbr>Error</a>
|
|
</li>
|
|
<li class=" tsd-kind-class">
|
|
<a href="classes/wallet.html" class="tsd-kind-icon">Wallet</a>
|
|
</li>
|
|
<li class=" tsd-kind-class">
|
|
<a href="classes/walletsigner.html" class="tsd-kind-icon">Wallet<wbr>Signer</a>
|
|
</li>
|
|
<li class=" tsd-kind-class">
|
|
<a href="classes/webcryptoaescipher.html" class="tsd-kind-icon">Web<wbr>Crypto<wbr>Aes<wbr>Cipher</a>
|
|
</li>
|
|
<li class=" tsd-kind-class">
|
|
<a href="classes/webcryptohmacsha256.html" class="tsd-kind-icon">Web<wbr>Crypto<wbr>Hmac<wbr>Sha256</a>
|
|
</li>
|
|
<li class=" tsd-kind-class">
|
|
<a href="classes/webcryptopartialpbkdf2.html" class="tsd-kind-icon">Web<wbr>Crypto<wbr>Partial<wbr>Pbkdf2</a>
|
|
</li>
|
|
<li class=" tsd-kind-class">
|
|
<a href="classes/webcryptopbkdf2.html" class="tsd-kind-icon">Web<wbr>Crypto<wbr>Pbkdf2</a>
|
|
</li>
|
|
<li class=" tsd-kind-class">
|
|
<a href="classes/webcryptosha2hash.html" class="tsd-kind-icon">Web<wbr>Crypto<wbr>Sha2<wbr>Hash</a>
|
|
</li>
|
|
<li class=" tsd-kind-class">
|
|
<a href="classes/sha512_256.html" class="tsd-kind-icon">sha512_<wbr>256</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/address.html" class="tsd-kind-icon">Address</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/aescipher.html" class="tsd-kind-icon">Aes<wbr>Cipher</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/assetinfo.html" class="tsd-kind-icon">Asset<wbr>Info</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/authrequesttype.html" class="tsd-kind-icon">Auth<wbr>Request<wbr>Type</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/balanceinfo.html" class="tsd-kind-icon">Balance<wbr>Info</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/blocktimeinfo.html" class="tsd-kind-icon">Block<wbr>Time<wbr>Info</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/buffercv.html" class="tsd-kind-icon">BufferCV</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/cli_command_group.html" class="tsd-kind-icon">CLI_<wbr>COMMAND_<wbr>GROUP</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/cli_command_group_item.html" class="tsd-kind-icon">CLI_<wbr>COMMAND_<wbr>GROUP_<wbr>ITEM</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/cli_command_help.html" class="tsd-kind-icon">CLI_<wbr>COMMAND_<wbr>HELP</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/cli_config_type.html" class="tsd-kind-icon">CLI_<wbr>CONFIG_<wbr>TYPE</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/cli_log_config_type.html" class="tsd-kind-icon">CLI_<wbr>LOG_<wbr>CONFIG_<wbr>TYPE</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/cli_network_opts.html" class="tsd-kind-icon">CLI_<wbr>NETWORK_<wbr>OPTS</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/cli_opts.html" class="tsd-kind-icon">CLI_<wbr>OPTS</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/cli_prop.html" class="tsd-kind-icon">CLI_<wbr>PROP</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/cli_prop_item.html" class="tsd-kind-icon">CLI_<wbr>PROP_<wbr>ITEM</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/canlockstxoptions.html" class="tsd-kind-icon">Can<wbr>Lock<wbr>Stx<wbr>Options</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/checkargsfailtype.html" class="tsd-kind-icon">Check<wbr>Args<wbr>Fail<wbr>Type</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/checkargssuccesstype.html" class="tsd-kind-icon">Check<wbr>Args<wbr>Success<wbr>Type</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/clarityabi.html" class="tsd-kind-icon">Clarity<wbr>Abi</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/clarityabifunction.html" class="tsd-kind-icon">Clarity<wbr>Abi<wbr>Function</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/clarityabimap.html" class="tsd-kind-icon">Clarity<wbr>Abi<wbr>Map</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/clarityabitypefungibletoken.html" class="tsd-kind-icon">Clarity<wbr>Abi<wbr>Type<wbr>Fungible<wbr>Token</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/clarityabitypenonfungibletoken.html" class="tsd-kind-icon">Clarity<wbr>Abi<wbr>Type<wbr>Non<wbr>Fungible<wbr>Token</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/clarityabivariable.html" class="tsd-kind-icon">Clarity<wbr>Abi<wbr>Variable</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/clarityfunctionarg.html" class="tsd-kind-icon">Clarity<wbr>Function<wbr>Arg</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/coinbasepayload.html" class="tsd-kind-icon">Coinbase<wbr>Payload</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/configapp.html" class="tsd-kind-icon">Config<wbr>App</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/configidentity.html" class="tsd-kind-icon">Config<wbr>Identity</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/connecttogaiaoptions.html" class="tsd-kind-icon">Connect<wbr>ToGaia<wbr>Options</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/constructoroptions.html" class="tsd-kind-icon">Constructor<wbr>Options</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/contractcalloptions.html" class="tsd-kind-icon">Contract<wbr>Call<wbr>Options</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/contractcallpayload.html" class="tsd-kind-icon">Contract<wbr>Call<wbr>Payload</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/contractdeployoptions.html" class="tsd-kind-icon">Contract<wbr>Deploy<wbr>Options</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/contractprincipal.html" class="tsd-kind-icon">Contract<wbr>Principal</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/contractprincipalcv.html" class="tsd-kind-icon">Contract<wbr>PrincipalCV</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/coreinfo.html" class="tsd-kind-icon">Core<wbr>Info</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/delegatestackstxoptions.html" class="tsd-kind-icon">Delegate<wbr>Stack<wbr>Stx<wbr>Options</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/delegatestxoptions.html" class="tsd-kind-icon">Delegate<wbr>Stx<wbr>Options</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/encryptcontentoptions.html" class="tsd-kind-icon">Encrypt<wbr>Content<wbr>Options</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/encryptionoptions.html" class="tsd-kind-icon">Encryption<wbr>Options</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/falsecv.html" class="tsd-kind-icon">FalseCV</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/fungiblepostcondition.html" class="tsd-kind-icon">Fungible<wbr>Post<wbr>Condition</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/gaiaauthpayload.html" class="tsd-kind-icon">Gaia<wbr>Auth<wbr>Payload</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/gaiahubconfig.html" class="tsd-kind-icon">Gaia<wbr>Hub<wbr>Config</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/getfileoptions.html" class="tsd-kind-icon">Get<wbr>File<wbr>Options</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/getfileurloptions.html" class="tsd-kind-icon">Get<wbr>File<wbr>Url<wbr>Options</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/getglobalobjectoptions.html" class="tsd-kind-icon">Get<wbr>Global<wbr>Object<wbr>Options</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/hmac.html" class="tsd-kind-icon">Hmac</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/huberrordetails.html" class="tsd-kind-icon">Hub<wbr>Error<wbr>Details</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/hubinfo.html" class="tsd-kind-icon">Hub<wbr>Info</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/idappkeys.html" class="tsd-kind-icon">IDApp<wbr>Keys</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/identityconstructoroptions.html" class="tsd-kind-icon">Identity<wbr>Constructor<wbr>Options</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/identitykeypair.html" class="tsd-kind-icon">Identity<wbr>Key<wbr>Pair</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/inquirerprompt.html" class="tsd-kind-icon">Inquirer<wbr>Prompt</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/intcv.html" class="tsd-kind-icon">IntCV</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/lengthprefixedlist.html" class="tsd-kind-icon">Length<wbr>Prefixed<wbr>List</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/lengthprefixedstring.html" class="tsd-kind-icon">Length<wbr>Prefixed<wbr>String</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/listcv.html" class="tsd-kind-icon">ListCV</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/lockstxoptions.html" class="tsd-kind-icon">Lock<wbr>Stx<wbr>Options</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/memostring.html" class="tsd-kind-icon">Memo<wbr>String</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/messagesignature.html" class="tsd-kind-icon">Message<wbr>Signature</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/multisigoptions.html" class="tsd-kind-icon">Multi<wbr>Sig<wbr>Options</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/multisigspendingcondition.html" class="tsd-kind-icon">Multi<wbr>Sig<wbr>Spending<wbr>Condition</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/nameinforesponse.html" class="tsd-kind-icon">Name<wbr>Info<wbr>Response</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/namedidentitytype.html" class="tsd-kind-icon">Named<wbr>Identity<wbr>Type</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/nodecryptolib.html" class="tsd-kind-icon">Node<wbr>Crypto<wbr>Lib</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/nonfungiblepostcondition.html" class="tsd-kind-icon">Non<wbr>Fungible<wbr>Post<wbr>Condition</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/nonecv.html" class="tsd-kind-icon">NoneCV</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/pbkdf2.html" class="tsd-kind-icon">Pbkdf2</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/poisonpayload.html" class="tsd-kind-icon">Poison<wbr>Payload</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/poxinfo.html" class="tsd-kind-icon">Pox<wbr>Info</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/pricetype.html" class="tsd-kind-icon">Price<wbr>Type</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/profileimage.html" class="tsd-kind-icon">Profile<wbr>Image</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/profilelookupoptions.html" class="tsd-kind-icon">Profile<wbr>Lookup<wbr>Options</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/putfileoptions.html" class="tsd-kind-icon">Put<wbr>File<wbr>Options</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/readonlyfunctionerrorresponse.html" class="tsd-kind-icon">Read<wbr>Only<wbr>Function<wbr>Error<wbr>Response</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/readonlyfunctionoptions.html" class="tsd-kind-icon">Read<wbr>Only<wbr>Function<wbr>Options</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/readonlyfunctionsuccessresponse.html" class="tsd-kind-icon">Read<wbr>Only<wbr>Function<wbr>Success<wbr>Response</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/readonlygaiaconfigoptions.html" class="tsd-kind-icon">Read<wbr>Only<wbr>Gaia<wbr>Config<wbr>Options</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/recursivemakeidentitiesoptions.html" class="tsd-kind-icon">Recursive<wbr>Make<wbr>Identities<wbr>Options</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/refreshoptions.html" class="tsd-kind-icon">Refresh<wbr>Options</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/registerparams.html" class="tsd-kind-icon">Register<wbr>Params</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/responseerrorcv.html" class="tsd-kind-icon">Response<wbr>ErrorCV</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/responseokcv.html" class="tsd-kind-icon">Response<wbr>OkCV</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/ripemd160digest.html" class="tsd-kind-icon">Ripemd160<wbr>Digest</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/stxpostcondition.html" class="tsd-kind-icon">STXPost<wbr>Condition</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/stxtransferoptions.html" class="tsd-kind-icon">STXTransfer<wbr>Options</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/sendtoregistrarparams.html" class="tsd-kind-icon">Send<wbr>ToRegistrar<wbr>Params</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/sessionoptions.html" class="tsd-kind-icon">Session<wbr>Options</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/sha2hash.html" class="tsd-kind-icon">Sha2<wbr>Hash</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/signedcontractcalloptions.html" class="tsd-kind-icon">Signed<wbr>Contract<wbr>Call<wbr>Options</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/signedmultisigcontractcalloptions.html" class="tsd-kind-icon">Signed<wbr>Multi<wbr>Sig<wbr>Contract<wbr>Call<wbr>Options</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/signedmultisigtokentransferoptions.html" class="tsd-kind-icon">Signed<wbr>Multi<wbr>Sig<wbr>Token<wbr>Transfer<wbr>Options</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/signedtokentransferoptions.html" class="tsd-kind-icon">Signed<wbr>Token<wbr>Transfer<wbr>Options</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/singlesigspendingcondition.html" class="tsd-kind-icon">Single<wbr>Sig<wbr>Spending<wbr>Condition</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/smartcontractpayload.html" class="tsd-kind-icon">Smart<wbr>Contract<wbr>Payload</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/somecv.html" class="tsd-kind-icon">SomeCV</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/sponsoroptions.html" class="tsd-kind-icon">Sponsor<wbr>Options</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/stackaggregationcommitoptions.html" class="tsd-kind-icon">Stack<wbr>Aggregation<wbr>Commit<wbr>Options</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/stackingeligibility.html" class="tsd-kind-icon">Stacking<wbr>Eligibility</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/stacksnetwork.html" class="tsd-kind-icon">Stacks<wbr>Network</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/stacksprivatekey.html" class="tsd-kind-icon">Stacks<wbr>Private<wbr>Key</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/stackspublickey.html" class="tsd-kind-icon">Stacks<wbr>Public<wbr>Key</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/standardprincipal.html" class="tsd-kind-icon">Standard<wbr>Principal</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/standardprincipalcv.html" class="tsd-kind-icon">Standard<wbr>PrincipalCV</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/storageoptions.html" class="tsd-kind-icon">Storage<wbr>Options</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/stringasciicv.html" class="tsd-kind-icon">String<wbr>AsciiCV</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/stringutf8cv.html" class="tsd-kind-icon">String<wbr>Utf8CV</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/tokentransferoptions.html" class="tsd-kind-icon">Token<wbr>Transfer<wbr>Options</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/tokentransferpayload.html" class="tsd-kind-icon">Token<wbr>Transfer<wbr>Payload</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/transactionauthfield.html" class="tsd-kind-icon">Transaction<wbr>Auth<wbr>Field</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/truecv.html" class="tsd-kind-icon">TrueCV</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/tuplecv.html" class="tsd-kind-icon">TupleCV</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/uintcv.html" class="tsd-kind-icon">UIntCV</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/utxo.html" class="tsd-kind-icon">UTXO</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/unsignedcontractcalloptions.html" class="tsd-kind-icon">Unsigned<wbr>Contract<wbr>Call<wbr>Options</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/unsignedmultisigcontractcalloptions.html" class="tsd-kind-icon">Unsigned<wbr>Multi<wbr>Sig<wbr>Contract<wbr>Call<wbr>Options</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/unsignedmultisigtokentransferoptions.html" class="tsd-kind-icon">Unsigned<wbr>Multi<wbr>Sig<wbr>Token<wbr>Transfer<wbr>Options</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/unsignedtokentransferoptions.html" class="tsd-kind-icon">Unsigned<wbr>Token<wbr>Transfer<wbr>Options</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/uploadresponse.html" class="tsd-kind-icon">Upload<wbr>Response</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/userdata.html" class="tsd-kind-icon">User<wbr>Data</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/walletconfig.html" class="tsd-kind-icon">Wallet<wbr>Config</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/webcryptolib.html" class="tsd-kind-icon">Web<wbr>Crypto<wbr>Lib</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/whoisinfotype.html" class="tsd-kind-icon">Whois<wbr>Info<wbr>Type</a>
|
|
</li>
|
|
<li class=" tsd-kind-type-alias">
|
|
<a href="globals.html#allowedkeyentropybits" class="tsd-kind-icon">Allowed<wbr>Key<wbr>Entropy<wbr>Bits</a>
|
|
</li>
|
|
<li class=" tsd-kind-type-alias">
|
|
<a href="globals.html#anyjson" class="tsd-kind-icon">Any<wbr>Json</a>
|
|
</li>
|
|
<li class=" tsd-kind-type-alias">
|
|
<a href="globals.html#appkeyinfotype" class="tsd-kind-icon">App<wbr>Key<wbr>Info<wbr>Type</a>
|
|
</li>
|
|
<li class=" tsd-kind-type-alias">
|
|
<a href="globals.html#authmetadata" class="tsd-kind-icon">Auth<wbr>Metadata</a>
|
|
</li>
|
|
<li class=" tsd-kind-type-alias">
|
|
<a href="globals.html#booleancv" class="tsd-kind-icon">BooleanCV</a>
|
|
</li>
|
|
<li class=" tsd-kind-type-alias">
|
|
<a href="globals.html#cipheralgorithm" class="tsd-kind-icon">Cipher<wbr>Algorithm</a>
|
|
</li>
|
|
<li class=" tsd-kind-type-alias">
|
|
<a href="globals.html#clarityabitype" class="tsd-kind-icon">Clarity<wbr>Abi<wbr>Type</a>
|
|
</li>
|
|
<li class=" tsd-kind-type-alias">
|
|
<a href="globals.html#clarityabitypebool" class="tsd-kind-icon">Clarity<wbr>Abi<wbr>Type<wbr>Bool</a>
|
|
</li>
|
|
<li class=" tsd-kind-type-alias">
|
|
<a href="globals.html#clarityabitypebuffer" class="tsd-kind-icon">Clarity<wbr>Abi<wbr>Type<wbr>Buffer</a>
|
|
</li>
|
|
<li class=" tsd-kind-type-alias">
|
|
<a href="globals.html#clarityabitypeint128" class="tsd-kind-icon">Clarity<wbr>Abi<wbr>Type<wbr>Int128</a>
|
|
</li>
|
|
<li class=" tsd-kind-type-alias">
|
|
<a href="globals.html#clarityabitypelist" class="tsd-kind-icon">Clarity<wbr>Abi<wbr>Type<wbr>List</a>
|
|
</li>
|
|
<li class=" tsd-kind-type-alias">
|
|
<a href="globals.html#clarityabitypenone" class="tsd-kind-icon">Clarity<wbr>Abi<wbr>Type<wbr>None</a>
|
|
</li>
|
|
<li class=" tsd-kind-type-alias">
|
|
<a href="globals.html#clarityabitypeoptional" class="tsd-kind-icon">Clarity<wbr>Abi<wbr>Type<wbr>Optional</a>
|
|
</li>
|
|
<li class=" tsd-kind-type-alias">
|
|
<a href="globals.html#clarityabitypeprimitive" class="tsd-kind-icon">Clarity<wbr>Abi<wbr>Type<wbr>Primitive</a>
|
|
</li>
|
|
<li class=" tsd-kind-type-alias">
|
|
<a href="globals.html#clarityabitypeprincipal" class="tsd-kind-icon">Clarity<wbr>Abi<wbr>Type<wbr>Principal</a>
|
|
</li>
|
|
<li class=" tsd-kind-type-alias">
|
|
<a href="globals.html#clarityabityperesponse" class="tsd-kind-icon">Clarity<wbr>Abi<wbr>Type<wbr>Response</a>
|
|
</li>
|
|
<li class=" tsd-kind-type-alias">
|
|
<a href="globals.html#clarityabitypestringascii" class="tsd-kind-icon">Clarity<wbr>Abi<wbr>Type<wbr>String<wbr>Ascii</a>
|
|
</li>
|
|
<li class=" tsd-kind-type-alias">
|
|
<a href="globals.html#clarityabitypestringutf8" class="tsd-kind-icon">Clarity<wbr>Abi<wbr>Type<wbr>String<wbr>Utf8</a>
|
|
</li>
|
|
<li class=" tsd-kind-type-alias">
|
|
<a href="globals.html#clarityabitypetraitreference" class="tsd-kind-icon">Clarity<wbr>Abi<wbr>Type<wbr>Trait<wbr>Reference</a>
|
|
</li>
|
|
<li class=" tsd-kind-type-alias">
|
|
<a href="globals.html#clarityabitypetuple" class="tsd-kind-icon">Clarity<wbr>Abi<wbr>Type<wbr>Tuple</a>
|
|
</li>
|
|
<li class=" tsd-kind-type-alias">
|
|
<a href="globals.html#clarityabitypeuint128" class="tsd-kind-icon">Clarity<wbr>Abi<wbr>TypeUInt128</a>
|
|
</li>
|
|
<li class=" tsd-kind-type-alias">
|
|
<a href="globals.html#clarityabitypeunion" class="tsd-kind-icon">Clarity<wbr>Abi<wbr>Type<wbr>Union</a>
|
|
</li>
|
|
<li class=" tsd-kind-type-alias">
|
|
<a href="globals.html#clarityvalue" class="tsd-kind-icon">Clarity<wbr>Value</a>
|
|
</li>
|
|
<li class=" tsd-kind-type-alias">
|
|
<a href="globals.html#commandfunction" class="tsd-kind-icon">Command<wbr>Function</a>
|
|
</li>
|
|
<li class=" tsd-kind-type-alias">
|
|
<a href="globals.html#docsargstype" class="tsd-kind-icon">Docs<wbr>Args<wbr>Type</a>
|
|
</li>
|
|
<li class=" tsd-kind-type-alias">
|
|
<a href="globals.html#etagmap" class="tsd-kind-icon">Etag<wbr>Map</a>
|
|
</li>
|
|
<li class=" tsd-kind-type-alias">
|
|
<a href="globals.html#formatteddocstype" class="tsd-kind-icon">Formatted<wbr>Docs<wbr>Type</a>
|
|
</li>
|
|
<li class=" tsd-kind-type-alias">
|
|
<a href="globals.html#getrandombytes" class="tsd-kind-icon">Get<wbr>Random<wbr>Bytes</a>
|
|
</li>
|
|
<li class=" tsd-kind-type-alias">
|
|
<a href="globals.html#multisighashmode" class="tsd-kind-icon">Multi<wbr>Sig<wbr>Hash<wbr>Mode</a>
|
|
</li>
|
|
<li class=" tsd-kind-type-alias">
|
|
<a href="globals.html#nameinfotype" class="tsd-kind-icon">Name<wbr>Info<wbr>Type</a>
|
|
</li>
|
|
<li class=" tsd-kind-type-alias">
|
|
<a href="globals.html#nodecryptocreatecipher" class="tsd-kind-icon">Node<wbr>Crypto<wbr>Create<wbr>Cipher</a>
|
|
</li>
|
|
<li class=" tsd-kind-type-alias">
|
|
<a href="globals.html#nodecryptocreatedecipher" class="tsd-kind-icon">Node<wbr>Crypto<wbr>Create<wbr>Decipher</a>
|
|
</li>
|
|
<li class=" tsd-kind-type-alias">
|
|
<a href="globals.html#nodecryptocreatehash" class="tsd-kind-icon">Node<wbr>Crypto<wbr>Create<wbr>Hash</a>
|
|
</li>
|
|
<li class=" tsd-kind-type-alias">
|
|
<a href="globals.html#nodecryptocreatehmac" class="tsd-kind-icon">Node<wbr>Crypto<wbr>Create<wbr>Hmac</a>
|
|
</li>
|
|
<li class=" tsd-kind-type-alias">
|
|
<a href="globals.html#nodepbkdf2fn" class="tsd-kind-icon">Node<wbr>Pbkdf2<wbr>Fn</a>
|
|
</li>
|
|
<li class=" tsd-kind-type-alias">
|
|
<a href="globals.html#optionalcv" class="tsd-kind-icon">OptionalCV</a>
|
|
</li>
|
|
<li class=" tsd-kind-type-alias">
|
|
<a href="globals.html#ownerkeyinfotype" class="tsd-kind-icon">Owner<wbr>Key<wbr>Info<wbr>Type</a>
|
|
</li>
|
|
<li class=" tsd-kind-type-alias">
|
|
<a href="globals.html#payload" class="tsd-kind-icon">Payload</a>
|
|
</li>
|
|
<li class=" tsd-kind-type-alias">
|
|
<a href="globals.html#paymentkeyinfotype" class="tsd-kind-icon">Payment<wbr>Key<wbr>Info<wbr>Type</a>
|
|
</li>
|
|
<li class=" tsd-kind-type-alias">
|
|
<a href="globals.html#pbkdf2digests" class="tsd-kind-icon">Pbkdf2<wbr>Digests</a>
|
|
</li>
|
|
<li class=" tsd-kind-type-alias">
|
|
<a href="globals.html#postcondition" class="tsd-kind-icon">Post<wbr>Condition</a>
|
|
</li>
|
|
<li class=" tsd-kind-type-alias">
|
|
<a href="globals.html#postconditionprincipal" class="tsd-kind-icon">Post<wbr>Condition<wbr>Principal</a>
|
|
</li>
|
|
<li class=" tsd-kind-type-alias">
|
|
<a href="globals.html#principalcv" class="tsd-kind-icon">PrincipalCV</a>
|
|
</li>
|
|
<li class=" tsd-kind-type-alias">
|
|
<a href="globals.html#putfilecontent" class="tsd-kind-icon">Put<wbr>File<wbr>Content</a>
|
|
</li>
|
|
<li class=" tsd-kind-type-alias">
|
|
<a href="globals.html#readonlyfunctionresponse" class="tsd-kind-icon">Read<wbr>Only<wbr>Function<wbr>Response</a>
|
|
</li>
|
|
<li class=" tsd-kind-type-alias">
|
|
<a href="globals.html#responsecv" class="tsd-kind-icon">ResponseCV</a>
|
|
</li>
|
|
<li class=" tsd-kind-type-alias">
|
|
<a href="globals.html#singlesighashmode" class="tsd-kind-icon">Single<wbr>Sig<wbr>Hash<wbr>Mode</a>
|
|
</li>
|
|
<li class=" tsd-kind-type-alias">
|
|
<a href="globals.html#spendingcondition" class="tsd-kind-icon">Spending<wbr>Condition</a>
|
|
</li>
|
|
<li class=" tsd-kind-type-alias">
|
|
<a href="globals.html#stackerinfo" class="tsd-kind-icon">Stacker<wbr>Info</a>
|
|
</li>
|
|
<li class=" tsd-kind-type-alias">
|
|
<a href="globals.html#stackskeyinfotype" class="tsd-kind-icon">Stacks<wbr>Key<wbr>Info<wbr>Type</a>
|
|
</li>
|
|
<li class=" tsd-kind-type-alias">
|
|
<a href="globals.html#stacksmessage" class="tsd-kind-icon">Stacks<wbr>Message</a>
|
|
</li>
|
|
<li class=" tsd-kind-type-alias">
|
|
<a href="globals.html#transactionauthfieldcontents" class="tsd-kind-icon">Transaction<wbr>Auth<wbr>Field<wbr>Contents</a>
|
|
</li>
|
|
<li class=" tsd-kind-type-alias">
|
|
<a href="globals.html#triplesecdecryptsignature" class="tsd-kind-icon">Triplesec<wbr>Decrypt<wbr>Signature</a>
|
|
</li>
|
|
<li class=" tsd-kind-type-alias">
|
|
<a href="globals.html#tupledata" class="tsd-kind-icon">Tuple<wbr>Data</a>
|
|
</li>
|
|
<li class=" tsd-kind-type-alias">
|
|
<a href="globals.html#txbroadcastresult" class="tsd-kind-icon">Tx<wbr>Broadcast<wbr>Result</a>
|
|
</li>
|
|
<li class=" tsd-kind-type-alias">
|
|
<a href="globals.html#txbroadcastresultok" class="tsd-kind-icon">Tx<wbr>Broadcast<wbr>Result<wbr>Ok</a>
|
|
</li>
|
|
<li class=" tsd-kind-type-alias">
|
|
<a href="globals.html#txbroadcastresultrejected" class="tsd-kind-icon">Tx<wbr>Broadcast<wbr>Result<wbr>Rejected</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable">
|
|
<a href="globals.html#address_chars" class="tsd-kind-icon">ADDRESS_<wbr>CHARS</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable">
|
|
<a href="globals.html#address_pattern" class="tsd-kind-icon">ADDRESS_<wbr>PATTERN</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable">
|
|
<a href="globals.html#apps_node_index" class="tsd-kind-icon">APPS_<wbr>NODE_<wbr>INDEX</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable">
|
|
<a href="globals.html#auth_continuation_param" class="tsd-kind-icon">AUTH_<wbr>CONTINUATION_<wbr>PARAM</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable">
|
|
<a href="globals.html#blockstack_on_bitcoin" class="tsd-kind-icon">BLOCKSTACK_<wbr>ON_<wbr>BITCOIN</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable">
|
|
<a href="globals.html#blockstack_test" class="tsd-kind-icon">BLOCKSTACK_<wbr>TEST</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable">
|
|
<a href="globals.html#bn" class="tsd-kind-icon">BN</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable">
|
|
<a href="globals.html#boolean_pattern" class="tsd-kind-icon">BOOLEAN_<wbr>PATTERN</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable">
|
|
<a href="globals.html#c32_address_chars" class="tsd-kind-icon">C32_<wbr>ADDRESS_<wbr>CHARS</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable">
|
|
<a href="globals.html#change_address" class="tsd-kind-icon">CHANGE_<wbr>ADDRESS</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable">
|
|
<a href="globals.html#clarity_int_size" class="tsd-kind-icon">CLARITY_<wbr>INT_<wbr>SIZE</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable">
|
|
<a href="globals.html#coinbase_buffer_length_bytes" class="tsd-kind-icon">COINBASE_<wbr>BUFFER_<wbr>LENGTH_<wbr>BYTES</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable">
|
|
<a href="globals.html#compressed_pubkey_length_bytes" class="tsd-kind-icon">COMPRESSED_<wbr>PUBKEY_<wbr>LENGTH_<wbr>BYTES</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable">
|
|
<a href="globals.html#config_index" class="tsd-kind-icon">CONFIG_<wbr>INDEX</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable">
|
|
<a href="globals.html#context" class="tsd-kind-icon">CONTEXT</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable">
|
|
<a href="globals.html#default_blockstack_host" class="tsd-kind-icon">DEFAULT_<wbr>BLOCKSTACK_<wbr>HOST</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable">
|
|
<a href="globals.html#default_chain_id" class="tsd-kind-icon">DEFAULT_<wbr>CHAIN_<wbr>ID</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable">
|
|
<a href="globals.html#default_config_path" class="tsd-kind-icon">DEFAULT_<wbr>CONFIG_<wbr>PATH</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable">
|
|
<a href="globals.html#default_config_regtest_path" class="tsd-kind-icon">DEFAULT_<wbr>CONFIG_<wbr>REGTEST_<wbr>PATH</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable">
|
|
<a href="globals.html#default_config_testnet_path" class="tsd-kind-icon">DEFAULT_<wbr>CONFIG_<wbr>TESTNET_<wbr>PATH</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable">
|
|
<a href="globals.html#default_core_node_api_url" class="tsd-kind-icon">DEFAULT_<wbr>CORE_<wbr>NODE_<wbr>API_<wbr>URL</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable">
|
|
<a href="globals.html#default_gaia_hub" class="tsd-kind-icon">DEFAULT_<wbr>GAIA_<wbr>HUB</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable">
|
|
<a href="globals.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">
|
|
<a href="globals.html#default_profile_file_name" class="tsd-kind-icon">DEFAULT_<wbr>PROFILE_<wbr>FILE_<wbr>NAME</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable">
|
|
<a href="globals.html#default_transaction_version" class="tsd-kind-icon">DEFAULT_<wbr>TRANSACTION_<wbr>VERSION</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable">
|
|
<a href="globals.html#derivation_path" class="tsd-kind-icon">DERIVATION_<wbr>PATH</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable">
|
|
<a href="globals.html#echo_reply_param" class="tsd-kind-icon">ECHO_<wbr>REPLY_<wbr>PARAM</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable">
|
|
<a href="globals.html#encryption_node_index" class="tsd-kind-icon">ENCRYPTION_<wbr>NODE_<wbr>INDEX</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable">
|
|
<a href="globals.html#external_address" class="tsd-kind-icon">EXTERNAL_<wbr>ADDRESS</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable">
|
|
<a href="globals.html#global_detection_cache_key" class="tsd-kind-icon">GLOBAL_<wbr>DETECTION_<wbr>CACHE_<wbr>KEY</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable">
|
|
<a href="globals.html#identity_keychain" class="tsd-kind-icon">IDENTITY_<wbr>KEYCHAIN</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable">
|
|
<a href="globals.html#id_address_pattern" class="tsd-kind-icon">ID_<wbr>ADDRESS_<wbr>PATTERN</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable">
|
|
<a href="globals.html#image_type" class="tsd-kind-icon">IMAGE_<wbr>TYPE</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable">
|
|
<a href="globals.html#int_pattern" class="tsd-kind-icon">INT_<wbr>PATTERN</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable">
|
|
<a href="globals.html#max_string_length_bytes" class="tsd-kind-icon">MAX_<wbr>STRING_<wbr>LENGTH_<wbr>BYTES</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable">
|
|
<a href="globals.html#memo_max_length_bytes" class="tsd-kind-icon">MEMO_<wbr>MAX_<wbr>LENGTH_<wbr>BYTES</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable">
|
|
<a href="globals.html#namespace_pattern" class="tsd-kind-icon">NAMESPACE_<wbr>PATTERN</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable">
|
|
<a href="globals.html#name_pattern" class="tsd-kind-icon">NAME_<wbr>PATTERN</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable">
|
|
<a href="globals.html#no_crypto_lib" class="tsd-kind-icon">NO_<wbr>CRYPTO_<wbr>LIB</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable">
|
|
<a href="globals.html#person_type" class="tsd-kind-icon">PERSON_<wbr>TYPE</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable">
|
|
<a href="globals.html#private_key_multisig_pattern" class="tsd-kind-icon">PRIVATE_<wbr>KEY_<wbr>MULTISIG_<wbr>PATTERN</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable">
|
|
<a href="globals.html#private_key_nosign_pattern" class="tsd-kind-icon">PRIVATE_<wbr>KEY_<wbr>NOSIGN_<wbr>PATTERN</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable">
|
|
<a href="globals.html#private_key_pattern" class="tsd-kind-icon">PRIVATE_<wbr>KEY_<wbr>PATTERN</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable">
|
|
<a href="globals.html#private_key_pattern_any" class="tsd-kind-icon">PRIVATE_<wbr>KEY_<wbr>PATTERN_<wbr>ANY</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable">
|
|
<a href="globals.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">
|
|
<a href="globals.html#private_key_uncompressed_pattern" class="tsd-kind-icon">PRIVATE_<wbr>KEY_<wbr>UNCOMPRESSED_<wbr>PATTERN</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable">
|
|
<a href="globals.html#public_key_pattern" class="tsd-kind-icon">PUBLIC_<wbr>KEY_<wbr>PATTERN</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable">
|
|
<a href="globals.html#public_testnet_host" class="tsd-kind-icon">PUBLIC_<wbr>TESTNET_<wbr>HOST</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable">
|
|
<a href="globals.html#recoverable_ecdsa_sig_length_bytes" class="tsd-kind-icon">RECOVERABLE_<wbr>ECDSA_<wbr>SIG_<wbr>LENGTH_<wbr>BYTES</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable">
|
|
<a href="globals.html#satoshis_per_btc" class="tsd-kind-icon">SATOSHIS_<wbr>PER_<wbr>BTC</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable">
|
|
<a href="globals.html#session_version" class="tsd-kind-icon">SESSION_<wbr>VERSION</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable">
|
|
<a href="globals.html#signature_file_suffix" class="tsd-kind-icon">SIGNATURE_<wbr>FILE_<wbr>SUFFIX</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable">
|
|
<a href="globals.html#signing_node_index" class="tsd-kind-icon">SIGNING_<wbr>NODE_<wbr>INDEX</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable">
|
|
<a href="globals.html#signin_css" class="tsd-kind-icon">SIGNIN_<wbr>CSS</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable">
|
|
<a href="globals.html#signin_desc" class="tsd-kind-icon">SIGNIN_<wbr>DESC</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable">
|
|
<a href="globals.html#signin_fmt_id" class="tsd-kind-icon">SIGNIN_<wbr>FMT_<wbr>ID</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable">
|
|
<a href="globals.html#signin_fmt_name" class="tsd-kind-icon">SIGNIN_<wbr>FMT_<wbr>NAME</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable">
|
|
<a href="globals.html#signin_footer" class="tsd-kind-icon">SIGNIN_<wbr>FOOTER</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable">
|
|
<a href="globals.html#signin_header" class="tsd-kind-icon">SIGNIN_<wbr>HEADER</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable">
|
|
<a href="globals.html#signin_scopes" class="tsd-kind-icon">SIGNIN_<wbr>SCOPES</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable">
|
|
<a href="globals.html#stacks_address_pattern" class="tsd-kind-icon">STACKS_<wbr>ADDRESS_<wbr>PATTERN</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable">
|
|
<a href="globals.html#strength" class="tsd-kind-icon">STRENGTH</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable">
|
|
<a href="globals.html#stx_node_index" class="tsd-kind-icon">STX_<wbr>NODE_<wbr>INDEX</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable">
|
|
<a href="globals.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">
|
|
<a href="globals.html#subdomain_pattern" class="tsd-kind-icon">SUBDOMAIN_<wbr>PATTERN</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable">
|
|
<a href="globals.html#txid_pattern" class="tsd-kind-icon">TXID_<wbr>PATTERN</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable">
|
|
<a href="globals.html#uncompressed_pubkey_length_bytes" class="tsd-kind-icon">UNCOMPRESSED_<wbr>PUBKEY_<wbr>LENGTH_<wbr>BYTES</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable">
|
|
<a href="globals.html#url_pattern" class="tsd-kind-icon">URL_<wbr>PATTERN</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable">
|
|
<a href="globals.html#usage" class="tsd-kind-icon">USAGE</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable">
|
|
<a href="globals.html#version" class="tsd-kind-icon">VERSION</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable">
|
|
<a href="globals.html#zonefile_hash_pattern" class="tsd-kind-icon">ZONEFILE_<wbr>HASH_<wbr>PATTERN</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable">
|
|
<a href="globals.html#zonefile" class="tsd-kind-icon">Zone<wbr>File</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable">
|
|
<a href="globals.html#authtransitnonce" class="tsd-kind-icon">auth<wbr>Transit<wbr>Nonce</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable">
|
|
<a href="globals.html#c32check" class="tsd-kind-icon">c32check</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable">
|
|
<a href="globals.html#ecurve" class="tsd-kind-icon">ecurve</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable">
|
|
<a href="globals.html#enumcheckfunctions" class="tsd-kind-icon">enum<wbr>Check<wbr>Functions</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable">
|
|
<a href="globals.html#estimateonly" class="tsd-kind-icon">estimate<wbr>Only</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable">
|
|
<a href="globals.html#global" class="tsd-kind-icon">global</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable">
|
|
<a href="globals.html#graceperiod" class="tsd-kind-icon">grace<wbr>Period</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable">
|
|
<a href="globals.html#inttolevel" class="tsd-kind-icon">int<wbr>ToLevel</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable">
|
|
<a href="globals.html#leveltoint" class="tsd-kind-icon">level<wbr>ToInt</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable">
|
|
<a href="globals.html#levels" class="tsd-kind-icon">levels</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable">
|
|
<a href="globals.html#localstorageram" class="tsd-kind-icon">local<wbr>StorageRAM</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable">
|
|
<a href="globals.html#maxidsearchindex" class="tsd-kind-icon">maxIDSearch<wbr>Index</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable">
|
|
<a href="globals.html#networkderivationpath" class="tsd-kind-icon">network<wbr>Derivation<wbr>Path</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable">
|
|
<a href="globals.html#noexit" class="tsd-kind-icon">no<wbr>Exit</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable">
|
|
<a href="globals.html#receivefeesperiod" class="tsd-kind-icon">receive<wbr>Fees<wbr>Period</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable">
|
|
<a href="globals.html#safetychecks" class="tsd-kind-icon">safety<wbr>Checks</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable">
|
|
<a href="globals.html#txonly" class="tsd-kind-icon">tx<wbr>Only</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#climain" class="tsd-kind-icon">CLIMain</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#clioptasbool" class="tsd-kind-icon">CLIOpt<wbr>AsBool</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#clioptasstring" class="tsd-kind-icon">CLIOpt<wbr>AsString</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#clioptasstringarray" class="tsd-kind-icon">CLIOpt<wbr>AsString<wbr>Array</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#jsonstringify" class="tsd-kind-icon">JSONStringify</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#abifunctiontostring" class="tsd-kind-icon">abi<wbr>Function<wbr>ToString</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#addressconvert" class="tsd-kind-icon">address<wbr>Convert</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#addressfromhashmode" class="tsd-kind-icon">address<wbr>From<wbr>Hash<wbr>Mode</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#addressfrompublickeys" class="tsd-kind-icon">address<wbr>From<wbr>Public<wbr>Keys</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#addressfromversionhash" class="tsd-kind-icon">address<wbr>From<wbr>Version<wbr>Hash</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#addresshashmodetoversion" class="tsd-kind-icon">address<wbr>Hash<wbr>Mode<wbr>ToVersion</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#addresstostring" class="tsd-kind-icon">address<wbr>ToString</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#answertoclarityvalue" class="tsd-kind-icon">answer<wbr>ToClarity<wbr>Value</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#argtoprompt" class="tsd-kind-icon">arg<wbr>ToPrompt</a>
|
|
</li>
|
|
<li class=" tsd-kind-function tsd-has-type-parameter">
|
|
<a href="globals.html#assertistruthy" class="tsd-kind-icon">assert<wbr>IsTruthy</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#authdaemon" class="tsd-kind-icon">auth<wbr>Daemon</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#balance" class="tsd-kind-icon">balance</a>
|
|
</li>
|
|
<li class=" tsd-kind-function tsd-has-type-parameter">
|
|
<a href="globals.html#batchify" class="tsd-kind-icon">batchify</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#broadcastrawtransaction" class="tsd-kind-icon">broadcast<wbr>Raw<wbr>Transaction</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#broadcasttransaction" class="tsd-kind-icon">broadcast<wbr>Transaction</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#broadcasttransactionandzonefile" class="tsd-kind-icon">broadcast<wbr>Transaction<wbr>And<wbr>Zone<wbr>File</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#buffercv" class="tsd-kind-icon">bufferCV</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#buffercvfromstring" class="tsd-kind-icon">bufferCVFrom<wbr>String</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#bufferwithtypeid" class="tsd-kind-icon">buffer<wbr>With<wbr>TypeID</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#callreadonlyfunction" class="tsd-kind-icon">call<wbr>Read<wbr>Only<wbr>Function</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#canstack" class="tsd-kind-icon">can<wbr>Stack</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#canonicalprivatekey" class="tsd-kind-icon">canonical<wbr>Private<wbr>Key</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#checkargs" class="tsd-kind-icon">check<wbr>Args</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#checkurl" class="tsd-kind-icon">check<wbr>Url</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#clearcondition" class="tsd-kind-icon">clear<wbr>Condition</a>
|
|
</li>
|
|
<li class=" tsd-kind-function tsd-has-type-parameter">
|
|
<a href="globals.html#clonedeep" class="tsd-kind-icon">clone<wbr>Deep</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#codebodystring" class="tsd-kind-icon">code<wbr>Body<wbr>String</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#connecttogaiahubwithconfig" class="tsd-kind-icon">connect<wbr>ToGaia<wbr>Hub<wbr>With<wbr>Config</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#containslegalcharacters" class="tsd-kind-icon">contains<wbr>Legal<wbr>Characters</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#contractdeploy" class="tsd-kind-icon">contract<wbr>Deploy</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#contractfunctioncall" class="tsd-kind-icon">contract<wbr>Function<wbr>Call</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#contractprincipalcv" class="tsd-kind-icon">contract<wbr>PrincipalCV</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#contractprincipalcvfromaddress" class="tsd-kind-icon">contract<wbr>PrincipalCVFrom<wbr>Address</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#contractprincipalcvfromstandard" class="tsd-kind-icon">contract<wbr>PrincipalCVFrom<wbr>Standard</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#createaddress" class="tsd-kind-icon">create<wbr>Address</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#createassetinfo" class="tsd-kind-icon">create<wbr>Asset<wbr>Info</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#createcipher" class="tsd-kind-icon">create<wbr>Cipher</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#createcoinbasepayload" class="tsd-kind-icon">create<wbr>Coinbase<wbr>Payload</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#createcontractcallpayload" class="tsd-kind-icon">create<wbr>Contract<wbr>Call<wbr>Payload</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#createcontractprincipal" class="tsd-kind-icon">create<wbr>Contract<wbr>Principal</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#createemptyaddress" class="tsd-kind-icon">create<wbr>Empty<wbr>Address</a>
|
|
</li>
|
|
<li class=" tsd-kind-function tsd-has-type-parameter">
|
|
<a href="globals.html#createenumchecker" class="tsd-kind-icon">create<wbr>Enum<wbr>Checker</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#createfungiblepostcondition" class="tsd-kind-icon">create<wbr>Fungible<wbr>Post<wbr>Condition</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#createhashripemd160" class="tsd-kind-icon">create<wbr>Hash<wbr>Ripemd160</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#createhmacsha256" class="tsd-kind-icon">create<wbr>Hmac<wbr>Sha256</a>
|
|
</li>
|
|
<li class=" tsd-kind-function tsd-has-type-parameter">
|
|
<a href="globals.html#createlplist" class="tsd-kind-icon">createLPList</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#createlpstring" class="tsd-kind-icon">createLPString</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#creatememostring" class="tsd-kind-icon">create<wbr>Memo<wbr>String</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#createmessagesignature" class="tsd-kind-icon">create<wbr>Message<wbr>Signature</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#createmultisigspendingcondition" class="tsd-kind-icon">create<wbr>Multi<wbr>Sig<wbr>Spending<wbr>Condition</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#createnonfungiblepostcondition" class="tsd-kind-icon">create<wbr>Non<wbr>Fungible<wbr>Post<wbr>Condition</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#createpbkdf2" class="tsd-kind-icon">create<wbr>Pbkdf2</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#createpoisonpayload" class="tsd-kind-icon">create<wbr>Poison<wbr>Payload</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#createstxpostcondition" class="tsd-kind-icon">createSTXPost<wbr>Condition</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#createsha2hash" class="tsd-kind-icon">create<wbr>Sha2<wbr>Hash</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#createsinglesigspendingcondition" class="tsd-kind-icon">create<wbr>Single<wbr>Sig<wbr>Spending<wbr>Condition</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#createsmartcontractpayload" class="tsd-kind-icon">create<wbr>Smart<wbr>Contract<wbr>Payload</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#createstacksprivatekey" class="tsd-kind-icon">create<wbr>Stacks<wbr>Private<wbr>Key</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#createstackspublickey" class="tsd-kind-icon">create<wbr>Stacks<wbr>Public<wbr>Key</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#createstandardprincipal" class="tsd-kind-icon">create<wbr>Standard<wbr>Principal</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#createtokentransferpayload" class="tsd-kind-icon">create<wbr>Token<wbr>Transfer<wbr>Payload</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#createtransactionauthfield" class="tsd-kind-icon">create<wbr>Transaction<wbr>Auth<wbr>Field</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#cvtohex" class="tsd-kind-icon">cv<wbr>ToHex</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#cvtojson" class="tsd-kind-icon">cv<wbr>ToJSON</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#cvtostring" class="tsd-kind-icon">cv<wbr>ToString</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#cvtovalue" class="tsd-kind-icon">cv<wbr>ToValue</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#decodebtcaddress" class="tsd-kind-icon">decode<wbr>Btc<wbr>Address</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#decodeprivatekey" class="tsd-kind-icon">decode<wbr>Private<wbr>Key</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#decrypt" class="tsd-kind-icon">decrypt</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#decryptbackupphrase" class="tsd-kind-icon">decrypt<wbr>Backup<wbr>Phrase</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#decryptcontent" class="tsd-kind-icon">decrypt<wbr>Content</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#deletefromgaiahub" class="tsd-kind-icon">delete<wbr>From<wbr>Gaia<wbr>Hub</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#deriveidentitykeypair" class="tsd-kind-icon">derive<wbr>Identity<wbr>Key<wbr>Pair</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#deriverootkeychainfrommnemonic" class="tsd-kind-icon">derive<wbr>Root<wbr>Keychain<wbr>From<wbr>Mnemonic</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#derivestxaddresschain" class="tsd-kind-icon">derive<wbr>Stx<wbr>Address<wbr>Chain</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#deserializeaddress" class="tsd-kind-icon">deserialize<wbr>Address</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#deserializeassetinfo" class="tsd-kind-icon">deserialize<wbr>Asset<wbr>Info</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#deserializecv" class="tsd-kind-icon">deserializeCV</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#deserializelplist" class="tsd-kind-icon">deserializeLPList</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#deserializelpstring" class="tsd-kind-icon">deserializeLPString</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#deserializememostring" class="tsd-kind-icon">deserialize<wbr>Memo<wbr>String</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#deserializemessagesignature" class="tsd-kind-icon">deserialize<wbr>Message<wbr>Signature</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#deserializemultisigspendingcondition" class="tsd-kind-icon">deserialize<wbr>Multi<wbr>Sig<wbr>Spending<wbr>Condition</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#deserializepayload" class="tsd-kind-icon">deserialize<wbr>Payload</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#deserializepostcondition" class="tsd-kind-icon">deserialize<wbr>Post<wbr>Condition</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#deserializeprincipal" class="tsd-kind-icon">deserialize<wbr>Principal</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#deserializepublickey" class="tsd-kind-icon">deserialize<wbr>Public<wbr>Key</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#deserializesinglesigspendingcondition" class="tsd-kind-icon">deserialize<wbr>Single<wbr>Sig<wbr>Spending<wbr>Condition</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#deserializespendingcondition" class="tsd-kind-icon">deserialize<wbr>Spending<wbr>Condition</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#deserializestacksmessage" class="tsd-kind-icon">deserialize<wbr>Stacks<wbr>Message</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#deserializetransaction" class="tsd-kind-icon">deserialize<wbr>Transaction</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#deserializetransactionauthfield" class="tsd-kind-icon">deserialize<wbr>Transaction<wbr>Auth<wbr>Field</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#emptymessagesignature" class="tsd-kind-icon">empty<wbr>Message<wbr>Signature</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#encodeclarityvalue" class="tsd-kind-icon">encode<wbr>Clarity<wbr>Value</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#encrypt" class="tsd-kind-icon">encrypt</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#encryptbackupphrase" class="tsd-kind-icon">encrypt<wbr>Backup<wbr>Phrase</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#encryptcontent" class="tsd-kind-icon">encrypt<wbr>Content</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#encryptmnemonicformatted" class="tsd-kind-icon">encrypt<wbr>Mnemonic<wbr>Formatted</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#estimatecontractdeploy" class="tsd-kind-icon">estimate<wbr>Contract<wbr>Deploy</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#estimatecontractfunctioncall" class="tsd-kind-icon">estimate<wbr>Contract<wbr>Function<wbr>Call</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#estimatetransfer" class="tsd-kind-icon">estimate<wbr>Transfer</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#exceedsmaxlengthbytes" class="tsd-kind-icon">exceeds<wbr>Max<wbr>Length<wbr>Bytes</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#extractappkey" class="tsd-kind-icon">extract<wbr>App<wbr>Key</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#extractprofile" class="tsd-kind-icon">extract<wbr>Profile</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#falsecv" class="tsd-kind-icon">falseCV</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#faucetcall" class="tsd-kind-icon">faucet<wbr>Call</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#fetchprofile" class="tsd-kind-icon">fetch<wbr>Profile</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#findidentityindex" class="tsd-kind-icon">find<wbr>Identity<wbr>Index</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#formatcommandhelplines" class="tsd-kind-icon">format<wbr>Command<wbr>Help<wbr>Lines</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#formathelpstring" class="tsd-kind-icon">format<wbr>Help<wbr>String</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#gaiaauth" class="tsd-kind-icon">gaia<wbr>Auth</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#gaiaconnect" class="tsd-kind-icon">gaia<wbr>Connect</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#gaiadeletefile" class="tsd-kind-icon">gaia<wbr>Delete<wbr>File</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#gaiadumpbucket" class="tsd-kind-icon">gaia<wbr>Dump<wbr>Bucket</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#gaiafindprofilename" class="tsd-kind-icon">gaia<wbr>Find<wbr>Profile<wbr>Name</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#gaiagetfile" class="tsd-kind-icon">gaia<wbr>Get<wbr>File</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#gaialistfiles" class="tsd-kind-icon">gaia<wbr>List<wbr>Files</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#gaiaputfile" class="tsd-kind-icon">gaia<wbr>Put<wbr>File</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#gaiarestorebucket" class="tsd-kind-icon">gaia<wbr>Restore<wbr>Bucket</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#gaiasethub" class="tsd-kind-icon">gaia<wbr>Set<wbr>Hub</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#gaiauploadprofile" class="tsd-kind-icon">gaia<wbr>Upload<wbr>Profile</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#gaiauploadprofileall" class="tsd-kind-icon">gaia<wbr>Upload<wbr>Profile<wbr>All</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#generateencryptedmnemonicrootkeychain" class="tsd-kind-icon">generate<wbr>Encrypted<wbr>Mnemonic<wbr>Root<wbr>Keychain</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#generateexplorertxpageurl" class="tsd-kind-icon">generate<wbr>Explorer<wbr>TxPage<wbr>Url</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#generatemnemonicrootkeychain" class="tsd-kind-icon">generate<wbr>Mnemonic<wbr>Root<wbr>Keychain</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#getapiusageerrormessage" class="tsd-kind-icon">getAPIUsage<wbr>Error<wbr>Message</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#getabi" class="tsd-kind-icon">get<wbr>Abi</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#getaccounthistory" class="tsd-kind-icon">get<wbr>Account<wbr>History</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#getaddressfromprivatekey" class="tsd-kind-icon">get<wbr>Address<wbr>From<wbr>Private<wbr>Key</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#getaddressfrompublickey" class="tsd-kind-icon">get<wbr>Address<wbr>From<wbr>Public<wbr>Key</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#getaddresshashmode" class="tsd-kind-icon">get<wbr>Address<wbr>Hash<wbr>Mode</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#getappkeys" class="tsd-kind-icon">get<wbr>App<wbr>Keys</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#getappprivatekey" class="tsd-kind-icon">get<wbr>App<wbr>Private<wbr>Key</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#getapplicationkeyinfo" class="tsd-kind-icon">get<wbr>Application<wbr>Key<wbr>Info</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#getbtcaddress" class="tsd-kind-icon">getBTCAddress</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#getbackupphrase" class="tsd-kind-icon">get<wbr>Backup<wbr>Phrase</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#getbase64outputlength" class="tsd-kind-icon">get<wbr>Base64<wbr>Output<wbr>Length</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#getbitcoinaddressnode" class="tsd-kind-icon">get<wbr>Bitcoin<wbr>Address<wbr>Node</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#getbitcoinprivatekeychain" class="tsd-kind-icon">get<wbr>Bitcoin<wbr>Private<wbr>Keychain</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#getblockchainidentities" class="tsd-kind-icon">get<wbr>Blockchain<wbr>Identities</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#getblockstackerrorfromresponse" class="tsd-kind-icon">get<wbr>Blockstack<wbr>Error<wbr>From<wbr>Response</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#getcliopts" class="tsd-kind-icon">getCLIOpts</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#getcvtypestring" class="tsd-kind-icon">getCVType<wbr>String</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#getcommandargs" class="tsd-kind-icon">get<wbr>Command<wbr>Args</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#getcommandgroups" class="tsd-kind-icon">get<wbr>Command<wbr>Groups</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#getcryptolib" class="tsd-kind-icon">get<wbr>Crypto<wbr>Lib</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#getderivationpath" class="tsd-kind-icon">get<wbr>Derivation<wbr>Path</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#geterrorstring" class="tsd-kind-icon">get<wbr>Error<wbr>String</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#getgaiaaddressfromprofile" class="tsd-kind-icon">get<wbr>Gaia<wbr>Address<wbr>From<wbr>Profile</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#getgaiaaddressfromurl" class="tsd-kind-icon">get<wbr>Gaia<wbr>Address<wbr>FromURL</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#getgaiaerrorresponse" class="tsd-kind-icon">get<wbr>Gaia<wbr>Error<wbr>Response</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#gethubinfo" class="tsd-kind-icon">get<wbr>Hub<wbr>Info</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#gethubprefix" class="tsd-kind-icon">get<wbr>Hub<wbr>Prefix</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#getidaddress" class="tsd-kind-icon">getIDAddress</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#getidappkeys" class="tsd-kind-icon">getIDApp<wbr>Keys</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#getidentityinfo" class="tsd-kind-icon">get<wbr>Identity<wbr>Info</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#getidentityowneraddressnode" class="tsd-kind-icon">get<wbr>Identity<wbr>Owner<wbr>Address<wbr>Node</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#getidentityprivatekeychain" class="tsd-kind-icon">get<wbr>Identity<wbr>Private<wbr>Keychain</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#getkeyaddress" class="tsd-kind-icon">get<wbr>Key<wbr>Address</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#getmaxidsearchindex" class="tsd-kind-icon">get<wbr>MaxIDSearch<wbr>Index</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#getname" class="tsd-kind-icon">get<wbr>Name</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#getnameinfoeasy" class="tsd-kind-icon">get<wbr>Name<wbr>Info<wbr>Easy</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#getnetwork" class="tsd-kind-icon">get<wbr>Network</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#getnodeprivatekey" class="tsd-kind-icon">get<wbr>Node<wbr>Private<wbr>Key</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#getnonce" class="tsd-kind-icon">get<wbr>Nonce</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#getownerkeyfromidaddress" class="tsd-kind-icon">get<wbr>Owner<wbr>Key<wbr>FromIDAddress</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#getownerkeyinfo" class="tsd-kind-icon">get<wbr>Owner<wbr>Key<wbr>Info</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#getownerkeys" class="tsd-kind-icon">get<wbr>Owner<wbr>Keys</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#getpaymentkey" class="tsd-kind-icon">get<wbr>Payment<wbr>Key</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#getpaymentkeyinfo" class="tsd-kind-icon">get<wbr>Payment<wbr>Key<wbr>Info</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#getprivatekeyaddress" class="tsd-kind-icon">get<wbr>Private<wbr>Key<wbr>Address</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#getprofileurlfromzonefile" class="tsd-kind-icon">get<wbr>ProfileURLFrom<wbr>Zone<wbr>File</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#getpublickey" class="tsd-kind-icon">get<wbr>Public<wbr>Key</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#getpublickeyfromprivatekey" class="tsd-kind-icon">get<wbr>Public<wbr>Key<wbr>From<wbr>Private<wbr>Key</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#getquerystringparams" class="tsd-kind-icon">get<wbr>Query<wbr>String<wbr>Params</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#getsignaturerecoveryparam" class="tsd-kind-icon">get<wbr>Signature<wbr>Recovery<wbr>Param</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#getstackswalletkey" class="tsd-kind-icon">get<wbr>Stacks<wbr>Wallet<wbr>Key</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#getstackswalletkeyinfo" class="tsd-kind-icon">get<wbr>Stacks<wbr>Wallet<wbr>Key<wbr>Info</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#gettypestring" class="tsd-kind-icon">get<wbr>Type<wbr>String</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#gettypeunion" class="tsd-kind-icon">get<wbr>Type<wbr>Union</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#getpass" class="tsd-kind-icon">getpass</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#handleauth" class="tsd-kind-icon">handle<wbr>Auth</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#handlesignin" class="tsd-kind-icon">handle<wbr>Sign<wbr>In</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#haskeys" class="tsd-kind-icon">has<wbr>Keys</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#hash160" class="tsd-kind-icon">hash160</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#hashp2pkh" class="tsd-kind-icon">hash<wbr>P2PKH</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#hashp2sh" class="tsd-kind-icon">hash<wbr>P2SH</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#hashripemd160" class="tsd-kind-icon">hash<wbr>Ripemd160</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#hashsha256sync" class="tsd-kind-icon">hash<wbr>Sha256<wbr>Sync</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#hashsha512sync" class="tsd-kind-icon">hash<wbr>Sha512<wbr>Sync</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#hexstringtoint" class="tsd-kind-icon">hex<wbr>String<wbr>ToInt</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#hextocv" class="tsd-kind-icon">hex<wbr>ToCV</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#intcv" class="tsd-kind-icon">intCV</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#inttohexstring" class="tsd-kind-icon">int<wbr>ToHex<wbr>String</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#isclitransactionsigner" class="tsd-kind-icon">isCLITransaction<wbr>Signer</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#isclarityabibuffer" class="tsd-kind-icon">is<wbr>Clarity<wbr>Abi<wbr>Buffer</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#isclarityabilist" class="tsd-kind-icon">is<wbr>Clarity<wbr>Abi<wbr>List</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#isclarityabioptional" class="tsd-kind-icon">is<wbr>Clarity<wbr>Abi<wbr>Optional</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#isclarityabiprimitive" class="tsd-kind-icon">is<wbr>Clarity<wbr>Abi<wbr>Primitive</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#isclarityabiresponse" class="tsd-kind-icon">is<wbr>Clarity<wbr>Abi<wbr>Response</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#isclarityabistringascii" class="tsd-kind-icon">is<wbr>Clarity<wbr>Abi<wbr>String<wbr>Ascii</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#isclarityabistringutf8" class="tsd-kind-icon">is<wbr>Clarity<wbr>Abi<wbr>String<wbr>Utf8</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#isclarityabituple" class="tsd-kind-icon">is<wbr>Clarity<wbr>Abi<wbr>Tuple</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#isclarityname" class="tsd-kind-icon">is<wbr>Clarity<wbr>Name</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#iscompressed" class="tsd-kind-icon">is<wbr>Compressed</a>
|
|
</li>
|
|
<li class=" tsd-kind-function tsd-has-type-parameter">
|
|
<a href="globals.html#isenum" class="tsd-kind-icon">is<wbr>Enum</a>
|
|
</li>
|
|
<li class=" tsd-kind-function tsd-has-type-parameter">
|
|
<a href="globals.html#isnodecryptoavailable" class="tsd-kind-icon">is<wbr>Node<wbr>Crypto<wbr>Available</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#isrecoverablegaiaerror" class="tsd-kind-icon">is<wbr>Recoverable<wbr>Gaia<wbr>Error</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#issinglesig" class="tsd-kind-icon">is<wbr>Single<wbr>Sig</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#isstringarray" class="tsd-kind-icon">is<wbr>String<wbr>Array</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#issubdomain" class="tsd-kind-icon">is<wbr>Subdomain</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#issubtlecryptoavailable" class="tsd-kind-icon">is<wbr>Subtle<wbr>Crypto<wbr>Available</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#leftpadhex" class="tsd-kind-icon">left<wbr>Pad<wbr>Hex</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#leftpadhextolength" class="tsd-kind-icon">left<wbr>Pad<wbr>Hex<wbr>ToLength</a>
|
|
</li>
|
|
<li class=" tsd-kind-function tsd-has-type-parameter">
|
|
<a href="globals.html#listcv" class="tsd-kind-icon">listCV</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#loadconfig" class="tsd-kind-icon">load<wbr>Config</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#loadnamedidentities" class="tsd-kind-icon">load<wbr>Named<wbr>Identities</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#loadnamedidentitiesloop" class="tsd-kind-icon">load<wbr>Named<wbr>Identities<wbr>Loop</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#loadunnamedidentity" class="tsd-kind-icon">load<wbr>Unnamed<wbr>Identity</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#lookupprofile" class="tsd-kind-icon">lookup<wbr>Profile</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#makeallcommandshelp" class="tsd-kind-icon">make<wbr>All<wbr>Commands<wbr>Help</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#makeallcommandslist" class="tsd-kind-icon">make<wbr>All<wbr>Commands<wbr>List</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#makeassociationtoken" class="tsd-kind-icon">make<wbr>Association<wbr>Token</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#makeauthpage" class="tsd-kind-icon">make<wbr>Auth<wbr>Page</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#makeauthrequest" class="tsd-kind-icon">make<wbr>Auth<wbr>Request</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#makecommandusagestring" class="tsd-kind-icon">make<wbr>Command<wbr>Usage<wbr>String</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#makecontractcall" class="tsd-kind-icon">make<wbr>Contract<wbr>Call</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#makecontractdeploy" class="tsd-kind-icon">make<wbr>Contract<wbr>Deploy</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#makecontractfungiblepostcondition" class="tsd-kind-icon">make<wbr>Contract<wbr>Fungible<wbr>Post<wbr>Condition</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#makecontractnonfungiblepostcondition" class="tsd-kind-icon">make<wbr>Contract<wbr>Non<wbr>Fungible<wbr>Post<wbr>Condition</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#makecontractstxpostcondition" class="tsd-kind-icon">make<wbr>ContractSTXPost<wbr>Condition</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#makedidconfiguration" class="tsd-kind-icon">makeDIDConfiguration</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#makefakeauthresponsetoken" class="tsd-kind-icon">make<wbr>Fake<wbr>Auth<wbr>Response<wbr>Token</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#makegaiaassociationtoken" class="tsd-kind-icon">make<wbr>Gaia<wbr>Association<wbr>Token</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#makegaiaauthtoken" class="tsd-kind-icon">make<wbr>Gaia<wbr>Auth<wbr>Token</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#makeidentity" class="tsd-kind-icon">make<wbr>Identity</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#makekeychain" class="tsd-kind-icon">make<wbr>Keychain</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#makeprofilejwt" class="tsd-kind-icon">make<wbr>ProfileJWT</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#makepromptsfromarglist" class="tsd-kind-icon">make<wbr>Prompts<wbr>From<wbr>Arg<wbr>List</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#makerandomprivkey" class="tsd-kind-icon">make<wbr>Random<wbr>Priv<wbr>Key</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#makereadonlygaiaconfig" class="tsd-kind-icon">make<wbr>Read<wbr>Only<wbr>Gaia<wbr>Config</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#makestxtokentransfer" class="tsd-kind-icon">makeSTXToken<wbr>Transfer</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#makesighashpostsign" class="tsd-kind-icon">make<wbr>Sig<wbr>Hash<wbr>Post<wbr>Sign</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#makesighashpresign" class="tsd-kind-icon">make<wbr>Sig<wbr>Hash<wbr>Pre<wbr>Sign</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#makesigninlink" class="tsd-kind-icon">make<wbr>Sign<wbr>InLink</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#makestandardfungiblepostcondition" class="tsd-kind-icon">make<wbr>Standard<wbr>Fungible<wbr>Post<wbr>Condition</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#makestandardnonfungiblepostcondition" class="tsd-kind-icon">make<wbr>Standard<wbr>Non<wbr>Fungible<wbr>Post<wbr>Condition</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#makestandardstxpostcondition" class="tsd-kind-icon">make<wbr>StandardSTXPost<wbr>Condition</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#makeunsignedcontractcall" class="tsd-kind-icon">make<wbr>Unsigned<wbr>Contract<wbr>Call</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#makeunsignedstxtokentransfer" class="tsd-kind-icon">make<wbr>UnsignedSTXToken<wbr>Transfer</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#makeusagestring" class="tsd-kind-icon">make<wbr>Usage<wbr>String</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#makezonefilefromgaiaurl" class="tsd-kind-icon">make<wbr>Zone<wbr>File<wbr>From<wbr>Gaia<wbr>Url</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#matchtype" class="tsd-kind-icon">match<wbr>Type</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#mkdirs" class="tsd-kind-icon">mkdirs</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#namelookup" class="tsd-kind-icon">name<wbr>Lookup</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#newinitialsighash" class="tsd-kind-icon">new<wbr>Initial<wbr>Sig<wbr>Hash</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#nextsignature" class="tsd-kind-icon">next<wbr>Signature</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#nextverification" class="tsd-kind-icon">next<wbr>Verification</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#nonecv" class="tsd-kind-icon">noneCV</a>
|
|
</li>
|
|
<li class=" tsd-kind-function tsd-has-type-parameter">
|
|
<a href="globals.html#omit" class="tsd-kind-icon">omit</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#optionalcvof" class="tsd-kind-icon">optionalCVOf</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#parseassetinfostring" class="tsd-kind-icon">parse<wbr>Asset<wbr>Info<wbr>String</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#parseclarityfunctionarganswers" class="tsd-kind-icon">parse<wbr>Clarity<wbr>Function<wbr>Arg<wbr>Answers</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#parsemultisigkeys" class="tsd-kind-icon">parse<wbr>Multi<wbr>Sig<wbr>Keys</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#parsenullsigner" class="tsd-kind-icon">parse<wbr>Null<wbr>Signer</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#parseprincipalstring" class="tsd-kind-icon">parse<wbr>Principal<wbr>String</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#parsereadonlyresponse" class="tsd-kind-icon">parse<wbr>Read<wbr>Only<wbr>Response</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#parserecoverablesignature" class="tsd-kind-icon">parse<wbr>Recoverable<wbr>Signature</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#parsesegwitp2shkeys" class="tsd-kind-icon">parse<wbr>Segwit<wbr>P2SHKeys</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#parsetocv" class="tsd-kind-icon">parse<wbr>ToCV</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#principalcv" class="tsd-kind-icon">principalCV</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#principaltostring" class="tsd-kind-icon">principal<wbr>ToString</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#printdocs" class="tsd-kind-icon">print<wbr>Docs</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#printusage" class="tsd-kind-icon">print<wbr>Usage</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#privatekeytostring" class="tsd-kind-icon">private<wbr>Key<wbr>ToString</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#profilesign" class="tsd-kind-icon">profile<wbr>Sign</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#profilestore" class="tsd-kind-icon">profile<wbr>Store</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#profileverify" class="tsd-kind-icon">profile<wbr>Verify</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#pubkeyfromprivkey" class="tsd-kind-icon">pub<wbr>Keyfrom<wbr>Priv<wbr>Key</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#publickeyfrombuffer" class="tsd-kind-icon">public<wbr>Key<wbr>From<wbr>Buffer</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#publickeyfromsignature" class="tsd-kind-icon">public<wbr>Key<wbr>From<wbr>Signature</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#publickeytostring" class="tsd-kind-icon">public<wbr>Key<wbr>ToString</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#readonlycontractfunctioncall" class="tsd-kind-icon">read<wbr>Only<wbr>Contract<wbr>Function<wbr>Call</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#recursiverestoreidentities" class="tsd-kind-icon">recursive<wbr>Restore<wbr>Identities</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#registersubdomain" class="tsd-kind-icon">register<wbr>Subdomain</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#responseerrorcv" class="tsd-kind-icon">response<wbr>ErrorCV</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#responseokcv" class="tsd-kind-icon">response<wbr>OkCV</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#rightpadhextolength" class="tsd-kind-icon">right<wbr>Pad<wbr>Hex<wbr>ToLength</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#sendjson" class="tsd-kind-icon">sendJSON</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#sendtokens" class="tsd-kind-icon">send<wbr>Tokens</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#sendusernametoregistrar" class="tsd-kind-icon">send<wbr>Username<wbr>ToRegistrar</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#serializeaddress" class="tsd-kind-icon">serialize<wbr>Address</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#serializeassetinfo" class="tsd-kind-icon">serialize<wbr>Asset<wbr>Info</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#serializeboolcv" class="tsd-kind-icon">serialize<wbr>BoolCV</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#serializebuffercv" class="tsd-kind-icon">serialize<wbr>BufferCV</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#serializecv" class="tsd-kind-icon">serializeCV</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#serializecontractprincipalcv" class="tsd-kind-icon">serialize<wbr>Contract<wbr>PrincipalCV</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#serializeintcv" class="tsd-kind-icon">serialize<wbr>IntCV</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#serializelplist" class="tsd-kind-icon">serializeLPList</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#serializelpstring" class="tsd-kind-icon">serializeLPString</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#serializelistcv" class="tsd-kind-icon">serialize<wbr>ListCV</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#serializememostring" class="tsd-kind-icon">serialize<wbr>Memo<wbr>String</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#serializemessagesignature" class="tsd-kind-icon">serialize<wbr>Message<wbr>Signature</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#serializemultisigspendingcondition" class="tsd-kind-icon">serialize<wbr>Multi<wbr>Sig<wbr>Spending<wbr>Condition</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#serializeoptionalcv" class="tsd-kind-icon">serialize<wbr>OptionalCV</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#serializepayload" class="tsd-kind-icon">serialize<wbr>Payload</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#serializepostcondition" class="tsd-kind-icon">serialize<wbr>Post<wbr>Condition</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#serializeprincipal" class="tsd-kind-icon">serialize<wbr>Principal</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#serializepublickey" class="tsd-kind-icon">serialize<wbr>Public<wbr>Key</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#serializeresponsecv" class="tsd-kind-icon">serialize<wbr>ResponseCV</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#serializesinglesigspendingcondition" class="tsd-kind-icon">serialize<wbr>Single<wbr>Sig<wbr>Spending<wbr>Condition</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#serializespendingcondition" class="tsd-kind-icon">serialize<wbr>Spending<wbr>Condition</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#serializestacksmessage" class="tsd-kind-icon">serialize<wbr>Stacks<wbr>Message</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#serializestandardprincipalcv" class="tsd-kind-icon">serialize<wbr>Standard<wbr>PrincipalCV</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#serializestringasciicv" class="tsd-kind-icon">serialize<wbr>String<wbr>AsciiCV</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#serializestringcv" class="tsd-kind-icon">serialize<wbr>StringCV</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#serializestringutf8cv" class="tsd-kind-icon">serialize<wbr>String<wbr>Utf8CV</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#serializetransactionauthfield" class="tsd-kind-icon">serialize<wbr>Transaction<wbr>Auth<wbr>Field</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#serializetuplecv" class="tsd-kind-icon">serialize<wbr>TupleCV</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#signanduploadprofile" class="tsd-kind-icon">sign<wbr>And<wbr>Upload<wbr>Profile</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#signprofileforupload" class="tsd-kind-icon">sign<wbr>Profile<wbr>For<wbr>Upload</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#signprofiletoken" class="tsd-kind-icon">sign<wbr>Profile<wbr>Token</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#signwithkey" class="tsd-kind-icon">sign<wbr>With<wbr>Key</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#somecv" class="tsd-kind-icon">someCV</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#sponsortransaction" class="tsd-kind-icon">sponsor<wbr>Transaction</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#stack" class="tsd-kind-icon">stack</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#stackingstatus" class="tsd-kind-icon">stacking<wbr>Status</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#standardprincipalcv" class="tsd-kind-icon">standard<wbr>PrincipalCV</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#standardprincipalcvfromaddress" class="tsd-kind-icon">standard<wbr>PrincipalCVFrom<wbr>Address</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#stringasciicv" class="tsd-kind-icon">string<wbr>AsciiCV</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#stringcv" class="tsd-kind-icon">stringCV</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#stringutf8cv" class="tsd-kind-icon">string<wbr>Utf8CV</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#sumutxos" class="tsd-kind-icon">sumUTXOs</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#truecv" class="tsd-kind-icon">trueCV</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#tuplecv" class="tsd-kind-icon">tupleCV</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#txidfromdata" class="tsd-kind-icon">txid<wbr>From<wbr>Data</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#uintcv" class="tsd-kind-icon">uintCV</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#updateprofileapisettings" class="tsd-kind-icon">update<wbr>ProfileAPISettings</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#updateprofileapps" class="tsd-kind-icon">update<wbr>Profile<wbr>Apps</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#uploadprofile" class="tsd-kind-icon">upload<wbr>Profile</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#validatecontractcall" class="tsd-kind-icon">validate<wbr>Contract<wbr>Call</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#validatestacksaddress" class="tsd-kind-icon">validate<wbr>Stacks<wbr>Address</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#validatesubdomain" class="tsd-kind-icon">validate<wbr>Subdomain</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#validatesubdomainavailability" class="tsd-kind-icon">validate<wbr>Subdomain<wbr>Availability</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#validatesubdomainformat" class="tsd-kind-icon">validate<wbr>Subdomain<wbr>Format</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#verify" class="tsd-kind-icon">verify</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#verifyprofiletoken" class="tsd-kind-icon">verify<wbr>Profile<wbr>Token</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#verifysinglesig" class="tsd-kind-icon">verify<wbr>Single<wbr>Sig</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#walletfrommnemonic" class="tsd-kind-icon">wallet<wbr>From<wbr>Mnemonic</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#wrapprofiletoken" class="tsd-kind-icon">wrap<wbr>Profile<wbr>Token</a>
|
|
</li>
|
|
<li class=" tsd-kind-object-literal">
|
|
<a href="globals.html#cli_args" class="tsd-kind-icon">CLI_<wbr>ARGS</a>
|
|
</li>
|
|
<li class=" tsd-kind-object-literal">
|
|
<a href="globals.html#commands" class="tsd-kind-icon">COMMANDS</a>
|
|
</li>
|
|
<li class=" tsd-kind-object-literal">
|
|
<a href="globals.html#config_defaults" class="tsd-kind-icon">CONFIG_<wbr>DEFAULTS</a>
|
|
</li>
|
|
<li class=" tsd-kind-object-literal">
|
|
<a href="globals.html#config_regtest_defaults" class="tsd-kind-icon">CONFIG_<wbr>REGTEST_<wbr>DEFAULTS</a>
|
|
</li>
|
|
<li class=" tsd-kind-object-literal">
|
|
<a href="globals.html#config_testnet_defaults" class="tsd-kind-icon">CONFIG_<wbr>TESTNET_<wbr>DEFAULTS</a>
|
|
</li>
|
|
<li class=" tsd-kind-object-literal">
|
|
<a href="globals.html#default_profile" class="tsd-kind-icon">DEFAULT_<wbr>PROFILE</a>
|
|
</li>
|
|
<li class=" tsd-kind-object-literal">
|
|
<a href="globals.html#log_config_defaults" class="tsd-kind-icon">LOG_<wbr>CONFIG_<wbr>DEFAULTS</a>
|
|
</li>
|
|
<li class=" tsd-kind-object-literal">
|
|
<a href="globals.html#derivationpaths" class="tsd-kind-icon">derivation<wbr>Paths</a>
|
|
</li>
|
|
<li class=" tsd-kind-object-literal">
|
|
<a href="globals.html#personschemadefinition" class="tsd-kind-icon">person<wbr>Schema<wbr>Definition</a>
|
|
</li>
|
|
<li class=" tsd-kind-object-literal">
|
|
<a href="globals.html#registrars" class="tsd-kind-icon">registrars</a>
|
|
</li>
|
|
<li class=" tsd-kind-object-literal">
|
|
<a href="globals.html#schemadefinition" class="tsd-kind-icon">schema<wbr>Definition</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-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
|
|
<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
|
|
</ul>
|
|
<ul class="tsd-legend">
|
|
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
|
|
</ul>
|
|
<ul class="tsd-legend">
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
|
|
</ul>
|
|
<ul class="tsd-legend">
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</footer>
|
|
<div class="container tsd-generator">
|
|
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
|
|
</div>
|
|
<div class="overlay"></div>
|
|
<script src="assets/js/main.js"></script>
|
|
</body>
|
|
</html> |