blockstack
Version:
The Blockstack Javascript library for authentication, identity, and storage.
634 lines • 420 kB
HTML
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>blockstack.js 21.1.1 Library Reference</title>
<meta name="description" content="">
<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.js" 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">blockstack.js 21.1.1 Library Reference</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-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> blockstack.js 21.1.1 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/authscope.html" class="tsd-kind-icon">Auth<wbr>Scope</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/blockstacknetwork.html" class="tsd-kind-icon">Blockstack<wbr>Network</a></li>
<li class="tsd-kind-class tsd-is-not-exported"><a href="classes/facebook.html" class="tsd-kind-icon">Facebook</a></li>
<li class="tsd-kind-class tsd-is-not-exported"><a href="classes/github.html" class="tsd-kind-icon">Github</a></li>
<li class="tsd-kind-class tsd-is-not-exported"><a href="classes/hackernews.html" class="tsd-kind-icon">Hacker<wbr>News</a></li>
<li class="tsd-kind-class tsd-is-not-exported"><a href="classes/instagram.html" class="tsd-kind-icon">Instagram</a></li>
<li class="tsd-kind-class tsd-is-not-exported"><a href="classes/linkedin.html" class="tsd-kind-icon">Linked<wbr>In</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 tsd-is-not-exported"><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/sessiondatastore.html" class="tsd-kind-icon">Session<wbr>Data<wbr>Store</a></li>
<li class="tsd-kind-class tsd-is-not-exported"><a href="classes/twitter.html" class="tsd-kind-icon">Twitter</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/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>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Interfaces</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-interface"><a href="interfaces/accountproofinfo.html" class="tsd-kind-icon">Account<wbr>Proof<wbr>Info</a></li>
<li class="tsd-kind-interface"><a href="interfaces/accounttokens.html" class="tsd-kind-icon">Account<wbr>Tokens</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/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/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 tsd-is-not-exported"><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/nodecryptolib.html" class="tsd-kind-icon">Node<wbr>Crypto<wbr>Lib</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/priceinfo.html" class="tsd-kind-icon">Price<wbr>Info</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/ripemd160digest.html" class="tsd-kind-icon">Ripemd160<wbr>Digest</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/transactioninfo.html" class="tsd-kind-icon">Transaction<wbr>Info</a></li>
<li class="tsd-kind-interface"><a href="interfaces/utxo.html" class="tsd-kind-icon">UTXO</a></li>
<li class="tsd-kind-interface tsd-is-not-exported"><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/webcryptolib.html" class="tsd-kind-icon">Web<wbr>Crypto<wbr>Lib</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Type aliases</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-type-alias tsd-is-not-exported"><a href="globals.html#amounttype" class="tsd-kind-icon">Amount<wbr>Type</a></li>
<li class="tsd-kind-type-alias tsd-is-not-exported"><a href="globals.html#amounttypev1" class="tsd-kind-icon">Amount<wbr>Type<wbr>V1</a></li>
<li class="tsd-kind-type-alias tsd-is-not-exported"><a href="globals.html#amounttypev2" class="tsd-kind-icon">Amount<wbr>Type<wbr>V2</a></li>
<li class="tsd-kind-type-alias tsd-is-not-exported"><a href="globals.html#authmetadata" class="tsd-kind-icon">Auth<wbr>Metadata</a></li>
<li class="tsd-kind-type-alias"><a href="globals.html#cheeriomoduletype" class="tsd-kind-icon">Cheerio<wbr>Module<wbr>Type</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 tsd-is-not-exported"><a href="globals.html#etagmap" class="tsd-kind-icon">Etag<wbr>Map</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 tsd-is-not-exported"><a href="globals.html#nodecryptocreatecipher" class="tsd-kind-icon">Node<wbr>Crypto<wbr>Create<wbr>Cipher</a></li>
<li class="tsd-kind-type-alias tsd-is-not-exported"><a href="globals.html#nodecryptocreatedecipher" class="tsd-kind-icon">Node<wbr>Crypto<wbr>Create<wbr>Decipher</a></li>
<li class="tsd-kind-type-alias tsd-is-not-exported"><a href="globals.html#nodecryptocreatehash" class="tsd-kind-icon">Node<wbr>Crypto<wbr>Create<wbr>Hash</a></li>
<li class="tsd-kind-type-alias tsd-is-not-exported"><a href="globals.html#nodecryptocreatehmac" class="tsd-kind-icon">Node<wbr>Crypto<wbr>Create<wbr>Hmac</a></li>
<li class="tsd-kind-type-alias tsd-is-not-exported"><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#pbkdf2digests" class="tsd-kind-icon">Pbkdf2<wbr>Digests</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 tsd-is-not-exported"><a href="globals.html#txpoint" class="tsd-kind-icon">tx<wbr>Point</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Variables</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-variable tsd-is-not-exported"><a href="globals.html#apps_node_index" class="tsd-kind-icon">APPS_<wbr>NODE_<wbr>INDEX</a></li>
<li class="tsd-kind-variable tsd-is-not-exported"><a href="globals.html#auth_continuation_param" class="tsd-kind-icon">AUTH_<wbr>CONTINUATION_<wbr>PARAM</a></li>
<li class="tsd-kind-variable tsd-is-not-exported"><a href="globals.html#bitcoin_account_index" class="tsd-kind-icon">BITCOIN_<wbr>ACCOUNT_<wbr>INDEX</a></li>
<li class="tsd-kind-variable tsd-is-not-exported"><a href="globals.html#bitcoin_bip_44_purpose" class="tsd-kind-icon">BITCOIN_<wbr>BIP_<wbr>44_<wbr>PURPOSE</a></li>
<li class="tsd-kind-variable tsd-is-not-exported"><a href="globals.html#bitcoin_coin_type" class="tsd-kind-icon">BITCOIN_<wbr>COIN_<wbr>TYPE</a></li>
<li class="tsd-kind-variable tsd-is-not-exported"><a href="globals.html#blockstack_on_bitcoin" class="tsd-kind-icon">BLOCKSTACK_<wbr>ON_<wbr>BITCOIN</a></li>
<li class="tsd-kind-variable tsd-is-not-exported"><a href="globals.html#change_address" class="tsd-kind-icon">CHANGE_<wbr>ADDRESS</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 tsd-is-not-exported"><a href="globals.html#echo_reply_param" class="tsd-kind-icon">ECHO_<wbr>REPLY_<wbr>PARAM</a></li>
<li class="tsd-kind-variable tsd-is-not-exported"><a href="globals.html#external_address" class="tsd-kind-icon">EXTERNAL_<wbr>ADDRESS</a></li>
<li class="tsd-kind-variable tsd-is-not-exported"><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 tsd-is-not-exported"><a href="globals.html#identity_keychain" class="tsd-kind-icon">IDENTITY_<wbr>KEYCHAIN</a></li>
<li class="tsd-kind-variable"><a href="globals.html#mainnet_default" class="tsd-kind-icon">MAINNET_<wbr>DEFAULT</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 tsd-is-not-exported"><a href="globals.html#satoshis_per_btc" class="tsd-kind-icon">SATOSHIS_<wbr>PER_<wbr>BTC</a></li>
<li class="tsd-kind-variable tsd-is-not-exported"><a href="globals.html#session_version" class="tsd-kind-icon">SESSION_<wbr>VERSION</a></li>
<li class="tsd-kind-variable tsd-is-not-exported"><a href="globals.html#signature_file_suffix" class="tsd-kind-icon">SIGNATURE_<wbr>FILE_<wbr>SUFFIX</a></li>
<li class="tsd-kind-variable tsd-is-not-exported"><a href="globals.html#tx_broadcast_service_registration_endpoint" class="tsd-kind-icon">TX_<wbr>BROADCAST_<wbr>SERVICE_<wbr>REGISTRATION_<wbr>ENDPOINT</a></li>
<li class="tsd-kind-variable tsd-is-not-exported"><a href="globals.html#tx_broadcast_service_tx_endpoint" class="tsd-kind-icon">TX_<wbr>BROADCAST_<wbr>SERVICE_<wbr>TX_<wbr>ENDPOINT</a></li>
<li class="tsd-kind-variable tsd-is-not-exported"><a href="globals.html#tx_broadcast_service_zone_file_endpoint" class="tsd-kind-icon">TX_<wbr>BROADCAST_<wbr>SERVICE_<wbr>ZONE_<wbr>FILE_<wbr>ENDPOINT</a></li>
<li class="tsd-kind-variable tsd-is-not-exported"><a href="globals.html#tx_empty_size" class="tsd-kind-icon">TX_<wbr>EMPTY_<wbr>SIZE</a></li>
<li class="tsd-kind-variable tsd-is-not-exported"><a href="globals.html#tx_input_base" class="tsd-kind-icon">TX_<wbr>INPUT_<wbr>BASE</a></li>
<li class="tsd-kind-variable tsd-is-not-exported"><a href="globals.html#tx_input_pubkeyhash" class="tsd-kind-icon">TX_<wbr>INPUT_<wbr>PUBKEYHASH</a></li>
<li class="tsd-kind-variable tsd-is-not-exported"><a href="globals.html#tx_output_base" class="tsd-kind-icon">TX_<wbr>OUTPUT_<wbr>BASE</a></li>
<li class="tsd-kind-variable tsd-is-not-exported"><a href="globals.html#tx_output_pubkeyhash" class="tsd-kind-icon">TX_<wbr>OUTPUT_<wbr>PUBKEYHASH</a></li>
<li class="tsd-kind-variable tsd-is-not-exported"><a href="globals.html#version" class="tsd-kind-icon">VERSION</a></li>
<li class="tsd-kind-variable tsd-is-not-exported"><a href="globals.html#dummyconsensushash" class="tsd-kind-icon">dummy<wbr>Consensus<wbr>Hash</a></li>
<li class="tsd-kind-variable tsd-is-not-exported"><a href="globals.html#dummyzonefilehash" class="tsd-kind-icon">dummy<wbr>Zonefile<wbr>Hash</a></li>
<li class="tsd-kind-variable tsd-is-not-exported"><a href="globals.html#ecurve" class="tsd-kind-icon">ecurve</a></li>
<li class="tsd-kind-variable tsd-is-not-exported"><a href="globals.html#inttolevel" class="tsd-kind-icon">int<wbr>ToLevel</a></li>
<li class="tsd-kind-variable tsd-is-not-exported"><a href="globals.html#leveltoint" class="tsd-kind-icon">level<wbr>ToInt</a></li>
<li class="tsd-kind-variable tsd-is-not-exported"><a href="globals.html#levels" class="tsd-kind-icon">levels</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#createcipher" class="tsd-kind-icon">create<wbr>Cipher</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"><a href="globals.html#createpbkdf2" class="tsd-kind-icon">create<wbr>Pbkdf2</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#decryptcontent" class="tsd-kind-icon">decrypt<wbr>Content</a></li>
<li class="tsd-kind-function"><a href="globals.html#deletefile" class="tsd-kind-icon">delete<wbr>File</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#encryptcontent" class="tsd-kind-icon">encrypt<wbr>Content</a></li>
<li class="tsd-kind-function tsd-is-private tsd-is-not-exported"><a href="globals.html#estimateannounce" class="tsd-kind-icon">estimate<wbr>Announce</a></li>
<li class="tsd-kind-function tsd-is-private tsd-is-not-exported"><a href="globals.html#estimatenameimport" class="tsd-kind-icon">estimate<wbr>Name<wbr>Import</a></li>
<li class="tsd-kind-function tsd-is-private tsd-is-not-exported"><a href="globals.html#estimatenamespacepreorder" class="tsd-kind-icon">estimate<wbr>Namespace<wbr>Preorder</a></li>
<li class="tsd-kind-function tsd-is-private tsd-is-not-exported"><a href="globals.html#estimatenamespaceready" class="tsd-kind-icon">estimate<wbr>Namespace<wbr>Ready</a></li>
<li class="tsd-kind-function tsd-is-private tsd-is-not-exported"><a href="globals.html#estimatenamespacereveal" class="tsd-kind-icon">estimate<wbr>Namespace<wbr>Reveal</a></li>
<li class="tsd-kind-function tsd-is-private tsd-is-not-exported"><a href="globals.html#estimatepreorder" class="tsd-kind-icon">estimate<wbr>Preorder</a></li>
<li class="tsd-kind-function tsd-is-private tsd-is-not-exported"><a href="globals.html#estimateregister" class="tsd-kind-icon">estimate<wbr>Register</a></li>
<li class="tsd-kind-function tsd-is-private tsd-is-not-exported"><a href="globals.html#estimaterenewal" class="tsd-kind-icon">estimate<wbr>Renewal</a></li>
<li class="tsd-kind-function tsd-is-private tsd-is-not-exported"><a href="globals.html#estimaterevoke" class="tsd-kind-icon">estimate<wbr>Revoke</a></li>
<li class="tsd-kind-function tsd-is-private tsd-is-not-exported"><a href="globals.html#estimatetokentransfer" class="tsd-kind-icon">estimate<wbr>Token<wbr>Transfer</a></li>
<li class="tsd-kind-function tsd-is-private tsd-is-not-exported"><a href="globals.html#estimatetransfer" class="tsd-kind-icon">estimate<wbr>Transfer</a></li>
<li class="tsd-kind-function tsd-is-private tsd-is-not-exported"><a href="globals.html#estimateupdate" class="tsd-kind-icon">estimate<wbr>Update</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 tsd-is-not-exported"><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#getappbucketurl" class="tsd-kind-icon">get<wbr>App<wbr>Bucket<wbr>Url</a></li>
<li class="tsd-kind-function"><a href="globals.html#getauthresponsetoken" class="tsd-kind-icon">get<wbr>Auth<wbr>Response<wbr>Token</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#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#getcryptolib" class="tsd-kind-icon">get<wbr>Crypto<wbr>Lib</a></li>
<li class="tsd-kind-function"><a href="globals.html#getfile" class="tsd-kind-icon">get<wbr>File</a></li>
<li class="tsd-kind-function tsd-is-not-exported"><a href="globals.html#getfilecontents" class="tsd-kind-icon">get<wbr>File<wbr>Contents</a></li>
<li class="tsd-kind-function tsd-is-not-exported"><a href="globals.html#getfilesignedunencrypted" class="tsd-kind-icon">get<wbr>File<wbr>Signed<wbr>Unencrypted</a></li>
<li class="tsd-kind-function"><a href="globals.html#getfileurl" class="tsd-kind-icon">get<wbr>File<wbr>Url</a></li>
<li class="tsd-kind-function tsd-is-not-exported"><a href="globals.html#getgaiaaddress" class="tsd-kind-icon">get<wbr>Gaia<wbr>Address</a></li>
<li class="tsd-kind-function tsd-is-not-exported"><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#getname" class="tsd-kind-icon">get<wbr>Name</a></li>
<li class="tsd-kind-function"><a href="globals.html#getnameinfo" class="tsd-kind-icon">get<wbr>Name<wbr>Info</a></li>
<li class="tsd-kind-function tsd-is-not-exported"><a href="globals.html#getquerystringparams" class="tsd-kind-icon">get<wbr>Query<wbr>String<wbr>Params</a></li>
<li class="tsd-kind-function tsd-is-not-exported"><a href="globals.html#gettransaction" class="tsd-kind-icon">get<wbr>Transaction</a></li>
<li class="tsd-kind-function"><a href="globals.html#getuserappfileurl" class="tsd-kind-icon">get<wbr>User<wbr>App<wbr>File<wbr>Url</a></li>
<li class="tsd-kind-function"><a href="globals.html#handlependingsignin" class="tsd-kind-icon">handle<wbr>Pending<wbr>Sign<wbr>In</a></li>
<li class="tsd-kind-function tsd-is-not-exported"><a href="globals.html#handlesignedencryptedcontents" class="tsd-kind-icon">handle<wbr>Signed<wbr>Encrypted<wbr>Contents</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 tsd-is-not-exported"><a href="globals.html#inputbytes" class="tsd-kind-icon">input<wbr>Bytes</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 tsd-is-not-exported"><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#issigninpending" class="tsd-kind-icon">is<wbr>Sign<wbr>InPending</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#launchcustomprotocol" class="tsd-kind-icon">launch<wbr>Custom<wbr>Protocol</a></li>
<li class="tsd-kind-function"><a href="globals.html#listfiles" class="tsd-kind-icon">list<wbr>Files</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 tsd-is-private tsd-is-not-exported"><a href="globals.html#makeannounce" class="tsd-kind-icon">make<wbr>Announce</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 tsd-is-private tsd-is-not-exported"><a href="globals.html#makebitcoinspend" class="tsd-kind-icon">make<wbr>Bitcoin<wbr>Spend</a></li>
<li class="tsd-kind-function tsd-is-private tsd-is-not-exported"><a href="globals.html#makenameimport" class="tsd-kind-icon">make<wbr>Name<wbr>Import</a></li>
<li class="tsd-kind-function tsd-is-private tsd-is-not-exported"><a href="globals.html#makenamespaceready" class="tsd-kind-icon">make<wbr>Namespace<wbr>Ready</a></li>
<li class="tsd-kind-function tsd-is-private tsd-is-not-exported"><a href="globals.html#makenamespacereveal" class="tsd-kind-icon">make<wbr>Namespace<wbr>Reveal</a></li>
<li class="tsd-kind-function tsd-is-private tsd-is-not-exported"><a href="globals.html#makepreorder" class="tsd-kind-icon">make<wbr>Preorder</a></li>
<li class="tsd-kind-function tsd-is-private tsd-is-not-exported"><a href="globals.html#makeregister" class="tsd-kind-icon">make<wbr>Register</a></li>
<li class="tsd-kind-function tsd-is-private tsd-is-not-exported"><a href="globals.html#makerenewal" class="tsd-kind-icon">make<wbr>Renewal</a></li>
<li class="tsd-kind-function tsd-is-private tsd-is-not-exported"><a href="globals.html#makerevoke" class="tsd-kind-icon">make<wbr>Revoke</a></li>
<li class="tsd-kind-function tsd-is-private tsd-is-not-exported"><a href="globals.html#maketokentransfer" class="tsd-kind-icon">make<wbr>Token<wbr>Transfer</a></li>
<li class="tsd-kind-function tsd-is-private tsd-is-not-exported"><a href="globals.html#maketransfer" class="tsd-kind-icon">make<wbr>Transfer</a></li>
<li class="tsd-kind-function tsd-is-private tsd-is-not-exported"><a href="globals.html#makeupdate" class="tsd-kind-icon">make<wbr>Update</a></li>
<li class="tsd-kind-function tsd-is-not-exported"><a href="globals.html#outputbytes" class="tsd-kind-icon">output<wbr>Bytes</a></li>
<li class="tsd-kind-function"><a href="globals.html#putfile" class="tsd-kind-icon">put<wbr>File</a></li>
<li class="tsd-kind-function"><a href="globals.html#redirecttosigninwithauthrequest" class="tsd-kind-icon">redirect<wbr>ToSign<wbr>InWith<wbr>Auth<wbr>Request</a></li>
<li class="tsd-kind-function"><a href="globals.html#signinputs" class="tsd-kind-icon">sign<wbr>Inputs</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#signuserout" class="tsd-kind-icon">sign<wbr>User<wbr>Out</a></li>
<li class="tsd-kind-function tsd-is-not-exported"><a href="globals.html#transactionbytes" class="tsd-kind-icon">transaction<wbr>Bytes</a></li>
<li class="tsd-kind-function"><a href="globals.html#validateproofs" class="tsd-kind-icon">validate<wbr>Proofs</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#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 tsd-is-not-exported"><a href="globals.html#default_profile" class="tsd-kind-icon">DEFAULT_<wbr>PROFILE</a></li>
<li class="tsd-kind-object-literal tsd-is-not-exported"><a href="globals.html#schemadefinition" class="tsd-kind-icon">schema<wbr>Definition</a></li>
<li class="tsd-kind-object-literal"><a href="globals.html#transactions" class="tsd-kind-icon">transactions</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Type aliases</h2>
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-is-not-exported">
<a name="amounttype" class="tsd-anchor"></a>
<h3>Amount<wbr>Type</h3>
<div class="tsd-signature tsd-kind-icon">Amount<wbr>Type<span class="tsd-signature-symbol">:</span> <a href="globals.html#amounttypev1" class="tsd-signature-type">AmountTypeV1</a><span class="tsd-signature-symbol"> | </span><a href="globals.html#amounttypev2" class="tsd-signature-type">AmountTypeV2</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/operations/skeletons.ts#L13">src/operations/skeletons.ts:13</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-is-not-exported">
<a name="amounttypev1" class="tsd-anchor"></a>
<h3>Amount<wbr>Type<wbr>V1</h3>
<div class="tsd-signature tsd-kind-icon">Amount<wbr>Type<wbr>V1<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/operations/skeletons.ts#L11">src/operations/skeletons.ts:11</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-is-not-exported">
<a name="amounttypev2" class="tsd-anchor"></a>
<h3>Amount<wbr>Type<wbr>V2</h3>
<div class="tsd-signature tsd-kind-icon">Amount<wbr>Type<wbr>V2<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/blockstack.js/blob/master/src/operations/skeletons.ts#L12">src/operations/skeletons.ts:12</a></li>
</ul>
</aside>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5>amount<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BN</span></h5>
</li>
<li class="tsd-parameter">
<h5>units<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
</li>
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-is-not-exported">
<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-type">object</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/auth/authMessages.ts#L16">src/auth/authMessages.ts:16</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">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">string</span></h5>
</li>
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-type-alias">
<a name="cheeriomoduletype" class="tsd-anchor"></a>
<h3>Cheerio<wbr>Module<wbr>Type</h3>
<div class="tsd-signature tsd-kind-icon">Cheerio<wbr>Module<wbr>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">CheerioAPI</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/services/service.ts#L5">src/profiles/services/service.ts:5</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/blockstack.js/blob/master/src/encryption/aesCipher.ts#L6">src/encryption/aesCipher.ts:6</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-is-not-exported">
<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-type">object</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/auth/sessionData.ts#L8">src/auth/sessionData.ts:8</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="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-type">function</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/encryption/cryptoRandom.ts#L6">src/encryption/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-siganture">
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-alias tsd-is-not-exported">
<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 tsd-is-not-exported">
<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/blockstack.js/blob/master/src/encryption/aesCipher.ts#L3">src/encryption/aesCipher.ts:3</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-is-not-exported">
<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/blockstack.js/blob/master/src/encryption/aesCipher.ts#L4">src/encryption/aesCipher.ts:4</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-is-not-exported">
<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/blockstack.js/blob/master/src/encryption/sha2Hash.ts#L4">src/encryption/sha2Hash.ts:4</a></li>
<li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/encryption/hashRipemd160.ts#L4">src/encryption/hashRipemd160.ts:4</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-is-not-exported">
<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/blockstack.js/blob/master/src/encryption/hmacSha256.ts#L7">src/encryption/hmacSha256.ts:7</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-is-not-exported">
<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/blockstack.js/blob/master/src/encryption/pbkdf2.ts#L14">src/encryption/pbkdf2.ts:14</a></li>
</ul>
</aside>
</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/blockstack.js/blob/master/src/encryption/pbkdf2.ts#L3">src/encryption/pbkdf2.ts:3</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-type">function</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/encryption/cryptoUtils.ts#L34">src/encryption/cryptoUtils.ts:34</a></li>
</ul>
</aside>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter-siganture">
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-alias tsd-is-not-exported">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>arg<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span>, cb<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">function</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-type">object</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-type">function</span></h5>
<ul class="tsd-parameters">
<li class="tsd-parameter-siganture">
<ul class="tsd-signatures tsd-kind-type-literal tsd-is-not-exported">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Error</span><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: <span class="tsd-signature-type">Error</span><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 tsd-is-not-exported">
<a name="txpoint" class="tsd-anchor"></a>
<h3>tx<wbr>Point</h3>
<div class="tsd-signature tsd-kind-icon">tx<wbr>Point<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/blockstack.js/blob/master/src/operations/utils.ts#L45">src/operations/utils.ts:45</a></li>
</ul>
</aside>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5>script<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</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>
<section class="tsd-panel-group tsd-member-group ">
<h2>Variables</h2>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-is-not-exported">
<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/blockstack.js/blob/master/src/wallet.ts#L9">src/wallet.ts:9</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-is-not-exported">
<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/blockstack.js/blob/master/src/auth/protocolEchoDetection.ts#L10">src/auth/protocolEchoDetection.ts:10</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-is-not-exported">
<a name="bitcoin_account_index" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagConst">Const</span> BITCOIN_<wbr>ACCOUNT_<wbr>INDEX</h3>
<div class="tsd-signature tsd-kind-icon">BITCOIN_<wbr>ACCOUNT_<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/blockstack.js/blob/master/src/wallet.ts#L15">src/wallet.ts:15</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-is-not-exported">
<a name="bitcoin_bip_44_purpose" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagConst">Const</span> BITCOIN_<wbr>BIP_<wbr>44_<wbr>PURPOSE</h3>
<div class="tsd-signature tsd-kind-icon">BITCOIN_<wbr>BIP_<wbr>44_<wbr>PURPOSE<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">44</span><span class="tsd-signature-symbol"> = 44</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/wallet.ts#L13">src/wallet.ts:13</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-is-not-exported">
<a name="bitcoin_coin_type" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagConst">Const</span> BITCOIN_<wbr>COIN_<wbr>TYPE</h3>
<div class="tsd-signature tsd-kind-icon">BITCOIN_<wbr>COIN_<wbr>TYPE<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/blockstack.js/blob/master/src/wallet.ts#L14">src/wallet.ts:14</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-is-not-exported">
<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/blockstack.js/blob/master/src/wallet.ts#L11">src/wallet.ts:11</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-is-not-exported">
<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/blockstack.js/bl