| 1 | <!doctype html>
|
| 2 | <html class="default no-js">
|
| 3 | <head>
|
| 4 | <meta charset="utf-8">
|
| 5 | <meta http-equiv="X-UA-Compatible" content="IE=edge">
|
| 6 | <title>blockstack</title>
|
| 7 | <meta name="description" content="">
|
| 8 | <meta name="viewport" content="width=device-width, initial-scale=1">
|
| 9 | <link rel="stylesheet" href="assets/css/main.css">
|
| 10 | </head>
|
| 11 | <body>
|
| 12 | <header>
|
| 13 | <div class="tsd-page-toolbar">
|
| 14 | <div class="container">
|
| 15 | <div class="table-wrap">
|
| 16 | <div class="table-cell" id="tsd-search" data-index="assets/js/search.js" data-base=".">
|
| 17 | <div class="field">
|
| 18 | <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
|
| 19 | <input id="tsd-search-field" type="text" />
|
| 20 | </div>
|
| 21 | <ul class="results">
|
| 22 | <li class="state loading">Preparing search index...</li>
|
| 23 | <li class="state failure">The search index is not available</li>
|
| 24 | </ul>
|
| 25 | <a href="index.html" class="title">blockstack</a>
|
| 26 | </div>
|
| 27 | <div class="table-cell" id="tsd-widgets">
|
| 28 | <div id="tsd-filter">
|
| 29 | <a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
|
| 30 | <div class="tsd-filter-group">
|
| 31 | <div class="tsd-select" id="tsd-filter-visibility">
|
| 32 | <span class="tsd-select-label">All</span>
|
| 33 | <ul class="tsd-select-list">
|
| 34 | <li data-value="public">Public</li>
|
| 35 | <li data-value="protected">Public/Protected</li>
|
| 36 | <li data-value="private" class="selected">All</li>
|
| 37 | </ul>
|
| 38 | </div>
|
| 39 | <input type="checkbox" id="tsd-filter-inherited" checked />
|
| 40 | <label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
|
| 41 | <input type="checkbox" id="tsd-filter-only-exported" />
|
| 42 | <label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
|
| 43 | </div>
|
| 44 | </div>
|
| 45 | <a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
|
| 46 | </div>
|
| 47 | </div>
|
| 48 | </div>
|
| 49 | </div>
|
| 50 | <div class="tsd-page-title">
|
| 51 | <div class="container">
|
| 52 | <ul class="tsd-breadcrumb">
|
| 53 | <li>
|
| 54 | <a href="globals.html">Globals</a>
|
| 55 | </li>
|
| 56 | </ul>
|
| 57 | <h1> blockstack</h1>
|
| 58 | </div>
|
| 59 | </div>
|
| 60 | </header>
|
| 61 | <div class="container container-main">
|
| 62 | <div class="row">
|
| 63 | <div class="col-8 col-content">
|
| 64 | <section class="tsd-panel-group tsd-index-group">
|
| 65 | <h2>Index</h2>
|
| 66 | <section class="tsd-panel tsd-index-panel">
|
| 67 | <div class="tsd-index-content">
|
| 68 | <section class="tsd-index-section ">
|
| 69 | <h3>Classes</h3>
|
| 70 | <ul class="tsd-index-list">
|
| 71 | <li class="tsd-kind-class"><a href="classes/appconfig.html" class="tsd-kind-icon">App<wbr>Config</a></li>
|
| 72 | <li class="tsd-kind-class"><a href="classes/bitcoinnetwork.html" class="tsd-kind-icon">Bitcoin<wbr>Network</a></li>
|
| 73 | <li class="tsd-kind-class"><a href="classes/bitcoindapi.html" class="tsd-kind-icon">BitcoindAPI</a></li>
|
| 74 | <li class="tsd-kind-class"><a href="classes/blockchaininfoapi.html" class="tsd-kind-icon">Blockchain<wbr>Info<wbr>Api</a></li>
|
| 75 | <li class="tsd-kind-class"><a href="classes/blockstackerror.html" class="tsd-kind-icon">Blockstack<wbr>Error</a></li>
|
| 76 | <li class="tsd-kind-class"><a href="classes/blockstacknamespace.html" class="tsd-kind-icon">Blockstack<wbr>Namespace</a></li>
|
| 77 | <li class="tsd-kind-class"><a href="classes/blockstacknetwork.html" class="tsd-kind-icon">Blockstack<wbr>Network</a></li>
|
| 78 | <li class="tsd-kind-class"><a href="classes/blockstackwallet.html" class="tsd-kind-icon">Blockstack<wbr>Wallet</a></li>
|
| 79 | <li class="tsd-kind-class"><a href="classes/creativework.html" class="tsd-kind-icon">Creative<wbr>Work</a></li>
|
| 80 | <li class="tsd-kind-class tsd-is-not-exported"><a href="classes/facebook.html" class="tsd-kind-icon">Facebook</a></li>
|
| 81 | <li class="tsd-kind-class tsd-is-not-exported"><a href="classes/github.html" class="tsd-kind-icon">Github</a></li>
|
| 82 | <li class="tsd-kind-class tsd-is-not-exported"><a href="classes/hackernews.html" class="tsd-kind-icon">Hacker<wbr>News</a></li>
|
| 83 | <li class="tsd-kind-class"><a href="classes/insightclient.html" class="tsd-kind-icon">Insight<wbr>Client</a></li>
|
| 84 | <li class="tsd-kind-class tsd-is-not-exported"><a href="classes/instagram.html" class="tsd-kind-icon">Instagram</a></li>
|
| 85 | <li class="tsd-kind-class"><a href="classes/instancedatastore.html" class="tsd-kind-icon">Instance<wbr>Data<wbr>Store</a></li>
|
| 86 | <li class="tsd-kind-class"><a href="classes/invalidamounterror.html" class="tsd-kind-icon">Invalid<wbr>Amount<wbr>Error</a></li>
|
| 87 | <li class="tsd-kind-class"><a href="classes/invaliddiderror.html" class="tsd-kind-icon">InvalidDIDError</a></li>
|
| 88 | <li class="tsd-kind-class"><a href="classes/invalidparametererror.html" class="tsd-kind-icon">Invalid<wbr>Parameter<wbr>Error</a></li>
|
| 89 | <li class="tsd-kind-class"><a href="classes/invalidstateerror.html" class="tsd-kind-icon">Invalid<wbr>State<wbr>Error</a></li>
|
| 90 | <li class="tsd-kind-class tsd-is-not-exported"><a href="classes/linkedin.html" class="tsd-kind-icon">Linked<wbr>In</a></li>
|
| 91 | <li class="tsd-kind-class"><a href="classes/localregtest.html" class="tsd-kind-icon">Local<wbr>Regtest</a></li>
|
| 92 | <li class="tsd-kind-class"><a href="classes/localstoragestore.html" class="tsd-kind-icon">Local<wbr>Storage<wbr>Store</a></li>
|
| 93 | <li class="tsd-kind-class"><a href="classes/logger.html" class="tsd-kind-icon">Logger</a></li>
|
| 94 | <li class="tsd-kind-class"><a href="classes/loginfailederror.html" class="tsd-kind-icon">Login<wbr>Failed<wbr>Error</a></li>
|
| 95 | <li class="tsd-kind-class"><a href="classes/missingparametererror.html" class="tsd-kind-icon">Missing<wbr>Parameter<wbr>Error</a></li>
|
| 96 | <li class="tsd-kind-class"><a href="classes/nosessiondataerror.html" class="tsd-kind-icon">No<wbr>Session<wbr>Data<wbr>Error</a></li>
|
| 97 | <li class="tsd-kind-class"><a href="classes/notenoughfundserror.html" class="tsd-kind-icon">Not<wbr>Enough<wbr>Funds<wbr>Error</a></li>
|
| 98 | <li class="tsd-kind-class"><a href="classes/organization.html" class="tsd-kind-icon">Organization</a></li>
|
| 99 | <li class="tsd-kind-class tsd-is-not-exported"><a href="classes/passworderror.html" class="tsd-kind-icon">Password<wbr>Error</a></li>
|
| 100 | <li class="tsd-kind-class"><a href="classes/person.html" class="tsd-kind-icon">Person</a></li>
|
| 101 | <li class="tsd-kind-class"><a href="classes/profile.html" class="tsd-kind-icon">Profile</a></li>
|
| 102 | <li class="tsd-kind-class tsd-is-private"><a href="classes/pubkeyhashsigner.html" class="tsd-kind-icon">Pubkey<wbr>Hash<wbr>Signer</a></li>
|
| 103 | <li class="tsd-kind-class"><a href="classes/remoteserviceerror.html" class="tsd-kind-icon">Remote<wbr>Service<wbr>Error</a></li>
|
| 104 | <li class="tsd-kind-class"><a href="classes/service.html" class="tsd-kind-icon">Service</a></li>
|
| 105 | <li class="tsd-kind-class"><a href="classes/sessiondata.html" class="tsd-kind-icon">Session<wbr>Data</a></li>
|
| 106 | <li class="tsd-kind-class"><a href="classes/sessiondatastore.html" class="tsd-kind-icon">Session<wbr>Data<wbr>Store</a></li>
|
| 107 | <li class="tsd-kind-class"><a href="classes/signatureverificationerror.html" class="tsd-kind-icon">Signature<wbr>Verification<wbr>Error</a></li>
|
| 108 | <li class="tsd-kind-class tsd-is-not-exported"><a href="classes/twitter.html" class="tsd-kind-icon">Twitter</a></li>
|
| 109 | <li class="tsd-kind-class"><a href="classes/usersession.html" class="tsd-kind-icon">User<wbr>Session</a></li>
|
| 110 | </ul>
|
| 111 | </section>
|
| 112 | <section class="tsd-index-section ">
|
| 113 | <h3>Interfaces</h3>
|
| 114 | <ul class="tsd-index-list">
|
| 115 | <li class="tsd-kind-interface tsd-is-not-exported"><a href="interfaces/cssstyle.html" class="tsd-kind-icon">Css<wbr>Style</a></li>
|
| 116 | <li class="tsd-kind-interface"><a href="interfaces/transactionsigner.html" class="tsd-kind-icon">Transaction<wbr>Signer</a></li>
|
| 117 | <li class="tsd-kind-interface"><a href="interfaces/userdata.html" class="tsd-kind-icon">User<wbr>Data</a></li>
|
| 118 | <li class="tsd-kind-interface tsd-is-not-exported"><a href="interfaces/validateproofservice.html" class="tsd-kind-icon">Validate<wbr>Proof<wbr>Service</a></li>
|
| 119 | </ul>
|
| 120 | </section>
|
| 121 | <section class="tsd-index-section ">
|
| 122 | <h3>Type aliases</h3>
|
| 123 | <ul class="tsd-index-list">
|
| 124 | <li class="tsd-kind-type-alias tsd-is-not-exported"><a href="globals.html#amounttype" class="tsd-kind-icon">Amount<wbr>Type</a></li>
|
| 125 | <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>
|
| 126 | <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>
|
| 127 | <li class="tsd-kind-type-alias tsd-is-not-exported"><a href="globals.html#authmetadata" class="tsd-kind-icon">Auth<wbr>Metadata</a></li>
|
| 128 | <li class="tsd-kind-type-alias"><a href="globals.html#cipherobject" class="tsd-kind-icon">Cipher<wbr>Object</a></li>
|
| 129 | <li class="tsd-kind-type-alias tsd-is-not-exported"><a href="globals.html#errortype" class="tsd-kind-icon">Error<wbr>Type</a></li>
|
| 130 | <li class="tsd-kind-type-alias"><a href="globals.html#gaiahubconfig" class="tsd-kind-icon">Gaia<wbr>Hub<wbr>Config</a></li>
|
| 131 | <li class="tsd-kind-type-alias"><a href="globals.html#getfileoptions" class="tsd-kind-icon">Get<wbr>File<wbr>Options</a></li>
|
| 132 | <li class="tsd-kind-type-alias"><a href="globals.html#identitykeypair" class="tsd-kind-icon">Identity<wbr>Key<wbr>Pair</a></li>
|
| 133 | <li class="tsd-kind-type-alias"><a href="globals.html#putfileoptions" class="tsd-kind-icon">Put<wbr>File<wbr>Options</a></li>
|
| 134 | <li class="tsd-kind-type-alias"><a href="globals.html#sessionoptions" class="tsd-kind-icon">Session<wbr>Options</a></li>
|
| 135 | <li class="tsd-kind-type-alias"><a href="globals.html#utxo" class="tsd-kind-icon">UTXO</a></li>
|
| 136 | <li class="tsd-kind-type-alias tsd-is-not-exported"><a href="globals.html#txpoint" class="tsd-kind-icon">tx<wbr>Point</a></li>
|
| 137 | </ul>
|
| 138 | </section>
|
| 139 | <section class="tsd-index-section ">
|
| 140 | <h3>Variables</h3>
|
| 141 | <ul class="tsd-index-list">
|
| 142 | <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>
|
| 143 | <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>
|
| 144 | <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>
|
| 145 | <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>
|
| 146 | <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>
|
| 147 | <li class="tsd-kind-variable"><a href="globals.html#blockstack_app_private_key_label" class="tsd-kind-icon">BLOCKSTACK_<wbr>APP_<wbr>PRIVATE_<wbr>KEY_<wbr>LABEL</a></li>
|
| 148 | <li class="tsd-kind-variable"><a href="globals.html#blockstack_default_gaia_hub_url" class="tsd-kind-icon">BLOCKSTACK_<wbr>DEFAULT_<wbr>GAIA_<wbr>HUB_<wbr>URL</a></li>
|
| 149 | <li class="tsd-kind-variable"><a href="globals.html#blockstack_gaia_hub_label" class="tsd-kind-icon">BLOCKSTACK_<wbr>GAIA_<wbr>HUB_<wbr>LABEL</a></li>
|
| 150 | <li class="tsd-kind-variable"><a href="globals.html#blockstack_handler" class="tsd-kind-icon">BLOCKSTACK_<wbr>HANDLER</a></li>
|
| 151 | <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>
|
| 152 | <li class="tsd-kind-variable"><a href="globals.html#blockstack_storage_label" class="tsd-kind-icon">BLOCKSTACK_<wbr>STORAGE_<wbr>LABEL</a></li>
|
| 153 | <li class="tsd-kind-variable tsd-is-not-exported"><a href="globals.html#change_address" class="tsd-kind-icon">CHANGE_<wbr>ADDRESS</a></li>
|
| 154 | <li class="tsd-kind-variable"><a href="globals.html#default_blockstack_host" class="tsd-kind-icon">DEFAULT_<wbr>BLOCKSTACK_<wbr>HOST</a></li>
|
| 155 | <li class="tsd-kind-variable"><a href="globals.html#default_core_node" class="tsd-kind-icon">DEFAULT_<wbr>CORE_<wbr>NODE</a></li>
|
| 156 | <li class="tsd-kind-variable"><a href="globals.html#default_scope" class="tsd-kind-icon">DEFAULT_<wbr>SCOPE</a></li>
|
| 157 | <li class="tsd-kind-variable"><a href="globals.html#dust_minimum" class="tsd-kind-icon">DUST_<wbr>MINIMUM</a></li>
|
| 158 | <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>
|
| 159 | <li class="tsd-kind-variable tsd-is-not-exported"><a href="globals.html#external_address" class="tsd-kind-icon">EXTERNAL_<wbr>ADDRESS</a></li>
|
| 160 | <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>
|
| 161 | <li class="tsd-kind-variable tsd-is-not-exported"><a href="globals.html#identity_keychain" class="tsd-kind-icon">IDENTITY_<wbr>KEYCHAIN</a></li>
|
| 162 | <li class="tsd-kind-variable"><a href="globals.html#localstorage_session_key" class="tsd-kind-icon">LOCALSTORAGE_<wbr>SESSION_<wbr>KEY</a></li>
|
| 163 | <li class="tsd-kind-variable tsd-is-not-exported"><a href="globals.html#local_regtest" class="tsd-kind-icon">LOCAL_<wbr>REGTEST</a></li>
|
| 164 | <li class="tsd-kind-variable tsd-is-not-exported"><a href="globals.html#mainnet_default" class="tsd-kind-icon">MAINNET_<wbr>DEFAULT</a></li>
|
| 165 | <li class="tsd-kind-variable"><a href="globals.html#name_lookup_path" class="tsd-kind-icon">NAME_<wbr>LOOKUP_<wbr>PATH</a></li>
|
| 166 | <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>
|
| 167 | <li class="tsd-kind-variable tsd-is-not-exported"><a href="globals.html#session_version" class="tsd-kind-icon">SESSION_<wbr>VERSION</a></li>
|
| 168 | <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>
|
| 169 | <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>
|
| 170 | <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>
|
| 171 | <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>
|
| 172 | <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>
|
| 173 | <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>
|
| 174 | <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>
|
| 175 | <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>
|
| 176 | <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>
|
| 177 | <li class="tsd-kind-variable tsd-is-not-exported"><a href="globals.html#version" class="tsd-kind-icon">VERSION</a></li>
|
| 178 | <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>
|
| 179 | <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>
|
| 180 | <li class="tsd-kind-variable tsd-is-not-exported"><a href="globals.html#ecurve" class="tsd-kind-icon">ecurve</a></li>
|
| 181 | <li class="tsd-kind-variable tsd-is-not-exported"><a href="globals.html#inttolevel" class="tsd-kind-icon">int<wbr>ToLevel</a></li>
|
| 182 | <li class="tsd-kind-variable tsd-is-not-exported"><a href="globals.html#leveltoint" class="tsd-kind-icon">level<wbr>ToInt</a></li>
|
| 183 | <li class="tsd-kind-variable"><a href="globals.html#levels" class="tsd-kind-icon">levels</a></li>
|
| 184 | </ul>
|
| 185 | </section>
|
| 186 | <section class="tsd-index-section ">
|
| 187 | <h3>Functions</h3>
|
| 188 | <ul class="tsd-index-list">
|
| 189 | <li class="tsd-kind-function tsd-is-not-exported"><a href="globals.html#addownerinput" class="tsd-kind-icon">add<wbr>Owner<wbr>Input</a></li>
|
| 190 | <li class="tsd-kind-function tsd-is-private"><a href="globals.html#addutxostofund" class="tsd-kind-icon">addUTXOs<wbr>ToFund</a></li>
|
| 191 | <li class="tsd-kind-function tsd-is-not-exported"><a href="globals.html#addresscanreceivename" class="tsd-kind-icon">address<wbr>Can<wbr>Receive<wbr>Name</a></li>
|
| 192 | <li class="tsd-kind-function tsd-is-not-exported"><a href="globals.html#aes256cbcdecrypt" class="tsd-kind-icon">aes256<wbr>Cbc<wbr>Decrypt</a></li>
|
| 193 | <li class="tsd-kind-function tsd-is-not-exported"><a href="globals.html#aes256cbcencrypt" class="tsd-kind-icon">aes256<wbr>Cbc<wbr>Encrypt</a></li>
|
| 194 | <li class="tsd-kind-function tsd-is-not-exported"><a href="globals.html#asamountv2" class="tsd-kind-icon">as<wbr>Amount<wbr>V2</a></li>
|
| 195 | <li class="tsd-kind-function"><a href="globals.html#connecttogaiahub" class="tsd-kind-icon">connect<wbr>ToGaia<wbr>Hub</a></li>
|
| 196 | <li class="tsd-kind-function"><a href="globals.html#containsvalidaddressproofstatement" class="tsd-kind-icon">contains<wbr>Valid<wbr>Address<wbr>Proof<wbr>Statement</a></li>
|
| 197 | <li class="tsd-kind-function"><a href="globals.html#containsvalidproofstatement" class="tsd-kind-icon">contains<wbr>Valid<wbr>Proof<wbr>Statement</a></li>
|
| 198 | <li class="tsd-kind-function"><a href="globals.html#decodeb40" class="tsd-kind-icon">decode<wbr>B40</a></li>
|
| 199 | <li class="tsd-kind-function"><a href="globals.html#decryptcontent" class="tsd-kind-icon">decrypt<wbr>Content</a></li>
|
| 200 | <li class="tsd-kind-function tsd-is-private"><a href="globals.html#decryptecies" class="tsd-kind-icon">decryptECIES</a></li>
|
| 201 | <li class="tsd-kind-function tsd-is-private tsd-is-not-exported"><a href="globals.html#decryptlegacy" class="tsd-kind-icon">decrypt<wbr>Legacy</a></li>
|
| 202 | <li class="tsd-kind-function tsd-is-private"><a href="globals.html#decryptmnemonic" class="tsd-kind-icon">decrypt<wbr>Mnemonic</a></li>
|
| 203 | <li class="tsd-kind-function tsd-is-not-exported"><a href="globals.html#decryptmnemonicbuffer" class="tsd-kind-icon">decrypt<wbr>Mnemonic<wbr>Buffer</a></li>
|
| 204 | <li class="tsd-kind-function tsd-is-private"><a href="globals.html#decryptprivatekey" class="tsd-kind-icon">decrypt<wbr>Private<wbr>Key</a></li>
|
| 205 | <li class="tsd-kind-function"><a href="globals.html#deletefile" class="tsd-kind-icon">delete<wbr>File</a></li>
|
| 206 | <li class="tsd-kind-function tsd-is-private"><a href="globals.html#dopublickeysmatchissuer" class="tsd-kind-icon">do<wbr>Public<wbr>Keys<wbr>Match<wbr>Issuer</a></li>
|
| 207 | <li class="tsd-kind-function tsd-is-private"><a href="globals.html#dopublickeysmatchusername" class="tsd-kind-icon">do<wbr>Public<wbr>Keys<wbr>Match<wbr>Username</a></li>
|
| 208 | <li class="tsd-kind-function tsd-is-private"><a href="globals.html#dosignaturesmatchpublickeys" class="tsd-kind-icon">do<wbr>Signatures<wbr>Match<wbr>Public<wbr>Keys</a></li>
|
| 209 | <li class="tsd-kind-function"><a href="globals.html#ecpairtoaddress" class="tsd-kind-icon">ec<wbr>Pair<wbr>ToAddress</a></li>
|
| 210 | <li class="tsd-kind-function"><a href="globals.html#ecpairtohexstring" class="tsd-kind-icon">ec<wbr>Pair<wbr>ToHex<wbr>String</a></li>
|
| 211 | <li class="tsd-kind-function"><a href="globals.html#encryptcontent" class="tsd-kind-icon">encrypt<wbr>Content</a></li>
|
| 212 | <li class="tsd-kind-function"><a href="globals.html#encryptecies" class="tsd-kind-icon">encryptECIES</a></li>
|
| 213 | <li class="tsd-kind-function tsd-is-private"><a href="globals.html#encryptmnemonic" class="tsd-kind-icon">encrypt<wbr>Mnemonic</a></li>
|
| 214 | <li class="tsd-kind-function tsd-is-private"><a href="globals.html#encryptprivatekey" class="tsd-kind-icon">encrypt<wbr>Private<wbr>Key</a></li>
|
| 215 | <li class="tsd-kind-function tsd-is-not-exported"><a href="globals.html#equalconsttime" class="tsd-kind-icon">equal<wbr>Const<wbr>Time</a></li>
|
| 216 | <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>
|
| 217 | <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>
|
| 218 | <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>
|
| 219 | <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>
|
| 220 | <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>
|
| 221 | <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>
|
| 222 | <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>
|
| 223 | <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>
|
| 224 | <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>
|
| 225 | <li class="tsd-kind-function"><a href="globals.html#estimatetxbytes" class="tsd-kind-icon">estimateTXBytes</a></li>
|
| 226 | <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>
|
| 227 | <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>
|
| 228 | <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>
|
| 229 | <li class="tsd-kind-function"><a href="globals.html#extractprofile" class="tsd-kind-icon">extract<wbr>Profile</a></li>
|
| 230 | <li class="tsd-kind-function tsd-is-private"><a href="globals.html#fetchappmanifest" class="tsd-kind-icon">fetch<wbr>App<wbr>Manifest</a></li>
|
| 231 | <li class="tsd-kind-function tsd-is-not-exported"><a href="globals.html#formataccount" class="tsd-kind-icon">format<wbr>Account</a></li>
|
| 232 | <li class="tsd-kind-function tsd-is-not-exported"><a href="globals.html#fundtransaction" class="tsd-kind-icon">fund<wbr>Transaction</a></li>
|
| 233 | <li class="tsd-kind-function tsd-is-private"><a href="globals.html#generatetransitkey" class="tsd-kind-icon">generate<wbr>Transit<wbr>Key</a></li>
|
| 234 | <li class="tsd-kind-function"><a href="globals.html#getaddress" class="tsd-kind-icon">get<wbr>Address</a></li>
|
| 235 | <li class="tsd-kind-function"><a href="globals.html#getaddressfromdid" class="tsd-kind-icon">get<wbr>Address<wbr>FromDID</a></li>
|
| 236 | <li class="tsd-kind-function"><a href="globals.html#getappbucketurl" class="tsd-kind-icon">get<wbr>App<wbr>Bucket<wbr>Url</a></li>
|
| 237 | <li class="tsd-kind-function tsd-is-private"><a href="globals.html#getauthrequestfromurl" class="tsd-kind-icon">get<wbr>Auth<wbr>Request<wbr>FromURL</a></li>
|
| 238 | <li class="tsd-kind-function"><a href="globals.html#getauthresponsetoken" class="tsd-kind-icon">get<wbr>Auth<wbr>Response<wbr>Token</a></li>
|
| 239 | <li class="tsd-kind-function"><a href="globals.html#getavatarurl" class="tsd-kind-icon">get<wbr>Avatar<wbr>Url</a></li>
|
| 240 | <li class="tsd-kind-function"><a href="globals.html#getbirthdate" class="tsd-kind-icon">get<wbr>Birth<wbr>Date</a></li>
|
| 241 | <li class="tsd-kind-function"><a href="globals.html#getbucketurl" class="tsd-kind-icon">get<wbr>Bucket<wbr>Url</a></li>
|
| 242 | <li class="tsd-kind-function tsd-is-not-exported"><a href="globals.html#getbuffer" class="tsd-kind-icon">get<wbr>Buffer</a></li>
|
| 243 | <li class="tsd-kind-function"><a href="globals.html#getconnections" class="tsd-kind-icon">get<wbr>Connections</a></li>
|
| 244 | <li class="tsd-kind-function tsd-is-private"><a href="globals.html#getcoresession" class="tsd-kind-icon">get<wbr>Core<wbr>Session</a></li>
|
| 245 | <li class="tsd-kind-function"><a href="globals.html#getdidtype" class="tsd-kind-icon">getDIDType</a></li>
|
| 246 | <li class="tsd-kind-function"><a href="globals.html#getdescription" class="tsd-kind-icon">get<wbr>Description</a></li>
|
| 247 | <li class="tsd-kind-function"><a href="globals.html#getentropy" class="tsd-kind-icon">get<wbr>Entropy</a></li>
|
| 248 | <li class="tsd-kind-function"><a href="globals.html#getfamilyname" class="tsd-kind-icon">get<wbr>Family<wbr>Name</a></li>
|
| 249 | <li class="tsd-kind-function"><a href="globals.html#getfile" class="tsd-kind-icon">get<wbr>File</a></li>
|
| 250 | <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>
|
| 251 | <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>
|
| 252 | <li class="tsd-kind-function"><a href="globals.html#getfileurl" class="tsd-kind-icon">get<wbr>File<wbr>Url</a></li>
|
| 253 | <li class="tsd-kind-function"><a href="globals.html#getfullreadurl" class="tsd-kind-icon">get<wbr>Full<wbr>Read<wbr>Url</a></li>
|
| 254 | <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>
|
| 255 | <li class="tsd-kind-function"><a href="globals.html#getgivenname" class="tsd-kind-icon">get<wbr>Given<wbr>Name</a></li>
|
| 256 | <li class="tsd-kind-function"><a href="globals.html#gethexfrombn" class="tsd-kind-icon">get<wbr>Hex<wbr>FromBN</a></li>
|
| 257 | <li class="tsd-kind-function"><a href="globals.html#getname" class="tsd-kind-icon">get<wbr>Name</a></li>
|
| 258 | <li class="tsd-kind-function tsd-is-not-exported"><a href="globals.html#getnodeprivatekey" class="tsd-kind-icon">get<wbr>Node<wbr>Private<wbr>Key</a></li>
|
| 259 | <li class="tsd-kind-function tsd-is-not-exported"><a href="globals.html#getnodepublickey" class="tsd-kind-icon">get<wbr>Node<wbr>Public<wbr>Key</a></li>
|
| 260 | <li class="tsd-kind-function"><a href="globals.html#getorganizations" class="tsd-kind-icon">get<wbr>Organizations</a></li>
|
| 261 | <li class="tsd-kind-function"><a href="globals.html#getpersonfromlegacyformat" class="tsd-kind-icon">get<wbr>Person<wbr>From<wbr>Legacy<wbr>Format</a></li>
|
| 262 | <li class="tsd-kind-function"><a href="globals.html#getpublickeyfromprivate" class="tsd-kind-icon">get<wbr>Public<wbr>Key<wbr>From<wbr>Private</a></li>
|
| 263 | <li class="tsd-kind-function"><a href="globals.html#gettokenfileurl" class="tsd-kind-icon">get<wbr>Token<wbr>File<wbr>Url</a></li>
|
| 264 | <li class="tsd-kind-function tsd-is-not-exported"><a href="globals.html#gettransaction" class="tsd-kind-icon">get<wbr>Transaction</a></li>
|
| 265 | <li class="tsd-kind-function"><a href="globals.html#gettransactioninsidebuilder" class="tsd-kind-icon">get<wbr>Transaction<wbr>Inside<wbr>Builder</a></li>
|
| 266 | <li class="tsd-kind-function tsd-is-not-exported"><a href="globals.html#gettransactionsigner" class="tsd-kind-icon">get<wbr>Transaction<wbr>Signer</a></li>
|
| 267 | <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>
|
| 268 | <li class="tsd-kind-function"><a href="globals.html#getverifiedaccounts" class="tsd-kind-icon">get<wbr>Verified<wbr>Accounts</a></li>
|
| 269 | <li class="tsd-kind-function"><a href="globals.html#handlependingsignin" class="tsd-kind-icon">handle<wbr>Pending<wbr>Sign<wbr>In</a></li>
|
| 270 | <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>
|
| 271 | <li class="tsd-kind-function"><a href="globals.html#hash128" class="tsd-kind-icon">hash128</a></li>
|
| 272 | <li class="tsd-kind-function"><a href="globals.html#hash160" class="tsd-kind-icon">hash160</a></li>
|
| 273 | <li class="tsd-kind-function tsd-is-not-exported"><a href="globals.html#hashcode" class="tsd-kind-icon">hash<wbr>Code</a></li>
|
| 274 | <li class="tsd-kind-function"><a href="globals.html#hexstringtoecpair" class="tsd-kind-icon">hex<wbr>String<wbr>ToECPair</a></li>
|
| 275 | <li class="tsd-kind-function tsd-is-not-exported"><a href="globals.html#hmacsha256" class="tsd-kind-icon">hmac<wbr>Sha256</a></li>
|
| 276 | <li class="tsd-kind-function tsd-is-not-exported"><a href="globals.html#inputbytes" class="tsd-kind-icon">input<wbr>Bytes</a></li>
|
| 277 | <li class="tsd-kind-function tsd-is-not-exported"><a href="globals.html#isaccountspendable" class="tsd-kind-icon">is<wbr>Account<wbr>Spendable</a></li>
|
| 278 | <li class="tsd-kind-function tsd-is-private"><a href="globals.html#isexpirationdatevalid" class="tsd-kind-icon">is<wbr>Expiration<wbr>Date<wbr>Valid</a></li>
|
| 279 | <li class="tsd-kind-function tsd-is-not-exported"><a href="globals.html#isingraceperiod" class="tsd-kind-icon">is<wbr>InGrace<wbr>Period</a></li>
|
| 280 | <li class="tsd-kind-function tsd-is-private"><a href="globals.html#isissuancedatevalid" class="tsd-kind-icon">is<wbr>Issuance<wbr>Date<wbr>Valid</a></li>
|
| 281 | <li class="tsd-kind-function tsd-is-private"><a href="globals.html#islaterversion" class="tsd-kind-icon">is<wbr>Later<wbr>Version</a></li>
|
| 282 | <li class="tsd-kind-function tsd-is-private"><a href="globals.html#ismanifesturivalid" class="tsd-kind-icon">is<wbr>Manifest<wbr>Uri<wbr>Valid</a></li>
|
| 283 | <li class="tsd-kind-function tsd-is-not-exported"><a href="globals.html#isnameavailable" class="tsd-kind-icon">is<wbr>Name<wbr>Available</a></li>
|
| 284 | <li class="tsd-kind-function tsd-is-not-exported"><a href="globals.html#isnamevalid" class="tsd-kind-icon">is<wbr>Name<wbr>Valid</a></li>
|
| 285 | <li class="tsd-kind-function tsd-is-not-exported"><a href="globals.html#isnamespaceavailable" class="tsd-kind-icon">is<wbr>Namespace<wbr>Available</a></li>
|
| 286 | <li class="tsd-kind-function tsd-is-not-exported"><a href="globals.html#isnamespacevalid" class="tsd-kind-icon">is<wbr>Namespace<wbr>Valid</a></li>
|
| 287 | <li class="tsd-kind-function tsd-is-private"><a href="globals.html#isredirecturivalid" class="tsd-kind-icon">is<wbr>Redirect<wbr>Uri<wbr>Valid</a></li>
|
| 288 | <li class="tsd-kind-function tsd-is-private"><a href="globals.html#issameoriginabsoluteurl" class="tsd-kind-icon">is<wbr>Same<wbr>Origin<wbr>Absolute<wbr>Url</a></li>
|
| 289 | <li class="tsd-kind-function"><a href="globals.html#issigninpending" class="tsd-kind-icon">is<wbr>Sign<wbr>InPending</a></li>
|
| 290 | <li class="tsd-kind-function"><a href="globals.html#isusersignedin" class="tsd-kind-icon">is<wbr>User<wbr>Signed<wbr>In</a></li>
|
| 291 | <li class="tsd-kind-function"><a href="globals.html#launchcustomprotocol" class="tsd-kind-icon">launch<wbr>Custom<wbr>Protocol</a></li>
|
| 292 | <li class="tsd-kind-function"><a href="globals.html#listfiles" class="tsd-kind-icon">list<wbr>Files</a></li>
|
| 293 | <li class="tsd-kind-function tsd-is-private tsd-is-not-exported"><a href="globals.html#listfilesloop" class="tsd-kind-icon">list<wbr>Files<wbr>Loop</a></li>
|
| 294 | <li class="tsd-kind-function"><a href="globals.html#loaduserdata" class="tsd-kind-icon">load<wbr>User<wbr>Data</a></li>
|
| 295 | <li class="tsd-kind-function"><a href="globals.html#lookupprofile" class="tsd-kind-icon">lookup<wbr>Profile</a></li>
|
| 296 | <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>
|
| 297 | <li class="tsd-kind-function"><a href="globals.html#makeannounceskeleton" class="tsd-kind-icon">make<wbr>Announce<wbr>Skeleton</a></li>
|
| 298 | <li class="tsd-kind-function"><a href="globals.html#makeauthrequest" class="tsd-kind-icon">make<wbr>Auth<wbr>Request</a></li>
|
| 299 | <li class="tsd-kind-function tsd-is-private"><a href="globals.html#makeauthresponse" class="tsd-kind-icon">make<wbr>Auth<wbr>Response</a></li>
|
| 300 | <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>
|
| 301 | <li class="tsd-kind-function tsd-is-private"><a href="globals.html#makecoresessionrequest" class="tsd-kind-icon">make<wbr>Core<wbr>Session<wbr>Request</a></li>
|
| 302 | <li class="tsd-kind-function"><a href="globals.html#makedidfromaddress" class="tsd-kind-icon">makeDIDFrom<wbr>Address</a></li>
|
| 303 | <li class="tsd-kind-function"><a href="globals.html#makedidfrompublickey" class="tsd-kind-icon">makeDIDFrom<wbr>Public<wbr>Key</a></li>
|
| 304 | <li class="tsd-kind-function"><a href="globals.html#makeecprivatekey" class="tsd-kind-icon">makeECPrivate<wbr>Key</a></li>
|
| 305 | <li class="tsd-kind-function tsd-is-not-exported"><a href="globals.html#makelegacyauthtoken" class="tsd-kind-icon">make<wbr>Legacy<wbr>Auth<wbr>Token</a></li>
|
| 306 | <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>
|
| 307 | <li class="tsd-kind-function"><a href="globals.html#makenameimportskeleton" class="tsd-kind-icon">make<wbr>Name<wbr>Import<wbr>Skeleton</a></li>
|
| 308 | <li class="tsd-kind-function tsd-is-private tsd-is-not-exported"><a href="globals.html#makenamespacepreorder" class="tsd-kind-icon">make<wbr>Namespace<wbr>Preorder</a></li>
|
| 309 | <li class="tsd-kind-function"><a href="globals.html#makenamespacepreorderskeleton" class="tsd-kind-icon">make<wbr>Namespace<wbr>Preorder<wbr>Skeleton</a></li>
|
| 310 | <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>
|
| 311 | <li class="tsd-kind-function"><a href="globals.html#makenamespacereadyskeleton" class="tsd-kind-icon">make<wbr>Namespace<wbr>Ready<wbr>Skeleton</a></li>
|
| 312 | <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>
|
| 313 | <li class="tsd-kind-function"><a href="globals.html#makenamespacerevealskeleton" class="tsd-kind-icon">make<wbr>Namespace<wbr>Reveal<wbr>Skeleton</a></li>
|
| 314 | <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>
|
| 315 | <li class="tsd-kind-function"><a href="globals.html#makepreorderskeleton" class="tsd-kind-icon">make<wbr>Preorder<wbr>Skeleton</a></li>
|
| 316 | <li class="tsd-kind-function"><a href="globals.html#makeprofilezonefile" class="tsd-kind-icon">make<wbr>Profile<wbr>Zone<wbr>File</a></li>
|
| 317 | <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>
|
| 318 | <li class="tsd-kind-function"><a href="globals.html#makeregisterskeleton" class="tsd-kind-icon">make<wbr>Register<wbr>Skeleton</a></li>
|
| 319 | <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>
|
| 320 | <li class="tsd-kind-function"><a href="globals.html#makerenewalskeleton" class="tsd-kind-icon">make<wbr>Renewal<wbr>Skeleton</a></li>
|
| 321 | <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>
|
| 322 | <li class="tsd-kind-function"><a href="globals.html#makerevokeskeleton" class="tsd-kind-icon">make<wbr>Revoke<wbr>Skeleton</a></li>
|
| 323 | <li class="tsd-kind-function tsd-is-not-exported"><a href="globals.html#maketxbuilder" class="tsd-kind-icon">makeTXbuilder</a></li>
|
| 324 | <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>
|
| 325 | <li class="tsd-kind-function"><a href="globals.html#maketokentransferskeleton" class="tsd-kind-icon">make<wbr>Token<wbr>Transfer<wbr>Skeleton</a></li>
|
| 326 | <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>
|
| 327 | <li class="tsd-kind-function"><a href="globals.html#maketransferskeleton" class="tsd-kind-icon">make<wbr>Transfer<wbr>Skeleton</a></li>
|
| 328 | <li class="tsd-kind-function tsd-is-private"><a href="globals.html#makeuuid4" class="tsd-kind-icon">makeUUID4</a></li>
|
| 329 | <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>
|
| 330 | <li class="tsd-kind-function"><a href="globals.html#makeupdateskeleton" class="tsd-kind-icon">make<wbr>Update<wbr>Skeleton</a></li>
|
| 331 | <li class="tsd-kind-function tsd-is-not-exported"><a href="globals.html#makev1gaiaauthtoken" class="tsd-kind-icon">make<wbr>V1Gaia<wbr>Auth<wbr>Token</a></li>
|
| 332 | <li class="tsd-kind-function tsd-is-not-exported"><a href="globals.html#namespaceisready" class="tsd-kind-icon">namespace<wbr>IsReady</a></li>
|
| 333 | <li class="tsd-kind-function tsd-is-not-exported"><a href="globals.html#namespaceisrevealed" class="tsd-kind-icon">namespace<wbr>IsRevealed</a></li>
|
| 334 | <li class="tsd-kind-function"><a href="globals.html#nexthour" class="tsd-kind-icon">next<wbr>Hour</a></li>
|
| 335 | <li class="tsd-kind-function"><a href="globals.html#nextmonth" class="tsd-kind-icon">next<wbr>Month</a></li>
|
| 336 | <li class="tsd-kind-function tsd-is-private"><a href="globals.html#nextyear" class="tsd-kind-icon">next<wbr>Year</a></li>
|
| 337 | <li class="tsd-kind-function tsd-has-type-parameter tsd-is-not-exported"><a href="globals.html#normalizeoptions" class="tsd-kind-icon">normalize<wbr>Options</a></li>
|
| 338 | <li class="tsd-kind-function tsd-is-not-exported"><a href="globals.html#opencode" class="tsd-kind-icon">op<wbr>Encode</a></li>
|
| 339 | <li class="tsd-kind-function tsd-is-not-exported"><a href="globals.html#outputbytes" class="tsd-kind-icon">output<wbr>Bytes</a></li>
|
| 340 | <li class="tsd-kind-function tsd-is-not-exported"><a href="globals.html#ownsname" class="tsd-kind-icon">owns<wbr>Name</a></li>
|
| 341 | <li class="tsd-kind-function"><a href="globals.html#publickeytoaddress" class="tsd-kind-icon">public<wbr>Key<wbr>ToAddress</a></li>
|
| 342 | <li class="tsd-kind-function"><a href="globals.html#putfile" class="tsd-kind-icon">put<wbr>File</a></li>
|
| 343 | <li class="tsd-kind-function"><a href="globals.html#redirecttosignin" class="tsd-kind-icon">redirect<wbr>ToSign<wbr>In</a></li>
|
| 344 | <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>
|
| 345 | <li class="tsd-kind-function tsd-is-private"><a href="globals.html#redirectusertoapp" class="tsd-kind-icon">redirect<wbr>User<wbr>ToApp</a></li>
|
| 346 | <li class="tsd-kind-function"><a href="globals.html#resolvezonefiletoperson" class="tsd-kind-icon">resolve<wbr>Zone<wbr>File<wbr>ToPerson</a></li>
|
| 347 | <li class="tsd-kind-function"><a href="globals.html#resolvezonefiletoprofile" class="tsd-kind-icon">resolve<wbr>Zone<wbr>File<wbr>ToProfile</a></li>
|
| 348 | <li class="tsd-kind-function tsd-is-not-exported"><a href="globals.html#returntransactionhex" class="tsd-kind-icon">return<wbr>Transaction<wbr>Hex</a></li>
|
| 349 | <li class="tsd-kind-function tsd-is-not-exported"><a href="globals.html#revealednamespace" class="tsd-kind-icon">revealed<wbr>Namespace</a></li>
|
| 350 | <li class="tsd-kind-function tsd-is-private"><a href="globals.html#sendcoresessionrequest" class="tsd-kind-icon">send<wbr>Core<wbr>Session<wbr>Request</a></li>
|
| 351 | <li class="tsd-kind-function tsd-is-not-exported"><a href="globals.html#sharedsecrettokeys" class="tsd-kind-icon">shared<wbr>Secret<wbr>ToKeys</a></li>
|
| 352 | <li class="tsd-kind-function tsd-is-private"><a href="globals.html#signecdsa" class="tsd-kind-icon">signECDSA</a></li>
|
| 353 | <li class="tsd-kind-function"><a href="globals.html#signinputs" class="tsd-kind-icon">sign<wbr>Inputs</a></li>
|
| 354 | <li class="tsd-kind-function"><a href="globals.html#signprofiletoken" class="tsd-kind-icon">sign<wbr>Profile<wbr>Token</a></li>
|
| 355 | <li class="tsd-kind-function"><a href="globals.html#signuserout" class="tsd-kind-icon">sign<wbr>User<wbr>Out</a></li>
|
| 356 | <li class="tsd-kind-function"><a href="globals.html#sumoutputvalues" class="tsd-kind-icon">sum<wbr>Output<wbr>Values</a></li>
|
| 357 | <li class="tsd-kind-function tsd-is-not-exported"><a href="globals.html#transactionbytes" class="tsd-kind-icon">transaction<wbr>Bytes</a></li>
|
| 358 | <li class="tsd-kind-function tsd-is-private"><a href="globals.html#updatequerystringparameter" class="tsd-kind-icon">update<wbr>Query<wbr>String<wbr>Parameter</a></li>
|
| 359 | <li class="tsd-kind-function"><a href="globals.html#uploadtogaiahub" class="tsd-kind-icon">upload<wbr>ToGaia<wbr>Hub</a></li>
|
| 360 | <li class="tsd-kind-function"><a href="globals.html#validateproofs" class="tsd-kind-icon">validate<wbr>Proofs</a></li>
|
| 361 | <li class="tsd-kind-function"><a href="globals.html#verifyauthrequest" class="tsd-kind-icon">verify<wbr>Auth<wbr>Request</a></li>
|
| 362 | <li class="tsd-kind-function tsd-is-private"><a href="globals.html#verifyauthrequestandloadmanifest" class="tsd-kind-icon">verify<wbr>Auth<wbr>Request<wbr>And<wbr>Load<wbr>Manifest</a></li>
|
| 363 | <li class="tsd-kind-function tsd-is-private"><a href="globals.html#verifyauthresponse" class="tsd-kind-icon">verify<wbr>Auth<wbr>Response</a></li>
|
| 364 | <li class="tsd-kind-function tsd-is-private"><a href="globals.html#verifyecdsa" class="tsd-kind-icon">verifyECDSA</a></li>
|
| 365 | <li class="tsd-kind-function"><a href="globals.html#verifyprofiletoken" class="tsd-kind-icon">verify<wbr>Profile<wbr>Token</a></li>
|
| 366 | <li class="tsd-kind-function"><a href="globals.html#wrapprofiletoken" class="tsd-kind-icon">wrap<wbr>Profile<wbr>Token</a></li>
|
| 367 | </ul>
|
| 368 | </section>
|
| 369 | <section class="tsd-index-section ">
|
| 370 | <h3>Object literals</h3>
|
| 371 | <ul class="tsd-index-list">
|
| 372 | <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>
|
| 373 | <li class="tsd-kind-object-literal"><a href="globals.html#error_codes" class="tsd-kind-icon">ERROR_<wbr>CODES</a></li>
|
| 374 | <li class="tsd-kind-object-literal tsd-is-not-exported"><a href="globals.html#config" class="tsd-kind-icon">config</a></li>
|
| 375 | <li class="tsd-kind-object-literal"><a href="globals.html#network" class="tsd-kind-icon">network</a></li>
|
| 376 | <li class="tsd-kind-object-literal"><a href="globals.html#profileservices" class="tsd-kind-icon">profile<wbr>Services</a></li>
|
| 377 | <li class="tsd-kind-object-literal"><a href="globals.html#safety" class="tsd-kind-icon">safety</a></li>
|
| 378 | <li class="tsd-kind-object-literal tsd-is-not-exported"><a href="globals.html#schemadefinition" class="tsd-kind-icon">schema<wbr>Definition</a></li>
|
| 379 | <li class="tsd-kind-object-literal"><a href="globals.html#transactions" class="tsd-kind-icon">transactions</a></li>
|
| 380 | </ul>
|
| 381 | </section>
|
| 382 | </div>
|
| 383 | </section>
|
| 384 | </section>
|
| 385 | <section class="tsd-panel-group tsd-member-group ">
|
| 386 | <h2>Type aliases</h2>
|
| 387 | <section class="tsd-panel tsd-member tsd-kind-type-alias tsd-is-not-exported">
|
| 388 | <a name="amounttype" class="tsd-anchor"></a>
|
| 389 | <h3>Amount<wbr>Type</h3>
|
| 390 | <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>
|
| 391 | <aside class="tsd-sources">
|
| 392 | <ul>
|
| 393 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/operations/skeletons.ts#L13">operations/skeletons.ts:13</a></li>
|
| 394 | </ul>
|
| 395 | </aside>
|
| 396 | </section>
|
| 397 | <section class="tsd-panel tsd-member tsd-kind-type-alias tsd-is-not-exported">
|
| 398 | <a name="amounttypev1" class="tsd-anchor"></a>
|
| 399 | <h3>Amount<wbr>Type<wbr>V1</h3>
|
| 400 | <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>
|
| 401 | <aside class="tsd-sources">
|
| 402 | <ul>
|
| 403 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/operations/skeletons.ts#L11">operations/skeletons.ts:11</a></li>
|
| 404 | </ul>
|
| 405 | </aside>
|
| 406 | </section>
|
| 407 | <section class="tsd-panel tsd-member tsd-kind-type-alias tsd-is-not-exported">
|
| 408 | <a name="amounttypev2" class="tsd-anchor"></a>
|
| 409 | <h3>Amount<wbr>Type<wbr>V2</h3>
|
| 410 | <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>
|
| 411 | <aside class="tsd-sources">
|
| 412 | <ul>
|
| 413 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/operations/skeletons.ts#L12">operations/skeletons.ts:12</a></li>
|
| 414 | </ul>
|
| 415 | </aside>
|
| 416 | <div class="tsd-type-declaration">
|
| 417 | <h4>Type declaration</h4>
|
| 418 | <ul class="tsd-parameters">
|
| 419 | <li class="tsd-parameter">
|
| 420 | <h5>amount<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BN</span></h5>
|
| 421 | </li>
|
| 422 | <li class="tsd-parameter">
|
| 423 | <h5>units<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
|
| 424 | </li>
|
| 425 | </ul>
|
| 426 | </div>
|
| 427 | </section>
|
| 428 | <section class="tsd-panel tsd-member tsd-kind-type-alias tsd-is-not-exported">
|
| 429 | <a name="authmetadata" class="tsd-anchor"></a>
|
| 430 | <h3>Auth<wbr>Metadata</h3>
|
| 431 | <div class="tsd-signature tsd-kind-icon">Auth<wbr>Metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
|
| 432 | <aside class="tsd-sources">
|
| 433 | <ul>
|
| 434 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/auth/authMessages.ts#L17">auth/authMessages.ts:17</a></li>
|
| 435 | </ul>
|
| 436 | </aside>
|
| 437 | <div class="tsd-type-declaration">
|
| 438 | <h4>Type declaration</h4>
|
| 439 | <ul class="tsd-parameters">
|
| 440 | <li class="tsd-parameter">
|
| 441 | <h5><span class="tsd-flag ts-flagOptional">Optional</span> email<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5>
|
| 442 | </li>
|
| 443 | <li class="tsd-parameter">
|
| 444 | <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>
|
| 445 | </li>
|
| 446 | </ul>
|
| 447 | </div>
|
| 448 | </section>
|
| 449 | <section class="tsd-panel tsd-member tsd-kind-type-alias">
|
| 450 | <a name="cipherobject" class="tsd-anchor"></a>
|
| 451 | <h3>Cipher<wbr>Object</h3>
|
| 452 | <div class="tsd-signature tsd-kind-icon">Cipher<wbr>Object<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
|
| 453 | <aside class="tsd-sources">
|
| 454 | <ul>
|
| 455 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/encryption/ec.ts#L9">encryption/ec.ts:9</a></li>
|
| 456 | </ul>
|
| 457 | </aside>
|
| 458 | <div class="tsd-type-declaration">
|
| 459 | <h4>Type declaration</h4>
|
| 460 | <ul class="tsd-parameters">
|
| 461 | <li class="tsd-parameter">
|
| 462 | <h5>cipher<wbr>Text<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
|
| 463 | </li>
|
| 464 | <li class="tsd-parameter">
|
| 465 | <h5>ephemeralPK<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
|
| 466 | </li>
|
| 467 | <li class="tsd-parameter">
|
| 468 | <h5>iv<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
|
| 469 | </li>
|
| 470 | <li class="tsd-parameter">
|
| 471 | <h5>mac<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
|
| 472 | </li>
|
| 473 | <li class="tsd-parameter">
|
| 474 | <h5>was<wbr>String<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5>
|
| 475 | </li>
|
| 476 | </ul>
|
| 477 | </div>
|
| 478 | </section>
|
| 479 | <section class="tsd-panel tsd-member tsd-kind-type-alias tsd-is-not-exported">
|
| 480 | <a name="errortype" class="tsd-anchor"></a>
|
| 481 | <h3>Error<wbr>Type</h3>
|
| 482 | <div class="tsd-signature tsd-kind-icon">Error<wbr>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
|
| 483 | <aside class="tsd-sources">
|
| 484 | <ul>
|
| 485 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/errors.ts#L12">errors.ts:12</a></li>
|
| 486 | </ul>
|
| 487 | </aside>
|
| 488 | <div class="tsd-type-declaration">
|
| 489 | <h4>Type declaration</h4>
|
| 490 | <ul class="tsd-parameters">
|
| 491 | <li class="tsd-parameter">
|
| 492 | <h5>code<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
|
| 493 | </li>
|
| 494 | <li class="tsd-parameter">
|
| 495 | <h5>message<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
|
| 496 | </li>
|
| 497 | <li class="tsd-parameter">
|
| 498 | <h5><span class="tsd-flag ts-flagOptional">Optional</span> parameter<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5>
|
| 499 | </li>
|
| 500 | </ul>
|
| 501 | </div>
|
| 502 | </section>
|
| 503 | <section class="tsd-panel tsd-member tsd-kind-type-alias">
|
| 504 | <a name="gaiahubconfig" class="tsd-anchor"></a>
|
| 505 | <h3>Gaia<wbr>Hub<wbr>Config</h3>
|
| 506 | <div class="tsd-signature tsd-kind-icon">Gaia<wbr>Hub<wbr>Config<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
|
| 507 | <aside class="tsd-sources">
|
| 508 | <ul>
|
| 509 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/storage/hub.ts#L13">storage/hub.ts:13</a></li>
|
| 510 | </ul>
|
| 511 | </aside>
|
| 512 | <div class="tsd-type-declaration">
|
| 513 | <h4>Type declaration</h4>
|
| 514 | <ul class="tsd-parameters">
|
| 515 | <li class="tsd-parameter">
|
| 516 | <h5>address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
|
| 517 | </li>
|
| 518 | <li class="tsd-parameter">
|
| 519 | <h5>server<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
|
| 520 | </li>
|
| 521 | <li class="tsd-parameter">
|
| 522 | <h5>token<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
|
| 523 | </li>
|
| 524 | <li class="tsd-parameter">
|
| 525 | <h5>url_<wbr>prefix<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
|
| 526 | </li>
|
| 527 | </ul>
|
| 528 | </div>
|
| 529 | </section>
|
| 530 | <section class="tsd-panel tsd-member tsd-kind-type-alias">
|
| 531 | <a name="getfileoptions" class="tsd-anchor"></a>
|
| 532 | <h3>Get<wbr>File<wbr>Options</h3>
|
| 533 | <div class="tsd-signature tsd-kind-icon">Get<wbr>File<wbr>Options<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
|
| 534 | <aside class="tsd-sources">
|
| 535 | <ul>
|
| 536 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/storage/index.ts#L370">storage/index.ts:370</a></li>
|
| 537 | </ul>
|
| 538 | </aside>
|
| 539 | <div class="tsd-type-declaration">
|
| 540 | <h4>Type declaration</h4>
|
| 541 | <ul class="tsd-parameters">
|
| 542 | <li class="tsd-parameter">
|
| 543 | <h5><span class="tsd-flag ts-flagOptional">Optional</span> app<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>
|
| 544 | </li>
|
| 545 | <li class="tsd-parameter">
|
| 546 | <h5><span class="tsd-flag ts-flagOptional">Optional</span> decrypt<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5>
|
| 547 | </li>
|
| 548 | <li class="tsd-parameter">
|
| 549 | <h5><span class="tsd-flag ts-flagOptional">Optional</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-type">null</span></h5>
|
| 550 | </li>
|
| 551 | <li class="tsd-parameter">
|
| 552 | <h5><span class="tsd-flag ts-flagOptional">Optional</span> verify<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5>
|
| 553 | </li>
|
| 554 | <li class="tsd-parameter">
|
| 555 | <h5><span class="tsd-flag ts-flagOptional">Optional</span> zone<wbr>File<wbr>LookupURL<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>
|
| 556 | </li>
|
| 557 | </ul>
|
| 558 | </div>
|
| 559 | </section>
|
| 560 | <section class="tsd-panel tsd-member tsd-kind-type-alias">
|
| 561 | <a name="identitykeypair" class="tsd-anchor"></a>
|
| 562 | <h3>Identity<wbr>Key<wbr>Pair</h3>
|
| 563 | <div class="tsd-signature tsd-kind-icon">Identity<wbr>Key<wbr>Pair<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
|
| 564 | <aside class="tsd-sources">
|
| 565 | <ul>
|
| 566 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/wallet.ts#L20">wallet.ts:20</a></li>
|
| 567 | </ul>
|
| 568 | </aside>
|
| 569 | <div class="tsd-type-declaration">
|
| 570 | <h4>Type declaration</h4>
|
| 571 | <ul class="tsd-parameters">
|
| 572 | <li class="tsd-parameter">
|
| 573 | <h5>address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
|
| 574 | </li>
|
| 575 | <li class="tsd-parameter">
|
| 576 | <h5>apps<wbr>Node<wbr>Key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
|
| 577 | </li>
|
| 578 | <li class="tsd-parameter">
|
| 579 | <h5>key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
|
| 580 | </li>
|
| 581 | <li class="tsd-parameter">
|
| 582 | <h5>keyID<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
|
| 583 | </li>
|
| 584 | <li class="tsd-parameter">
|
| 585 | <h5>salt<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
|
| 586 | </li>
|
| 587 | </ul>
|
| 588 | </div>
|
| 589 | </section>
|
| 590 | <section class="tsd-panel tsd-member tsd-kind-type-alias">
|
| 591 | <a name="putfileoptions" class="tsd-anchor"></a>
|
| 592 | <h3>Put<wbr>File<wbr>Options</h3>
|
| 593 | <div class="tsd-signature tsd-kind-icon">Put<wbr>File<wbr>Options<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
|
| 594 | <aside class="tsd-sources">
|
| 595 | <ul>
|
| 596 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/storage/index.ts#L23">storage/index.ts:23</a></li>
|
| 597 | </ul>
|
| 598 | </aside>
|
| 599 | <div class="tsd-type-declaration">
|
| 600 | <h4>Type declaration</h4>
|
| 601 | <ul class="tsd-parameters">
|
| 602 | <li class="tsd-parameter">
|
| 603 | <h5><span class="tsd-flag ts-flagOptional">Optional</span> content<wbr>Type<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5>
|
| 604 | </li>
|
| 605 | <li class="tsd-parameter">
|
| 606 | <h5><span class="tsd-flag ts-flagOptional">Optional</span> encrypt<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5>
|
| 607 | </li>
|
| 608 | <li class="tsd-parameter">
|
| 609 | <h5><span class="tsd-flag ts-flagOptional">Optional</span> sign<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5>
|
| 610 | </li>
|
| 611 | </ul>
|
| 612 | </div>
|
| 613 | </section>
|
| 614 | <section class="tsd-panel tsd-member tsd-kind-type-alias">
|
| 615 | <a name="sessionoptions" class="tsd-anchor"></a>
|
| 616 | <h3>Session<wbr>Options</h3>
|
| 617 | <div class="tsd-signature tsd-kind-icon">Session<wbr>Options<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
|
| 618 | <aside class="tsd-sources">
|
| 619 | <ul>
|
| 620 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/auth/sessionData.ts#L8">auth/sessionData.ts:8</a></li>
|
| 621 | </ul>
|
| 622 | </aside>
|
| 623 | <div class="tsd-type-declaration">
|
| 624 | <h4>Type declaration</h4>
|
| 625 | <ul class="tsd-parameters">
|
| 626 | <li class="tsd-parameter">
|
| 627 | <h5><span class="tsd-flag ts-flagOptional">Optional</span> app<wbr>Private<wbr>Key<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5>
|
| 628 | </li>
|
| 629 | <li class="tsd-parameter">
|
| 630 | <h5><span class="tsd-flag ts-flagOptional">Optional</span> core<wbr>Node<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5>
|
| 631 | </li>
|
| 632 | <li class="tsd-parameter">
|
| 633 | <h5><span class="tsd-flag ts-flagOptional">Optional</span> hub<wbr>Url<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5>
|
| 634 | </li>
|
| 635 | <li class="tsd-parameter">
|
| 636 | <h5><span class="tsd-flag ts-flagOptional">Optional</span> identity<wbr>Address<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5>
|
| 637 | </li>
|
| 638 | <li class="tsd-parameter">
|
| 639 | <h5><span class="tsd-flag ts-flagOptional">Optional</span> local<wbr>Storage<wbr>Key<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5>
|
| 640 | </li>
|
| 641 | <li class="tsd-parameter">
|
| 642 | <h5><span class="tsd-flag ts-flagOptional">Optional</span> store<wbr>Options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">object</span></h5>
|
| 643 | <ul class="tsd-parameters">
|
| 644 | <li class="tsd-parameter">
|
| 645 | <h5><span class="tsd-flag ts-flagOptional">Optional</span> local<wbr>Storage<wbr>Key<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5>
|
| 646 | </li>
|
| 647 | </ul>
|
| 648 | </li>
|
| 649 | <li class="tsd-parameter">
|
| 650 | <h5><span class="tsd-flag ts-flagOptional">Optional</span> transit<wbr>Key<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5>
|
| 651 | </li>
|
| 652 | <li class="tsd-parameter">
|
| 653 | <h5><span class="tsd-flag ts-flagOptional">Optional</span> user<wbr>Data<span class="tsd-signature-symbol">?: </span><a href="interfaces/userdata.html" class="tsd-signature-type">UserData</a></h5>
|
| 654 | </li>
|
| 655 | <li class="tsd-parameter">
|
| 656 | <h5><span class="tsd-flag ts-flagOptional">Optional</span> username<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5>
|
| 657 | </li>
|
| 658 | </ul>
|
| 659 | </div>
|
| 660 | </section>
|
| 661 | <section class="tsd-panel tsd-member tsd-kind-type-alias">
|
| 662 | <a name="utxo" class="tsd-anchor"></a>
|
| 663 | <h3>UTXO</h3>
|
| 664 | <div class="tsd-signature tsd-kind-icon">UTXO<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
|
| 665 | <aside class="tsd-sources">
|
| 666 | <ul>
|
| 667 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/network.ts#L9">network.ts:9</a></li>
|
| 668 | </ul>
|
| 669 | </aside>
|
| 670 | <div class="tsd-type-declaration">
|
| 671 | <h4>Type declaration</h4>
|
| 672 | <ul class="tsd-parameters">
|
| 673 | <li class="tsd-parameter">
|
| 674 | <h5><span class="tsd-flag ts-flagOptional">Optional</span> confirmations<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5>
|
| 675 | </li>
|
| 676 | <li class="tsd-parameter">
|
| 677 | <h5>tx_<wbr>hash<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
|
| 678 | </li>
|
| 679 | <li class="tsd-parameter">
|
| 680 | <h5>tx_<wbr>output_<wbr>n<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
|
| 681 | </li>
|
| 682 | <li class="tsd-parameter">
|
| 683 | <h5><span class="tsd-flag ts-flagOptional">Optional</span> value<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5>
|
| 684 | </li>
|
| 685 | </ul>
|
| 686 | </div>
|
| 687 | </section>
|
| 688 | <section class="tsd-panel tsd-member tsd-kind-type-alias tsd-is-not-exported">
|
| 689 | <a name="txpoint" class="tsd-anchor"></a>
|
| 690 | <h3>tx<wbr>Point</h3>
|
| 691 | <div class="tsd-signature tsd-kind-icon">tx<wbr>Point<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
|
| 692 | <aside class="tsd-sources">
|
| 693 | <ul>
|
| 694 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/operations/utils.ts#L31">operations/utils.ts:31</a></li>
|
| 695 | </ul>
|
| 696 | </aside>
|
| 697 | <div class="tsd-type-declaration">
|
| 698 | <h4>Type declaration</h4>
|
| 699 | <ul class="tsd-parameters">
|
| 700 | <li class="tsd-parameter">
|
| 701 | <h5>script<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span></h5>
|
| 702 | <ul class="tsd-parameters">
|
| 703 | <li class="tsd-parameter">
|
| 704 | <h5>length<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
|
| 705 | </li>
|
| 706 | </ul>
|
| 707 | </li>
|
| 708 | </ul>
|
| 709 | </div>
|
| 710 | </section>
|
| 711 | </section>
|
| 712 | <section class="tsd-panel-group tsd-member-group ">
|
| 713 | <h2>Variables</h2>
|
| 714 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-is-not-exported">
|
| 715 | <a name="apps_node_index" class="tsd-anchor"></a>
|
| 716 | <h3><span class="tsd-flag ts-flagConst">Const</span> APPS_<wbr>NODE_<wbr>INDEX</h3>
|
| 717 | <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>
|
| 718 | <aside class="tsd-sources">
|
| 719 | <ul>
|
| 720 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/wallet.ts#L9">wallet.ts:9</a></li>
|
| 721 | </ul>
|
| 722 | </aside>
|
| 723 | </section>
|
| 724 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-is-not-exported">
|
| 725 | <a name="auth_continuation_param" class="tsd-anchor"></a>
|
| 726 | <h3><span class="tsd-flag ts-flagConst">Const</span> AUTH_<wbr>CONTINUATION_<wbr>PARAM</h3>
|
| 727 | <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>
|
| 728 | <aside class="tsd-sources">
|
| 729 | <ul>
|
| 730 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/auth/protocolEchoDetection.ts#L10">auth/protocolEchoDetection.ts:10</a></li>
|
| 731 | </ul>
|
| 732 | </aside>
|
| 733 | </section>
|
| 734 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-is-not-exported">
|
| 735 | <a name="bitcoin_account_index" class="tsd-anchor"></a>
|
| 736 | <h3><span class="tsd-flag ts-flagConst">Const</span> BITCOIN_<wbr>ACCOUNT_<wbr>INDEX</h3>
|
| 737 | <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>
|
| 738 | <aside class="tsd-sources">
|
| 739 | <ul>
|
| 740 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/wallet.ts#L15">wallet.ts:15</a></li>
|
| 741 | </ul>
|
| 742 | </aside>
|
| 743 | </section>
|
| 744 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-is-not-exported">
|
| 745 | <a name="bitcoin_bip_44_purpose" class="tsd-anchor"></a>
|
| 746 | <h3><span class="tsd-flag ts-flagConst">Const</span> BITCOIN_<wbr>BIP_<wbr>44_<wbr>PURPOSE</h3>
|
| 747 | <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>
|
| 748 | <aside class="tsd-sources">
|
| 749 | <ul>
|
| 750 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/wallet.ts#L13">wallet.ts:13</a></li>
|
| 751 | </ul>
|
| 752 | </aside>
|
| 753 | </section>
|
| 754 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-is-not-exported">
|
| 755 | <a name="bitcoin_coin_type" class="tsd-anchor"></a>
|
| 756 | <h3><span class="tsd-flag ts-flagConst">Const</span> BITCOIN_<wbr>COIN_<wbr>TYPE</h3>
|
| 757 | <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>
|
| 758 | <aside class="tsd-sources">
|
| 759 | <ul>
|
| 760 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/wallet.ts#L14">wallet.ts:14</a></li>
|
| 761 | </ul>
|
| 762 | </aside>
|
| 763 | </section>
|
| 764 | <section class="tsd-panel tsd-member tsd-kind-variable">
|
| 765 | <a name="blockstack_app_private_key_label" class="tsd-anchor"></a>
|
| 766 | <h3><span class="tsd-flag ts-flagConst">Const</span> BLOCKSTACK_<wbr>APP_<wbr>PRIVATE_<wbr>KEY_<wbr>LABEL</h3>
|
| 767 | <div class="tsd-signature tsd-kind-icon">BLOCKSTACK_<wbr>APP_<wbr>PRIVATE_<wbr>KEY_<wbr>LABEL<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"blockstack-transit-private-key"</span><span class="tsd-signature-symbol"> = "blockstack-transit-private-key"</span></div>
|
| 768 | <aside class="tsd-sources">
|
| 769 | <ul>
|
| 770 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/auth/authConstants.ts#L6">auth/authConstants.ts:6</a></li>
|
| 771 | </ul>
|
| 772 | </aside>
|
| 773 | </section>
|
| 774 | <section class="tsd-panel tsd-member tsd-kind-variable">
|
| 775 | <a name="blockstack_default_gaia_hub_url" class="tsd-anchor"></a>
|
| 776 | <h3><span class="tsd-flag ts-flagConst">Const</span> BLOCKSTACK_<wbr>DEFAULT_<wbr>GAIA_<wbr>HUB_<wbr>URL</h3>
|
| 777 | <div class="tsd-signature tsd-kind-icon">BLOCKSTACK_<wbr>DEFAULT_<wbr>GAIA_<wbr>HUB_<wbr>URL<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"https://hub.blockstack.org"</span><span class="tsd-signature-symbol"> = "https://hub.blockstack.org"</span></div>
|
| 778 | <aside class="tsd-sources">
|
| 779 | <ul>
|
| 780 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/auth/authConstants.ts#L7">auth/authConstants.ts:7</a></li>
|
| 781 | </ul>
|
| 782 | </aside>
|
| 783 | </section>
|
| 784 | <section class="tsd-panel tsd-member tsd-kind-variable">
|
| 785 | <a name="blockstack_gaia_hub_label" class="tsd-anchor"></a>
|
| 786 | <h3><span class="tsd-flag ts-flagConst">Const</span> BLOCKSTACK_<wbr>GAIA_<wbr>HUB_<wbr>LABEL</h3>
|
| 787 | <div class="tsd-signature tsd-kind-icon">BLOCKSTACK_<wbr>GAIA_<wbr>HUB_<wbr>LABEL<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"blockstack-gaia-hub-config"</span><span class="tsd-signature-symbol"> = "blockstack-gaia-hub-config"</span></div>
|
| 788 | <aside class="tsd-sources">
|
| 789 | <ul>
|
| 790 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/storage/hub.ts#L11">storage/hub.ts:11</a></li>
|
| 791 | </ul>
|
| 792 | </aside>
|
| 793 | </section>
|
| 794 | <section class="tsd-panel tsd-member tsd-kind-variable">
|
| 795 | <a name="blockstack_handler" class="tsd-anchor"></a>
|
| 796 | <h3><span class="tsd-flag ts-flagConst">Const</span> BLOCKSTACK_<wbr>HANDLER</h3>
|
| 797 | <div class="tsd-signature tsd-kind-icon">BLOCKSTACK_<wbr>HANDLER<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"blockstack"</span><span class="tsd-signature-symbol"> = "blockstack"</span></div>
|
| 798 | <aside class="tsd-sources">
|
| 799 | <ul>
|
| 800 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/auth/authConstants.ts#L2">auth/authConstants.ts:2</a></li>
|
| 801 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/utils.ts#L7">utils.ts:7</a></li>
|
| 802 | </ul>
|
| 803 | </aside>
|
| 804 | </section>
|
| 805 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-is-not-exported">
|
| 806 | <a name="blockstack_on_bitcoin" class="tsd-anchor"></a>
|
| 807 | <h3><span class="tsd-flag ts-flagConst">Const</span> BLOCKSTACK_<wbr>ON_<wbr>BITCOIN</h3>
|
| 808 | <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>
|
| 809 | <aside class="tsd-sources">
|
| 810 | <ul>
|
| 811 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/wallet.ts#L11">wallet.ts:11</a></li>
|
| 812 | </ul>
|
| 813 | </aside>
|
| 814 | </section>
|
| 815 | <section class="tsd-panel tsd-member tsd-kind-variable">
|
| 816 | <a name="blockstack_storage_label" class="tsd-anchor"></a>
|
| 817 | <h3><span class="tsd-flag ts-flagConst">Const</span> BLOCKSTACK_<wbr>STORAGE_<wbr>LABEL</h3>
|
| 818 | <div class="tsd-signature tsd-kind-icon">BLOCKSTACK_<wbr>STORAGE_<wbr>LABEL<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"blockstack"</span><span class="tsd-signature-symbol"> = "blockstack"</span></div>
|
| 819 | <aside class="tsd-sources">
|
| 820 | <ul>
|
| 821 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/auth/authConstants.ts#L3">auth/authConstants.ts:3</a></li>
|
| 822 | </ul>
|
| 823 | </aside>
|
| 824 | </section>
|
| 825 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-is-not-exported">
|
| 826 | <a name="change_address" class="tsd-anchor"></a>
|
| 827 | <h3><span class="tsd-flag ts-flagConst">Const</span> CHANGE_<wbr>ADDRESS</h3>
|
| 828 | <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>
|
| 829 | <aside class="tsd-sources">
|
| 830 | <ul>
|
| 831 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/wallet.ts#L18">wallet.ts:18</a></li>
|
| 832 | </ul>
|
| 833 | </aside>
|
| 834 | </section>
|
| 835 | <section class="tsd-panel tsd-member tsd-kind-variable">
|
| 836 | <a name="default_blockstack_host" class="tsd-anchor"></a>
|
| 837 | <h3><span class="tsd-flag ts-flagConst">Const</span> DEFAULT_<wbr>BLOCKSTACK_<wbr>HOST</h3>
|
| 838 | <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>
|
| 839 | <aside class="tsd-sources">
|
| 840 | <ul>
|
| 841 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/auth/authConstants.ts#L4">auth/authConstants.ts:4</a></li>
|
| 842 | </ul>
|
| 843 | </aside>
|
| 844 | </section>
|
| 845 | <section class="tsd-panel tsd-member tsd-kind-variable">
|
| 846 | <a name="default_core_node" class="tsd-anchor"></a>
|
| 847 | <h3><span class="tsd-flag ts-flagConst">Const</span> DEFAULT_<wbr>CORE_<wbr>NODE</h3>
|
| 848 | <div class="tsd-signature tsd-kind-icon">DEFAULT_<wbr>CORE_<wbr>NODE<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"https://core.blockstack.org"</span><span class="tsd-signature-symbol"> = "https://core.blockstack.org"</span></div>
|
| 849 | <aside class="tsd-sources">
|
| 850 | <ul>
|
| 851 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/auth/authConstants.ts#L9">auth/authConstants.ts:9</a></li>
|
| 852 | </ul>
|
| 853 | </aside>
|
| 854 | </section>
|
| 855 | <section class="tsd-panel tsd-member tsd-kind-variable">
|
| 856 | <a name="default_scope" class="tsd-anchor"></a>
|
| 857 | <h3><span class="tsd-flag ts-flagConst">Const</span> DEFAULT_<wbr>SCOPE</h3>
|
| 858 | <div class="tsd-signature tsd-kind-icon">DEFAULT_<wbr>SCOPE<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = ['store_write']</span></div>
|
| 859 | <aside class="tsd-sources">
|
| 860 | <ul>
|
| 861 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/auth/authConstants.ts#L5">auth/authConstants.ts:5</a></li>
|
| 862 | </ul>
|
| 863 | </aside>
|
| 864 | </section>
|
| 865 | <section class="tsd-panel tsd-member tsd-kind-variable">
|
| 866 | <a name="dust_minimum" class="tsd-anchor"></a>
|
| 867 | <h3><span class="tsd-flag ts-flagConst">Const</span> DUST_<wbr>MINIMUM</h3>
|
| 868 | <div class="tsd-signature tsd-kind-icon">DUST_<wbr>MINIMUM<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">5500</span><span class="tsd-signature-symbol"> = 5500</span></div>
|
| 869 | <aside class="tsd-sources">
|
| 870 | <ul>
|
| 871 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/operations/utils.ts#L11">operations/utils.ts:11</a></li>
|
| 872 | </ul>
|
| 873 | </aside>
|
| 874 | </section>
|
| 875 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-is-not-exported">
|
| 876 | <a name="echo_reply_param" class="tsd-anchor"></a>
|
| 877 | <h3><span class="tsd-flag ts-flagConst">Const</span> ECHO_<wbr>REPLY_<wbr>PARAM</h3>
|
| 878 | <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>
|
| 879 | <aside class="tsd-sources">
|
| 880 | <ul>
|
| 881 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/auth/protocolEchoDetection.ts#L9">auth/protocolEchoDetection.ts:9</a></li>
|
| 882 | </ul>
|
| 883 | </aside>
|
| 884 | </section>
|
| 885 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-is-not-exported">
|
| 886 | <a name="external_address" class="tsd-anchor"></a>
|
| 887 | <h3><span class="tsd-flag ts-flagConst">Const</span> EXTERNAL_<wbr>ADDRESS</h3>
|
| 888 | <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>
|
| 889 | <aside class="tsd-sources">
|
| 890 | <ul>
|
| 891 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/wallet.ts#L17">wallet.ts:17</a></li>
|
| 892 | </ul>
|
| 893 | </aside>
|
| 894 | </section>
|
| 895 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-is-not-exported">
|
| 896 | <a name="global_detection_cache_key" class="tsd-anchor"></a>
|
| 897 | <h3><span class="tsd-flag ts-flagConst">Const</span> GLOBAL_<wbr>DETECTION_<wbr>CACHE_<wbr>KEY</h3>
|
| 898 | <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>
|
| 899 | <aside class="tsd-sources">
|
| 900 | <ul>
|
| 901 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/auth/protocolEchoDetection.ts#L8">auth/protocolEchoDetection.ts:8</a></li>
|
| 902 | </ul>
|
| 903 | </aside>
|
| 904 | <div class="tsd-comment tsd-typography">
|
| 905 | <div class="lead">
|
| 906 | <p>This logic is in a separate file with no dependencies so that it can be
|
| 907 | loaded and executed as soon as possible to fulfill the purpose of the protocol
|
| 908 | detection technique. The effectiveness of this is obviously subject to how web
|
| 909 | apps bundle/consume the blockstack.js lib.</p>
|
| 910 | </div>
|
| 911 | </div>
|
| 912 | </section>
|
| 913 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-is-not-exported">
|
| 914 | <a name="identity_keychain" class="tsd-anchor"></a>
|
| 915 | <h3><span class="tsd-flag ts-flagConst">Const</span> IDENTITY_<wbr>KEYCHAIN</h3>
|
| 916 | <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>
|
| 917 | <aside class="tsd-sources">
|
| 918 | <ul>
|
| 919 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/wallet.ts#L10">wallet.ts:10</a></li>
|
| 920 | </ul>
|
| 921 | </aside>
|
| 922 | </section>
|
| 923 | <section class="tsd-panel tsd-member tsd-kind-variable">
|
| 924 | <a name="localstorage_session_key" class="tsd-anchor"></a>
|
| 925 | <h3><span class="tsd-flag ts-flagConst">Const</span> LOCALSTORAGE_<wbr>SESSION_<wbr>KEY</h3>
|
| 926 | <div class="tsd-signature tsd-kind-icon">LOCALSTORAGE_<wbr>SESSION_<wbr>KEY<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"blockstack-session"</span><span class="tsd-signature-symbol"> = "blockstack-session"</span></div>
|
| 927 | <aside class="tsd-sources">
|
| 928 | <ul>
|
| 929 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/auth/authConstants.ts#L11">auth/authConstants.ts:11</a></li>
|
| 930 | </ul>
|
| 931 | </aside>
|
| 932 | </section>
|
| 933 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-is-not-exported">
|
| 934 | <a name="local_regtest" class="tsd-anchor"></a>
|
| 935 | <h3><span class="tsd-flag ts-flagConst">Const</span> LOCAL_<wbr>REGTEST</h3>
|
| 936 | <div class="tsd-signature tsd-kind-icon">LOCAL_<wbr>REGTEST<span class="tsd-signature-symbol">:</span> <a href="classes/localregtest.html" class="tsd-signature-type">LocalRegtest</a><span class="tsd-signature-symbol"> = new LocalRegtest('http://localhost:16268','http://localhost:16269',new BitcoindAPI('http://localhost:18332/',{ username: 'blockstack', password: 'blockstacksystem' }))</span></div>
|
| 937 | <aside class="tsd-sources">
|
| 938 | <ul>
|
| 939 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/network.ts#L1177">network.ts:1177</a></li>
|
| 940 | </ul>
|
| 941 | </aside>
|
| 942 | </section>
|
| 943 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-is-not-exported">
|
| 944 | <a name="mainnet_default" class="tsd-anchor"></a>
|
| 945 | <h3><span class="tsd-flag ts-flagConst">Const</span> MAINNET_<wbr>DEFAULT</h3>
|
| 946 | <div class="tsd-signature tsd-kind-icon">MAINNET_<wbr>DEFAULT<span class="tsd-signature-symbol">:</span> <a href="classes/blockstacknetwork.html" class="tsd-signature-type">BlockstackNetwork</a><span class="tsd-signature-symbol"> = new BlockstackNetwork('https://core.blockstack.org','https://broadcast.blockstack.org',new BlockchainInfoApi())</span></div>
|
| 947 | <aside class="tsd-sources">
|
| 948 | <ul>
|
| 949 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/network.ts#L1184">network.ts:1184</a></li>
|
| 950 | </ul>
|
| 951 | </aside>
|
| 952 | </section>
|
| 953 | <section class="tsd-panel tsd-member tsd-kind-variable">
|
| 954 | <a name="name_lookup_path" class="tsd-anchor"></a>
|
| 955 | <h3><span class="tsd-flag ts-flagConst">Const</span> NAME_<wbr>LOOKUP_<wbr>PATH</h3>
|
| 956 | <div class="tsd-signature tsd-kind-icon">NAME_<wbr>LOOKUP_<wbr>PATH<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"/v1/names"</span><span class="tsd-signature-symbol"> = "/v1/names"</span></div>
|
| 957 | <aside class="tsd-sources">
|
| 958 | <ul>
|
| 959 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/auth/authConstants.ts#L10">auth/authConstants.ts:10</a></li>
|
| 960 | </ul>
|
| 961 | </aside>
|
| 962 | </section>
|
| 963 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-is-not-exported">
|
| 964 | <a name="satoshis_per_btc" class="tsd-anchor"></a>
|
| 965 | <h3><span class="tsd-flag ts-flagConst">Const</span> SATOSHIS_<wbr>PER_<wbr>BTC</h3>
|
| 966 | <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>
|
| 967 | <aside class="tsd-sources">
|
| 968 | <ul>
|
| 969 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/network.ts#L16">network.ts:16</a></li>
|
| 970 | </ul>
|
| 971 | </aside>
|
| 972 | </section>
|
| 973 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-is-not-exported">
|
| 974 | <a name="session_version" class="tsd-anchor"></a>
|
| 975 | <h3><span class="tsd-flag ts-flagConst">Const</span> SESSION_<wbr>VERSION</h3>
|
| 976 | <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>
|
| 977 | <aside class="tsd-sources">
|
| 978 | <ul>
|
| 979 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/auth/sessionData.ts#L6">auth/sessionData.ts:6</a></li>
|
| 980 | </ul>
|
| 981 | </aside>
|
| 982 | </section>
|
| 983 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-is-not-exported">
|
| 984 | <a name="signature_file_suffix" class="tsd-anchor"></a>
|
| 985 | <h3><span class="tsd-flag ts-flagConst">Const</span> SIGNATURE_<wbr>FILE_<wbr>SUFFIX</h3>
|
| 986 | <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>
|
| 987 | <aside class="tsd-sources">
|
| 988 | <ul>
|
| 989 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/storage/index.ts#L29">storage/index.ts:29</a></li>
|
| 990 | </ul>
|
| 991 | </aside>
|
| 992 | </section>
|
| 993 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-is-not-exported">
|
| 994 | <a name="tx_broadcast_service_registration_endpoint" class="tsd-anchor"></a>
|
| 995 | <h3><span class="tsd-flag ts-flagConst">Const</span> TX_<wbr>BROADCAST_<wbr>SERVICE_<wbr>REGISTRATION_<wbr>ENDPOINT</h3>
|
| 996 | <div class="tsd-signature tsd-kind-icon">TX_<wbr>BROADCAST_<wbr>SERVICE_<wbr>REGISTRATION_<wbr>ENDPOINT<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"registration"</span><span class="tsd-signature-symbol"> = "registration"</span></div>
|
| 997 | <aside class="tsd-sources">
|
| 998 | <ul>
|
| 999 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/network.ts#L18">network.ts:18</a></li>
|
| 1000 | </ul>
|
| 1001 | </aside>
|
| 1002 | </section>
|
| 1003 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-is-not-exported">
|
| 1004 | <a name="tx_broadcast_service_tx_endpoint" class="tsd-anchor"></a>
|
| 1005 | <h3><span class="tsd-flag ts-flagConst">Const</span> TX_<wbr>BROADCAST_<wbr>SERVICE_<wbr>TX_<wbr>ENDPOINT</h3>
|
| 1006 | <div class="tsd-signature tsd-kind-icon">TX_<wbr>BROADCAST_<wbr>SERVICE_<wbr>TX_<wbr>ENDPOINT<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"transaction"</span><span class="tsd-signature-symbol"> = "transaction"</span></div>
|
| 1007 | <aside class="tsd-sources">
|
| 1008 | <ul>
|
| 1009 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/network.ts#L19">network.ts:19</a></li>
|
| 1010 | </ul>
|
| 1011 | </aside>
|
| 1012 | </section>
|
| 1013 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-is-not-exported">
|
| 1014 | <a name="tx_broadcast_service_zone_file_endpoint" class="tsd-anchor"></a>
|
| 1015 | <h3><span class="tsd-flag ts-flagConst">Const</span> TX_<wbr>BROADCAST_<wbr>SERVICE_<wbr>ZONE_<wbr>FILE_<wbr>ENDPOINT</h3>
|
| 1016 | <div class="tsd-signature tsd-kind-icon">TX_<wbr>BROADCAST_<wbr>SERVICE_<wbr>ZONE_<wbr>FILE_<wbr>ENDPOINT<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"zone-file"</span><span class="tsd-signature-symbol"> = "zone-file"</span></div>
|
| 1017 | <aside class="tsd-sources">
|
| 1018 | <ul>
|
| 1019 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/network.ts#L17">network.ts:17</a></li>
|
| 1020 | </ul>
|
| 1021 | </aside>
|
| 1022 | </section>
|
| 1023 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-is-not-exported">
|
| 1024 | <a name="tx_empty_size" class="tsd-anchor"></a>
|
| 1025 | <h3><span class="tsd-flag ts-flagConst">Const</span> TX_<wbr>EMPTY_<wbr>SIZE</h3>
|
| 1026 | <div class="tsd-signature tsd-kind-icon">TX_<wbr>EMPTY_<wbr>SIZE<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 4 + 1 + 1 + 4</span></div>
|
| 1027 | <aside class="tsd-sources">
|
| 1028 | <ul>
|
| 1029 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/operations/utils.ts#L25">operations/utils.ts:25</a></li>
|
| 1030 | </ul>
|
| 1031 | </aside>
|
| 1032 | </section>
|
| 1033 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-is-not-exported">
|
| 1034 | <a name="tx_input_base" class="tsd-anchor"></a>
|
| 1035 | <h3><span class="tsd-flag ts-flagConst">Const</span> TX_<wbr>INPUT_<wbr>BASE</h3>
|
| 1036 | <div class="tsd-signature tsd-kind-icon">TX_<wbr>INPUT_<wbr>BASE<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 32 + 4 + 1 + 4</span></div>
|
| 1037 | <aside class="tsd-sources">
|
| 1038 | <ul>
|
| 1039 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/operations/utils.ts#L26">operations/utils.ts:26</a></li>
|
| 1040 | </ul>
|
| 1041 | </aside>
|
| 1042 | </section>
|
| 1043 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-is-not-exported">
|
| 1044 | <a name="tx_input_pubkeyhash" class="tsd-anchor"></a>
|
| 1045 | <h3><span class="tsd-flag ts-flagConst">Const</span> TX_<wbr>INPUT_<wbr>PUBKEYHASH</h3>
|
| 1046 | <div class="tsd-signature tsd-kind-icon">TX_<wbr>INPUT_<wbr>PUBKEYHASH<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">107</span><span class="tsd-signature-symbol"> = 107</span></div>
|
| 1047 | <aside class="tsd-sources">
|
| 1048 | <ul>
|
| 1049 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/operations/utils.ts#L27">operations/utils.ts:27</a></li>
|
| 1050 | </ul>
|
| 1051 | </aside>
|
| 1052 | </section>
|
| 1053 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-is-not-exported">
|
| 1054 | <a name="tx_output_base" class="tsd-anchor"></a>
|
| 1055 | <h3><span class="tsd-flag ts-flagConst">Const</span> TX_<wbr>OUTPUT_<wbr>BASE</h3>
|
| 1056 | <div class="tsd-signature tsd-kind-icon">TX_<wbr>OUTPUT_<wbr>BASE<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 8 + 1</span></div>
|
| 1057 | <aside class="tsd-sources">
|
| 1058 | <ul>
|
| 1059 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/operations/utils.ts#L28">operations/utils.ts:28</a></li>
|
| 1060 | </ul>
|
| 1061 | </aside>
|
| 1062 | </section>
|
| 1063 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-is-not-exported">
|
| 1064 | <a name="tx_output_pubkeyhash" class="tsd-anchor"></a>
|
| 1065 | <h3><span class="tsd-flag ts-flagConst">Const</span> TX_<wbr>OUTPUT_<wbr>PUBKEYHASH</h3>
|
| 1066 | <div class="tsd-signature tsd-kind-icon">TX_<wbr>OUTPUT_<wbr>PUBKEYHASH<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">25</span><span class="tsd-signature-symbol"> = 25</span></div>
|
| 1067 | <aside class="tsd-sources">
|
| 1068 | <ul>
|
| 1069 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/operations/utils.ts#L29">operations/utils.ts:29</a></li>
|
| 1070 | </ul>
|
| 1071 | </aside>
|
| 1072 | </section>
|
| 1073 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-is-not-exported">
|
| 1074 | <a name="version" class="tsd-anchor"></a>
|
| 1075 | <h3><span class="tsd-flag ts-flagConst">Const</span> VERSION</h3>
|
| 1076 | <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>
|
| 1077 | <aside class="tsd-sources">
|
| 1078 | <ul>
|
| 1079 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/auth/authMessages.ts#L15">auth/authMessages.ts:15</a></li>
|
| 1080 | </ul>
|
| 1081 | </aside>
|
| 1082 | </section>
|
| 1083 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-is-not-exported">
|
| 1084 | <a name="dummyconsensushash" class="tsd-anchor"></a>
|
| 1085 | <h3><span class="tsd-flag ts-flagConst">Const</span> dummy<wbr>Consensus<wbr>Hash</h3>
|
| 1086 | <div class="tsd-signature tsd-kind-icon">dummy<wbr>Consensus<wbr>Hash<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"</span><span class="tsd-signature-symbol"> = "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"</span></div>
|
| 1087 | <aside class="tsd-sources">
|
| 1088 | <ul>
|
| 1089 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/operations/txbuild.ts#L24">operations/txbuild.ts:24</a></li>
|
| 1090 | </ul>
|
| 1091 | </aside>
|
| 1092 | </section>
|
| 1093 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-is-not-exported">
|
| 1094 | <a name="dummyzonefilehash" class="tsd-anchor"></a>
|
| 1095 | <h3><span class="tsd-flag ts-flagConst">Const</span> dummy<wbr>Zonefile<wbr>Hash</h3>
|
| 1096 | <div class="tsd-signature tsd-kind-icon">dummy<wbr>Zonefile<wbr>Hash<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ffffffffffffffffffffffffffffffffffffffff"</span><span class="tsd-signature-symbol"> = "ffffffffffffffffffffffffffffffffffffffff"</span></div>
|
| 1097 | <aside class="tsd-sources">
|
| 1098 | <ul>
|
| 1099 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/operations/txbuild.ts#L25">operations/txbuild.ts:25</a></li>
|
| 1100 | </ul>
|
| 1101 | </aside>
|
| 1102 | </section>
|
| 1103 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-is-not-exported">
|
| 1104 | <a name="ecurve" class="tsd-anchor"></a>
|
| 1105 | <h3><span class="tsd-flag ts-flagConst">Const</span> ecurve</h3>
|
| 1106 | <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>
|
| 1107 | <aside class="tsd-sources">
|
| 1108 | <ul>
|
| 1109 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/encryption/ec.ts#L7">encryption/ec.ts:7</a></li>
|
| 1110 | </ul>
|
| 1111 | </aside>
|
| 1112 | </section>
|
| 1113 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-is-not-exported">
|
| 1114 | <a name="inttolevel" class="tsd-anchor"></a>
|
| 1115 | <h3><span class="tsd-flag ts-flagConst">Const</span> int<wbr>ToLevel</h3>
|
| 1116 | <div class="tsd-signature tsd-kind-icon">int<wbr>ToLevel<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
|
| 1117 | <aside class="tsd-sources">
|
| 1118 | <ul>
|
| 1119 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/logger.ts#L12">logger.ts:12</a></li>
|
| 1120 | </ul>
|
| 1121 | </aside>
|
| 1122 | <div class="tsd-type-declaration">
|
| 1123 | <h4>Type declaration</h4>
|
| 1124 | <ul class="tsd-parameters">
|
| 1125 | <li class="tsd-parameter-index-signature">
|
| 1126 | <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>
|
| 1127 | </li>
|
| 1128 | </ul>
|
| 1129 | </div>
|
| 1130 | </section>
|
| 1131 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-is-not-exported">
|
| 1132 | <a name="leveltoint" class="tsd-anchor"></a>
|
| 1133 | <h3><span class="tsd-flag ts-flagConst">Const</span> level<wbr>ToInt</h3>
|
| 1134 | <div class="tsd-signature tsd-kind-icon">level<wbr>ToInt<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
|
| 1135 | <aside class="tsd-sources">
|
| 1136 | <ul>
|
| 1137 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/logger.ts#L11">logger.ts:11</a></li>
|
| 1138 | </ul>
|
| 1139 | </aside>
|
| 1140 | <div class="tsd-type-declaration">
|
| 1141 | <h4>Type declaration</h4>
|
| 1142 | <ul class="tsd-parameters">
|
| 1143 | <li class="tsd-parameter-index-signature">
|
| 1144 | <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>
|
| 1145 | </li>
|
| 1146 | </ul>
|
| 1147 | </div>
|
| 1148 | </section>
|
| 1149 | <section class="tsd-panel tsd-member tsd-kind-variable">
|
| 1150 | <a name="levels" class="tsd-anchor"></a>
|
| 1151 | <h3><span class="tsd-flag ts-flagConst">Const</span> levels</h3>
|
| 1152 | <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>
|
| 1153 | <aside class="tsd-sources">
|
| 1154 | <ul>
|
| 1155 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/logger.ts#L3">logger.ts:3</a></li>
|
| 1156 | </ul>
|
| 1157 | </aside>
|
| 1158 | </section>
|
| 1159 | </section>
|
| 1160 | <section class="tsd-panel-group tsd-member-group ">
|
| 1161 | <h2>Functions</h2>
|
| 1162 | <section class="tsd-panel tsd-member tsd-kind-function tsd-is-not-exported">
|
| 1163 | <a name="addownerinput" class="tsd-anchor"></a>
|
| 1164 | <h3>add<wbr>Owner<wbr>Input</h3>
|
| 1165 | <ul class="tsd-signatures tsd-kind-function tsd-is-not-exported">
|
| 1166 | <li class="tsd-signature tsd-kind-icon">add<wbr>Owner<wbr>Input<span class="tsd-signature-symbol">(</span>utxos<span class="tsd-signature-symbol">: </span><a href="globals.html#utxo" class="tsd-signature-type">UTXO</a><span class="tsd-signature-symbol">[]</span>, ownerAddress<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, txB<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">bitcoinjs.TransactionBuilder</span>, addChangeOut<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">object</span></li>
|
| 1167 | </ul>
|
| 1168 | <ul class="tsd-descriptions">
|
| 1169 | <li class="tsd-description">
|
| 1170 | <aside class="tsd-sources">
|
| 1171 | <ul>
|
| 1172 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/operations/txbuild.ts#L27">operations/txbuild.ts:27</a></li>
|
| 1173 | </ul>
|
| 1174 | </aside>
|
| 1175 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 1176 | <ul class="tsd-parameters">
|
| 1177 | <li>
|
| 1178 | <h5>utxos: <a href="globals.html#utxo" class="tsd-signature-type">UTXO</a><span class="tsd-signature-symbol">[]</span></h5>
|
| 1179 | </li>
|
| 1180 | <li>
|
| 1181 | <h5>ownerAddress: <span class="tsd-signature-type">string</span></h5>
|
| 1182 | </li>
|
| 1183 | <li>
|
| 1184 | <h5>txB: <span class="tsd-signature-type">bitcoinjs.TransactionBuilder</span></h5>
|
| 1185 | </li>
|
| 1186 | <li>
|
| 1187 | <h5><span class="tsd-flag ts-flagDefault value">Default value</span> addChangeOut: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></h5>
|
| 1188 | </li>
|
| 1189 | </ul>
|
| 1190 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">object</span></h4>
|
| 1191 | <ul class="tsd-parameters">
|
| 1192 | <li class="tsd-parameter">
|
| 1193 | <h5>index<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
|
| 1194 | </li>
|
| 1195 | <li class="tsd-parameter">
|
| 1196 | <h5>value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
|
| 1197 | </li>
|
| 1198 | </ul>
|
| 1199 | </li>
|
| 1200 | </ul>
|
| 1201 | </section>
|
| 1202 | <section class="tsd-panel tsd-member tsd-kind-function tsd-is-private">
|
| 1203 | <a name="addutxostofund" class="tsd-anchor"></a>
|
| 1204 | <h3><span class="tsd-flag ts-flagPrivate">Private</span> addUTXOs<wbr>ToFund</h3>
|
| 1205 | <ul class="tsd-signatures tsd-kind-function tsd-is-private">
|
| 1206 | <li class="tsd-signature tsd-kind-icon">addUTXOs<wbr>ToFund<span class="tsd-signature-symbol">(</span>txBuilderIn<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">bitcoinjs.TransactionBuilder</span>, utxos<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><a href="globals.html#utxo" class="tsd-signature-type">UTXO</a><span class="tsd-signature-symbol">></span>, amountToFund<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, feeRate<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, fundNewFees<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">number</span></li>
|
| 1207 | </ul>
|
| 1208 | <ul class="tsd-descriptions">
|
| 1209 | <li class="tsd-description">
|
| 1210 | <aside class="tsd-sources">
|
| 1211 | <ul>
|
| 1212 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/operations/utils.ts#L133">operations/utils.ts:133</a></li>
|
| 1213 | </ul>
|
| 1214 | </aside>
|
| 1215 | <div class="tsd-comment tsd-typography">
|
| 1216 | <div class="lead">
|
| 1217 | <p>Adds UTXOs to fund a transaction</p>
|
| 1218 | </div>
|
| 1219 | </div>
|
| 1220 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 1221 | <ul class="tsd-parameters">
|
| 1222 | <li>
|
| 1223 | <h5>txBuilderIn: <span class="tsd-signature-type">bitcoinjs.TransactionBuilder</span></h5>
|
| 1224 | <div class="tsd-comment tsd-typography">
|
| 1225 | <p>a transaction builder object to add the inputs to. this
|
| 1226 | object is <em>always</em> mutated. If not enough UTXOs exist to fund, the tx builder object
|
| 1227 | will still contain as many inputs as could be found.</p>
|
| 1228 | </div>
|
| 1229 | </li>
|
| 1230 | <li>
|
| 1231 | <h5>utxos: <span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><a href="globals.html#utxo" class="tsd-signature-type">UTXO</a><span class="tsd-signature-symbol">></span></h5>
|
| 1232 | </li>
|
| 1233 | <li>
|
| 1234 | <h5>amountToFund: <span class="tsd-signature-type">number</span></h5>
|
| 1235 | <div class="tsd-comment tsd-typography">
|
| 1236 | <p>the amount of satoshis to fund in the transaction. the payer's
|
| 1237 | utxos will be included to fund up to this amount of <em>output</em> and the corresponding <em>fees</em>
|
| 1238 | for those additional inputs</p>
|
| 1239 | </div>
|
| 1240 | </li>
|
| 1241 | <li>
|
| 1242 | <h5>feeRate: <span class="tsd-signature-type">number</span></h5>
|
| 1243 | <div class="tsd-comment tsd-typography">
|
| 1244 | <p>the satoshis/byte fee rate to use for fee calculation</p>
|
| 1245 | </div>
|
| 1246 | </li>
|
| 1247 | <li>
|
| 1248 | <h5><span class="tsd-flag ts-flagDefault value">Default value</span> fundNewFees: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></h5>
|
| 1249 | <div class="tsd-comment tsd-typography">
|
| 1250 | <p>if true, this function will fund <code>amountToFund</code> and any new fees
|
| 1251 | associated with including the new inputs.
|
| 1252 | if false, this function will fund <em>at most</em> <code>amountToFund</code></p>
|
| 1253 | </div>
|
| 1254 | </li>
|
| 1255 | </ul>
|
| 1256 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
|
| 1257 | <ul>
|
| 1258 | <li>the amount of leftover change (in satoshis)</li>
|
| 1259 | </ul>
|
| 1260 | </li>
|
| 1261 | </ul>
|
| 1262 | </section>
|
| 1263 | <section class="tsd-panel tsd-member tsd-kind-function tsd-is-not-exported">
|
| 1264 | <a name="addresscanreceivename" class="tsd-anchor"></a>
|
| 1265 | <h3>address<wbr>Can<wbr>Receive<wbr>Name</h3>
|
| 1266 | <ul class="tsd-signatures tsd-kind-function tsd-is-not-exported">
|
| 1267 | <li class="tsd-signature tsd-kind-icon">address<wbr>Can<wbr>Receive<wbr>Name<span class="tsd-signature-symbol">(</span>address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></li>
|
| 1268 | </ul>
|
| 1269 | <ul class="tsd-descriptions">
|
| 1270 | <li class="tsd-description">
|
| 1271 | <aside class="tsd-sources">
|
| 1272 | <ul>
|
| 1273 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/operations/safety.ts#L127">operations/safety.ts:127</a></li>
|
| 1274 | </ul>
|
| 1275 | </aside>
|
| 1276 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 1277 | <ul class="tsd-parameters">
|
| 1278 | <li>
|
| 1279 | <h5>address: <span class="tsd-signature-type">string</span></h5>
|
| 1280 | </li>
|
| 1281 | </ul>
|
| 1282 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></h4>
|
| 1283 | </li>
|
| 1284 | </ul>
|
| 1285 | </section>
|
| 1286 | <section class="tsd-panel tsd-member tsd-kind-function tsd-is-not-exported">
|
| 1287 | <a name="aes256cbcdecrypt" class="tsd-anchor"></a>
|
| 1288 | <h3>aes256<wbr>Cbc<wbr>Decrypt</h3>
|
| 1289 | <ul class="tsd-signatures tsd-kind-function tsd-is-not-exported">
|
| 1290 | <li class="tsd-signature tsd-kind-icon">aes256<wbr>Cbc<wbr>Decrypt<span class="tsd-signature-symbol">(</span>iv<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span>, key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span>, ciphertext<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>
|
| 1291 | </ul>
|
| 1292 | <ul class="tsd-descriptions">
|
| 1293 | <li class="tsd-description">
|
| 1294 | <aside class="tsd-sources">
|
| 1295 | <ul>
|
| 1296 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/encryption/ec.ts#L22">encryption/ec.ts:22</a></li>
|
| 1297 | </ul>
|
| 1298 | </aside>
|
| 1299 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 1300 | <ul class="tsd-parameters">
|
| 1301 | <li>
|
| 1302 | <h5>iv: <span class="tsd-signature-type">Buffer</span></h5>
|
| 1303 | </li>
|
| 1304 | <li>
|
| 1305 | <h5>key: <span class="tsd-signature-type">Buffer</span></h5>
|
| 1306 | </li>
|
| 1307 | <li>
|
| 1308 | <h5>ciphertext: <span class="tsd-signature-type">Buffer</span></h5>
|
| 1309 | </li>
|
| 1310 | </ul>
|
| 1311 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Buffer</span></h4>
|
| 1312 | </li>
|
| 1313 | </ul>
|
| 1314 | </section>
|
| 1315 | <section class="tsd-panel tsd-member tsd-kind-function tsd-is-not-exported">
|
| 1316 | <a name="aes256cbcencrypt" class="tsd-anchor"></a>
|
| 1317 | <h3>aes256<wbr>Cbc<wbr>Encrypt</h3>
|
| 1318 | <ul class="tsd-signatures tsd-kind-function tsd-is-not-exported">
|
| 1319 | <li class="tsd-signature tsd-kind-icon">aes256<wbr>Cbc<wbr>Encrypt<span class="tsd-signature-symbol">(</span>iv<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span>, key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span>, plaintext<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>
|
| 1320 | </ul>
|
| 1321 | <ul class="tsd-descriptions">
|
| 1322 | <li class="tsd-description">
|
| 1323 | <aside class="tsd-sources">
|
| 1324 | <ul>
|
| 1325 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/encryption/ec.ts#L17">encryption/ec.ts:17</a></li>
|
| 1326 | </ul>
|
| 1327 | </aside>
|
| 1328 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 1329 | <ul class="tsd-parameters">
|
| 1330 | <li>
|
| 1331 | <h5>iv: <span class="tsd-signature-type">Buffer</span></h5>
|
| 1332 | </li>
|
| 1333 | <li>
|
| 1334 | <h5>key: <span class="tsd-signature-type">Buffer</span></h5>
|
| 1335 | </li>
|
| 1336 | <li>
|
| 1337 | <h5>plaintext: <span class="tsd-signature-type">Buffer</span></h5>
|
| 1338 | </li>
|
| 1339 | </ul>
|
| 1340 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Buffer</span></h4>
|
| 1341 | </li>
|
| 1342 | </ul>
|
| 1343 | </section>
|
| 1344 | <section class="tsd-panel tsd-member tsd-kind-function tsd-is-not-exported">
|
| 1345 | <a name="asamountv2" class="tsd-anchor"></a>
|
| 1346 | <h3>as<wbr>Amount<wbr>V2</h3>
|
| 1347 | <ul class="tsd-signatures tsd-kind-function tsd-is-not-exported">
|
| 1348 | <li class="tsd-signature tsd-kind-icon">as<wbr>Amount<wbr>V2<span class="tsd-signature-symbol">(</span>amount<span class="tsd-signature-symbol">: </span><a href="globals.html#amounttype" class="tsd-signature-type">AmountType</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="globals.html#amounttypev2" class="tsd-signature-type">AmountTypeV2</a></li>
|
| 1349 | </ul>
|
| 1350 | <ul class="tsd-descriptions">
|
| 1351 | <li class="tsd-description">
|
| 1352 | <aside class="tsd-sources">
|
| 1353 | <ul>
|
| 1354 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/operations/skeletons.ts#L137">operations/skeletons.ts:137</a></li>
|
| 1355 | </ul>
|
| 1356 | </aside>
|
| 1357 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 1358 | <ul class="tsd-parameters">
|
| 1359 | <li>
|
| 1360 | <h5>amount: <a href="globals.html#amounttype" class="tsd-signature-type">AmountType</a></h5>
|
| 1361 | </li>
|
| 1362 | </ul>
|
| 1363 | <h4 class="tsd-returns-title">Returns <a href="globals.html#amounttypev2" class="tsd-signature-type">AmountTypeV2</a></h4>
|
| 1364 | </li>
|
| 1365 | </ul>
|
| 1366 | </section>
|
| 1367 | <section class="tsd-panel tsd-member tsd-kind-function">
|
| 1368 | <a name="connecttogaiahub" class="tsd-anchor"></a>
|
| 1369 | <h3>connect<wbr>ToGaia<wbr>Hub</h3>
|
| 1370 | <ul class="tsd-signatures tsd-kind-function">
|
| 1371 | <li class="tsd-signature tsd-kind-icon">connect<wbr>ToGaia<wbr>Hub<span class="tsd-signature-symbol">(</span>gaiaHubUrl<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, challengeSignerHex<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, associationToken<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#gaiahubconfig" class="tsd-signature-type">GaiaHubConfig</a><span class="tsd-signature-symbol">></span></li>
|
| 1372 | </ul>
|
| 1373 | <ul class="tsd-descriptions">
|
| 1374 | <li class="tsd-description">
|
| 1375 | <aside class="tsd-sources">
|
| 1376 | <ul>
|
| 1377 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/storage/hub.ts#L106">storage/hub.ts:106</a></li>
|
| 1378 | </ul>
|
| 1379 | </aside>
|
| 1380 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 1381 | <ul class="tsd-parameters">
|
| 1382 | <li>
|
| 1383 | <h5>gaiaHubUrl: <span class="tsd-signature-type">string</span></h5>
|
| 1384 | </li>
|
| 1385 | <li>
|
| 1386 | <h5>challengeSignerHex: <span class="tsd-signature-type">string</span></h5>
|
| 1387 | </li>
|
| 1388 | <li>
|
| 1389 | <h5><span class="tsd-flag ts-flagOptional">Optional</span> associationToken: <span class="tsd-signature-type">string</span></h5>
|
| 1390 | </li>
|
| 1391 | </ul>
|
| 1392 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="globals.html#gaiahubconfig" class="tsd-signature-type">GaiaHubConfig</a><span class="tsd-signature-symbol">></span></h4>
|
| 1393 | </li>
|
| 1394 | </ul>
|
| 1395 | </section>
|
| 1396 | <section class="tsd-panel tsd-member tsd-kind-function">
|
| 1397 | <a name="containsvalidaddressproofstatement" class="tsd-anchor"></a>
|
| 1398 | <h3>contains<wbr>Valid<wbr>Address<wbr>Proof<wbr>Statement</h3>
|
| 1399 | <ul class="tsd-signatures tsd-kind-function">
|
| 1400 | <li class="tsd-signature tsd-kind-icon">contains<wbr>Valid<wbr>Address<wbr>Proof<wbr>Statement<span class="tsd-signature-symbol">(</span>proofStatement<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
|
| 1401 | </ul>
|
| 1402 | <ul class="tsd-descriptions">
|
| 1403 | <li class="tsd-description">
|
| 1404 | <aside class="tsd-sources">
|
| 1405 | <ul>
|
| 1406 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/services/serviceUtils.ts#L55">profiles/services/serviceUtils.ts:55</a></li>
|
| 1407 | </ul>
|
| 1408 | </aside>
|
| 1409 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 1410 | <ul class="tsd-parameters">
|
| 1411 | <li>
|
| 1412 | <h5>proofStatement: <span class="tsd-signature-type">string</span></h5>
|
| 1413 | </li>
|
| 1414 | <li>
|
| 1415 | <h5>address: <span class="tsd-signature-type">string</span></h5>
|
| 1416 | </li>
|
| 1417 | </ul>
|
| 1418 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
|
| 1419 | </li>
|
| 1420 | </ul>
|
| 1421 | </section>
|
| 1422 | <section class="tsd-panel tsd-member tsd-kind-function">
|
| 1423 | <a name="containsvalidproofstatement" class="tsd-anchor"></a>
|
| 1424 | <h3>contains<wbr>Valid<wbr>Proof<wbr>Statement</h3>
|
| 1425 | <ul class="tsd-signatures tsd-kind-function">
|
| 1426 | <li class="tsd-signature tsd-kind-icon">contains<wbr>Valid<wbr>Proof<wbr>Statement<span class="tsd-signature-symbol">(</span>searchText<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</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-type">null</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
|
| 1427 | </ul>
|
| 1428 | <ul class="tsd-descriptions">
|
| 1429 | <li class="tsd-description">
|
| 1430 | <aside class="tsd-sources">
|
| 1431 | <ul>
|
| 1432 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/services/serviceUtils.ts#L2">profiles/services/serviceUtils.ts:2</a></li>
|
| 1433 | </ul>
|
| 1434 | </aside>
|
| 1435 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 1436 | <ul class="tsd-parameters">
|
| 1437 | <li>
|
| 1438 | <h5>searchText: <span class="tsd-signature-type">string</span></h5>
|
| 1439 | </li>
|
| 1440 | <li>
|
| 1441 | <h5><span class="tsd-flag ts-flagDefault value">Default value</span> name: <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>
|
| 1442 | </li>
|
| 1443 | </ul>
|
| 1444 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
|
| 1445 | </li>
|
| 1446 | </ul>
|
| 1447 | </section>
|
| 1448 | <section class="tsd-panel tsd-member tsd-kind-function">
|
| 1449 | <a name="decodeb40" class="tsd-anchor"></a>
|
| 1450 | <h3>decode<wbr>B40</h3>
|
| 1451 | <ul class="tsd-signatures tsd-kind-function">
|
| 1452 | <li class="tsd-signature tsd-kind-icon">decode<wbr>B40<span class="tsd-signature-symbol">(</span>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><span class="tsd-signature-type">string</span></li>
|
| 1453 | </ul>
|
| 1454 | <ul class="tsd-descriptions">
|
| 1455 | <li class="tsd-description">
|
| 1456 | <aside class="tsd-sources">
|
| 1457 | <ul>
|
| 1458 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/operations/utils.ts#L90">operations/utils.ts:90</a></li>
|
| 1459 | </ul>
|
| 1460 | </aside>
|
| 1461 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 1462 | <ul class="tsd-parameters">
|
| 1463 | <li>
|
| 1464 | <h5>input: <span class="tsd-signature-type">string</span></h5>
|
| 1465 | </li>
|
| 1466 | </ul>
|
| 1467 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
|
| 1468 | </li>
|
| 1469 | </ul>
|
| 1470 | </section>
|
| 1471 | <section class="tsd-panel tsd-member tsd-kind-function">
|
| 1472 | <a name="decryptcontent" class="tsd-anchor"></a>
|
| 1473 | <h3>decrypt<wbr>Content</h3>
|
| 1474 | <ul class="tsd-signatures tsd-kind-function">
|
| 1475 | <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">object</span>, caller<span class="tsd-signature-symbol">?: </span><a href="classes/usersession.html" class="tsd-signature-type">UserSession</a><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">Buffer</span></li>
|
| 1476 | </ul>
|
| 1477 | <ul class="tsd-descriptions">
|
| 1478 | <li class="tsd-description">
|
| 1479 | <aside class="tsd-sources">
|
| 1480 | <ul>
|
| 1481 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/storage/index.ts#L101">storage/index.ts:101</a></li>
|
| 1482 | </ul>
|
| 1483 | </aside>
|
| 1484 | <div class="tsd-comment tsd-typography">
|
| 1485 | <div class="lead">
|
| 1486 | <p>Decrypts data encrypted with <code>encryptContent</code> with the
|
| 1487 | transit private key.</p>
|
| 1488 | </div>
|
| 1489 | </div>
|
| 1490 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 1491 | <ul class="tsd-parameters">
|
| 1492 | <li>
|
| 1493 | <h5>content: <span class="tsd-signature-type">string</span></h5>
|
| 1494 | <div class="tsd-comment tsd-typography">
|
| 1495 | <p>encrypted content.</p>
|
| 1496 | </div>
|
| 1497 | </li>
|
| 1498 | <li>
|
| 1499 | <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">object</span></h5>
|
| 1500 | <ul class="tsd-parameters">
|
| 1501 | <li class="tsd-parameter">
|
| 1502 | <h5><span class="tsd-flag ts-flagOptional">Optional</span> private<wbr>Key<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5>
|
| 1503 | <div class="tsd-comment tsd-typography">
|
| 1504 | <p>the hex string of the ECDSA private
|
| 1505 | key to use for decryption. If not provided, will use user's appPrivateKey.</p>
|
| 1506 | </div>
|
| 1507 | </li>
|
| 1508 | </ul>
|
| 1509 | </li>
|
| 1510 | <li>
|
| 1511 | <h5><span class="tsd-flag ts-flagOptional">Optional</span> caller: <a href="classes/usersession.html" class="tsd-signature-type">UserSession</a></h5>
|
| 1512 | </li>
|
| 1513 | </ul>
|
| 1514 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span>
|
| 1515 | <span class="tsd-signature-symbol"> | </span>
|
| 1516 | <span class="tsd-signature-type">Buffer</span>
|
| 1517 | </h4>
|
| 1518 | <p>decrypted content.</p>
|
| 1519 | </li>
|
| 1520 | </ul>
|
| 1521 | </section>
|
| 1522 | <section class="tsd-panel tsd-member tsd-kind-function tsd-is-private">
|
| 1523 | <a name="decryptecies" class="tsd-anchor"></a>
|
| 1524 | <h3><span class="tsd-flag ts-flagPrivate">Private</span> decryptECIES</h3>
|
| 1525 | <ul class="tsd-signatures tsd-kind-function tsd-is-private">
|
| 1526 | <li class="tsd-signature tsd-kind-icon">decryptECIES<span class="tsd-signature-symbol">(</span>privateKey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, cipherObject<span class="tsd-signature-symbol">: </span><a href="globals.html#cipherobject" class="tsd-signature-type">CipherObject</a><span class="tsd-signature-symbol">)</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">string</span></li>
|
| 1527 | </ul>
|
| 1528 | <ul class="tsd-descriptions">
|
| 1529 | <li class="tsd-description">
|
| 1530 | <aside class="tsd-sources">
|
| 1531 | <ul>
|
| 1532 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/encryption/ec.ts#L123">encryption/ec.ts:123</a></li>
|
| 1533 | </ul>
|
| 1534 | </aside>
|
| 1535 | <div class="tsd-comment tsd-typography">
|
| 1536 | <div class="lead">
|
| 1537 | <p>Decrypt content encrypted using ECIES</p>
|
| 1538 | </div>
|
| 1539 | <dl class="tsd-comment-tags">
|
| 1540 | <dt>throws</dt>
|
| 1541 | <dd><p>{Error} if unable to decrypt</p>
|
| 1542 | </dd>
|
| 1543 | </dl>
|
| 1544 | </div>
|
| 1545 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 1546 | <ul class="tsd-parameters">
|
| 1547 | <li>
|
| 1548 | <h5>privateKey: <span class="tsd-signature-type">string</span></h5>
|
| 1549 | <div class="tsd-comment tsd-typography">
|
| 1550 | <p>secp256k1 private key hex string</p>
|
| 1551 | </div>
|
| 1552 | </li>
|
| 1553 | <li>
|
| 1554 | <h5>cipherObject: <a href="globals.html#cipherobject" class="tsd-signature-type">CipherObject</a></h5>
|
| 1555 | <div class="tsd-comment tsd-typography">
|
| 1556 | <p>object to decrypt, should contain:
|
| 1557 | iv (initialization vector), cipherText (cipher text),
|
| 1558 | mac (message authentication code), ephemeralPublicKey
|
| 1559 | wasString (boolean indicating with or not to return a buffer or string on decrypt)</p>
|
| 1560 | </div>
|
| 1561 | </li>
|
| 1562 | </ul>
|
| 1563 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Buffer</span>
|
| 1564 | <span class="tsd-signature-symbol"> | </span>
|
| 1565 | <span class="tsd-signature-type">string</span>
|
| 1566 | </h4>
|
| 1567 | <p>plaintext</p>
|
| 1568 | </li>
|
| 1569 | </ul>
|
| 1570 | </section>
|
| 1571 | <section class="tsd-panel tsd-member tsd-kind-function tsd-is-private tsd-is-not-exported">
|
| 1572 | <a name="decryptlegacy" class="tsd-anchor"></a>
|
| 1573 | <h3><span class="tsd-flag ts-flagPrivate">Private</span> decrypt<wbr>Legacy</h3>
|
| 1574 | <ul class="tsd-signatures tsd-kind-function tsd-is-private tsd-is-not-exported">
|
| 1575 | <li class="tsd-signature tsd-kind-icon">decrypt<wbr>Legacy<span class="tsd-signature-symbol">(</span>dataBuffer<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">Buffer</span><span class="tsd-signature-symbol">></span></li>
|
| 1576 | </ul>
|
| 1577 | <ul class="tsd-descriptions">
|
| 1578 | <li class="tsd-description">
|
| 1579 | <aside class="tsd-sources">
|
| 1580 | <ul>
|
| 1581 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/encryption/wallet.ts#L103">encryption/wallet.ts:103</a></li>
|
| 1582 | </ul>
|
| 1583 | </aside>
|
| 1584 | <div class="tsd-comment tsd-typography">
|
| 1585 | <div class="lead">
|
| 1586 | <p>Decrypt legacy triplesec keys</p>
|
| 1587 | </div>
|
| 1588 | </div>
|
| 1589 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 1590 | <ul class="tsd-parameters">
|
| 1591 | <li>
|
| 1592 | <h5>dataBuffer: <span class="tsd-signature-type">Buffer</span></h5>
|
| 1593 | <div class="tsd-comment tsd-typography">
|
| 1594 | <p>The encrypted key</p>
|
| 1595 | </div>
|
| 1596 | </li>
|
| 1597 | <li>
|
| 1598 | <h5>password: <span class="tsd-signature-type">string</span></h5>
|
| 1599 | <div class="tsd-comment tsd-typography">
|
| 1600 | <p>Password for data</p>
|
| 1601 | </div>
|
| 1602 | </li>
|
| 1603 | </ul>
|
| 1604 | <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>
|
| 1605 | <p>Decrypted seed</p>
|
| 1606 | </li>
|
| 1607 | </ul>
|
| 1608 | </section>
|
| 1609 | <section class="tsd-panel tsd-member tsd-kind-function tsd-is-private">
|
| 1610 | <a name="decryptmnemonic" class="tsd-anchor"></a>
|
| 1611 | <h3><span class="tsd-flag ts-flagPrivate">Private</span> decrypt<wbr>Mnemonic</h3>
|
| 1612 | <ul class="tsd-signatures tsd-kind-function tsd-is-private">
|
| 1613 | <li class="tsd-signature tsd-kind-icon">decrypt<wbr>Mnemonic<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-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>
|
| 1614 | </ul>
|
| 1615 | <ul class="tsd-descriptions">
|
| 1616 | <li class="tsd-description">
|
| 1617 | <aside class="tsd-sources">
|
| 1618 | <ul>
|
| 1619 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/encryption/wallet.ts#L128">encryption/wallet.ts:128</a></li>
|
| 1620 | </ul>
|
| 1621 | </aside>
|
| 1622 | <div class="tsd-comment tsd-typography">
|
| 1623 | <div class="lead">
|
| 1624 | <p>Encrypt a raw mnemonic phrase with a password</p>
|
| 1625 | </div>
|
| 1626 | </div>
|
| 1627 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 1628 | <ul class="tsd-parameters">
|
| 1629 | <li>
|
| 1630 | <h5>data: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Buffer</span></h5>
|
| 1631 | <div class="tsd-comment tsd-typography">
|
| 1632 | <p>Buffer or hex-encoded string of the encrypted mnemonic</p>
|
| 1633 | </div>
|
| 1634 | </li>
|
| 1635 | <li>
|
| 1636 | <h5>password: <span class="tsd-signature-type">string</span></h5>
|
| 1637 | <div class="tsd-comment tsd-typography">
|
| 1638 | <p>Password for data</p>
|
| 1639 | </div>
|
| 1640 | </li>
|
| 1641 | </ul>
|
| 1642 | <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>
|
| 1643 | <p>the raw mnemonic phrase</p>
|
| 1644 | </li>
|
| 1645 | </ul>
|
| 1646 | </section>
|
| 1647 | <section class="tsd-panel tsd-member tsd-kind-function tsd-is-not-exported">
|
| 1648 | <a name="decryptmnemonicbuffer" class="tsd-anchor"></a>
|
| 1649 | <h3>decrypt<wbr>Mnemonic<wbr>Buffer</h3>
|
| 1650 | <ul class="tsd-signatures tsd-kind-function tsd-is-not-exported">
|
| 1651 | <li class="tsd-signature tsd-kind-icon">decrypt<wbr>Mnemonic<wbr>Buffer<span class="tsd-signature-symbol">(</span>dataBuffer<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>
|
| 1652 | </ul>
|
| 1653 | <ul class="tsd-descriptions">
|
| 1654 | <li class="tsd-description">
|
| 1655 | <aside class="tsd-sources">
|
| 1656 | <ul>
|
| 1657 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/encryption/wallet.ts#L49">encryption/wallet.ts:49</a></li>
|
| 1658 | </ul>
|
| 1659 | </aside>
|
| 1660 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 1661 | <ul class="tsd-parameters">
|
| 1662 | <li>
|
| 1663 | <h5>dataBuffer: <span class="tsd-signature-type">Buffer</span></h5>
|
| 1664 | </li>
|
| 1665 | <li>
|
| 1666 | <h5>password: <span class="tsd-signature-type">string</span></h5>
|
| 1667 | </li>
|
| 1668 | </ul>
|
| 1669 | <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>
|
| 1670 | </li>
|
| 1671 | </ul>
|
| 1672 | </section>
|
| 1673 | <section class="tsd-panel tsd-member tsd-kind-function tsd-is-private">
|
| 1674 | <a name="decryptprivatekey" class="tsd-anchor"></a>
|
| 1675 | <h3><span class="tsd-flag ts-flagPrivate">Private</span> decrypt<wbr>Private<wbr>Key</h3>
|
| 1676 | <ul class="tsd-signatures tsd-kind-function tsd-is-private">
|
| 1677 | <li class="tsd-signature tsd-kind-icon">decrypt<wbr>Private<wbr>Key<span class="tsd-signature-symbol">(</span>privateKey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, hexedEncrypted<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>
|
| 1678 | </ul>
|
| 1679 | <ul class="tsd-descriptions">
|
| 1680 | <li class="tsd-description">
|
| 1681 | <aside class="tsd-sources">
|
| 1682 | <ul>
|
| 1683 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/auth/authMessages.ts#L146">auth/authMessages.ts:146</a></li>
|
| 1684 | </ul>
|
| 1685 | </aside>
|
| 1686 | <div class="tsd-comment tsd-typography">
|
| 1687 | <div class="lead">
|
| 1688 | <p>Decrypts the hex encrypted private key</p>
|
| 1689 | </div>
|
| 1690 | <dl class="tsd-comment-tags">
|
| 1691 | <dt>throws</dt>
|
| 1692 | <dd><p>{Error} if unable to decrypt</p>
|
| 1693 | </dd>
|
| 1694 | </dl>
|
| 1695 | </div>
|
| 1696 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 1697 | <ul class="tsd-parameters">
|
| 1698 | <li>
|
| 1699 | <h5>privateKey: <span class="tsd-signature-type">string</span></h5>
|
| 1700 | <div class="tsd-comment tsd-typography">
|
| 1701 | <p>the private key corresponding to the public
|
| 1702 | key for which the ciphertext was encrypted</p>
|
| 1703 | </div>
|
| 1704 | </li>
|
| 1705 | <li>
|
| 1706 | <h5>hexedEncrypted: <span class="tsd-signature-type">string</span></h5>
|
| 1707 | <div class="tsd-comment tsd-typography">
|
| 1708 | <p>the ciphertext</p>
|
| 1709 | </div>
|
| 1710 | </li>
|
| 1711 | </ul>
|
| 1712 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span>
|
| 1713 | <span class="tsd-signature-symbol"> | </span>
|
| 1714 | <span class="tsd-signature-type">null</span>
|
| 1715 | </h4>
|
| 1716 | <p>the decrypted private key</p>
|
| 1717 | </li>
|
| 1718 | </ul>
|
| 1719 | </section>
|
| 1720 | <section class="tsd-panel tsd-member tsd-kind-function">
|
| 1721 | <a name="deletefile" class="tsd-anchor"></a>
|
| 1722 | <h3>delete<wbr>File</h3>
|
| 1723 | <ul class="tsd-signatures tsd-kind-function">
|
| 1724 | <li class="tsd-signature tsd-kind-icon">delete<wbr>File<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>
|
| 1725 | </ul>
|
| 1726 | <ul class="tsd-descriptions">
|
| 1727 | <li class="tsd-description">
|
| 1728 | <aside class="tsd-sources">
|
| 1729 | <ul>
|
| 1730 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/storage/index.ts#L37">storage/index.ts:37</a></li>
|
| 1731 | </ul>
|
| 1732 | </aside>
|
| 1733 | <div class="tsd-comment tsd-typography">
|
| 1734 | <div class="lead">
|
| 1735 | <p>Deletes the specified file from the app's data store. Currently not implemented.</p>
|
| 1736 | </div>
|
| 1737 | </div>
|
| 1738 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 1739 | <ul class="tsd-parameters">
|
| 1740 | <li>
|
| 1741 | <h5>path: <span class="tsd-signature-type">string</span></h5>
|
| 1742 | <div class="tsd-comment tsd-typography">
|
| 1743 | <p>the path to the file to delete</p>
|
| 1744 | </div>
|
| 1745 | </li>
|
| 1746 | </ul>
|
| 1747 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
| 1748 | <p>that resolves when the file has been removed
|
| 1749 | or rejects with an error</p>
|
| 1750 | </li>
|
| 1751 | </ul>
|
| 1752 | </section>
|
| 1753 | <section class="tsd-panel tsd-member tsd-kind-function tsd-is-private">
|
| 1754 | <a name="dopublickeysmatchissuer" class="tsd-anchor"></a>
|
| 1755 | <h3><span class="tsd-flag ts-flagPrivate">Private</span> do<wbr>Public<wbr>Keys<wbr>Match<wbr>Issuer</h3>
|
| 1756 | <ul class="tsd-signatures tsd-kind-function tsd-is-private">
|
| 1757 | <li class="tsd-signature tsd-kind-icon">do<wbr>Public<wbr>Keys<wbr>Match<wbr>Issuer<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-type">boolean</span></li>
|
| 1758 | </ul>
|
| 1759 | <ul class="tsd-descriptions">
|
| 1760 | <li class="tsd-description">
|
| 1761 | <aside class="tsd-sources">
|
| 1762 | <ul>
|
| 1763 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/auth/authVerification.ts#L48">auth/authVerification.ts:48</a></li>
|
| 1764 | </ul>
|
| 1765 | </aside>
|
| 1766 | <div class="tsd-comment tsd-typography">
|
| 1767 | <div class="lead">
|
| 1768 | <p>Makes sure that the identity address portion of
|
| 1769 | the decentralized identifier passed in the issuer <code>iss</code>
|
| 1770 | key of the token matches the public key</p>
|
| 1771 | </div>
|
| 1772 | <dl class="tsd-comment-tags">
|
| 1773 | <dt>throws</dt>
|
| 1774 | <dd><p>{Error} if <code>token</code> has multiple public keys</p>
|
| 1775 | </dd>
|
| 1776 | </dl>
|
| 1777 | </div>
|
| 1778 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 1779 | <ul class="tsd-parameters">
|
| 1780 | <li>
|
| 1781 | <h5>token: <span class="tsd-signature-type">string</span></h5>
|
| 1782 | <div class="tsd-comment tsd-typography">
|
| 1783 | <p>encoded and signed authentication token</p>
|
| 1784 | </div>
|
| 1785 | </li>
|
| 1786 | </ul>
|
| 1787 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
|
| 1788 | <p>if the identity address and public keys match</p>
|
| 1789 | </li>
|
| 1790 | </ul>
|
| 1791 | </section>
|
| 1792 | <section class="tsd-panel tsd-member tsd-kind-function tsd-is-private">
|
| 1793 | <a name="dopublickeysmatchusername" class="tsd-anchor"></a>
|
| 1794 | <h3><span class="tsd-flag ts-flagPrivate">Private</span> do<wbr>Public<wbr>Keys<wbr>Match<wbr>Username</h3>
|
| 1795 | <ul class="tsd-signatures tsd-kind-function tsd-is-private">
|
| 1796 | <li class="tsd-signature tsd-kind-icon">do<wbr>Public<wbr>Keys<wbr>Match<wbr>Username<span class="tsd-signature-symbol">(</span>token<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, nameLookupURL<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">boolean</span><span class="tsd-signature-symbol">></span></li>
|
| 1797 | </ul>
|
| 1798 | <ul class="tsd-descriptions">
|
| 1799 | <li class="tsd-description">
|
| 1800 | <aside class="tsd-sources">
|
| 1801 | <ul>
|
| 1802 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/auth/authVerification.ts#L78">auth/authVerification.ts:78</a></li>
|
| 1803 | </ul>
|
| 1804 | </aside>
|
| 1805 | <div class="tsd-comment tsd-typography">
|
| 1806 | <div class="lead">
|
| 1807 | <p>Looks up the identity address that owns the claimed username
|
| 1808 | in <code>token</code> using the lookup endpoint provided in <code>nameLookupURL</code>
|
| 1809 | to determine if the username is owned by the identity address
|
| 1810 | that matches the claimed public key</p>
|
| 1811 | </div>
|
| 1812 | </div>
|
| 1813 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 1814 | <ul class="tsd-parameters">
|
| 1815 | <li>
|
| 1816 | <h5>token: <span class="tsd-signature-type">string</span></h5>
|
| 1817 | <div class="tsd-comment tsd-typography">
|
| 1818 | <p>encoded and signed authentication token</p>
|
| 1819 | </div>
|
| 1820 | </li>
|
| 1821 | <li>
|
| 1822 | <h5>nameLookupURL: <span class="tsd-signature-type">string</span></h5>
|
| 1823 | <div class="tsd-comment tsd-typography">
|
| 1824 | <p>a URL to the name lookup endpoint of the Blockstack Core API</p>
|
| 1825 | </div>
|
| 1826 | </li>
|
| 1827 | </ul>
|
| 1828 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></h4>
|
| 1829 | <p>returns a <code>Promise</code> that resolves to
|
| 1830 | <code>true</code> if the username is owned by the public key, otherwise the
|
| 1831 | <code>Promise</code> resolves to <code>false</code></p>
|
| 1832 | </li>
|
| 1833 | </ul>
|
| 1834 | </section>
|
| 1835 | <section class="tsd-panel tsd-member tsd-kind-function tsd-is-private">
|
| 1836 | <a name="dosignaturesmatchpublickeys" class="tsd-anchor"></a>
|
| 1837 | <h3><span class="tsd-flag ts-flagPrivate">Private</span> do<wbr>Signatures<wbr>Match<wbr>Public<wbr>Keys</h3>
|
| 1838 | <ul class="tsd-signatures tsd-kind-function tsd-is-private">
|
| 1839 | <li class="tsd-signature tsd-kind-icon">do<wbr>Signatures<wbr>Match<wbr>Public<wbr>Keys<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-type">boolean</span></li>
|
| 1840 | </ul>
|
| 1841 | <ul class="tsd-descriptions">
|
| 1842 | <li class="tsd-description">
|
| 1843 | <aside class="tsd-sources">
|
| 1844 | <ul>
|
| 1845 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/auth/authVerification.ts#L17">auth/authVerification.ts:17</a></li>
|
| 1846 | </ul>
|
| 1847 | </aside>
|
| 1848 | <div class="tsd-comment tsd-typography">
|
| 1849 | <div class="lead">
|
| 1850 | <p>Checks if the ES256k signature on passed <code>token</code> match the claimed public key
|
| 1851 | in the payload key <code>public_keys</code>.</p>
|
| 1852 | </div>
|
| 1853 | <dl class="tsd-comment-tags">
|
| 1854 | <dt>throws</dt>
|
| 1855 | <dd><p>{Error} if <code>token</code> contains multiple public keys</p>
|
| 1856 | </dd>
|
| 1857 | </dl>
|
| 1858 | </div>
|
| 1859 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 1860 | <ul class="tsd-parameters">
|
| 1861 | <li>
|
| 1862 | <h5>token: <span class="tsd-signature-type">string</span></h5>
|
| 1863 | <div class="tsd-comment tsd-typography">
|
| 1864 | <p>encoded and signed authentication token</p>
|
| 1865 | </div>
|
| 1866 | </li>
|
| 1867 | </ul>
|
| 1868 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
|
| 1869 | <p>Returns <code>true</code> if the signature matches the claimed public key</p>
|
| 1870 | </li>
|
| 1871 | </ul>
|
| 1872 | </section>
|
| 1873 | <section class="tsd-panel tsd-member tsd-kind-function">
|
| 1874 | <a name="ecpairtoaddress" class="tsd-anchor"></a>
|
| 1875 | <h3>ec<wbr>Pair<wbr>ToAddress</h3>
|
| 1876 | <ul class="tsd-signatures tsd-kind-function">
|
| 1877 | <li class="tsd-signature tsd-kind-icon">ec<wbr>Pair<wbr>ToAddress<span class="tsd-signature-symbol">(</span>keyPair<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ECPair</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
|
| 1878 | </ul>
|
| 1879 | <ul class="tsd-descriptions">
|
| 1880 | <li class="tsd-description">
|
| 1881 | <aside class="tsd-sources">
|
| 1882 | <ul>
|
| 1883 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/utils.ts#L112">utils.ts:112</a></li>
|
| 1884 | </ul>
|
| 1885 | </aside>
|
| 1886 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 1887 | <ul class="tsd-parameters">
|
| 1888 | <li>
|
| 1889 | <h5>keyPair: <span class="tsd-signature-type">ECPair</span></h5>
|
| 1890 | </li>
|
| 1891 | </ul>
|
| 1892 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
|
| 1893 | </li>
|
| 1894 | </ul>
|
| 1895 | </section>
|
| 1896 | <section class="tsd-panel tsd-member tsd-kind-function">
|
| 1897 | <a name="ecpairtohexstring" class="tsd-anchor"></a>
|
| 1898 | <h3>ec<wbr>Pair<wbr>ToHex<wbr>String</h3>
|
| 1899 | <ul class="tsd-signatures tsd-kind-function">
|
| 1900 | <li class="tsd-signature tsd-kind-icon">ec<wbr>Pair<wbr>ToHex<wbr>String<span class="tsd-signature-symbol">(</span>secretKey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ECPair</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
|
| 1901 | </ul>
|
| 1902 | <ul class="tsd-descriptions">
|
| 1903 | <li class="tsd-description">
|
| 1904 | <aside class="tsd-sources">
|
| 1905 | <ul>
|
| 1906 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/utils.ts#L103">utils.ts:103</a></li>
|
| 1907 | </ul>
|
| 1908 | </aside>
|
| 1909 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 1910 | <ul class="tsd-parameters">
|
| 1911 | <li>
|
| 1912 | <h5>secretKey: <span class="tsd-signature-type">ECPair</span></h5>
|
| 1913 | </li>
|
| 1914 | </ul>
|
| 1915 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
|
| 1916 | </li>
|
| 1917 | </ul>
|
| 1918 | </section>
|
| 1919 | <section class="tsd-panel tsd-member tsd-kind-function">
|
| 1920 | <a name="encryptcontent" class="tsd-anchor"></a>
|
| 1921 | <h3>encrypt<wbr>Content</h3>
|
| 1922 | <ul class="tsd-signatures tsd-kind-function">
|
| 1923 | <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><span class="tsd-signature-type">object</span>, caller<span class="tsd-signature-symbol">?: </span><a href="classes/usersession.html" class="tsd-signature-type">UserSession</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
|
| 1924 | </ul>
|
| 1925 | <ul class="tsd-descriptions">
|
| 1926 | <li class="tsd-description">
|
| 1927 | <aside class="tsd-sources">
|
| 1928 | <ul>
|
| 1929 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/storage/index.ts#L76">storage/index.ts:76</a></li>
|
| 1930 | </ul>
|
| 1931 | </aside>
|
| 1932 | <div class="tsd-comment tsd-typography">
|
| 1933 | <div class="lead">
|
| 1934 | <p>Encrypts the data provided with the app public key.</p>
|
| 1935 | </div>
|
| 1936 | </div>
|
| 1937 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 1938 | <ul class="tsd-parameters">
|
| 1939 | <li>
|
| 1940 | <h5>content: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Buffer</span></h5>
|
| 1941 | <div class="tsd-comment tsd-typography">
|
| 1942 | <p>data to encrypt</p>
|
| 1943 | </div>
|
| 1944 | </li>
|
| 1945 | <li>
|
| 1946 | <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">object</span></h5>
|
| 1947 | <ul class="tsd-parameters">
|
| 1948 | <li class="tsd-parameter">
|
| 1949 | <h5><span class="tsd-flag ts-flagOptional">Optional</span> public<wbr>Key<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5>
|
| 1950 | <div class="tsd-comment tsd-typography">
|
| 1951 | <p>the hex string of the ECDSA public
|
| 1952 | key to use for encryption. If not provided, will use user's appPublicKey.</p>
|
| 1953 | </div>
|
| 1954 | </li>
|
| 1955 | </ul>
|
| 1956 | </li>
|
| 1957 | <li>
|
| 1958 | <h5><span class="tsd-flag ts-flagOptional">Optional</span> caller: <a href="classes/usersession.html" class="tsd-signature-type">UserSession</a></h5>
|
| 1959 | </li>
|
| 1960 | </ul>
|
| 1961 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
|
| 1962 | <p>Stringified ciphertext object</p>
|
| 1963 | </li>
|
| 1964 | </ul>
|
| 1965 | </section>
|
| 1966 | <section class="tsd-panel tsd-member tsd-kind-function">
|
| 1967 | <a name="encryptecies" class="tsd-anchor"></a>
|
| 1968 | <h3>encryptECIES</h3>
|
| 1969 | <ul class="tsd-signatures tsd-kind-function">
|
| 1970 | <li class="tsd-signature tsd-kind-icon">encryptECIES<span class="tsd-signature-symbol">(</span>publicKey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</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><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="globals.html#cipherobject" class="tsd-signature-type">CipherObject</a></li>
|
| 1971 | </ul>
|
| 1972 | <ul class="tsd-descriptions">
|
| 1973 | <li class="tsd-description">
|
| 1974 | <aside class="tsd-sources">
|
| 1975 | <ul>
|
| 1976 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/encryption/ec.ts#L76">encryption/ec.ts:76</a></li>
|
| 1977 | </ul>
|
| 1978 | </aside>
|
| 1979 | <div class="tsd-comment tsd-typography">
|
| 1980 | <div class="lead">
|
| 1981 | <p>Encrypt content to elliptic curve publicKey using ECIES</p>
|
| 1982 | </div>
|
| 1983 | </div>
|
| 1984 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 1985 | <ul class="tsd-parameters">
|
| 1986 | <li>
|
| 1987 | <h5>publicKey: <span class="tsd-signature-type">string</span></h5>
|
| 1988 | <div class="tsd-comment tsd-typography">
|
| 1989 | <p>secp256k1 public key hex string</p>
|
| 1990 | </div>
|
| 1991 | </li>
|
| 1992 | <li>
|
| 1993 | <h5>content: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Buffer</span></h5>
|
| 1994 | <div class="tsd-comment tsd-typography">
|
| 1995 | <p>content to encrypt</p>
|
| 1996 | </div>
|
| 1997 | </li>
|
| 1998 | </ul>
|
| 1999 | <h4 class="tsd-returns-title">Returns <a href="globals.html#cipherobject" class="tsd-signature-type">CipherObject</a></h4>
|
| 2000 | <p>Object containing (hex encoded):
|
| 2001 | iv (initialization vector), cipherText (cipher text),
|
| 2002 | mac (message authentication code), ephemeral public key
|
| 2003 | wasString (boolean indicating with or not to return a buffer or string on decrypt)
|
| 2004 | @private</p>
|
| 2005 | </li>
|
| 2006 | </ul>
|
| 2007 | </section>
|
| 2008 | <section class="tsd-panel tsd-member tsd-kind-function tsd-is-private">
|
| 2009 | <a name="encryptmnemonic" class="tsd-anchor"></a>
|
| 2010 | <h3><span class="tsd-flag ts-flagPrivate">Private</span> encrypt<wbr>Mnemonic</h3>
|
| 2011 | <ul class="tsd-signatures tsd-kind-function tsd-is-private">
|
| 2012 | <li class="tsd-signature tsd-kind-icon">encrypt<wbr>Mnemonic<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>
|
| 2013 | </ul>
|
| 2014 | <ul class="tsd-descriptions">
|
| 2015 | <li class="tsd-description">
|
| 2016 | <aside class="tsd-sources">
|
| 2017 | <ul>
|
| 2018 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/encryption/wallet.ts#L12">encryption/wallet.ts:12</a></li>
|
| 2019 | </ul>
|
| 2020 | </aside>
|
| 2021 | <div class="tsd-comment tsd-typography">
|
| 2022 | <div class="lead">
|
| 2023 | <p>Encrypt a raw mnemonic phrase to be password protected</p>
|
| 2024 | </div>
|
| 2025 | </div>
|
| 2026 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 2027 | <ul class="tsd-parameters">
|
| 2028 | <li>
|
| 2029 | <h5>phrase: <span class="tsd-signature-type">string</span></h5>
|
| 2030 | <div class="tsd-comment tsd-typography">
|
| 2031 | <p>Raw mnemonic phrase</p>
|
| 2032 | </div>
|
| 2033 | </li>
|
| 2034 | <li>
|
| 2035 | <h5>password: <span class="tsd-signature-type">string</span></h5>
|
| 2036 | <div class="tsd-comment tsd-typography">
|
| 2037 | <p>Password to encrypt mnemonic with</p>
|
| 2038 | </div>
|
| 2039 | </li>
|
| 2040 | </ul>
|
| 2041 | <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>
|
| 2042 | <p>The encrypted phrase</p>
|
| 2043 | </li>
|
| 2044 | </ul>
|
| 2045 | </section>
|
| 2046 | <section class="tsd-panel tsd-member tsd-kind-function tsd-is-private">
|
| 2047 | <a name="encryptprivatekey" class="tsd-anchor"></a>
|
| 2048 | <h3><span class="tsd-flag ts-flagPrivate">Private</span> encrypt<wbr>Private<wbr>Key</h3>
|
| 2049 | <ul class="tsd-signatures tsd-kind-function tsd-is-private">
|
| 2050 | <li class="tsd-signature tsd-kind-icon">encrypt<wbr>Private<wbr>Key<span class="tsd-signature-symbol">(</span>publicKey<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">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></li>
|
| 2051 | </ul>
|
| 2052 | <ul class="tsd-descriptions">
|
| 2053 | <li class="tsd-description">
|
| 2054 | <aside class="tsd-sources">
|
| 2055 | <ul>
|
| 2056 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/auth/authMessages.ts#L129">auth/authMessages.ts:129</a></li>
|
| 2057 | </ul>
|
| 2058 | </aside>
|
| 2059 | <div class="tsd-comment tsd-typography">
|
| 2060 | <div class="lead">
|
| 2061 | <p>Encrypts the private key for decryption by the given
|
| 2062 | public key.</p>
|
| 2063 | </div>
|
| 2064 | </div>
|
| 2065 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 2066 | <ul class="tsd-parameters">
|
| 2067 | <li>
|
| 2068 | <h5>publicKey: <span class="tsd-signature-type">string</span></h5>
|
| 2069 | </li>
|
| 2070 | <li>
|
| 2071 | <h5>privateKey: <span class="tsd-signature-type">string</span></h5>
|
| 2072 | </li>
|
| 2073 | </ul>
|
| 2074 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span>
|
| 2075 | <span class="tsd-signature-symbol"> | </span>
|
| 2076 | <span class="tsd-signature-type">null</span>
|
| 2077 | </h4>
|
| 2078 | <p>hex encoded ciphertext</p>
|
| 2079 | </li>
|
| 2080 | </ul>
|
| 2081 | </section>
|
| 2082 | <section class="tsd-panel tsd-member tsd-kind-function tsd-is-not-exported">
|
| 2083 | <a name="equalconsttime" class="tsd-anchor"></a>
|
| 2084 | <h3>equal<wbr>Const<wbr>Time</h3>
|
| 2085 | <ul class="tsd-signatures tsd-kind-function tsd-is-not-exported">
|
| 2086 | <li class="tsd-signature tsd-kind-icon">equal<wbr>Const<wbr>Time<span class="tsd-signature-symbol">(</span>b1<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span>, b2<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">boolean</span></li>
|
| 2087 | </ul>
|
| 2088 | <ul class="tsd-descriptions">
|
| 2089 | <li class="tsd-description">
|
| 2090 | <aside class="tsd-sources">
|
| 2091 | <ul>
|
| 2092 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/encryption/ec.ts#L31">encryption/ec.ts:31</a></li>
|
| 2093 | </ul>
|
| 2094 | </aside>
|
| 2095 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 2096 | <ul class="tsd-parameters">
|
| 2097 | <li>
|
| 2098 | <h5>b1: <span class="tsd-signature-type">Buffer</span></h5>
|
| 2099 | </li>
|
| 2100 | <li>
|
| 2101 | <h5>b2: <span class="tsd-signature-type">Buffer</span></h5>
|
| 2102 | </li>
|
| 2103 | </ul>
|
| 2104 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
|
| 2105 | </li>
|
| 2106 | </ul>
|
| 2107 | </section>
|
| 2108 | <section class="tsd-panel tsd-member tsd-kind-function tsd-is-private tsd-is-not-exported">
|
| 2109 | <a name="estimateannounce" class="tsd-anchor"></a>
|
| 2110 | <h3><span class="tsd-flag ts-flagPrivate">Private</span> estimate<wbr>Announce</h3>
|
| 2111 | <ul class="tsd-signatures tsd-kind-function tsd-is-private tsd-is-not-exported">
|
| 2112 | <li class="tsd-signature tsd-kind-icon">estimate<wbr>Announce<span class="tsd-signature-symbol">(</span>messageHash<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, senderUtxos<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>
|
| 2113 | </ul>
|
| 2114 | <ul class="tsd-descriptions">
|
| 2115 | <li class="tsd-description">
|
| 2116 | <aside class="tsd-sources">
|
| 2117 | <ul>
|
| 2118 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/operations/txbuild.ts#L419">operations/txbuild.ts:419</a></li>
|
| 2119 | </ul>
|
| 2120 | </aside>
|
| 2121 | <div class="tsd-comment tsd-typography">
|
| 2122 | <div class="lead">
|
| 2123 | <p>Estimates the cost of an announce transaction</p>
|
| 2124 | </div>
|
| 2125 | </div>
|
| 2126 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 2127 | <ul class="tsd-parameters">
|
| 2128 | <li>
|
| 2129 | <h5>messageHash: <span class="tsd-signature-type">string</span></h5>
|
| 2130 | <div class="tsd-comment tsd-typography">
|
| 2131 | <p>the hash of the message</p>
|
| 2132 | </div>
|
| 2133 | </li>
|
| 2134 | <li>
|
| 2135 | <h5><span class="tsd-flag ts-flagDefault value">Default value</span> senderUtxos: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 1</span></h5>
|
| 2136 | <div class="tsd-comment tsd-typography">
|
| 2137 | <p>the number of utxos we expect will
|
| 2138 | be required from the importer address</p>
|
| 2139 | </div>
|
| 2140 | </li>
|
| 2141 | </ul>
|
| 2142 | <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>
|
| 2143 | <ul>
|
| 2144 | <li>a promise which resolves to the satoshi cost
|
| 2145 | to fund this announce transaction</li>
|
| 2146 | </ul>
|
| 2147 | </li>
|
| 2148 | </ul>
|
| 2149 | </section>
|
| 2150 | <section class="tsd-panel tsd-member tsd-kind-function tsd-is-private tsd-is-not-exported">
|
| 2151 | <a name="estimatenameimport" class="tsd-anchor"></a>
|
| 2152 | <h3><span class="tsd-flag ts-flagPrivate">Private</span> estimate<wbr>Name<wbr>Import</h3>
|
| 2153 | <ul class="tsd-signatures tsd-kind-function tsd-is-private tsd-is-not-exported">
|
| 2154 | <li class="tsd-signature tsd-kind-icon">estimate<wbr>Name<wbr>Import<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, recipientAddr<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, zonefileHash<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, importUtxos<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>
|
| 2155 | </ul>
|
| 2156 | <ul class="tsd-descriptions">
|
| 2157 | <li class="tsd-description">
|
| 2158 | <aside class="tsd-sources">
|
| 2159 | <ul>
|
| 2160 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/operations/txbuild.ts#L394">operations/txbuild.ts:394</a></li>
|
| 2161 | </ul>
|
| 2162 | </aside>
|
| 2163 | <div class="tsd-comment tsd-typography">
|
| 2164 | <div class="lead">
|
| 2165 | <p>Estimates the cost of a name-import transaction</p>
|
| 2166 | </div>
|
| 2167 | </div>
|
| 2168 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 2169 | <ul class="tsd-parameters">
|
| 2170 | <li>
|
| 2171 | <h5>name: <span class="tsd-signature-type">string</span></h5>
|
| 2172 | <div class="tsd-comment tsd-typography">
|
| 2173 | <p>the fully-qualified name</p>
|
| 2174 | </div>
|
| 2175 | </li>
|
| 2176 | <li>
|
| 2177 | <h5>recipientAddr: <span class="tsd-signature-type">string</span></h5>
|
| 2178 | <div class="tsd-comment tsd-typography">
|
| 2179 | <p>the recipient</p>
|
| 2180 | </div>
|
| 2181 | </li>
|
| 2182 | <li>
|
| 2183 | <h5>zonefileHash: <span class="tsd-signature-type">string</span></h5>
|
| 2184 | <div class="tsd-comment tsd-typography">
|
| 2185 | <p>the zone file hash</p>
|
| 2186 | </div>
|
| 2187 | </li>
|
| 2188 | <li>
|
| 2189 | <h5><span class="tsd-flag ts-flagDefault value">Default value</span> importUtxos: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 1</span></h5>
|
| 2190 | <div class="tsd-comment tsd-typography">
|
| 2191 | <p>the number of UTXOs we expect will
|
| 2192 | be required from the importer address</p>
|
| 2193 | </div>
|
| 2194 | </li>
|
| 2195 | </ul>
|
| 2196 | <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>
|
| 2197 | <ul>
|
| 2198 | <li>a promise which resolves to the satoshi cost
|
| 2199 | to fund this name-import transaction</li>
|
| 2200 | </ul>
|
| 2201 | </li>
|
| 2202 | </ul>
|
| 2203 | </section>
|
| 2204 | <section class="tsd-panel tsd-member tsd-kind-function tsd-is-private tsd-is-not-exported">
|
| 2205 | <a name="estimatenamespacepreorder" class="tsd-anchor"></a>
|
| 2206 | <h3><span class="tsd-flag ts-flagPrivate">Private</span> estimate<wbr>Namespace<wbr>Preorder</h3>
|
| 2207 | <ul class="tsd-signatures tsd-kind-function tsd-is-private tsd-is-not-exported">
|
| 2208 | <li class="tsd-signature tsd-kind-icon">estimate<wbr>Namespace<wbr>Preorder<span class="tsd-signature-symbol">(</span>namespaceID<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, revealAddress<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, paymentAddress<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, paymentUtxos<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>
|
| 2209 | </ul>
|
| 2210 | <ul class="tsd-descriptions">
|
| 2211 | <li class="tsd-description">
|
| 2212 | <aside class="tsd-sources">
|
| 2213 | <ul>
|
| 2214 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/operations/txbuild.ts#L307">operations/txbuild.ts:307</a></li>
|
| 2215 | </ul>
|
| 2216 | </aside>
|
| 2217 | <div class="tsd-comment tsd-typography">
|
| 2218 | <div class="lead">
|
| 2219 | <p>Estimates cost of a namespace preorder transaction for a namespace</p>
|
| 2220 | </div>
|
| 2221 | </div>
|
| 2222 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 2223 | <ul class="tsd-parameters">
|
| 2224 | <li>
|
| 2225 | <h5>namespaceID: <span class="tsd-signature-type">string</span></h5>
|
| 2226 | <div class="tsd-comment tsd-typography">
|
| 2227 | <p>the namespace to preorder</p>
|
| 2228 | </div>
|
| 2229 | </li>
|
| 2230 | <li>
|
| 2231 | <h5>revealAddress: <span class="tsd-signature-type">string</span></h5>
|
| 2232 | <div class="tsd-comment tsd-typography">
|
| 2233 | <p>the address to receive the namespace (this
|
| 2234 | must be passed as the 'revealAddress' in the namespace-reveal transaction)</p>
|
| 2235 | </div>
|
| 2236 | </li>
|
| 2237 | <li>
|
| 2238 | <h5>paymentAddress: <span class="tsd-signature-type">string</span></h5>
|
| 2239 | <div class="tsd-comment tsd-typography">
|
| 2240 | <p>the address funding the preorder</p>
|
| 2241 | </div>
|
| 2242 | </li>
|
| 2243 | <li>
|
| 2244 | <h5><span class="tsd-flag ts-flagDefault value">Default value</span> paymentUtxos: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 1</span></h5>
|
| 2245 | <div class="tsd-comment tsd-typography">
|
| 2246 | <p>the number of UTXOs we expect will be required
|
| 2247 | from the payment address.</p>
|
| 2248 | </div>
|
| 2249 | </li>
|
| 2250 | </ul>
|
| 2251 | <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>
|
| 2252 | <ul>
|
| 2253 | <li>a promise which resolves to the satoshi cost to fund
|
| 2254 | the preorder. This includes a 5500 satoshi dust output for the preorder.
|
| 2255 | Even though this is a change output, the payer must supply enough funds
|
| 2256 | to generate this output, so we include it in the cost.</li>
|
| 2257 | </ul>
|
| 2258 | </li>
|
| 2259 | </ul>
|
| 2260 | </section>
|
| 2261 | <section class="tsd-panel tsd-member tsd-kind-function tsd-is-private tsd-is-not-exported">
|
| 2262 | <a name="estimatenamespaceready" class="tsd-anchor"></a>
|
| 2263 | <h3><span class="tsd-flag ts-flagPrivate">Private</span> estimate<wbr>Namespace<wbr>Ready</h3>
|
| 2264 | <ul class="tsd-signatures tsd-kind-function tsd-is-private tsd-is-not-exported">
|
| 2265 | <li class="tsd-signature tsd-kind-icon">estimate<wbr>Namespace<wbr>Ready<span class="tsd-signature-symbol">(</span>namespaceID<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, revealUtxos<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>
|
| 2266 | </ul>
|
| 2267 | <ul class="tsd-descriptions">
|
| 2268 | <li class="tsd-description">
|
| 2269 | <aside class="tsd-sources">
|
| 2270 | <ul>
|
| 2271 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/operations/txbuild.ts#L369">operations/txbuild.ts:369</a></li>
|
| 2272 | </ul>
|
| 2273 | </aside>
|
| 2274 | <div class="tsd-comment tsd-typography">
|
| 2275 | <div class="lead">
|
| 2276 | <p>Estimates the cost of a namespace-ready transaction for a namespace</p>
|
| 2277 | </div>
|
| 2278 | </div>
|
| 2279 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 2280 | <ul class="tsd-parameters">
|
| 2281 | <li>
|
| 2282 | <h5>namespaceID: <span class="tsd-signature-type">string</span></h5>
|
| 2283 | <div class="tsd-comment tsd-typography">
|
| 2284 | <p>the namespace to ready</p>
|
| 2285 | </div>
|
| 2286 | </li>
|
| 2287 | <li>
|
| 2288 | <h5><span class="tsd-flag ts-flagDefault value">Default value</span> revealUtxos: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 1</span></h5>
|
| 2289 | <div class="tsd-comment tsd-typography">
|
| 2290 | <p>the number of UTXOs we expect will
|
| 2291 | be required from the reveal address</p>
|
| 2292 | </div>
|
| 2293 | </li>
|
| 2294 | </ul>
|
| 2295 | <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>
|
| 2296 | <ul>
|
| 2297 | <li>a promise which resolves to the satoshi cost to
|
| 2298 | fund this namespacey-ready transaction.</li>
|
| 2299 | </ul>
|
| 2300 | </li>
|
| 2301 | </ul>
|
| 2302 | </section>
|
| 2303 | <section class="tsd-panel tsd-member tsd-kind-function tsd-is-private tsd-is-not-exported">
|
| 2304 | <a name="estimatenamespacereveal" class="tsd-anchor"></a>
|
| 2305 | <h3><span class="tsd-flag ts-flagPrivate">Private</span> estimate<wbr>Namespace<wbr>Reveal</h3>
|
| 2306 | <ul class="tsd-signatures tsd-kind-function tsd-is-private tsd-is-not-exported">
|
| 2307 | <li class="tsd-signature tsd-kind-icon">estimate<wbr>Namespace<wbr>Reveal<span class="tsd-signature-symbol">(</span>namespace<span class="tsd-signature-symbol">: </span><a href="classes/blockstacknamespace.html" class="tsd-signature-type">BlockstackNamespace</a>, revealAddress<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, paymentAddress<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, paymentUtxos<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>
|
| 2308 | </ul>
|
| 2309 | <ul class="tsd-descriptions">
|
| 2310 | <li class="tsd-description">
|
| 2311 | <aside class="tsd-sources">
|
| 2312 | <ul>
|
| 2313 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/operations/txbuild.ts#L343">operations/txbuild.ts:343</a></li>
|
| 2314 | </ul>
|
| 2315 | </aside>
|
| 2316 | <div class="tsd-comment tsd-typography">
|
| 2317 | <div class="lead">
|
| 2318 | <p>Estimates cost of a namesapce reveal transaction for a namespace</p>
|
| 2319 | </div>
|
| 2320 | </div>
|
| 2321 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 2322 | <ul class="tsd-parameters">
|
| 2323 | <li>
|
| 2324 | <h5>namespace: <a href="classes/blockstacknamespace.html" class="tsd-signature-type">BlockstackNamespace</a></h5>
|
| 2325 | <div class="tsd-comment tsd-typography">
|
| 2326 | <p>the namespace to reveal</p>
|
| 2327 | </div>
|
| 2328 | </li>
|
| 2329 | <li>
|
| 2330 | <h5>revealAddress: <span class="tsd-signature-type">string</span></h5>
|
| 2331 | <div class="tsd-comment tsd-typography">
|
| 2332 | <p>the address to receive the namespace
|
| 2333 | (this must have been passed as 'revealAddress' to a prior namespace
|
| 2334 | preorder)</p>
|
| 2335 | </div>
|
| 2336 | </li>
|
| 2337 | <li>
|
| 2338 | <h5>paymentAddress: <span class="tsd-signature-type">string</span></h5>
|
| 2339 | <div class="tsd-comment tsd-typography">
|
| 2340 | <p>the address that pays for this transaction</p>
|
| 2341 | </div>
|
| 2342 | </li>
|
| 2343 | <li>
|
| 2344 | <h5><span class="tsd-flag ts-flagDefault value">Default value</span> paymentUtxos: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 1</span></h5>
|
| 2345 | <div class="tsd-comment tsd-typography">
|
| 2346 | <p>the number of UTXOs we expect will be required
|
| 2347 | from the payment address</p>
|
| 2348 | </div>
|
| 2349 | </li>
|
| 2350 | </ul>
|
| 2351 | <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>
|
| 2352 | <ul>
|
| 2353 | <li>a promise which resolves to the satoshi cost to
|
| 2354 | fund the reveal. This includes a 5500 satoshi dust output for the
|
| 2355 | preorder. Even though this is a change output, the payer must have
|
| 2356 | enough funds to generate this output, so we include it in the cost.</li>
|
| 2357 | </ul>
|
| 2358 | </li>
|
| 2359 | </ul>
|
| 2360 | </section>
|
| 2361 | <section class="tsd-panel tsd-member tsd-kind-function tsd-is-private tsd-is-not-exported">
|
| 2362 | <a name="estimatepreorder" class="tsd-anchor"></a>
|
| 2363 | <h3><span class="tsd-flag ts-flagPrivate">Private</span> estimate<wbr>Preorder</h3>
|
| 2364 | <ul class="tsd-signatures tsd-kind-function tsd-is-private tsd-is-not-exported">
|
| 2365 | <li class="tsd-signature tsd-kind-icon">estimate<wbr>Preorder<span class="tsd-signature-symbol">(</span>fullyQualifiedName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, destinationAddress<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, paymentAddress<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, paymentUtxos<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>
|
| 2366 | </ul>
|
| 2367 | <ul class="tsd-descriptions">
|
| 2368 | <li class="tsd-description">
|
| 2369 | <aside class="tsd-sources">
|
| 2370 | <ul>
|
| 2371 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/operations/txbuild.ts#L95">operations/txbuild.ts:95</a></li>
|
| 2372 | </ul>
|
| 2373 | </aside>
|
| 2374 | <div class="tsd-comment tsd-typography">
|
| 2375 | <div class="lead">
|
| 2376 | <p>Estimates cost of a preorder transaction for a domain name.</p>
|
| 2377 | </div>
|
| 2378 | </div>
|
| 2379 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 2380 | <ul class="tsd-parameters">
|
| 2381 | <li>
|
| 2382 | <h5>fullyQualifiedName: <span class="tsd-signature-type">string</span></h5>
|
| 2383 | <div class="tsd-comment tsd-typography">
|
| 2384 | <p>the name to preorder</p>
|
| 2385 | </div>
|
| 2386 | </li>
|
| 2387 | <li>
|
| 2388 | <h5>destinationAddress: <span class="tsd-signature-type">string</span></h5>
|
| 2389 | <div class="tsd-comment tsd-typography">
|
| 2390 | <p>the address to receive the name (this
|
| 2391 | must be passed as the 'registrationAddress' in the register transaction)</p>
|
| 2392 | </div>
|
| 2393 | </li>
|
| 2394 | <li>
|
| 2395 | <h5>paymentAddress: <span class="tsd-signature-type">string</span></h5>
|
| 2396 | <div class="tsd-comment tsd-typography">
|
| 2397 | <p>the address funding the preorder</p>
|
| 2398 | </div>
|
| 2399 | </li>
|
| 2400 | <li>
|
| 2401 | <h5><span class="tsd-flag ts-flagDefault value">Default value</span> paymentUtxos: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 1</span></h5>
|
| 2402 | <div class="tsd-comment tsd-typography">
|
| 2403 | <p>the number of UTXOs we expect will be required
|
| 2404 | from the payment address.</p>
|
| 2405 | </div>
|
| 2406 | </li>
|
| 2407 | </ul>
|
| 2408 | <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>
|
| 2409 | <ul>
|
| 2410 | <li>a promise which resolves to the satoshi cost to fund
|
| 2411 | the preorder. This includes a 5500 satoshi dust output for the preorder.
|
| 2412 | Even though this is a change output, the payer must supply enough funds
|
| 2413 | to generate this output, so we include it in the cost.</li>
|
| 2414 | </ul>
|
| 2415 | </li>
|
| 2416 | </ul>
|
| 2417 | </section>
|
| 2418 | <section class="tsd-panel tsd-member tsd-kind-function tsd-is-private tsd-is-not-exported">
|
| 2419 | <a name="estimateregister" class="tsd-anchor"></a>
|
| 2420 | <h3><span class="tsd-flag ts-flagPrivate">Private</span> estimate<wbr>Register</h3>
|
| 2421 | <ul class="tsd-signatures tsd-kind-function tsd-is-private tsd-is-not-exported">
|
| 2422 | <li class="tsd-signature tsd-kind-icon">estimate<wbr>Register<span class="tsd-signature-symbol">(</span>fullyQualifiedName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, registerAddress<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, paymentAddress<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, includingZonefile<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span>, paymentUtxos<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>
|
| 2423 | </ul>
|
| 2424 | <ul class="tsd-descriptions">
|
| 2425 | <li class="tsd-description">
|
| 2426 | <aside class="tsd-sources">
|
| 2427 | <ul>
|
| 2428 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/operations/txbuild.ts#L129">operations/txbuild.ts:129</a></li>
|
| 2429 | </ul>
|
| 2430 | </aside>
|
| 2431 | <div class="tsd-comment tsd-typography">
|
| 2432 | <div class="lead">
|
| 2433 | <p>Estimates cost of a register transaction for a domain name.</p>
|
| 2434 | </div>
|
| 2435 | </div>
|
| 2436 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 2437 | <ul class="tsd-parameters">
|
| 2438 | <li>
|
| 2439 | <h5>fullyQualifiedName: <span class="tsd-signature-type">string</span></h5>
|
| 2440 | <div class="tsd-comment tsd-typography">
|
| 2441 | <p>the name to register</p>
|
| 2442 | </div>
|
| 2443 | </li>
|
| 2444 | <li>
|
| 2445 | <h5>registerAddress: <span class="tsd-signature-type">string</span></h5>
|
| 2446 | <div class="tsd-comment tsd-typography">
|
| 2447 | <p>the address to receive the name</p>
|
| 2448 | </div>
|
| 2449 | </li>
|
| 2450 | <li>
|
| 2451 | <h5>paymentAddress: <span class="tsd-signature-type">string</span></h5>
|
| 2452 | <div class="tsd-comment tsd-typography">
|
| 2453 | <p>the address funding the register</p>
|
| 2454 | </div>
|
| 2455 | </li>
|
| 2456 | <li>
|
| 2457 | <h5><span class="tsd-flag ts-flagDefault value">Default value</span> includingZonefile: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></h5>
|
| 2458 | <div class="tsd-comment tsd-typography">
|
| 2459 | <p>whether or not we will broadcast
|
| 2460 | a zonefile hash as part of the register</p>
|
| 2461 | </div>
|
| 2462 | </li>
|
| 2463 | <li>
|
| 2464 | <h5><span class="tsd-flag ts-flagDefault value">Default value</span> paymentUtxos: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 1</span></h5>
|
| 2465 | <div class="tsd-comment tsd-typography">
|
| 2466 | <p>the number of UTXOs we expect will be required
|
| 2467 | from the payment address.</p>
|
| 2468 | </div>
|
| 2469 | </li>
|
| 2470 | </ul>
|
| 2471 | <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>
|
| 2472 | <ul>
|
| 2473 | <li>a promise which resolves to the satoshi cost to fund
|
| 2474 | the register.</li>
|
| 2475 | </ul>
|
| 2476 | </li>
|
| 2477 | </ul>
|
| 2478 | </section>
|
| 2479 | <section class="tsd-panel tsd-member tsd-kind-function tsd-is-private tsd-is-not-exported">
|
| 2480 | <a name="estimaterenewal" class="tsd-anchor"></a>
|
| 2481 | <h3><span class="tsd-flag ts-flagPrivate">Private</span> estimate<wbr>Renewal</h3>
|
| 2482 | <ul class="tsd-signatures tsd-kind-function tsd-is-private tsd-is-not-exported">
|
| 2483 | <li class="tsd-signature tsd-kind-icon">estimate<wbr>Renewal<span class="tsd-signature-symbol">(</span>fullyQualifiedName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, destinationAddress<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, ownerAddress<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, paymentAddress<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, includingZonefile<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span>, paymentUtxos<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>
|
| 2484 | </ul>
|
| 2485 | <ul class="tsd-descriptions">
|
| 2486 | <li class="tsd-description">
|
| 2487 | <aside class="tsd-sources">
|
| 2488 | <ul>
|
| 2489 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/operations/txbuild.ts#L234">operations/txbuild.ts:234</a></li>
|
| 2490 | </ul>
|
| 2491 | </aside>
|
| 2492 | <div class="tsd-comment tsd-typography">
|
| 2493 | <div class="lead">
|
| 2494 | <p>Estimates cost of an transfer transaction for a domain name.</p>
|
| 2495 | </div>
|
| 2496 | </div>
|
| 2497 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 2498 | <ul class="tsd-parameters">
|
| 2499 | <li>
|
| 2500 | <h5>fullyQualifiedName: <span class="tsd-signature-type">string</span></h5>
|
| 2501 | <div class="tsd-comment tsd-typography">
|
| 2502 | <p>the name to renew</p>
|
| 2503 | </div>
|
| 2504 | </li>
|
| 2505 | <li>
|
| 2506 | <h5>destinationAddress: <span class="tsd-signature-type">string</span></h5>
|
| 2507 | <div class="tsd-comment tsd-typography">
|
| 2508 | <p>the next owner of the name</p>
|
| 2509 | </div>
|
| 2510 | </li>
|
| 2511 | <li>
|
| 2512 | <h5>ownerAddress: <span class="tsd-signature-type">string</span></h5>
|
| 2513 | <div class="tsd-comment tsd-typography">
|
| 2514 | <p>the current owner of the name</p>
|
| 2515 | </div>
|
| 2516 | </li>
|
| 2517 | <li>
|
| 2518 | <h5>paymentAddress: <span class="tsd-signature-type">string</span></h5>
|
| 2519 | <div class="tsd-comment tsd-typography">
|
| 2520 | <p>the address funding the transfer</p>
|
| 2521 | </div>
|
| 2522 | </li>
|
| 2523 | <li>
|
| 2524 | <h5><span class="tsd-flag ts-flagDefault value">Default value</span> includingZonefile: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></h5>
|
| 2525 | <div class="tsd-comment tsd-typography">
|
| 2526 | <p>whether or not we will broadcast a zonefile hash
|
| 2527 | in the renewal operation</p>
|
| 2528 | </div>
|
| 2529 | </li>
|
| 2530 | <li>
|
| 2531 | <h5><span class="tsd-flag ts-flagDefault value">Default value</span> paymentUtxos: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 1</span></h5>
|
| 2532 | <div class="tsd-comment tsd-typography">
|
| 2533 | <p>the number of UTXOs we expect will be required
|
| 2534 | from the payment address.</p>
|
| 2535 | </div>
|
| 2536 | </li>
|
| 2537 | </ul>
|
| 2538 | <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>
|
| 2539 | <ul>
|
| 2540 | <li>a promise which resolves to the satoshi cost to fund
|
| 2541 | the transfer.</li>
|
| 2542 | </ul>
|
| 2543 | </li>
|
| 2544 | </ul>
|
| 2545 | </section>
|
| 2546 | <section class="tsd-panel tsd-member tsd-kind-function tsd-is-private tsd-is-not-exported">
|
| 2547 | <a name="estimaterevoke" class="tsd-anchor"></a>
|
| 2548 | <h3><span class="tsd-flag ts-flagPrivate">Private</span> estimate<wbr>Revoke</h3>
|
| 2549 | <ul class="tsd-signatures tsd-kind-function tsd-is-private tsd-is-not-exported">
|
| 2550 | <li class="tsd-signature tsd-kind-icon">estimate<wbr>Revoke<span class="tsd-signature-symbol">(</span>fullyQualifiedName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, ownerAddress<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, paymentAddress<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, paymentUtxos<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>
|
| 2551 | </ul>
|
| 2552 | <ul class="tsd-descriptions">
|
| 2553 | <li class="tsd-description">
|
| 2554 | <aside class="tsd-sources">
|
| 2555 | <ul>
|
| 2556 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/operations/txbuild.ts#L275">operations/txbuild.ts:275</a></li>
|
| 2557 | </ul>
|
| 2558 | </aside>
|
| 2559 | <div class="tsd-comment tsd-typography">
|
| 2560 | <div class="lead">
|
| 2561 | <p>Estimates cost of a revoke transaction for a domain name.</p>
|
| 2562 | </div>
|
| 2563 | </div>
|
| 2564 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 2565 | <ul class="tsd-parameters">
|
| 2566 | <li>
|
| 2567 | <h5>fullyQualifiedName: <span class="tsd-signature-type">string</span></h5>
|
| 2568 | <div class="tsd-comment tsd-typography">
|
| 2569 | <p>the name to revoke</p>
|
| 2570 | </div>
|
| 2571 | </li>
|
| 2572 | <li>
|
| 2573 | <h5>ownerAddress: <span class="tsd-signature-type">string</span></h5>
|
| 2574 | <div class="tsd-comment tsd-typography">
|
| 2575 | <p>the current owner of the name</p>
|
| 2576 | </div>
|
| 2577 | </li>
|
| 2578 | <li>
|
| 2579 | <h5>paymentAddress: <span class="tsd-signature-type">string</span></h5>
|
| 2580 | <div class="tsd-comment tsd-typography">
|
| 2581 | <p>the address funding the revoke</p>
|
| 2582 | </div>
|
| 2583 | </li>
|
| 2584 | <li>
|
| 2585 | <h5><span class="tsd-flag ts-flagDefault value">Default value</span> paymentUtxos: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 1</span></h5>
|
| 2586 | <div class="tsd-comment tsd-typography">
|
| 2587 | <p>the number of UTXOs we expect will be required
|
| 2588 | from the payment address.</p>
|
| 2589 | </div>
|
| 2590 | </li>
|
| 2591 | </ul>
|
| 2592 | <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>
|
| 2593 | <ul>
|
| 2594 | <li>a promise which resolves to the satoshi cost to fund the
|
| 2595 | revoke.</li>
|
| 2596 | </ul>
|
| 2597 | </li>
|
| 2598 | </ul>
|
| 2599 | </section>
|
| 2600 | <section class="tsd-panel tsd-member tsd-kind-function">
|
| 2601 | <a name="estimatetxbytes" class="tsd-anchor"></a>
|
| 2602 | <h3>estimateTXBytes</h3>
|
| 2603 | <ul class="tsd-signatures tsd-kind-function">
|
| 2604 | <li class="tsd-signature tsd-kind-icon">estimateTXBytes<span class="tsd-signature-symbol">(</span>txIn<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">bitcoinjs.Transaction</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">bitcoinjs.TransactionBuilder</span>, additionalInputs<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, additionalOutputs<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>
|
| 2605 | </ul>
|
| 2606 | <ul class="tsd-descriptions">
|
| 2607 | <li class="tsd-description">
|
| 2608 | <aside class="tsd-sources">
|
| 2609 | <ul>
|
| 2610 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/operations/utils.ts#L70">operations/utils.ts:70</a></li>
|
| 2611 | </ul>
|
| 2612 | </aside>
|
| 2613 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 2614 | <ul class="tsd-parameters">
|
| 2615 | <li>
|
| 2616 | <h5>txIn: <span class="tsd-signature-type">bitcoinjs.Transaction</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">bitcoinjs.TransactionBuilder</span></h5>
|
| 2617 | </li>
|
| 2618 | <li>
|
| 2619 | <h5>additionalInputs: <span class="tsd-signature-type">number</span></h5>
|
| 2620 | </li>
|
| 2621 | <li>
|
| 2622 | <h5>additionalOutputs: <span class="tsd-signature-type">number</span></h5>
|
| 2623 | </li>
|
| 2624 | </ul>
|
| 2625 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
|
| 2626 | </li>
|
| 2627 | </ul>
|
| 2628 | </section>
|
| 2629 | <section class="tsd-panel tsd-member tsd-kind-function tsd-is-private tsd-is-not-exported">
|
| 2630 | <a name="estimatetokentransfer" class="tsd-anchor"></a>
|
| 2631 | <h3><span class="tsd-flag ts-flagPrivate">Private</span> estimate<wbr>Token<wbr>Transfer</h3>
|
| 2632 | <ul class="tsd-signatures tsd-kind-function tsd-is-private tsd-is-not-exported">
|
| 2633 | <li class="tsd-signature tsd-kind-icon">estimate<wbr>Token<wbr>Transfer<span class="tsd-signature-symbol">(</span>recipientAddress<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, tokenType<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, tokenAmount<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BN</span>, scratchArea<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, senderUtxos<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, additionalOutputs<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>
|
| 2634 | </ul>
|
| 2635 | <ul class="tsd-descriptions">
|
| 2636 | <li class="tsd-description">
|
| 2637 | <aside class="tsd-sources">
|
| 2638 | <ul>
|
| 2639 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/operations/txbuild.ts#L448">operations/txbuild.ts:448</a></li>
|
| 2640 | </ul>
|
| 2641 | </aside>
|
| 2642 | <div class="tsd-comment tsd-typography">
|
| 2643 | <div class="lead">
|
| 2644 | <p>Estimates the cost of a token-transfer transaction</p>
|
| 2645 | </div>
|
| 2646 | </div>
|
| 2647 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 2648 | <ul class="tsd-parameters">
|
| 2649 | <li>
|
| 2650 | <h5>recipientAddress: <span class="tsd-signature-type">string</span></h5>
|
| 2651 | <div class="tsd-comment tsd-typography">
|
| 2652 | <p>the recipient of the tokens</p>
|
| 2653 | </div>
|
| 2654 | </li>
|
| 2655 | <li>
|
| 2656 | <h5>tokenType: <span class="tsd-signature-type">string</span></h5>
|
| 2657 | <div class="tsd-comment tsd-typography">
|
| 2658 | <p>the type of token to spend</p>
|
| 2659 | </div>
|
| 2660 | </li>
|
| 2661 | <li>
|
| 2662 | <h5>tokenAmount: <span class="tsd-signature-type">BN</span></h5>
|
| 2663 | <div class="tsd-comment tsd-typography">
|
| 2664 | <p>a 64-bit unsigned BigInteger encoding the number of tokens
|
| 2665 | to spend</p>
|
| 2666 | </div>
|
| 2667 | </li>
|
| 2668 | <li>
|
| 2669 | <h5>scratchArea: <span class="tsd-signature-type">string</span></h5>
|
| 2670 | <div class="tsd-comment tsd-typography">
|
| 2671 | <p>an arbitrary string to store with the transaction</p>
|
| 2672 | </div>
|
| 2673 | </li>
|
| 2674 | <li>
|
| 2675 | <h5><span class="tsd-flag ts-flagDefault value">Default value</span> senderUtxos: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 1</span></h5>
|
| 2676 | <div class="tsd-comment tsd-typography">
|
| 2677 | <p>the number of utxos we expect will
|
| 2678 | be required from the importer address</p>
|
| 2679 | </div>
|
| 2680 | </li>
|
| 2681 | <li>
|
| 2682 | <h5><span class="tsd-flag ts-flagDefault value">Default value</span> additionalOutputs: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 1</span></h5>
|
| 2683 | <div class="tsd-comment tsd-typography">
|
| 2684 | <p>the number of outputs we expect to add beyond
|
| 2685 | just the recipient output (default = 1, if the token owner is also the bitcoin funder)</p>
|
| 2686 | </div>
|
| 2687 | </li>
|
| 2688 | </ul>
|
| 2689 | <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>
|
| 2690 | <ul>
|
| 2691 | <li>a promise which resolves to the satoshi cost to
|
| 2692 | fund this token-transfer transaction</li>
|
| 2693 | </ul>
|
| 2694 | </li>
|
| 2695 | </ul>
|
| 2696 | </section>
|
| 2697 | <section class="tsd-panel tsd-member tsd-kind-function tsd-is-private tsd-is-not-exported">
|
| 2698 | <a name="estimatetransfer" class="tsd-anchor"></a>
|
| 2699 | <h3><span class="tsd-flag ts-flagPrivate">Private</span> estimate<wbr>Transfer</h3>
|
| 2700 | <ul class="tsd-signatures tsd-kind-function tsd-is-private tsd-is-not-exported">
|
| 2701 | <li class="tsd-signature tsd-kind-icon">estimate<wbr>Transfer<span class="tsd-signature-symbol">(</span>fullyQualifiedName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, destinationAddress<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, ownerAddress<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, paymentAddress<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, paymentUtxos<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>
|
| 2702 | </ul>
|
| 2703 | <ul class="tsd-descriptions">
|
| 2704 | <li class="tsd-description">
|
| 2705 | <aside class="tsd-sources">
|
| 2706 | <ul>
|
| 2707 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/operations/txbuild.ts#L199">operations/txbuild.ts:199</a></li>
|
| 2708 | </ul>
|
| 2709 | </aside>
|
| 2710 | <div class="tsd-comment tsd-typography">
|
| 2711 | <div class="lead">
|
| 2712 | <p>Estimates cost of an transfer transaction for a domain name.</p>
|
| 2713 | </div>
|
| 2714 | </div>
|
| 2715 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 2716 | <ul class="tsd-parameters">
|
| 2717 | <li>
|
| 2718 | <h5>fullyQualifiedName: <span class="tsd-signature-type">string</span></h5>
|
| 2719 | <div class="tsd-comment tsd-typography">
|
| 2720 | <p>the name to transfer</p>
|
| 2721 | </div>
|
| 2722 | </li>
|
| 2723 | <li>
|
| 2724 | <h5>destinationAddress: <span class="tsd-signature-type">string</span></h5>
|
| 2725 | <div class="tsd-comment tsd-typography">
|
| 2726 | <p>the next owner of the name</p>
|
| 2727 | </div>
|
| 2728 | </li>
|
| 2729 | <li>
|
| 2730 | <h5>ownerAddress: <span class="tsd-signature-type">string</span></h5>
|
| 2731 | <div class="tsd-comment tsd-typography">
|
| 2732 | <p>the current owner of the name</p>
|
| 2733 | </div>
|
| 2734 | </li>
|
| 2735 | <li>
|
| 2736 | <h5>paymentAddress: <span class="tsd-signature-type">string</span></h5>
|
| 2737 | <div class="tsd-comment tsd-typography">
|
| 2738 | <p>the address funding the transfer</p>
|
| 2739 | </div>
|
| 2740 | </li>
|
| 2741 | <li>
|
| 2742 | <h5><span class="tsd-flag ts-flagDefault value">Default value</span> paymentUtxos: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 1</span></h5>
|
| 2743 | <div class="tsd-comment tsd-typography">
|
| 2744 | <p>the number of UTXOs we expect will be required
|
| 2745 | from the payment address.</p>
|
| 2746 | </div>
|
| 2747 | </li>
|
| 2748 | </ul>
|
| 2749 | <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>
|
| 2750 | <ul>
|
| 2751 | <li>a promise which resolves to the satoshi cost to fund
|
| 2752 | the transfer.</li>
|
| 2753 | </ul>
|
| 2754 | </li>
|
| 2755 | </ul>
|
| 2756 | </section>
|
| 2757 | <section class="tsd-panel tsd-member tsd-kind-function tsd-is-private tsd-is-not-exported">
|
| 2758 | <a name="estimateupdate" class="tsd-anchor"></a>
|
| 2759 | <h3><span class="tsd-flag ts-flagPrivate">Private</span> estimate<wbr>Update</h3>
|
| 2760 | <ul class="tsd-signatures tsd-kind-function tsd-is-private tsd-is-not-exported">
|
| 2761 | <li class="tsd-signature tsd-kind-icon">estimate<wbr>Update<span class="tsd-signature-symbol">(</span>fullyQualifiedName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, ownerAddress<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, paymentAddress<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, paymentUtxos<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>
|
| 2762 | </ul>
|
| 2763 | <ul class="tsd-descriptions">
|
| 2764 | <li class="tsd-description">
|
| 2765 | <aside class="tsd-sources">
|
| 2766 | <ul>
|
| 2767 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/operations/txbuild.ts#L166">operations/txbuild.ts:166</a></li>
|
| 2768 | </ul>
|
| 2769 | </aside>
|
| 2770 | <div class="tsd-comment tsd-typography">
|
| 2771 | <div class="lead">
|
| 2772 | <p>Estimates cost of an update transaction for a domain name.</p>
|
| 2773 | </div>
|
| 2774 | </div>
|
| 2775 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 2776 | <ul class="tsd-parameters">
|
| 2777 | <li>
|
| 2778 | <h5>fullyQualifiedName: <span class="tsd-signature-type">string</span></h5>
|
| 2779 | <div class="tsd-comment tsd-typography">
|
| 2780 | <p>the name to update</p>
|
| 2781 | </div>
|
| 2782 | </li>
|
| 2783 | <li>
|
| 2784 | <h5>ownerAddress: <span class="tsd-signature-type">string</span></h5>
|
| 2785 | <div class="tsd-comment tsd-typography">
|
| 2786 | <p>the owner of the name</p>
|
| 2787 | </div>
|
| 2788 | </li>
|
| 2789 | <li>
|
| 2790 | <h5>paymentAddress: <span class="tsd-signature-type">string</span></h5>
|
| 2791 | <div class="tsd-comment tsd-typography">
|
| 2792 | <p>the address funding the update</p>
|
| 2793 | </div>
|
| 2794 | </li>
|
| 2795 | <li>
|
| 2796 | <h5><span class="tsd-flag ts-flagDefault value">Default value</span> paymentUtxos: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 1</span></h5>
|
| 2797 | <div class="tsd-comment tsd-typography">
|
| 2798 | <p>the number of UTXOs we expect will be required
|
| 2799 | from the payment address.</p>
|
| 2800 | </div>
|
| 2801 | </li>
|
| 2802 | </ul>
|
| 2803 | <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>
|
| 2804 | <ul>
|
| 2805 | <li>a promise which resolves to the satoshi cost to fund
|
| 2806 | the update.</li>
|
| 2807 | </ul>
|
| 2808 | </li>
|
| 2809 | </ul>
|
| 2810 | </section>
|
| 2811 | <section class="tsd-panel tsd-member tsd-kind-function">
|
| 2812 | <a name="extractprofile" class="tsd-anchor"></a>
|
| 2813 | <h3>extract<wbr>Profile</h3>
|
| 2814 | <ul class="tsd-signatures tsd-kind-function">
|
| 2815 | <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">object</span></li>
|
| 2816 | </ul>
|
| 2817 | <ul class="tsd-descriptions">
|
| 2818 | <li class="tsd-description">
|
| 2819 | <aside class="tsd-sources">
|
| 2820 | <ul>
|
| 2821 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileTokens.ts#L141">profiles/profileTokens.ts:141</a></li>
|
| 2822 | </ul>
|
| 2823 | </aside>
|
| 2824 | <div class="tsd-comment tsd-typography">
|
| 2825 | <div class="lead">
|
| 2826 | <p>Extracts a profile from an encoded token and optionally verifies it,
|
| 2827 | if <code>publicKeyOrAddress</code> is provided.</p>
|
| 2828 | </div>
|
| 2829 | <dl class="tsd-comment-tags">
|
| 2830 | <dt>throws</dt>
|
| 2831 | <dd><p>{Error} - if the token isn't signed by the provided <code>publicKeyOrAddress</code></p>
|
| 2832 | </dd>
|
| 2833 | </dl>
|
| 2834 | </div>
|
| 2835 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 2836 | <ul class="tsd-parameters">
|
| 2837 | <li>
|
| 2838 | <h5>token: <span class="tsd-signature-type">string</span></h5>
|
| 2839 | <div class="tsd-comment tsd-typography">
|
| 2840 | <p>the token to be extracted</p>
|
| 2841 | </div>
|
| 2842 | </li>
|
| 2843 | <li>
|
| 2844 | <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>
|
| 2845 | <div class="tsd-comment tsd-typography">
|
| 2846 | <p>the public key or address of the
|
| 2847 | keypair that is thought to have signed the token</p>
|
| 2848 | </div>
|
| 2849 | </li>
|
| 2850 | </ul>
|
| 2851 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">object</span></h4>
|
| 2852 | <ul>
|
| 2853 | <li>the profile extracted from the encoded token</li>
|
| 2854 | </ul>
|
| 2855 | <ul class="tsd-parameters">
|
| 2856 | </ul>
|
| 2857 | </li>
|
| 2858 | </ul>
|
| 2859 | </section>
|
| 2860 | <section class="tsd-panel tsd-member tsd-kind-function tsd-is-private">
|
| 2861 | <a name="fetchappmanifest" class="tsd-anchor"></a>
|
| 2862 | <h3><span class="tsd-flag ts-flagPrivate">Private</span> fetch<wbr>App<wbr>Manifest</h3>
|
| 2863 | <ul class="tsd-signatures tsd-kind-function tsd-is-private">
|
| 2864 | <li class="tsd-signature tsd-kind-icon">fetch<wbr>App<wbr>Manifest<span class="tsd-signature-symbol">(</span>authRequest<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>
|
| 2865 | </ul>
|
| 2866 | <ul class="tsd-descriptions">
|
| 2867 | <li class="tsd-description">
|
| 2868 | <aside class="tsd-sources">
|
| 2869 | <ul>
|
| 2870 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/auth/authProvider.ts#L33">auth/authProvider.ts:33</a></li>
|
| 2871 | </ul>
|
| 2872 | </aside>
|
| 2873 | <div class="tsd-comment tsd-typography">
|
| 2874 | <div class="lead">
|
| 2875 | <p>Fetches the contents of the manifest file specified in the authentication request</p>
|
| 2876 | </div>
|
| 2877 | </div>
|
| 2878 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 2879 | <ul class="tsd-parameters">
|
| 2880 | <li>
|
| 2881 | <h5>authRequest: <span class="tsd-signature-type">string</span></h5>
|
| 2882 | <div class="tsd-comment tsd-typography">
|
| 2883 | <p>encoded and signed authentication request</p>
|
| 2884 | </div>
|
| 2885 | </li>
|
| 2886 | </ul>
|
| 2887 | <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>
|
| 2888 | <p>Returns a <code>Promise</code> that resolves to the JSON
|
| 2889 | object manifest file unless there's an error in which case rejects with an error
|
| 2890 | message.</p>
|
| 2891 | </li>
|
| 2892 | </ul>
|
| 2893 | </section>
|
| 2894 | <section class="tsd-panel tsd-member tsd-kind-function tsd-is-not-exported">
|
| 2895 | <a name="formataccount" class="tsd-anchor"></a>
|
| 2896 | <h3>format<wbr>Account</h3>
|
| 2897 | <ul class="tsd-signatures tsd-kind-function tsd-is-not-exported">
|
| 2898 | <li class="tsd-signature tsd-kind-icon">format<wbr>Account<span class="tsd-signature-symbol">(</span>serviceName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, data<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">object</span></li>
|
| 2899 | </ul>
|
| 2900 | <ul class="tsd-descriptions">
|
| 2901 | <li class="tsd-description">
|
| 2902 | <aside class="tsd-sources">
|
| 2903 | <ul>
|
| 2904 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/personLegacy.ts#L1">profiles/profileSchemas/personLegacy.ts:1</a></li>
|
| 2905 | </ul>
|
| 2906 | </aside>
|
| 2907 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 2908 | <ul class="tsd-parameters">
|
| 2909 | <li>
|
| 2910 | <h5>serviceName: <span class="tsd-signature-type">string</span></h5>
|
| 2911 | </li>
|
| 2912 | <li>
|
| 2913 | <h5>data: <span class="tsd-signature-type">any</span></h5>
|
| 2914 | </li>
|
| 2915 | </ul>
|
| 2916 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">object</span></h4>
|
| 2917 | <ul class="tsd-parameters">
|
| 2918 | <li class="tsd-parameter">
|
| 2919 | <h5>@type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
|
| 2920 | </li>
|
| 2921 | <li class="tsd-parameter">
|
| 2922 | <h5>identifier<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></h5>
|
| 2923 | </li>
|
| 2924 | <li class="tsd-parameter">
|
| 2925 | <h5>proof<wbr>Type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
|
| 2926 | </li>
|
| 2927 | <li class="tsd-parameter">
|
| 2928 | <h5>proof<wbr>Url<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></h5>
|
| 2929 | </li>
|
| 2930 | <li class="tsd-parameter">
|
| 2931 | <h5>service<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
|
| 2932 | </li>
|
| 2933 | </ul>
|
| 2934 | </li>
|
| 2935 | </ul>
|
| 2936 | </section>
|
| 2937 | <section class="tsd-panel tsd-member tsd-kind-function tsd-is-not-exported">
|
| 2938 | <a name="fundtransaction" class="tsd-anchor"></a>
|
| 2939 | <h3>fund<wbr>Transaction</h3>
|
| 2940 | <ul class="tsd-signatures tsd-kind-function tsd-is-not-exported">
|
| 2941 | <li class="tsd-signature tsd-kind-icon">fund<wbr>Transaction<span class="tsd-signature-symbol">(</span>txB<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">bitcoinjs.TransactionBuilder</span>, paymentAddress<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, utxos<span class="tsd-signature-symbol">: </span><a href="globals.html#utxo" class="tsd-signature-type">UTXO</a><span class="tsd-signature-symbol">[]</span>, feeRate<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, inAmounts<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, changeIndex<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</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">TransactionBuilder</span></li>
|
| 2942 | </ul>
|
| 2943 | <ul class="tsd-descriptions">
|
| 2944 | <li class="tsd-description">
|
| 2945 | <aside class="tsd-sources">
|
| 2946 | <ul>
|
| 2947 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/operations/txbuild.ts#L46">operations/txbuild.ts:46</a></li>
|
| 2948 | </ul>
|
| 2949 | </aside>
|
| 2950 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 2951 | <ul class="tsd-parameters">
|
| 2952 | <li>
|
| 2953 | <h5>txB: <span class="tsd-signature-type">bitcoinjs.TransactionBuilder</span></h5>
|
| 2954 | </li>
|
| 2955 | <li>
|
| 2956 | <h5>paymentAddress: <span class="tsd-signature-type">string</span></h5>
|
| 2957 | </li>
|
| 2958 | <li>
|
| 2959 | <h5>utxos: <a href="globals.html#utxo" class="tsd-signature-type">UTXO</a><span class="tsd-signature-symbol">[]</span></h5>
|
| 2960 | </li>
|
| 2961 | <li>
|
| 2962 | <h5>feeRate: <span class="tsd-signature-type">number</span></h5>
|
| 2963 | </li>
|
| 2964 | <li>
|
| 2965 | <h5>inAmounts: <span class="tsd-signature-type">number</span></h5>
|
| 2966 | </li>
|
| 2967 | <li>
|
| 2968 | <h5><span class="tsd-flag ts-flagDefault value">Default value</span> changeIndex: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> = null</span></h5>
|
| 2969 | </li>
|
| 2970 | </ul>
|
| 2971 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">TransactionBuilder</span></h4>
|
| 2972 | </li>
|
| 2973 | </ul>
|
| 2974 | </section>
|
| 2975 | <section class="tsd-panel tsd-member tsd-kind-function tsd-is-private">
|
| 2976 | <a name="generatetransitkey" class="tsd-anchor"></a>
|
| 2977 | <h3><span class="tsd-flag ts-flagPrivate">Private</span> generate<wbr>Transit<wbr>Key</h3>
|
| 2978 | <ul class="tsd-signatures tsd-kind-function tsd-is-private">
|
| 2979 | <li class="tsd-signature tsd-kind-icon">generate<wbr>Transit<wbr>Key<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>
|
| 2980 | </ul>
|
| 2981 | <ul class="tsd-descriptions">
|
| 2982 | <li class="tsd-description">
|
| 2983 | <aside class="tsd-sources">
|
| 2984 | <ul>
|
| 2985 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/auth/authMessages.ts#L29">auth/authMessages.ts:29</a></li>
|
| 2986 | </ul>
|
| 2987 | </aside>
|
| 2988 | <div class="tsd-comment tsd-typography">
|
| 2989 | <div class="lead">
|
| 2990 | <p>Generates a ECDSA keypair to
|
| 2991 | use as the ephemeral app transit private key</p>
|
| 2992 | </div>
|
| 2993 | </div>
|
| 2994 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
|
| 2995 | <p>the hex encoded private key</p>
|
| 2996 | </li>
|
| 2997 | </ul>
|
| 2998 | </section>
|
| 2999 | <section class="tsd-panel tsd-member tsd-kind-function">
|
| 3000 | <a name="getaddress" class="tsd-anchor"></a>
|
| 3001 | <h3>get<wbr>Address</h3>
|
| 3002 | <ul class="tsd-signatures tsd-kind-function">
|
| 3003 | <li class="tsd-signature tsd-kind-icon">get<wbr>Address<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>
|
| 3004 | </ul>
|
| 3005 | <ul class="tsd-descriptions">
|
| 3006 | <li class="tsd-description">
|
| 3007 | <aside class="tsd-sources">
|
| 3008 | <ul>
|
| 3009 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/personUtils.ts#L149">profiles/profileSchemas/personUtils.ts:149</a></li>
|
| 3010 | </ul>
|
| 3011 | </aside>
|
| 3012 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 3013 | <ul class="tsd-parameters">
|
| 3014 | <li>
|
| 3015 | <h5>profile: <span class="tsd-signature-type">any</span></h5>
|
| 3016 | </li>
|
| 3017 | </ul>
|
| 3018 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
|
| 3019 | </li>
|
| 3020 | </ul>
|
| 3021 | </section>
|
| 3022 | <section class="tsd-panel tsd-member tsd-kind-function">
|
| 3023 | <a name="getaddressfromdid" class="tsd-anchor"></a>
|
| 3024 | <h3>get<wbr>Address<wbr>FromDID</h3>
|
| 3025 | <ul class="tsd-signatures tsd-kind-function">
|
| 3026 | <li class="tsd-signature tsd-kind-icon">get<wbr>Address<wbr>FromDID<span class="tsd-signature-symbol">(</span>decentralizedID<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>
|
| 3027 | </ul>
|
| 3028 | <ul class="tsd-descriptions">
|
| 3029 | <li class="tsd-description">
|
| 3030 | <aside class="tsd-sources">
|
| 3031 | <ul>
|
| 3032 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/dids.ts#L25">dids.ts:25</a></li>
|
| 3033 | </ul>
|
| 3034 | </aside>
|
| 3035 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 3036 | <ul class="tsd-parameters">
|
| 3037 | <li>
|
| 3038 | <h5>decentralizedID: <span class="tsd-signature-type">string</span></h5>
|
| 3039 | </li>
|
| 3040 | </ul>
|
| 3041 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
|
| 3042 | </li>
|
| 3043 | </ul>
|
| 3044 | </section>
|
| 3045 | <section class="tsd-panel tsd-member tsd-kind-function">
|
| 3046 | <a name="getappbucketurl" class="tsd-anchor"></a>
|
| 3047 | <h3>get<wbr>App<wbr>Bucket<wbr>Url</h3>
|
| 3048 | <ul class="tsd-signatures tsd-kind-function">
|
| 3049 | <li class="tsd-signature tsd-kind-icon">get<wbr>App<wbr>Bucket<wbr>Url<span class="tsd-signature-symbol">(</span>gaiaHubUrl<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</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-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>
|
| 3050 | </ul>
|
| 3051 | <ul class="tsd-descriptions">
|
| 3052 | <li class="tsd-description">
|
| 3053 | <aside class="tsd-sources">
|
| 3054 | <ul>
|
| 3055 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/storage/index.ts#L564">storage/index.ts:564</a></li>
|
| 3056 | </ul>
|
| 3057 | </aside>
|
| 3058 | <div class="tsd-comment tsd-typography">
|
| 3059 | <div class="lead">
|
| 3060 | <p>Get the app storage bucket URL</p>
|
| 3061 | </div>
|
| 3062 | </div>
|
| 3063 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 3064 | <ul class="tsd-parameters">
|
| 3065 | <li>
|
| 3066 | <h5>gaiaHubUrl: <span class="tsd-signature-type">string</span></h5>
|
| 3067 | <div class="tsd-comment tsd-typography">
|
| 3068 | <p>the gaia hub URL</p>
|
| 3069 | </div>
|
| 3070 | </li>
|
| 3071 | <li>
|
| 3072 | <h5>appPrivateKey: <span class="tsd-signature-type">string</span></h5>
|
| 3073 | <div class="tsd-comment tsd-typography">
|
| 3074 | <p>the app private key used to generate the app address</p>
|
| 3075 | </div>
|
| 3076 | </li>
|
| 3077 | </ul>
|
| 3078 | <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>
|
| 3079 | <p>That resolves to the URL of the app index file
|
| 3080 | or rejects if it fails</p>
|
| 3081 | </li>
|
| 3082 | </ul>
|
| 3083 | </section>
|
| 3084 | <section class="tsd-panel tsd-member tsd-kind-function tsd-is-private">
|
| 3085 | <a name="getauthrequestfromurl" class="tsd-anchor"></a>
|
| 3086 | <h3><span class="tsd-flag ts-flagPrivate">Private</span> get<wbr>Auth<wbr>Request<wbr>FromURL</h3>
|
| 3087 | <ul class="tsd-signatures tsd-kind-function tsd-is-private">
|
| 3088 | <li class="tsd-signature tsd-kind-icon">get<wbr>Auth<wbr>Request<wbr>FromURL<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>
|
| 3089 | </ul>
|
| 3090 | <ul class="tsd-descriptions">
|
| 3091 | <li class="tsd-description">
|
| 3092 | <aside class="tsd-sources">
|
| 3093 | <ul>
|
| 3094 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/auth/authProvider.ts#L14">auth/authProvider.ts:14</a></li>
|
| 3095 | </ul>
|
| 3096 | </aside>
|
| 3097 | <div class="tsd-comment tsd-typography">
|
| 3098 | <div class="lead">
|
| 3099 | <p>Retrieves the authentication request from the query string</p>
|
| 3100 | </div>
|
| 3101 | </div>
|
| 3102 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
|
| 3103 | <p>the authentication request or <code>null</code> if
|
| 3104 | the query string parameter <code>authRequest</code> is not found</p>
|
| 3105 | </li>
|
| 3106 | </ul>
|
| 3107 | </section>
|
| 3108 | <section class="tsd-panel tsd-member tsd-kind-function">
|
| 3109 | <a name="getauthresponsetoken" class="tsd-anchor"></a>
|
| 3110 | <h3>get<wbr>Auth<wbr>Response<wbr>Token</h3>
|
| 3111 | <ul class="tsd-signatures tsd-kind-function">
|
| 3112 | <li class="tsd-signature tsd-kind-icon">get<wbr>Auth<wbr>Response<wbr>Token<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>
|
| 3113 | </ul>
|
| 3114 | <ul class="tsd-descriptions">
|
| 3115 | <li class="tsd-description">
|
| 3116 | <aside class="tsd-sources">
|
| 3117 | <ul>
|
| 3118 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/auth/authApp.ts#L113">auth/authApp.ts:113</a></li>
|
| 3119 | </ul>
|
| 3120 | </aside>
|
| 3121 | <div class="tsd-comment tsd-typography">
|
| 3122 | <div class="lead">
|
| 3123 | <p>Retrieve the authentication token from the URL query</p>
|
| 3124 | </div>
|
| 3125 | </div>
|
| 3126 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
|
| 3127 | <p>the authentication token if it exists otherwise <code>null</code></p>
|
| 3128 | </li>
|
| 3129 | </ul>
|
| 3130 | </section>
|
| 3131 | <section class="tsd-panel tsd-member tsd-kind-function">
|
| 3132 | <a name="getavatarurl" class="tsd-anchor"></a>
|
| 3133 | <h3>get<wbr>Avatar<wbr>Url</h3>
|
| 3134 | <ul class="tsd-signatures tsd-kind-function">
|
| 3135 | <li class="tsd-signature tsd-kind-icon">get<wbr>Avatar<wbr>Url<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">string</span></li>
|
| 3136 | </ul>
|
| 3137 | <ul class="tsd-descriptions">
|
| 3138 | <li class="tsd-description">
|
| 3139 | <aside class="tsd-sources">
|
| 3140 | <ul>
|
| 3141 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/personUtils.ts#L63">profiles/profileSchemas/personUtils.ts:63</a></li>
|
| 3142 | </ul>
|
| 3143 | </aside>
|
| 3144 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 3145 | <ul class="tsd-parameters">
|
| 3146 | <li>
|
| 3147 | <h5>profile: <span class="tsd-signature-type">any</span></h5>
|
| 3148 | </li>
|
| 3149 | </ul>
|
| 3150 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
|
| 3151 | </li>
|
| 3152 | </ul>
|
| 3153 | </section>
|
| 3154 | <section class="tsd-panel tsd-member tsd-kind-function">
|
| 3155 | <a name="getbirthdate" class="tsd-anchor"></a>
|
| 3156 | <h3>get<wbr>Birth<wbr>Date</h3>
|
| 3157 | <ul class="tsd-signatures tsd-kind-function">
|
| 3158 | <li class="tsd-signature tsd-kind-icon">get<wbr>Birth<wbr>Date<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>
|
| 3159 | </ul>
|
| 3160 | <ul class="tsd-descriptions">
|
| 3161 | <li class="tsd-description">
|
| 3162 | <aside class="tsd-sources">
|
| 3163 | <ul>
|
| 3164 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/personUtils.ts#L180">profiles/profileSchemas/personUtils.ts:180</a></li>
|
| 3165 | </ul>
|
| 3166 | </aside>
|
| 3167 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 3168 | <ul class="tsd-parameters">
|
| 3169 | <li>
|
| 3170 | <h5>profile: <span class="tsd-signature-type">any</span></h5>
|
| 3171 | </li>
|
| 3172 | </ul>
|
| 3173 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
|
| 3174 | </li>
|
| 3175 | </ul>
|
| 3176 | </section>
|
| 3177 | <section class="tsd-panel tsd-member tsd-kind-function">
|
| 3178 | <a name="getbucketurl" class="tsd-anchor"></a>
|
| 3179 | <h3>get<wbr>Bucket<wbr>Url</h3>
|
| 3180 | <ul class="tsd-signatures tsd-kind-function">
|
| 3181 | <li class="tsd-signature tsd-kind-icon">get<wbr>Bucket<wbr>Url<span class="tsd-signature-symbol">(</span>gaiaHubUrl<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</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-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>
|
| 3182 | </ul>
|
| 3183 | <ul class="tsd-descriptions">
|
| 3184 | <li class="tsd-description">
|
| 3185 | <aside class="tsd-sources">
|
| 3186 | <ul>
|
| 3187 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/storage/hub.ts#L127">storage/hub.ts:127</a></li>
|
| 3188 | </ul>
|
| 3189 | </aside>
|
| 3190 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 3191 | <ul class="tsd-parameters">
|
| 3192 | <li>
|
| 3193 | <h5>gaiaHubUrl: <span class="tsd-signature-type">string</span></h5>
|
| 3194 | </li>
|
| 3195 | <li>
|
| 3196 | <h5>appPrivateKey: <span class="tsd-signature-type">string</span></h5>
|
| 3197 | </li>
|
| 3198 | </ul>
|
| 3199 | <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>
|
| 3200 | </li>
|
| 3201 | </ul>
|
| 3202 | </section>
|
| 3203 | <section class="tsd-panel tsd-member tsd-kind-function tsd-is-not-exported">
|
| 3204 | <a name="getbuffer" class="tsd-anchor"></a>
|
| 3205 | <h3>get<wbr>Buffer</h3>
|
| 3206 | <ul class="tsd-signatures tsd-kind-function tsd-is-not-exported">
|
| 3207 | <li class="tsd-signature tsd-kind-icon">get<wbr>Buffer<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">ArrayBuffer</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><span class="tsd-signature-type">Buffer</span></li>
|
| 3208 | </ul>
|
| 3209 | <ul class="tsd-descriptions">
|
| 3210 | <li class="tsd-description">
|
| 3211 | <aside class="tsd-sources">
|
| 3212 | <ul>
|
| 3213 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/encryption/ec.ts#L179">encryption/ec.ts:179</a></li>
|
| 3214 | </ul>
|
| 3215 | </aside>
|
| 3216 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 3217 | <ul class="tsd-parameters">
|
| 3218 | <li>
|
| 3219 | <h5>content: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">ArrayBuffer</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Buffer</span></h5>
|
| 3220 | </li>
|
| 3221 | </ul>
|
| 3222 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Buffer</span></h4>
|
| 3223 | </li>
|
| 3224 | </ul>
|
| 3225 | </section>
|
| 3226 | <section class="tsd-panel tsd-member tsd-kind-function">
|
| 3227 | <a name="getconnections" class="tsd-anchor"></a>
|
| 3228 | <h3>get<wbr>Connections</h3>
|
| 3229 | <ul class="tsd-signatures tsd-kind-function">
|
| 3230 | <li class="tsd-signature tsd-kind-icon">get<wbr>Connections<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><span class="tsd-signature-symbol">[]</span></li>
|
| 3231 | </ul>
|
| 3232 | <ul class="tsd-descriptions">
|
| 3233 | <li class="tsd-description">
|
| 3234 | <aside class="tsd-sources">
|
| 3235 | <ul>
|
| 3236 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/personUtils.ts#L135">profiles/profileSchemas/personUtils.ts:135</a></li>
|
| 3237 | </ul>
|
| 3238 | </aside>
|
| 3239 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 3240 | <ul class="tsd-parameters">
|
| 3241 | <li>
|
| 3242 | <h5>profile: <span class="tsd-signature-type">any</span></h5>
|
| 3243 | </li>
|
| 3244 | </ul>
|
| 3245 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h4>
|
| 3246 | </li>
|
| 3247 | </ul>
|
| 3248 | </section>
|
| 3249 | <section class="tsd-panel tsd-member tsd-kind-function tsd-is-private">
|
| 3250 | <a name="getcoresession" class="tsd-anchor"></a>
|
| 3251 | <h3><span class="tsd-flag ts-flagPrivate">Private</span> get<wbr>Core<wbr>Session</h3>
|
| 3252 | <ul class="tsd-signatures tsd-kind-function tsd-is-private">
|
| 3253 | <li class="tsd-signature tsd-kind-icon">get<wbr>Core<wbr>Session<span class="tsd-signature-symbol">(</span>coreHost<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, corePort<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, apiPassword<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, appPrivateKey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, blockchainId<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, authRequest<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, deviceId<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>
|
| 3254 | </ul>
|
| 3255 | <ul class="tsd-descriptions">
|
| 3256 | <li class="tsd-description">
|
| 3257 | <aside class="tsd-sources">
|
| 3258 | <ul>
|
| 3259 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/auth/authSession.ts#L123">auth/authSession.ts:123</a></li>
|
| 3260 | </ul>
|
| 3261 | </aside>
|
| 3262 | <div class="tsd-comment tsd-typography">
|
| 3263 | <div class="lead">
|
| 3264 | <p>Get a core session token. Generate an auth request, sign it, send it to Core,
|
| 3265 | and get back a session token.</p>
|
| 3266 | </div>
|
| 3267 | <dl class="tsd-comment-tags">
|
| 3268 | <dt>deprecated</dt>
|
| 3269 | <dd></dd>
|
| 3270 | </dl>
|
| 3271 | </div>
|
| 3272 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 3273 | <ul class="tsd-parameters">
|
| 3274 | <li>
|
| 3275 | <h5>coreHost: <span class="tsd-signature-type">string</span></h5>
|
| 3276 | <div class="tsd-comment tsd-typography">
|
| 3277 | <p>Core API server's hostname</p>
|
| 3278 | </div>
|
| 3279 | </li>
|
| 3280 | <li>
|
| 3281 | <h5>corePort: <span class="tsd-signature-type">number</span></h5>
|
| 3282 | <div class="tsd-comment tsd-typography">
|
| 3283 | <p>Core API server's port number</p>
|
| 3284 | </div>
|
| 3285 | </li>
|
| 3286 | <li>
|
| 3287 | <h5>apiPassword: <span class="tsd-signature-type">string</span></h5>
|
| 3288 | <div class="tsd-comment tsd-typography">
|
| 3289 | <p>core api password</p>
|
| 3290 | </div>
|
| 3291 | </li>
|
| 3292 | <li>
|
| 3293 | <h5>appPrivateKey: <span class="tsd-signature-type">string</span></h5>
|
| 3294 | <div class="tsd-comment tsd-typography">
|
| 3295 | <p>Application's private key</p>
|
| 3296 | </div>
|
| 3297 | </li>
|
| 3298 | <li>
|
| 3299 | <h5><span class="tsd-flag ts-flagDefault value">Default value</span> blockchainId: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = null</span></h5>
|
| 3300 | <div class="tsd-comment tsd-typography">
|
| 3301 | <p>blockchain ID of the user signing in.
|
| 3302 | <code>null</code> if user has no blockchain ID</p>
|
| 3303 | </div>
|
| 3304 | </li>
|
| 3305 | <li>
|
| 3306 | <h5><span class="tsd-flag ts-flagDefault value">Default value</span> authRequest: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = null</span></h5>
|
| 3307 | <div class="tsd-comment tsd-typography">
|
| 3308 | <p>authentication request token</p>
|
| 3309 | </div>
|
| 3310 | </li>
|
| 3311 | <li>
|
| 3312 | <h5><span class="tsd-flag ts-flagDefault value">Default value</span> deviceId: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "0"</span></h5>
|
| 3313 | <div class="tsd-comment tsd-typography">
|
| 3314 | <p>identifier for the current device</p>
|
| 3315 | </div>
|
| 3316 | </li>
|
| 3317 | </ul>
|
| 3318 | <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>
|
| 3319 | <p>a Promise that resolves to a Core session token or rejects
|
| 3320 | with an error message.</p>
|
| 3321 | </li>
|
| 3322 | </ul>
|
| 3323 | </section>
|
| 3324 | <section class="tsd-panel tsd-member tsd-kind-function">
|
| 3325 | <a name="getdidtype" class="tsd-anchor"></a>
|
| 3326 | <h3>getDIDType</h3>
|
| 3327 | <ul class="tsd-signatures tsd-kind-function">
|
| 3328 | <li class="tsd-signature tsd-kind-icon">getDIDType<span class="tsd-signature-symbol">(</span>decentralizedID<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>
|
| 3329 | </ul>
|
| 3330 | <ul class="tsd-descriptions">
|
| 3331 | <li class="tsd-description">
|
| 3332 | <aside class="tsd-sources">
|
| 3333 | <ul>
|
| 3334 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/dids.ts#L11">dids.ts:11</a></li>
|
| 3335 | </ul>
|
| 3336 | </aside>
|
| 3337 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 3338 | <ul class="tsd-parameters">
|
| 3339 | <li>
|
| 3340 | <h5>decentralizedID: <span class="tsd-signature-type">string</span></h5>
|
| 3341 | </li>
|
| 3342 | </ul>
|
| 3343 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
|
| 3344 | </li>
|
| 3345 | </ul>
|
| 3346 | </section>
|
| 3347 | <section class="tsd-panel tsd-member tsd-kind-function">
|
| 3348 | <a name="getdescription" class="tsd-anchor"></a>
|
| 3349 | <h3>get<wbr>Description</h3>
|
| 3350 | <ul class="tsd-signatures tsd-kind-function">
|
| 3351 | <li class="tsd-signature tsd-kind-icon">get<wbr>Description<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>
|
| 3352 | </ul>
|
| 3353 | <ul class="tsd-descriptions">
|
| 3354 | <li class="tsd-description">
|
| 3355 | <aside class="tsd-sources">
|
| 3356 | <ul>
|
| 3357 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/personUtils.ts#L51">profiles/profileSchemas/personUtils.ts:51</a></li>
|
| 3358 | </ul>
|
| 3359 | </aside>
|
| 3360 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 3361 | <ul class="tsd-parameters">
|
| 3362 | <li>
|
| 3363 | <h5>profile: <span class="tsd-signature-type">any</span></h5>
|
| 3364 | </li>
|
| 3365 | </ul>
|
| 3366 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
|
| 3367 | </li>
|
| 3368 | </ul>
|
| 3369 | </section>
|
| 3370 | <section class="tsd-panel tsd-member tsd-kind-function">
|
| 3371 | <a name="getentropy" class="tsd-anchor"></a>
|
| 3372 | <h3>get<wbr>Entropy</h3>
|
| 3373 | <ul class="tsd-signatures tsd-kind-function">
|
| 3374 | <li class="tsd-signature tsd-kind-icon">get<wbr>Entropy<span class="tsd-signature-symbol">(</span>numberOfBytes<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>
|
| 3375 | </ul>
|
| 3376 | <ul class="tsd-descriptions">
|
| 3377 | <li class="tsd-description">
|
| 3378 | <aside class="tsd-sources">
|
| 3379 | <ul>
|
| 3380 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/keys.ts#L5">keys.ts:5</a></li>
|
| 3381 | </ul>
|
| 3382 | </aside>
|
| 3383 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 3384 | <ul class="tsd-parameters">
|
| 3385 | <li>
|
| 3386 | <h5>numberOfBytes: <span class="tsd-signature-type">number</span></h5>
|
| 3387 | </li>
|
| 3388 | </ul>
|
| 3389 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Buffer</span></h4>
|
| 3390 | </li>
|
| 3391 | </ul>
|
| 3392 | </section>
|
| 3393 | <section class="tsd-panel tsd-member tsd-kind-function">
|
| 3394 | <a name="getfamilyname" class="tsd-anchor"></a>
|
| 3395 | <h3>get<wbr>Family<wbr>Name</h3>
|
| 3396 | <ul class="tsd-signatures tsd-kind-function">
|
| 3397 | <li class="tsd-signature tsd-kind-icon">get<wbr>Family<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>
|
| 3398 | </ul>
|
| 3399 | <ul class="tsd-descriptions">
|
| 3400 | <li class="tsd-description">
|
| 3401 | <aside class="tsd-sources">
|
| 3402 | <ul>
|
| 3403 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/personUtils.ts#L36">profiles/profileSchemas/personUtils.ts:36</a></li>
|
| 3404 | </ul>
|
| 3405 | </aside>
|
| 3406 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 3407 | <ul class="tsd-parameters">
|
| 3408 | <li>
|
| 3409 | <h5>profile: <span class="tsd-signature-type">any</span></h5>
|
| 3410 | </li>
|
| 3411 | </ul>
|
| 3412 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
|
| 3413 | </li>
|
| 3414 | </ul>
|
| 3415 | </section>
|
| 3416 | <section class="tsd-panel tsd-member tsd-kind-function">
|
| 3417 | <a name="getfile" class="tsd-anchor"></a>
|
| 3418 | <h3>get<wbr>File</h3>
|
| 3419 | <ul class="tsd-signatures tsd-kind-function">
|
| 3420 | <li class="tsd-signature tsd-kind-icon">get<wbr>File<span class="tsd-signature-symbol">(</span>path<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">object</span>, caller<span class="tsd-signature-symbol">?: </span><a href="classes/usersession.html" class="tsd-signature-type">UserSession</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><span class="tsd-signature-type">ArrayBuffer</span><span class="tsd-signature-symbol">></span></li>
|
| 3421 | </ul>
|
| 3422 | <ul class="tsd-descriptions">
|
| 3423 | <li class="tsd-description">
|
| 3424 | <aside class="tsd-sources">
|
| 3425 | <ul>
|
| 3426 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/storage/index.ts#L394">storage/index.ts:394</a></li>
|
| 3427 | </ul>
|
| 3428 | </aside>
|
| 3429 | <div class="tsd-comment tsd-typography">
|
| 3430 | <div class="lead">
|
| 3431 | <p>Retrieves the specified file from the app's data store.</p>
|
| 3432 | </div>
|
| 3433 | </div>
|
| 3434 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 3435 | <ul class="tsd-parameters">
|
| 3436 | <li>
|
| 3437 | <h5>path: <span class="tsd-signature-type">string</span></h5>
|
| 3438 | <div class="tsd-comment tsd-typography">
|
| 3439 | <p>the path to the file to read</p>
|
| 3440 | </div>
|
| 3441 | </li>
|
| 3442 | <li>
|
| 3443 | <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">object</span></h5>
|
| 3444 | <ul class="tsd-parameters">
|
| 3445 | <li class="tsd-parameter">
|
| 3446 | <h5><span class="tsd-flag ts-flagOptional">Optional</span> app<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5>
|
| 3447 | <div class="tsd-comment tsd-typography">
|
| 3448 | <p>the app to lookup for multi-player storage -
|
| 3449 | defaults to current origin</p>
|
| 3450 | </div>
|
| 3451 | </li>
|
| 3452 | <li class="tsd-parameter">
|
| 3453 | <h5><span class="tsd-flag ts-flagOptional">Optional</span> decrypt<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5>
|
| 3454 | </li>
|
| 3455 | <li class="tsd-parameter">
|
| 3456 | <h5><span class="tsd-flag ts-flagOptional">Optional</span> username<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5>
|
| 3457 | <div class="tsd-comment tsd-typography">
|
| 3458 | <p>the Blockstack ID to lookup for multi-player storage</p>
|
| 3459 | </div>
|
| 3460 | </li>
|
| 3461 | <li class="tsd-parameter">
|
| 3462 | <h5><span class="tsd-flag ts-flagOptional">Optional</span> verify<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5>
|
| 3463 | <div class="tsd-comment tsd-typography">
|
| 3464 | <p>Whether the content should be verified, only to be used
|
| 3465 | when <code>putFile</code> was set to <code>sign = true</code></p>
|
| 3466 | </div>
|
| 3467 | </li>
|
| 3468 | <li class="tsd-parameter">
|
| 3469 | <h5><span class="tsd-flag ts-flagOptional">Optional</span> zone<wbr>File<wbr>LookupURL<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5>
|
| 3470 | </li>
|
| 3471 | </ul>
|
| 3472 | </li>
|
| 3473 | <li>
|
| 3474 | <h5><span class="tsd-flag ts-flagOptional">Optional</span> caller: <a href="classes/usersession.html" class="tsd-signature-type">UserSession</a></h5>
|
| 3475 | </li>
|
| 3476 | </ul>
|
| 3477 | <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">ArrayBuffer</span><span class="tsd-signature-symbol">></span></h4>
|
| 3478 | <p>that resolves to the raw data in the file
|
| 3479 | or rejects with an error</p>
|
| 3480 | </li>
|
| 3481 | </ul>
|
| 3482 | </section>
|
| 3483 | <section class="tsd-panel tsd-member tsd-kind-function tsd-is-not-exported">
|
| 3484 | <a name="getfilecontents" class="tsd-anchor"></a>
|
| 3485 | <h3>get<wbr>File<wbr>Contents</h3>
|
| 3486 | <ul class="tsd-signatures tsd-kind-function tsd-is-not-exported">
|
| 3487 | <li class="tsd-signature tsd-kind-icon">get<wbr>File<wbr>Contents<span class="tsd-signature-symbol">(</span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, app<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</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-type">undefined</span>, zoneFileLookupURL<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span>, forceText<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span>, caller<span class="tsd-signature-symbol">?: </span><a href="classes/usersession.html" class="tsd-signature-type">UserSession</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><span class="tsd-signature-type">ArrayBuffer</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">></span></li>
|
| 3488 | </ul>
|
| 3489 | <ul class="tsd-descriptions">
|
| 3490 | <li class="tsd-description">
|
| 3491 | <aside class="tsd-sources">
|
| 3492 | <ul>
|
| 3493 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/storage/index.ts#L219">storage/index.ts:219</a></li>
|
| 3494 | </ul>
|
| 3495 | </aside>
|
| 3496 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 3497 | <ul class="tsd-parameters">
|
| 3498 | <li>
|
| 3499 | <h5>path: <span class="tsd-signature-type">string</span></h5>
|
| 3500 | </li>
|
| 3501 | <li>
|
| 3502 | <h5>app: <span class="tsd-signature-type">string</span></h5>
|
| 3503 | </li>
|
| 3504 | <li>
|
| 3505 | <h5>username: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span></h5>
|
| 3506 | </li>
|
| 3507 | <li>
|
| 3508 | <h5>zoneFileLookupURL: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span></h5>
|
| 3509 | </li>
|
| 3510 | <li>
|
| 3511 | <h5>forceText: <span class="tsd-signature-type">boolean</span></h5>
|
| 3512 | </li>
|
| 3513 | <li>
|
| 3514 | <h5><span class="tsd-flag ts-flagOptional">Optional</span> caller: <a href="classes/usersession.html" class="tsd-signature-type">UserSession</a></h5>
|
| 3515 | </li>
|
| 3516 | </ul>
|
| 3517 | <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">ArrayBuffer</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">></span></h4>
|
| 3518 | </li>
|
| 3519 | </ul>
|
| 3520 | </section>
|
| 3521 | <section class="tsd-panel tsd-member tsd-kind-function tsd-is-not-exported">
|
| 3522 | <a name="getfilesignedunencrypted" class="tsd-anchor"></a>
|
| 3523 | <h3>get<wbr>File<wbr>Signed<wbr>Unencrypted</h3>
|
| 3524 | <ul class="tsd-signatures tsd-kind-function tsd-is-not-exported">
|
| 3525 | <li class="tsd-signature tsd-kind-icon">get<wbr>File<wbr>Signed<wbr>Unencrypted<span class="tsd-signature-symbol">(</span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, opt<span class="tsd-signature-symbol">: </span><a href="globals.html#getfileoptions" class="tsd-signature-type">GetFileOptions</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type">object</span>, caller<span class="tsd-signature-symbol">?: </span><a href="classes/usersession.html" class="tsd-signature-type">UserSession</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><span class="tsd-signature-type">ArrayBuffer</span><span class="tsd-signature-symbol">></span></li>
|
| 3526 | </ul>
|
| 3527 | <ul class="tsd-descriptions">
|
| 3528 | <li class="tsd-description">
|
| 3529 | <aside class="tsd-sources">
|
| 3530 | <ul>
|
| 3531 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/storage/index.ts#L254">storage/index.ts:254</a></li>
|
| 3532 | </ul>
|
| 3533 | </aside>
|
| 3534 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 3535 | <ul class="tsd-parameters">
|
| 3536 | <li>
|
| 3537 | <h5>path: <span class="tsd-signature-type">string</span></h5>
|
| 3538 | </li>
|
| 3539 | <li>
|
| 3540 | <h5>opt: <a href="globals.html#getfileoptions" class="tsd-signature-type">GetFileOptions</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type">object</span></h5>
|
| 3541 | </li>
|
| 3542 | <li>
|
| 3543 | <h5><span class="tsd-flag ts-flagOptional">Optional</span> caller: <a href="classes/usersession.html" class="tsd-signature-type">UserSession</a></h5>
|
| 3544 | </li>
|
| 3545 | </ul>
|
| 3546 | <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">ArrayBuffer</span><span class="tsd-signature-symbol">></span></h4>
|
| 3547 | </li>
|
| 3548 | </ul>
|
| 3549 | </section>
|
| 3550 | <section class="tsd-panel tsd-member tsd-kind-function">
|
| 3551 | <a name="getfileurl" class="tsd-anchor"></a>
|
| 3552 | <h3>get<wbr>File<wbr>Url</h3>
|
| 3553 | <ul class="tsd-signatures tsd-kind-function">
|
| 3554 | <li class="tsd-signature tsd-kind-icon">get<wbr>File<wbr>Url<span class="tsd-signature-symbol">(</span>path<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">object</span>, caller<span class="tsd-signature-symbol">?: </span><a href="classes/usersession.html" class="tsd-signature-type">UserSession</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>
|
| 3555 | </ul>
|
| 3556 | <ul class="tsd-descriptions">
|
| 3557 | <li class="tsd-description">
|
| 3558 | <aside class="tsd-sources">
|
| 3559 | <ul>
|
| 3560 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/storage/index.ts#L189">storage/index.ts:189</a></li>
|
| 3561 | </ul>
|
| 3562 | </aside>
|
| 3563 | <div class="tsd-comment tsd-typography">
|
| 3564 | <div class="lead">
|
| 3565 | <p>Get the URL for reading a file from an app's data store.</p>
|
| 3566 | </div>
|
| 3567 | </div>
|
| 3568 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 3569 | <ul class="tsd-parameters">
|
| 3570 | <li>
|
| 3571 | <h5>path: <span class="tsd-signature-type">string</span></h5>
|
| 3572 | <div class="tsd-comment tsd-typography">
|
| 3573 | <p>the path to the file to read</p>
|
| 3574 | </div>
|
| 3575 | </li>
|
| 3576 | <li>
|
| 3577 | <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">object</span></h5>
|
| 3578 | <ul class="tsd-parameters">
|
| 3579 | <li class="tsd-parameter">
|
| 3580 | <h5><span class="tsd-flag ts-flagOptional">Optional</span> app<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5>
|
| 3581 | <div class="tsd-comment tsd-typography">
|
| 3582 | <p>the app to lookup for multi-player storage -
|
| 3583 | defaults to current origin</p>
|
| 3584 | </div>
|
| 3585 | </li>
|
| 3586 | <li class="tsd-parameter">
|
| 3587 | <h5><span class="tsd-flag ts-flagOptional">Optional</span> username<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5>
|
| 3588 | <div class="tsd-comment tsd-typography">
|
| 3589 | <p>the Blockstack ID to lookup for multi-player storage</p>
|
| 3590 | </div>
|
| 3591 | </li>
|
| 3592 | <li class="tsd-parameter">
|
| 3593 | <h5><span class="tsd-flag ts-flagOptional">Optional</span> zone<wbr>File<wbr>LookupURL<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5>
|
| 3594 | </li>
|
| 3595 | </ul>
|
| 3596 | </li>
|
| 3597 | <li>
|
| 3598 | <h5><span class="tsd-flag ts-flagOptional">Optional</span> caller: <a href="classes/usersession.html" class="tsd-signature-type">UserSession</a></h5>
|
| 3599 | </li>
|
| 3600 | </ul>
|
| 3601 | <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>
|
| 3602 | <p>that resolves to the URL or rejects with an error</p>
|
| 3603 | </li>
|
| 3604 | </ul>
|
| 3605 | </section>
|
| 3606 | <section class="tsd-panel tsd-member tsd-kind-function">
|
| 3607 | <a name="getfullreadurl" class="tsd-anchor"></a>
|
| 3608 | <h3>get<wbr>Full<wbr>Read<wbr>Url</h3>
|
| 3609 | <ul class="tsd-signatures tsd-kind-function">
|
| 3610 | <li class="tsd-signature tsd-kind-icon">get<wbr>Full<wbr>Read<wbr>Url<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="globals.html#gaiahubconfig" 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>
|
| 3611 | </ul>
|
| 3612 | <ul class="tsd-descriptions">
|
| 3613 | <li class="tsd-description">
|
| 3614 | <aside class="tsd-sources">
|
| 3615 | <ul>
|
| 3616 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/storage/hub.ts#L44">storage/hub.ts:44</a></li>
|
| 3617 | </ul>
|
| 3618 | </aside>
|
| 3619 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 3620 | <ul class="tsd-parameters">
|
| 3621 | <li>
|
| 3622 | <h5>filename: <span class="tsd-signature-type">string</span></h5>
|
| 3623 | </li>
|
| 3624 | <li>
|
| 3625 | <h5>hubConfig: <a href="globals.html#gaiahubconfig" class="tsd-signature-type">GaiaHubConfig</a></h5>
|
| 3626 | </li>
|
| 3627 | </ul>
|
| 3628 | <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>
|
| 3629 | </li>
|
| 3630 | </ul>
|
| 3631 | </section>
|
| 3632 | <section class="tsd-panel tsd-member tsd-kind-function tsd-is-not-exported">
|
| 3633 | <a name="getgaiaaddress" class="tsd-anchor"></a>
|
| 3634 | <h3>get<wbr>Gaia<wbr>Address</h3>
|
| 3635 | <ul class="tsd-signatures tsd-kind-function tsd-is-not-exported">
|
| 3636 | <li class="tsd-signature tsd-kind-icon">get<wbr>Gaia<wbr>Address<span class="tsd-signature-symbol">(</span>app<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, username<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, zoneFileLookupURL<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, caller<span class="tsd-signature-symbol">?: </span><a href="classes/usersession.html" class="tsd-signature-type">UserSession</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>
|
| 3637 | </ul>
|
| 3638 | <ul class="tsd-descriptions">
|
| 3639 | <li class="tsd-description">
|
| 3640 | <aside class="tsd-sources">
|
| 3641 | <ul>
|
| 3642 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/storage/index.ts#L130">storage/index.ts:130</a></li>
|
| 3643 | </ul>
|
| 3644 | </aside>
|
| 3645 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 3646 | <ul class="tsd-parameters">
|
| 3647 | <li>
|
| 3648 | <h5>app: <span class="tsd-signature-type">string</span></h5>
|
| 3649 | </li>
|
| 3650 | <li>
|
| 3651 | <h5><span class="tsd-flag ts-flagOptional">Optional</span> username: <span class="tsd-signature-type">string</span></h5>
|
| 3652 | </li>
|
| 3653 | <li>
|
| 3654 | <h5><span class="tsd-flag ts-flagOptional">Optional</span> zoneFileLookupURL: <span class="tsd-signature-type">string</span></h5>
|
| 3655 | </li>
|
| 3656 | <li>
|
| 3657 | <h5><span class="tsd-flag ts-flagOptional">Optional</span> caller: <a href="classes/usersession.html" class="tsd-signature-type">UserSession</a></h5>
|
| 3658 | </li>
|
| 3659 | </ul>
|
| 3660 | <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>
|
| 3661 | </li>
|
| 3662 | </ul>
|
| 3663 | </section>
|
| 3664 | <section class="tsd-panel tsd-member tsd-kind-function">
|
| 3665 | <a name="getgivenname" class="tsd-anchor"></a>
|
| 3666 | <h3>get<wbr>Given<wbr>Name</h3>
|
| 3667 | <ul class="tsd-signatures tsd-kind-function">
|
| 3668 | <li class="tsd-signature tsd-kind-icon">get<wbr>Given<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>
|
| 3669 | </ul>
|
| 3670 | <ul class="tsd-descriptions">
|
| 3671 | <li class="tsd-description">
|
| 3672 | <aside class="tsd-sources">
|
| 3673 | <ul>
|
| 3674 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/personUtils.ts#L21">profiles/profileSchemas/personUtils.ts:21</a></li>
|
| 3675 | </ul>
|
| 3676 | </aside>
|
| 3677 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 3678 | <ul class="tsd-parameters">
|
| 3679 | <li>
|
| 3680 | <h5>profile: <span class="tsd-signature-type">any</span></h5>
|
| 3681 | </li>
|
| 3682 | </ul>
|
| 3683 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
|
| 3684 | </li>
|
| 3685 | </ul>
|
| 3686 | </section>
|
| 3687 | <section class="tsd-panel tsd-member tsd-kind-function">
|
| 3688 | <a name="gethexfrombn" class="tsd-anchor"></a>
|
| 3689 | <h3>get<wbr>Hex<wbr>FromBN</h3>
|
| 3690 | <ul class="tsd-signatures tsd-kind-function">
|
| 3691 | <li class="tsd-signature tsd-kind-icon">get<wbr>Hex<wbr>FromBN<span class="tsd-signature-symbol">(</span>bnInput<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BN</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
|
| 3692 | </ul>
|
| 3693 | <ul class="tsd-descriptions">
|
| 3694 | <li class="tsd-description">
|
| 3695 | <aside class="tsd-sources">
|
| 3696 | <ul>
|
| 3697 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/encryption/ec.ts#L51">encryption/ec.ts:51</a></li>
|
| 3698 | </ul>
|
| 3699 | </aside>
|
| 3700 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 3701 | <ul class="tsd-parameters">
|
| 3702 | <li>
|
| 3703 | <h5>bnInput: <span class="tsd-signature-type">BN</span></h5>
|
| 3704 | </li>
|
| 3705 | </ul>
|
| 3706 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
|
| 3707 | </li>
|
| 3708 | </ul>
|
| 3709 | </section>
|
| 3710 | <section class="tsd-panel tsd-member tsd-kind-function">
|
| 3711 | <a name="getname" class="tsd-anchor"></a>
|
| 3712 | <h3>get<wbr>Name</h3>
|
| 3713 | <ul class="tsd-signatures tsd-kind-function">
|
| 3714 | <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>
|
| 3715 | </ul>
|
| 3716 | <ul class="tsd-descriptions">
|
| 3717 | <li class="tsd-description">
|
| 3718 | <aside class="tsd-sources">
|
| 3719 | <ul>
|
| 3720 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/personUtils.ts#L1">profiles/profileSchemas/personUtils.ts:1</a></li>
|
| 3721 | </ul>
|
| 3722 | </aside>
|
| 3723 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 3724 | <ul class="tsd-parameters">
|
| 3725 | <li>
|
| 3726 | <h5>profile: <span class="tsd-signature-type">any</span></h5>
|
| 3727 | </li>
|
| 3728 | </ul>
|
| 3729 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
|
| 3730 | </li>
|
| 3731 | </ul>
|
| 3732 | </section>
|
| 3733 | <section class="tsd-panel tsd-member tsd-kind-function tsd-is-not-exported">
|
| 3734 | <a name="getnodeprivatekey" class="tsd-anchor"></a>
|
| 3735 | <h3>get<wbr>Node<wbr>Private<wbr>Key</h3>
|
| 3736 | <ul class="tsd-signatures tsd-kind-function tsd-is-not-exported">
|
| 3737 | <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">BIP32</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
|
| 3738 | </ul>
|
| 3739 | <ul class="tsd-descriptions">
|
| 3740 | <li class="tsd-description">
|
| 3741 | <aside class="tsd-sources">
|
| 3742 | <ul>
|
| 3743 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/wallet.ts#L39">wallet.ts:39</a></li>
|
| 3744 | </ul>
|
| 3745 | </aside>
|
| 3746 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 3747 | <ul class="tsd-parameters">
|
| 3748 | <li>
|
| 3749 | <h5>node: <span class="tsd-signature-type">BIP32</span></h5>
|
| 3750 | </li>
|
| 3751 | </ul>
|
| 3752 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
|
| 3753 | </li>
|
| 3754 | </ul>
|
| 3755 | </section>
|
| 3756 | <section class="tsd-panel tsd-member tsd-kind-function tsd-is-not-exported">
|
| 3757 | <a name="getnodepublickey" class="tsd-anchor"></a>
|
| 3758 | <h3>get<wbr>Node<wbr>Public<wbr>Key</h3>
|
| 3759 | <ul class="tsd-signatures tsd-kind-function tsd-is-not-exported">
|
| 3760 | <li class="tsd-signature tsd-kind-icon">get<wbr>Node<wbr>Public<wbr>Key<span class="tsd-signature-symbol">(</span>node<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BIP32</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
|
| 3761 | </ul>
|
| 3762 | <ul class="tsd-descriptions">
|
| 3763 | <li class="tsd-description">
|
| 3764 | <aside class="tsd-sources">
|
| 3765 | <ul>
|
| 3766 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/wallet.ts#L43">wallet.ts:43</a></li>
|
| 3767 | </ul>
|
| 3768 | </aside>
|
| 3769 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 3770 | <ul class="tsd-parameters">
|
| 3771 | <li>
|
| 3772 | <h5>node: <span class="tsd-signature-type">BIP32</span></h5>
|
| 3773 | </li>
|
| 3774 | </ul>
|
| 3775 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
|
| 3776 | </li>
|
| 3777 | </ul>
|
| 3778 | </section>
|
| 3779 | <section class="tsd-panel tsd-member tsd-kind-function">
|
| 3780 | <a name="getorganizations" class="tsd-anchor"></a>
|
| 3781 | <h3>get<wbr>Organizations</h3>
|
| 3782 | <ul class="tsd-signatures tsd-kind-function">
|
| 3783 | <li class="tsd-signature tsd-kind-icon">get<wbr>Organizations<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>
|
| 3784 | </ul>
|
| 3785 | <ul class="tsd-descriptions">
|
| 3786 | <li class="tsd-description">
|
| 3787 | <aside class="tsd-sources">
|
| 3788 | <ul>
|
| 3789 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/personUtils.ts#L121">profiles/profileSchemas/personUtils.ts:121</a></li>
|
| 3790 | </ul>
|
| 3791 | </aside>
|
| 3792 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 3793 | <ul class="tsd-parameters">
|
| 3794 | <li>
|
| 3795 | <h5>profile: <span class="tsd-signature-type">any</span></h5>
|
| 3796 | </li>
|
| 3797 | </ul>
|
| 3798 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
|
| 3799 | </li>
|
| 3800 | </ul>
|
| 3801 | </section>
|
| 3802 | <section class="tsd-panel tsd-member tsd-kind-function">
|
| 3803 | <a name="getpersonfromlegacyformat" class="tsd-anchor"></a>
|
| 3804 | <h3>get<wbr>Person<wbr>From<wbr>Legacy<wbr>Format</h3>
|
| 3805 | <ul class="tsd-signatures tsd-kind-function">
|
| 3806 | <li class="tsd-signature tsd-kind-icon">get<wbr>Person<wbr>From<wbr>Legacy<wbr>Format<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">object</span></li>
|
| 3807 | </ul>
|
| 3808 | <ul class="tsd-descriptions">
|
| 3809 | <li class="tsd-description">
|
| 3810 | <aside class="tsd-sources">
|
| 3811 | <ul>
|
| 3812 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/personLegacy.ts#L15">profiles/profileSchemas/personLegacy.ts:15</a></li>
|
| 3813 | </ul>
|
| 3814 | </aside>
|
| 3815 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 3816 | <ul class="tsd-parameters">
|
| 3817 | <li>
|
| 3818 | <h5>profile: <span class="tsd-signature-type">any</span></h5>
|
| 3819 | </li>
|
| 3820 | </ul>
|
| 3821 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">object</span></h4>
|
| 3822 | <ul class="tsd-parameters">
|
| 3823 | <li class="tsd-parameter">
|
| 3824 | <h5>@type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
|
| 3825 | </li>
|
| 3826 | <li class="tsd-parameter">
|
| 3827 | <h5><span class="tsd-flag ts-flagOptional">Optional</span> account<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5>
|
| 3828 | </li>
|
| 3829 | <li class="tsd-parameter">
|
| 3830 | <h5><span class="tsd-flag ts-flagOptional">Optional</span> address<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">object</span></h5>
|
| 3831 | <ul class="tsd-parameters">
|
| 3832 | <li class="tsd-parameter">
|
| 3833 | <h5>@type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
|
| 3834 | </li>
|
| 3835 | <li class="tsd-parameter">
|
| 3836 | <h5>address<wbr>Locality<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
|
| 3837 | </li>
|
| 3838 | </ul>
|
| 3839 | </li>
|
| 3840 | <li class="tsd-parameter">
|
| 3841 | <h5><span class="tsd-flag ts-flagOptional">Optional</span> description<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5>
|
| 3842 | </li>
|
| 3843 | <li class="tsd-parameter">
|
| 3844 | <h5><span class="tsd-flag ts-flagOptional">Optional</span> image<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5>
|
| 3845 | </li>
|
| 3846 | <li class="tsd-parameter">
|
| 3847 | <h5><span class="tsd-flag ts-flagOptional">Optional</span> name<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5>
|
| 3848 | </li>
|
| 3849 | <li class="tsd-parameter">
|
| 3850 | <h5><span class="tsd-flag ts-flagOptional">Optional</span> website<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">></span></h5>
|
| 3851 | </li>
|
| 3852 | </ul>
|
| 3853 | </li>
|
| 3854 | </ul>
|
| 3855 | </section>
|
| 3856 | <section class="tsd-panel tsd-member tsd-kind-function">
|
| 3857 | <a name="getpublickeyfromprivate" class="tsd-anchor"></a>
|
| 3858 | <h3>get<wbr>Public<wbr>Key<wbr>From<wbr>Private</h3>
|
| 3859 | <ul class="tsd-signatures tsd-kind-function">
|
| 3860 | <li class="tsd-signature tsd-kind-icon">get<wbr>Public<wbr>Key<wbr>From<wbr>Private<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>
|
| 3861 | </ul>
|
| 3862 | <ul class="tsd-descriptions">
|
| 3863 | <li class="tsd-description">
|
| 3864 | <aside class="tsd-sources">
|
| 3865 | <ul>
|
| 3866 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/keys.ts#L24">keys.ts:24</a></li>
|
| 3867 | </ul>
|
| 3868 | </aside>
|
| 3869 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 3870 | <ul class="tsd-parameters">
|
| 3871 | <li>
|
| 3872 | <h5>privateKey: <span class="tsd-signature-type">string</span></h5>
|
| 3873 | </li>
|
| 3874 | </ul>
|
| 3875 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
|
| 3876 | </li>
|
| 3877 | </ul>
|
| 3878 | </section>
|
| 3879 | <section class="tsd-panel tsd-member tsd-kind-function">
|
| 3880 | <a name="gettokenfileurl" class="tsd-anchor"></a>
|
| 3881 | <h3>get<wbr>Token<wbr>File<wbr>Url</h3>
|
| 3882 | <ul class="tsd-signatures tsd-kind-function">
|
| 3883 | <li class="tsd-signature tsd-kind-icon">get<wbr>Token<wbr>File<wbr>Url<span class="tsd-signature-symbol">(</span>zoneFileJson<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><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></li>
|
| 3884 | </ul>
|
| 3885 | <ul class="tsd-descriptions">
|
| 3886 | <li class="tsd-description">
|
| 3887 | <aside class="tsd-sources">
|
| 3888 | <ul>
|
| 3889 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileZoneFiles.ts#L36">profiles/profileZoneFiles.ts:36</a></li>
|
| 3890 | </ul>
|
| 3891 | </aside>
|
| 3892 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 3893 | <ul class="tsd-parameters">
|
| 3894 | <li>
|
| 3895 | <h5>zoneFileJson: <span class="tsd-signature-type">any</span></h5>
|
| 3896 | </li>
|
| 3897 | </ul>
|
| 3898 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span>
|
| 3899 | <span class="tsd-signature-symbol"> | </span>
|
| 3900 | <span class="tsd-signature-type">null</span>
|
| 3901 | </h4>
|
| 3902 | </li>
|
| 3903 | </ul>
|
| 3904 | </section>
|
| 3905 | <section class="tsd-panel tsd-member tsd-kind-function tsd-is-not-exported">
|
| 3906 | <a name="gettransaction" class="tsd-anchor"></a>
|
| 3907 | <h3>get<wbr>Transaction</h3>
|
| 3908 | <ul class="tsd-signatures tsd-kind-function tsd-is-not-exported">
|
| 3909 | <li class="tsd-signature tsd-kind-icon">get<wbr>Transaction<span class="tsd-signature-symbol">(</span>txIn<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">bitcoinjs.Transaction</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">bitcoinjs.TransactionBuilder</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Transaction</span></li>
|
| 3910 | </ul>
|
| 3911 | <ul class="tsd-descriptions">
|
| 3912 | <li class="tsd-description">
|
| 3913 | <aside class="tsd-sources">
|
| 3914 | <ul>
|
| 3915 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/operations/utils.ts#L61">operations/utils.ts:61</a></li>
|
| 3916 | </ul>
|
| 3917 | </aside>
|
| 3918 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 3919 | <ul class="tsd-parameters">
|
| 3920 | <li>
|
| 3921 | <h5>txIn: <span class="tsd-signature-type">bitcoinjs.Transaction</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">bitcoinjs.TransactionBuilder</span></h5>
|
| 3922 | </li>
|
| 3923 | </ul>
|
| 3924 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Transaction</span></h4>
|
| 3925 | </li>
|
| 3926 | </ul>
|
| 3927 | </section>
|
| 3928 | <section class="tsd-panel tsd-member tsd-kind-function">
|
| 3929 | <a name="gettransactioninsidebuilder" class="tsd-anchor"></a>
|
| 3930 | <h3>get<wbr>Transaction<wbr>Inside<wbr>Builder</h3>
|
| 3931 | <ul class="tsd-signatures tsd-kind-function">
|
| 3932 | <li class="tsd-signature tsd-kind-icon">get<wbr>Transaction<wbr>Inside<wbr>Builder<span class="tsd-signature-symbol">(</span>txBuilder<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">bitcoinjs.TransactionBuilder</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Transaction</span></li>
|
| 3933 | </ul>
|
| 3934 | <ul class="tsd-descriptions">
|
| 3935 | <li class="tsd-description">
|
| 3936 | <aside class="tsd-sources">
|
| 3937 | <ul>
|
| 3938 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/operations/utils.ts#L57">operations/utils.ts:57</a></li>
|
| 3939 | </ul>
|
| 3940 | </aside>
|
| 3941 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 3942 | <ul class="tsd-parameters">
|
| 3943 | <li>
|
| 3944 | <h5>txBuilder: <span class="tsd-signature-type">bitcoinjs.TransactionBuilder</span></h5>
|
| 3945 | </li>
|
| 3946 | </ul>
|
| 3947 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Transaction</span></h4>
|
| 3948 | </li>
|
| 3949 | </ul>
|
| 3950 | </section>
|
| 3951 | <section class="tsd-panel tsd-member tsd-kind-function tsd-is-not-exported">
|
| 3952 | <a name="gettransactionsigner" class="tsd-anchor"></a>
|
| 3953 | <h3>get<wbr>Transaction<wbr>Signer</h3>
|
| 3954 | <ul class="tsd-signatures tsd-kind-function tsd-is-not-exported">
|
| 3955 | <li class="tsd-signature tsd-kind-icon">get<wbr>Transaction<wbr>Signer<span class="tsd-signature-symbol">(</span>input<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="interfaces/transactionsigner.html" class="tsd-signature-type">TransactionSigner</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="interfaces/transactionsigner.html" class="tsd-signature-type">TransactionSigner</a></li>
|
| 3956 | </ul>
|
| 3957 | <ul class="tsd-descriptions">
|
| 3958 | <li class="tsd-description">
|
| 3959 | <aside class="tsd-sources">
|
| 3960 | <ul>
|
| 3961 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/operations/txbuild.ts#L73">operations/txbuild.ts:73</a></li>
|
| 3962 | </ul>
|
| 3963 | </aside>
|
| 3964 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 3965 | <ul class="tsd-parameters">
|
| 3966 | <li>
|
| 3967 | <h5>input: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="interfaces/transactionsigner.html" class="tsd-signature-type">TransactionSigner</a></h5>
|
| 3968 | </li>
|
| 3969 | </ul>
|
| 3970 | <h4 class="tsd-returns-title">Returns <a href="interfaces/transactionsigner.html" class="tsd-signature-type">TransactionSigner</a></h4>
|
| 3971 | </li>
|
| 3972 | </ul>
|
| 3973 | </section>
|
| 3974 | <section class="tsd-panel tsd-member tsd-kind-function">
|
| 3975 | <a name="getuserappfileurl" class="tsd-anchor"></a>
|
| 3976 | <h3>get<wbr>User<wbr>App<wbr>File<wbr>Url</h3>
|
| 3977 | <ul class="tsd-signatures tsd-kind-function">
|
| 3978 | <li class="tsd-signature tsd-kind-icon">get<wbr>User<wbr>App<wbr>File<wbr>Url<span class="tsd-signature-symbol">(</span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, username<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>, zoneFileLookupURL<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><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">></span></li>
|
| 3979 | </ul>
|
| 3980 | <ul class="tsd-descriptions">
|
| 3981 | <li class="tsd-description">
|
| 3982 | <aside class="tsd-sources">
|
| 3983 | <ul>
|
| 3984 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/storage/index.ts#L52">storage/index.ts:52</a></li>
|
| 3985 | </ul>
|
| 3986 | </aside>
|
| 3987 | <div class="tsd-comment tsd-typography">
|
| 3988 | <div class="lead">
|
| 3989 | <p>Fetch the public read URL of a user file for the specified app.</p>
|
| 3990 | </div>
|
| 3991 | </div>
|
| 3992 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 3993 | <ul class="tsd-parameters">
|
| 3994 | <li>
|
| 3995 | <h5>path: <span class="tsd-signature-type">string</span></h5>
|
| 3996 | <div class="tsd-comment tsd-typography">
|
| 3997 | <p>the path to the file to read</p>
|
| 3998 | </div>
|
| 3999 | </li>
|
| 4000 | <li>
|
| 4001 | <h5>username: <span class="tsd-signature-type">string</span></h5>
|
| 4002 | <div class="tsd-comment tsd-typography">
|
| 4003 | <p>The Blockstack ID of the user to look up</p>
|
| 4004 | </div>
|
| 4005 | </li>
|
| 4006 | <li>
|
| 4007 | <h5>appOrigin: <span class="tsd-signature-type">string</span></h5>
|
| 4008 | <div class="tsd-comment tsd-typography">
|
| 4009 | <p>The app origin</p>
|
| 4010 | </div>
|
| 4011 | </li>
|
| 4012 | <li>
|
| 4013 | <h5><span class="tsd-flag ts-flagOptional">Optional</span> zoneFileLookupURL: <span class="tsd-signature-type">string</span></h5>
|
| 4014 | </li>
|
| 4015 | </ul>
|
| 4016 | <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">null</span><span class="tsd-signature-symbol">></span></h4>
|
| 4017 | <p>that resolves to the public read URL of the file
|
| 4018 | or rejects with an error</p>
|
| 4019 | </li>
|
| 4020 | </ul>
|
| 4021 | </section>
|
| 4022 | <section class="tsd-panel tsd-member tsd-kind-function">
|
| 4023 | <a name="getverifiedaccounts" class="tsd-anchor"></a>
|
| 4024 | <h3>get<wbr>Verified<wbr>Accounts</h3>
|
| 4025 | <ul class="tsd-signatures tsd-kind-function">
|
| 4026 | <li class="tsd-signature tsd-kind-icon">get<wbr>Verified<wbr>Accounts<span class="tsd-signature-symbol">(</span>profile<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, verifications<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">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></li>
|
| 4027 | </ul>
|
| 4028 | <ul class="tsd-descriptions">
|
| 4029 | <li class="tsd-description">
|
| 4030 | <aside class="tsd-sources">
|
| 4031 | <ul>
|
| 4032 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/personUtils.ts#L82">profiles/profileSchemas/personUtils.ts:82</a></li>
|
| 4033 | </ul>
|
| 4034 | </aside>
|
| 4035 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 4036 | <ul class="tsd-parameters">
|
| 4037 | <li>
|
| 4038 | <h5>profile: <span class="tsd-signature-type">any</span></h5>
|
| 4039 | </li>
|
| 4040 | <li>
|
| 4041 | <h5><span class="tsd-flag ts-flagOptional">Optional</span> verifications: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5>
|
| 4042 | </li>
|
| 4043 | </ul>
|
| 4044 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h4>
|
| 4045 | </li>
|
| 4046 | </ul>
|
| 4047 | </section>
|
| 4048 | <section class="tsd-panel tsd-member tsd-kind-function">
|
| 4049 | <a name="handlependingsignin" class="tsd-anchor"></a>
|
| 4050 | <h3>handle<wbr>Pending<wbr>Sign<wbr>In</h3>
|
| 4051 | <ul class="tsd-signatures tsd-kind-function">
|
| 4052 | <li class="tsd-signature tsd-kind-icon">handle<wbr>Pending<wbr>Sign<wbr>In<span class="tsd-signature-symbol">(</span>nameLookupURL<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, authResponseToken<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, transitKey<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, caller<span class="tsd-signature-symbol">?: </span><a href="classes/usersession.html" class="tsd-signature-type">UserSession</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="interfaces/userdata.html" class="tsd-signature-type">UserData</a><span class="tsd-signature-symbol">></span></li>
|
| 4053 | </ul>
|
| 4054 | <ul class="tsd-descriptions">
|
| 4055 | <li class="tsd-description">
|
| 4056 | <aside class="tsd-sources">
|
| 4057 | <ul>
|
| 4058 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/auth/authApp.ts#L207">auth/authApp.ts:207</a></li>
|
| 4059 | </ul>
|
| 4060 | </aside>
|
| 4061 | <div class="tsd-comment tsd-typography">
|
| 4062 | <div class="lead">
|
| 4063 | <p>Try to process any pending sign in request by returning a <code>Promise</code> that resolves
|
| 4064 | to the user data object if the sign in succeeds.</p>
|
| 4065 | </div>
|
| 4066 | </div>
|
| 4067 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 4068 | <ul class="tsd-parameters">
|
| 4069 | <li>
|
| 4070 | <h5><span class="tsd-flag ts-flagDefault value">Default value</span> nameLookupURL: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = ""</span></h5>
|
| 4071 | <div class="tsd-comment tsd-typography">
|
| 4072 | <p>the endpoint against which to verify public
|
| 4073 | keys match claimed username</p>
|
| 4074 | </div>
|
| 4075 | </li>
|
| 4076 | <li>
|
| 4077 | <h5><span class="tsd-flag ts-flagDefault value">Default value</span> authResponseToken: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = getAuthResponseToken()</span></h5>
|
| 4078 | <div class="tsd-comment tsd-typography">
|
| 4079 | <p>the signed authentication response token</p>
|
| 4080 | </div>
|
| 4081 | </li>
|
| 4082 | <li>
|
| 4083 | <h5><span class="tsd-flag ts-flagOptional">Optional</span> transitKey: <span class="tsd-signature-type">string</span></h5>
|
| 4084 | <div class="tsd-comment tsd-typography">
|
| 4085 | <p>the transit private key that corresponds to the transit public key
|
| 4086 | that was provided in the authentication request</p>
|
| 4087 | </div>
|
| 4088 | </li>
|
| 4089 | <li>
|
| 4090 | <h5><span class="tsd-flag ts-flagOptional">Optional</span> caller: <a href="classes/usersession.html" class="tsd-signature-type">UserSession</a></h5>
|
| 4091 | </li>
|
| 4092 | </ul>
|
| 4093 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="interfaces/userdata.html" class="tsd-signature-type">UserData</a><span class="tsd-signature-symbol">></span></h4>
|
| 4094 | <p>that resolves to the user data object if successful and rejects
|
| 4095 | if handling the sign in request fails or there was no pending sign in request.</p>
|
| 4096 | </li>
|
| 4097 | </ul>
|
| 4098 | </section>
|
| 4099 | <section class="tsd-panel tsd-member tsd-kind-function tsd-is-not-exported">
|
| 4100 | <a name="handlesignedencryptedcontents" class="tsd-anchor"></a>
|
| 4101 | <h3>handle<wbr>Signed<wbr>Encrypted<wbr>Contents</h3>
|
| 4102 | <ul class="tsd-signatures tsd-kind-function tsd-is-not-exported">
|
| 4103 | <li class="tsd-signature tsd-kind-icon">handle<wbr>Signed<wbr>Encrypted<wbr>Contents<span class="tsd-signature-symbol">(</span>caller<span class="tsd-signature-symbol">: </span><a href="classes/usersession.html" class="tsd-signature-type">UserSession</a>, path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, storedContents<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, app<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, username<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, zoneFileLookupURL<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><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">></span></li>
|
| 4104 | </ul>
|
| 4105 | <ul class="tsd-descriptions">
|
| 4106 | <li class="tsd-description">
|
| 4107 | <aside class="tsd-sources">
|
| 4108 | <ul>
|
| 4109 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/storage/index.ts#L318">storage/index.ts:318</a></li>
|
| 4110 | </ul>
|
| 4111 | </aside>
|
| 4112 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 4113 | <ul class="tsd-parameters">
|
| 4114 | <li>
|
| 4115 | <h5>caller: <a href="classes/usersession.html" class="tsd-signature-type">UserSession</a></h5>
|
| 4116 | </li>
|
| 4117 | <li>
|
| 4118 | <h5>path: <span class="tsd-signature-type">string</span></h5>
|
| 4119 | </li>
|
| 4120 | <li>
|
| 4121 | <h5>storedContents: <span class="tsd-signature-type">string</span></h5>
|
| 4122 | </li>
|
| 4123 | <li>
|
| 4124 | <h5>app: <span class="tsd-signature-type">string</span></h5>
|
| 4125 | </li>
|
| 4126 | <li>
|
| 4127 | <h5><span class="tsd-flag ts-flagOptional">Optional</span> username: <span class="tsd-signature-type">string</span></h5>
|
| 4128 | </li>
|
| 4129 | <li>
|
| 4130 | <h5><span class="tsd-flag ts-flagOptional">Optional</span> zoneFileLookupURL: <span class="tsd-signature-type">string</span></h5>
|
| 4131 | </li>
|
| 4132 | </ul>
|
| 4133 | <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>
|
| 4134 | </li>
|
| 4135 | </ul>
|
| 4136 | </section>
|
| 4137 | <section class="tsd-panel tsd-member tsd-kind-function">
|
| 4138 | <a name="hash128" class="tsd-anchor"></a>
|
| 4139 | <h3>hash128</h3>
|
| 4140 | <ul class="tsd-signatures tsd-kind-function">
|
| 4141 | <li class="tsd-signature tsd-kind-icon">hash128<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>
|
| 4142 | </ul>
|
| 4143 | <ul class="tsd-descriptions">
|
| 4144 | <li class="tsd-description">
|
| 4145 | <aside class="tsd-sources">
|
| 4146 | <ul>
|
| 4147 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/operations/utils.ts#L18">operations/utils.ts:18</a></li>
|
| 4148 | </ul>
|
| 4149 | </aside>
|
| 4150 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 4151 | <ul class="tsd-parameters">
|
| 4152 | <li>
|
| 4153 | <h5>buff: <span class="tsd-signature-type">Buffer</span></h5>
|
| 4154 | </li>
|
| 4155 | </ul>
|
| 4156 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Buffer</span></h4>
|
| 4157 | </li>
|
| 4158 | </ul>
|
| 4159 | </section>
|
| 4160 | <section class="tsd-panel tsd-member tsd-kind-function">
|
| 4161 | <a name="hash160" class="tsd-anchor"></a>
|
| 4162 | <h3>hash160</h3>
|
| 4163 | <ul class="tsd-signatures tsd-kind-function">
|
| 4164 | <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>
|
| 4165 | </ul>
|
| 4166 | <ul class="tsd-descriptions">
|
| 4167 | <li class="tsd-description">
|
| 4168 | <aside class="tsd-sources">
|
| 4169 | <ul>
|
| 4170 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/operations/utils.ts#L13">operations/utils.ts:13</a></li>
|
| 4171 | </ul>
|
| 4172 | </aside>
|
| 4173 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 4174 | <ul class="tsd-parameters">
|
| 4175 | <li>
|
| 4176 | <h5>buff: <span class="tsd-signature-type">Buffer</span></h5>
|
| 4177 | </li>
|
| 4178 | </ul>
|
| 4179 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Buffer</span></h4>
|
| 4180 | </li>
|
| 4181 | </ul>
|
| 4182 | </section>
|
| 4183 | <section class="tsd-panel tsd-member tsd-kind-function tsd-is-not-exported">
|
| 4184 | <a name="hashcode" class="tsd-anchor"></a>
|
| 4185 | <h3>hash<wbr>Code</h3>
|
| 4186 | <ul class="tsd-signatures tsd-kind-function tsd-is-not-exported">
|
| 4187 | <li class="tsd-signature tsd-kind-icon">hash<wbr>Code<span class="tsd-signature-symbol">(</span>string<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>
|
| 4188 | </ul>
|
| 4189 | <ul class="tsd-descriptions">
|
| 4190 | <li class="tsd-description">
|
| 4191 | <aside class="tsd-sources">
|
| 4192 | <ul>
|
| 4193 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/wallet.ts#L28">wallet.ts:28</a></li>
|
| 4194 | </ul>
|
| 4195 | </aside>
|
| 4196 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 4197 | <ul class="tsd-parameters">
|
| 4198 | <li>
|
| 4199 | <h5>string: <span class="tsd-signature-type">string</span></h5>
|
| 4200 | </li>
|
| 4201 | </ul>
|
| 4202 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
|
| 4203 | </li>
|
| 4204 | </ul>
|
| 4205 | </section>
|
| 4206 | <section class="tsd-panel tsd-member tsd-kind-function">
|
| 4207 | <a name="hexstringtoecpair" class="tsd-anchor"></a>
|
| 4208 | <h3>hex<wbr>String<wbr>ToECPair</h3>
|
| 4209 | <ul class="tsd-signatures tsd-kind-function">
|
| 4210 | <li class="tsd-signature tsd-kind-icon">hex<wbr>String<wbr>ToECPair<span class="tsd-signature-symbol">(</span>skHex<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">ECPair</span></li>
|
| 4211 | </ul>
|
| 4212 | <ul class="tsd-descriptions">
|
| 4213 | <li class="tsd-description">
|
| 4214 | <aside class="tsd-sources">
|
| 4215 | <ul>
|
| 4216 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/utils.ts#L83">utils.ts:83</a></li>
|
| 4217 | </ul>
|
| 4218 | </aside>
|
| 4219 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 4220 | <ul class="tsd-parameters">
|
| 4221 | <li>
|
| 4222 | <h5>skHex: <span class="tsd-signature-type">string</span></h5>
|
| 4223 | </li>
|
| 4224 | </ul>
|
| 4225 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">ECPair</span></h4>
|
| 4226 | </li>
|
| 4227 | </ul>
|
| 4228 | </section>
|
| 4229 | <section class="tsd-panel tsd-member tsd-kind-function tsd-is-not-exported">
|
| 4230 | <a name="hmacsha256" class="tsd-anchor"></a>
|
| 4231 | <h3>hmac<wbr>Sha256</h3>
|
| 4232 | <ul class="tsd-signatures tsd-kind-function tsd-is-not-exported">
|
| 4233 | <li class="tsd-signature tsd-kind-icon">hmac<wbr>Sha256<span class="tsd-signature-symbol">(</span>key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span>, content<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>
|
| 4234 | </ul>
|
| 4235 | <ul class="tsd-descriptions">
|
| 4236 | <li class="tsd-description">
|
| 4237 | <aside class="tsd-sources">
|
| 4238 | <ul>
|
| 4239 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/encryption/ec.ts#L27">encryption/ec.ts:27</a></li>
|
| 4240 | </ul>
|
| 4241 | </aside>
|
| 4242 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 4243 | <ul class="tsd-parameters">
|
| 4244 | <li>
|
| 4245 | <h5>key: <span class="tsd-signature-type">Buffer</span></h5>
|
| 4246 | </li>
|
| 4247 | <li>
|
| 4248 | <h5>content: <span class="tsd-signature-type">Buffer</span></h5>
|
| 4249 | </li>
|
| 4250 | </ul>
|
| 4251 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Buffer</span></h4>
|
| 4252 | </li>
|
| 4253 | </ul>
|
| 4254 | </section>
|
| 4255 | <section class="tsd-panel tsd-member tsd-kind-function tsd-is-not-exported">
|
| 4256 | <a name="inputbytes" class="tsd-anchor"></a>
|
| 4257 | <h3>input<wbr>Bytes</h3>
|
| 4258 | <ul class="tsd-signatures tsd-kind-function tsd-is-not-exported">
|
| 4259 | <li class="tsd-signature tsd-kind-icon">input<wbr>Bytes<span class="tsd-signature-symbol">(</span>input<span class="tsd-signature-symbol">: </span><a href="globals.html#txpoint" class="tsd-signature-type">txPoint</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">number</span></li>
|
| 4260 | </ul>
|
| 4261 | <ul class="tsd-descriptions">
|
| 4262 | <li class="tsd-description">
|
| 4263 | <aside class="tsd-sources">
|
| 4264 | <ul>
|
| 4265 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/operations/utils.ts#L35">operations/utils.ts:35</a></li>
|
| 4266 | </ul>
|
| 4267 | </aside>
|
| 4268 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 4269 | <ul class="tsd-parameters">
|
| 4270 | <li>
|
| 4271 | <h5>input: <a href="globals.html#txpoint" class="tsd-signature-type">txPoint</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></h5>
|
| 4272 | </li>
|
| 4273 | </ul>
|
| 4274 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
|
| 4275 | </li>
|
| 4276 | </ul>
|
| 4277 | </section>
|
| 4278 | <section class="tsd-panel tsd-member tsd-kind-function tsd-is-not-exported">
|
| 4279 | <a name="isaccountspendable" class="tsd-anchor"></a>
|
| 4280 | <h3>is<wbr>Account<wbr>Spendable</h3>
|
| 4281 | <ul class="tsd-signatures tsd-kind-function tsd-is-not-exported">
|
| 4282 | <li class="tsd-signature tsd-kind-icon">is<wbr>Account<wbr>Spendable<span class="tsd-signature-symbol">(</span>address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, tokenType<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, blockHeight<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">boolean</span><span class="tsd-signature-symbol">></span></li>
|
| 4283 | </ul>
|
| 4284 | <ul class="tsd-descriptions">
|
| 4285 | <li class="tsd-description">
|
| 4286 | <aside class="tsd-sources">
|
| 4287 | <ul>
|
| 4288 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/operations/safety.ts#L133">operations/safety.ts:133</a></li>
|
| 4289 | </ul>
|
| 4290 | </aside>
|
| 4291 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 4292 | <ul class="tsd-parameters">
|
| 4293 | <li>
|
| 4294 | <h5>address: <span class="tsd-signature-type">string</span></h5>
|
| 4295 | </li>
|
| 4296 | <li>
|
| 4297 | <h5>tokenType: <span class="tsd-signature-type">string</span></h5>
|
| 4298 | </li>
|
| 4299 | <li>
|
| 4300 | <h5>blockHeight: <span class="tsd-signature-type">number</span></h5>
|
| 4301 | </li>
|
| 4302 | </ul>
|
| 4303 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></h4>
|
| 4304 | </li>
|
| 4305 | </ul>
|
| 4306 | </section>
|
| 4307 | <section class="tsd-panel tsd-member tsd-kind-function tsd-is-private">
|
| 4308 | <a name="isexpirationdatevalid" class="tsd-anchor"></a>
|
| 4309 | <h3><span class="tsd-flag ts-flagPrivate">Private</span> is<wbr>Expiration<wbr>Date<wbr>Valid</h3>
|
| 4310 | <ul class="tsd-signatures tsd-kind-function tsd-is-private">
|
| 4311 | <li class="tsd-signature tsd-kind-icon">is<wbr>Expiration<wbr>Date<wbr>Valid<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-type">boolean</span></li>
|
| 4312 | </ul>
|
| 4313 | <ul class="tsd-descriptions">
|
| 4314 | <li class="tsd-description">
|
| 4315 | <aside class="tsd-sources">
|
| 4316 | <ul>
|
| 4317 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/auth/authVerification.ts#L150">auth/authVerification.ts:150</a></li>
|
| 4318 | </ul>
|
| 4319 | </aside>
|
| 4320 | <div class="tsd-comment tsd-typography">
|
| 4321 | <div class="lead">
|
| 4322 | <p>Checks if the expiration date of the <code>token</code> is before the current time</p>
|
| 4323 | </div>
|
| 4324 | </div>
|
| 4325 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 4326 | <ul class="tsd-parameters">
|
| 4327 | <li>
|
| 4328 | <h5>token: <span class="tsd-signature-type">string</span></h5>
|
| 4329 | <div class="tsd-comment tsd-typography">
|
| 4330 | <p>encoded and signed authentication token</p>
|
| 4331 | </div>
|
| 4332 | </li>
|
| 4333 | </ul>
|
| 4334 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
|
| 4335 | <p><code>true</code> if the <code>token</code> has not yet expired, <code>false</code>
|
| 4336 | if the <code>token</code> has expired</p>
|
| 4337 | </li>
|
| 4338 | </ul>
|
| 4339 | </section>
|
| 4340 | <section class="tsd-panel tsd-member tsd-kind-function tsd-is-not-exported">
|
| 4341 | <a name="isingraceperiod" class="tsd-anchor"></a>
|
| 4342 | <h3>is<wbr>InGrace<wbr>Period</h3>
|
| 4343 | <ul class="tsd-signatures tsd-kind-function tsd-is-not-exported">
|
| 4344 | <li class="tsd-signature tsd-kind-icon">is<wbr>InGrace<wbr>Period<span class="tsd-signature-symbol">(</span>fullyQualifiedName<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">boolean</span><span class="tsd-signature-symbol">></span></li>
|
| 4345 | </ul>
|
| 4346 | <ul class="tsd-descriptions">
|
| 4347 | <li class="tsd-description">
|
| 4348 | <aside class="tsd-sources">
|
| 4349 | <ul>
|
| 4350 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/operations/safety.ts#L109">operations/safety.ts:109</a></li>
|
| 4351 | </ul>
|
| 4352 | </aside>
|
| 4353 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 4354 | <ul class="tsd-parameters">
|
| 4355 | <li>
|
| 4356 | <h5>fullyQualifiedName: <span class="tsd-signature-type">string</span></h5>
|
| 4357 | </li>
|
| 4358 | </ul>
|
| 4359 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></h4>
|
| 4360 | </li>
|
| 4361 | </ul>
|
| 4362 | </section>
|
| 4363 | <section class="tsd-panel tsd-member tsd-kind-function tsd-is-private">
|
| 4364 | <a name="isissuancedatevalid" class="tsd-anchor"></a>
|
| 4365 | <h3><span class="tsd-flag ts-flagPrivate">Private</span> is<wbr>Issuance<wbr>Date<wbr>Valid</h3>
|
| 4366 | <ul class="tsd-signatures tsd-kind-function tsd-is-private">
|
| 4367 | <li class="tsd-signature tsd-kind-icon">is<wbr>Issuance<wbr>Date<wbr>Valid<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-type">boolean</span></li>
|
| 4368 | </ul>
|
| 4369 | <ul class="tsd-descriptions">
|
| 4370 | <li class="tsd-description">
|
| 4371 | <aside class="tsd-sources">
|
| 4372 | <ul>
|
| 4373 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/auth/authVerification.ts#L125">auth/authVerification.ts:125</a></li>
|
| 4374 | </ul>
|
| 4375 | </aside>
|
| 4376 | <div class="tsd-comment tsd-typography">
|
| 4377 | <div class="lead">
|
| 4378 | <p>Checks if the if the token issuance time and date is after the
|
| 4379 | current time and date.</p>
|
| 4380 | </div>
|
| 4381 | </div>
|
| 4382 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 4383 | <ul class="tsd-parameters">
|
| 4384 | <li>
|
| 4385 | <h5>token: <span class="tsd-signature-type">string</span></h5>
|
| 4386 | <div class="tsd-comment tsd-typography">
|
| 4387 | <p>encoded and signed authentication token</p>
|
| 4388 | </div>
|
| 4389 | </li>
|
| 4390 | </ul>
|
| 4391 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
|
| 4392 | <p><code>true</code> if the token was issued after the current time,
|
| 4393 | otherwise returns <code>false</code></p>
|
| 4394 | </li>
|
| 4395 | </ul>
|
| 4396 | </section>
|
| 4397 | <section class="tsd-panel tsd-member tsd-kind-function tsd-is-private">
|
| 4398 | <a name="islaterversion" class="tsd-anchor"></a>
|
| 4399 | <h3><span class="tsd-flag ts-flagPrivate">Private</span> is<wbr>Later<wbr>Version</h3>
|
| 4400 | <ul class="tsd-signatures tsd-kind-function tsd-is-private">
|
| 4401 | <li class="tsd-signature tsd-kind-icon">is<wbr>Later<wbr>Version<span class="tsd-signature-symbol">(</span>v1<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, v2<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>
|
| 4402 | </ul>
|
| 4403 | <ul class="tsd-descriptions">
|
| 4404 | <li class="tsd-description">
|
| 4405 | <aside class="tsd-sources">
|
| 4406 | <ul>
|
| 4407 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/utils.ts#L60">utils.ts:60</a></li>
|
| 4408 | </ul>
|
| 4409 | </aside>
|
| 4410 | <div class="tsd-comment tsd-typography">
|
| 4411 | <div class="lead">
|
| 4412 | <p>Versioning</p>
|
| 4413 | </div>
|
| 4414 | </div>
|
| 4415 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 4416 | <ul class="tsd-parameters">
|
| 4417 | <li>
|
| 4418 | <h5>v1: <span class="tsd-signature-type">string</span></h5>
|
| 4419 | <div class="tsd-comment tsd-typography">
|
| 4420 | <p>the left half of the version inequality</p>
|
| 4421 | </div>
|
| 4422 | </li>
|
| 4423 | <li>
|
| 4424 | <h5>v2: <span class="tsd-signature-type">string</span></h5>
|
| 4425 | <div class="tsd-comment tsd-typography">
|
| 4426 | <p>right half of the version inequality</p>
|
| 4427 | </div>
|
| 4428 | </li>
|
| 4429 | </ul>
|
| 4430 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
|
| 4431 | <p>iff v1 >= v2</p>
|
| 4432 | </li>
|
| 4433 | </ul>
|
| 4434 | </section>
|
| 4435 | <section class="tsd-panel tsd-member tsd-kind-function tsd-is-private">
|
| 4436 | <a name="ismanifesturivalid" class="tsd-anchor"></a>
|
| 4437 | <h3><span class="tsd-flag ts-flagPrivate">Private</span> is<wbr>Manifest<wbr>Uri<wbr>Valid</h3>
|
| 4438 | <ul class="tsd-signatures tsd-kind-function tsd-is-private">
|
| 4439 | <li class="tsd-signature tsd-kind-icon">is<wbr>Manifest<wbr>Uri<wbr>Valid<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-type">boolean</span></li>
|
| 4440 | </ul>
|
| 4441 | <ul class="tsd-descriptions">
|
| 4442 | <li class="tsd-description">
|
| 4443 | <aside class="tsd-sources">
|
| 4444 | <ul>
|
| 4445 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/auth/authVerification.ts#L173">auth/authVerification.ts:173</a></li>
|
| 4446 | </ul>
|
| 4447 | </aside>
|
| 4448 | <div class="tsd-comment tsd-typography">
|
| 4449 | <div class="lead">
|
| 4450 | <p>Makes sure the <code>manifest_uri</code> is a same origin absolute URL.</p>
|
| 4451 | </div>
|
| 4452 | </div>
|
| 4453 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 4454 | <ul class="tsd-parameters">
|
| 4455 | <li>
|
| 4456 | <h5>token: <span class="tsd-signature-type">string</span></h5>
|
| 4457 | <div class="tsd-comment tsd-typography">
|
| 4458 | <p>encoded and signed authentication token</p>
|
| 4459 | </div>
|
| 4460 | </li>
|
| 4461 | </ul>
|
| 4462 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
|
| 4463 | <p><code>true</code> if valid, otherwise <code>false</code></p>
|
| 4464 | </li>
|
| 4465 | </ul>
|
| 4466 | </section>
|
| 4467 | <section class="tsd-panel tsd-member tsd-kind-function tsd-is-not-exported">
|
| 4468 | <a name="isnameavailable" class="tsd-anchor"></a>
|
| 4469 | <h3>is<wbr>Name<wbr>Available</h3>
|
| 4470 | <ul class="tsd-signatures tsd-kind-function tsd-is-not-exported">
|
| 4471 | <li class="tsd-signature tsd-kind-icon">is<wbr>Name<wbr>Available<span class="tsd-signature-symbol">(</span>fullyQualifiedName<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">boolean</span><span class="tsd-signature-symbol">></span></li>
|
| 4472 | </ul>
|
| 4473 | <ul class="tsd-descriptions">
|
| 4474 | <li class="tsd-description">
|
| 4475 | <aside class="tsd-sources">
|
| 4476 | <ul>
|
| 4477 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/operations/safety.ts#L37">operations/safety.ts:37</a></li>
|
| 4478 | </ul>
|
| 4479 | </aside>
|
| 4480 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 4481 | <ul class="tsd-parameters">
|
| 4482 | <li>
|
| 4483 | <h5>fullyQualifiedName: <span class="tsd-signature-type">string</span></h5>
|
| 4484 | </li>
|
| 4485 | </ul>
|
| 4486 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></h4>
|
| 4487 | </li>
|
| 4488 | </ul>
|
| 4489 | </section>
|
| 4490 | <section class="tsd-panel tsd-member tsd-kind-function tsd-is-not-exported">
|
| 4491 | <a name="isnamevalid" class="tsd-anchor"></a>
|
| 4492 | <h3>is<wbr>Name<wbr>Valid</h3>
|
| 4493 | <ul class="tsd-signatures tsd-kind-function tsd-is-not-exported">
|
| 4494 | <li class="tsd-signature tsd-kind-icon">is<wbr>Name<wbr>Valid<span class="tsd-signature-symbol">(</span>fullyQualifiedName<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">boolean</span><span class="tsd-signature-symbol">></span></li>
|
| 4495 | </ul>
|
| 4496 | <ul class="tsd-descriptions">
|
| 4497 | <li class="tsd-description">
|
| 4498 | <aside class="tsd-sources">
|
| 4499 | <ul>
|
| 4500 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/operations/safety.ts#L5">operations/safety.ts:5</a></li>
|
| 4501 | </ul>
|
| 4502 | </aside>
|
| 4503 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 4504 | <ul class="tsd-parameters">
|
| 4505 | <li>
|
| 4506 | <h5><span class="tsd-flag ts-flagDefault value">Default value</span> fullyQualifiedName: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = ""</span></h5>
|
| 4507 | </li>
|
| 4508 | </ul>
|
| 4509 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></h4>
|
| 4510 | </li>
|
| 4511 | </ul>
|
| 4512 | </section>
|
| 4513 | <section class="tsd-panel tsd-member tsd-kind-function tsd-is-not-exported">
|
| 4514 | <a name="isnamespaceavailable" class="tsd-anchor"></a>
|
| 4515 | <h3>is<wbr>Namespace<wbr>Available</h3>
|
| 4516 | <ul class="tsd-signatures tsd-kind-function tsd-is-not-exported">
|
| 4517 | <li class="tsd-signature tsd-kind-icon">is<wbr>Namespace<wbr>Available<span class="tsd-signature-symbol">(</span>namespaceID<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">boolean</span><span class="tsd-signature-symbol">></span></li>
|
| 4518 | </ul>
|
| 4519 | <ul class="tsd-descriptions">
|
| 4520 | <li class="tsd-description">
|
| 4521 | <aside class="tsd-sources">
|
| 4522 | <ul>
|
| 4523 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/operations/safety.ts#L49">operations/safety.ts:49</a></li>
|
| 4524 | </ul>
|
| 4525 | </aside>
|
| 4526 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 4527 | <ul class="tsd-parameters">
|
| 4528 | <li>
|
| 4529 | <h5>namespaceID: <span class="tsd-signature-type">string</span></h5>
|
| 4530 | </li>
|
| 4531 | </ul>
|
| 4532 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></h4>
|
| 4533 | </li>
|
| 4534 | </ul>
|
| 4535 | </section>
|
| 4536 | <section class="tsd-panel tsd-member tsd-kind-function tsd-is-not-exported">
|
| 4537 | <a name="isnamespacevalid" class="tsd-anchor"></a>
|
| 4538 | <h3>is<wbr>Namespace<wbr>Valid</h3>
|
| 4539 | <ul class="tsd-signatures tsd-kind-function tsd-is-not-exported">
|
| 4540 | <li class="tsd-signature tsd-kind-icon">is<wbr>Namespace<wbr>Valid<span class="tsd-signature-symbol">(</span>namespaceID<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">boolean</span><span class="tsd-signature-symbol">></span></li>
|
| 4541 | </ul>
|
| 4542 | <ul class="tsd-descriptions">
|
| 4543 | <li class="tsd-description">
|
| 4544 | <aside class="tsd-sources">
|
| 4545 | <ul>
|
| 4546 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/operations/safety.ts#L30">operations/safety.ts:30</a></li>
|
| 4547 | </ul>
|
| 4548 | </aside>
|
| 4549 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 4550 | <ul class="tsd-parameters">
|
| 4551 | <li>
|
| 4552 | <h5>namespaceID: <span class="tsd-signature-type">string</span></h5>
|
| 4553 | </li>
|
| 4554 | </ul>
|
| 4555 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></h4>
|
| 4556 | </li>
|
| 4557 | </ul>
|
| 4558 | </section>
|
| 4559 | <section class="tsd-panel tsd-member tsd-kind-function tsd-is-private">
|
| 4560 | <a name="isredirecturivalid" class="tsd-anchor"></a>
|
| 4561 | <h3><span class="tsd-flag ts-flagPrivate">Private</span> is<wbr>Redirect<wbr>Uri<wbr>Valid</h3>
|
| 4562 | <ul class="tsd-signatures tsd-kind-function tsd-is-private">
|
| 4563 | <li class="tsd-signature tsd-kind-icon">is<wbr>Redirect<wbr>Uri<wbr>Valid<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-type">boolean</span></li>
|
| 4564 | </ul>
|
| 4565 | <ul class="tsd-descriptions">
|
| 4566 | <li class="tsd-description">
|
| 4567 | <aside class="tsd-sources">
|
| 4568 | <ul>
|
| 4569 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/auth/authVerification.ts#L184">auth/authVerification.ts:184</a></li>
|
| 4570 | </ul>
|
| 4571 | </aside>
|
| 4572 | <div class="tsd-comment tsd-typography">
|
| 4573 | <div class="lead">
|
| 4574 | <p>Makes sure the <code>redirect_uri</code> is a same origin absolute URL.</p>
|
| 4575 | </div>
|
| 4576 | </div>
|
| 4577 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 4578 | <ul class="tsd-parameters">
|
| 4579 | <li>
|
| 4580 | <h5>token: <span class="tsd-signature-type">string</span></h5>
|
| 4581 | <div class="tsd-comment tsd-typography">
|
| 4582 | <p>encoded and signed authentication token</p>
|
| 4583 | </div>
|
| 4584 | </li>
|
| 4585 | </ul>
|
| 4586 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
|
| 4587 | <p><code>true</code> if valid, otherwise <code>false</code></p>
|
| 4588 | </li>
|
| 4589 | </ul>
|
| 4590 | </section>
|
| 4591 | <section class="tsd-panel tsd-member tsd-kind-function tsd-is-private">
|
| 4592 | <a name="issameoriginabsoluteurl" class="tsd-anchor"></a>
|
| 4593 | <h3><span class="tsd-flag ts-flagPrivate">Private</span> is<wbr>Same<wbr>Origin<wbr>Absolute<wbr>Url</h3>
|
| 4594 | <ul class="tsd-signatures tsd-kind-function tsd-is-private">
|
| 4595 | <li class="tsd-signature tsd-kind-icon">is<wbr>Same<wbr>Origin<wbr>Absolute<wbr>Url<span class="tsd-signature-symbol">(</span>uri1<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, uri2<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>
|
| 4596 | </ul>
|
| 4597 | <ul class="tsd-descriptions">
|
| 4598 | <li class="tsd-description">
|
| 4599 | <aside class="tsd-sources">
|
| 4600 | <ul>
|
| 4601 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/utils.ts#L140">utils.ts:140</a></li>
|
| 4602 | </ul>
|
| 4603 | </aside>
|
| 4604 | <div class="tsd-comment tsd-typography">
|
| 4605 | <div class="lead">
|
| 4606 | <p>Checks if both urls pass the same origin check & are absolute</p>
|
| 4607 | </div>
|
| 4608 | </div>
|
| 4609 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 4610 | <ul class="tsd-parameters">
|
| 4611 | <li>
|
| 4612 | <h5>uri1: <span class="tsd-signature-type">string</span></h5>
|
| 4613 | <div class="tsd-comment tsd-typography">
|
| 4614 | <p>first uri to check</p>
|
| 4615 | </div>
|
| 4616 | </li>
|
| 4617 | <li>
|
| 4618 | <h5>uri2: <span class="tsd-signature-type">string</span></h5>
|
| 4619 | <div class="tsd-comment tsd-typography">
|
| 4620 | <p>second uri to check</p>
|
| 4621 | </div>
|
| 4622 | </li>
|
| 4623 | </ul>
|
| 4624 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
|
| 4625 | <p>true if they pass the same origin check</p>
|
| 4626 | </li>
|
| 4627 | </ul>
|
| 4628 | </section>
|
| 4629 | <section class="tsd-panel tsd-member tsd-kind-function">
|
| 4630 | <a name="issigninpending" class="tsd-anchor"></a>
|
| 4631 | <h3>is<wbr>Sign<wbr>InPending</h3>
|
| 4632 | <ul class="tsd-signatures tsd-kind-function">
|
| 4633 | <li class="tsd-signature tsd-kind-icon">is<wbr>Sign<wbr>InPending<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>
|
| 4634 | </ul>
|
| 4635 | <ul class="tsd-descriptions">
|
| 4636 | <li class="tsd-description">
|
| 4637 | <aside class="tsd-sources">
|
| 4638 | <ul>
|
| 4639 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/auth/authApp.ts#L95">auth/authApp.ts:95</a></li>
|
| 4640 | </ul>
|
| 4641 | </aside>
|
| 4642 | <div class="tsd-comment tsd-typography">
|
| 4643 | <div class="lead">
|
| 4644 | <p>Check if there is a authentication request that hasn't been handled.
|
| 4645 | Also checks for a protocol echo reply (which if detected then the page
|
| 4646 | will be automatically redirected after this call).</p>
|
| 4647 | </div>
|
| 4648 | </div>
|
| 4649 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
|
| 4650 | <p><code>true</code> if there is a pending sign in, otherwise <code>false</code></p>
|
| 4651 | </li>
|
| 4652 | </ul>
|
| 4653 | </section>
|
| 4654 | <section class="tsd-panel tsd-member tsd-kind-function">
|
| 4655 | <a name="isusersignedin" class="tsd-anchor"></a>
|
| 4656 | <h3>is<wbr>User<wbr>Signed<wbr>In</h3>
|
| 4657 | <ul class="tsd-signatures tsd-kind-function">
|
| 4658 | <li class="tsd-signature tsd-kind-icon">is<wbr>User<wbr>Signed<wbr>In<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>
|
| 4659 | </ul>
|
| 4660 | <ul class="tsd-descriptions">
|
| 4661 | <li class="tsd-description">
|
| 4662 | <aside class="tsd-sources">
|
| 4663 | <ul>
|
| 4664 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/auth/authApp.ts#L49">auth/authApp.ts:49</a></li>
|
| 4665 | </ul>
|
| 4666 | </aside>
|
| 4667 | <div class="tsd-comment tsd-typography">
|
| 4668 | <div class="lead">
|
| 4669 | <p>Check if a user is currently signed in.</p>
|
| 4670 | </div>
|
| 4671 | <dl class="tsd-comment-tags">
|
| 4672 | <dt>method</dt>
|
| 4673 | <dd><p>isUserSignedIn</p>
|
| 4674 | </dd>
|
| 4675 | </dl>
|
| 4676 | </div>
|
| 4677 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
|
| 4678 | <p><code>true</code> if the user is signed in, <code>false</code> if not.</p>
|
| 4679 | </li>
|
| 4680 | </ul>
|
| 4681 | </section>
|
| 4682 | <section class="tsd-panel tsd-member tsd-kind-function">
|
| 4683 | <a name="launchcustomprotocol" class="tsd-anchor"></a>
|
| 4684 | <h3>launch<wbr>Custom<wbr>Protocol</h3>
|
| 4685 | <ul class="tsd-signatures tsd-kind-function">
|
| 4686 | <li class="tsd-signature tsd-kind-icon">launch<wbr>Custom<wbr>Protocol<span class="tsd-signature-symbol">(</span>authRequest<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, successCallback<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">function</span>, failCallback<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>
|
| 4687 | </ul>
|
| 4688 | <ul class="tsd-descriptions">
|
| 4689 | <li class="tsd-description">
|
| 4690 | <aside class="tsd-sources">
|
| 4691 | <ul>
|
| 4692 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/auth/protocolLaunch.ts#L15">auth/protocolLaunch.ts:15</a></li>
|
| 4693 | </ul>
|
| 4694 | </aside>
|
| 4695 | <div class="tsd-comment tsd-typography">
|
| 4696 | <div class="lead">
|
| 4697 | <p>Detects if the native auth-browser is installed and is successfully
|
| 4698 | launched via a custom protocol URI.</p>
|
| 4699 | </div>
|
| 4700 | </div>
|
| 4701 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 4702 | <ul class="tsd-parameters">
|
| 4703 | <li>
|
| 4704 | <h5>authRequest: <span class="tsd-signature-type">string</span></h5>
|
| 4705 | <div class="tsd-comment tsd-typography">
|
| 4706 | <p>The encoded authRequest to be used as a query param in the custom URI.</p>
|
| 4707 | </div>
|
| 4708 | </li>
|
| 4709 | <li>
|
| 4710 | <h5>successCallback: <span class="tsd-signature-type">function</span></h5>
|
| 4711 | <div class="tsd-comment tsd-typography">
|
| 4712 | <p>The callback that is invoked when the protocol handler was detected.</p>
|
| 4713 | </div>
|
| 4714 | <ul class="tsd-parameters">
|
| 4715 | <li class="tsd-parameter-siganture">
|
| 4716 | <ul class="tsd-signatures tsd-kind-type-literal tsd-is-not-exported">
|
| 4717 | <li class="tsd-signature tsd-kind-icon"><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>
|
| 4718 | </ul>
|
| 4719 | <ul class="tsd-descriptions">
|
| 4720 | <li class="tsd-description">
|
| 4721 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
| 4722 | </li>
|
| 4723 | </ul>
|
| 4724 | </li>
|
| 4725 | </ul>
|
| 4726 | </li>
|
| 4727 | <li>
|
| 4728 | <h5>failCallback: <span class="tsd-signature-type">function</span></h5>
|
| 4729 | <div class="tsd-comment tsd-typography">
|
| 4730 | <p>The callback that is invoked when the protocol handler was not detected.</p>
|
| 4731 | </div>
|
| 4732 | <ul class="tsd-parameters">
|
| 4733 | <li class="tsd-parameter-siganture">
|
| 4734 | <ul class="tsd-signatures tsd-kind-type-literal tsd-is-not-exported">
|
| 4735 | <li class="tsd-signature tsd-kind-icon"><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>
|
| 4736 | </ul>
|
| 4737 | <ul class="tsd-descriptions">
|
| 4738 | <li class="tsd-description">
|
| 4739 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
| 4740 | </li>
|
| 4741 | </ul>
|
| 4742 | </li>
|
| 4743 | </ul>
|
| 4744 | </li>
|
| 4745 | </ul>
|
| 4746 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
| 4747 | </li>
|
| 4748 | </ul>
|
| 4749 | </section>
|
| 4750 | <section class="tsd-panel tsd-member tsd-kind-function">
|
| 4751 | <a name="listfiles" class="tsd-anchor"></a>
|
| 4752 | <h3>list<wbr>Files</h3>
|
| 4753 | <ul class="tsd-signatures tsd-kind-function">
|
| 4754 | <li class="tsd-signature tsd-kind-icon">list<wbr>Files<span class="tsd-signature-symbol">(</span>callback<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">function</span>, caller<span class="tsd-signature-symbol">?: </span><a href="classes/usersession.html" class="tsd-signature-type">UserSession</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">number</span><span class="tsd-signature-symbol">></span></li>
|
| 4755 | </ul>
|
| 4756 | <ul class="tsd-descriptions">
|
| 4757 | <li class="tsd-description">
|
| 4758 | <aside class="tsd-sources">
|
| 4759 | <ul>
|
| 4760 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/storage/index.ts#L647">storage/index.ts:647</a></li>
|
| 4761 | </ul>
|
| 4762 | </aside>
|
| 4763 | <div class="tsd-comment tsd-typography">
|
| 4764 | <div class="lead">
|
| 4765 | <p>List the set of files in this application's Gaia storage bucket.</p>
|
| 4766 | </div>
|
| 4767 | </div>
|
| 4768 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 4769 | <ul class="tsd-parameters">
|
| 4770 | <li>
|
| 4771 | <h5>callback: <span class="tsd-signature-type">function</span></h5>
|
| 4772 | <div class="tsd-comment tsd-typography">
|
| 4773 | <p>a callback to invoke on each named file that
|
| 4774 | returns <code>true</code> to continue the listing operation or <code>false</code> to end it</p>
|
| 4775 | </div>
|
| 4776 | <ul class="tsd-parameters">
|
| 4777 | <li class="tsd-parameter-siganture">
|
| 4778 | <ul class="tsd-signatures tsd-kind-type-literal tsd-is-not-exported">
|
| 4779 | <li class="tsd-signature tsd-kind-icon"><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>
|
| 4780 | </ul>
|
| 4781 | <ul class="tsd-descriptions">
|
| 4782 | <li class="tsd-description">
|
| 4783 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 4784 | <ul class="tsd-parameters">
|
| 4785 | <li>
|
| 4786 | <h5>name: <span class="tsd-signature-type">string</span></h5>
|
| 4787 | </li>
|
| 4788 | </ul>
|
| 4789 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
|
| 4790 | </li>
|
| 4791 | </ul>
|
| 4792 | </li>
|
| 4793 | </ul>
|
| 4794 | </li>
|
| 4795 | <li>
|
| 4796 | <h5><span class="tsd-flag ts-flagOptional">Optional</span> caller: <a href="classes/usersession.html" class="tsd-signature-type">UserSession</a></h5>
|
| 4797 | <div class="tsd-comment tsd-typography">
|
| 4798 | <p>instance calling this method</p>
|
| 4799 | </div>
|
| 4800 | </li>
|
| 4801 | </ul>
|
| 4802 | <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>
|
| 4803 | <p>that resolves to the number of files listed</p>
|
| 4804 | </li>
|
| 4805 | </ul>
|
| 4806 | </section>
|
| 4807 | <section class="tsd-panel tsd-member tsd-kind-function tsd-is-private tsd-is-not-exported">
|
| 4808 | <a name="listfilesloop" class="tsd-anchor"></a>
|
| 4809 | <h3><span class="tsd-flag ts-flagPrivate">Private</span> list<wbr>Files<wbr>Loop</h3>
|
| 4810 | <ul class="tsd-signatures tsd-kind-function tsd-is-private tsd-is-not-exported">
|
| 4811 | <li class="tsd-signature tsd-kind-icon">list<wbr>Files<wbr>Loop<span class="tsd-signature-symbol">(</span>hubConfig<span class="tsd-signature-symbol">: </span><a href="globals.html#gaiahubconfig" class="tsd-signature-type">GaiaHubConfig</a>, page<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>, callCount<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, fileCount<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, callback<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">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span></li>
|
| 4812 | </ul>
|
| 4813 | <ul class="tsd-descriptions">
|
| 4814 | <li class="tsd-description">
|
| 4815 | <aside class="tsd-sources">
|
| 4816 | <ul>
|
| 4817 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/storage/index.ts#L580">storage/index.ts:580</a></li>
|
| 4818 | </ul>
|
| 4819 | </aside>
|
| 4820 | <div class="tsd-comment tsd-typography">
|
| 4821 | <div class="lead">
|
| 4822 | <p>Loop over the list of files in a Gaia hub, and run a callback on each entry.
|
| 4823 | Not meant to be called by external clients.</p>
|
| 4824 | </div>
|
| 4825 | </div>
|
| 4826 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 4827 | <ul class="tsd-parameters">
|
| 4828 | <li>
|
| 4829 | <h5>hubConfig: <a href="globals.html#gaiahubconfig" class="tsd-signature-type">GaiaHubConfig</a></h5>
|
| 4830 | <div class="tsd-comment tsd-typography">
|
| 4831 | <p>the Gaia hub config</p>
|
| 4832 | </div>
|
| 4833 | </li>
|
| 4834 | <li>
|
| 4835 | <h5>page: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></h5>
|
| 4836 | <div class="tsd-comment tsd-typography">
|
| 4837 | <p>the page ID</p>
|
| 4838 | </div>
|
| 4839 | </li>
|
| 4840 | <li>
|
| 4841 | <h5>callCount: <span class="tsd-signature-type">number</span></h5>
|
| 4842 | <div class="tsd-comment tsd-typography">
|
| 4843 | <p>the loop count</p>
|
| 4844 | </div>
|
| 4845 | </li>
|
| 4846 | <li>
|
| 4847 | <h5>fileCount: <span class="tsd-signature-type">number</span></h5>
|
| 4848 | <div class="tsd-comment tsd-typography">
|
| 4849 | <p>the number of files listed so far</p>
|
| 4850 | </div>
|
| 4851 | </li>
|
| 4852 | <li>
|
| 4853 | <h5>callback: <span class="tsd-signature-type">function</span></h5>
|
| 4854 | <div class="tsd-comment tsd-typography">
|
| 4855 | <p>the callback to invoke on each file. If it returns a falsey
|
| 4856 | value, then the loop stops. If it returns a truthy value, the loop continues.</p>
|
| 4857 | </div>
|
| 4858 | <ul class="tsd-parameters">
|
| 4859 | <li class="tsd-parameter-siganture">
|
| 4860 | <ul class="tsd-signatures tsd-kind-type-literal tsd-is-not-exported">
|
| 4861 | <li class="tsd-signature tsd-kind-icon"><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>
|
| 4862 | </ul>
|
| 4863 | <ul class="tsd-descriptions">
|
| 4864 | <li class="tsd-description">
|
| 4865 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 4866 | <ul class="tsd-parameters">
|
| 4867 | <li>
|
| 4868 | <h5>name: <span class="tsd-signature-type">string</span></h5>
|
| 4869 | </li>
|
| 4870 | </ul>
|
| 4871 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
|
| 4872 | </li>
|
| 4873 | </ul>
|
| 4874 | </li>
|
| 4875 | </ul>
|
| 4876 | </li>
|
| 4877 | </ul>
|
| 4878 | <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>
|
| 4879 | <p>that resolves to the number of files listed.</p>
|
| 4880 | </li>
|
| 4881 | </ul>
|
| 4882 | </section>
|
| 4883 | <section class="tsd-panel tsd-member tsd-kind-function">
|
| 4884 | <a name="loaduserdata" class="tsd-anchor"></a>
|
| 4885 | <h3>load<wbr>User<wbr>Data</h3>
|
| 4886 | <ul class="tsd-signatures tsd-kind-function">
|
| 4887 | <li class="tsd-signature tsd-kind-icon">load<wbr>User<wbr>Data<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="interfaces/userdata.html" class="tsd-signature-type">UserData</a></li>
|
| 4888 | </ul>
|
| 4889 | <ul class="tsd-descriptions">
|
| 4890 | <li class="tsd-description">
|
| 4891 | <aside class="tsd-sources">
|
| 4892 | <ul>
|
| 4893 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/auth/authApp.ts#L123">auth/authApp.ts:123</a></li>
|
| 4894 | </ul>
|
| 4895 | </aside>
|
| 4896 | <div class="tsd-comment tsd-typography">
|
| 4897 | <div class="lead">
|
| 4898 | <p>Retrieves the user data object. The user's profile is stored in the key <code>profile</code>.</p>
|
| 4899 | </div>
|
| 4900 | </div>
|
| 4901 | <h4 class="tsd-returns-title">Returns <a href="interfaces/userdata.html" class="tsd-signature-type">UserData</a></h4>
|
| 4902 | <p>User data object.</p>
|
| 4903 | </li>
|
| 4904 | </ul>
|
| 4905 | </section>
|
| 4906 | <section class="tsd-panel tsd-member tsd-kind-function">
|
| 4907 | <a name="lookupprofile" class="tsd-anchor"></a>
|
| 4908 | <h3>lookup<wbr>Profile</h3>
|
| 4909 | <ul class="tsd-signatures tsd-kind-function">
|
| 4910 | <li class="tsd-signature tsd-kind-icon">lookup<wbr>Profile<span class="tsd-signature-symbol">(</span>username<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, zoneFileLookupURL<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>
|
| 4911 | </ul>
|
| 4912 | <ul class="tsd-descriptions">
|
| 4913 | <li class="tsd-description">
|
| 4914 | <aside class="tsd-sources">
|
| 4915 | <ul>
|
| 4916 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileLookup.ts#L14">profiles/profileLookup.ts:14</a></li>
|
| 4917 | </ul>
|
| 4918 | </aside>
|
| 4919 | <div class="tsd-comment tsd-typography">
|
| 4920 | <div class="lead">
|
| 4921 | <p>Look up a user profile by blockstack ID</p>
|
| 4922 | </div>
|
| 4923 | </div>
|
| 4924 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 4925 | <ul class="tsd-parameters">
|
| 4926 | <li>
|
| 4927 | <h5>username: <span class="tsd-signature-type">string</span></h5>
|
| 4928 | <div class="tsd-comment tsd-typography">
|
| 4929 | <p>The Blockstack ID of the profile to look up</p>
|
| 4930 | </div>
|
| 4931 | </li>
|
| 4932 | <li>
|
| 4933 | <h5><span class="tsd-flag ts-flagOptional">Optional</span> zoneFileLookupURL: <span class="tsd-signature-type">string</span></h5>
|
| 4934 | </li>
|
| 4935 | </ul>
|
| 4936 | <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>
|
| 4937 | <p>that resolves to a profile object</p>
|
| 4938 | </li>
|
| 4939 | </ul>
|
| 4940 | </section>
|
| 4941 | <section class="tsd-panel tsd-member tsd-kind-function tsd-is-private tsd-is-not-exported">
|
| 4942 | <a name="makeannounce" class="tsd-anchor"></a>
|
| 4943 | <h3><span class="tsd-flag ts-flagPrivate">Private</span> make<wbr>Announce</h3>
|
| 4944 | <ul class="tsd-signatures tsd-kind-function tsd-is-private tsd-is-not-exported">
|
| 4945 | <li class="tsd-signature tsd-kind-icon">make<wbr>Announce<span class="tsd-signature-symbol">(</span>messageHash<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, senderKeyIn<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="interfaces/transactionsigner.html" class="tsd-signature-type">TransactionSigner</a>, buildIncomplete<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-type">string</span><span class="tsd-signature-symbol">></span></li>
|
| 4946 | </ul>
|
| 4947 | <ul class="tsd-descriptions">
|
| 4948 | <li class="tsd-description">
|
| 4949 | <aside class="tsd-sources">
|
| 4950 | <ul>
|
| 4951 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/operations/txbuild.ts#L1014">operations/txbuild.ts:1014</a></li>
|
| 4952 | </ul>
|
| 4953 | </aside>
|
| 4954 | <div class="tsd-comment tsd-typography">
|
| 4955 | <div class="lead">
|
| 4956 | <p>Generates an announce transaction</p>
|
| 4957 | </div>
|
| 4958 | </div>
|
| 4959 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 4960 | <ul class="tsd-parameters">
|
| 4961 | <li>
|
| 4962 | <h5>messageHash: <span class="tsd-signature-type">string</span></h5>
|
| 4963 | <div class="tsd-comment tsd-typography">
|
| 4964 | <p>the hash of the message to send. Should be
|
| 4965 | an already-announced zone file hash</p>
|
| 4966 | </div>
|
| 4967 | </li>
|
| 4968 | <li>
|
| 4969 | <h5>senderKeyIn: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="interfaces/transactionsigner.html" class="tsd-signature-type">TransactionSigner</a></h5>
|
| 4970 | <div class="tsd-comment tsd-typography">
|
| 4971 | <p>the private key
|
| 4972 | that pays for the transaction. Should be the key that owns the
|
| 4973 | name that the message recipients subscribe to</p>
|
| 4974 | </div>
|
| 4975 | </li>
|
| 4976 | <li>
|
| 4977 | <h5><span class="tsd-flag ts-flagDefault value">Default value</span> buildIncomplete: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></h5>
|
| 4978 | <div class="tsd-comment tsd-typography">
|
| 4979 | <p>optional boolean, defaults to false,
|
| 4980 | indicating whether the function should attempt to return an unsigned (or not fully signed)
|
| 4981 | transaction. Useful for passing around a TX for multi-sig input signing.</p>
|
| 4982 | </div>
|
| 4983 | </li>
|
| 4984 | </ul>
|
| 4985 | <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>
|
| 4986 | <ul>
|
| 4987 | <li>a promise which resolves to the hex-encoded transaction.
|
| 4988 | this function does not perform the requisite safety checks -- please see the
|
| 4989 | safety module for those.</li>
|
| 4990 | </ul>
|
| 4991 | </li>
|
| 4992 | </ul>
|
| 4993 | </section>
|
| 4994 | <section class="tsd-panel tsd-member tsd-kind-function">
|
| 4995 | <a name="makeannounceskeleton" class="tsd-anchor"></a>
|
| 4996 | <h3>make<wbr>Announce<wbr>Skeleton</h3>
|
| 4997 | <ul class="tsd-signatures tsd-kind-function">
|
| 4998 | <li class="tsd-signature tsd-kind-icon">make<wbr>Announce<wbr>Skeleton<span class="tsd-signature-symbol">(</span>messageHash<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">Transaction</span></li>
|
| 4999 | </ul>
|
| 5000 | <ul class="tsd-descriptions">
|
| 5001 | <li class="tsd-description">
|
| 5002 | <aside class="tsd-sources">
|
| 5003 | <ul>
|
| 5004 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/operations/skeletons.ts#L651">operations/skeletons.ts:651</a></li>
|
| 5005 | </ul>
|
| 5006 | </aside>
|
| 5007 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 5008 | <ul class="tsd-parameters">
|
| 5009 | <li>
|
| 5010 | <h5>messageHash: <span class="tsd-signature-type">string</span></h5>
|
| 5011 | </li>
|
| 5012 | </ul>
|
| 5013 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Transaction</span></h4>
|
| 5014 | </li>
|
| 5015 | </ul>
|
| 5016 | </section>
|
| 5017 | <section class="tsd-panel tsd-member tsd-kind-function">
|
| 5018 | <a name="makeauthrequest" class="tsd-anchor"></a>
|
| 5019 | <h3>make<wbr>Auth<wbr>Request</h3>
|
| 5020 | <ul class="tsd-signatures tsd-kind-function">
|
| 5021 | <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">string</span>, manifestURI<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, scopes<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span>, appDomain<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>
|
| 5022 | </ul>
|
| 5023 | <ul class="tsd-descriptions">
|
| 5024 | <li class="tsd-description">
|
| 5025 | <aside class="tsd-sources">
|
| 5026 | <ul>
|
| 5027 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/auth/authMessages.ts#L56">auth/authMessages.ts:56</a></li>
|
| 5028 | </ul>
|
| 5029 | </aside>
|
| 5030 | <div class="tsd-comment tsd-typography">
|
| 5031 | <div class="lead">
|
| 5032 | <p>Generates an authentication request that can be sent to the Blockstack
|
| 5033 | browser for the user to approve sign in. This authentication request can
|
| 5034 | then be used for sign in by passing it to the <code>redirectToSignInWithAuthRequest</code>
|
| 5035 | method.</p>
|
| 5036 | </div>
|
| 5037 | <p><em>Note: This method should only be used if you want to roll your own authentication
|
| 5038 | flow. Typically you'd use <code>redirectToSignIn</code> which takes care of this
|
| 5039 | under the hood.</em></p>
|
| 5040 | </div>
|
| 5041 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 5042 | <ul class="tsd-parameters">
|
| 5043 | <li>
|
| 5044 | <h5><span class="tsd-flag ts-flagOptional">Optional</span> transitPrivateKey: <span class="tsd-signature-type">string</span></h5>
|
| 5045 | <div class="tsd-comment tsd-typography">
|
| 5046 | <p>hex encoded transit private key</p>
|
| 5047 | </div>
|
| 5048 | </li>
|
| 5049 | <li>
|
| 5050 | <h5><span class="tsd-flag ts-flagOptional">Optional</span> redirectURI: <span class="tsd-signature-type">string</span></h5>
|
| 5051 | <div class="tsd-comment tsd-typography">
|
| 5052 | <p>location to redirect user to after sign in approval</p>
|
| 5053 | </div>
|
| 5054 | </li>
|
| 5055 | <li>
|
| 5056 | <h5><span class="tsd-flag ts-flagOptional">Optional</span> manifestURI: <span class="tsd-signature-type">string</span></h5>
|
| 5057 | <div class="tsd-comment tsd-typography">
|
| 5058 | <p>location of this app's manifest file</p>
|
| 5059 | </div>
|
| 5060 | </li>
|
| 5061 | <li>
|
| 5062 | <h5><span class="tsd-flag ts-flagDefault value">Default value</span> scopes: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = DEFAULT_SCOPE</span></h5>
|
| 5063 | <div class="tsd-comment tsd-typography">
|
| 5064 | <p>the permissions this app is requesting</p>
|
| 5065 | </div>
|
| 5066 | </li>
|
| 5067 | <li>
|
| 5068 | <h5><span class="tsd-flag ts-flagOptional">Optional</span> appDomain: <span class="tsd-signature-type">string</span></h5>
|
| 5069 | <div class="tsd-comment tsd-typography">
|
| 5070 | <p>the origin of this app</p>
|
| 5071 | </div>
|
| 5072 | </li>
|
| 5073 | <li>
|
| 5074 | <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>
|
| 5075 | <div class="tsd-comment tsd-typography">
|
| 5076 | <p>the time at which this request is no longer valid</p>
|
| 5077 | </div>
|
| 5078 | </li>
|
| 5079 | <li>
|
| 5080 | <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>
|
| 5081 | <div class="tsd-comment tsd-typography">
|
| 5082 | <p>Any extra parameters you'd like to pass to the authenticator.
|
| 5083 | Use this to pass options that aren't part of the Blockstack auth spec, but might be supported
|
| 5084 | by special authenticators.</p>
|
| 5085 | </div>
|
| 5086 | </li>
|
| 5087 | </ul>
|
| 5088 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
|
| 5089 | <p>the authentication request</p>
|
| 5090 | </li>
|
| 5091 | </ul>
|
| 5092 | </section>
|
| 5093 | <section class="tsd-panel tsd-member tsd-kind-function tsd-is-private">
|
| 5094 | <a name="makeauthresponse" class="tsd-anchor"></a>
|
| 5095 | <h3><span class="tsd-flag ts-flagPrivate">Private</span> make<wbr>Auth<wbr>Response</h3>
|
| 5096 | <ul class="tsd-signatures tsd-kind-function tsd-is-private">
|
| 5097 | <li class="tsd-signature tsd-kind-icon">make<wbr>Auth<wbr>Response<span class="tsd-signature-symbol">(</span>privateKey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, profile<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">__type</span>, username<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, metadata<span class="tsd-signature-symbol">: </span><a href="globals.html#authmetadata" class="tsd-signature-type">AuthMetadata</a>, coreToken<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, appPrivateKey<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>, transitPublicKey<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>, blockstackAPIUrl<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, associationToken<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>
|
| 5098 | </ul>
|
| 5099 | <ul class="tsd-descriptions">
|
| 5100 | <li class="tsd-description">
|
| 5101 | <aside class="tsd-sources">
|
| 5102 | <ul>
|
| 5103 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/auth/authMessages.ts#L183">auth/authMessages.ts:183</a></li>
|
| 5104 | </ul>
|
| 5105 | </aside>
|
| 5106 | <div class="tsd-comment tsd-typography">
|
| 5107 | <div class="lead">
|
| 5108 | <p>Generates a signed authentication response token for an app. This
|
| 5109 | token is sent back to apps which use contents to access the
|
| 5110 | resources and data requested by the app.</p>
|
| 5111 | </div>
|
| 5112 | </div>
|
| 5113 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 5114 | <ul class="tsd-parameters">
|
| 5115 | <li>
|
| 5116 | <h5>privateKey: <span class="tsd-signature-type">string</span></h5>
|
| 5117 | <div class="tsd-comment tsd-typography">
|
| 5118 | <p>the identity key of the Blockstack ID generating
|
| 5119 | the authentication response</p>
|
| 5120 | </div>
|
| 5121 | </li>
|
| 5122 | <li>
|
| 5123 | <h5><span class="tsd-flag ts-flagDefault value">Default value</span> profile: <span class="tsd-signature-type">__type</span><span class="tsd-signature-symbol"> = {}</span></h5>
|
| 5124 | <div class="tsd-comment tsd-typography">
|
| 5125 | <p>the profile object for the Blockstack ID</p>
|
| 5126 | </div>
|
| 5127 | </li>
|
| 5128 | <li>
|
| 5129 | <h5><span class="tsd-flag ts-flagDefault value">Default value</span> username: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = null</span></h5>
|
| 5130 | <div class="tsd-comment tsd-typography">
|
| 5131 | <p>the username of the Blockstack ID if any, otherwise <code>null</code></p>
|
| 5132 | </div>
|
| 5133 | </li>
|
| 5134 | <li>
|
| 5135 | <h5>metadata: <a href="globals.html#authmetadata" class="tsd-signature-type">AuthMetadata</a></h5>
|
| 5136 | <div class="tsd-comment tsd-typography">
|
| 5137 | <p>an object containing metadata sent as part of the authentication
|
| 5138 | response including <code>email</code> if requested and available and a URL to the profile</p>
|
| 5139 | </div>
|
| 5140 | </li>
|
| 5141 | <li>
|
| 5142 | <h5><span class="tsd-flag ts-flagDefault value">Default value</span> coreToken: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = null</span></h5>
|
| 5143 | <div class="tsd-comment tsd-typography">
|
| 5144 | <p>core session token when responding to a legacy auth request
|
| 5145 | or <code>null</code> for current direct to gaia authentication requests</p>
|
| 5146 | </div>
|
| 5147 | </li>
|
| 5148 | <li>
|
| 5149 | <h5><span class="tsd-flag ts-flagDefault value">Default value</span> appPrivateKey: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = null</span></h5>
|
| 5150 | <div class="tsd-comment tsd-typography">
|
| 5151 | <p>the application private key. This private key is
|
| 5152 | unique and specific for every Blockstack ID and application combination.</p>
|
| 5153 | </div>
|
| 5154 | </li>
|
| 5155 | <li>
|
| 5156 | <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>
|
| 5157 | <div class="tsd-comment tsd-typography">
|
| 5158 | <p>an integer in the same format as
|
| 5159 | <code>new Date().getTime()</code>, milliseconds since the Unix epoch</p>
|
| 5160 | </div>
|
| 5161 | </li>
|
| 5162 | <li>
|
| 5163 | <h5><span class="tsd-flag ts-flagDefault value">Default value</span> transitPublicKey: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = null</span></h5>
|
| 5164 | <div class="tsd-comment tsd-typography">
|
| 5165 | <p>the public key provide by the app
|
| 5166 | in its authentication request with which secrets will be encrypted</p>
|
| 5167 | </div>
|
| 5168 | </li>
|
| 5169 | <li>
|
| 5170 | <h5><span class="tsd-flag ts-flagDefault value">Default value</span> hubUrl: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = null</span></h5>
|
| 5171 | <div class="tsd-comment tsd-typography">
|
| 5172 | <p>URL to the write path of the user's Gaia hub</p>
|
| 5173 | </div>
|
| 5174 | </li>
|
| 5175 | <li>
|
| 5176 | <h5><span class="tsd-flag ts-flagDefault value">Default value</span> blockstackAPIUrl: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = null</span></h5>
|
| 5177 | <div class="tsd-comment tsd-typography">
|
| 5178 | <p>URL to the API endpoint to use</p>
|
| 5179 | </div>
|
| 5180 | </li>
|
| 5181 | <li>
|
| 5182 | <h5><span class="tsd-flag ts-flagDefault value">Default value</span> associationToken: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = null</span></h5>
|
| 5183 | <div class="tsd-comment tsd-typography">
|
| 5184 | <p>JWT that binds the app key to the identity key</p>
|
| 5185 | </div>
|
| 5186 | </li>
|
| 5187 | </ul>
|
| 5188 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
|
| 5189 | <p>signed and encoded authentication response token</p>
|
| 5190 | </li>
|
| 5191 | </ul>
|
| 5192 | </section>
|
| 5193 | <section class="tsd-panel tsd-member tsd-kind-function tsd-is-private tsd-is-not-exported">
|
| 5194 | <a name="makebitcoinspend" class="tsd-anchor"></a>
|
| 5195 | <h3><span class="tsd-flag ts-flagPrivate">Private</span> make<wbr>Bitcoin<wbr>Spend</h3>
|
| 5196 | <ul class="tsd-signatures tsd-kind-function tsd-is-private tsd-is-not-exported">
|
| 5197 | <li class="tsd-signature tsd-kind-icon">make<wbr>Bitcoin<wbr>Spend<span class="tsd-signature-symbol">(</span>destinationAddress<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, paymentKeyIn<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="interfaces/transactionsigner.html" class="tsd-signature-type">TransactionSigner</a>, amount<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, buildIncomplete<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-type">string</span><span class="tsd-signature-symbol">></span></li>
|
| 5198 | </ul>
|
| 5199 | <ul class="tsd-descriptions">
|
| 5200 | <li class="tsd-description">
|
| 5201 | <aside class="tsd-sources">
|
| 5202 | <ul>
|
| 5203 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/operations/txbuild.ts#L1121">operations/txbuild.ts:1121</a></li>
|
| 5204 | </ul>
|
| 5205 | </aside>
|
| 5206 | <div class="tsd-comment tsd-typography">
|
| 5207 | <div class="lead">
|
| 5208 | <p>Generates a bitcoin spend to a specified address. This will fund up to <code>amount</code>
|
| 5209 | of satoshis from the payer's UTXOs. It will generate a change output if and only
|
| 5210 | if the amount of leftover change is <em>greater</em> than the additional fees associated
|
| 5211 | with the extra output. If the requested amount is not enough to fund the transaction's
|
| 5212 | associated fees, then this will reject with a InvalidAmountError</p>
|
| 5213 | </div>
|
| 5214 | <p>UTXOs are selected largest to smallest, and UTXOs which cannot fund the fees associated
|
| 5215 | with their own input will not be included.</p>
|
| 5216 | <p>If you specify an amount > the total balance of the payer address, then this will
|
| 5217 | generate a maximum spend transaction</p>
|
| 5218 | </div>
|
| 5219 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 5220 | <ul class="tsd-parameters">
|
| 5221 | <li>
|
| 5222 | <h5>destinationAddress: <span class="tsd-signature-type">string</span></h5>
|
| 5223 | <div class="tsd-comment tsd-typography">
|
| 5224 | <p>the address to receive the bitcoin payment</p>
|
| 5225 | </div>
|
| 5226 | </li>
|
| 5227 | <li>
|
| 5228 | <h5>paymentKeyIn: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="interfaces/transactionsigner.html" class="tsd-signature-type">TransactionSigner</a></h5>
|
| 5229 | <div class="tsd-comment tsd-typography">
|
| 5230 | <p>the private key
|
| 5231 | used to fund the bitcoin spend</p>
|
| 5232 | </div>
|
| 5233 | </li>
|
| 5234 | <li>
|
| 5235 | <h5>amount: <span class="tsd-signature-type">number</span></h5>
|
| 5236 | <div class="tsd-comment tsd-typography">
|
| 5237 | <p>the amount in satoshis for the payment address to
|
| 5238 | spend in this transaction</p>
|
| 5239 | </div>
|
| 5240 | </li>
|
| 5241 | <li>
|
| 5242 | <h5><span class="tsd-flag ts-flagDefault value">Default value</span> buildIncomplete: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></h5>
|
| 5243 | <div class="tsd-comment tsd-typography">
|
| 5244 | <p>optional boolean, defaults to false,
|
| 5245 | indicating whether the function should attempt to return an unsigned (or not fully signed)
|
| 5246 | transaction. Useful for passing around a TX for multi-sig input signing.</p>
|
| 5247 | </div>
|
| 5248 | </li>
|
| 5249 | </ul>
|
| 5250 | <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>
|
| 5251 | <ul>
|
| 5252 | <li>a promise which resolves to the hex-encoded transaction.</li>
|
| 5253 | </ul>
|
| 5254 | </li>
|
| 5255 | </ul>
|
| 5256 | </section>
|
| 5257 | <section class="tsd-panel tsd-member tsd-kind-function tsd-is-private">
|
| 5258 | <a name="makecoresessionrequest" class="tsd-anchor"></a>
|
| 5259 | <h3><span class="tsd-flag ts-flagPrivate">Private</span> make<wbr>Core<wbr>Session<wbr>Request</h3>
|
| 5260 | <ul class="tsd-signatures tsd-kind-function tsd-is-private">
|
| 5261 | <li class="tsd-signature tsd-kind-icon">make<wbr>Core<wbr>Session<wbr>Request<span class="tsd-signature-symbol">(</span>appDomain<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, appMethods<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>, appPrivateKey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, blockchainID<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, thisDevice<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">any</span></li>
|
| 5262 | </ul>
|
| 5263 | <ul class="tsd-descriptions">
|
| 5264 | <li class="tsd-description">
|
| 5265 | <aside class="tsd-sources">
|
| 5266 | <ul>
|
| 5267 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/auth/authSession.ts#L19">auth/authSession.ts:19</a></li>
|
| 5268 | </ul>
|
| 5269 | </aside>
|
| 5270 | <div class="tsd-comment tsd-typography">
|
| 5271 | <div class="lead">
|
| 5272 | <p>Create an authentication token to be sent to the Core API server
|
| 5273 | in order to generate a Core session JWT.</p>
|
| 5274 | </div>
|
| 5275 | <dl class="tsd-comment-tags">
|
| 5276 | <dt>deprecated</dt>
|
| 5277 | <dd></dd>
|
| 5278 | </dl>
|
| 5279 | </div>
|
| 5280 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 5281 | <ul class="tsd-parameters">
|
| 5282 | <li>
|
| 5283 | <h5>appDomain: <span class="tsd-signature-type">string</span></h5>
|
| 5284 | <div class="tsd-comment tsd-typography">
|
| 5285 | <p>The unique application identifier (e.g. foo.app, <a href="http://www.foo.com">www.foo.com</a>, etc).</p>
|
| 5286 | </div>
|
| 5287 | </li>
|
| 5288 | <li>
|
| 5289 | <h5>appMethods: <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>
|
| 5290 | <div class="tsd-comment tsd-typography">
|
| 5291 | <p>The list of API methods this application will need.</p>
|
| 5292 | </div>
|
| 5293 | </li>
|
| 5294 | <li>
|
| 5295 | <h5>appPrivateKey: <span class="tsd-signature-type">string</span></h5>
|
| 5296 | <div class="tsd-comment tsd-typography">
|
| 5297 | <p>The application-specific private key</p>
|
| 5298 | </div>
|
| 5299 | </li>
|
| 5300 | <li>
|
| 5301 | <h5><span class="tsd-flag ts-flagDefault value">Default value</span> blockchainID: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = null</span></h5>
|
| 5302 | <div class="tsd-comment tsd-typography">
|
| 5303 | <p>This is the blockchain ID of the requester</p>
|
| 5304 | </div>
|
| 5305 | </li>
|
| 5306 | <li>
|
| 5307 | <h5><span class="tsd-flag ts-flagDefault value">Default value</span> thisDevice: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = null</span></h5>
|
| 5308 | <div class="tsd-comment tsd-typography">
|
| 5309 | <p>Identifier of the current device</p>
|
| 5310 | </div>
|
| 5311 | </li>
|
| 5312 | </ul>
|
| 5313 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
|
| 5314 | <p>a JWT signed by the app's private key</p>
|
| 5315 | </li>
|
| 5316 | </ul>
|
| 5317 | </section>
|
| 5318 | <section class="tsd-panel tsd-member tsd-kind-function">
|
| 5319 | <a name="makedidfromaddress" class="tsd-anchor"></a>
|
| 5320 | <h3>makeDIDFrom<wbr>Address</h3>
|
| 5321 | <ul class="tsd-signatures tsd-kind-function">
|
| 5322 | <li class="tsd-signature tsd-kind-icon">makeDIDFrom<wbr>Address<span class="tsd-signature-symbol">(</span>address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
|
| 5323 | </ul>
|
| 5324 | <ul class="tsd-descriptions">
|
| 5325 | <li class="tsd-description">
|
| 5326 | <aside class="tsd-sources">
|
| 5327 | <ul>
|
| 5328 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/dids.ts#L3">dids.ts:3</a></li>
|
| 5329 | </ul>
|
| 5330 | </aside>
|
| 5331 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 5332 | <ul class="tsd-parameters">
|
| 5333 | <li>
|
| 5334 | <h5>address: <span class="tsd-signature-type">string</span></h5>
|
| 5335 | </li>
|
| 5336 | </ul>
|
| 5337 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
|
| 5338 | </li>
|
| 5339 | </ul>
|
| 5340 | </section>
|
| 5341 | <section class="tsd-panel tsd-member tsd-kind-function">
|
| 5342 | <a name="makedidfrompublickey" class="tsd-anchor"></a>
|
| 5343 | <h3>makeDIDFrom<wbr>Public<wbr>Key</h3>
|
| 5344 | <ul class="tsd-signatures tsd-kind-function">
|
| 5345 | <li class="tsd-signature tsd-kind-icon">makeDIDFrom<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-symbol">: </span><span class="tsd-signature-type">string</span></li>
|
| 5346 | </ul>
|
| 5347 | <ul class="tsd-descriptions">
|
| 5348 | <li class="tsd-description">
|
| 5349 | <aside class="tsd-sources">
|
| 5350 | <ul>
|
| 5351 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/dids.ts#L7">dids.ts:7</a></li>
|
| 5352 | </ul>
|
| 5353 | </aside>
|
| 5354 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 5355 | <ul class="tsd-parameters">
|
| 5356 | <li>
|
| 5357 | <h5>publicKey: <span class="tsd-signature-type">string</span></h5>
|
| 5358 | </li>
|
| 5359 | </ul>
|
| 5360 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
|
| 5361 | </li>
|
| 5362 | </ul>
|
| 5363 | </section>
|
| 5364 | <section class="tsd-panel tsd-member tsd-kind-function">
|
| 5365 | <a name="makeecprivatekey" class="tsd-anchor"></a>
|
| 5366 | <h3>makeECPrivate<wbr>Key</h3>
|
| 5367 | <ul class="tsd-signatures tsd-kind-function">
|
| 5368 | <li class="tsd-signature tsd-kind-icon">makeECPrivate<wbr>Key<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>
|
| 5369 | </ul>
|
| 5370 | <ul class="tsd-descriptions">
|
| 5371 | <li class="tsd-description">
|
| 5372 | <aside class="tsd-sources">
|
| 5373 | <ul>
|
| 5374 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/keys.ts#L12">keys.ts:12</a></li>
|
| 5375 | </ul>
|
| 5376 | </aside>
|
| 5377 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
|
| 5378 | </li>
|
| 5379 | </ul>
|
| 5380 | </section>
|
| 5381 | <section class="tsd-panel tsd-member tsd-kind-function tsd-is-not-exported">
|
| 5382 | <a name="makelegacyauthtoken" class="tsd-anchor"></a>
|
| 5383 | <h3>make<wbr>Legacy<wbr>Auth<wbr>Token</h3>
|
| 5384 | <ul class="tsd-signatures tsd-kind-function tsd-is-not-exported">
|
| 5385 | <li class="tsd-signature tsd-kind-icon">make<wbr>Legacy<wbr>Auth<wbr>Token<span class="tsd-signature-symbol">(</span>challengeText<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, signerKeyHex<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>
|
| 5386 | </ul>
|
| 5387 | <ul class="tsd-descriptions">
|
| 5388 | <li class="tsd-description">
|
| 5389 | <aside class="tsd-sources">
|
| 5390 | <ul>
|
| 5391 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/storage/hub.ts#L49">storage/hub.ts:49</a></li>
|
| 5392 | </ul>
|
| 5393 | </aside>
|
| 5394 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 5395 | <ul class="tsd-parameters">
|
| 5396 | <li>
|
| 5397 | <h5>challengeText: <span class="tsd-signature-type">string</span></h5>
|
| 5398 | </li>
|
| 5399 | <li>
|
| 5400 | <h5>signerKeyHex: <span class="tsd-signature-type">string</span></h5>
|
| 5401 | </li>
|
| 5402 | </ul>
|
| 5403 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
|
| 5404 | </li>
|
| 5405 | </ul>
|
| 5406 | </section>
|
| 5407 | <section class="tsd-panel tsd-member tsd-kind-function tsd-is-private tsd-is-not-exported">
|
| 5408 | <a name="makenameimport" class="tsd-anchor"></a>
|
| 5409 | <h3><span class="tsd-flag ts-flagPrivate">Private</span> make<wbr>Name<wbr>Import</h3>
|
| 5410 | <ul class="tsd-signatures tsd-kind-function tsd-is-private tsd-is-not-exported">
|
| 5411 | <li class="tsd-signature tsd-kind-icon">make<wbr>Name<wbr>Import<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, recipientAddr<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, zonefileHash<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, importerKeyIn<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="interfaces/transactionsigner.html" class="tsd-signature-type">TransactionSigner</a>, buildIncomplete<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-type">string</span><span class="tsd-signature-symbol">></span></li>
|
| 5412 | </ul>
|
| 5413 | <ul class="tsd-descriptions">
|
| 5414 | <li class="tsd-description">
|
| 5415 | <aside class="tsd-sources">
|
| 5416 | <ul>
|
| 5417 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/operations/txbuild.ts#L976">operations/txbuild.ts:976</a></li>
|
| 5418 | </ul>
|
| 5419 | </aside>
|
| 5420 | <div class="tsd-comment tsd-typography">
|
| 5421 | <div class="lead">
|
| 5422 | <p>Generates a name import transaction for a namespace</p>
|
| 5423 | </div>
|
| 5424 | </div>
|
| 5425 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 5426 | <ul class="tsd-parameters">
|
| 5427 | <li>
|
| 5428 | <h5>name: <span class="tsd-signature-type">string</span></h5>
|
| 5429 | <div class="tsd-comment tsd-typography">
|
| 5430 | <p>the name to import</p>
|
| 5431 | </div>
|
| 5432 | </li>
|
| 5433 | <li>
|
| 5434 | <h5>recipientAddr: <span class="tsd-signature-type">string</span></h5>
|
| 5435 | <div class="tsd-comment tsd-typography">
|
| 5436 | <p>the address to receive the name</p>
|
| 5437 | </div>
|
| 5438 | </li>
|
| 5439 | <li>
|
| 5440 | <h5>zonefileHash: <span class="tsd-signature-type">string</span></h5>
|
| 5441 | <div class="tsd-comment tsd-typography">
|
| 5442 | <p>the hash of the zonefile to give this name</p>
|
| 5443 | </div>
|
| 5444 | </li>
|
| 5445 | <li>
|
| 5446 | <h5>importerKeyIn: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="interfaces/transactionsigner.html" class="tsd-signature-type">TransactionSigner</a></h5>
|
| 5447 | <div class="tsd-comment tsd-typography">
|
| 5448 | <p>the private key
|
| 5449 | that pays for the import</p>
|
| 5450 | </div>
|
| 5451 | </li>
|
| 5452 | <li>
|
| 5453 | <h5><span class="tsd-flag ts-flagDefault value">Default value</span> buildIncomplete: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></h5>
|
| 5454 | <div class="tsd-comment tsd-typography">
|
| 5455 | <p>optional boolean, defaults to false,
|
| 5456 | indicating whether the function should attempt to return an unsigned (or not fully signed)
|
| 5457 | transaction. Useful for passing around a TX for multi-sig input signing.</p>
|
| 5458 | </div>
|
| 5459 | </li>
|
| 5460 | </ul>
|
| 5461 | <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>
|
| 5462 | <ul>
|
| 5463 | <li>a promise which resolves to the hex-encoded transaction.
|
| 5464 | this function does not perform the requisite safety checks -- please see
|
| 5465 | the safety module for those.</li>
|
| 5466 | </ul>
|
| 5467 | </li>
|
| 5468 | </ul>
|
| 5469 | </section>
|
| 5470 | <section class="tsd-panel tsd-member tsd-kind-function">
|
| 5471 | <a name="makenameimportskeleton" class="tsd-anchor"></a>
|
| 5472 | <h3>make<wbr>Name<wbr>Import<wbr>Skeleton</h3>
|
| 5473 | <ul class="tsd-signatures tsd-kind-function">
|
| 5474 | <li class="tsd-signature tsd-kind-icon">make<wbr>Name<wbr>Import<wbr>Skeleton<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, recipientAddr<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, zonefileHash<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">Transaction</span></li>
|
| 5475 | </ul>
|
| 5476 | <ul class="tsd-descriptions">
|
| 5477 | <li class="tsd-description">
|
| 5478 | <aside class="tsd-sources">
|
| 5479 | <ul>
|
| 5480 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/operations/skeletons.ts#L616">operations/skeletons.ts:616</a></li>
|
| 5481 | </ul>
|
| 5482 | </aside>
|
| 5483 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 5484 | <ul class="tsd-parameters">
|
| 5485 | <li>
|
| 5486 | <h5>name: <span class="tsd-signature-type">string</span></h5>
|
| 5487 | </li>
|
| 5488 | <li>
|
| 5489 | <h5>recipientAddr: <span class="tsd-signature-type">string</span></h5>
|
| 5490 | </li>
|
| 5491 | <li>
|
| 5492 | <h5>zonefileHash: <span class="tsd-signature-type">string</span></h5>
|
| 5493 | </li>
|
| 5494 | </ul>
|
| 5495 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Transaction</span></h4>
|
| 5496 | </li>
|
| 5497 | </ul>
|
| 5498 | </section>
|
| 5499 | <section class="tsd-panel tsd-member tsd-kind-function tsd-is-private tsd-is-not-exported">
|
| 5500 | <a name="makenamespacepreorder" class="tsd-anchor"></a>
|
| 5501 | <h3><span class="tsd-flag ts-flagPrivate">Private</span> make<wbr>Namespace<wbr>Preorder</h3>
|
| 5502 | <ul class="tsd-signatures tsd-kind-function tsd-is-private tsd-is-not-exported">
|
| 5503 | <li class="tsd-signature tsd-kind-icon">make<wbr>Namespace<wbr>Preorder<span class="tsd-signature-symbol">(</span>namespaceID<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, revealAddress<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, paymentKeyIn<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="interfaces/transactionsigner.html" class="tsd-signature-type">TransactionSigner</a>, buildIncomplete<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-type">string</span><span class="tsd-signature-symbol">></span></li>
|
| 5504 | </ul>
|
| 5505 | <ul class="tsd-descriptions">
|
| 5506 | <li class="tsd-description">
|
| 5507 | <aside class="tsd-sources">
|
| 5508 | <ul>
|
| 5509 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/operations/txbuild.ts#L849">operations/txbuild.ts:849</a></li>
|
| 5510 | </ul>
|
| 5511 | </aside>
|
| 5512 | <div class="tsd-comment tsd-typography">
|
| 5513 | <div class="lead">
|
| 5514 | <p>Generates a namespace preorder transaction for a namespace</p>
|
| 5515 | </div>
|
| 5516 | </div>
|
| 5517 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 5518 | <ul class="tsd-parameters">
|
| 5519 | <li>
|
| 5520 | <h5>namespaceID: <span class="tsd-signature-type">string</span></h5>
|
| 5521 | <div class="tsd-comment tsd-typography">
|
| 5522 | <p>the namespace to pre-order</p>
|
| 5523 | </div>
|
| 5524 | </li>
|
| 5525 | <li>
|
| 5526 | <h5>revealAddress: <span class="tsd-signature-type">string</span></h5>
|
| 5527 | <div class="tsd-comment tsd-typography">
|
| 5528 | <p>the address to receive the namespace (this
|
| 5529 | must be passed as the 'revealAddress' in the namespace-reveal transaction)</p>
|
| 5530 | </div>
|
| 5531 | </li>
|
| 5532 | <li>
|
| 5533 | <h5>paymentKeyIn: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="interfaces/transactionsigner.html" class="tsd-signature-type">TransactionSigner</a></h5>
|
| 5534 | <div class="tsd-comment tsd-typography">
|
| 5535 | <p>a hex string of
|
| 5536 | the private key used to fund the transaction (or a
|
| 5537 | TransactionSigner object)</p>
|
| 5538 | </div>
|
| 5539 | </li>
|
| 5540 | <li>
|
| 5541 | <h5><span class="tsd-flag ts-flagDefault value">Default value</span> buildIncomplete: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></h5>
|
| 5542 | <div class="tsd-comment tsd-typography">
|
| 5543 | <p>optional boolean, defaults to false,
|
| 5544 | indicating whether the function should attempt to return an unsigned (or not fully signed)
|
| 5545 | transaction. Useful for passing around a TX for multi-sig input signing.</p>
|
| 5546 | </div>
|
| 5547 | </li>
|
| 5548 | </ul>
|
| 5549 | <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>
|
| 5550 | <ul>
|
| 5551 | <li>a promise which resolves to the hex-encoded transaction.
|
| 5552 | this function <em>does not</em> perform the requisite safety checks -- please see
|
| 5553 | the safety module for those.</li>
|
| 5554 | </ul>
|
| 5555 | </li>
|
| 5556 | </ul>
|
| 5557 | </section>
|
| 5558 | <section class="tsd-panel tsd-member tsd-kind-function">
|
| 5559 | <a name="makenamespacepreorderskeleton" class="tsd-anchor"></a>
|
| 5560 | <h3>make<wbr>Namespace<wbr>Preorder<wbr>Skeleton</h3>
|
| 5561 | <ul class="tsd-signatures tsd-kind-function">
|
| 5562 | <li class="tsd-signature tsd-kind-icon">make<wbr>Namespace<wbr>Preorder<wbr>Skeleton<span class="tsd-signature-symbol">(</span>namespaceID<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, consensusHash<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, preorderAddress<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, registerAddress<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, burn<span class="tsd-signature-symbol">: </span><a href="globals.html#amounttype" class="tsd-signature-type">AmountType</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Transaction</span></li>
|
| 5563 | </ul>
|
| 5564 | <ul class="tsd-descriptions">
|
| 5565 | <li class="tsd-description">
|
| 5566 | <aside class="tsd-sources">
|
| 5567 | <ul>
|
| 5568 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/operations/skeletons.ts#L487">operations/skeletons.ts:487</a></li>
|
| 5569 | </ul>
|
| 5570 | </aside>
|
| 5571 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 5572 | <ul class="tsd-parameters">
|
| 5573 | <li>
|
| 5574 | <h5>namespaceID: <span class="tsd-signature-type">string</span></h5>
|
| 5575 | </li>
|
| 5576 | <li>
|
| 5577 | <h5>consensusHash: <span class="tsd-signature-type">string</span></h5>
|
| 5578 | </li>
|
| 5579 | <li>
|
| 5580 | <h5>preorderAddress: <span class="tsd-signature-type">string</span></h5>
|
| 5581 | </li>
|
| 5582 | <li>
|
| 5583 | <h5>registerAddress: <span class="tsd-signature-type">string</span></h5>
|
| 5584 | </li>
|
| 5585 | <li>
|
| 5586 | <h5>burn: <a href="globals.html#amounttype" class="tsd-signature-type">AmountType</a></h5>
|
| 5587 | </li>
|
| 5588 | </ul>
|
| 5589 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Transaction</span></h4>
|
| 5590 | </li>
|
| 5591 | </ul>
|
| 5592 | </section>
|
| 5593 | <section class="tsd-panel tsd-member tsd-kind-function tsd-is-private tsd-is-not-exported">
|
| 5594 | <a name="makenamespaceready" class="tsd-anchor"></a>
|
| 5595 | <h3><span class="tsd-flag ts-flagPrivate">Private</span> make<wbr>Namespace<wbr>Ready</h3>
|
| 5596 | <ul class="tsd-signatures tsd-kind-function tsd-is-private tsd-is-not-exported">
|
| 5597 | <li class="tsd-signature tsd-kind-icon">make<wbr>Namespace<wbr>Ready<span class="tsd-signature-symbol">(</span>namespaceID<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, revealKeyIn<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="interfaces/transactionsigner.html" class="tsd-signature-type">TransactionSigner</a>, buildIncomplete<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-type">string</span><span class="tsd-signature-symbol">></span></li>
|
| 5598 | </ul>
|
| 5599 | <ul class="tsd-descriptions">
|
| 5600 | <li class="tsd-description">
|
| 5601 | <aside class="tsd-sources">
|
| 5602 | <ul>
|
| 5603 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/operations/txbuild.ts#L939">operations/txbuild.ts:939</a></li>
|
| 5604 | </ul>
|
| 5605 | </aside>
|
| 5606 | <div class="tsd-comment tsd-typography">
|
| 5607 | <div class="lead">
|
| 5608 | <p>Generates a namespace ready transaction for a namespace</p>
|
| 5609 | </div>
|
| 5610 | </div>
|
| 5611 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 5612 | <ul class="tsd-parameters">
|
| 5613 | <li>
|
| 5614 | <h5>namespaceID: <span class="tsd-signature-type">string</span></h5>
|
| 5615 | <div class="tsd-comment tsd-typography">
|
| 5616 | <p>the namespace to launch</p>
|
| 5617 | </div>
|
| 5618 | </li>
|
| 5619 | <li>
|
| 5620 | <h5>revealKeyIn: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="interfaces/transactionsigner.html" class="tsd-signature-type">TransactionSigner</a></h5>
|
| 5621 | <div class="tsd-comment tsd-typography">
|
| 5622 | <p>the private key
|
| 5623 | of the 'revealAddress' used to reveal the namespace</p>
|
| 5624 | </div>
|
| 5625 | </li>
|
| 5626 | <li>
|
| 5627 | <h5><span class="tsd-flag ts-flagDefault value">Default value</span> buildIncomplete: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></h5>
|
| 5628 | <div class="tsd-comment tsd-typography">
|
| 5629 | <p>optional boolean, defaults to false,
|
| 5630 | indicating whether the function should attempt to return an unsigned (or not fully signed)
|
| 5631 | transaction. Useful for passing around a TX for multi-sig input signing.</p>
|
| 5632 | </div>
|
| 5633 | </li>
|
| 5634 | </ul>
|
| 5635 | <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>
|
| 5636 | <ul>
|
| 5637 | <li>a promise which resolves to the hex-encoded transaction.
|
| 5638 | this function <em>does not</em> perform the requisite safety checks -- please see
|
| 5639 | the safety module for those.</li>
|
| 5640 | </ul>
|
| 5641 | </li>
|
| 5642 | </ul>
|
| 5643 | </section>
|
| 5644 | <section class="tsd-panel tsd-member tsd-kind-function">
|
| 5645 | <a name="makenamespacereadyskeleton" class="tsd-anchor"></a>
|
| 5646 | <h3>make<wbr>Namespace<wbr>Ready<wbr>Skeleton</h3>
|
| 5647 | <ul class="tsd-signatures tsd-kind-function">
|
| 5648 | <li class="tsd-signature tsd-kind-icon">make<wbr>Namespace<wbr>Ready<wbr>Skeleton<span class="tsd-signature-symbol">(</span>namespaceID<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">Transaction</span></li>
|
| 5649 | </ul>
|
| 5650 | <ul class="tsd-descriptions">
|
| 5651 | <li class="tsd-description">
|
| 5652 | <aside class="tsd-sources">
|
| 5653 | <ul>
|
| 5654 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/operations/skeletons.ts#L591">operations/skeletons.ts:591</a></li>
|
| 5655 | </ul>
|
| 5656 | </aside>
|
| 5657 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 5658 | <ul class="tsd-parameters">
|
| 5659 | <li>
|
| 5660 | <h5>namespaceID: <span class="tsd-signature-type">string</span></h5>
|
| 5661 | </li>
|
| 5662 | </ul>
|
| 5663 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Transaction</span></h4>
|
| 5664 | </li>
|
| 5665 | </ul>
|
| 5666 | </section>
|
| 5667 | <section class="tsd-panel tsd-member tsd-kind-function tsd-is-private tsd-is-not-exported">
|
| 5668 | <a name="makenamespacereveal" class="tsd-anchor"></a>
|
| 5669 | <h3><span class="tsd-flag ts-flagPrivate">Private</span> make<wbr>Namespace<wbr>Reveal</h3>
|
| 5670 | <ul class="tsd-signatures tsd-kind-function tsd-is-private tsd-is-not-exported">
|
| 5671 | <li class="tsd-signature tsd-kind-icon">make<wbr>Namespace<wbr>Reveal<span class="tsd-signature-symbol">(</span>namespace<span class="tsd-signature-symbol">: </span><a href="classes/blockstacknamespace.html" class="tsd-signature-type">BlockstackNamespace</a>, revealAddress<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, paymentKeyIn<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="interfaces/transactionsigner.html" class="tsd-signature-type">TransactionSigner</a>, buildIncomplete<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-type">string</span><span class="tsd-signature-symbol">></span></li>
|
| 5672 | </ul>
|
| 5673 | <ul class="tsd-descriptions">
|
| 5674 | <li class="tsd-description">
|
| 5675 | <aside class="tsd-sources">
|
| 5676 | <ul>
|
| 5677 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/operations/txbuild.ts#L896">operations/txbuild.ts:896</a></li>
|
| 5678 | </ul>
|
| 5679 | </aside>
|
| 5680 | <div class="tsd-comment tsd-typography">
|
| 5681 | <div class="lead">
|
| 5682 | <p>Generates a namespace reveal transaction for a namespace</p>
|
| 5683 | </div>
|
| 5684 | </div>
|
| 5685 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 5686 | <ul class="tsd-parameters">
|
| 5687 | <li>
|
| 5688 | <h5>namespace: <a href="classes/blockstacknamespace.html" class="tsd-signature-type">BlockstackNamespace</a></h5>
|
| 5689 | <div class="tsd-comment tsd-typography">
|
| 5690 | <p>the namespace to reveal</p>
|
| 5691 | </div>
|
| 5692 | </li>
|
| 5693 | <li>
|
| 5694 | <h5>revealAddress: <span class="tsd-signature-type">string</span></h5>
|
| 5695 | <div class="tsd-comment tsd-typography">
|
| 5696 | <p>the address to receive the namespace (this
|
| 5697 | must be passed as the 'revealAddress' in the namespace-reveal transaction)</p>
|
| 5698 | </div>
|
| 5699 | </li>
|
| 5700 | <li>
|
| 5701 | <h5>paymentKeyIn: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="interfaces/transactionsigner.html" class="tsd-signature-type">TransactionSigner</a></h5>
|
| 5702 | <div class="tsd-comment tsd-typography">
|
| 5703 | <p>a hex string (or
|
| 5704 | a TransactionSigner object) of the private key used to fund the
|
| 5705 | transaction</p>
|
| 5706 | </div>
|
| 5707 | </li>
|
| 5708 | <li>
|
| 5709 | <h5><span class="tsd-flag ts-flagDefault value">Default value</span> buildIncomplete: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></h5>
|
| 5710 | <div class="tsd-comment tsd-typography">
|
| 5711 | <p>optional boolean, defaults to false,
|
| 5712 | indicating whether the function should attempt to return an unsigned (or not fully signed)
|
| 5713 | transaction. Useful for passing around a TX for multi-sig input signing.</p>
|
| 5714 | </div>
|
| 5715 | </li>
|
| 5716 | </ul>
|
| 5717 | <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>
|
| 5718 | <ul>
|
| 5719 | <li>a promise which resolves to the hex-encoded transaction.
|
| 5720 | this function <em>does not</em> perform the requisite safety checks -- please see
|
| 5721 | the safety module for those.</li>
|
| 5722 | </ul>
|
| 5723 | </li>
|
| 5724 | </ul>
|
| 5725 | </section>
|
| 5726 | <section class="tsd-panel tsd-member tsd-kind-function">
|
| 5727 | <a name="makenamespacerevealskeleton" class="tsd-anchor"></a>
|
| 5728 | <h3>make<wbr>Namespace<wbr>Reveal<wbr>Skeleton</h3>
|
| 5729 | <ul class="tsd-signatures tsd-kind-function">
|
| 5730 | <li class="tsd-signature tsd-kind-icon">make<wbr>Namespace<wbr>Reveal<wbr>Skeleton<span class="tsd-signature-symbol">(</span>namespace<span class="tsd-signature-symbol">: </span><a href="classes/blockstacknamespace.html" class="tsd-signature-type">BlockstackNamespace</a>, revealAddress<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">Transaction</span></li>
|
| 5731 | </ul>
|
| 5732 | <ul class="tsd-descriptions">
|
| 5733 | <li class="tsd-description">
|
| 5734 | <aside class="tsd-sources">
|
| 5735 | <ul>
|
| 5736 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/operations/skeletons.ts#L560">operations/skeletons.ts:560</a></li>
|
| 5737 | </ul>
|
| 5738 | </aside>
|
| 5739 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 5740 | <ul class="tsd-parameters">
|
| 5741 | <li>
|
| 5742 | <h5>namespace: <a href="classes/blockstacknamespace.html" class="tsd-signature-type">BlockstackNamespace</a></h5>
|
| 5743 | </li>
|
| 5744 | <li>
|
| 5745 | <h5>revealAddress: <span class="tsd-signature-type">string</span></h5>
|
| 5746 | </li>
|
| 5747 | </ul>
|
| 5748 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Transaction</span></h4>
|
| 5749 | </li>
|
| 5750 | </ul>
|
| 5751 | </section>
|
| 5752 | <section class="tsd-panel tsd-member tsd-kind-function tsd-is-private tsd-is-not-exported">
|
| 5753 | <a name="makepreorder" class="tsd-anchor"></a>
|
| 5754 | <h3><span class="tsd-flag ts-flagPrivate">Private</span> make<wbr>Preorder</h3>
|
| 5755 | <ul class="tsd-signatures tsd-kind-function tsd-is-private tsd-is-not-exported">
|
| 5756 | <li class="tsd-signature tsd-kind-icon">make<wbr>Preorder<span class="tsd-signature-symbol">(</span>fullyQualifiedName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, destinationAddress<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, paymentKeyIn<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="interfaces/transactionsigner.html" class="tsd-signature-type">TransactionSigner</a>, buildIncomplete<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-type">string</span><span class="tsd-signature-symbol">></span></li>
|
| 5757 | </ul>
|
| 5758 | <ul class="tsd-descriptions">
|
| 5759 | <li class="tsd-description">
|
| 5760 | <aside class="tsd-sources">
|
| 5761 | <ul>
|
| 5762 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/operations/txbuild.ts#L482">operations/txbuild.ts:482</a></li>
|
| 5763 | </ul>
|
| 5764 | </aside>
|
| 5765 | <div class="tsd-comment tsd-typography">
|
| 5766 | <div class="lead">
|
| 5767 | <p>Generates a preorder transaction for a domain name.</p>
|
| 5768 | </div>
|
| 5769 | </div>
|
| 5770 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 5771 | <ul class="tsd-parameters">
|
| 5772 | <li>
|
| 5773 | <h5>fullyQualifiedName: <span class="tsd-signature-type">string</span></h5>
|
| 5774 | <div class="tsd-comment tsd-typography">
|
| 5775 | <p>the name to pre-order</p>
|
| 5776 | </div>
|
| 5777 | </li>
|
| 5778 | <li>
|
| 5779 | <h5>destinationAddress: <span class="tsd-signature-type">string</span></h5>
|
| 5780 | <div class="tsd-comment tsd-typography">
|
| 5781 | <p>the address to receive the name (this
|
| 5782 | must be passed as the 'registrationAddress' in the register transaction)</p>
|
| 5783 | </div>
|
| 5784 | </li>
|
| 5785 | <li>
|
| 5786 | <h5>paymentKeyIn: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="interfaces/transactionsigner.html" class="tsd-signature-type">TransactionSigner</a></h5>
|
| 5787 | <div class="tsd-comment tsd-typography">
|
| 5788 | <p>a hex string of
|
| 5789 | the private key used to fund the transaction or a transaction signer object</p>
|
| 5790 | </div>
|
| 5791 | </li>
|
| 5792 | <li>
|
| 5793 | <h5><span class="tsd-flag ts-flagDefault value">Default value</span> buildIncomplete: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></h5>
|
| 5794 | <div class="tsd-comment tsd-typography">
|
| 5795 | <p>optional boolean, defaults to false,
|
| 5796 | indicating whether the function should attempt to return an unsigned (or not fully signed)
|
| 5797 | transaction. Useful for passing around a TX for multi-sig input signing.</p>
|
| 5798 | </div>
|
| 5799 | </li>
|
| 5800 | </ul>
|
| 5801 | <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>
|
| 5802 | <ul>
|
| 5803 | <li>a promise which resolves to the hex-encoded transaction.
|
| 5804 | this function <em>does not</em> perform the requisite safety checks -- please see
|
| 5805 | the safety module for those.</li>
|
| 5806 | </ul>
|
| 5807 | </li>
|
| 5808 | </ul>
|
| 5809 | </section>
|
| 5810 | <section class="tsd-panel tsd-member tsd-kind-function">
|
| 5811 | <a name="makepreorderskeleton" class="tsd-anchor"></a>
|
| 5812 | <h3>make<wbr>Preorder<wbr>Skeleton</h3>
|
| 5813 | <ul class="tsd-signatures tsd-kind-function">
|
| 5814 | <li class="tsd-signature tsd-kind-icon">make<wbr>Preorder<wbr>Skeleton<span class="tsd-signature-symbol">(</span>fullyQualifiedName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, consensusHash<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, preorderAddress<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, burnAddress<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, burn<span class="tsd-signature-symbol">: </span><a href="globals.html#amounttype" class="tsd-signature-type">AmountType</a>, registerAddress<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">Transaction</span></li>
|
| 5815 | </ul>
|
| 5816 | <ul class="tsd-descriptions">
|
| 5817 | <li class="tsd-description">
|
| 5818 | <aside class="tsd-sources">
|
| 5819 | <ul>
|
| 5820 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/operations/skeletons.ts#L162">operations/skeletons.ts:162</a></li>
|
| 5821 | </ul>
|
| 5822 | </aside>
|
| 5823 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 5824 | <ul class="tsd-parameters">
|
| 5825 | <li>
|
| 5826 | <h5>fullyQualifiedName: <span class="tsd-signature-type">string</span></h5>
|
| 5827 | </li>
|
| 5828 | <li>
|
| 5829 | <h5>consensusHash: <span class="tsd-signature-type">string</span></h5>
|
| 5830 | </li>
|
| 5831 | <li>
|
| 5832 | <h5>preorderAddress: <span class="tsd-signature-type">string</span></h5>
|
| 5833 | </li>
|
| 5834 | <li>
|
| 5835 | <h5>burnAddress: <span class="tsd-signature-type">string</span></h5>
|
| 5836 | </li>
|
| 5837 | <li>
|
| 5838 | <h5>burn: <a href="globals.html#amounttype" class="tsd-signature-type">AmountType</a></h5>
|
| 5839 | </li>
|
| 5840 | <li>
|
| 5841 | <h5><span class="tsd-flag ts-flagDefault value">Default value</span> registerAddress: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = null</span></h5>
|
| 5842 | </li>
|
| 5843 | </ul>
|
| 5844 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Transaction</span></h4>
|
| 5845 | </li>
|
| 5846 | </ul>
|
| 5847 | </section>
|
| 5848 | <section class="tsd-panel tsd-member tsd-kind-function">
|
| 5849 | <a name="makeprofilezonefile" class="tsd-anchor"></a>
|
| 5850 | <h3>make<wbr>Profile<wbr>Zone<wbr>File</h3>
|
| 5851 | <ul class="tsd-signatures tsd-kind-function">
|
| 5852 | <li class="tsd-signature tsd-kind-icon">make<wbr>Profile<wbr>Zone<wbr>File<span class="tsd-signature-symbol">(</span>origin<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, tokenFileUrl<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">any</span></li>
|
| 5853 | </ul>
|
| 5854 | <ul class="tsd-descriptions">
|
| 5855 | <li class="tsd-description">
|
| 5856 | <aside class="tsd-sources">
|
| 5857 | <ul>
|
| 5858 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileZoneFiles.ts#L7">profiles/profileZoneFiles.ts:7</a></li>
|
| 5859 | </ul>
|
| 5860 | </aside>
|
| 5861 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 5862 | <ul class="tsd-parameters">
|
| 5863 | <li>
|
| 5864 | <h5>origin: <span class="tsd-signature-type">string</span></h5>
|
| 5865 | </li>
|
| 5866 | <li>
|
| 5867 | <h5>tokenFileUrl: <span class="tsd-signature-type">string</span></h5>
|
| 5868 | </li>
|
| 5869 | </ul>
|
| 5870 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
|
| 5871 | </li>
|
| 5872 | </ul>
|
| 5873 | </section>
|
| 5874 | <section class="tsd-panel tsd-member tsd-kind-function tsd-is-private tsd-is-not-exported">
|
| 5875 | <a name="makeregister" class="tsd-anchor"></a>
|
| 5876 | <h3><span class="tsd-flag ts-flagPrivate">Private</span> make<wbr>Register</h3>
|
| 5877 | <ul class="tsd-signatures tsd-kind-function tsd-is-private tsd-is-not-exported">
|
| 5878 | <li class="tsd-signature tsd-kind-icon">make<wbr>Register<span class="tsd-signature-symbol">(</span>fullyQualifiedName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, registerAddress<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, paymentKeyIn<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="interfaces/transactionsigner.html" class="tsd-signature-type">TransactionSigner</a>, zonefile<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, valueHash<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, buildIncomplete<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-type">string</span><span class="tsd-signature-symbol">></span></li>
|
| 5879 | </ul>
|
| 5880 | <ul class="tsd-descriptions">
|
| 5881 | <li class="tsd-description">
|
| 5882 | <aside class="tsd-sources">
|
| 5883 | <ul>
|
| 5884 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/operations/txbuild.ts#L613">operations/txbuild.ts:613</a></li>
|
| 5885 | </ul>
|
| 5886 | </aside>
|
| 5887 | <div class="tsd-comment tsd-typography">
|
| 5888 | <div class="lead">
|
| 5889 | <p>Generates a register transaction for a domain name.</p>
|
| 5890 | </div>
|
| 5891 | </div>
|
| 5892 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 5893 | <ul class="tsd-parameters">
|
| 5894 | <li>
|
| 5895 | <h5>fullyQualifiedName: <span class="tsd-signature-type">string</span></h5>
|
| 5896 | <div class="tsd-comment tsd-typography">
|
| 5897 | <p>the name to register</p>
|
| 5898 | </div>
|
| 5899 | </li>
|
| 5900 | <li>
|
| 5901 | <h5>registerAddress: <span class="tsd-signature-type">string</span></h5>
|
| 5902 | <div class="tsd-comment tsd-typography">
|
| 5903 | <p>the address to receive the name (this
|
| 5904 | must have been passed as the 'destinationAddress' in the preorder transaction)
|
| 5905 | this address will receive a dust UTXO</p>
|
| 5906 | </div>
|
| 5907 | </li>
|
| 5908 | <li>
|
| 5909 | <h5>paymentKeyIn: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="interfaces/transactionsigner.html" class="tsd-signature-type">TransactionSigner</a></h5>
|
| 5910 | <div class="tsd-comment tsd-typography">
|
| 5911 | <p>a hex string of
|
| 5912 | the private key (or a TransactionSigner object) used to fund the
|
| 5913 | transaction (this <em>must</em> be the same as the payment address used
|
| 5914 | to fund the preorder)</p>
|
| 5915 | </div>
|
| 5916 | </li>
|
| 5917 | <li>
|
| 5918 | <h5><span class="tsd-flag ts-flagDefault value">Default value</span> zonefile: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = null</span></h5>
|
| 5919 | <div class="tsd-comment tsd-typography">
|
| 5920 | <p>the zonefile data to include (this will be hashed
|
| 5921 | to include in the transaction), the zonefile itself must be published
|
| 5922 | after the UPDATE propagates.</p>
|
| 5923 | </div>
|
| 5924 | </li>
|
| 5925 | <li>
|
| 5926 | <h5><span class="tsd-flag ts-flagDefault value">Default value</span> valueHash: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = null</span></h5>
|
| 5927 | <div class="tsd-comment tsd-typography">
|
| 5928 | <p>the hash of the zone file data to include.
|
| 5929 | It will be used instead of zonefile, if given</p>
|
| 5930 | </div>
|
| 5931 | </li>
|
| 5932 | <li>
|
| 5933 | <h5><span class="tsd-flag ts-flagDefault value">Default value</span> buildIncomplete: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></h5>
|
| 5934 | <div class="tsd-comment tsd-typography">
|
| 5935 | <p>optional boolean, defaults to false,
|
| 5936 | indicating whether the function should attempt to return an unsigned (or not fully signed)
|
| 5937 | transaction. Useful for passing around a TX for multi-sig input signing.</p>
|
| 5938 | </div>
|
| 5939 | </li>
|
| 5940 | </ul>
|
| 5941 | <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>
|
| 5942 | <ul>
|
| 5943 | <li>a promise which resolves to the hex-encoded transaction.
|
| 5944 | this function <em>does not</em> perform the requisite safety checks -- please see
|
| 5945 | the safety module for those.</li>
|
| 5946 | </ul>
|
| 5947 | </li>
|
| 5948 | </ul>
|
| 5949 | </section>
|
| 5950 | <section class="tsd-panel tsd-member tsd-kind-function">
|
| 5951 | <a name="makeregisterskeleton" class="tsd-anchor"></a>
|
| 5952 | <h3>make<wbr>Register<wbr>Skeleton</h3>
|
| 5953 | <ul class="tsd-signatures tsd-kind-function">
|
| 5954 | <li class="tsd-signature tsd-kind-icon">make<wbr>Register<wbr>Skeleton<span class="tsd-signature-symbol">(</span>fullyQualifiedName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, ownerAddress<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, valueHash<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, burnTokenAmountHex<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">Transaction</span></li>
|
| 5955 | </ul>
|
| 5956 | <ul class="tsd-descriptions">
|
| 5957 | <li class="tsd-description">
|
| 5958 | <aside class="tsd-sources">
|
| 5959 | <ul>
|
| 5960 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/operations/skeletons.ts#L232">operations/skeletons.ts:232</a></li>
|
| 5961 | </ul>
|
| 5962 | </aside>
|
| 5963 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 5964 | <ul class="tsd-parameters">
|
| 5965 | <li>
|
| 5966 | <h5>fullyQualifiedName: <span class="tsd-signature-type">string</span></h5>
|
| 5967 | </li>
|
| 5968 | <li>
|
| 5969 | <h5>ownerAddress: <span class="tsd-signature-type">string</span></h5>
|
| 5970 | </li>
|
| 5971 | <li>
|
| 5972 | <h5><span class="tsd-flag ts-flagDefault value">Default value</span> valueHash: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = null</span></h5>
|
| 5973 | </li>
|
| 5974 | <li>
|
| 5975 | <h5><span class="tsd-flag ts-flagDefault value">Default value</span> burnTokenAmountHex: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = null</span></h5>
|
| 5976 | </li>
|
| 5977 | </ul>
|
| 5978 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Transaction</span></h4>
|
| 5979 | </li>
|
| 5980 | </ul>
|
| 5981 | </section>
|
| 5982 | <section class="tsd-panel tsd-member tsd-kind-function tsd-is-private tsd-is-not-exported">
|
| 5983 | <a name="makerenewal" class="tsd-anchor"></a>
|
| 5984 | <h3><span class="tsd-flag ts-flagPrivate">Private</span> make<wbr>Renewal</h3>
|
| 5985 | <ul class="tsd-signatures tsd-kind-function tsd-is-private tsd-is-not-exported">
|
| 5986 | <li class="tsd-signature tsd-kind-icon">make<wbr>Renewal<span class="tsd-signature-symbol">(</span>fullyQualifiedName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, destinationAddress<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, ownerKeyIn<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="interfaces/transactionsigner.html" class="tsd-signature-type">TransactionSigner</a>, paymentKeyIn<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="interfaces/transactionsigner.html" class="tsd-signature-type">TransactionSigner</a>, zonefile<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, valueHash<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, buildIncomplete<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-type">string</span><span class="tsd-signature-symbol">></span></li>
|
| 5987 | </ul>
|
| 5988 | <ul class="tsd-descriptions">
|
| 5989 | <li class="tsd-description">
|
| 5990 | <aside class="tsd-sources">
|
| 5991 | <ul>
|
| 5992 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/operations/txbuild.ts#L775">operations/txbuild.ts:775</a></li>
|
| 5993 | </ul>
|
| 5994 | </aside>
|
| 5995 | <div class="tsd-comment tsd-typography">
|
| 5996 | <div class="lead">
|
| 5997 | <p>Generates a renewal transaction for a domain name.</p>
|
| 5998 | </div>
|
| 5999 | </div>
|
| 6000 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 6001 | <ul class="tsd-parameters">
|
| 6002 | <li>
|
| 6003 | <h5>fullyQualifiedName: <span class="tsd-signature-type">string</span></h5>
|
| 6004 | <div class="tsd-comment tsd-typography">
|
| 6005 | <p>the name to transfer</p>
|
| 6006 | </div>
|
| 6007 | </li>
|
| 6008 | <li>
|
| 6009 | <h5>destinationAddress: <span class="tsd-signature-type">string</span></h5>
|
| 6010 | <div class="tsd-comment tsd-typography">
|
| 6011 | <p>the address to receive the name after renewal
|
| 6012 | this address will receive a dust UTXO</p>
|
| 6013 | </div>
|
| 6014 | </li>
|
| 6015 | <li>
|
| 6016 | <h5>ownerKeyIn: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="interfaces/transactionsigner.html" class="tsd-signature-type">TransactionSigner</a></h5>
|
| 6017 | <div class="tsd-comment tsd-typography">
|
| 6018 | <p>a hex string of
|
| 6019 | the current owner's private key (or a TransactionSigner object)</p>
|
| 6020 | </div>
|
| 6021 | </li>
|
| 6022 | <li>
|
| 6023 | <h5>paymentKeyIn: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="interfaces/transactionsigner.html" class="tsd-signature-type">TransactionSigner</a></h5>
|
| 6024 | <div class="tsd-comment tsd-typography">
|
| 6025 | <p>a hex string of
|
| 6026 | the private key used to fund the renewal (or a TransactionSigner
|
| 6027 | object)</p>
|
| 6028 | </div>
|
| 6029 | </li>
|
| 6030 | <li>
|
| 6031 | <h5><span class="tsd-flag ts-flagDefault value">Default value</span> zonefile: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = null</span></h5>
|
| 6032 | <div class="tsd-comment tsd-typography">
|
| 6033 | <p>the zonefile data to include, if given (this will be hashed
|
| 6034 | to include in the transaction), the zonefile itself must be published
|
| 6035 | after the RENEWAL propagates.</p>
|
| 6036 | </div>
|
| 6037 | </li>
|
| 6038 | <li>
|
| 6039 | <h5><span class="tsd-flag ts-flagDefault value">Default value</span> valueHash: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = null</span></h5>
|
| 6040 | <div class="tsd-comment tsd-typography">
|
| 6041 | <p>the raw zone file hash to include (this will be used
|
| 6042 | instead of zonefile, if given).</p>
|
| 6043 | </div>
|
| 6044 | </li>
|
| 6045 | <li>
|
| 6046 | <h5><span class="tsd-flag ts-flagDefault value">Default value</span> buildIncomplete: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></h5>
|
| 6047 | <div class="tsd-comment tsd-typography">
|
| 6048 | <p>optional boolean, defaults to false,
|
| 6049 | indicating whether the function should attempt to return an unsigned (or not fully signed)
|
| 6050 | transaction. Useful for passing around a TX for multi-sig input signing.</p>
|
| 6051 | </div>
|
| 6052 | </li>
|
| 6053 | </ul>
|
| 6054 | <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>
|
| 6055 | <ul>
|
| 6056 | <li>a promise which resolves to the hex-encoded transaction.
|
| 6057 | this function <em>does not</em> perform the requisite safety checks -- please see
|
| 6058 | the safety module for those.</li>
|
| 6059 | </ul>
|
| 6060 | </li>
|
| 6061 | </ul>
|
| 6062 | </section>
|
| 6063 | <section class="tsd-panel tsd-member tsd-kind-function">
|
| 6064 | <a name="makerenewalskeleton" class="tsd-anchor"></a>
|
| 6065 | <h3>make<wbr>Renewal<wbr>Skeleton</h3>
|
| 6066 | <ul class="tsd-signatures tsd-kind-function">
|
| 6067 | <li class="tsd-signature tsd-kind-icon">make<wbr>Renewal<wbr>Skeleton<span class="tsd-signature-symbol">(</span>fullyQualifiedName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, nextOwnerAddress<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, lastOwnerAddress<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, burnAddress<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, burn<span class="tsd-signature-symbol">: </span><a href="globals.html#amounttype" class="tsd-signature-type">AmountType</a>, valueHash<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">Transaction</span></li>
|
| 6068 | </ul>
|
| 6069 | <ul class="tsd-descriptions">
|
| 6070 | <li class="tsd-description">
|
| 6071 | <aside class="tsd-sources">
|
| 6072 | <ul>
|
| 6073 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/operations/skeletons.ts#L304">operations/skeletons.ts:304</a></li>
|
| 6074 | </ul>
|
| 6075 | </aside>
|
| 6076 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 6077 | <ul class="tsd-parameters">
|
| 6078 | <li>
|
| 6079 | <h5>fullyQualifiedName: <span class="tsd-signature-type">string</span></h5>
|
| 6080 | </li>
|
| 6081 | <li>
|
| 6082 | <h5>nextOwnerAddress: <span class="tsd-signature-type">string</span></h5>
|
| 6083 | </li>
|
| 6084 | <li>
|
| 6085 | <h5>lastOwnerAddress: <span class="tsd-signature-type">string</span></h5>
|
| 6086 | </li>
|
| 6087 | <li>
|
| 6088 | <h5>burnAddress: <span class="tsd-signature-type">string</span></h5>
|
| 6089 | </li>
|
| 6090 | <li>
|
| 6091 | <h5>burn: <a href="globals.html#amounttype" class="tsd-signature-type">AmountType</a></h5>
|
| 6092 | </li>
|
| 6093 | <li>
|
| 6094 | <h5><span class="tsd-flag ts-flagDefault value">Default value</span> valueHash: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = null</span></h5>
|
| 6095 | </li>
|
| 6096 | </ul>
|
| 6097 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Transaction</span></h4>
|
| 6098 | </li>
|
| 6099 | </ul>
|
| 6100 | </section>
|
| 6101 | <section class="tsd-panel tsd-member tsd-kind-function tsd-is-private tsd-is-not-exported">
|
| 6102 | <a name="makerevoke" class="tsd-anchor"></a>
|
| 6103 | <h3><span class="tsd-flag ts-flagPrivate">Private</span> make<wbr>Revoke</h3>
|
| 6104 | <ul class="tsd-signatures tsd-kind-function tsd-is-private tsd-is-not-exported">
|
| 6105 | <li class="tsd-signature tsd-kind-icon">make<wbr>Revoke<span class="tsd-signature-symbol">(</span>fullyQualifiedName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, ownerKeyIn<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="interfaces/transactionsigner.html" class="tsd-signature-type">TransactionSigner</a>, paymentKeyIn<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="interfaces/transactionsigner.html" class="tsd-signature-type">TransactionSigner</a>, buildIncomplete<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-type">string</span><span class="tsd-signature-symbol">></span></li>
|
| 6106 | </ul>
|
| 6107 | <ul class="tsd-descriptions">
|
| 6108 | <li class="tsd-description">
|
| 6109 | <aside class="tsd-sources">
|
| 6110 | <ul>
|
| 6111 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/operations/txbuild.ts#L723">operations/txbuild.ts:723</a></li>
|
| 6112 | </ul>
|
| 6113 | </aside>
|
| 6114 | <div class="tsd-comment tsd-typography">
|
| 6115 | <div class="lead">
|
| 6116 | <p>Generates a revoke transaction for a domain name.</p>
|
| 6117 | </div>
|
| 6118 | </div>
|
| 6119 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 6120 | <ul class="tsd-parameters">
|
| 6121 | <li>
|
| 6122 | <h5>fullyQualifiedName: <span class="tsd-signature-type">string</span></h5>
|
| 6123 | <div class="tsd-comment tsd-typography">
|
| 6124 | <p>the name to revoke</p>
|
| 6125 | </div>
|
| 6126 | </li>
|
| 6127 | <li>
|
| 6128 | <h5>ownerKeyIn: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="interfaces/transactionsigner.html" class="tsd-signature-type">TransactionSigner</a></h5>
|
| 6129 | <div class="tsd-comment tsd-typography">
|
| 6130 | <p>a hex string of
|
| 6131 | the current owner's private key (or a TransactionSigner object)</p>
|
| 6132 | </div>
|
| 6133 | </li>
|
| 6134 | <li>
|
| 6135 | <h5>paymentKeyIn: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="interfaces/transactionsigner.html" class="tsd-signature-type">TransactionSigner</a></h5>
|
| 6136 | <div class="tsd-comment tsd-typography">
|
| 6137 | <p>a hex string of
|
| 6138 | the private key used to fund the transaction (or a
|
| 6139 | TransactionSigner object)</p>
|
| 6140 | </div>
|
| 6141 | </li>
|
| 6142 | <li>
|
| 6143 | <h5><span class="tsd-flag ts-flagDefault value">Default value</span> buildIncomplete: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></h5>
|
| 6144 | <div class="tsd-comment tsd-typography">
|
| 6145 | <p>optional boolean, defaults to false,
|
| 6146 | indicating whether the function should attempt to return an unsigned (or not fully signed)
|
| 6147 | transaction. Useful for passing around a TX for multi-sig input signing.</p>
|
| 6148 | </div>
|
| 6149 | </li>
|
| 6150 | </ul>
|
| 6151 | <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>
|
| 6152 | <ul>
|
| 6153 | <li>a promise which resolves to the hex-encoded transaction.
|
| 6154 | this function <em>does not</em> perform the requisite safety checks -- please see
|
| 6155 | the safety module for those.</li>
|
| 6156 | </ul>
|
| 6157 | </li>
|
| 6158 | </ul>
|
| 6159 | </section>
|
| 6160 | <section class="tsd-panel tsd-member tsd-kind-function">
|
| 6161 | <a name="makerevokeskeleton" class="tsd-anchor"></a>
|
| 6162 | <h3>make<wbr>Revoke<wbr>Skeleton</h3>
|
| 6163 | <ul class="tsd-signatures tsd-kind-function">
|
| 6164 | <li class="tsd-signature tsd-kind-icon">make<wbr>Revoke<wbr>Skeleton<span class="tsd-signature-symbol">(</span>fullyQualifiedName<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">Transaction</span></li>
|
| 6165 | </ul>
|
| 6166 | <ul class="tsd-descriptions">
|
| 6167 | <li class="tsd-description">
|
| 6168 | <aside class="tsd-sources">
|
| 6169 | <ul>
|
| 6170 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/operations/skeletons.ts#L455">operations/skeletons.ts:455</a></li>
|
| 6171 | </ul>
|
| 6172 | </aside>
|
| 6173 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 6174 | <ul class="tsd-parameters">
|
| 6175 | <li>
|
| 6176 | <h5>fullyQualifiedName: <span class="tsd-signature-type">string</span></h5>
|
| 6177 | </li>
|
| 6178 | </ul>
|
| 6179 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Transaction</span></h4>
|
| 6180 | </li>
|
| 6181 | </ul>
|
| 6182 | </section>
|
| 6183 | <section class="tsd-panel tsd-member tsd-kind-function tsd-is-not-exported">
|
| 6184 | <a name="maketxbuilder" class="tsd-anchor"></a>
|
| 6185 | <h3>makeTXbuilder</h3>
|
| 6186 | <ul class="tsd-signatures tsd-kind-function tsd-is-not-exported">
|
| 6187 | <li class="tsd-signature tsd-kind-icon">makeTXbuilder<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">TransactionBuilder</span></li>
|
| 6188 | </ul>
|
| 6189 | <ul class="tsd-descriptions">
|
| 6190 | <li class="tsd-description">
|
| 6191 | <aside class="tsd-sources">
|
| 6192 | <ul>
|
| 6193 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/operations/skeletons.ts#L147">operations/skeletons.ts:147</a></li>
|
| 6194 | </ul>
|
| 6195 | </aside>
|
| 6196 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">TransactionBuilder</span></h4>
|
| 6197 | </li>
|
| 6198 | </ul>
|
| 6199 | </section>
|
| 6200 | <section class="tsd-panel tsd-member tsd-kind-function tsd-is-private tsd-is-not-exported">
|
| 6201 | <a name="maketokentransfer" class="tsd-anchor"></a>
|
| 6202 | <h3><span class="tsd-flag ts-flagPrivate">Private</span> make<wbr>Token<wbr>Transfer</h3>
|
| 6203 | <ul class="tsd-signatures tsd-kind-function tsd-is-private tsd-is-not-exported">
|
| 6204 | <li class="tsd-signature tsd-kind-icon">make<wbr>Token<wbr>Transfer<span class="tsd-signature-symbol">(</span>recipientAddress<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, tokenType<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, tokenAmount<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BN</span>, scratchArea<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, senderKeyIn<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="interfaces/transactionsigner.html" class="tsd-signature-type">TransactionSigner</a>, btcFunderKeyIn<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="interfaces/transactionsigner.html" class="tsd-signature-type">TransactionSigner</a>, buildIncomplete<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-type">string</span><span class="tsd-signature-symbol">></span></li>
|
| 6205 | </ul>
|
| 6206 | <ul class="tsd-descriptions">
|
| 6207 | <li class="tsd-description">
|
| 6208 | <aside class="tsd-sources">
|
| 6209 | <ul>
|
| 6210 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/operations/txbuild.ts#L1055">operations/txbuild.ts:1055</a></li>
|
| 6211 | </ul>
|
| 6212 | </aside>
|
| 6213 | <div class="tsd-comment tsd-typography">
|
| 6214 | <div class="lead">
|
| 6215 | <p>Generates a token-transfer transaction</p>
|
| 6216 | </div>
|
| 6217 | </div>
|
| 6218 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 6219 | <ul class="tsd-parameters">
|
| 6220 | <li>
|
| 6221 | <h5>recipientAddress: <span class="tsd-signature-type">string</span></h5>
|
| 6222 | <div class="tsd-comment tsd-typography">
|
| 6223 | <p>the address to receive the tokens</p>
|
| 6224 | </div>
|
| 6225 | </li>
|
| 6226 | <li>
|
| 6227 | <h5>tokenType: <span class="tsd-signature-type">string</span></h5>
|
| 6228 | <div class="tsd-comment tsd-typography">
|
| 6229 | <p>the type of tokens to send</p>
|
| 6230 | </div>
|
| 6231 | </li>
|
| 6232 | <li>
|
| 6233 | <h5>tokenAmount: <span class="tsd-signature-type">BN</span></h5>
|
| 6234 | <div class="tsd-comment tsd-typography">
|
| 6235 | <p>the BigInteger encoding of an unsigned 64-bit number of
|
| 6236 | tokens to send</p>
|
| 6237 | </div>
|
| 6238 | </li>
|
| 6239 | <li>
|
| 6240 | <h5>scratchArea: <span class="tsd-signature-type">string</span></h5>
|
| 6241 | <div class="tsd-comment tsd-typography">
|
| 6242 | <p>an arbitrary string to include with the transaction</p>
|
| 6243 | </div>
|
| 6244 | </li>
|
| 6245 | <li>
|
| 6246 | <h5>senderKeyIn: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="interfaces/transactionsigner.html" class="tsd-signature-type">TransactionSigner</a></h5>
|
| 6247 | <div class="tsd-comment tsd-typography">
|
| 6248 | <p>the hex-encoded private key to send
|
| 6249 | the tokens</p>
|
| 6250 | </div>
|
| 6251 | </li>
|
| 6252 | <li>
|
| 6253 | <h5><span class="tsd-flag ts-flagOptional">Optional</span> btcFunderKeyIn: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="interfaces/transactionsigner.html" class="tsd-signature-type">TransactionSigner</a></h5>
|
| 6254 | <div class="tsd-comment tsd-typography">
|
| 6255 | <p>the hex-encoded private key to fund
|
| 6256 | the bitcoin fees for the transaction. Optional -- if not passed, will attempt to
|
| 6257 | fund with sender key.</p>
|
| 6258 | </div>
|
| 6259 | </li>
|
| 6260 | <li>
|
| 6261 | <h5><span class="tsd-flag ts-flagDefault value">Default value</span> buildIncomplete: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></h5>
|
| 6262 | <div class="tsd-comment tsd-typography">
|
| 6263 | <p>optional boolean, defaults to false,
|
| 6264 | indicating whether the function should attempt to return an unsigned (or not fully signed)
|
| 6265 | transaction. Useful for passing around a TX for multi-sig input signing.</p>
|
| 6266 | </div>
|
| 6267 | </li>
|
| 6268 | </ul>
|
| 6269 | <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>
|
| 6270 | <ul>
|
| 6271 | <li>a promise which resolves to the hex-encoded transaction.
|
| 6272 | This function does not perform the requisite safety checks -- please see the
|
| 6273 | safety module for those.</li>
|
| 6274 | </ul>
|
| 6275 | </li>
|
| 6276 | </ul>
|
| 6277 | </section>
|
| 6278 | <section class="tsd-panel tsd-member tsd-kind-function">
|
| 6279 | <a name="maketokentransferskeleton" class="tsd-anchor"></a>
|
| 6280 | <h3>make<wbr>Token<wbr>Transfer<wbr>Skeleton</h3>
|
| 6281 | <ul class="tsd-signatures tsd-kind-function">
|
| 6282 | <li class="tsd-signature tsd-kind-icon">make<wbr>Token<wbr>Transfer<wbr>Skeleton<span class="tsd-signature-symbol">(</span>recipientAddress<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, consensusHash<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, tokenType<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, tokenAmount<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BN</span>, scratchArea<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">Transaction</span></li>
|
| 6283 | </ul>
|
| 6284 | <ul class="tsd-descriptions">
|
| 6285 | <li class="tsd-description">
|
| 6286 | <aside class="tsd-sources">
|
| 6287 | <ul>
|
| 6288 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/operations/skeletons.ts#L676">operations/skeletons.ts:676</a></li>
|
| 6289 | </ul>
|
| 6290 | </aside>
|
| 6291 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 6292 | <ul class="tsd-parameters">
|
| 6293 | <li>
|
| 6294 | <h5>recipientAddress: <span class="tsd-signature-type">string</span></h5>
|
| 6295 | </li>
|
| 6296 | <li>
|
| 6297 | <h5>consensusHash: <span class="tsd-signature-type">string</span></h5>
|
| 6298 | </li>
|
| 6299 | <li>
|
| 6300 | <h5>tokenType: <span class="tsd-signature-type">string</span></h5>
|
| 6301 | </li>
|
| 6302 | <li>
|
| 6303 | <h5>tokenAmount: <span class="tsd-signature-type">BN</span></h5>
|
| 6304 | </li>
|
| 6305 | <li>
|
| 6306 | <h5>scratchArea: <span class="tsd-signature-type">string</span></h5>
|
| 6307 | </li>
|
| 6308 | </ul>
|
| 6309 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Transaction</span></h4>
|
| 6310 | </li>
|
| 6311 | </ul>
|
| 6312 | </section>
|
| 6313 | <section class="tsd-panel tsd-member tsd-kind-function tsd-is-private tsd-is-not-exported">
|
| 6314 | <a name="maketransfer" class="tsd-anchor"></a>
|
| 6315 | <h3><span class="tsd-flag ts-flagPrivate">Private</span> make<wbr>Transfer</h3>
|
| 6316 | <ul class="tsd-signatures tsd-kind-function tsd-is-private tsd-is-not-exported">
|
| 6317 | <li class="tsd-signature tsd-kind-icon">make<wbr>Transfer<span class="tsd-signature-symbol">(</span>fullyQualifiedName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, destinationAddress<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, ownerKeyIn<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="interfaces/transactionsigner.html" class="tsd-signature-type">TransactionSigner</a>, paymentKeyIn<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="interfaces/transactionsigner.html" class="tsd-signature-type">TransactionSigner</a>, keepZonefile<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span>, buildIncomplete<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-type">string</span><span class="tsd-signature-symbol">></span></li>
|
| 6318 | </ul>
|
| 6319 | <ul class="tsd-descriptions">
|
| 6320 | <li class="tsd-description">
|
| 6321 | <aside class="tsd-sources">
|
| 6322 | <ul>
|
| 6323 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/operations/txbuild.ts#L669">operations/txbuild.ts:669</a></li>
|
| 6324 | </ul>
|
| 6325 | </aside>
|
| 6326 | <div class="tsd-comment tsd-typography">
|
| 6327 | <div class="lead">
|
| 6328 | <p>Generates a transfer transaction for a domain name.</p>
|
| 6329 | </div>
|
| 6330 | </div>
|
| 6331 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 6332 | <ul class="tsd-parameters">
|
| 6333 | <li>
|
| 6334 | <h5>fullyQualifiedName: <span class="tsd-signature-type">string</span></h5>
|
| 6335 | <div class="tsd-comment tsd-typography">
|
| 6336 | <p>the name to transfer</p>
|
| 6337 | </div>
|
| 6338 | </li>
|
| 6339 | <li>
|
| 6340 | <h5>destinationAddress: <span class="tsd-signature-type">string</span></h5>
|
| 6341 | <div class="tsd-comment tsd-typography">
|
| 6342 | <p>the address to receive the name.
|
| 6343 | this address will receive a dust UTXO</p>
|
| 6344 | </div>
|
| 6345 | </li>
|
| 6346 | <li>
|
| 6347 | <h5>ownerKeyIn: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="interfaces/transactionsigner.html" class="tsd-signature-type">TransactionSigner</a></h5>
|
| 6348 | <div class="tsd-comment tsd-typography">
|
| 6349 | <p>a hex string of
|
| 6350 | the current owner's private key (or a TransactionSigner object)</p>
|
| 6351 | </div>
|
| 6352 | </li>
|
| 6353 | <li>
|
| 6354 | <h5>paymentKeyIn: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="interfaces/transactionsigner.html" class="tsd-signature-type">TransactionSigner</a></h5>
|
| 6355 | <div class="tsd-comment tsd-typography">
|
| 6356 | <p>a hex string of
|
| 6357 | the private key used to fund the transaction (or a
|
| 6358 | TransactionSigner object)</p>
|
| 6359 | </div>
|
| 6360 | </li>
|
| 6361 | <li>
|
| 6362 | <h5><span class="tsd-flag ts-flagDefault value">Default value</span> keepZonefile: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></h5>
|
| 6363 | <div class="tsd-comment tsd-typography">
|
| 6364 | <p>if true, then preserve the name's zone file</p>
|
| 6365 | </div>
|
| 6366 | </li>
|
| 6367 | <li>
|
| 6368 | <h5><span class="tsd-flag ts-flagDefault value">Default value</span> buildIncomplete: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></h5>
|
| 6369 | <div class="tsd-comment tsd-typography">
|
| 6370 | <p>optional boolean, defaults to false,
|
| 6371 | indicating whether the function should attempt to return an unsigned (or not fully signed)
|
| 6372 | transaction. Useful for passing around a TX for multi-sig input signing.</p>
|
| 6373 | </div>
|
| 6374 | </li>
|
| 6375 | </ul>
|
| 6376 | <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>
|
| 6377 | <ul>
|
| 6378 | <li>a promise which resolves to the hex-encoded transaction.
|
| 6379 | this function <em>does not</em> perform the requisite safety checks -- please see
|
| 6380 | the safety module for those.</li>
|
| 6381 | </ul>
|
| 6382 | </li>
|
| 6383 | </ul>
|
| 6384 | </section>
|
| 6385 | <section class="tsd-panel tsd-member tsd-kind-function">
|
| 6386 | <a name="maketransferskeleton" class="tsd-anchor"></a>
|
| 6387 | <h3>make<wbr>Transfer<wbr>Skeleton</h3>
|
| 6388 | <ul class="tsd-signatures tsd-kind-function">
|
| 6389 | <li class="tsd-signature tsd-kind-icon">make<wbr>Transfer<wbr>Skeleton<span class="tsd-signature-symbol">(</span>fullyQualifiedName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, consensusHash<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, newOwner<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, keepZonefile<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">Transaction</span></li>
|
| 6390 | </ul>
|
| 6391 | <ul class="tsd-descriptions">
|
| 6392 | <li class="tsd-description">
|
| 6393 | <aside class="tsd-sources">
|
| 6394 | <ul>
|
| 6395 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/operations/skeletons.ts#L365">operations/skeletons.ts:365</a></li>
|
| 6396 | </ul>
|
| 6397 | </aside>
|
| 6398 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 6399 | <ul class="tsd-parameters">
|
| 6400 | <li>
|
| 6401 | <h5>fullyQualifiedName: <span class="tsd-signature-type">string</span></h5>
|
| 6402 | </li>
|
| 6403 | <li>
|
| 6404 | <h5>consensusHash: <span class="tsd-signature-type">string</span></h5>
|
| 6405 | </li>
|
| 6406 | <li>
|
| 6407 | <h5>newOwner: <span class="tsd-signature-type">string</span></h5>
|
| 6408 | </li>
|
| 6409 | <li>
|
| 6410 | <h5><span class="tsd-flag ts-flagDefault value">Default value</span> keepZonefile: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></h5>
|
| 6411 | </li>
|
| 6412 | </ul>
|
| 6413 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Transaction</span></h4>
|
| 6414 | </li>
|
| 6415 | </ul>
|
| 6416 | </section>
|
| 6417 | <section class="tsd-panel tsd-member tsd-kind-function tsd-is-private">
|
| 6418 | <a name="makeuuid4" class="tsd-anchor"></a>
|
| 6419 | <h3><span class="tsd-flag ts-flagPrivate">Private</span> makeUUID4</h3>
|
| 6420 | <ul class="tsd-signatures tsd-kind-function tsd-is-private">
|
| 6421 | <li class="tsd-signature tsd-kind-icon">makeUUID4<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>
|
| 6422 | </ul>
|
| 6423 | <ul class="tsd-descriptions">
|
| 6424 | <li class="tsd-description">
|
| 6425 | <aside class="tsd-sources">
|
| 6426 | <ul>
|
| 6427 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/utils.ts#L121">utils.ts:121</a></li>
|
| 6428 | </ul>
|
| 6429 | </aside>
|
| 6430 | <div class="tsd-comment tsd-typography">
|
| 6431 | <div class="lead">
|
| 6432 | <p>UUIDs</p>
|
| 6433 | </div>
|
| 6434 | </div>
|
| 6435 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
|
| 6436 | </li>
|
| 6437 | </ul>
|
| 6438 | </section>
|
| 6439 | <section class="tsd-panel tsd-member tsd-kind-function tsd-is-private tsd-is-not-exported">
|
| 6440 | <a name="makeupdate" class="tsd-anchor"></a>
|
| 6441 | <h3><span class="tsd-flag ts-flagPrivate">Private</span> make<wbr>Update</h3>
|
| 6442 | <ul class="tsd-signatures tsd-kind-function tsd-is-private tsd-is-not-exported">
|
| 6443 | <li class="tsd-signature tsd-kind-icon">make<wbr>Update<span class="tsd-signature-symbol">(</span>fullyQualifiedName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, ownerKeyIn<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="interfaces/transactionsigner.html" class="tsd-signature-type">TransactionSigner</a>, paymentKeyIn<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="interfaces/transactionsigner.html" class="tsd-signature-type">TransactionSigner</a>, zonefile<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, valueHash<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, buildIncomplete<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-type">string</span><span class="tsd-signature-symbol">></span></li>
|
| 6444 | </ul>
|
| 6445 | <ul class="tsd-descriptions">
|
| 6446 | <li class="tsd-description">
|
| 6447 | <aside class="tsd-sources">
|
| 6448 | <ul>
|
| 6449 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/operations/txbuild.ts#L538">operations/txbuild.ts:538</a></li>
|
| 6450 | </ul>
|
| 6451 | </aside>
|
| 6452 | <div class="tsd-comment tsd-typography">
|
| 6453 | <div class="lead">
|
| 6454 | <p>Generates an update transaction for a domain name.</p>
|
| 6455 | </div>
|
| 6456 | </div>
|
| 6457 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 6458 | <ul class="tsd-parameters">
|
| 6459 | <li>
|
| 6460 | <h5>fullyQualifiedName: <span class="tsd-signature-type">string</span></h5>
|
| 6461 | <div class="tsd-comment tsd-typography">
|
| 6462 | <p>the name to update</p>
|
| 6463 | </div>
|
| 6464 | </li>
|
| 6465 | <li>
|
| 6466 | <h5>ownerKeyIn: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="interfaces/transactionsigner.html" class="tsd-signature-type">TransactionSigner</a></h5>
|
| 6467 | <div class="tsd-comment tsd-typography">
|
| 6468 | <p>a hex string of the
|
| 6469 | owner key, or a transaction signer object. This will provide one
|
| 6470 | UTXO input, and also recieve a dust output.</p>
|
| 6471 | </div>
|
| 6472 | </li>
|
| 6473 | <li>
|
| 6474 | <h5>paymentKeyIn: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="interfaces/transactionsigner.html" class="tsd-signature-type">TransactionSigner</a></h5>
|
| 6475 | <div class="tsd-comment tsd-typography">
|
| 6476 | <p>a hex string, or a
|
| 6477 | transaction signer object, of the private key used to fund the
|
| 6478 | transaction's txfees</p>
|
| 6479 | </div>
|
| 6480 | </li>
|
| 6481 | <li>
|
| 6482 | <h5>zonefile: <span class="tsd-signature-type">string</span></h5>
|
| 6483 | <div class="tsd-comment tsd-typography">
|
| 6484 | <p>the zonefile data to update (this will be hashed
|
| 6485 | to include in the transaction), the zonefile itself must be published
|
| 6486 | after the UPDATE propagates.</p>
|
| 6487 | </div>
|
| 6488 | </li>
|
| 6489 | <li>
|
| 6490 | <h5><span class="tsd-flag ts-flagDefault value">Default value</span> valueHash: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = ""</span></h5>
|
| 6491 | <div class="tsd-comment tsd-typography">
|
| 6492 | <p>if given, this is the hash to store (instead of
|
| 6493 | zonefile). zonefile will be ignored if this is given.</p>
|
| 6494 | </div>
|
| 6495 | </li>
|
| 6496 | <li>
|
| 6497 | <h5><span class="tsd-flag ts-flagDefault value">Default value</span> buildIncomplete: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></h5>
|
| 6498 | <div class="tsd-comment tsd-typography">
|
| 6499 | <p>optional boolean, defaults to false,
|
| 6500 | indicating whether the function should attempt to return an unsigned (or not fully signed)
|
| 6501 | transaction. Useful for passing around a TX for multi-sig input signing.</p>
|
| 6502 | </div>
|
| 6503 | </li>
|
| 6504 | </ul>
|
| 6505 | <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>
|
| 6506 | <ul>
|
| 6507 | <li>a promise which resolves to the hex-encoded transaction.
|
| 6508 | this function <em>does not</em> perform the requisite safety checks -- please see
|
| 6509 | the safety module for those.</li>
|
| 6510 | </ul>
|
| 6511 | </li>
|
| 6512 | </ul>
|
| 6513 | </section>
|
| 6514 | <section class="tsd-panel tsd-member tsd-kind-function">
|
| 6515 | <a name="makeupdateskeleton" class="tsd-anchor"></a>
|
| 6516 | <h3>make<wbr>Update<wbr>Skeleton</h3>
|
| 6517 | <ul class="tsd-signatures tsd-kind-function">
|
| 6518 | <li class="tsd-signature tsd-kind-icon">make<wbr>Update<wbr>Skeleton<span class="tsd-signature-symbol">(</span>fullyQualifiedName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, consensusHash<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, valueHash<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">Transaction</span></li>
|
| 6519 | </ul>
|
| 6520 | <ul class="tsd-descriptions">
|
| 6521 | <li class="tsd-description">
|
| 6522 | <aside class="tsd-sources">
|
| 6523 | <ul>
|
| 6524 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/operations/skeletons.ts#L411">operations/skeletons.ts:411</a></li>
|
| 6525 | </ul>
|
| 6526 | </aside>
|
| 6527 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 6528 | <ul class="tsd-parameters">
|
| 6529 | <li>
|
| 6530 | <h5>fullyQualifiedName: <span class="tsd-signature-type">string</span></h5>
|
| 6531 | </li>
|
| 6532 | <li>
|
| 6533 | <h5>consensusHash: <span class="tsd-signature-type">string</span></h5>
|
| 6534 | </li>
|
| 6535 | <li>
|
| 6536 | <h5>valueHash: <span class="tsd-signature-type">string</span></h5>
|
| 6537 | </li>
|
| 6538 | </ul>
|
| 6539 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Transaction</span></h4>
|
| 6540 | </li>
|
| 6541 | </ul>
|
| 6542 | </section>
|
| 6543 | <section class="tsd-panel tsd-member tsd-kind-function tsd-is-not-exported">
|
| 6544 | <a name="makev1gaiaauthtoken" class="tsd-anchor"></a>
|
| 6545 | <h3>make<wbr>V1Gaia<wbr>Auth<wbr>Token</h3>
|
| 6546 | <ul class="tsd-signatures tsd-kind-function tsd-is-not-exported">
|
| 6547 | <li class="tsd-signature tsd-kind-icon">make<wbr>V1Gaia<wbr>Auth<wbr>Token<span class="tsd-signature-symbol">(</span>hubInfo<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, signerKeyHex<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>, associationToken<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>
|
| 6548 | </ul>
|
| 6549 | <ul class="tsd-descriptions">
|
| 6550 | <li class="tsd-description">
|
| 6551 | <aside class="tsd-sources">
|
| 6552 | <ul>
|
| 6553 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/storage/hub.ts#L81">storage/hub.ts:81</a></li>
|
| 6554 | </ul>
|
| 6555 | </aside>
|
| 6556 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 6557 | <ul class="tsd-parameters">
|
| 6558 | <li>
|
| 6559 | <h5>hubInfo: <span class="tsd-signature-type">any</span></h5>
|
| 6560 | </li>
|
| 6561 | <li>
|
| 6562 | <h5>signerKeyHex: <span class="tsd-signature-type">string</span></h5>
|
| 6563 | </li>
|
| 6564 | <li>
|
| 6565 | <h5>hubUrl: <span class="tsd-signature-type">string</span></h5>
|
| 6566 | </li>
|
| 6567 | <li>
|
| 6568 | <h5><span class="tsd-flag ts-flagOptional">Optional</span> associationToken: <span class="tsd-signature-type">string</span></h5>
|
| 6569 | </li>
|
| 6570 | </ul>
|
| 6571 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
|
| 6572 | </li>
|
| 6573 | </ul>
|
| 6574 | </section>
|
| 6575 | <section class="tsd-panel tsd-member tsd-kind-function tsd-is-not-exported">
|
| 6576 | <a name="namespaceisready" class="tsd-anchor"></a>
|
| 6577 | <h3>namespace<wbr>IsReady</h3>
|
| 6578 | <ul class="tsd-signatures tsd-kind-function tsd-is-not-exported">
|
| 6579 | <li class="tsd-signature tsd-kind-icon">namespace<wbr>IsReady<span class="tsd-signature-symbol">(</span>namespaceID<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>
|
| 6580 | </ul>
|
| 6581 | <ul class="tsd-descriptions">
|
| 6582 | <li class="tsd-description">
|
| 6583 | <aside class="tsd-sources">
|
| 6584 | <ul>
|
| 6585 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/operations/safety.ts#L85">operations/safety.ts:85</a></li>
|
| 6586 | </ul>
|
| 6587 | </aside>
|
| 6588 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 6589 | <ul class="tsd-parameters">
|
| 6590 | <li>
|
| 6591 | <h5>namespaceID: <span class="tsd-signature-type">string</span></h5>
|
| 6592 | </li>
|
| 6593 | </ul>
|
| 6594 | <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>
|
| 6595 | </li>
|
| 6596 | </ul>
|
| 6597 | </section>
|
| 6598 | <section class="tsd-panel tsd-member tsd-kind-function tsd-is-not-exported">
|
| 6599 | <a name="namespaceisrevealed" class="tsd-anchor"></a>
|
| 6600 | <h3>namespace<wbr>IsRevealed</h3>
|
| 6601 | <ul class="tsd-signatures tsd-kind-function tsd-is-not-exported">
|
| 6602 | <li class="tsd-signature tsd-kind-icon">namespace<wbr>IsRevealed<span class="tsd-signature-symbol">(</span>namespaceID<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">boolean</span><span class="tsd-signature-symbol">></span></li>
|
| 6603 | </ul>
|
| 6604 | <ul class="tsd-descriptions">
|
| 6605 | <li class="tsd-description">
|
| 6606 | <aside class="tsd-sources">
|
| 6607 | <ul>
|
| 6608 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/operations/safety.ts#L97">operations/safety.ts:97</a></li>
|
| 6609 | </ul>
|
| 6610 | </aside>
|
| 6611 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 6612 | <ul class="tsd-parameters">
|
| 6613 | <li>
|
| 6614 | <h5>namespaceID: <span class="tsd-signature-type">string</span></h5>
|
| 6615 | </li>
|
| 6616 | </ul>
|
| 6617 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></h4>
|
| 6618 | </li>
|
| 6619 | </ul>
|
| 6620 | </section>
|
| 6621 | <section class="tsd-panel tsd-member tsd-kind-function">
|
| 6622 | <a name="nexthour" class="tsd-anchor"></a>
|
| 6623 | <h3>next<wbr>Hour</h3>
|
| 6624 | <ul class="tsd-signatures tsd-kind-function">
|
| 6625 | <li class="tsd-signature tsd-kind-icon">next<wbr>Hour<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Date</span></li>
|
| 6626 | </ul>
|
| 6627 | <ul class="tsd-descriptions">
|
| 6628 | <li class="tsd-description">
|
| 6629 | <aside class="tsd-sources">
|
| 6630 | <ul>
|
| 6631 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/utils.ts#L29">utils.ts:29</a></li>
|
| 6632 | </ul>
|
| 6633 | </aside>
|
| 6634 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Date</span></h4>
|
| 6635 | </li>
|
| 6636 | </ul>
|
| 6637 | </section>
|
| 6638 | <section class="tsd-panel tsd-member tsd-kind-function">
|
| 6639 | <a name="nextmonth" class="tsd-anchor"></a>
|
| 6640 | <h3>next<wbr>Month</h3>
|
| 6641 | <ul class="tsd-signatures tsd-kind-function">
|
| 6642 | <li class="tsd-signature tsd-kind-icon">next<wbr>Month<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Date</span></li>
|
| 6643 | </ul>
|
| 6644 | <ul class="tsd-descriptions">
|
| 6645 | <li class="tsd-description">
|
| 6646 | <aside class="tsd-sources">
|
| 6647 | <ul>
|
| 6648 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/utils.ts#L21">utils.ts:21</a></li>
|
| 6649 | </ul>
|
| 6650 | </aside>
|
| 6651 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Date</span></h4>
|
| 6652 | </li>
|
| 6653 | </ul>
|
| 6654 | </section>
|
| 6655 | <section class="tsd-panel tsd-member tsd-kind-function tsd-is-private">
|
| 6656 | <a name="nextyear" class="tsd-anchor"></a>
|
| 6657 | <h3><span class="tsd-flag ts-flagPrivate">Private</span> next<wbr>Year</h3>
|
| 6658 | <ul class="tsd-signatures tsd-kind-function tsd-is-private">
|
| 6659 | <li class="tsd-signature tsd-kind-icon">next<wbr>Year<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Date</span></li>
|
| 6660 | </ul>
|
| 6661 | <ul class="tsd-descriptions">
|
| 6662 | <li class="tsd-description">
|
| 6663 | <aside class="tsd-sources">
|
| 6664 | <ul>
|
| 6665 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/utils.ts#L13">utils.ts:13</a></li>
|
| 6666 | </ul>
|
| 6667 | </aside>
|
| 6668 | <div class="tsd-comment tsd-typography">
|
| 6669 | <div class="lead">
|
| 6670 | <p>Time</p>
|
| 6671 | </div>
|
| 6672 | </div>
|
| 6673 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Date</span></h4>
|
| 6674 | </li>
|
| 6675 | </ul>
|
| 6676 | </section>
|
| 6677 | <section class="tsd-panel tsd-member tsd-kind-function tsd-has-type-parameter tsd-is-not-exported">
|
| 6678 | <a name="normalizeoptions" class="tsd-anchor"></a>
|
| 6679 | <h3>normalize<wbr>Options</h3>
|
| 6680 | <ul class="tsd-signatures tsd-kind-function tsd-has-type-parameter tsd-is-not-exported">
|
| 6681 | <li class="tsd-signature tsd-kind-icon">normalize<wbr>Options<T><span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type">T</span>, caller<span class="tsd-signature-symbol">?: </span><a href="classes/usersession.html" class="tsd-signature-type">UserSession</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type">T</span></li>
|
| 6682 | </ul>
|
| 6683 | <ul class="tsd-descriptions">
|
| 6684 | <li class="tsd-description">
|
| 6685 | <aside class="tsd-sources">
|
| 6686 | <ul>
|
| 6687 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/storage/index.ts#L157">storage/index.ts:157</a></li>
|
| 6688 | </ul>
|
| 6689 | </aside>
|
| 6690 | <div class="tsd-comment tsd-typography">
|
| 6691 | </div>
|
| 6692 | <h4 class="tsd-type-parameters-title">Type parameters</h4>
|
| 6693 | <ul class="tsd-type-parameters">
|
| 6694 | <li>
|
| 6695 | <h4>T</h4>
|
| 6696 | </li>
|
| 6697 | </ul>
|
| 6698 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 6699 | <ul class="tsd-parameters">
|
| 6700 | <li>
|
| 6701 | <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">object</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type">T</span></h5>
|
| 6702 | </li>
|
| 6703 | <li>
|
| 6704 | <h5><span class="tsd-flag ts-flagOptional">Optional</span> caller: <a href="classes/usersession.html" class="tsd-signature-type">UserSession</a></h5>
|
| 6705 | </li>
|
| 6706 | </ul>
|
| 6707 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">object</span>
|
| 6708 | <span class="tsd-signature-symbol"> & </span>
|
| 6709 | <span class="tsd-signature-type">T</span>
|
| 6710 | </h4>
|
| 6711 | </li>
|
| 6712 | </ul>
|
| 6713 | </section>
|
| 6714 | <section class="tsd-panel tsd-member tsd-kind-function tsd-is-not-exported">
|
| 6715 | <a name="opencode" class="tsd-anchor"></a>
|
| 6716 | <h3>op<wbr>Encode</h3>
|
| 6717 | <ul class="tsd-signatures tsd-kind-function tsd-is-not-exported">
|
| 6718 | <li class="tsd-signature tsd-kind-icon">op<wbr>Encode<span class="tsd-signature-symbol">(</span>opcode<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>
|
| 6719 | </ul>
|
| 6720 | <ul class="tsd-descriptions">
|
| 6721 | <li class="tsd-description">
|
| 6722 | <aside class="tsd-sources">
|
| 6723 | <ul>
|
| 6724 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/operations/skeletons.ts#L153">operations/skeletons.ts:153</a></li>
|
| 6725 | </ul>
|
| 6726 | </aside>
|
| 6727 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 6728 | <ul class="tsd-parameters">
|
| 6729 | <li>
|
| 6730 | <h5>opcode: <span class="tsd-signature-type">string</span></h5>
|
| 6731 | </li>
|
| 6732 | </ul>
|
| 6733 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
|
| 6734 | </li>
|
| 6735 | </ul>
|
| 6736 | </section>
|
| 6737 | <section class="tsd-panel tsd-member tsd-kind-function tsd-is-not-exported">
|
| 6738 | <a name="outputbytes" class="tsd-anchor"></a>
|
| 6739 | <h3>output<wbr>Bytes</h3>
|
| 6740 | <ul class="tsd-signatures tsd-kind-function tsd-is-not-exported">
|
| 6741 | <li class="tsd-signature tsd-kind-icon">output<wbr>Bytes<span class="tsd-signature-symbol">(</span>output<span class="tsd-signature-symbol">: </span><a href="globals.html#txpoint" class="tsd-signature-type">txPoint</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">number</span></li>
|
| 6742 | </ul>
|
| 6743 | <ul class="tsd-descriptions">
|
| 6744 | <li class="tsd-description">
|
| 6745 | <aside class="tsd-sources">
|
| 6746 | <ul>
|
| 6747 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/operations/utils.ts#L43">operations/utils.ts:43</a></li>
|
| 6748 | </ul>
|
| 6749 | </aside>
|
| 6750 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 6751 | <ul class="tsd-parameters">
|
| 6752 | <li>
|
| 6753 | <h5>output: <a href="globals.html#txpoint" class="tsd-signature-type">txPoint</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></h5>
|
| 6754 | </li>
|
| 6755 | </ul>
|
| 6756 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
|
| 6757 | </li>
|
| 6758 | </ul>
|
| 6759 | </section>
|
| 6760 | <section class="tsd-panel tsd-member tsd-kind-function tsd-is-not-exported">
|
| 6761 | <a name="ownsname" class="tsd-anchor"></a>
|
| 6762 | <h3>owns<wbr>Name</h3>
|
| 6763 | <ul class="tsd-signatures tsd-kind-function tsd-is-not-exported">
|
| 6764 | <li class="tsd-signature tsd-kind-icon">owns<wbr>Name<span class="tsd-signature-symbol">(</span>fullyQualifiedName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, ownerAddress<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">boolean</span><span class="tsd-signature-symbol">></span></li>
|
| 6765 | </ul>
|
| 6766 | <ul class="tsd-descriptions">
|
| 6767 | <li class="tsd-description">
|
| 6768 | <aside class="tsd-sources">
|
| 6769 | <ul>
|
| 6770 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/operations/safety.ts#L61">operations/safety.ts:61</a></li>
|
| 6771 | </ul>
|
| 6772 | </aside>
|
| 6773 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 6774 | <ul class="tsd-parameters">
|
| 6775 | <li>
|
| 6776 | <h5>fullyQualifiedName: <span class="tsd-signature-type">string</span></h5>
|
| 6777 | </li>
|
| 6778 | <li>
|
| 6779 | <h5>ownerAddress: <span class="tsd-signature-type">string</span></h5>
|
| 6780 | </li>
|
| 6781 | </ul>
|
| 6782 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></h4>
|
| 6783 | </li>
|
| 6784 | </ul>
|
| 6785 | </section>
|
| 6786 | <section class="tsd-panel tsd-member tsd-kind-function">
|
| 6787 | <a name="publickeytoaddress" class="tsd-anchor"></a>
|
| 6788 | <h3>public<wbr>Key<wbr>ToAddress</h3>
|
| 6789 | <ul class="tsd-signatures tsd-kind-function">
|
| 6790 | <li class="tsd-signature tsd-kind-icon">public<wbr>Key<wbr>ToAddress<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-symbol">: </span><span class="tsd-signature-type">string</span></li>
|
| 6791 | </ul>
|
| 6792 | <ul class="tsd-descriptions">
|
| 6793 | <li class="tsd-description">
|
| 6794 | <aside class="tsd-sources">
|
| 6795 | <ul>
|
| 6796 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/keys.ts#L17">keys.ts:17</a></li>
|
| 6797 | </ul>
|
| 6798 | </aside>
|
| 6799 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 6800 | <ul class="tsd-parameters">
|
| 6801 | <li>
|
| 6802 | <h5>publicKey: <span class="tsd-signature-type">string</span></h5>
|
| 6803 | </li>
|
| 6804 | </ul>
|
| 6805 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
|
| 6806 | </li>
|
| 6807 | </ul>
|
| 6808 | </section>
|
| 6809 | <section class="tsd-panel tsd-member tsd-kind-function">
|
| 6810 | <a name="putfile" class="tsd-anchor"></a>
|
| 6811 | <h3>put<wbr>File</h3>
|
| 6812 | <ul class="tsd-signatures tsd-kind-function">
|
| 6813 | <li class="tsd-signature tsd-kind-icon">put<wbr>File<span class="tsd-signature-symbol">(</span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</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="globals.html#putfileoptions" class="tsd-signature-type">PutFileOptions</a>, caller<span class="tsd-signature-symbol">?: </span><a href="classes/usersession.html" class="tsd-signature-type">UserSession</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>
|
| 6814 | </ul>
|
| 6815 | <ul class="tsd-descriptions">
|
| 6816 | <li class="tsd-description">
|
| 6817 | <aside class="tsd-sources">
|
| 6818 | <ul>
|
| 6819 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/storage/index.ts#L460">storage/index.ts:460</a></li>
|
| 6820 | </ul>
|
| 6821 | </aside>
|
| 6822 | <div class="tsd-comment tsd-typography">
|
| 6823 | <div class="lead">
|
| 6824 | <p>Stores the data provided in the app's data store to to the file specified.</p>
|
| 6825 | </div>
|
| 6826 | </div>
|
| 6827 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 6828 | <ul class="tsd-parameters">
|
| 6829 | <li>
|
| 6830 | <h5>path: <span class="tsd-signature-type">string</span></h5>
|
| 6831 | <div class="tsd-comment tsd-typography">
|
| 6832 | <p>the path to store the data in</p>
|
| 6833 | </div>
|
| 6834 | </li>
|
| 6835 | <li>
|
| 6836 | <h5>content: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Buffer</span></h5>
|
| 6837 | <div class="tsd-comment tsd-typography">
|
| 6838 | <p>the data to store in the file</p>
|
| 6839 | </div>
|
| 6840 | </li>
|
| 6841 | <li>
|
| 6842 | <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <a href="globals.html#putfileoptions" class="tsd-signature-type">PutFileOptions</a></h5>
|
| 6843 | </li>
|
| 6844 | <li>
|
| 6845 | <h5><span class="tsd-flag ts-flagOptional">Optional</span> caller: <a href="classes/usersession.html" class="tsd-signature-type">UserSession</a></h5>
|
| 6846 | </li>
|
| 6847 | </ul>
|
| 6848 | <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>
|
| 6849 | <p>that resolves if the operation succeed and rejects
|
| 6850 | if it failed</p>
|
| 6851 | </li>
|
| 6852 | </ul>
|
| 6853 | </section>
|
| 6854 | <section class="tsd-panel tsd-member tsd-kind-function">
|
| 6855 | <a name="redirecttosignin" class="tsd-anchor"></a>
|
| 6856 | <h3>redirect<wbr>ToSign<wbr>In</h3>
|
| 6857 | <ul class="tsd-signatures tsd-kind-function">
|
| 6858 | <li class="tsd-signature tsd-kind-icon">redirect<wbr>ToSign<wbr>In<span class="tsd-signature-symbol">(</span>redirectURI<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">string</span>, scopes<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">void</span></li>
|
| 6859 | </ul>
|
| 6860 | <ul class="tsd-descriptions">
|
| 6861 | <li class="tsd-description">
|
| 6862 | <aside class="tsd-sources">
|
| 6863 | <ul>
|
| 6864 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/auth/authApp.ts#L79">auth/authApp.ts:79</a></li>
|
| 6865 | </ul>
|
| 6866 | </aside>
|
| 6867 | <div class="tsd-comment tsd-typography">
|
| 6868 | <div class="lead">
|
| 6869 | <p>Generates an authentication request and redirects the user to the Blockstack
|
| 6870 | browser to approve the sign in request.</p>
|
| 6871 | </div>
|
| 6872 | <p>Please note that this requires that the web browser properly handles the
|
| 6873 | <code>blockstack:</code> URL protocol handler.</p>
|
| 6874 | <p>Most applications should use this
|
| 6875 | method for sign in unless they require more fine grained control over how the
|
| 6876 | authentication request is generated. If your app falls into this category,
|
| 6877 | use <code>makeAuthRequest</code> and <code>redirectToSignInWithAuthRequest</code> to build your own sign in process.</p>
|
| 6878 | </div>
|
| 6879 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 6880 | <ul class="tsd-parameters">
|
| 6881 | <li>
|
| 6882 | <h5><span class="tsd-flag ts-flagOptional">Optional</span> redirectURI: <span class="tsd-signature-type">string</span></h5>
|
| 6883 | </li>
|
| 6884 | <li>
|
| 6885 | <h5><span class="tsd-flag ts-flagOptional">Optional</span> manifestURI: <span class="tsd-signature-type">string</span></h5>
|
| 6886 | </li>
|
| 6887 | <li>
|
| 6888 | <h5><span class="tsd-flag ts-flagOptional">Optional</span> scopes: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5>
|
| 6889 | </li>
|
| 6890 | </ul>
|
| 6891 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
| 6892 | </li>
|
| 6893 | </ul>
|
| 6894 | </section>
|
| 6895 | <section class="tsd-panel tsd-member tsd-kind-function">
|
| 6896 | <a name="redirecttosigninwithauthrequest" class="tsd-anchor"></a>
|
| 6897 | <h3>redirect<wbr>ToSign<wbr>InWith<wbr>Auth<wbr>Request</h3>
|
| 6898 | <ul class="tsd-signatures tsd-kind-function">
|
| 6899 | <li class="tsd-signature tsd-kind-icon">redirect<wbr>ToSign<wbr>InWith<wbr>Auth<wbr>Request<span class="tsd-signature-symbol">(</span>authRequest<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, blockstackIDHost<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>
|
| 6900 | </ul>
|
| 6901 | <ul class="tsd-descriptions">
|
| 6902 | <li class="tsd-description">
|
| 6903 | <aside class="tsd-sources">
|
| 6904 | <ul>
|
| 6905 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/auth/authApp.ts#L165">auth/authApp.ts:165</a></li>
|
| 6906 | </ul>
|
| 6907 | </aside>
|
| 6908 | <div class="tsd-comment tsd-typography">
|
| 6909 | <div class="lead">
|
| 6910 | <p>Redirects the user to the Blockstack browser to approve the sign in request
|
| 6911 | given.</p>
|
| 6912 | </div>
|
| 6913 | <p>The user is redirected to the <code>blockstackIDHost</code> if the <code>blockstack:</code>
|
| 6914 | protocol handler is not detected. Please note that the protocol handler detection
|
| 6915 | does not work on all browsers.</p>
|
| 6916 | </div>
|
| 6917 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 6918 | <ul class="tsd-parameters">
|
| 6919 | <li>
|
| 6920 | <h5><span class="tsd-flag ts-flagOptional">Optional</span> authRequest: <span class="tsd-signature-type">string</span></h5>
|
| 6921 | <div class="tsd-comment tsd-typography">
|
| 6922 | <p>the authentication request generated by <code>makeAuthRequest</code></p>
|
| 6923 | </div>
|
| 6924 | </li>
|
| 6925 | <li>
|
| 6926 | <h5><span class="tsd-flag ts-flagDefault value">Default value</span> blockstackIDHost: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = DEFAULT_BLOCKSTACK_HOST</span></h5>
|
| 6927 | <div class="tsd-comment tsd-typography">
|
| 6928 | <p>the URL to redirect the user to if the blockstack
|
| 6929 | protocol handler is not detected</p>
|
| 6930 | </div>
|
| 6931 | </li>
|
| 6932 | </ul>
|
| 6933 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
| 6934 | </li>
|
| 6935 | </ul>
|
| 6936 | </section>
|
| 6937 | <section class="tsd-panel tsd-member tsd-kind-function tsd-is-private">
|
| 6938 | <a name="redirectusertoapp" class="tsd-anchor"></a>
|
| 6939 | <h3><span class="tsd-flag ts-flagPrivate">Private</span> redirect<wbr>User<wbr>ToApp</h3>
|
| 6940 | <ul class="tsd-signatures tsd-kind-function tsd-is-private">
|
| 6941 | <li class="tsd-signature tsd-kind-icon">redirect<wbr>User<wbr>ToApp<span class="tsd-signature-symbol">(</span>authRequest<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, authResponse<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>
|
| 6942 | </ul>
|
| 6943 | <ul class="tsd-descriptions">
|
| 6944 | <li class="tsd-description">
|
| 6945 | <aside class="tsd-sources">
|
| 6946 | <ul>
|
| 6947 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/auth/authProvider.ts#L71">auth/authProvider.ts:71</a></li>
|
| 6948 | </ul>
|
| 6949 | </aside>
|
| 6950 | <div class="tsd-comment tsd-typography">
|
| 6951 | <div class="lead">
|
| 6952 | <p>Redirect the user's browser to the app using the <code>redirect_uri</code>
|
| 6953 | specified in the authentication request, passing the authentication
|
| 6954 | response token as a query parameter.</p>
|
| 6955 | </div>
|
| 6956 | <dl class="tsd-comment-tags">
|
| 6957 | <dt>throws</dt>
|
| 6958 | <dd><p>{Error} if there is no redirect uri</p>
|
| 6959 | </dd>
|
| 6960 | </dl>
|
| 6961 | </div>
|
| 6962 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 6963 | <ul class="tsd-parameters">
|
| 6964 | <li>
|
| 6965 | <h5>authRequest: <span class="tsd-signature-type">string</span></h5>
|
| 6966 | <div class="tsd-comment tsd-typography">
|
| 6967 | <p>encoded and signed authentication request token</p>
|
| 6968 | </div>
|
| 6969 | </li>
|
| 6970 | <li>
|
| 6971 | <h5>authResponse: <span class="tsd-signature-type">string</span></h5>
|
| 6972 | <div class="tsd-comment tsd-typography">
|
| 6973 | <p>encoded and signed authentication response token</p>
|
| 6974 | </div>
|
| 6975 | </li>
|
| 6976 | </ul>
|
| 6977 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
| 6978 | </li>
|
| 6979 | </ul>
|
| 6980 | </section>
|
| 6981 | <section class="tsd-panel tsd-member tsd-kind-function">
|
| 6982 | <a name="resolvezonefiletoperson" class="tsd-anchor"></a>
|
| 6983 | <h3>resolve<wbr>Zone<wbr>File<wbr>ToPerson</h3>
|
| 6984 | <ul class="tsd-signatures tsd-kind-function">
|
| 6985 | <li class="tsd-signature tsd-kind-icon">resolve<wbr>Zone<wbr>File<wbr>ToPerson<span class="tsd-signature-symbol">(</span>zoneFile<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, publicKeyOrAddress<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, callback<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>
|
| 6986 | </ul>
|
| 6987 | <ul class="tsd-descriptions">
|
| 6988 | <li class="tsd-description">
|
| 6989 | <aside class="tsd-sources">
|
| 6990 | <ul>
|
| 6991 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/personZoneFiles.ts#L8">profiles/profileSchemas/personZoneFiles.ts:8</a></li>
|
| 6992 | </ul>
|
| 6993 | </aside>
|
| 6994 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 6995 | <ul class="tsd-parameters">
|
| 6996 | <li>
|
| 6997 | <h5>zoneFile: <span class="tsd-signature-type">any</span></h5>
|
| 6998 | </li>
|
| 6999 | <li>
|
| 7000 | <h5>publicKeyOrAddress: <span class="tsd-signature-type">string</span></h5>
|
| 7001 | </li>
|
| 7002 | <li>
|
| 7003 | <h5>callback: <span class="tsd-signature-type">function</span></h5>
|
| 7004 | <ul class="tsd-parameters">
|
| 7005 | <li class="tsd-parameter-siganture">
|
| 7006 | <ul class="tsd-signatures tsd-kind-type-literal tsd-is-not-exported">
|
| 7007 | <li class="tsd-signature tsd-kind-icon"><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">void</span></li>
|
| 7008 | </ul>
|
| 7009 | <ul class="tsd-descriptions">
|
| 7010 | <li class="tsd-description">
|
| 7011 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 7012 | <ul class="tsd-parameters">
|
| 7013 | <li>
|
| 7014 | <h5>profile: <span class="tsd-signature-type">any</span></h5>
|
| 7015 | </li>
|
| 7016 | </ul>
|
| 7017 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
| 7018 | </li>
|
| 7019 | </ul>
|
| 7020 | </li>
|
| 7021 | </ul>
|
| 7022 | </li>
|
| 7023 | </ul>
|
| 7024 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
| 7025 | </li>
|
| 7026 | </ul>
|
| 7027 | </section>
|
| 7028 | <section class="tsd-panel tsd-member tsd-kind-function">
|
| 7029 | <a name="resolvezonefiletoprofile" class="tsd-anchor"></a>
|
| 7030 | <h3>resolve<wbr>Zone<wbr>File<wbr>ToProfile</h3>
|
| 7031 | <ul class="tsd-signatures tsd-kind-function">
|
| 7032 | <li class="tsd-signature tsd-kind-icon">resolve<wbr>Zone<wbr>File<wbr>ToProfile<span class="tsd-signature-symbol">(</span>zoneFile<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</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">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Object</span><span class="tsd-signature-symbol">></span></li>
|
| 7033 | </ul>
|
| 7034 | <ul class="tsd-descriptions">
|
| 7035 | <li class="tsd-description">
|
| 7036 | <aside class="tsd-sources">
|
| 7037 | <ul>
|
| 7038 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileZoneFiles.ts#L64">profiles/profileZoneFiles.ts:64</a></li>
|
| 7039 | </ul>
|
| 7040 | </aside>
|
| 7041 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 7042 | <ul class="tsd-parameters">
|
| 7043 | <li>
|
| 7044 | <h5>zoneFile: <span class="tsd-signature-type">any</span></h5>
|
| 7045 | </li>
|
| 7046 | <li>
|
| 7047 | <h5>publicKeyOrAddress: <span class="tsd-signature-type">string</span></h5>
|
| 7048 | </li>
|
| 7049 | </ul>
|
| 7050 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Object</span><span class="tsd-signature-symbol">></span></h4>
|
| 7051 | </li>
|
| 7052 | </ul>
|
| 7053 | </section>
|
| 7054 | <section class="tsd-panel tsd-member tsd-kind-function tsd-is-not-exported">
|
| 7055 | <a name="returntransactionhex" class="tsd-anchor"></a>
|
| 7056 | <h3>return<wbr>Transaction<wbr>Hex</h3>
|
| 7057 | <ul class="tsd-signatures tsd-kind-function tsd-is-not-exported">
|
| 7058 | <li class="tsd-signature tsd-kind-icon">return<wbr>Transaction<wbr>Hex<span class="tsd-signature-symbol">(</span>txB<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">bitcoinjs.TransactionBuilder</span>, buildIncomplete<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>
|
| 7059 | </ul>
|
| 7060 | <ul class="tsd-descriptions">
|
| 7061 | <li class="tsd-description">
|
| 7062 | <aside class="tsd-sources">
|
| 7063 | <ul>
|
| 7064 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/operations/txbuild.ts#L63">operations/txbuild.ts:63</a></li>
|
| 7065 | </ul>
|
| 7066 | </aside>
|
| 7067 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 7068 | <ul class="tsd-parameters">
|
| 7069 | <li>
|
| 7070 | <h5>txB: <span class="tsd-signature-type">bitcoinjs.TransactionBuilder</span></h5>
|
| 7071 | </li>
|
| 7072 | <li>
|
| 7073 | <h5><span class="tsd-flag ts-flagDefault value">Default value</span> buildIncomplete: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></h5>
|
| 7074 | </li>
|
| 7075 | </ul>
|
| 7076 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
|
| 7077 | </li>
|
| 7078 | </ul>
|
| 7079 | </section>
|
| 7080 | <section class="tsd-panel tsd-member tsd-kind-function tsd-is-not-exported">
|
| 7081 | <a name="revealednamespace" class="tsd-anchor"></a>
|
| 7082 | <h3>revealed<wbr>Namespace</h3>
|
| 7083 | <ul class="tsd-signatures tsd-kind-function tsd-is-not-exported">
|
| 7084 | <li class="tsd-signature tsd-kind-icon">revealed<wbr>Namespace<span class="tsd-signature-symbol">(</span>namespaceID<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, revealAddress<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">boolean</span><span class="tsd-signature-symbol">></span></li>
|
| 7085 | </ul>
|
| 7086 | <ul class="tsd-descriptions">
|
| 7087 | <li class="tsd-description">
|
| 7088 | <aside class="tsd-sources">
|
| 7089 | <ul>
|
| 7090 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/operations/safety.ts#L73">operations/safety.ts:73</a></li>
|
| 7091 | </ul>
|
| 7092 | </aside>
|
| 7093 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 7094 | <ul class="tsd-parameters">
|
| 7095 | <li>
|
| 7096 | <h5>namespaceID: <span class="tsd-signature-type">string</span></h5>
|
| 7097 | </li>
|
| 7098 | <li>
|
| 7099 | <h5>revealAddress: <span class="tsd-signature-type">string</span></h5>
|
| 7100 | </li>
|
| 7101 | </ul>
|
| 7102 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></h4>
|
| 7103 | </li>
|
| 7104 | </ul>
|
| 7105 | </section>
|
| 7106 | <section class="tsd-panel tsd-member tsd-kind-function tsd-is-private">
|
| 7107 | <a name="sendcoresessionrequest" class="tsd-anchor"></a>
|
| 7108 | <h3><span class="tsd-flag ts-flagPrivate">Private</span> send<wbr>Core<wbr>Session<wbr>Request</h3>
|
| 7109 | <ul class="tsd-signatures tsd-kind-function tsd-is-private">
|
| 7110 | <li class="tsd-signature tsd-kind-icon">send<wbr>Core<wbr>Session<wbr>Request<span class="tsd-signature-symbol">(</span>coreHost<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, corePort<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, coreAuthRequest<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, apiPassword<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>
|
| 7111 | </ul>
|
| 7112 | <ul class="tsd-descriptions">
|
| 7113 | <li class="tsd-description">
|
| 7114 | <aside class="tsd-sources">
|
| 7115 | <ul>
|
| 7116 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/auth/authSession.ts#L66">auth/authSession.ts:66</a></li>
|
| 7117 | </ul>
|
| 7118 | </aside>
|
| 7119 | <div class="tsd-comment tsd-typography">
|
| 7120 | <div class="lead">
|
| 7121 | <p>Send Core a request for a session token.</p>
|
| 7122 | </div>
|
| 7123 | <dl class="tsd-comment-tags">
|
| 7124 | <dt>deprecated</dt>
|
| 7125 | <dd></dd>
|
| 7126 | </dl>
|
| 7127 | </div>
|
| 7128 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 7129 | <ul class="tsd-parameters">
|
| 7130 | <li>
|
| 7131 | <h5>coreHost: <span class="tsd-signature-type">string</span></h5>
|
| 7132 | <div class="tsd-comment tsd-typography">
|
| 7133 | <p>host name of the core node</p>
|
| 7134 | </div>
|
| 7135 | </li>
|
| 7136 | <li>
|
| 7137 | <h5>corePort: <span class="tsd-signature-type">number</span></h5>
|
| 7138 | <div class="tsd-comment tsd-typography">
|
| 7139 | <p>port number of the core node</p>
|
| 7140 | </div>
|
| 7141 | </li>
|
| 7142 | <li>
|
| 7143 | <h5>coreAuthRequest: <span class="tsd-signature-type">string</span></h5>
|
| 7144 | <div class="tsd-comment tsd-typography">
|
| 7145 | <p>a signed JWT encoding the authentication request</p>
|
| 7146 | </div>
|
| 7147 | </li>
|
| 7148 | <li>
|
| 7149 | <h5>apiPassword: <span class="tsd-signature-type">string</span></h5>
|
| 7150 | <div class="tsd-comment tsd-typography">
|
| 7151 | <p>the API password for Core</p>
|
| 7152 | </div>
|
| 7153 | </li>
|
| 7154 | </ul>
|
| 7155 | <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>
|
| 7156 | <p>the resolves to a JWT signed with the Core API server's private key
|
| 7157 | that authorizes the bearer to carry out the requested operations and rejects
|
| 7158 | with an error message otherwise</p>
|
| 7159 | </li>
|
| 7160 | </ul>
|
| 7161 | </section>
|
| 7162 | <section class="tsd-panel tsd-member tsd-kind-function tsd-is-not-exported">
|
| 7163 | <a name="sharedsecrettokeys" class="tsd-anchor"></a>
|
| 7164 | <h3>shared<wbr>Secret<wbr>ToKeys</h3>
|
| 7165 | <ul class="tsd-signatures tsd-kind-function tsd-is-not-exported">
|
| 7166 | <li class="tsd-signature tsd-kind-icon">shared<wbr>Secret<wbr>ToKeys<span class="tsd-signature-symbol">(</span>sharedSecret<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">object</span></li>
|
| 7167 | </ul>
|
| 7168 | <ul class="tsd-descriptions">
|
| 7169 | <li class="tsd-description">
|
| 7170 | <aside class="tsd-sources">
|
| 7171 | <ul>
|
| 7172 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/encryption/ec.ts#L42">encryption/ec.ts:42</a></li>
|
| 7173 | </ul>
|
| 7174 | </aside>
|
| 7175 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 7176 | <ul class="tsd-parameters">
|
| 7177 | <li>
|
| 7178 | <h5>sharedSecret: <span class="tsd-signature-type">Buffer</span></h5>
|
| 7179 | </li>
|
| 7180 | </ul>
|
| 7181 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">object</span></h4>
|
| 7182 | <ul class="tsd-parameters">
|
| 7183 | <li class="tsd-parameter">
|
| 7184 | <h5>encryption<wbr>Key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span></h5>
|
| 7185 | </li>
|
| 7186 | <li class="tsd-parameter">
|
| 7187 | <h5>hmac<wbr>Key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span></h5>
|
| 7188 | </li>
|
| 7189 | </ul>
|
| 7190 | </li>
|
| 7191 | </ul>
|
| 7192 | </section>
|
| 7193 | <section class="tsd-panel tsd-member tsd-kind-function tsd-is-private">
|
| 7194 | <a name="signecdsa" class="tsd-anchor"></a>
|
| 7195 | <h3><span class="tsd-flag ts-flagPrivate">Private</span> signECDSA</h3>
|
| 7196 | <ul class="tsd-signatures tsd-kind-function tsd-is-private">
|
| 7197 | <li class="tsd-signature tsd-kind-icon">signECDSA<span class="tsd-signature-symbol">(</span>privateKey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</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><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span></li>
|
| 7198 | </ul>
|
| 7199 | <ul class="tsd-descriptions">
|
| 7200 | <li class="tsd-description">
|
| 7201 | <aside class="tsd-sources">
|
| 7202 | <ul>
|
| 7203 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/encryption/ec.ts#L163">encryption/ec.ts:163</a></li>
|
| 7204 | </ul>
|
| 7205 | </aside>
|
| 7206 | <div class="tsd-comment tsd-typography">
|
| 7207 | <div class="lead">
|
| 7208 | <p>Sign content using ECDSA</p>
|
| 7209 | </div>
|
| 7210 | </div>
|
| 7211 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 7212 | <ul class="tsd-parameters">
|
| 7213 | <li>
|
| 7214 | <h5>privateKey: <span class="tsd-signature-type">string</span></h5>
|
| 7215 | <div class="tsd-comment tsd-typography">
|
| 7216 | <p>secp256k1 private key hex string</p>
|
| 7217 | </div>
|
| 7218 | </li>
|
| 7219 | <li>
|
| 7220 | <h5>content: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Buffer</span></h5>
|
| 7221 | <div class="tsd-comment tsd-typography">
|
| 7222 | <p>content to sign</p>
|
| 7223 | </div>
|
| 7224 | </li>
|
| 7225 | </ul>
|
| 7226 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">object</span></h4>
|
| 7227 | <p>contains:
|
| 7228 | signature - Hex encoded DER signature
|
| 7229 | public key - Hex encoded private string taken from privateKey</p>
|
| 7230 | <ul class="tsd-parameters">
|
| 7231 | <li class="tsd-parameter">
|
| 7232 | <h5>public<wbr>Key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
|
| 7233 | </li>
|
| 7234 | <li class="tsd-parameter">
|
| 7235 | <h5>signature<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
|
| 7236 | </li>
|
| 7237 | </ul>
|
| 7238 | </li>
|
| 7239 | </ul>
|
| 7240 | </section>
|
| 7241 | <section class="tsd-panel tsd-member tsd-kind-function">
|
| 7242 | <a name="signinputs" class="tsd-anchor"></a>
|
| 7243 | <h3>sign<wbr>Inputs</h3>
|
| 7244 | <ul class="tsd-signatures tsd-kind-function">
|
| 7245 | <li class="tsd-signature tsd-kind-icon">sign<wbr>Inputs<span class="tsd-signature-symbol">(</span>txB<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">bitcoinjs.TransactionBuilder</span>, defaultSigner<span class="tsd-signature-symbol">: </span><a href="interfaces/transactionsigner.html" class="tsd-signature-type">TransactionSigner</a>, otherSigners<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Array</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><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">TransactionBuilder</span><span class="tsd-signature-symbol">></span></li>
|
| 7246 | </ul>
|
| 7247 | <ul class="tsd-descriptions">
|
| 7248 | <li class="tsd-description">
|
| 7249 | <aside class="tsd-sources">
|
| 7250 | <ul>
|
| 7251 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/operations/utils.ts#L181">operations/utils.ts:181</a></li>
|
| 7252 | </ul>
|
| 7253 | </aside>
|
| 7254 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 7255 | <ul class="tsd-parameters">
|
| 7256 | <li>
|
| 7257 | <h5>txB: <span class="tsd-signature-type">bitcoinjs.TransactionBuilder</span></h5>
|
| 7258 | </li>
|
| 7259 | <li>
|
| 7260 | <h5>defaultSigner: <a href="interfaces/transactionsigner.html" class="tsd-signature-type">TransactionSigner</a></h5>
|
| 7261 | </li>
|
| 7262 | <li>
|
| 7263 | <h5><span class="tsd-flag ts-flagOptional">Optional</span> otherSigners: <span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">></span></h5>
|
| 7264 | </li>
|
| 7265 | </ul>
|
| 7266 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">TransactionBuilder</span><span class="tsd-signature-symbol">></span></h4>
|
| 7267 | </li>
|
| 7268 | </ul>
|
| 7269 | </section>
|
| 7270 | <section class="tsd-panel tsd-member tsd-kind-function">
|
| 7271 | <a name="signprofiletoken" class="tsd-anchor"></a>
|
| 7272 | <h3>sign<wbr>Profile<wbr>Token</h3>
|
| 7273 | <ul class="tsd-signatures tsd-kind-function">
|
| 7274 | <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">any</span></li>
|
| 7275 | </ul>
|
| 7276 | <ul class="tsd-descriptions">
|
| 7277 | <li class="tsd-description">
|
| 7278 | <aside class="tsd-sources">
|
| 7279 | <ul>
|
| 7280 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileTokens.ts#L19">profiles/profileTokens.ts:19</a></li>
|
| 7281 | </ul>
|
| 7282 | </aside>
|
| 7283 | <div class="tsd-comment tsd-typography">
|
| 7284 | <div class="lead">
|
| 7285 | <p>Signs a profile token</p>
|
| 7286 | </div>
|
| 7287 | </div>
|
| 7288 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 7289 | <ul class="tsd-parameters">
|
| 7290 | <li>
|
| 7291 | <h5>profile: <span class="tsd-signature-type">any</span></h5>
|
| 7292 | <div class="tsd-comment tsd-typography">
|
| 7293 | <p>the JSON of the profile to be signed</p>
|
| 7294 | </div>
|
| 7295 | </li>
|
| 7296 | <li>
|
| 7297 | <h5>privateKey: <span class="tsd-signature-type">string</span></h5>
|
| 7298 | <div class="tsd-comment tsd-typography">
|
| 7299 | <p>the signing private key</p>
|
| 7300 | </div>
|
| 7301 | </li>
|
| 7302 | <li>
|
| 7303 | <h5><span class="tsd-flag ts-flagOptional">Optional</span> subject: <span class="tsd-signature-type">any</span></h5>
|
| 7304 | <div class="tsd-comment tsd-typography">
|
| 7305 | <p>the entity that the information is about</p>
|
| 7306 | </div>
|
| 7307 | </li>
|
| 7308 | <li>
|
| 7309 | <h5><span class="tsd-flag ts-flagOptional">Optional</span> issuer: <span class="tsd-signature-type">any</span></h5>
|
| 7310 | <div class="tsd-comment tsd-typography">
|
| 7311 | <p>the entity that is issuing the token</p>
|
| 7312 | </div>
|
| 7313 | </li>
|
| 7314 | <li>
|
| 7315 | <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>
|
| 7316 | <div class="tsd-comment tsd-typography">
|
| 7317 | <p>the signing algorithm to use</p>
|
| 7318 | </div>
|
| 7319 | </li>
|
| 7320 | <li>
|
| 7321 | <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>
|
| 7322 | <div class="tsd-comment tsd-typography">
|
| 7323 | <p>the time of issuance of the token</p>
|
| 7324 | </div>
|
| 7325 | </li>
|
| 7326 | <li>
|
| 7327 | <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>
|
| 7328 | <div class="tsd-comment tsd-typography">
|
| 7329 | <p>the time of expiration of the token</p>
|
| 7330 | </div>
|
| 7331 | </li>
|
| 7332 | </ul>
|
| 7333 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
|
| 7334 | <ul>
|
| 7335 | <li>the signed profile token</li>
|
| 7336 | </ul>
|
| 7337 | </li>
|
| 7338 | </ul>
|
| 7339 | </section>
|
| 7340 | <section class="tsd-panel tsd-member tsd-kind-function">
|
| 7341 | <a name="signuserout" class="tsd-anchor"></a>
|
| 7342 | <h3>sign<wbr>User<wbr>Out</h3>
|
| 7343 | <ul class="tsd-signatures tsd-kind-function">
|
| 7344 | <li class="tsd-signature tsd-kind-icon">sign<wbr>User<wbr>Out<span class="tsd-signature-symbol">(</span>redirectURL<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, caller<span class="tsd-signature-symbol">?: </span><a href="classes/usersession.html" class="tsd-signature-type">UserSession</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
| 7345 | </ul>
|
| 7346 | <ul class="tsd-descriptions">
|
| 7347 | <li class="tsd-description">
|
| 7348 | <aside class="tsd-sources">
|
| 7349 | <ul>
|
| 7350 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/auth/authApp.ts#L137">auth/authApp.ts:137</a></li>
|
| 7351 | </ul>
|
| 7352 | </aside>
|
| 7353 | <div class="tsd-comment tsd-typography">
|
| 7354 | <div class="lead">
|
| 7355 | <p>Sign the user out and optionally redirect to given location.</p>
|
| 7356 | </div>
|
| 7357 | </div>
|
| 7358 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 7359 | <ul class="tsd-parameters">
|
| 7360 | <li>
|
| 7361 | <h5><span class="tsd-flag ts-flagOptional">Optional</span> redirectURL: <span class="tsd-signature-type">string</span></h5>
|
| 7362 | <div class="tsd-comment tsd-typography">
|
| 7363 | <p>Location to redirect user to after sign out.
|
| 7364 | Only used in environments with <code>window</code> available</p>
|
| 7365 | </div>
|
| 7366 | </li>
|
| 7367 | <li>
|
| 7368 | <h5><span class="tsd-flag ts-flagOptional">Optional</span> caller: <a href="classes/usersession.html" class="tsd-signature-type">UserSession</a></h5>
|
| 7369 | </li>
|
| 7370 | </ul>
|
| 7371 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
| 7372 | </li>
|
| 7373 | </ul>
|
| 7374 | </section>
|
| 7375 | <section class="tsd-panel tsd-member tsd-kind-function">
|
| 7376 | <a name="sumoutputvalues" class="tsd-anchor"></a>
|
| 7377 | <h3>sum<wbr>Output<wbr>Values</h3>
|
| 7378 | <ul class="tsd-signatures tsd-kind-function">
|
| 7379 | <li class="tsd-signature tsd-kind-icon">sum<wbr>Output<wbr>Values<span class="tsd-signature-symbol">(</span>txIn<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">bitcoinjs.Transaction</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">bitcoinjs.TransactionBuilder</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
|
| 7380 | </ul>
|
| 7381 | <ul class="tsd-descriptions">
|
| 7382 | <li class="tsd-description">
|
| 7383 | <aside class="tsd-sources">
|
| 7384 | <ul>
|
| 7385 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/operations/utils.ts#L85">operations/utils.ts:85</a></li>
|
| 7386 | </ul>
|
| 7387 | </aside>
|
| 7388 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 7389 | <ul class="tsd-parameters">
|
| 7390 | <li>
|
| 7391 | <h5>txIn: <span class="tsd-signature-type">bitcoinjs.Transaction</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">bitcoinjs.TransactionBuilder</span></h5>
|
| 7392 | </li>
|
| 7393 | </ul>
|
| 7394 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
|
| 7395 | </li>
|
| 7396 | </ul>
|
| 7397 | </section>
|
| 7398 | <section class="tsd-panel tsd-member tsd-kind-function tsd-is-not-exported">
|
| 7399 | <a name="transactionbytes" class="tsd-anchor"></a>
|
| 7400 | <h3>transaction<wbr>Bytes</h3>
|
| 7401 | <ul class="tsd-signatures tsd-kind-function tsd-is-not-exported">
|
| 7402 | <li class="tsd-signature tsd-kind-icon">transaction<wbr>Bytes<span class="tsd-signature-symbol">(</span>inputs<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><a href="globals.html#txpoint" class="tsd-signature-type">txPoint</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">></span>, outputs<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><a href="globals.html#txpoint" class="tsd-signature-type">txPoint</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-symbol">: </span><span class="tsd-signature-type">number</span></li>
|
| 7403 | </ul>
|
| 7404 | <ul class="tsd-descriptions">
|
| 7405 | <li class="tsd-description">
|
| 7406 | <aside class="tsd-sources">
|
| 7407 | <ul>
|
| 7408 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/operations/utils.ts#L51">operations/utils.ts:51</a></li>
|
| 7409 | </ul>
|
| 7410 | </aside>
|
| 7411 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 7412 | <ul class="tsd-parameters">
|
| 7413 | <li>
|
| 7414 | <h5>inputs: <span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><a href="globals.html#txpoint" class="tsd-signature-type">txPoint</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">></span></h5>
|
| 7415 | </li>
|
| 7416 | <li>
|
| 7417 | <h5>outputs: <span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><a href="globals.html#txpoint" class="tsd-signature-type">txPoint</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">></span></h5>
|
| 7418 | </li>
|
| 7419 | </ul>
|
| 7420 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
|
| 7421 | </li>
|
| 7422 | </ul>
|
| 7423 | </section>
|
| 7424 | <section class="tsd-panel tsd-member tsd-kind-function tsd-is-private">
|
| 7425 | <a name="updatequerystringparameter" class="tsd-anchor"></a>
|
| 7426 | <h3><span class="tsd-flag ts-flagPrivate">Private</span> update<wbr>Query<wbr>String<wbr>Parameter</h3>
|
| 7427 | <ul class="tsd-signatures tsd-kind-function tsd-is-private">
|
| 7428 | <li class="tsd-signature tsd-kind-icon">update<wbr>Query<wbr>String<wbr>Parameter<span class="tsd-signature-symbol">(</span>uri<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, value<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>
|
| 7429 | </ul>
|
| 7430 | <ul class="tsd-descriptions">
|
| 7431 | <li class="tsd-description">
|
| 7432 | <aside class="tsd-sources">
|
| 7433 | <ul>
|
| 7434 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/utils.ts#L42">utils.ts:42</a></li>
|
| 7435 | </ul>
|
| 7436 | </aside>
|
| 7437 | <div class="tsd-comment tsd-typography">
|
| 7438 | <div class="lead">
|
| 7439 | <p>Query Strings</p>
|
| 7440 | </div>
|
| 7441 | </div>
|
| 7442 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 7443 | <ul class="tsd-parameters">
|
| 7444 | <li>
|
| 7445 | <h5>uri: <span class="tsd-signature-type">string</span></h5>
|
| 7446 | </li>
|
| 7447 | <li>
|
| 7448 | <h5>key: <span class="tsd-signature-type">string</span></h5>
|
| 7449 | </li>
|
| 7450 | <li>
|
| 7451 | <h5>value: <span class="tsd-signature-type">string</span></h5>
|
| 7452 | </li>
|
| 7453 | </ul>
|
| 7454 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
|
| 7455 | </li>
|
| 7456 | </ul>
|
| 7457 | </section>
|
| 7458 | <section class="tsd-panel tsd-member tsd-kind-function">
|
| 7459 | <a name="uploadtogaiahub" class="tsd-anchor"></a>
|
| 7460 | <h3>upload<wbr>ToGaia<wbr>Hub</h3>
|
| 7461 | <ul class="tsd-signatures tsd-kind-function">
|
| 7462 | <li class="tsd-signature tsd-kind-icon">upload<wbr>ToGaia<wbr>Hub<span class="tsd-signature-symbol">(</span>filename<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, contents<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, hubConfig<span class="tsd-signature-symbol">: </span><a href="globals.html#gaiahubconfig" class="tsd-signature-type">GaiaHubConfig</a>, contentType<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>
|
| 7463 | </ul>
|
| 7464 | <ul class="tsd-descriptions">
|
| 7465 | <li class="tsd-description">
|
| 7466 | <aside class="tsd-sources">
|
| 7467 | <ul>
|
| 7468 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/storage/hub.ts#L20">storage/hub.ts:20</a></li>
|
| 7469 | </ul>
|
| 7470 | </aside>
|
| 7471 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 7472 | <ul class="tsd-parameters">
|
| 7473 | <li>
|
| 7474 | <h5>filename: <span class="tsd-signature-type">string</span></h5>
|
| 7475 | </li>
|
| 7476 | <li>
|
| 7477 | <h5>contents: <span class="tsd-signature-type">any</span></h5>
|
| 7478 | </li>
|
| 7479 | <li>
|
| 7480 | <h5>hubConfig: <a href="globals.html#gaiahubconfig" class="tsd-signature-type">GaiaHubConfig</a></h5>
|
| 7481 | </li>
|
| 7482 | <li>
|
| 7483 | <h5><span class="tsd-flag ts-flagDefault value">Default value</span> contentType: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "application/octet-stream"</span></h5>
|
| 7484 | </li>
|
| 7485 | </ul>
|
| 7486 | <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>
|
| 7487 | </li>
|
| 7488 | </ul>
|
| 7489 | </section>
|
| 7490 | <section class="tsd-panel tsd-member tsd-kind-function">
|
| 7491 | <a name="validateproofs" class="tsd-anchor"></a>
|
| 7492 | <h3>validate<wbr>Proofs</h3>
|
| 7493 | <ul class="tsd-signatures tsd-kind-function">
|
| 7494 | <li class="tsd-signature tsd-kind-icon">validate<wbr>Proofs<span class="tsd-signature-symbol">(</span>profile<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, ownerAddress<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</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">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></li>
|
| 7495 | </ul>
|
| 7496 | <ul class="tsd-descriptions">
|
| 7497 | <li class="tsd-description">
|
| 7498 | <aside class="tsd-sources">
|
| 7499 | <ul>
|
| 7500 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileProofs.ts#L13">profiles/profileProofs.ts:13</a></li>
|
| 7501 | </ul>
|
| 7502 | </aside>
|
| 7503 | <div class="tsd-comment tsd-typography">
|
| 7504 | <div class="lead">
|
| 7505 | <p>Validates the social proofs in a user's profile. Currently supports validation of
|
| 7506 | Facebook, Twitter, GitHub, Instagram, LinkedIn and HackerNews accounts.</p>
|
| 7507 | </div>
|
| 7508 | </div>
|
| 7509 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 7510 | <ul class="tsd-parameters">
|
| 7511 | <li>
|
| 7512 | <h5>profile: <span class="tsd-signature-type">any</span></h5>
|
| 7513 | <div class="tsd-comment tsd-typography">
|
| 7514 | <p>The JSON of the profile to be validated</p>
|
| 7515 | </div>
|
| 7516 | </li>
|
| 7517 | <li>
|
| 7518 | <h5>ownerAddress: <span class="tsd-signature-type">string</span></h5>
|
| 7519 | <div class="tsd-comment tsd-typography">
|
| 7520 | <p>The owner bitcoin address to be validated</p>
|
| 7521 | </div>
|
| 7522 | </li>
|
| 7523 | <li>
|
| 7524 | <h5><span class="tsd-flag ts-flagDefault value">Default value</span> name: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = null</span></h5>
|
| 7525 | </li>
|
| 7526 | </ul>
|
| 7527 | <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><span class="tsd-signature-symbol">></span></h4>
|
| 7528 | <p>that resolves to an array of validated proof objects</p>
|
| 7529 | </li>
|
| 7530 | </ul>
|
| 7531 | </section>
|
| 7532 | <section class="tsd-panel tsd-member tsd-kind-function">
|
| 7533 | <a name="verifyauthrequest" class="tsd-anchor"></a>
|
| 7534 | <h3>verify<wbr>Auth<wbr>Request</h3>
|
| 7535 | <ul class="tsd-signatures tsd-kind-function">
|
| 7536 | <li class="tsd-signature tsd-kind-icon">verify<wbr>Auth<wbr>Request<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-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></li>
|
| 7537 | </ul>
|
| 7538 | <ul class="tsd-descriptions">
|
| 7539 | <li class="tsd-description">
|
| 7540 | <aside class="tsd-sources">
|
| 7541 | <ul>
|
| 7542 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/auth/authVerification.ts#L203">auth/authVerification.ts:203</a></li>
|
| 7543 | </ul>
|
| 7544 | </aside>
|
| 7545 | <div class="tsd-comment tsd-typography">
|
| 7546 | <div class="lead">
|
| 7547 | <p>Verify authentication request is valid. This function performs a number
|
| 7548 | of checks on the authentication request token:</p>
|
| 7549 | <ul>
|
| 7550 | <li>Checks that <code>token</code> has a valid issuance date & is not expired</li>
|
| 7551 | <li>Checks that <code>token</code> has a valid signature that matches the public key it claims</li>
|
| 7552 | <li>Checks that both the manifest and redirect URLs are absolute and conform to
|
| 7553 | the same origin policy</li>
|
| 7554 | </ul>
|
| 7555 | </div>
|
| 7556 | </div>
|
| 7557 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 7558 | <ul class="tsd-parameters">
|
| 7559 | <li>
|
| 7560 | <h5>token: <span class="tsd-signature-type">string</span></h5>
|
| 7561 | <div class="tsd-comment tsd-typography">
|
| 7562 | <p>encoded and signed authentication request token</p>
|
| 7563 | </div>
|
| 7564 | </li>
|
| 7565 | </ul>
|
| 7566 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></h4>
|
| 7567 | <p>that resolves to true if the auth request
|
| 7568 | is valid and false if it does not. It rejects with a String if the
|
| 7569 | token is not signed
|
| 7570 | @private</p>
|
| 7571 | </li>
|
| 7572 | </ul>
|
| 7573 | </section>
|
| 7574 | <section class="tsd-panel tsd-member tsd-kind-function tsd-is-private">
|
| 7575 | <a name="verifyauthrequestandloadmanifest" class="tsd-anchor"></a>
|
| 7576 | <h3><span class="tsd-flag ts-flagPrivate">Private</span> verify<wbr>Auth<wbr>Request<wbr>And<wbr>Load<wbr>Manifest</h3>
|
| 7577 | <ul class="tsd-signatures tsd-kind-function tsd-is-private">
|
| 7578 | <li class="tsd-signature tsd-kind-icon">verify<wbr>Auth<wbr>Request<wbr>And<wbr>Load<wbr>Manifest<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-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></li>
|
| 7579 | </ul>
|
| 7580 | <ul class="tsd-descriptions">
|
| 7581 | <li class="tsd-description">
|
| 7582 | <aside class="tsd-sources">
|
| 7583 | <ul>
|
| 7584 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/auth/authVerification.ts#L232">auth/authVerification.ts:232</a></li>
|
| 7585 | </ul>
|
| 7586 | </aside>
|
| 7587 | <div class="tsd-comment tsd-typography">
|
| 7588 | <div class="lead">
|
| 7589 | <p>Verify the authentication request is valid and
|
| 7590 | fetch the app manifest file if valid. Otherwise, reject the promise.</p>
|
| 7591 | </div>
|
| 7592 | </div>
|
| 7593 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 7594 | <ul class="tsd-parameters">
|
| 7595 | <li>
|
| 7596 | <h5>token: <span class="tsd-signature-type">string</span></h5>
|
| 7597 | <div class="tsd-comment tsd-typography">
|
| 7598 | <p>encoded and signed authentication request token</p>
|
| 7599 | </div>
|
| 7600 | </li>
|
| 7601 | </ul>
|
| 7602 | <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>
|
| 7603 | <p>that resolves to the app manifest file in JSON format
|
| 7604 | or rejects if the auth request or app manifest file is invalid</p>
|
| 7605 | </li>
|
| 7606 | </ul>
|
| 7607 | </section>
|
| 7608 | <section class="tsd-panel tsd-member tsd-kind-function tsd-is-private">
|
| 7609 | <a name="verifyauthresponse" class="tsd-anchor"></a>
|
| 7610 | <h3><span class="tsd-flag ts-flagPrivate">Private</span> verify<wbr>Auth<wbr>Response</h3>
|
| 7611 | <ul class="tsd-signatures tsd-kind-function tsd-is-private">
|
| 7612 | <li class="tsd-signature tsd-kind-icon">verify<wbr>Auth<wbr>Response<span class="tsd-signature-symbol">(</span>token<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, nameLookupURL<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">boolean</span><span class="tsd-signature-symbol">></span></li>
|
| 7613 | </ul>
|
| 7614 | <ul class="tsd-descriptions">
|
| 7615 | <li class="tsd-description">
|
| 7616 | <aside class="tsd-sources">
|
| 7617 | <ul>
|
| 7618 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/auth/authVerification.ts#L251">auth/authVerification.ts:251</a></li>
|
| 7619 | </ul>
|
| 7620 | </aside>
|
| 7621 | <div class="tsd-comment tsd-typography">
|
| 7622 | <div class="lead">
|
| 7623 | <p>Verify the authentication response is valid</p>
|
| 7624 | </div>
|
| 7625 | </div>
|
| 7626 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 7627 | <ul class="tsd-parameters">
|
| 7628 | <li>
|
| 7629 | <h5>token: <span class="tsd-signature-type">string</span></h5>
|
| 7630 | <div class="tsd-comment tsd-typography">
|
| 7631 | <p>the authentication response token</p>
|
| 7632 | </div>
|
| 7633 | </li>
|
| 7634 | <li>
|
| 7635 | <h5>nameLookupURL: <span class="tsd-signature-type">string</span></h5>
|
| 7636 | <div class="tsd-comment tsd-typography">
|
| 7637 | <p>the url use to verify owner of a username</p>
|
| 7638 | </div>
|
| 7639 | </li>
|
| 7640 | </ul>
|
| 7641 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></h4>
|
| 7642 | <p>that resolves to true if auth response
|
| 7643 | is valid and false if it does not</p>
|
| 7644 | </li>
|
| 7645 | </ul>
|
| 7646 | </section>
|
| 7647 | <section class="tsd-panel tsd-member tsd-kind-function tsd-is-private">
|
| 7648 | <a name="verifyecdsa" class="tsd-anchor"></a>
|
| 7649 | <h3><span class="tsd-flag ts-flagPrivate">Private</span> verifyECDSA</h3>
|
| 7650 | <ul class="tsd-signatures tsd-kind-function tsd-is-private">
|
| 7651 | <li class="tsd-signature tsd-kind-icon">verifyECDSA<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">ArrayBuffer</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Buffer</span>, publicKey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</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">boolean</span></li>
|
| 7652 | </ul>
|
| 7653 | <ul class="tsd-descriptions">
|
| 7654 | <li class="tsd-description">
|
| 7655 | <aside class="tsd-sources">
|
| 7656 | <ul>
|
| 7657 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/encryption/ec.ts#L193">encryption/ec.ts:193</a></li>
|
| 7658 | </ul>
|
| 7659 | </aside>
|
| 7660 | <div class="tsd-comment tsd-typography">
|
| 7661 | <div class="lead">
|
| 7662 | <p>Verify content using ECDSA</p>
|
| 7663 | </div>
|
| 7664 | </div>
|
| 7665 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 7666 | <ul class="tsd-parameters">
|
| 7667 | <li>
|
| 7668 | <h5>content: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">ArrayBuffer</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Buffer</span></h5>
|
| 7669 | <div class="tsd-comment tsd-typography">
|
| 7670 | <p>Content to verify was signed</p>
|
| 7671 | </div>
|
| 7672 | </li>
|
| 7673 | <li>
|
| 7674 | <h5>publicKey: <span class="tsd-signature-type">string</span></h5>
|
| 7675 | <div class="tsd-comment tsd-typography">
|
| 7676 | <p>secp256k1 private key hex string</p>
|
| 7677 | </div>
|
| 7678 | </li>
|
| 7679 | <li>
|
| 7680 | <h5>signature: <span class="tsd-signature-type">string</span></h5>
|
| 7681 | <div class="tsd-comment tsd-typography">
|
| 7682 | <p>Hex encoded DER signature</p>
|
| 7683 | </div>
|
| 7684 | </li>
|
| 7685 | </ul>
|
| 7686 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
|
| 7687 | <p>returns true when signature matches publickey + content, false if not</p>
|
| 7688 | </li>
|
| 7689 | </ul>
|
| 7690 | </section>
|
| 7691 | <section class="tsd-panel tsd-member tsd-kind-function">
|
| 7692 | <a name="verifyprofiletoken" class="tsd-anchor"></a>
|
| 7693 | <h3>verify<wbr>Profile<wbr>Token</h3>
|
| 7694 | <ul class="tsd-signatures tsd-kind-function">
|
| 7695 | <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">any</span></li>
|
| 7696 | </ul>
|
| 7697 | <ul class="tsd-descriptions">
|
| 7698 | <li class="tsd-description">
|
| 7699 | <aside class="tsd-sources">
|
| 7700 | <ul>
|
| 7701 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileTokens.ts#L74">profiles/profileTokens.ts:74</a></li>
|
| 7702 | </ul>
|
| 7703 | </aside>
|
| 7704 | <div class="tsd-comment tsd-typography">
|
| 7705 | <div class="lead">
|
| 7706 | <p>Verifies a profile token</p>
|
| 7707 | </div>
|
| 7708 | <dl class="tsd-comment-tags">
|
| 7709 | <dt>throws</dt>
|
| 7710 | <dd><p>{Error} - throws an error if token verification fails</p>
|
| 7711 | </dd>
|
| 7712 | </dl>
|
| 7713 | </div>
|
| 7714 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 7715 | <ul class="tsd-parameters">
|
| 7716 | <li>
|
| 7717 | <h5>token: <span class="tsd-signature-type">string</span></h5>
|
| 7718 | <div class="tsd-comment tsd-typography">
|
| 7719 | <p>the token to be verified</p>
|
| 7720 | </div>
|
| 7721 | </li>
|
| 7722 | <li>
|
| 7723 | <h5>publicKeyOrAddress: <span class="tsd-signature-type">string</span></h5>
|
| 7724 | <div class="tsd-comment tsd-typography">
|
| 7725 | <p>the public key or address of the
|
| 7726 | keypair that is thought to have signed the token</p>
|
| 7727 | </div>
|
| 7728 | </li>
|
| 7729 | </ul>
|
| 7730 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
|
| 7731 | <ul>
|
| 7732 | <li>the verified, decoded profile token</li>
|
| 7733 | </ul>
|
| 7734 | </li>
|
| 7735 | </ul>
|
| 7736 | </section>
|
| 7737 | <section class="tsd-panel tsd-member tsd-kind-function">
|
| 7738 | <a name="wrapprofiletoken" class="tsd-anchor"></a>
|
| 7739 | <h3>wrap<wbr>Profile<wbr>Token</h3>
|
| 7740 | <ul class="tsd-signatures tsd-kind-function">
|
| 7741 | <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-type">object</span></li>
|
| 7742 | </ul>
|
| 7743 | <ul class="tsd-descriptions">
|
| 7744 | <li class="tsd-description">
|
| 7745 | <aside class="tsd-sources">
|
| 7746 | <ul>
|
| 7747 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileTokens.ts#L59">profiles/profileTokens.ts:59</a></li>
|
| 7748 | </ul>
|
| 7749 | </aside>
|
| 7750 | <div class="tsd-comment tsd-typography">
|
| 7751 | <div class="lead">
|
| 7752 | <p>Wraps a token for a profile token file</p>
|
| 7753 | </div>
|
| 7754 | </div>
|
| 7755 | <h4 class="tsd-parameters-title">Parameters</h4>
|
| 7756 | <ul class="tsd-parameters">
|
| 7757 | <li>
|
| 7758 | <h5>token: <span class="tsd-signature-type">string</span></h5>
|
| 7759 | <div class="tsd-comment tsd-typography">
|
| 7760 | <p>the token to be wrapped</p>
|
| 7761 | </div>
|
| 7762 | </li>
|
| 7763 | </ul>
|
| 7764 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">object</span></h4>
|
| 7765 | <ul>
|
| 7766 | <li>including <code>token</code> and <code>decodedToken</code></li>
|
| 7767 | </ul>
|
| 7768 | <ul class="tsd-parameters">
|
| 7769 | <li class="tsd-parameter">
|
| 7770 | <h5>decoded<wbr>Token<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></h5>
|
| 7771 | </li>
|
| 7772 | <li class="tsd-parameter">
|
| 7773 | <h5>token<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
|
| 7774 | </li>
|
| 7775 | </ul>
|
| 7776 | </li>
|
| 7777 | </ul>
|
| 7778 | </section>
|
| 7779 | </section>
|
| 7780 | <section class="tsd-panel-group tsd-member-group ">
|
| 7781 | <h2>Object literals</h2>
|
| 7782 | <section class="tsd-panel tsd-member tsd-kind-object-literal tsd-is-not-exported">
|
| 7783 | <a name="default_profile" class="tsd-anchor"></a>
|
| 7784 | <h3><span class="tsd-flag ts-flagConst">Const</span> DEFAULT_<wbr>PROFILE</h3>
|
| 7785 | <div class="tsd-signature tsd-kind-icon">DEFAULT_<wbr>PROFILE<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
|
| 7786 | <aside class="tsd-sources">
|
| 7787 | <ul>
|
| 7788 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/auth/authApp.ts#L24">auth/authApp.ts:24</a></li>
|
| 7789 | </ul>
|
| 7790 | </aside>
|
| 7791 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal tsd-is-not-exported">
|
| 7792 | <a name="default_profile._context" class="tsd-anchor"></a>
|
| 7793 | <h3>@context</h3>
|
| 7794 | <div class="tsd-signature tsd-kind-icon">@context<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "http://schema.org"</span></div>
|
| 7795 | <aside class="tsd-sources">
|
| 7796 | <ul>
|
| 7797 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/auth/authApp.ts#L26">auth/authApp.ts:26</a></li>
|
| 7798 | </ul>
|
| 7799 | </aside>
|
| 7800 | </section>
|
| 7801 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal tsd-is-not-exported">
|
| 7802 | <a name="default_profile._type" class="tsd-anchor"></a>
|
| 7803 | <h3>@type</h3>
|
| 7804 | <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"> = "Person"</span></div>
|
| 7805 | <aside class="tsd-sources">
|
| 7806 | <ul>
|
| 7807 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/auth/authApp.ts#L25">auth/authApp.ts:25</a></li>
|
| 7808 | </ul>
|
| 7809 | </aside>
|
| 7810 | </section>
|
| 7811 | </section>
|
| 7812 | <section class="tsd-panel tsd-member tsd-kind-object-literal">
|
| 7813 | <a name="error_codes" class="tsd-anchor"></a>
|
| 7814 | <h3><span class="tsd-flag ts-flagConst">Const</span> ERROR_<wbr>CODES</h3>
|
| 7815 | <div class="tsd-signature tsd-kind-icon">ERROR_<wbr>CODES<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
|
| 7816 | <aside class="tsd-sources">
|
| 7817 | <ul>
|
| 7818 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/errors.ts#L2">errors.ts:2</a></li>
|
| 7819 | </ul>
|
| 7820 | </aside>
|
| 7821 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
| 7822 | <a name="error_codes.invalid_state" class="tsd-anchor"></a>
|
| 7823 | <h3>INVALID_<wbr>STATE</h3>
|
| 7824 | <div class="tsd-signature tsd-kind-icon">INVALID_<wbr>STATE<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "invalid_state"</span></div>
|
| 7825 | <aside class="tsd-sources">
|
| 7826 | <ul>
|
| 7827 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/errors.ts#L5">errors.ts:5</a></li>
|
| 7828 | </ul>
|
| 7829 | </aside>
|
| 7830 | </section>
|
| 7831 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
| 7832 | <a name="error_codes.missing_parameter" class="tsd-anchor"></a>
|
| 7833 | <h3>MISSING_<wbr>PARAMETER</h3>
|
| 7834 | <div class="tsd-signature tsd-kind-icon">MISSING_<wbr>PARAMETER<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "missing_parameter"</span></div>
|
| 7835 | <aside class="tsd-sources">
|
| 7836 | <ul>
|
| 7837 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/errors.ts#L3">errors.ts:3</a></li>
|
| 7838 | </ul>
|
| 7839 | </aside>
|
| 7840 | </section>
|
| 7841 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
| 7842 | <a name="error_codes.no_session_data" class="tsd-anchor"></a>
|
| 7843 | <h3>NO_<wbr>SESSION_<wbr>DATA</h3>
|
| 7844 | <div class="tsd-signature tsd-kind-icon">NO_<wbr>SESSION_<wbr>DATA<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "no_session_data"</span></div>
|
| 7845 | <aside class="tsd-sources">
|
| 7846 | <ul>
|
| 7847 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/errors.ts#L6">errors.ts:6</a></li>
|
| 7848 | </ul>
|
| 7849 | </aside>
|
| 7850 | </section>
|
| 7851 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
| 7852 | <a name="error_codes.remote_service_error" class="tsd-anchor"></a>
|
| 7853 | <h3>REMOTE_<wbr>SERVICE_<wbr>ERROR</h3>
|
| 7854 | <div class="tsd-signature tsd-kind-icon">REMOTE_<wbr>SERVICE_<wbr>ERROR<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "remote_service_error"</span></div>
|
| 7855 | <aside class="tsd-sources">
|
| 7856 | <ul>
|
| 7857 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/errors.ts#L4">errors.ts:4</a></li>
|
| 7858 | </ul>
|
| 7859 | </aside>
|
| 7860 | </section>
|
| 7861 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
| 7862 | <a name="error_codes.unknown" class="tsd-anchor"></a>
|
| 7863 | <h3>UNKNOWN</h3>
|
| 7864 | <div class="tsd-signature tsd-kind-icon">UNKNOWN<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "unknown"</span></div>
|
| 7865 | <aside class="tsd-sources">
|
| 7866 | <ul>
|
| 7867 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/errors.ts#L7">errors.ts:7</a></li>
|
| 7868 | </ul>
|
| 7869 | </aside>
|
| 7870 | </section>
|
| 7871 | </section>
|
| 7872 | <section class="tsd-panel tsd-member tsd-kind-object-literal tsd-is-not-exported">
|
| 7873 | <a name="config" class="tsd-anchor"></a>
|
| 7874 | <h3><span class="tsd-flag ts-flagConst">Const</span> config</h3>
|
| 7875 | <div class="tsd-signature tsd-kind-icon">config<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
|
| 7876 | <aside class="tsd-sources">
|
| 7877 | <ul>
|
| 7878 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/config.ts#L3">config.ts:3</a></li>
|
| 7879 | </ul>
|
| 7880 | </aside>
|
| 7881 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal tsd-is-not-exported">
|
| 7882 | <a name="config.loglevel" class="tsd-anchor"></a>
|
| 7883 | <h3>log<wbr>Level</h3>
|
| 7884 | <div class="tsd-signature tsd-kind-icon">log<wbr>Level<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "debug"</span></div>
|
| 7885 | <aside class="tsd-sources">
|
| 7886 | <ul>
|
| 7887 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/config.ts#L5">config.ts:5</a></li>
|
| 7888 | </ul>
|
| 7889 | </aside>
|
| 7890 | </section>
|
| 7891 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal tsd-is-not-exported">
|
| 7892 | <a name="config.network" class="tsd-anchor"></a>
|
| 7893 | <h3>network</h3>
|
| 7894 | <div class="tsd-signature tsd-kind-icon">network<span class="tsd-signature-symbol">:</span> <a href="classes/blockstacknetwork.html" class="tsd-signature-type">BlockstackNetwork</a><span class="tsd-signature-symbol"> = network.defaults.MAINNET_DEFAULT</span></div>
|
| 7895 | <aside class="tsd-sources">
|
| 7896 | <ul>
|
| 7897 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/config.ts#L4">config.ts:4</a></li>
|
| 7898 | </ul>
|
| 7899 | </aside>
|
| 7900 | </section>
|
| 7901 | </section>
|
| 7902 | <section class="tsd-panel tsd-member tsd-kind-object-literal">
|
| 7903 | <a name="network" class="tsd-anchor"></a>
|
| 7904 | <h3><span class="tsd-flag ts-flagConst">Const</span> network</h3>
|
| 7905 | <div class="tsd-signature tsd-kind-icon">network<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
|
| 7906 | <aside class="tsd-sources">
|
| 7907 | <ul>
|
| 7908 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/network.ts#L1190">network.ts:1190</a></li>
|
| 7909 | </ul>
|
| 7910 | </aside>
|
| 7911 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
| 7912 | <a name="network.bitcoindapi" class="tsd-anchor"></a>
|
| 7913 | <h3>BitcoindAPI</h3>
|
| 7914 | <div class="tsd-signature tsd-kind-icon">BitcoindAPI<span class="tsd-signature-symbol">:</span> <a href="classes/bitcoindapi.html" class="tsd-signature-type">BitcoindAPI</a></div>
|
| 7915 | <aside class="tsd-sources">
|
| 7916 | <ul>
|
| 7917 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/network.ts#L1194">network.ts:1194</a></li>
|
| 7918 | </ul>
|
| 7919 | </aside>
|
| 7920 | </section>
|
| 7921 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
| 7922 | <a name="network.blockchaininfoapi" class="tsd-anchor"></a>
|
| 7923 | <h3>Blockchain<wbr>Info<wbr>Api</h3>
|
| 7924 | <div class="tsd-signature tsd-kind-icon">Blockchain<wbr>Info<wbr>Api<span class="tsd-signature-symbol">:</span> <a href="classes/blockchaininfoapi.html" class="tsd-signature-type">BlockchainInfoApi</a></div>
|
| 7925 | <aside class="tsd-sources">
|
| 7926 | <ul>
|
| 7927 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/network.ts#L1193">network.ts:1193</a></li>
|
| 7928 | </ul>
|
| 7929 | </aside>
|
| 7930 | </section>
|
| 7931 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
| 7932 | <a name="network.blockstacknetwork" class="tsd-anchor"></a>
|
| 7933 | <h3>Blockstack<wbr>Network</h3>
|
| 7934 | <div class="tsd-signature tsd-kind-icon">Blockstack<wbr>Network<span class="tsd-signature-symbol">:</span> <a href="classes/blockstacknetwork.html" class="tsd-signature-type">BlockstackNetwork</a></div>
|
| 7935 | <aside class="tsd-sources">
|
| 7936 | <ul>
|
| 7937 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/network.ts#L1191">network.ts:1191</a></li>
|
| 7938 | </ul>
|
| 7939 | </aside>
|
| 7940 | </section>
|
| 7941 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
| 7942 | <a name="network.insightclient" class="tsd-anchor"></a>
|
| 7943 | <h3>Insight<wbr>Client</h3>
|
| 7944 | <div class="tsd-signature tsd-kind-icon">Insight<wbr>Client<span class="tsd-signature-symbol">:</span> <a href="classes/insightclient.html" class="tsd-signature-type">InsightClient</a></div>
|
| 7945 | <aside class="tsd-sources">
|
| 7946 | <ul>
|
| 7947 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/network.ts#L1195">network.ts:1195</a></li>
|
| 7948 | </ul>
|
| 7949 | </aside>
|
| 7950 | </section>
|
| 7951 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
| 7952 | <a name="network.localregtest" class="tsd-anchor"></a>
|
| 7953 | <h3>Local<wbr>Regtest</h3>
|
| 7954 | <div class="tsd-signature tsd-kind-icon">Local<wbr>Regtest<span class="tsd-signature-symbol">:</span> <a href="classes/localregtest.html" class="tsd-signature-type">LocalRegtest</a></div>
|
| 7955 | <aside class="tsd-sources">
|
| 7956 | <ul>
|
| 7957 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/network.ts#L1192">network.ts:1192</a></li>
|
| 7958 | </ul>
|
| 7959 | </aside>
|
| 7960 | </section>
|
| 7961 | <section class="tsd-panel tsd-member tsd-kind-object-literal tsd-parent-kind-object-literal">
|
| 7962 | <a name="network.defaults" class="tsd-anchor"></a>
|
| 7963 | <h3>defaults</h3>
|
| 7964 | <div class="tsd-signature tsd-kind-icon">defaults<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
|
| 7965 | <aside class="tsd-sources">
|
| 7966 | <ul>
|
| 7967 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/network.ts#L1196">network.ts:1196</a></li>
|
| 7968 | </ul>
|
| 7969 | </aside>
|
| 7970 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
| 7971 | <a name="network.defaults.local_regtest" class="tsd-anchor"></a>
|
| 7972 | <h3>LOCAL_<wbr>REGTEST</h3>
|
| 7973 | <div class="tsd-signature tsd-kind-icon">LOCAL_<wbr>REGTEST<span class="tsd-signature-symbol">:</span> <a href="classes/localregtest.html" class="tsd-signature-type">LocalRegtest</a></div>
|
| 7974 | <aside class="tsd-sources">
|
| 7975 | <ul>
|
| 7976 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/network.ts#L1196">network.ts:1196</a></li>
|
| 7977 | </ul>
|
| 7978 | </aside>
|
| 7979 | </section>
|
| 7980 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
| 7981 | <a name="network.defaults.mainnet_default" class="tsd-anchor"></a>
|
| 7982 | <h3>MAINNET_<wbr>DEFAULT</h3>
|
| 7983 | <div class="tsd-signature tsd-kind-icon">MAINNET_<wbr>DEFAULT<span class="tsd-signature-symbol">:</span> <a href="classes/blockstacknetwork.html" class="tsd-signature-type">BlockstackNetwork</a></div>
|
| 7984 | <aside class="tsd-sources">
|
| 7985 | <ul>
|
| 7986 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/network.ts#L1196">network.ts:1196</a></li>
|
| 7987 | </ul>
|
| 7988 | </aside>
|
| 7989 | </section>
|
| 7990 | </section>
|
| 7991 | </section>
|
| 7992 | <section class="tsd-panel tsd-member tsd-kind-object-literal">
|
| 7993 | <a name="profileservices" class="tsd-anchor"></a>
|
| 7994 | <h3><span class="tsd-flag ts-flagConst">Const</span> profile<wbr>Services</h3>
|
| 7995 | <div class="tsd-signature tsd-kind-icon">profile<wbr>Services<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
|
| 7996 | <aside class="tsd-sources">
|
| 7997 | <ul>
|
| 7998 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/services/index.ts#L17">profiles/services/index.ts:17</a></li>
|
| 7999 | </ul>
|
| 8000 | </aside>
|
| 8001 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
| 8002 | <a name="profileservices.facebook" class="tsd-anchor"></a>
|
| 8003 | <h3>facebook</h3>
|
| 8004 | <div class="tsd-signature tsd-kind-icon">facebook<span class="tsd-signature-symbol">:</span> <a href="classes/facebook.html" class="tsd-signature-type">Facebook</a><span class="tsd-signature-symbol"> = Facebook</span></div>
|
| 8005 | <aside class="tsd-sources">
|
| 8006 | <ul>
|
| 8007 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/services/index.ts#L20">profiles/services/index.ts:20</a></li>
|
| 8008 | </ul>
|
| 8009 | </aside>
|
| 8010 | </section>
|
| 8011 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
| 8012 | <a name="profileservices.github" class="tsd-anchor"></a>
|
| 8013 | <h3>github</h3>
|
| 8014 | <div class="tsd-signature tsd-kind-icon">github<span class="tsd-signature-symbol">:</span> <a href="classes/github.html" class="tsd-signature-type">Github</a><span class="tsd-signature-symbol"> = Github</span></div>
|
| 8015 | <aside class="tsd-sources">
|
| 8016 | <ul>
|
| 8017 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/services/index.ts#L21">profiles/services/index.ts:21</a></li>
|
| 8018 | </ul>
|
| 8019 | </aside>
|
| 8020 | </section>
|
| 8021 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
| 8022 | <a name="profileservices.hackernews" class="tsd-anchor"></a>
|
| 8023 | <h3>hacker<wbr>News</h3>
|
| 8024 | <div class="tsd-signature tsd-kind-icon">hacker<wbr>News<span class="tsd-signature-symbol">:</span> <a href="classes/hackernews.html" class="tsd-signature-type">HackerNews</a><span class="tsd-signature-symbol"> = HackerNews</span></div>
|
| 8025 | <aside class="tsd-sources">
|
| 8026 | <ul>
|
| 8027 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/services/index.ts#L24">profiles/services/index.ts:24</a></li>
|
| 8028 | </ul>
|
| 8029 | </aside>
|
| 8030 | </section>
|
| 8031 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
| 8032 | <a name="profileservices.instagram" class="tsd-anchor"></a>
|
| 8033 | <h3>instagram</h3>
|
| 8034 | <div class="tsd-signature tsd-kind-icon">instagram<span class="tsd-signature-symbol">:</span> <a href="classes/instagram.html" class="tsd-signature-type">Instagram</a><span class="tsd-signature-symbol"> = Instagram</span></div>
|
| 8035 | <aside class="tsd-sources">
|
| 8036 | <ul>
|
| 8037 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/services/index.ts#L23">profiles/services/index.ts:23</a></li>
|
| 8038 | </ul>
|
| 8039 | </aside>
|
| 8040 | </section>
|
| 8041 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
| 8042 | <a name="profileservices.linkedin" class="tsd-anchor"></a>
|
| 8043 | <h3>linked<wbr>In</h3>
|
| 8044 | <div class="tsd-signature tsd-kind-icon">linked<wbr>In<span class="tsd-signature-symbol">:</span> <a href="classes/linkedin.html" class="tsd-signature-type">LinkedIn</a><span class="tsd-signature-symbol"> = LinkedIn</span></div>
|
| 8045 | <aside class="tsd-sources">
|
| 8046 | <ul>
|
| 8047 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/services/index.ts#L25">profiles/services/index.ts:25</a></li>
|
| 8048 | </ul>
|
| 8049 | </aside>
|
| 8050 | </section>
|
| 8051 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
| 8052 | <a name="profileservices.twitter" class="tsd-anchor"></a>
|
| 8053 | <h3>twitter</h3>
|
| 8054 | <div class="tsd-signature tsd-kind-icon">twitter<span class="tsd-signature-symbol">:</span> <a href="classes/twitter.html" class="tsd-signature-type">Twitter</a><span class="tsd-signature-symbol"> = Twitter</span></div>
|
| 8055 | <aside class="tsd-sources">
|
| 8056 | <ul>
|
| 8057 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/services/index.ts#L22">profiles/services/index.ts:22</a></li>
|
| 8058 | </ul>
|
| 8059 | </aside>
|
| 8060 | </section>
|
| 8061 | </section>
|
| 8062 | <section class="tsd-panel tsd-member tsd-kind-object-literal">
|
| 8063 | <a name="safety" class="tsd-anchor"></a>
|
| 8064 | <h3><span class="tsd-flag ts-flagConst">Const</span> safety</h3>
|
| 8065 | <div class="tsd-signature tsd-kind-icon">safety<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
|
| 8066 | <aside class="tsd-sources">
|
| 8067 | <ul>
|
| 8068 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/operations/safety.ts#L138">operations/safety.ts:138</a></li>
|
| 8069 | </ul>
|
| 8070 | </aside>
|
| 8071 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
| 8072 | <a name="safety.addresscanreceivename" class="tsd-anchor"></a>
|
| 8073 | <h3>address<wbr>Can<wbr>Receive<wbr>Name</h3>
|
| 8074 | <div class="tsd-signature tsd-kind-icon">address<wbr>Can<wbr>Receive<wbr>Name<span class="tsd-signature-symbol">:</span> <a href="globals.html#addresscanreceivename" class="tsd-signature-type">addressCanReceiveName</a></div>
|
| 8075 | <aside class="tsd-sources">
|
| 8076 | <ul>
|
| 8077 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/operations/safety.ts#L139">operations/safety.ts:139</a></li>
|
| 8078 | </ul>
|
| 8079 | </aside>
|
| 8080 | </section>
|
| 8081 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
| 8082 | <a name="safety.isaccountspendable" class="tsd-anchor"></a>
|
| 8083 | <h3>is<wbr>Account<wbr>Spendable</h3>
|
| 8084 | <div class="tsd-signature tsd-kind-icon">is<wbr>Account<wbr>Spendable<span class="tsd-signature-symbol">:</span> <a href="globals.html#isaccountspendable" class="tsd-signature-type">isAccountSpendable</a></div>
|
| 8085 | <aside class="tsd-sources">
|
| 8086 | <ul>
|
| 8087 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/operations/safety.ts#L149">operations/safety.ts:149</a></li>
|
| 8088 | </ul>
|
| 8089 | </aside>
|
| 8090 | </section>
|
| 8091 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
| 8092 | <a name="safety.isingraceperiod" class="tsd-anchor"></a>
|
| 8093 | <h3>is<wbr>InGrace<wbr>Period</h3>
|
| 8094 | <div class="tsd-signature tsd-kind-icon">is<wbr>InGrace<wbr>Period<span class="tsd-signature-symbol">:</span> <a href="globals.html#isingraceperiod" class="tsd-signature-type">isInGracePeriod</a></div>
|
| 8095 | <aside class="tsd-sources">
|
| 8096 | <ul>
|
| 8097 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/operations/safety.ts#L140">operations/safety.ts:140</a></li>
|
| 8098 | </ul>
|
| 8099 | </aside>
|
| 8100 | </section>
|
| 8101 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
| 8102 | <a name="safety.isnameavailable" class="tsd-anchor"></a>
|
| 8103 | <h3>is<wbr>Name<wbr>Available</h3>
|
| 8104 | <div class="tsd-signature tsd-kind-icon">is<wbr>Name<wbr>Available<span class="tsd-signature-symbol">:</span> <a href="globals.html#isnameavailable" class="tsd-signature-type">isNameAvailable</a></div>
|
| 8105 | <aside class="tsd-sources">
|
| 8106 | <ul>
|
| 8107 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/operations/safety.ts#L142">operations/safety.ts:142</a></li>
|
| 8108 | </ul>
|
| 8109 | </aside>
|
| 8110 | </section>
|
| 8111 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
| 8112 | <a name="safety.isnamevalid" class="tsd-anchor"></a>
|
| 8113 | <h3>is<wbr>Name<wbr>Valid</h3>
|
| 8114 | <div class="tsd-signature tsd-kind-icon">is<wbr>Name<wbr>Valid<span class="tsd-signature-symbol">:</span> <a href="globals.html#isnamevalid" class="tsd-signature-type">isNameValid</a></div>
|
| 8115 | <aside class="tsd-sources">
|
| 8116 | <ul>
|
| 8117 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/operations/safety.ts#L143">operations/safety.ts:143</a></li>
|
| 8118 | </ul>
|
| 8119 | </aside>
|
| 8120 | </section>
|
| 8121 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
| 8122 | <a name="safety.isnamespaceavailable" class="tsd-anchor"></a>
|
| 8123 | <h3>is<wbr>Namespace<wbr>Available</h3>
|
| 8124 | <div class="tsd-signature tsd-kind-icon">is<wbr>Namespace<wbr>Available<span class="tsd-signature-symbol">:</span> <a href="globals.html#isnamespaceavailable" class="tsd-signature-type">isNamespaceAvailable</a></div>
|
| 8125 | <aside class="tsd-sources">
|
| 8126 | <ul>
|
| 8127 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/operations/safety.ts#L145">operations/safety.ts:145</a></li>
|
| 8128 | </ul>
|
| 8129 | </aside>
|
| 8130 | </section>
|
| 8131 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
| 8132 | <a name="safety.isnamespacevalid" class="tsd-anchor"></a>
|
| 8133 | <h3>is<wbr>Namespace<wbr>Valid</h3>
|
| 8134 | <div class="tsd-signature tsd-kind-icon">is<wbr>Namespace<wbr>Valid<span class="tsd-signature-symbol">:</span> <a href="globals.html#isnamespacevalid" class="tsd-signature-type">isNamespaceValid</a></div>
|
| 8135 | <aside class="tsd-sources">
|
| 8136 | <ul>
|
| 8137 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/operations/safety.ts#L144">operations/safety.ts:144</a></li>
|
| 8138 | </ul>
|
| 8139 | </aside>
|
| 8140 | </section>
|
| 8141 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
| 8142 | <a name="safety.namespaceisready" class="tsd-anchor"></a>
|
| 8143 | <h3>namespace<wbr>IsReady</h3>
|
| 8144 | <div class="tsd-signature tsd-kind-icon">namespace<wbr>IsReady<span class="tsd-signature-symbol">:</span> <a href="globals.html#namespaceisready" class="tsd-signature-type">namespaceIsReady</a></div>
|
| 8145 | <aside class="tsd-sources">
|
| 8146 | <ul>
|
| 8147 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/operations/safety.ts#L147">operations/safety.ts:147</a></li>
|
| 8148 | </ul>
|
| 8149 | </aside>
|
| 8150 | </section>
|
| 8151 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
| 8152 | <a name="safety.namespaceisrevealed" class="tsd-anchor"></a>
|
| 8153 | <h3>namespace<wbr>IsRevealed</h3>
|
| 8154 | <div class="tsd-signature tsd-kind-icon">namespace<wbr>IsRevealed<span class="tsd-signature-symbol">:</span> <a href="globals.html#namespaceisrevealed" class="tsd-signature-type">namespaceIsRevealed</a></div>
|
| 8155 | <aside class="tsd-sources">
|
| 8156 | <ul>
|
| 8157 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/operations/safety.ts#L148">operations/safety.ts:148</a></li>
|
| 8158 | </ul>
|
| 8159 | </aside>
|
| 8160 | </section>
|
| 8161 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
| 8162 | <a name="safety.ownsname" class="tsd-anchor"></a>
|
| 8163 | <h3>owns<wbr>Name</h3>
|
| 8164 | <div class="tsd-signature tsd-kind-icon">owns<wbr>Name<span class="tsd-signature-symbol">:</span> <a href="globals.html#ownsname" class="tsd-signature-type">ownsName</a></div>
|
| 8165 | <aside class="tsd-sources">
|
| 8166 | <ul>
|
| 8167 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/operations/safety.ts#L141">operations/safety.ts:141</a></li>
|
| 8168 | </ul>
|
| 8169 | </aside>
|
| 8170 | </section>
|
| 8171 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
| 8172 | <a name="safety.revealednamespace" class="tsd-anchor"></a>
|
| 8173 | <h3>revealed<wbr>Namespace</h3>
|
| 8174 | <div class="tsd-signature tsd-kind-icon">revealed<wbr>Namespace<span class="tsd-signature-symbol">:</span> <a href="globals.html#revealednamespace" class="tsd-signature-type">revealedNamespace</a></div>
|
| 8175 | <aside class="tsd-sources">
|
| 8176 | <ul>
|
| 8177 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/operations/safety.ts#L146">operations/safety.ts:146</a></li>
|
| 8178 | </ul>
|
| 8179 | </aside>
|
| 8180 | </section>
|
| 8181 | </section>
|
| 8182 | <section class="tsd-panel tsd-member tsd-kind-object-literal tsd-is-not-exported">
|
| 8183 | <a name="schemadefinition" class="tsd-anchor"></a>
|
| 8184 | <h3><span class="tsd-flag ts-flagConst">Const</span> schema<wbr>Definition</h3>
|
| 8185 | <div class="tsd-signature tsd-kind-icon">schema<wbr>Definition<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
|
| 8186 | <aside class="tsd-sources">
|
| 8187 | <ul>
|
| 8188 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profile.ts#L8">profiles/profile.ts:8</a></li>
|
| 8189 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/person.ts#L13">profiles/profileSchemas/person.ts:13</a></li>
|
| 8190 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/organization.ts#L8">profiles/profileSchemas/organization.ts:8</a></li>
|
| 8191 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/creativework.ts#L6">profiles/profileSchemas/creativework.ts:6</a></li>
|
| 8192 | </ul>
|
| 8193 | </aside>
|
| 8194 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal tsd-is-not-exported">
|
| 8195 | <a name="schemadefinition.strict" class="tsd-anchor"></a>
|
| 8196 | <h3>strict</h3>
|
| 8197 | <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>
|
| 8198 | <aside class="tsd-sources">
|
| 8199 | <ul>
|
| 8200 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/person.ts#L15">profiles/profileSchemas/person.ts:15</a></li>
|
| 8201 | </ul>
|
| 8202 | </aside>
|
| 8203 | </section>
|
| 8204 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal tsd-is-not-exported">
|
| 8205 | <a name="schemadefinition.type" class="tsd-anchor"></a>
|
| 8206 | <h3>type</h3>
|
| 8207 | <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>
|
| 8208 | <aside class="tsd-sources">
|
| 8209 | <ul>
|
| 8210 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profile.ts#L9">profiles/profile.ts:9</a></li>
|
| 8211 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/person.ts#L14">profiles/profileSchemas/person.ts:14</a></li>
|
| 8212 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/organization.ts#L9">profiles/profileSchemas/organization.ts:9</a></li>
|
| 8213 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/creativework.ts#L7">profiles/profileSchemas/creativework.ts:7</a></li>
|
| 8214 | </ul>
|
| 8215 | </aside>
|
| 8216 | </section>
|
| 8217 | <section class="tsd-panel tsd-member tsd-kind-object-literal tsd-parent-kind-object-literal tsd-is-not-exported">
|
| 8218 | <a name="schemadefinition.properties" class="tsd-anchor"></a>
|
| 8219 | <h3>properties</h3>
|
| 8220 | <div class="tsd-signature tsd-kind-icon">properties<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
|
| 8221 | <aside class="tsd-sources">
|
| 8222 | <ul>
|
| 8223 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profile.ts#L10">profiles/profile.ts:10</a></li>
|
| 8224 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/person.ts#L16">profiles/profileSchemas/person.ts:16</a></li>
|
| 8225 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/organization.ts#L10">profiles/profileSchemas/organization.ts:10</a></li>
|
| 8226 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/creativework.ts#L8">profiles/profileSchemas/creativework.ts:8</a></li>
|
| 8227 | </ul>
|
| 8228 | </aside>
|
| 8229 | <section class="tsd-panel tsd-member tsd-kind-object-literal tsd-parent-kind-object-literal tsd-is-not-exported">
|
| 8230 | <a name="schemadefinition.properties._context" class="tsd-anchor"></a>
|
| 8231 | <h3>@context</h3>
|
| 8232 | <div class="tsd-signature tsd-kind-icon">@context<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
|
| 8233 | <aside class="tsd-sources">
|
| 8234 | <ul>
|
| 8235 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profile.ts#L11">profiles/profile.ts:11</a></li>
|
| 8236 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/person.ts#L17">profiles/profileSchemas/person.ts:17</a></li>
|
| 8237 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/organization.ts#L11">profiles/profileSchemas/organization.ts:11</a></li>
|
| 8238 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/creativework.ts#L9">profiles/profileSchemas/creativework.ts:9</a></li>
|
| 8239 | </ul>
|
| 8240 | </aside>
|
| 8241 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal tsd-is-not-exported">
|
| 8242 | <a name="schemadefinition.properties._context.optional" class="tsd-anchor"></a>
|
| 8243 | <h3>optional</h3>
|
| 8244 | <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>
|
| 8245 | <aside class="tsd-sources">
|
| 8246 | <ul>
|
| 8247 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profile.ts#L11">profiles/profile.ts:11</a></li>
|
| 8248 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/person.ts#L17">profiles/profileSchemas/person.ts:17</a></li>
|
| 8249 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/organization.ts#L11">profiles/profileSchemas/organization.ts:11</a></li>
|
| 8250 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/creativework.ts#L9">profiles/profileSchemas/creativework.ts:9</a></li>
|
| 8251 | </ul>
|
| 8252 | </aside>
|
| 8253 | </section>
|
| 8254 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal tsd-is-not-exported">
|
| 8255 | <a name="schemadefinition.properties._context.type-1" class="tsd-anchor"></a>
|
| 8256 | <h3>type</h3>
|
| 8257 | <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>
|
| 8258 | <aside class="tsd-sources">
|
| 8259 | <ul>
|
| 8260 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profile.ts#L11">profiles/profile.ts:11</a></li>
|
| 8261 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/person.ts#L17">profiles/profileSchemas/person.ts:17</a></li>
|
| 8262 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/organization.ts#L11">profiles/profileSchemas/organization.ts:11</a></li>
|
| 8263 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/creativework.ts#L9">profiles/profileSchemas/creativework.ts:9</a></li>
|
| 8264 | </ul>
|
| 8265 | </aside>
|
| 8266 | </section>
|
| 8267 | </section>
|
| 8268 | <section class="tsd-panel tsd-member tsd-kind-object-literal tsd-parent-kind-object-literal tsd-is-not-exported">
|
| 8269 | <a name="schemadefinition.properties._id" class="tsd-anchor"></a>
|
| 8270 | <h3>@id</h3>
|
| 8271 | <div class="tsd-signature tsd-kind-icon">@id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
|
| 8272 | <aside class="tsd-sources">
|
| 8273 | <ul>
|
| 8274 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/person.ts#L19">profiles/profileSchemas/person.ts:19</a></li>
|
| 8275 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/organization.ts#L13">profiles/profileSchemas/organization.ts:13</a></li>
|
| 8276 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/creativework.ts#L11">profiles/profileSchemas/creativework.ts:11</a></li>
|
| 8277 | </ul>
|
| 8278 | </aside>
|
| 8279 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal tsd-is-not-exported">
|
| 8280 | <a name="schemadefinition.properties._id.optional-1" class="tsd-anchor"></a>
|
| 8281 | <h3>optional</h3>
|
| 8282 | <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>
|
| 8283 | <aside class="tsd-sources">
|
| 8284 | <ul>
|
| 8285 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/person.ts#L19">profiles/profileSchemas/person.ts:19</a></li>
|
| 8286 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/organization.ts#L13">profiles/profileSchemas/organization.ts:13</a></li>
|
| 8287 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/creativework.ts#L11">profiles/profileSchemas/creativework.ts:11</a></li>
|
| 8288 | </ul>
|
| 8289 | </aside>
|
| 8290 | </section>
|
| 8291 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal tsd-is-not-exported">
|
| 8292 | <a name="schemadefinition.properties._id.type-2" class="tsd-anchor"></a>
|
| 8293 | <h3>type</h3>
|
| 8294 | <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>
|
| 8295 | <aside class="tsd-sources">
|
| 8296 | <ul>
|
| 8297 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/person.ts#L19">profiles/profileSchemas/person.ts:19</a></li>
|
| 8298 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/organization.ts#L13">profiles/profileSchemas/organization.ts:13</a></li>
|
| 8299 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/creativework.ts#L11">profiles/profileSchemas/creativework.ts:11</a></li>
|
| 8300 | </ul>
|
| 8301 | </aside>
|
| 8302 | </section>
|
| 8303 | </section>
|
| 8304 | <section class="tsd-panel tsd-member tsd-kind-object-literal tsd-parent-kind-object-literal tsd-is-not-exported">
|
| 8305 | <a name="schemadefinition.properties._type" class="tsd-anchor"></a>
|
| 8306 | <h3>@type</h3>
|
| 8307 | <div class="tsd-signature tsd-kind-icon">@type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
|
| 8308 | <aside class="tsd-sources">
|
| 8309 | <ul>
|
| 8310 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profile.ts#L12">profiles/profile.ts:12</a></li>
|
| 8311 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/person.ts#L18">profiles/profileSchemas/person.ts:18</a></li>
|
| 8312 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/organization.ts#L12">profiles/profileSchemas/organization.ts:12</a></li>
|
| 8313 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/creativework.ts#L10">profiles/profileSchemas/creativework.ts:10</a></li>
|
| 8314 | </ul>
|
| 8315 | </aside>
|
| 8316 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal tsd-is-not-exported">
|
| 8317 | <a name="schemadefinition.properties._type.type-3" class="tsd-anchor"></a>
|
| 8318 | <h3>type</h3>
|
| 8319 | <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>
|
| 8320 | <aside class="tsd-sources">
|
| 8321 | <ul>
|
| 8322 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profile.ts#L12">profiles/profile.ts:12</a></li>
|
| 8323 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/person.ts#L18">profiles/profileSchemas/person.ts:18</a></li>
|
| 8324 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/organization.ts#L12">profiles/profileSchemas/organization.ts:12</a></li>
|
| 8325 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/creativework.ts#L10">profiles/profileSchemas/creativework.ts:10</a></li>
|
| 8326 | </ul>
|
| 8327 | </aside>
|
| 8328 | </section>
|
| 8329 | </section>
|
| 8330 | <section class="tsd-panel tsd-member tsd-kind-object-literal tsd-parent-kind-object-literal tsd-is-not-exported">
|
| 8331 | <a name="schemadefinition.properties.account" class="tsd-anchor"></a>
|
| 8332 | <h3>account</h3>
|
| 8333 | <div class="tsd-signature tsd-kind-icon">account<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
|
| 8334 | <aside class="tsd-sources">
|
| 8335 | <ul>
|
| 8336 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/person.ts#L47">profiles/profileSchemas/person.ts:47</a></li>
|
| 8337 | </ul>
|
| 8338 | </aside>
|
| 8339 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal tsd-is-not-exported">
|
| 8340 | <a name="schemadefinition.properties.account.optional-2" class="tsd-anchor"></a>
|
| 8341 | <h3>optional</h3>
|
| 8342 | <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>
|
| 8343 | <aside class="tsd-sources">
|
| 8344 | <ul>
|
| 8345 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/person.ts#L49">profiles/profileSchemas/person.ts:49</a></li>
|
| 8346 | </ul>
|
| 8347 | </aside>
|
| 8348 | </section>
|
| 8349 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal tsd-is-not-exported">
|
| 8350 | <a name="schemadefinition.properties.account.type-4" class="tsd-anchor"></a>
|
| 8351 | <h3>type</h3>
|
| 8352 | <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>
|
| 8353 | <aside class="tsd-sources">
|
| 8354 | <ul>
|
| 8355 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/person.ts#L48">profiles/profileSchemas/person.ts:48</a></li>
|
| 8356 | </ul>
|
| 8357 | </aside>
|
| 8358 | </section>
|
| 8359 | <section class="tsd-panel tsd-member tsd-kind-object-literal tsd-parent-kind-object-literal tsd-is-not-exported">
|
| 8360 | <a name="schemadefinition.properties.account.items" class="tsd-anchor"></a>
|
| 8361 | <h3>items</h3>
|
| 8362 | <div class="tsd-signature tsd-kind-icon">items<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
|
| 8363 | <aside class="tsd-sources">
|
| 8364 | <ul>
|
| 8365 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/person.ts#L50">profiles/profileSchemas/person.ts:50</a></li>
|
| 8366 | </ul>
|
| 8367 | </aside>
|
| 8368 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal tsd-is-not-exported">
|
| 8369 | <a name="schemadefinition.properties.account.items.type-5" class="tsd-anchor"></a>
|
| 8370 | <h3>type</h3>
|
| 8371 | <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>
|
| 8372 | <aside class="tsd-sources">
|
| 8373 | <ul>
|
| 8374 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/person.ts#L51">profiles/profileSchemas/person.ts:51</a></li>
|
| 8375 | </ul>
|
| 8376 | </aside>
|
| 8377 | </section>
|
| 8378 | <section class="tsd-panel tsd-member tsd-kind-object-literal tsd-parent-kind-object-literal tsd-is-not-exported">
|
| 8379 | <a name="schemadefinition.properties.account.items.properties-1" class="tsd-anchor"></a>
|
| 8380 | <h3>properties</h3>
|
| 8381 | <div class="tsd-signature tsd-kind-icon">properties<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
|
| 8382 | <aside class="tsd-sources">
|
| 8383 | <ul>
|
| 8384 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/person.ts#L52">profiles/profileSchemas/person.ts:52</a></li>
|
| 8385 | </ul>
|
| 8386 | </aside>
|
| 8387 | <section class="tsd-panel tsd-member tsd-kind-object-literal tsd-parent-kind-object-literal tsd-is-not-exported">
|
| 8388 | <a name="schemadefinition.properties.account.items.properties-1._type-1" class="tsd-anchor"></a>
|
| 8389 | <h3>@type</h3>
|
| 8390 | <div class="tsd-signature tsd-kind-icon">@type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
|
| 8391 | <aside class="tsd-sources">
|
| 8392 | <ul>
|
| 8393 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/person.ts#L53">profiles/profileSchemas/person.ts:53</a></li>
|
| 8394 | </ul>
|
| 8395 | </aside>
|
| 8396 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal tsd-is-not-exported">
|
| 8397 | <a name="schemadefinition.properties.account.items.properties-1._type-1.type-6" class="tsd-anchor"></a>
|
| 8398 | <h3>type</h3>
|
| 8399 | <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>
|
| 8400 | <aside class="tsd-sources">
|
| 8401 | <ul>
|
| 8402 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/person.ts#L53">profiles/profileSchemas/person.ts:53</a></li>
|
| 8403 | </ul>
|
| 8404 | </aside>
|
| 8405 | </section>
|
| 8406 | </section>
|
| 8407 | <section class="tsd-panel tsd-member tsd-kind-object-literal tsd-parent-kind-object-literal tsd-is-not-exported">
|
| 8408 | <a name="schemadefinition.properties.account.items.properties-1.identifier" class="tsd-anchor"></a>
|
| 8409 | <h3>identifier</h3>
|
| 8410 | <div class="tsd-signature tsd-kind-icon">identifier<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
|
| 8411 | <aside class="tsd-sources">
|
| 8412 | <ul>
|
| 8413 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/person.ts#L55">profiles/profileSchemas/person.ts:55</a></li>
|
| 8414 | </ul>
|
| 8415 | </aside>
|
| 8416 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal tsd-is-not-exported">
|
| 8417 | <a name="schemadefinition.properties.account.items.properties-1.identifier.optional-3" class="tsd-anchor"></a>
|
| 8418 | <h3>optional</h3>
|
| 8419 | <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>
|
| 8420 | <aside class="tsd-sources">
|
| 8421 | <ul>
|
| 8422 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/person.ts#L55">profiles/profileSchemas/person.ts:55</a></li>
|
| 8423 | </ul>
|
| 8424 | </aside>
|
| 8425 | </section>
|
| 8426 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal tsd-is-not-exported">
|
| 8427 | <a name="schemadefinition.properties.account.items.properties-1.identifier.type-7" class="tsd-anchor"></a>
|
| 8428 | <h3>type</h3>
|
| 8429 | <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>
|
| 8430 | <aside class="tsd-sources">
|
| 8431 | <ul>
|
| 8432 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/person.ts#L55">profiles/profileSchemas/person.ts:55</a></li>
|
| 8433 | </ul>
|
| 8434 | </aside>
|
| 8435 | </section>
|
| 8436 | </section>
|
| 8437 | <section class="tsd-panel tsd-member tsd-kind-object-literal tsd-parent-kind-object-literal tsd-is-not-exported">
|
| 8438 | <a name="schemadefinition.properties.account.items.properties-1.proofmessage" class="tsd-anchor"></a>
|
| 8439 | <h3>proof<wbr>Message</h3>
|
| 8440 | <div class="tsd-signature tsd-kind-icon">proof<wbr>Message<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
|
| 8441 | <aside class="tsd-sources">
|
| 8442 | <ul>
|
| 8443 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/person.ts#L58">profiles/profileSchemas/person.ts:58</a></li>
|
| 8444 | </ul>
|
| 8445 | </aside>
|
| 8446 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal tsd-is-not-exported">
|
| 8447 | <a name="schemadefinition.properties.account.items.properties-1.proofmessage.optional-4" class="tsd-anchor"></a>
|
| 8448 | <h3>optional</h3>
|
| 8449 | <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>
|
| 8450 | <aside class="tsd-sources">
|
| 8451 | <ul>
|
| 8452 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/person.ts#L58">profiles/profileSchemas/person.ts:58</a></li>
|
| 8453 | </ul>
|
| 8454 | </aside>
|
| 8455 | </section>
|
| 8456 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal tsd-is-not-exported">
|
| 8457 | <a name="schemadefinition.properties.account.items.properties-1.proofmessage.type-8" class="tsd-anchor"></a>
|
| 8458 | <h3>type</h3>
|
| 8459 | <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>
|
| 8460 | <aside class="tsd-sources">
|
| 8461 | <ul>
|
| 8462 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/person.ts#L58">profiles/profileSchemas/person.ts:58</a></li>
|
| 8463 | </ul>
|
| 8464 | </aside>
|
| 8465 | </section>
|
| 8466 | </section>
|
| 8467 | <section class="tsd-panel tsd-member tsd-kind-object-literal tsd-parent-kind-object-literal tsd-is-not-exported">
|
| 8468 | <a name="schemadefinition.properties.account.items.properties-1.proofsignature" class="tsd-anchor"></a>
|
| 8469 | <h3>proof<wbr>Signature</h3>
|
| 8470 | <div class="tsd-signature tsd-kind-icon">proof<wbr>Signature<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
|
| 8471 | <aside class="tsd-sources">
|
| 8472 | <ul>
|
| 8473 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/person.ts#L59">profiles/profileSchemas/person.ts:59</a></li>
|
| 8474 | </ul>
|
| 8475 | </aside>
|
| 8476 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal tsd-is-not-exported">
|
| 8477 | <a name="schemadefinition.properties.account.items.properties-1.proofsignature.optional-5" class="tsd-anchor"></a>
|
| 8478 | <h3>optional</h3>
|
| 8479 | <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>
|
| 8480 | <aside class="tsd-sources">
|
| 8481 | <ul>
|
| 8482 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/person.ts#L59">profiles/profileSchemas/person.ts:59</a></li>
|
| 8483 | </ul>
|
| 8484 | </aside>
|
| 8485 | </section>
|
| 8486 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal tsd-is-not-exported">
|
| 8487 | <a name="schemadefinition.properties.account.items.properties-1.proofsignature.type-9" class="tsd-anchor"></a>
|
| 8488 | <h3>type</h3>
|
| 8489 | <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>
|
| 8490 | <aside class="tsd-sources">
|
| 8491 | <ul>
|
| 8492 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/person.ts#L59">profiles/profileSchemas/person.ts:59</a></li>
|
| 8493 | </ul>
|
| 8494 | </aside>
|
| 8495 | </section>
|
| 8496 | </section>
|
| 8497 | <section class="tsd-panel tsd-member tsd-kind-object-literal tsd-parent-kind-object-literal tsd-is-not-exported">
|
| 8498 | <a name="schemadefinition.properties.account.items.properties-1.prooftype" class="tsd-anchor"></a>
|
| 8499 | <h3>proof<wbr>Type</h3>
|
| 8500 | <div class="tsd-signature tsd-kind-icon">proof<wbr>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
|
| 8501 | <aside class="tsd-sources">
|
| 8502 | <ul>
|
| 8503 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/person.ts#L56">profiles/profileSchemas/person.ts:56</a></li>
|
| 8504 | </ul>
|
| 8505 | </aside>
|
| 8506 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal tsd-is-not-exported">
|
| 8507 | <a name="schemadefinition.properties.account.items.properties-1.prooftype.optional-6" class="tsd-anchor"></a>
|
| 8508 | <h3>optional</h3>
|
| 8509 | <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>
|
| 8510 | <aside class="tsd-sources">
|
| 8511 | <ul>
|
| 8512 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/person.ts#L56">profiles/profileSchemas/person.ts:56</a></li>
|
| 8513 | </ul>
|
| 8514 | </aside>
|
| 8515 | </section>
|
| 8516 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal tsd-is-not-exported">
|
| 8517 | <a name="schemadefinition.properties.account.items.properties-1.prooftype.type-10" class="tsd-anchor"></a>
|
| 8518 | <h3>type</h3>
|
| 8519 | <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>
|
| 8520 | <aside class="tsd-sources">
|
| 8521 | <ul>
|
| 8522 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/person.ts#L56">profiles/profileSchemas/person.ts:56</a></li>
|
| 8523 | </ul>
|
| 8524 | </aside>
|
| 8525 | </section>
|
| 8526 | </section>
|
| 8527 | <section class="tsd-panel tsd-member tsd-kind-object-literal tsd-parent-kind-object-literal tsd-is-not-exported">
|
| 8528 | <a name="schemadefinition.properties.account.items.properties-1.proofurl" class="tsd-anchor"></a>
|
| 8529 | <h3>proof<wbr>Url</h3>
|
| 8530 | <div class="tsd-signature tsd-kind-icon">proof<wbr>Url<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
|
| 8531 | <aside class="tsd-sources">
|
| 8532 | <ul>
|
| 8533 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/person.ts#L57">profiles/profileSchemas/person.ts:57</a></li>
|
| 8534 | </ul>
|
| 8535 | </aside>
|
| 8536 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal tsd-is-not-exported">
|
| 8537 | <a name="schemadefinition.properties.account.items.properties-1.proofurl.optional-7" class="tsd-anchor"></a>
|
| 8538 | <h3>optional</h3>
|
| 8539 | <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>
|
| 8540 | <aside class="tsd-sources">
|
| 8541 | <ul>
|
| 8542 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/person.ts#L57">profiles/profileSchemas/person.ts:57</a></li>
|
| 8543 | </ul>
|
| 8544 | </aside>
|
| 8545 | </section>
|
| 8546 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal tsd-is-not-exported">
|
| 8547 | <a name="schemadefinition.properties.account.items.properties-1.proofurl.type-11" class="tsd-anchor"></a>
|
| 8548 | <h3>type</h3>
|
| 8549 | <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>
|
| 8550 | <aside class="tsd-sources">
|
| 8551 | <ul>
|
| 8552 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/person.ts#L57">profiles/profileSchemas/person.ts:57</a></li>
|
| 8553 | </ul>
|
| 8554 | </aside>
|
| 8555 | </section>
|
| 8556 | </section>
|
| 8557 | <section class="tsd-panel tsd-member tsd-kind-object-literal tsd-parent-kind-object-literal tsd-is-not-exported">
|
| 8558 | <a name="schemadefinition.properties.account.items.properties-1.service" class="tsd-anchor"></a>
|
| 8559 | <h3>service</h3>
|
| 8560 | <div class="tsd-signature tsd-kind-icon">service<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
|
| 8561 | <aside class="tsd-sources">
|
| 8562 | <ul>
|
| 8563 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/person.ts#L54">profiles/profileSchemas/person.ts:54</a></li>
|
| 8564 | </ul>
|
| 8565 | </aside>
|
| 8566 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal tsd-is-not-exported">
|
| 8567 | <a name="schemadefinition.properties.account.items.properties-1.service.optional-8" class="tsd-anchor"></a>
|
| 8568 | <h3>optional</h3>
|
| 8569 | <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>
|
| 8570 | <aside class="tsd-sources">
|
| 8571 | <ul>
|
| 8572 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/person.ts#L54">profiles/profileSchemas/person.ts:54</a></li>
|
| 8573 | </ul>
|
| 8574 | </aside>
|
| 8575 | </section>
|
| 8576 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal tsd-is-not-exported">
|
| 8577 | <a name="schemadefinition.properties.account.items.properties-1.service.type-12" class="tsd-anchor"></a>
|
| 8578 | <h3>type</h3>
|
| 8579 | <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>
|
| 8580 | <aside class="tsd-sources">
|
| 8581 | <ul>
|
| 8582 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/person.ts#L54">profiles/profileSchemas/person.ts:54</a></li>
|
| 8583 | </ul>
|
| 8584 | </aside>
|
| 8585 | </section>
|
| 8586 | </section>
|
| 8587 | </section>
|
| 8588 | </section>
|
| 8589 | </section>
|
| 8590 | <section class="tsd-panel tsd-member tsd-kind-object-literal tsd-parent-kind-object-literal tsd-is-not-exported">
|
| 8591 | <a name="schemadefinition.properties.address" class="tsd-anchor"></a>
|
| 8592 | <h3>address</h3>
|
| 8593 | <div class="tsd-signature tsd-kind-icon">address<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
|
| 8594 | <aside class="tsd-sources">
|
| 8595 | <ul>
|
| 8596 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/person.ts#L85">profiles/profileSchemas/person.ts:85</a></li>
|
| 8597 | </ul>
|
| 8598 | </aside>
|
| 8599 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal tsd-is-not-exported">
|
| 8600 | <a name="schemadefinition.properties.address.optional-9" class="tsd-anchor"></a>
|
| 8601 | <h3>optional</h3>
|
| 8602 | <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>
|
| 8603 | <aside class="tsd-sources">
|
| 8604 | <ul>
|
| 8605 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/person.ts#L87">profiles/profileSchemas/person.ts:87</a></li>
|
| 8606 | </ul>
|
| 8607 | </aside>
|
| 8608 | </section>
|
| 8609 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal tsd-is-not-exported">
|
| 8610 | <a name="schemadefinition.properties.address.type-13" class="tsd-anchor"></a>
|
| 8611 | <h3>type</h3>
|
| 8612 | <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>
|
| 8613 | <aside class="tsd-sources">
|
| 8614 | <ul>
|
| 8615 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/person.ts#L86">profiles/profileSchemas/person.ts:86</a></li>
|
| 8616 | </ul>
|
| 8617 | </aside>
|
| 8618 | </section>
|
| 8619 | <section class="tsd-panel tsd-member tsd-kind-object-literal tsd-parent-kind-object-literal tsd-is-not-exported">
|
| 8620 | <a name="schemadefinition.properties.address.properties-2" class="tsd-anchor"></a>
|
| 8621 | <h3>properties</h3>
|
| 8622 | <div class="tsd-signature tsd-kind-icon">properties<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
|
| 8623 | <aside class="tsd-sources">
|
| 8624 | <ul>
|
| 8625 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/person.ts#L88">profiles/profileSchemas/person.ts:88</a></li>
|
| 8626 | </ul>
|
| 8627 | </aside>
|
| 8628 | <section class="tsd-panel tsd-member tsd-kind-object-literal tsd-parent-kind-object-literal tsd-is-not-exported">
|
| 8629 | <a name="schemadefinition.properties.address.properties-2._type-2" class="tsd-anchor"></a>
|
| 8630 | <h3>@type</h3>
|
| 8631 | <div class="tsd-signature tsd-kind-icon">@type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
|
| 8632 | <aside class="tsd-sources">
|
| 8633 | <ul>
|
| 8634 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/person.ts#L89">profiles/profileSchemas/person.ts:89</a></li>
|
| 8635 | </ul>
|
| 8636 | </aside>
|
| 8637 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal tsd-is-not-exported">
|
| 8638 | <a name="schemadefinition.properties.address.properties-2._type-2.type-14" class="tsd-anchor"></a>
|
| 8639 | <h3>type</h3>
|
| 8640 | <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>
|
| 8641 | <aside class="tsd-sources">
|
| 8642 | <ul>
|
| 8643 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/person.ts#L89">profiles/profileSchemas/person.ts:89</a></li>
|
| 8644 | </ul>
|
| 8645 | </aside>
|
| 8646 | </section>
|
| 8647 | </section>
|
| 8648 | <section class="tsd-panel tsd-member tsd-kind-object-literal tsd-parent-kind-object-literal tsd-is-not-exported">
|
| 8649 | <a name="schemadefinition.properties.address.properties-2.addresscountry" class="tsd-anchor"></a>
|
| 8650 | <h3>address<wbr>Country</h3>
|
| 8651 | <div class="tsd-signature tsd-kind-icon">address<wbr>Country<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
|
| 8652 | <aside class="tsd-sources">
|
| 8653 | <ul>
|
| 8654 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/person.ts#L93">profiles/profileSchemas/person.ts:93</a></li>
|
| 8655 | </ul>
|
| 8656 | </aside>
|
| 8657 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal tsd-is-not-exported">
|
| 8658 | <a name="schemadefinition.properties.address.properties-2.addresscountry.optional-10" class="tsd-anchor"></a>
|
| 8659 | <h3>optional</h3>
|
| 8660 | <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>
|
| 8661 | <aside class="tsd-sources">
|
| 8662 | <ul>
|
| 8663 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/person.ts#L93">profiles/profileSchemas/person.ts:93</a></li>
|
| 8664 | </ul>
|
| 8665 | </aside>
|
| 8666 | </section>
|
| 8667 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal tsd-is-not-exported">
|
| 8668 | <a name="schemadefinition.properties.address.properties-2.addresscountry.type-15" class="tsd-anchor"></a>
|
| 8669 | <h3>type</h3>
|
| 8670 | <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>
|
| 8671 | <aside class="tsd-sources">
|
| 8672 | <ul>
|
| 8673 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/person.ts#L93">profiles/profileSchemas/person.ts:93</a></li>
|
| 8674 | </ul>
|
| 8675 | </aside>
|
| 8676 | </section>
|
| 8677 | </section>
|
| 8678 | <section class="tsd-panel tsd-member tsd-kind-object-literal tsd-parent-kind-object-literal tsd-is-not-exported">
|
| 8679 | <a name="schemadefinition.properties.address.properties-2.addresslocality" class="tsd-anchor"></a>
|
| 8680 | <h3>address<wbr>Locality</h3>
|
| 8681 | <div class="tsd-signature tsd-kind-icon">address<wbr>Locality<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
|
| 8682 | <aside class="tsd-sources">
|
| 8683 | <ul>
|
| 8684 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/person.ts#L91">profiles/profileSchemas/person.ts:91</a></li>
|
| 8685 | </ul>
|
| 8686 | </aside>
|
| 8687 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal tsd-is-not-exported">
|
| 8688 | <a name="schemadefinition.properties.address.properties-2.addresslocality.optional-11" class="tsd-anchor"></a>
|
| 8689 | <h3>optional</h3>
|
| 8690 | <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>
|
| 8691 | <aside class="tsd-sources">
|
| 8692 | <ul>
|
| 8693 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/person.ts#L91">profiles/profileSchemas/person.ts:91</a></li>
|
| 8694 | </ul>
|
| 8695 | </aside>
|
| 8696 | </section>
|
| 8697 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal tsd-is-not-exported">
|
| 8698 | <a name="schemadefinition.properties.address.properties-2.addresslocality.type-16" class="tsd-anchor"></a>
|
| 8699 | <h3>type</h3>
|
| 8700 | <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>
|
| 8701 | <aside class="tsd-sources">
|
| 8702 | <ul>
|
| 8703 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/person.ts#L91">profiles/profileSchemas/person.ts:91</a></li>
|
| 8704 | </ul>
|
| 8705 | </aside>
|
| 8706 | </section>
|
| 8707 | </section>
|
| 8708 | <section class="tsd-panel tsd-member tsd-kind-object-literal tsd-parent-kind-object-literal tsd-is-not-exported">
|
| 8709 | <a name="schemadefinition.properties.address.properties-2.postalcode" class="tsd-anchor"></a>
|
| 8710 | <h3>postal<wbr>Code</h3>
|
| 8711 | <div class="tsd-signature tsd-kind-icon">postal<wbr>Code<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
|
| 8712 | <aside class="tsd-sources">
|
| 8713 | <ul>
|
| 8714 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/person.ts#L92">profiles/profileSchemas/person.ts:92</a></li>
|
| 8715 | </ul>
|
| 8716 | </aside>
|
| 8717 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal tsd-is-not-exported">
|
| 8718 | <a name="schemadefinition.properties.address.properties-2.postalcode.optional-12" class="tsd-anchor"></a>
|
| 8719 | <h3>optional</h3>
|
| 8720 | <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>
|
| 8721 | <aside class="tsd-sources">
|
| 8722 | <ul>
|
| 8723 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/person.ts#L92">profiles/profileSchemas/person.ts:92</a></li>
|
| 8724 | </ul>
|
| 8725 | </aside>
|
| 8726 | </section>
|
| 8727 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal tsd-is-not-exported">
|
| 8728 | <a name="schemadefinition.properties.address.properties-2.postalcode.type-17" class="tsd-anchor"></a>
|
| 8729 | <h3>type</h3>
|
| 8730 | <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>
|
| 8731 | <aside class="tsd-sources">
|
| 8732 | <ul>
|
| 8733 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/person.ts#L92">profiles/profileSchemas/person.ts:92</a></li>
|
| 8734 | </ul>
|
| 8735 | </aside>
|
| 8736 | </section>
|
| 8737 | </section>
|
| 8738 | <section class="tsd-panel tsd-member tsd-kind-object-literal tsd-parent-kind-object-literal tsd-is-not-exported">
|
| 8739 | <a name="schemadefinition.properties.address.properties-2.streetaddress" class="tsd-anchor"></a>
|
| 8740 | <h3>street<wbr>Address</h3>
|
| 8741 | <div class="tsd-signature tsd-kind-icon">street<wbr>Address<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
|
| 8742 | <aside class="tsd-sources">
|
| 8743 | <ul>
|
| 8744 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/person.ts#L90">profiles/profileSchemas/person.ts:90</a></li>
|
| 8745 | </ul>
|
| 8746 | </aside>
|
| 8747 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal tsd-is-not-exported">
|
| 8748 | <a name="schemadefinition.properties.address.properties-2.streetaddress.optional-13" class="tsd-anchor"></a>
|
| 8749 | <h3>optional</h3>
|
| 8750 | <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>
|
| 8751 | <aside class="tsd-sources">
|
| 8752 | <ul>
|
| 8753 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/person.ts#L90">profiles/profileSchemas/person.ts:90</a></li>
|
| 8754 | </ul>
|
| 8755 | </aside>
|
| 8756 | </section>
|
| 8757 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal tsd-is-not-exported">
|
| 8758 | <a name="schemadefinition.properties.address.properties-2.streetaddress.type-18" class="tsd-anchor"></a>
|
| 8759 | <h3>type</h3>
|
| 8760 | <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>
|
| 8761 | <aside class="tsd-sources">
|
| 8762 | <ul>
|
| 8763 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/person.ts#L90">profiles/profileSchemas/person.ts:90</a></li>
|
| 8764 | </ul>
|
| 8765 | </aside>
|
| 8766 | </section>
|
| 8767 | </section>
|
| 8768 | </section>
|
| 8769 | </section>
|
| 8770 | <section class="tsd-panel tsd-member tsd-kind-object-literal tsd-parent-kind-object-literal tsd-is-not-exported">
|
| 8771 | <a name="schemadefinition.properties.birthdate" class="tsd-anchor"></a>
|
| 8772 | <h3>birth<wbr>Date</h3>
|
| 8773 | <div class="tsd-signature tsd-kind-icon">birth<wbr>Date<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
|
| 8774 | <aside class="tsd-sources">
|
| 8775 | <ul>
|
| 8776 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/person.ts#L96">profiles/profileSchemas/person.ts:96</a></li>
|
| 8777 | </ul>
|
| 8778 | </aside>
|
| 8779 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal tsd-is-not-exported">
|
| 8780 | <a name="schemadefinition.properties.birthdate.optional-14" class="tsd-anchor"></a>
|
| 8781 | <h3>optional</h3>
|
| 8782 | <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>
|
| 8783 | <aside class="tsd-sources">
|
| 8784 | <ul>
|
| 8785 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/person.ts#L96">profiles/profileSchemas/person.ts:96</a></li>
|
| 8786 | </ul>
|
| 8787 | </aside>
|
| 8788 | </section>
|
| 8789 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal tsd-is-not-exported">
|
| 8790 | <a name="schemadefinition.properties.birthdate.type-19" class="tsd-anchor"></a>
|
| 8791 | <h3>type</h3>
|
| 8792 | <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>
|
| 8793 | <aside class="tsd-sources">
|
| 8794 | <ul>
|
| 8795 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/person.ts#L96">profiles/profileSchemas/person.ts:96</a></li>
|
| 8796 | </ul>
|
| 8797 | </aside>
|
| 8798 | </section>
|
| 8799 | </section>
|
| 8800 | <section class="tsd-panel tsd-member tsd-kind-object-literal tsd-parent-kind-object-literal tsd-is-not-exported">
|
| 8801 | <a name="schemadefinition.properties.description" class="tsd-anchor"></a>
|
| 8802 | <h3>description</h3>
|
| 8803 | <div class="tsd-signature tsd-kind-icon">description<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
|
| 8804 | <aside class="tsd-sources">
|
| 8805 | <ul>
|
| 8806 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/person.ts#L23">profiles/profileSchemas/person.ts:23</a></li>
|
| 8807 | </ul>
|
| 8808 | </aside>
|
| 8809 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal tsd-is-not-exported">
|
| 8810 | <a name="schemadefinition.properties.description.optional-15" class="tsd-anchor"></a>
|
| 8811 | <h3>optional</h3>
|
| 8812 | <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>
|
| 8813 | <aside class="tsd-sources">
|
| 8814 | <ul>
|
| 8815 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/person.ts#L23">profiles/profileSchemas/person.ts:23</a></li>
|
| 8816 | </ul>
|
| 8817 | </aside>
|
| 8818 | </section>
|
| 8819 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal tsd-is-not-exported">
|
| 8820 | <a name="schemadefinition.properties.description.type-20" class="tsd-anchor"></a>
|
| 8821 | <h3>type</h3>
|
| 8822 | <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>
|
| 8823 | <aside class="tsd-sources">
|
| 8824 | <ul>
|
| 8825 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/person.ts#L23">profiles/profileSchemas/person.ts:23</a></li>
|
| 8826 | </ul>
|
| 8827 | </aside>
|
| 8828 | </section>
|
| 8829 | </section>
|
| 8830 | <section class="tsd-panel tsd-member tsd-kind-object-literal tsd-parent-kind-object-literal tsd-is-not-exported">
|
| 8831 | <a name="schemadefinition.properties.familyname" class="tsd-anchor"></a>
|
| 8832 | <h3>family<wbr>Name</h3>
|
| 8833 | <div class="tsd-signature tsd-kind-icon">family<wbr>Name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
|
| 8834 | <aside class="tsd-sources">
|
| 8835 | <ul>
|
| 8836 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/person.ts#L22">profiles/profileSchemas/person.ts:22</a></li>
|
| 8837 | </ul>
|
| 8838 | </aside>
|
| 8839 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal tsd-is-not-exported">
|
| 8840 | <a name="schemadefinition.properties.familyname.optional-16" class="tsd-anchor"></a>
|
| 8841 | <h3>optional</h3>
|
| 8842 | <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>
|
| 8843 | <aside class="tsd-sources">
|
| 8844 | <ul>
|
| 8845 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/person.ts#L22">profiles/profileSchemas/person.ts:22</a></li>
|
| 8846 | </ul>
|
| 8847 | </aside>
|
| 8848 | </section>
|
| 8849 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal tsd-is-not-exported">
|
| 8850 | <a name="schemadefinition.properties.familyname.type-21" class="tsd-anchor"></a>
|
| 8851 | <h3>type</h3>
|
| 8852 | <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>
|
| 8853 | <aside class="tsd-sources">
|
| 8854 | <ul>
|
| 8855 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/person.ts#L22">profiles/profileSchemas/person.ts:22</a></li>
|
| 8856 | </ul>
|
| 8857 | </aside>
|
| 8858 | </section>
|
| 8859 | </section>
|
| 8860 | <section class="tsd-panel tsd-member tsd-kind-object-literal tsd-parent-kind-object-literal tsd-is-not-exported">
|
| 8861 | <a name="schemadefinition.properties.givenname" class="tsd-anchor"></a>
|
| 8862 | <h3>given<wbr>Name</h3>
|
| 8863 | <div class="tsd-signature tsd-kind-icon">given<wbr>Name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
|
| 8864 | <aside class="tsd-sources">
|
| 8865 | <ul>
|
| 8866 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/person.ts#L21">profiles/profileSchemas/person.ts:21</a></li>
|
| 8867 | </ul>
|
| 8868 | </aside>
|
| 8869 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal tsd-is-not-exported">
|
| 8870 | <a name="schemadefinition.properties.givenname.optional-17" class="tsd-anchor"></a>
|
| 8871 | <h3>optional</h3>
|
| 8872 | <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>
|
| 8873 | <aside class="tsd-sources">
|
| 8874 | <ul>
|
| 8875 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/person.ts#L21">profiles/profileSchemas/person.ts:21</a></li>
|
| 8876 | </ul>
|
| 8877 | </aside>
|
| 8878 | </section>
|
| 8879 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal tsd-is-not-exported">
|
| 8880 | <a name="schemadefinition.properties.givenname.type-22" class="tsd-anchor"></a>
|
| 8881 | <h3>type</h3>
|
| 8882 | <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>
|
| 8883 | <aside class="tsd-sources">
|
| 8884 | <ul>
|
| 8885 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/person.ts#L21">profiles/profileSchemas/person.ts:21</a></li>
|
| 8886 | </ul>
|
| 8887 | </aside>
|
| 8888 | </section>
|
| 8889 | </section>
|
| 8890 | <section class="tsd-panel tsd-member tsd-kind-object-literal tsd-parent-kind-object-literal tsd-is-not-exported">
|
| 8891 | <a name="schemadefinition.properties.image" class="tsd-anchor"></a>
|
| 8892 | <h3>image</h3>
|
| 8893 | <div class="tsd-signature tsd-kind-icon">image<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
|
| 8894 | <aside class="tsd-sources">
|
| 8895 | <ul>
|
| 8896 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/person.ts#L24">profiles/profileSchemas/person.ts:24</a></li>
|
| 8897 | </ul>
|
| 8898 | </aside>
|
| 8899 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal tsd-is-not-exported">
|
| 8900 | <a name="schemadefinition.properties.image.optional-18" class="tsd-anchor"></a>
|
| 8901 | <h3>optional</h3>
|
| 8902 | <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>
|
| 8903 | <aside class="tsd-sources">
|
| 8904 | <ul>
|
| 8905 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/person.ts#L26">profiles/profileSchemas/person.ts:26</a></li>
|
| 8906 | </ul>
|
| 8907 | </aside>
|
| 8908 | </section>
|
| 8909 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal tsd-is-not-exported">
|
| 8910 | <a name="schemadefinition.properties.image.type-23" class="tsd-anchor"></a>
|
| 8911 | <h3>type</h3>
|
| 8912 | <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>
|
| 8913 | <aside class="tsd-sources">
|
| 8914 | <ul>
|
| 8915 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/person.ts#L25">profiles/profileSchemas/person.ts:25</a></li>
|
| 8916 | </ul>
|
| 8917 | </aside>
|
| 8918 | </section>
|
| 8919 | <section class="tsd-panel tsd-member tsd-kind-object-literal tsd-parent-kind-object-literal tsd-is-not-exported">
|
| 8920 | <a name="schemadefinition.properties.image.items-1" class="tsd-anchor"></a>
|
| 8921 | <h3>items</h3>
|
| 8922 | <div class="tsd-signature tsd-kind-icon">items<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
|
| 8923 | <aside class="tsd-sources">
|
| 8924 | <ul>
|
| 8925 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/person.ts#L27">profiles/profileSchemas/person.ts:27</a></li>
|
| 8926 | </ul>
|
| 8927 | </aside>
|
| 8928 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal tsd-is-not-exported">
|
| 8929 | <a name="schemadefinition.properties.image.items-1.type-24" class="tsd-anchor"></a>
|
| 8930 | <h3>type</h3>
|
| 8931 | <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>
|
| 8932 | <aside class="tsd-sources">
|
| 8933 | <ul>
|
| 8934 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/person.ts#L28">profiles/profileSchemas/person.ts:28</a></li>
|
| 8935 | </ul>
|
| 8936 | </aside>
|
| 8937 | </section>
|
| 8938 | <section class="tsd-panel tsd-member tsd-kind-object-literal tsd-parent-kind-object-literal tsd-is-not-exported">
|
| 8939 | <a name="schemadefinition.properties.image.items-1.properties-3" class="tsd-anchor"></a>
|
| 8940 | <h3>properties</h3>
|
| 8941 | <div class="tsd-signature tsd-kind-icon">properties<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
|
| 8942 | <aside class="tsd-sources">
|
| 8943 | <ul>
|
| 8944 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/person.ts#L29">profiles/profileSchemas/person.ts:29</a></li>
|
| 8945 | </ul>
|
| 8946 | </aside>
|
| 8947 | <section class="tsd-panel tsd-member tsd-kind-object-literal tsd-parent-kind-object-literal tsd-is-not-exported">
|
| 8948 | <a name="schemadefinition.properties.image.items-1.properties-3._type-3" class="tsd-anchor"></a>
|
| 8949 | <h3>@type</h3>
|
| 8950 | <div class="tsd-signature tsd-kind-icon">@type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
|
| 8951 | <aside class="tsd-sources">
|
| 8952 | <ul>
|
| 8953 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/person.ts#L30">profiles/profileSchemas/person.ts:30</a></li>
|
| 8954 | </ul>
|
| 8955 | </aside>
|
| 8956 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal tsd-is-not-exported">
|
| 8957 | <a name="schemadefinition.properties.image.items-1.properties-3._type-3.type-25" class="tsd-anchor"></a>
|
| 8958 | <h3>type</h3>
|
| 8959 | <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>
|
| 8960 | <aside class="tsd-sources">
|
| 8961 | <ul>
|
| 8962 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/person.ts#L30">profiles/profileSchemas/person.ts:30</a></li>
|
| 8963 | </ul>
|
| 8964 | </aside>
|
| 8965 | </section>
|
| 8966 | </section>
|
| 8967 | <section class="tsd-panel tsd-member tsd-kind-object-literal tsd-parent-kind-object-literal tsd-is-not-exported">
|
| 8968 | <a name="schemadefinition.properties.image.items-1.properties-3.contenturl" class="tsd-anchor"></a>
|
| 8969 | <h3>content<wbr>Url</h3>
|
| 8970 | <div class="tsd-signature tsd-kind-icon">content<wbr>Url<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
|
| 8971 | <aside class="tsd-sources">
|
| 8972 | <ul>
|
| 8973 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/person.ts#L32">profiles/profileSchemas/person.ts:32</a></li>
|
| 8974 | </ul>
|
| 8975 | </aside>
|
| 8976 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal tsd-is-not-exported">
|
| 8977 | <a name="schemadefinition.properties.image.items-1.properties-3.contenturl.optional-19" class="tsd-anchor"></a>
|
| 8978 | <h3>optional</h3>
|
| 8979 | <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>
|
| 8980 | <aside class="tsd-sources">
|
| 8981 | <ul>
|
| 8982 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/person.ts#L32">profiles/profileSchemas/person.ts:32</a></li>
|
| 8983 | </ul>
|
| 8984 | </aside>
|
| 8985 | </section>
|
| 8986 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal tsd-is-not-exported">
|
| 8987 | <a name="schemadefinition.properties.image.items-1.properties-3.contenturl.type-26" class="tsd-anchor"></a>
|
| 8988 | <h3>type</h3>
|
| 8989 | <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>
|
| 8990 | <aside class="tsd-sources">
|
| 8991 | <ul>
|
| 8992 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/person.ts#L32">profiles/profileSchemas/person.ts:32</a></li>
|
| 8993 | </ul>
|
| 8994 | </aside>
|
| 8995 | </section>
|
| 8996 | </section>
|
| 8997 | <section class="tsd-panel tsd-member tsd-kind-object-literal tsd-parent-kind-object-literal tsd-is-not-exported">
|
| 8998 | <a name="schemadefinition.properties.image.items-1.properties-3.name" class="tsd-anchor"></a>
|
| 8999 | <h3>name</h3>
|
| 9000 | <div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
|
| 9001 | <aside class="tsd-sources">
|
| 9002 | <ul>
|
| 9003 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/person.ts#L31">profiles/profileSchemas/person.ts:31</a></li>
|
| 9004 | </ul>
|
| 9005 | </aside>
|
| 9006 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal tsd-is-not-exported">
|
| 9007 | <a name="schemadefinition.properties.image.items-1.properties-3.name.optional-20" class="tsd-anchor"></a>
|
| 9008 | <h3>optional</h3>
|
| 9009 | <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>
|
| 9010 | <aside class="tsd-sources">
|
| 9011 | <ul>
|
| 9012 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/person.ts#L31">profiles/profileSchemas/person.ts:31</a></li>
|
| 9013 | </ul>
|
| 9014 | </aside>
|
| 9015 | </section>
|
| 9016 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal tsd-is-not-exported">
|
| 9017 | <a name="schemadefinition.properties.image.items-1.properties-3.name.type-27" class="tsd-anchor"></a>
|
| 9018 | <h3>type</h3>
|
| 9019 | <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>
|
| 9020 | <aside class="tsd-sources">
|
| 9021 | <ul>
|
| 9022 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/person.ts#L31">profiles/profileSchemas/person.ts:31</a></li>
|
| 9023 | </ul>
|
| 9024 | </aside>
|
| 9025 | </section>
|
| 9026 | </section>
|
| 9027 | </section>
|
| 9028 | </section>
|
| 9029 | </section>
|
| 9030 | <section class="tsd-panel tsd-member tsd-kind-object-literal tsd-parent-kind-object-literal tsd-is-not-exported">
|
| 9031 | <a name="schemadefinition.properties.knows" class="tsd-anchor"></a>
|
| 9032 | <h3>knows</h3>
|
| 9033 | <div class="tsd-signature tsd-kind-icon">knows<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
|
| 9034 | <aside class="tsd-sources">
|
| 9035 | <ul>
|
| 9036 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/person.ts#L74">profiles/profileSchemas/person.ts:74</a></li>
|
| 9037 | </ul>
|
| 9038 | </aside>
|
| 9039 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal tsd-is-not-exported">
|
| 9040 | <a name="schemadefinition.properties.knows.optional-21" class="tsd-anchor"></a>
|
| 9041 | <h3>optional</h3>
|
| 9042 | <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>
|
| 9043 | <aside class="tsd-sources">
|
| 9044 | <ul>
|
| 9045 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/person.ts#L76">profiles/profileSchemas/person.ts:76</a></li>
|
| 9046 | </ul>
|
| 9047 | </aside>
|
| 9048 | </section>
|
| 9049 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal tsd-is-not-exported">
|
| 9050 | <a name="schemadefinition.properties.knows.type-28" class="tsd-anchor"></a>
|
| 9051 | <h3>type</h3>
|
| 9052 | <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>
|
| 9053 | <aside class="tsd-sources">
|
| 9054 | <ul>
|
| 9055 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/person.ts#L75">profiles/profileSchemas/person.ts:75</a></li>
|
| 9056 | </ul>
|
| 9057 | </aside>
|
| 9058 | </section>
|
| 9059 | <section class="tsd-panel tsd-member tsd-kind-object-literal tsd-parent-kind-object-literal tsd-is-not-exported">
|
| 9060 | <a name="schemadefinition.properties.knows.items-2" class="tsd-anchor"></a>
|
| 9061 | <h3>items</h3>
|
| 9062 | <div class="tsd-signature tsd-kind-icon">items<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
|
| 9063 | <aside class="tsd-sources">
|
| 9064 | <ul>
|
| 9065 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/person.ts#L77">profiles/profileSchemas/person.ts:77</a></li>
|
| 9066 | </ul>
|
| 9067 | </aside>
|
| 9068 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal tsd-is-not-exported">
|
| 9069 | <a name="schemadefinition.properties.knows.items-2.type-29" class="tsd-anchor"></a>
|
| 9070 | <h3>type</h3>
|
| 9071 | <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>
|
| 9072 | <aside class="tsd-sources">
|
| 9073 | <ul>
|
| 9074 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/person.ts#L78">profiles/profileSchemas/person.ts:78</a></li>
|
| 9075 | </ul>
|
| 9076 | </aside>
|
| 9077 | </section>
|
| 9078 | <section class="tsd-panel tsd-member tsd-kind-object-literal tsd-parent-kind-object-literal tsd-is-not-exported">
|
| 9079 | <a name="schemadefinition.properties.knows.items-2.properties-4" class="tsd-anchor"></a>
|
| 9080 | <h3>properties</h3>
|
| 9081 | <div class="tsd-signature tsd-kind-icon">properties<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
|
| 9082 | <aside class="tsd-sources">
|
| 9083 | <ul>
|
| 9084 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/person.ts#L79">profiles/profileSchemas/person.ts:79</a></li>
|
| 9085 | </ul>
|
| 9086 | </aside>
|
| 9087 | <section class="tsd-panel tsd-member tsd-kind-object-literal tsd-parent-kind-object-literal tsd-is-not-exported">
|
| 9088 | <a name="schemadefinition.properties.knows.items-2.properties-4._id-1" class="tsd-anchor"></a>
|
| 9089 | <h3>@id</h3>
|
| 9090 | <div class="tsd-signature tsd-kind-icon">@id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
|
| 9091 | <aside class="tsd-sources">
|
| 9092 | <ul>
|
| 9093 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/person.ts#L81">profiles/profileSchemas/person.ts:81</a></li>
|
| 9094 | </ul>
|
| 9095 | </aside>
|
| 9096 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal tsd-is-not-exported">
|
| 9097 | <a name="schemadefinition.properties.knows.items-2.properties-4._id-1.optional-22" class="tsd-anchor"></a>
|
| 9098 | <h3>optional</h3>
|
| 9099 | <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>
|
| 9100 | <aside class="tsd-sources">
|
| 9101 | <ul>
|
| 9102 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/person.ts#L81">profiles/profileSchemas/person.ts:81</a></li>
|
| 9103 | </ul>
|
| 9104 | </aside>
|
| 9105 | </section>
|
| 9106 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal tsd-is-not-exported">
|
| 9107 | <a name="schemadefinition.properties.knows.items-2.properties-4._id-1.type-30" class="tsd-anchor"></a>
|
| 9108 | <h3>type</h3>
|
| 9109 | <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>
|
| 9110 | <aside class="tsd-sources">
|
| 9111 | <ul>
|
| 9112 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/person.ts#L81">profiles/profileSchemas/person.ts:81</a></li>
|
| 9113 | </ul>
|
| 9114 | </aside>
|
| 9115 | </section>
|
| 9116 | </section>
|
| 9117 | <section class="tsd-panel tsd-member tsd-kind-object-literal tsd-parent-kind-object-literal tsd-is-not-exported">
|
| 9118 | <a name="schemadefinition.properties.knows.items-2.properties-4._type-4" class="tsd-anchor"></a>
|
| 9119 | <h3>@type</h3>
|
| 9120 | <div class="tsd-signature tsd-kind-icon">@type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
|
| 9121 | <aside class="tsd-sources">
|
| 9122 | <ul>
|
| 9123 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/person.ts#L80">profiles/profileSchemas/person.ts:80</a></li>
|
| 9124 | </ul>
|
| 9125 | </aside>
|
| 9126 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal tsd-is-not-exported">
|
| 9127 | <a name="schemadefinition.properties.knows.items-2.properties-4._type-4.type-31" class="tsd-anchor"></a>
|
| 9128 | <h3>type</h3>
|
| 9129 | <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>
|
| 9130 | <aside class="tsd-sources">
|
| 9131 | <ul>
|
| 9132 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/person.ts#L80">profiles/profileSchemas/person.ts:80</a></li>
|
| 9133 | </ul>
|
| 9134 | </aside>
|
| 9135 | </section>
|
| 9136 | </section>
|
| 9137 | </section>
|
| 9138 | </section>
|
| 9139 | </section>
|
| 9140 | <section class="tsd-panel tsd-member tsd-kind-object-literal tsd-parent-kind-object-literal tsd-is-not-exported">
|
| 9141 | <a name="schemadefinition.properties.name-1" class="tsd-anchor"></a>
|
| 9142 | <h3>name</h3>
|
| 9143 | <div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
|
| 9144 | <aside class="tsd-sources">
|
| 9145 | <ul>
|
| 9146 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/person.ts#L20">profiles/profileSchemas/person.ts:20</a></li>
|
| 9147 | </ul>
|
| 9148 | </aside>
|
| 9149 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal tsd-is-not-exported">
|
| 9150 | <a name="schemadefinition.properties.name-1.optional-23" class="tsd-anchor"></a>
|
| 9151 | <h3>optional</h3>
|
| 9152 | <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>
|
| 9153 | <aside class="tsd-sources">
|
| 9154 | <ul>
|
| 9155 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/person.ts#L20">profiles/profileSchemas/person.ts:20</a></li>
|
| 9156 | </ul>
|
| 9157 | </aside>
|
| 9158 | </section>
|
| 9159 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal tsd-is-not-exported">
|
| 9160 | <a name="schemadefinition.properties.name-1.type-32" class="tsd-anchor"></a>
|
| 9161 | <h3>type</h3>
|
| 9162 | <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>
|
| 9163 | <aside class="tsd-sources">
|
| 9164 | <ul>
|
| 9165 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/person.ts#L20">profiles/profileSchemas/person.ts:20</a></li>
|
| 9166 | </ul>
|
| 9167 | </aside>
|
| 9168 | </section>
|
| 9169 | </section>
|
| 9170 | <section class="tsd-panel tsd-member tsd-kind-object-literal tsd-parent-kind-object-literal tsd-is-not-exported">
|
| 9171 | <a name="schemadefinition.properties.taxid" class="tsd-anchor"></a>
|
| 9172 | <h3>taxID</h3>
|
| 9173 | <div class="tsd-signature tsd-kind-icon">taxID<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
|
| 9174 | <aside class="tsd-sources">
|
| 9175 | <ul>
|
| 9176 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/person.ts#L97">profiles/profileSchemas/person.ts:97</a></li>
|
| 9177 | </ul>
|
| 9178 | </aside>
|
| 9179 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal tsd-is-not-exported">
|
| 9180 | <a name="schemadefinition.properties.taxid.optional-24" class="tsd-anchor"></a>
|
| 9181 | <h3>optional</h3>
|
| 9182 | <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>
|
| 9183 | <aside class="tsd-sources">
|
| 9184 | <ul>
|
| 9185 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/person.ts#L97">profiles/profileSchemas/person.ts:97</a></li>
|
| 9186 | </ul>
|
| 9187 | </aside>
|
| 9188 | </section>
|
| 9189 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal tsd-is-not-exported">
|
| 9190 | <a name="schemadefinition.properties.taxid.type-33" class="tsd-anchor"></a>
|
| 9191 | <h3>type</h3>
|
| 9192 | <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>
|
| 9193 | <aside class="tsd-sources">
|
| 9194 | <ul>
|
| 9195 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/person.ts#L97">profiles/profileSchemas/person.ts:97</a></li>
|
| 9196 | </ul>
|
| 9197 | </aside>
|
| 9198 | </section>
|
| 9199 | </section>
|
| 9200 | <section class="tsd-panel tsd-member tsd-kind-object-literal tsd-parent-kind-object-literal tsd-is-not-exported">
|
| 9201 | <a name="schemadefinition.properties.website" class="tsd-anchor"></a>
|
| 9202 | <h3>website</h3>
|
| 9203 | <div class="tsd-signature tsd-kind-icon">website<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
|
| 9204 | <aside class="tsd-sources">
|
| 9205 | <ul>
|
| 9206 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/person.ts#L36">profiles/profileSchemas/person.ts:36</a></li>
|
| 9207 | </ul>
|
| 9208 | </aside>
|
| 9209 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal tsd-is-not-exported">
|
| 9210 | <a name="schemadefinition.properties.website.optional-25" class="tsd-anchor"></a>
|
| 9211 | <h3>optional</h3>
|
| 9212 | <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>
|
| 9213 | <aside class="tsd-sources">
|
| 9214 | <ul>
|
| 9215 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/person.ts#L38">profiles/profileSchemas/person.ts:38</a></li>
|
| 9216 | </ul>
|
| 9217 | </aside>
|
| 9218 | </section>
|
| 9219 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal tsd-is-not-exported">
|
| 9220 | <a name="schemadefinition.properties.website.type-34" class="tsd-anchor"></a>
|
| 9221 | <h3>type</h3>
|
| 9222 | <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>
|
| 9223 | <aside class="tsd-sources">
|
| 9224 | <ul>
|
| 9225 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/person.ts#L37">profiles/profileSchemas/person.ts:37</a></li>
|
| 9226 | </ul>
|
| 9227 | </aside>
|
| 9228 | </section>
|
| 9229 | <section class="tsd-panel tsd-member tsd-kind-object-literal tsd-parent-kind-object-literal tsd-is-not-exported">
|
| 9230 | <a name="schemadefinition.properties.website.items-3" class="tsd-anchor"></a>
|
| 9231 | <h3>items</h3>
|
| 9232 | <div class="tsd-signature tsd-kind-icon">items<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
|
| 9233 | <aside class="tsd-sources">
|
| 9234 | <ul>
|
| 9235 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/person.ts#L39">profiles/profileSchemas/person.ts:39</a></li>
|
| 9236 | </ul>
|
| 9237 | </aside>
|
| 9238 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal tsd-is-not-exported">
|
| 9239 | <a name="schemadefinition.properties.website.items-3.type-35" class="tsd-anchor"></a>
|
| 9240 | <h3>type</h3>
|
| 9241 | <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>
|
| 9242 | <aside class="tsd-sources">
|
| 9243 | <ul>
|
| 9244 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/person.ts#L40">profiles/profileSchemas/person.ts:40</a></li>
|
| 9245 | </ul>
|
| 9246 | </aside>
|
| 9247 | </section>
|
| 9248 | <section class="tsd-panel tsd-member tsd-kind-object-literal tsd-parent-kind-object-literal tsd-is-not-exported">
|
| 9249 | <a name="schemadefinition.properties.website.items-3.properties-5" class="tsd-anchor"></a>
|
| 9250 | <h3>properties</h3>
|
| 9251 | <div class="tsd-signature tsd-kind-icon">properties<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
|
| 9252 | <aside class="tsd-sources">
|
| 9253 | <ul>
|
| 9254 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/person.ts#L41">profiles/profileSchemas/person.ts:41</a></li>
|
| 9255 | </ul>
|
| 9256 | </aside>
|
| 9257 | <section class="tsd-panel tsd-member tsd-kind-object-literal tsd-parent-kind-object-literal tsd-is-not-exported">
|
| 9258 | <a name="schemadefinition.properties.website.items-3.properties-5._type-5" class="tsd-anchor"></a>
|
| 9259 | <h3>@type</h3>
|
| 9260 | <div class="tsd-signature tsd-kind-icon">@type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
|
| 9261 | <aside class="tsd-sources">
|
| 9262 | <ul>
|
| 9263 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/person.ts#L42">profiles/profileSchemas/person.ts:42</a></li>
|
| 9264 | </ul>
|
| 9265 | </aside>
|
| 9266 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal tsd-is-not-exported">
|
| 9267 | <a name="schemadefinition.properties.website.items-3.properties-5._type-5.type-36" class="tsd-anchor"></a>
|
| 9268 | <h3>type</h3>
|
| 9269 | <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>
|
| 9270 | <aside class="tsd-sources">
|
| 9271 | <ul>
|
| 9272 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/person.ts#L42">profiles/profileSchemas/person.ts:42</a></li>
|
| 9273 | </ul>
|
| 9274 | </aside>
|
| 9275 | </section>
|
| 9276 | </section>
|
| 9277 | <section class="tsd-panel tsd-member tsd-kind-object-literal tsd-parent-kind-object-literal tsd-is-not-exported">
|
| 9278 | <a name="schemadefinition.properties.website.items-3.properties-5.url" class="tsd-anchor"></a>
|
| 9279 | <h3>url</h3>
|
| 9280 | <div class="tsd-signature tsd-kind-icon">url<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
|
| 9281 | <aside class="tsd-sources">
|
| 9282 | <ul>
|
| 9283 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/person.ts#L43">profiles/profileSchemas/person.ts:43</a></li>
|
| 9284 | </ul>
|
| 9285 | </aside>
|
| 9286 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal tsd-is-not-exported">
|
| 9287 | <a name="schemadefinition.properties.website.items-3.properties-5.url.optional-26" class="tsd-anchor"></a>
|
| 9288 | <h3>optional</h3>
|
| 9289 | <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>
|
| 9290 | <aside class="tsd-sources">
|
| 9291 | <ul>
|
| 9292 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/person.ts#L43">profiles/profileSchemas/person.ts:43</a></li>
|
| 9293 | </ul>
|
| 9294 | </aside>
|
| 9295 | </section>
|
| 9296 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal tsd-is-not-exported">
|
| 9297 | <a name="schemadefinition.properties.website.items-3.properties-5.url.type-37" class="tsd-anchor"></a>
|
| 9298 | <h3>type</h3>
|
| 9299 | <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>
|
| 9300 | <aside class="tsd-sources">
|
| 9301 | <ul>
|
| 9302 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/person.ts#L43">profiles/profileSchemas/person.ts:43</a></li>
|
| 9303 | </ul>
|
| 9304 | </aside>
|
| 9305 | </section>
|
| 9306 | </section>
|
| 9307 | </section>
|
| 9308 | </section>
|
| 9309 | </section>
|
| 9310 | <section class="tsd-panel tsd-member tsd-kind-object-literal tsd-parent-kind-object-literal tsd-is-not-exported">
|
| 9311 | <a name="schemadefinition.properties.worksfor" class="tsd-anchor"></a>
|
| 9312 | <h3>works<wbr>For</h3>
|
| 9313 | <div class="tsd-signature tsd-kind-icon">works<wbr>For<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
|
| 9314 | <aside class="tsd-sources">
|
| 9315 | <ul>
|
| 9316 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/person.ts#L63">profiles/profileSchemas/person.ts:63</a></li>
|
| 9317 | </ul>
|
| 9318 | </aside>
|
| 9319 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal tsd-is-not-exported">
|
| 9320 | <a name="schemadefinition.properties.worksfor.optional-27" class="tsd-anchor"></a>
|
| 9321 | <h3>optional</h3>
|
| 9322 | <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>
|
| 9323 | <aside class="tsd-sources">
|
| 9324 | <ul>
|
| 9325 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/person.ts#L65">profiles/profileSchemas/person.ts:65</a></li>
|
| 9326 | </ul>
|
| 9327 | </aside>
|
| 9328 | </section>
|
| 9329 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal tsd-is-not-exported">
|
| 9330 | <a name="schemadefinition.properties.worksfor.type-38" class="tsd-anchor"></a>
|
| 9331 | <h3>type</h3>
|
| 9332 | <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>
|
| 9333 | <aside class="tsd-sources">
|
| 9334 | <ul>
|
| 9335 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/person.ts#L64">profiles/profileSchemas/person.ts:64</a></li>
|
| 9336 | </ul>
|
| 9337 | </aside>
|
| 9338 | </section>
|
| 9339 | <section class="tsd-panel tsd-member tsd-kind-object-literal tsd-parent-kind-object-literal tsd-is-not-exported">
|
| 9340 | <a name="schemadefinition.properties.worksfor.items-4" class="tsd-anchor"></a>
|
| 9341 | <h3>items</h3>
|
| 9342 | <div class="tsd-signature tsd-kind-icon">items<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
|
| 9343 | <aside class="tsd-sources">
|
| 9344 | <ul>
|
| 9345 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/person.ts#L66">profiles/profileSchemas/person.ts:66</a></li>
|
| 9346 | </ul>
|
| 9347 | </aside>
|
| 9348 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal tsd-is-not-exported">
|
| 9349 | <a name="schemadefinition.properties.worksfor.items-4.type-39" class="tsd-anchor"></a>
|
| 9350 | <h3>type</h3>
|
| 9351 | <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>
|
| 9352 | <aside class="tsd-sources">
|
| 9353 | <ul>
|
| 9354 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/person.ts#L67">profiles/profileSchemas/person.ts:67</a></li>
|
| 9355 | </ul>
|
| 9356 | </aside>
|
| 9357 | </section>
|
| 9358 | <section class="tsd-panel tsd-member tsd-kind-object-literal tsd-parent-kind-object-literal tsd-is-not-exported">
|
| 9359 | <a name="schemadefinition.properties.worksfor.items-4.properties-6" class="tsd-anchor"></a>
|
| 9360 | <h3>properties</h3>
|
| 9361 | <div class="tsd-signature tsd-kind-icon">properties<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
|
| 9362 | <aside class="tsd-sources">
|
| 9363 | <ul>
|
| 9364 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/person.ts#L68">profiles/profileSchemas/person.ts:68</a></li>
|
| 9365 | </ul>
|
| 9366 | </aside>
|
| 9367 | <section class="tsd-panel tsd-member tsd-kind-object-literal tsd-parent-kind-object-literal tsd-is-not-exported">
|
| 9368 | <a name="schemadefinition.properties.worksfor.items-4.properties-6._id-2" class="tsd-anchor"></a>
|
| 9369 | <h3>@id</h3>
|
| 9370 | <div class="tsd-signature tsd-kind-icon">@id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
|
| 9371 | <aside class="tsd-sources">
|
| 9372 | <ul>
|
| 9373 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/person.ts#L70">profiles/profileSchemas/person.ts:70</a></li>
|
| 9374 | </ul>
|
| 9375 | </aside>
|
| 9376 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal tsd-is-not-exported">
|
| 9377 | <a name="schemadefinition.properties.worksfor.items-4.properties-6._id-2.optional-28" class="tsd-anchor"></a>
|
| 9378 | <h3>optional</h3>
|
| 9379 | <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>
|
| 9380 | <aside class="tsd-sources">
|
| 9381 | <ul>
|
| 9382 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/person.ts#L70">profiles/profileSchemas/person.ts:70</a></li>
|
| 9383 | </ul>
|
| 9384 | </aside>
|
| 9385 | </section>
|
| 9386 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal tsd-is-not-exported">
|
| 9387 | <a name="schemadefinition.properties.worksfor.items-4.properties-6._id-2.type-40" class="tsd-anchor"></a>
|
| 9388 | <h3>type</h3>
|
| 9389 | <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>
|
| 9390 | <aside class="tsd-sources">
|
| 9391 | <ul>
|
| 9392 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/person.ts#L70">profiles/profileSchemas/person.ts:70</a></li>
|
| 9393 | </ul>
|
| 9394 | </aside>
|
| 9395 | </section>
|
| 9396 | </section>
|
| 9397 | <section class="tsd-panel tsd-member tsd-kind-object-literal tsd-parent-kind-object-literal tsd-is-not-exported">
|
| 9398 | <a name="schemadefinition.properties.worksfor.items-4.properties-6._type-6" class="tsd-anchor"></a>
|
| 9399 | <h3>@type</h3>
|
| 9400 | <div class="tsd-signature tsd-kind-icon">@type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
|
| 9401 | <aside class="tsd-sources">
|
| 9402 | <ul>
|
| 9403 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/person.ts#L69">profiles/profileSchemas/person.ts:69</a></li>
|
| 9404 | </ul>
|
| 9405 | </aside>
|
| 9406 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal tsd-is-not-exported">
|
| 9407 | <a name="schemadefinition.properties.worksfor.items-4.properties-6._type-6.type-41" class="tsd-anchor"></a>
|
| 9408 | <h3>type</h3>
|
| 9409 | <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>
|
| 9410 | <aside class="tsd-sources">
|
| 9411 | <ul>
|
| 9412 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/profiles/profileSchemas/person.ts#L69">profiles/profileSchemas/person.ts:69</a></li>
|
| 9413 | </ul>
|
| 9414 | </aside>
|
| 9415 | </section>
|
| 9416 | </section>
|
| 9417 | </section>
|
| 9418 | </section>
|
| 9419 | </section>
|
| 9420 | </section>
|
| 9421 | </section>
|
| 9422 | <section class="tsd-panel tsd-member tsd-kind-object-literal">
|
| 9423 | <a name="transactions" class="tsd-anchor"></a>
|
| 9424 | <h3><span class="tsd-flag ts-flagConst">Const</span> transactions</h3>
|
| 9425 | <div class="tsd-signature tsd-kind-icon">transactions<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
|
| 9426 | <aside class="tsd-sources">
|
| 9427 | <ul>
|
| 9428 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/operations/txbuild.ts#L1181">operations/txbuild.ts:1181</a></li>
|
| 9429 | </ul>
|
| 9430 | </aside>
|
| 9431 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
| 9432 | <a name="transactions.blockstacknamespace" class="tsd-anchor"></a>
|
| 9433 | <h3>Blockstack<wbr>Namespace</h3>
|
| 9434 | <div class="tsd-signature tsd-kind-icon">Blockstack<wbr>Namespace<span class="tsd-signature-symbol">:</span> <a href="classes/blockstacknamespace.html" class="tsd-signature-type">BlockstackNamespace</a></div>
|
| 9435 | <aside class="tsd-sources">
|
| 9436 | <ul>
|
| 9437 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/operations/txbuild.ts#L1195">operations/txbuild.ts:1195</a></li>
|
| 9438 | </ul>
|
| 9439 | </aside>
|
| 9440 | </section>
|
| 9441 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
| 9442 | <a name="transactions.estimateannounce" class="tsd-anchor"></a>
|
| 9443 | <h3>estimate<wbr>Announce</h3>
|
| 9444 | <div class="tsd-signature tsd-kind-icon">estimate<wbr>Announce<span class="tsd-signature-symbol">:</span> <a href="globals.html#estimateannounce" class="tsd-signature-type">estimateAnnounce</a></div>
|
| 9445 | <aside class="tsd-sources">
|
| 9446 | <ul>
|
| 9447 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/operations/txbuild.ts#L1206">operations/txbuild.ts:1206</a></li>
|
| 9448 | </ul>
|
| 9449 | </aside>
|
| 9450 | </section>
|
| 9451 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
| 9452 | <a name="transactions.estimatenameimport" class="tsd-anchor"></a>
|
| 9453 | <h3>estimate<wbr>Name<wbr>Import</h3>
|
| 9454 | <div class="tsd-signature tsd-kind-icon">estimate<wbr>Name<wbr>Import<span class="tsd-signature-symbol">:</span> <a href="globals.html#estimatenameimport" class="tsd-signature-type">estimateNameImport</a></div>
|
| 9455 | <aside class="tsd-sources">
|
| 9456 | <ul>
|
| 9457 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/operations/txbuild.ts#L1205">operations/txbuild.ts:1205</a></li>
|
| 9458 | </ul>
|
| 9459 | </aside>
|
| 9460 | </section>
|
| 9461 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
| 9462 | <a name="transactions.estimatenamespacepreorder" class="tsd-anchor"></a>
|
| 9463 | <h3>estimate<wbr>Namespace<wbr>Preorder</h3>
|
| 9464 | <div class="tsd-signature tsd-kind-icon">estimate<wbr>Namespace<wbr>Preorder<span class="tsd-signature-symbol">:</span> <a href="globals.html#estimatenamespacepreorder" class="tsd-signature-type">estimateNamespacePreorder</a></div>
|
| 9465 | <aside class="tsd-sources">
|
| 9466 | <ul>
|
| 9467 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/operations/txbuild.ts#L1202">operations/txbuild.ts:1202</a></li>
|
| 9468 | </ul>
|
| 9469 | </aside>
|
| 9470 | </section>
|
| 9471 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
| 9472 | <a name="transactions.estimatenamespaceready" class="tsd-anchor"></a>
|
| 9473 | <h3>estimate<wbr>Namespace<wbr>Ready</h3>
|
| 9474 | <div class="tsd-signature tsd-kind-icon">estimate<wbr>Namespace<wbr>Ready<span class="tsd-signature-symbol">:</span> <a href="globals.html#estimatenamespaceready" class="tsd-signature-type">estimateNamespaceReady</a></div>
|
| 9475 | <aside class="tsd-sources">
|
| 9476 | <ul>
|
| 9477 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/operations/txbuild.ts#L1204">operations/txbuild.ts:1204</a></li>
|
| 9478 | </ul>
|
| 9479 | </aside>
|
| 9480 | </section>
|
| 9481 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
| 9482 | <a name="transactions.estimatenamespacereveal" class="tsd-anchor"></a>
|
| 9483 | <h3>estimate<wbr>Namespace<wbr>Reveal</h3>
|
| 9484 | <div class="tsd-signature tsd-kind-icon">estimate<wbr>Namespace<wbr>Reveal<span class="tsd-signature-symbol">:</span> <a href="globals.html#estimatenamespacereveal" class="tsd-signature-type">estimateNamespaceReveal</a></div>
|
| 9485 | <aside class="tsd-sources">
|
| 9486 | <ul>
|
| 9487 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/operations/txbuild.ts#L1203">operations/txbuild.ts:1203</a></li>
|
| 9488 | </ul>
|
| 9489 | </aside>
|
| 9490 | </section>
|
| 9491 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
| 9492 | <a name="transactions.estimatepreorder" class="tsd-anchor"></a>
|
| 9493 | <h3>estimate<wbr>Preorder</h3>
|
| 9494 | <div class="tsd-signature tsd-kind-icon">estimate<wbr>Preorder<span class="tsd-signature-symbol">:</span> <a href="globals.html#estimatepreorder" class="tsd-signature-type">estimatePreorder</a></div>
|
| 9495 | <aside class="tsd-sources">
|
| 9496 | <ul>
|
| 9497 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/operations/txbuild.ts#L1196">operations/txbuild.ts:1196</a></li>
|
| 9498 | </ul>
|
| 9499 | </aside>
|
| 9500 | </section>
|
| 9501 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
| 9502 | <a name="transactions.estimateregister" class="tsd-anchor"></a>
|
| 9503 | <h3>estimate<wbr>Register</h3>
|
| 9504 | <div class="tsd-signature tsd-kind-icon">estimate<wbr>Register<span class="tsd-signature-symbol">:</span> <a href="globals.html#estimateregister" class="tsd-signature-type">estimateRegister</a></div>
|
| 9505 | <aside class="tsd-sources">
|
| 9506 | <ul>
|
| 9507 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/operations/txbuild.ts#L1197">operations/txbuild.ts:1197</a></li>
|
| 9508 | </ul>
|
| 9509 | </aside>
|
| 9510 | </section>
|
| 9511 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
| 9512 | <a name="transactions.estimaterenewal" class="tsd-anchor"></a>
|
| 9513 | <h3>estimate<wbr>Renewal</h3>
|
| 9514 | <div class="tsd-signature tsd-kind-icon">estimate<wbr>Renewal<span class="tsd-signature-symbol">:</span> <a href="globals.html#estimaterenewal" class="tsd-signature-type">estimateRenewal</a></div>
|
| 9515 | <aside class="tsd-sources">
|
| 9516 | <ul>
|
| 9517 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/operations/txbuild.ts#L1200">operations/txbuild.ts:1200</a></li>
|
| 9518 | </ul>
|
| 9519 | </aside>
|
| 9520 | </section>
|
| 9521 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
| 9522 | <a name="transactions.estimaterevoke" class="tsd-anchor"></a>
|
| 9523 | <h3>estimate<wbr>Revoke</h3>
|
| 9524 | <div class="tsd-signature tsd-kind-icon">estimate<wbr>Revoke<span class="tsd-signature-symbol">:</span> <a href="globals.html#estimaterevoke" class="tsd-signature-type">estimateRevoke</a></div>
|
| 9525 | <aside class="tsd-sources">
|
| 9526 | <ul>
|
| 9527 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/operations/txbuild.ts#L1201">operations/txbuild.ts:1201</a></li>
|
| 9528 | </ul>
|
| 9529 | </aside>
|
| 9530 | </section>
|
| 9531 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
| 9532 | <a name="transactions.estimatetokentransfer" class="tsd-anchor"></a>
|
| 9533 | <h3>estimate<wbr>Token<wbr>Transfer</h3>
|
| 9534 | <div class="tsd-signature tsd-kind-icon">estimate<wbr>Token<wbr>Transfer<span class="tsd-signature-symbol">:</span> <a href="globals.html#estimatetokentransfer" class="tsd-signature-type">estimateTokenTransfer</a></div>
|
| 9535 | <aside class="tsd-sources">
|
| 9536 | <ul>
|
| 9537 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/operations/txbuild.ts#L1207">operations/txbuild.ts:1207</a></li>
|
| 9538 | </ul>
|
| 9539 | </aside>
|
| 9540 | </section>
|
| 9541 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
| 9542 | <a name="transactions.estimatetransfer" class="tsd-anchor"></a>
|
| 9543 | <h3>estimate<wbr>Transfer</h3>
|
| 9544 | <div class="tsd-signature tsd-kind-icon">estimate<wbr>Transfer<span class="tsd-signature-symbol">:</span> <a href="globals.html#estimatetransfer" class="tsd-signature-type">estimateTransfer</a></div>
|
| 9545 | <aside class="tsd-sources">
|
| 9546 | <ul>
|
| 9547 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/operations/txbuild.ts#L1198">operations/txbuild.ts:1198</a></li>
|
| 9548 | </ul>
|
| 9549 | </aside>
|
| 9550 | </section>
|
| 9551 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
| 9552 | <a name="transactions.estimateupdate" class="tsd-anchor"></a>
|
| 9553 | <h3>estimate<wbr>Update</h3>
|
| 9554 | <div class="tsd-signature tsd-kind-icon">estimate<wbr>Update<span class="tsd-signature-symbol">:</span> <a href="globals.html#estimateupdate" class="tsd-signature-type">estimateUpdate</a></div>
|
| 9555 | <aside class="tsd-sources">
|
| 9556 | <ul>
|
| 9557 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/operations/txbuild.ts#L1199">operations/txbuild.ts:1199</a></li>
|
| 9558 | </ul>
|
| 9559 | </aside>
|
| 9560 | </section>
|
| 9561 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
| 9562 | <a name="transactions.makeannounce" class="tsd-anchor"></a>
|
| 9563 | <h3>make<wbr>Announce</h3>
|
| 9564 | <div class="tsd-signature tsd-kind-icon">make<wbr>Announce<span class="tsd-signature-symbol">:</span> <a href="globals.html#makeannounce" class="tsd-signature-type">makeAnnounce</a></div>
|
| 9565 | <aside class="tsd-sources">
|
| 9566 | <ul>
|
| 9567 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/operations/txbuild.ts#L1193">operations/txbuild.ts:1193</a></li>
|
| 9568 | </ul>
|
| 9569 | </aside>
|
| 9570 | </section>
|
| 9571 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
| 9572 | <a name="transactions.makebitcoinspend" class="tsd-anchor"></a>
|
| 9573 | <h3>make<wbr>Bitcoin<wbr>Spend</h3>
|
| 9574 | <div class="tsd-signature tsd-kind-icon">make<wbr>Bitcoin<wbr>Spend<span class="tsd-signature-symbol">:</span> <a href="globals.html#makebitcoinspend" class="tsd-signature-type">makeBitcoinSpend</a></div>
|
| 9575 | <aside class="tsd-sources">
|
| 9576 | <ul>
|
| 9577 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/operations/txbuild.ts#L1191">operations/txbuild.ts:1191</a></li>
|
| 9578 | </ul>
|
| 9579 | </aside>
|
| 9580 | </section>
|
| 9581 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
| 9582 | <a name="transactions.makenameimport" class="tsd-anchor"></a>
|
| 9583 | <h3>make<wbr>Name<wbr>Import</h3>
|
| 9584 | <div class="tsd-signature tsd-kind-icon">make<wbr>Name<wbr>Import<span class="tsd-signature-symbol">:</span> <a href="globals.html#makenameimport" class="tsd-signature-type">makeNameImport</a></div>
|
| 9585 | <aside class="tsd-sources">
|
| 9586 | <ul>
|
| 9587 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/operations/txbuild.ts#L1192">operations/txbuild.ts:1192</a></li>
|
| 9588 | </ul>
|
| 9589 | </aside>
|
| 9590 | </section>
|
| 9591 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
| 9592 | <a name="transactions.makenamespacepreorder" class="tsd-anchor"></a>
|
| 9593 | <h3>make<wbr>Namespace<wbr>Preorder</h3>
|
| 9594 | <div class="tsd-signature tsd-kind-icon">make<wbr>Namespace<wbr>Preorder<span class="tsd-signature-symbol">:</span> <a href="globals.html#makenamespacepreorder" class="tsd-signature-type">makeNamespacePreorder</a></div>
|
| 9595 | <aside class="tsd-sources">
|
| 9596 | <ul>
|
| 9597 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/operations/txbuild.ts#L1188">operations/txbuild.ts:1188</a></li>
|
| 9598 | </ul>
|
| 9599 | </aside>
|
| 9600 | </section>
|
| 9601 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
| 9602 | <a name="transactions.makenamespaceready" class="tsd-anchor"></a>
|
| 9603 | <h3>make<wbr>Namespace<wbr>Ready</h3>
|
| 9604 | <div class="tsd-signature tsd-kind-icon">make<wbr>Namespace<wbr>Ready<span class="tsd-signature-symbol">:</span> <a href="globals.html#makenamespaceready" class="tsd-signature-type">makeNamespaceReady</a></div>
|
| 9605 | <aside class="tsd-sources">
|
| 9606 | <ul>
|
| 9607 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/operations/txbuild.ts#L1190">operations/txbuild.ts:1190</a></li>
|
| 9608 | </ul>
|
| 9609 | </aside>
|
| 9610 | </section>
|
| 9611 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
| 9612 | <a name="transactions.makenamespacereveal" class="tsd-anchor"></a>
|
| 9613 | <h3>make<wbr>Namespace<wbr>Reveal</h3>
|
| 9614 | <div class="tsd-signature tsd-kind-icon">make<wbr>Namespace<wbr>Reveal<span class="tsd-signature-symbol">:</span> <a href="globals.html#makenamespacereveal" class="tsd-signature-type">makeNamespaceReveal</a></div>
|
| 9615 | <aside class="tsd-sources">
|
| 9616 | <ul>
|
| 9617 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/operations/txbuild.ts#L1189">operations/txbuild.ts:1189</a></li>
|
| 9618 | </ul>
|
| 9619 | </aside>
|
| 9620 | </section>
|
| 9621 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
| 9622 | <a name="transactions.makepreorder" class="tsd-anchor"></a>
|
| 9623 | <h3>make<wbr>Preorder</h3>
|
| 9624 | <div class="tsd-signature tsd-kind-icon">make<wbr>Preorder<span class="tsd-signature-symbol">:</span> <a href="globals.html#makepreorder" class="tsd-signature-type">makePreorder</a></div>
|
| 9625 | <aside class="tsd-sources">
|
| 9626 | <ul>
|
| 9627 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/operations/txbuild.ts#L1184">operations/txbuild.ts:1184</a></li>
|
| 9628 | </ul>
|
| 9629 | </aside>
|
| 9630 | </section>
|
| 9631 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
| 9632 | <a name="transactions.makeregister" class="tsd-anchor"></a>
|
| 9633 | <h3>make<wbr>Register</h3>
|
| 9634 | <div class="tsd-signature tsd-kind-icon">make<wbr>Register<span class="tsd-signature-symbol">:</span> <a href="globals.html#makeregister" class="tsd-signature-type">makeRegister</a></div>
|
| 9635 | <aside class="tsd-sources">
|
| 9636 | <ul>
|
| 9637 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/operations/txbuild.ts#L1185">operations/txbuild.ts:1185</a></li>
|
| 9638 | </ul>
|
| 9639 | </aside>
|
| 9640 | </section>
|
| 9641 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
| 9642 | <a name="transactions.makerenewal" class="tsd-anchor"></a>
|
| 9643 | <h3>make<wbr>Renewal</h3>
|
| 9644 | <div class="tsd-signature tsd-kind-icon">make<wbr>Renewal<span class="tsd-signature-symbol">:</span> <a href="globals.html#makerenewal" class="tsd-signature-type">makeRenewal</a></div>
|
| 9645 | <aside class="tsd-sources">
|
| 9646 | <ul>
|
| 9647 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/operations/txbuild.ts#L1182">operations/txbuild.ts:1182</a></li>
|
| 9648 | </ul>
|
| 9649 | </aside>
|
| 9650 | </section>
|
| 9651 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
| 9652 | <a name="transactions.makerevoke" class="tsd-anchor"></a>
|
| 9653 | <h3>make<wbr>Revoke</h3>
|
| 9654 | <div class="tsd-signature tsd-kind-icon">make<wbr>Revoke<span class="tsd-signature-symbol">:</span> <a href="globals.html#makerevoke" class="tsd-signature-type">makeRevoke</a></div>
|
| 9655 | <aside class="tsd-sources">
|
| 9656 | <ul>
|
| 9657 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/operations/txbuild.ts#L1187">operations/txbuild.ts:1187</a></li>
|
| 9658 | </ul>
|
| 9659 | </aside>
|
| 9660 | </section>
|
| 9661 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
| 9662 | <a name="transactions.maketokentransfer" class="tsd-anchor"></a>
|
| 9663 | <h3>make<wbr>Token<wbr>Transfer</h3>
|
| 9664 | <div class="tsd-signature tsd-kind-icon">make<wbr>Token<wbr>Transfer<span class="tsd-signature-symbol">:</span> <a href="globals.html#maketokentransfer" class="tsd-signature-type">makeTokenTransfer</a></div>
|
| 9665 | <aside class="tsd-sources">
|
| 9666 | <ul>
|
| 9667 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/operations/txbuild.ts#L1194">operations/txbuild.ts:1194</a></li>
|
| 9668 | </ul>
|
| 9669 | </aside>
|
| 9670 | </section>
|
| 9671 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
| 9672 | <a name="transactions.maketransfer" class="tsd-anchor"></a>
|
| 9673 | <h3>make<wbr>Transfer</h3>
|
| 9674 | <div class="tsd-signature tsd-kind-icon">make<wbr>Transfer<span class="tsd-signature-symbol">:</span> <a href="globals.html#maketransfer" class="tsd-signature-type">makeTransfer</a></div>
|
| 9675 | <aside class="tsd-sources">
|
| 9676 | <ul>
|
| 9677 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/operations/txbuild.ts#L1186">operations/txbuild.ts:1186</a></li>
|
| 9678 | </ul>
|
| 9679 | </aside>
|
| 9680 | </section>
|
| 9681 | <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
| 9682 | <a name="transactions.makeupdate" class="tsd-anchor"></a>
|
| 9683 | <h3>make<wbr>Update</h3>
|
| 9684 | <div class="tsd-signature tsd-kind-icon">make<wbr>Update<span class="tsd-signature-symbol">:</span> <a href="globals.html#makeupdate" class="tsd-signature-type">makeUpdate</a></div>
|
| 9685 | <aside class="tsd-sources">
|
| 9686 | <ul>
|
| 9687 | <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/operations/txbuild.ts#L1183">operations/txbuild.ts:1183</a></li>
|
| 9688 | </ul>
|
| 9689 | </aside>
|
| 9690 | </section>
|
| 9691 | </section>
|
| 9692 | </section>
|
| 9693 | </div>
|
| 9694 | <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
| 9695 | <nav class="tsd-navigation primary">
|
| 9696 | <ul>
|
| 9697 | <li class="globals current ">
|
| 9698 | <a href="globals.html"><em>Globals</em></a>
|
| 9699 | </li>
|
| 9700 | </ul>
|
| 9701 | </nav>
|
| 9702 | <nav class="tsd-navigation secondary menu-sticky">
|
| 9703 | <ul class="before-current">
|
| 9704 | <li class=" tsd-kind-class">
|
| 9705 | <a href="classes/appconfig.html" class="tsd-kind-icon">App<wbr>Config</a>
|
| 9706 | </li>
|
| 9707 | <li class=" tsd-kind-class">
|
| 9708 | <a href="classes/bitcoinnetwork.html" class="tsd-kind-icon">Bitcoin<wbr>Network</a>
|
| 9709 | </li>
|
| 9710 | <li class=" tsd-kind-class">
|
| 9711 | <a href="classes/bitcoindapi.html" class="tsd-kind-icon">BitcoindAPI</a>
|
| 9712 | </li>
|
| 9713 | <li class=" tsd-kind-class">
|
| 9714 | <a href="classes/blockchaininfoapi.html" class="tsd-kind-icon">Blockchain<wbr>Info<wbr>Api</a>
|
| 9715 | </li>
|
| 9716 | <li class=" tsd-kind-class">
|
| 9717 | <a href="classes/blockstackerror.html" class="tsd-kind-icon">Blockstack<wbr>Error</a>
|
| 9718 | </li>
|
| 9719 | <li class=" tsd-kind-class">
|
| 9720 | <a href="classes/blockstacknamespace.html" class="tsd-kind-icon">Blockstack<wbr>Namespace</a>
|
| 9721 | </li>
|
| 9722 | <li class=" tsd-kind-class">
|
| 9723 | <a href="classes/blockstacknetwork.html" class="tsd-kind-icon">Blockstack<wbr>Network</a>
|
| 9724 | </li>
|
| 9725 | <li class=" tsd-kind-class">
|
| 9726 | <a href="classes/blockstackwallet.html" class="tsd-kind-icon">Blockstack<wbr>Wallet</a>
|
| 9727 | </li>
|
| 9728 | <li class=" tsd-kind-class">
|
| 9729 | <a href="classes/creativework.html" class="tsd-kind-icon">Creative<wbr>Work</a>
|
| 9730 | </li>
|
| 9731 | <li class=" tsd-kind-class tsd-is-not-exported">
|
| 9732 | <a href="classes/facebook.html" class="tsd-kind-icon">Facebook</a>
|
| 9733 | </li>
|
| 9734 | <li class=" tsd-kind-class tsd-is-not-exported">
|
| 9735 | <a href="classes/github.html" class="tsd-kind-icon">Github</a>
|
| 9736 | </li>
|
| 9737 | <li class=" tsd-kind-class tsd-is-not-exported">
|
| 9738 | <a href="classes/hackernews.html" class="tsd-kind-icon">Hacker<wbr>News</a>
|
| 9739 | </li>
|
| 9740 | <li class=" tsd-kind-class">
|
| 9741 | <a href="classes/insightclient.html" class="tsd-kind-icon">Insight<wbr>Client</a>
|
| 9742 | </li>
|
| 9743 | <li class=" tsd-kind-class tsd-is-not-exported">
|
| 9744 | <a href="classes/instagram.html" class="tsd-kind-icon">Instagram</a>
|
| 9745 | </li>
|
| 9746 | <li class=" tsd-kind-class">
|
| 9747 | <a href="classes/instancedatastore.html" class="tsd-kind-icon">Instance<wbr>Data<wbr>Store</a>
|
| 9748 | </li>
|
| 9749 | <li class=" tsd-kind-class">
|
| 9750 | <a href="classes/invalidamounterror.html" class="tsd-kind-icon">Invalid<wbr>Amount<wbr>Error</a>
|
| 9751 | </li>
|
| 9752 | <li class=" tsd-kind-class">
|
| 9753 | <a href="classes/invaliddiderror.html" class="tsd-kind-icon">InvalidDIDError</a>
|
| 9754 | </li>
|
| 9755 | <li class=" tsd-kind-class">
|
| 9756 | <a href="classes/invalidparametererror.html" class="tsd-kind-icon">Invalid<wbr>Parameter<wbr>Error</a>
|
| 9757 | </li>
|
| 9758 | <li class=" tsd-kind-class">
|
| 9759 | <a href="classes/invalidstateerror.html" class="tsd-kind-icon">Invalid<wbr>State<wbr>Error</a>
|
| 9760 | </li>
|
| 9761 | <li class=" tsd-kind-class tsd-is-not-exported">
|
| 9762 | <a href="classes/linkedin.html" class="tsd-kind-icon">Linked<wbr>In</a>
|
| 9763 | </li>
|
| 9764 | <li class=" tsd-kind-class">
|
| 9765 | <a href="classes/localregtest.html" class="tsd-kind-icon">Local<wbr>Regtest</a>
|
| 9766 | </li>
|
| 9767 | <li class=" tsd-kind-class">
|
| 9768 | <a href="classes/localstoragestore.html" class="tsd-kind-icon">Local<wbr>Storage<wbr>Store</a>
|
| 9769 | </li>
|
| 9770 | <li class=" tsd-kind-class">
|
| 9771 | <a href="classes/logger.html" class="tsd-kind-icon">Logger</a>
|
| 9772 | </li>
|
| 9773 | <li class=" tsd-kind-class">
|
| 9774 | <a href="classes/loginfailederror.html" class="tsd-kind-icon">Login<wbr>Failed<wbr>Error</a>
|
| 9775 | </li>
|
| 9776 | <li class=" tsd-kind-class">
|
| 9777 | <a href="classes/missingparametererror.html" class="tsd-kind-icon">Missing<wbr>Parameter<wbr>Error</a>
|
| 9778 | </li>
|
| 9779 | <li class=" tsd-kind-class">
|
| 9780 | <a href="classes/nosessiondataerror.html" class="tsd-kind-icon">No<wbr>Session<wbr>Data<wbr>Error</a>
|
| 9781 | </li>
|
| 9782 | <li class=" tsd-kind-class">
|
| 9783 | <a href="classes/notenoughfundserror.html" class="tsd-kind-icon">Not<wbr>Enough<wbr>Funds<wbr>Error</a>
|
| 9784 | </li>
|
| 9785 | <li class=" tsd-kind-class">
|
| 9786 | <a href="classes/organization.html" class="tsd-kind-icon">Organization</a>
|
| 9787 | </li>
|
| 9788 | <li class=" tsd-kind-class tsd-is-not-exported">
|
| 9789 | <a href="classes/passworderror.html" class="tsd-kind-icon">Password<wbr>Error</a>
|
| 9790 | </li>
|
| 9791 | <li class=" tsd-kind-class">
|
| 9792 | <a href="classes/person.html" class="tsd-kind-icon">Person</a>
|
| 9793 | </li>
|
| 9794 | <li class=" tsd-kind-class">
|
| 9795 | <a href="classes/profile.html" class="tsd-kind-icon">Profile</a>
|
| 9796 | </li>
|
| 9797 | <li class=" tsd-kind-class tsd-is-private">
|
| 9798 | <a href="classes/pubkeyhashsigner.html" class="tsd-kind-icon">Pubkey<wbr>Hash<wbr>Signer</a>
|
| 9799 | </li>
|
| 9800 | <li class=" tsd-kind-class">
|
| 9801 | <a href="classes/remoteserviceerror.html" class="tsd-kind-icon">Remote<wbr>Service<wbr>Error</a>
|
| 9802 | </li>
|
| 9803 | <li class=" tsd-kind-class">
|
| 9804 | <a href="classes/service.html" class="tsd-kind-icon">Service</a>
|
| 9805 | </li>
|
| 9806 | <li class=" tsd-kind-class">
|
| 9807 | <a href="classes/sessiondata.html" class="tsd-kind-icon">Session<wbr>Data</a>
|
| 9808 | </li>
|
| 9809 | <li class=" tsd-kind-class">
|
| 9810 | <a href="classes/sessiondatastore.html" class="tsd-kind-icon">Session<wbr>Data<wbr>Store</a>
|
| 9811 | </li>
|
| 9812 | <li class=" tsd-kind-class">
|
| 9813 | <a href="classes/signatureverificationerror.html" class="tsd-kind-icon">Signature<wbr>Verification<wbr>Error</a>
|
| 9814 | </li>
|
| 9815 | <li class=" tsd-kind-class tsd-is-not-exported">
|
| 9816 | <a href="classes/twitter.html" class="tsd-kind-icon">Twitter</a>
|
| 9817 | </li>
|
| 9818 | <li class=" tsd-kind-class">
|
| 9819 | <a href="classes/usersession.html" class="tsd-kind-icon">User<wbr>Session</a>
|
| 9820 | </li>
|
| 9821 | <li class=" tsd-kind-interface tsd-is-not-exported">
|
| 9822 | <a href="interfaces/cssstyle.html" class="tsd-kind-icon">Css<wbr>Style</a>
|
| 9823 | </li>
|
| 9824 | <li class=" tsd-kind-interface">
|
| 9825 | <a href="interfaces/transactionsigner.html" class="tsd-kind-icon">Transaction<wbr>Signer</a>
|
| 9826 | </li>
|
| 9827 | <li class=" tsd-kind-interface">
|
| 9828 | <a href="interfaces/userdata.html" class="tsd-kind-icon">User<wbr>Data</a>
|
| 9829 | </li>
|
| 9830 | <li class=" tsd-kind-interface tsd-is-not-exported">
|
| 9831 | <a href="interfaces/validateproofservice.html" class="tsd-kind-icon">Validate<wbr>Proof<wbr>Service</a>
|
| 9832 | </li>
|
| 9833 | <li class=" tsd-kind-type-alias tsd-is-not-exported">
|
| 9834 | <a href="globals.html#amounttype" class="tsd-kind-icon">Amount<wbr>Type</a>
|
| 9835 | </li>
|
| 9836 | <li class=" tsd-kind-type-alias tsd-is-not-exported">
|
| 9837 | <a href="globals.html#amounttypev1" class="tsd-kind-icon">Amount<wbr>Type<wbr>V1</a>
|
| 9838 | </li>
|
| 9839 | <li class=" tsd-kind-type-alias tsd-is-not-exported">
|
| 9840 | <a href="globals.html#amounttypev2" class="tsd-kind-icon">Amount<wbr>Type<wbr>V2</a>
|
| 9841 | </li>
|
| 9842 | <li class=" tsd-kind-type-alias tsd-is-not-exported">
|
| 9843 | <a href="globals.html#authmetadata" class="tsd-kind-icon">Auth<wbr>Metadata</a>
|
| 9844 | </li>
|
| 9845 | <li class=" tsd-kind-type-alias">
|
| 9846 | <a href="globals.html#cipherobject" class="tsd-kind-icon">Cipher<wbr>Object</a>
|
| 9847 | </li>
|
| 9848 | <li class=" tsd-kind-type-alias tsd-is-not-exported">
|
| 9849 | <a href="globals.html#errortype" class="tsd-kind-icon">Error<wbr>Type</a>
|
| 9850 | </li>
|
| 9851 | <li class=" tsd-kind-type-alias">
|
| 9852 | <a href="globals.html#gaiahubconfig" class="tsd-kind-icon">Gaia<wbr>Hub<wbr>Config</a>
|
| 9853 | </li>
|
| 9854 | <li class=" tsd-kind-type-alias">
|
| 9855 | <a href="globals.html#getfileoptions" class="tsd-kind-icon">Get<wbr>File<wbr>Options</a>
|
| 9856 | </li>
|
| 9857 | <li class=" tsd-kind-type-alias">
|
| 9858 | <a href="globals.html#identitykeypair" class="tsd-kind-icon">Identity<wbr>Key<wbr>Pair</a>
|
| 9859 | </li>
|
| 9860 | <li class=" tsd-kind-type-alias">
|
| 9861 | <a href="globals.html#putfileoptions" class="tsd-kind-icon">Put<wbr>File<wbr>Options</a>
|
| 9862 | </li>
|
| 9863 | <li class=" tsd-kind-type-alias">
|
| 9864 | <a href="globals.html#sessionoptions" class="tsd-kind-icon">Session<wbr>Options</a>
|
| 9865 | </li>
|
| 9866 | <li class=" tsd-kind-type-alias">
|
| 9867 | <a href="globals.html#utxo" class="tsd-kind-icon">UTXO</a>
|
| 9868 | </li>
|
| 9869 | <li class=" tsd-kind-type-alias tsd-is-not-exported">
|
| 9870 | <a href="globals.html#txpoint" class="tsd-kind-icon">tx<wbr>Point</a>
|
| 9871 | </li>
|
| 9872 | <li class=" tsd-kind-variable tsd-is-not-exported">
|
| 9873 | <a href="globals.html#apps_node_index" class="tsd-kind-icon">APPS_<wbr>NODE_<wbr>INDEX</a>
|
| 9874 | </li>
|
| 9875 | <li class=" tsd-kind-variable tsd-is-not-exported">
|
| 9876 | <a href="globals.html#auth_continuation_param" class="tsd-kind-icon">AUTH_<wbr>CONTINUATION_<wbr>PARAM</a>
|
| 9877 | </li>
|
| 9878 | <li class=" tsd-kind-variable tsd-is-not-exported">
|
| 9879 | <a href="globals.html#bitcoin_account_index" class="tsd-kind-icon">BITCOIN_<wbr>ACCOUNT_<wbr>INDEX</a>
|
| 9880 | </li>
|
| 9881 | <li class=" tsd-kind-variable tsd-is-not-exported">
|
| 9882 | <a href="globals.html#bitcoin_bip_44_purpose" class="tsd-kind-icon">BITCOIN_<wbr>BIP_<wbr>44_<wbr>PURPOSE</a>
|
| 9883 | </li>
|
| 9884 | <li class=" tsd-kind-variable tsd-is-not-exported">
|
| 9885 | <a href="globals.html#bitcoin_coin_type" class="tsd-kind-icon">BITCOIN_<wbr>COIN_<wbr>TYPE</a>
|
| 9886 | </li>
|
| 9887 | <li class=" tsd-kind-variable">
|
| 9888 | <a href="globals.html#blockstack_app_private_key_label" class="tsd-kind-icon">BLOCKSTACK_<wbr>APP_<wbr>PRIVATE_<wbr>KEY_<wbr>LABEL</a>
|
| 9889 | </li>
|
| 9890 | <li class=" tsd-kind-variable">
|
| 9891 | <a href="globals.html#blockstack_default_gaia_hub_url" class="tsd-kind-icon">BLOCKSTACK_<wbr>DEFAULT_<wbr>GAIA_<wbr>HUB_<wbr>URL</a>
|
| 9892 | </li>
|
| 9893 | <li class=" tsd-kind-variable">
|
| 9894 | <a href="globals.html#blockstack_gaia_hub_label" class="tsd-kind-icon">BLOCKSTACK_<wbr>GAIA_<wbr>HUB_<wbr>LABEL</a>
|
| 9895 | </li>
|
| 9896 | <li class=" tsd-kind-variable">
|
| 9897 | <a href="globals.html#blockstack_handler" class="tsd-kind-icon">BLOCKSTACK_<wbr>HANDLER</a>
|
| 9898 | </li>
|
| 9899 | <li class=" tsd-kind-variable tsd-is-not-exported">
|
| 9900 | <a href="globals.html#blockstack_on_bitcoin" class="tsd-kind-icon">BLOCKSTACK_<wbr>ON_<wbr>BITCOIN</a>
|
| 9901 | </li>
|
| 9902 | <li class=" tsd-kind-variable">
|
| 9903 | <a href="globals.html#blockstack_storage_label" class="tsd-kind-icon">BLOCKSTACK_<wbr>STORAGE_<wbr>LABEL</a>
|
| 9904 | </li>
|
| 9905 | <li class=" tsd-kind-variable tsd-is-not-exported">
|
| 9906 | <a href="globals.html#change_address" class="tsd-kind-icon">CHANGE_<wbr>ADDRESS</a>
|
| 9907 | </li>
|
| 9908 | <li class=" tsd-kind-variable">
|
| 9909 | <a href="globals.html#default_blockstack_host" class="tsd-kind-icon">DEFAULT_<wbr>BLOCKSTACK_<wbr>HOST</a>
|
| 9910 | </li>
|
| 9911 | <li class=" tsd-kind-variable">
|
| 9912 | <a href="globals.html#default_core_node" class="tsd-kind-icon">DEFAULT_<wbr>CORE_<wbr>NODE</a>
|
| 9913 | </li>
|
| 9914 | <li class=" tsd-kind-variable">
|
| 9915 | <a href="globals.html#default_scope" class="tsd-kind-icon">DEFAULT_<wbr>SCOPE</a>
|
| 9916 | </li>
|
| 9917 | <li class=" tsd-kind-variable">
|
| 9918 | <a href="globals.html#dust_minimum" class="tsd-kind-icon">DUST_<wbr>MINIMUM</a>
|
| 9919 | </li>
|
| 9920 | <li class=" tsd-kind-variable tsd-is-not-exported">
|
| 9921 | <a href="globals.html#echo_reply_param" class="tsd-kind-icon">ECHO_<wbr>REPLY_<wbr>PARAM</a>
|
| 9922 | </li>
|
| 9923 | <li class=" tsd-kind-variable tsd-is-not-exported">
|
| 9924 | <a href="globals.html#external_address" class="tsd-kind-icon">EXTERNAL_<wbr>ADDRESS</a>
|
| 9925 | </li>
|
| 9926 | <li class=" tsd-kind-variable tsd-is-not-exported">
|
| 9927 | <a href="globals.html#global_detection_cache_key" class="tsd-kind-icon">GLOBAL_<wbr>DETECTION_<wbr>CACHE_<wbr>KEY</a>
|
| 9928 | </li>
|
| 9929 | <li class=" tsd-kind-variable tsd-is-not-exported">
|
| 9930 | <a href="globals.html#identity_keychain" class="tsd-kind-icon">IDENTITY_<wbr>KEYCHAIN</a>
|
| 9931 | </li>
|
| 9932 | <li class=" tsd-kind-variable">
|
| 9933 | <a href="globals.html#localstorage_session_key" class="tsd-kind-icon">LOCALSTORAGE_<wbr>SESSION_<wbr>KEY</a>
|
| 9934 | </li>
|
| 9935 | <li class=" tsd-kind-variable tsd-is-not-exported">
|
| 9936 | <a href="globals.html#local_regtest" class="tsd-kind-icon">LOCAL_<wbr>REGTEST</a>
|
| 9937 | </li>
|
| 9938 | <li class=" tsd-kind-variable tsd-is-not-exported">
|
| 9939 | <a href="globals.html#mainnet_default" class="tsd-kind-icon">MAINNET_<wbr>DEFAULT</a>
|
| 9940 | </li>
|
| 9941 | <li class=" tsd-kind-variable">
|
| 9942 | <a href="globals.html#name_lookup_path" class="tsd-kind-icon">NAME_<wbr>LOOKUP_<wbr>PATH</a>
|
| 9943 | </li>
|
| 9944 | <li class=" tsd-kind-variable tsd-is-not-exported">
|
| 9945 | <a href="globals.html#satoshis_per_btc" class="tsd-kind-icon">SATOSHIS_<wbr>PER_<wbr>BTC</a>
|
| 9946 | </li>
|
| 9947 | <li class=" tsd-kind-variable tsd-is-not-exported">
|
| 9948 | <a href="globals.html#session_version" class="tsd-kind-icon">SESSION_<wbr>VERSION</a>
|
| 9949 | </li>
|
| 9950 | <li class=" tsd-kind-variable tsd-is-not-exported">
|
| 9951 | <a href="globals.html#signature_file_suffix" class="tsd-kind-icon">SIGNATURE_<wbr>FILE_<wbr>SUFFIX</a>
|
| 9952 | </li>
|
| 9953 | <li class=" tsd-kind-variable tsd-is-not-exported">
|
| 9954 | <a href="globals.html#tx_broadcast_service_registration_endpoint" class="tsd-kind-icon">TX_<wbr>BROADCAST_<wbr>SERVICE_<wbr>REGISTRATION_<wbr>ENDPOINT</a>
|
| 9955 | </li>
|
| 9956 | <li class=" tsd-kind-variable tsd-is-not-exported">
|
| 9957 | <a href="globals.html#tx_broadcast_service_tx_endpoint" class="tsd-kind-icon">TX_<wbr>BROADCAST_<wbr>SERVICE_<wbr>TX_<wbr>ENDPOINT</a>
|
| 9958 | </li>
|
| 9959 | <li class=" tsd-kind-variable tsd-is-not-exported">
|
| 9960 | <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>
|
| 9961 | </li>
|
| 9962 | <li class=" tsd-kind-variable tsd-is-not-exported">
|
| 9963 | <a href="globals.html#tx_empty_size" class="tsd-kind-icon">TX_<wbr>EMPTY_<wbr>SIZE</a>
|
| 9964 | </li>
|
| 9965 | <li class=" tsd-kind-variable tsd-is-not-exported">
|
| 9966 | <a href="globals.html#tx_input_base" class="tsd-kind-icon">TX_<wbr>INPUT_<wbr>BASE</a>
|
| 9967 | </li>
|
| 9968 | <li class=" tsd-kind-variable tsd-is-not-exported">
|
| 9969 | <a href="globals.html#tx_input_pubkeyhash" class="tsd-kind-icon">TX_<wbr>INPUT_<wbr>PUBKEYHASH</a>
|
| 9970 | </li>
|
| 9971 | <li class=" tsd-kind-variable tsd-is-not-exported">
|
| 9972 | <a href="globals.html#tx_output_base" class="tsd-kind-icon">TX_<wbr>OUTPUT_<wbr>BASE</a>
|
| 9973 | </li>
|
| 9974 | <li class=" tsd-kind-variable tsd-is-not-exported">
|
| 9975 | <a href="globals.html#tx_output_pubkeyhash" class="tsd-kind-icon">TX_<wbr>OUTPUT_<wbr>PUBKEYHASH</a>
|
| 9976 | </li>
|
| 9977 | <li class=" tsd-kind-variable tsd-is-not-exported">
|
| 9978 | <a href="globals.html#version" class="tsd-kind-icon">VERSION</a>
|
| 9979 | </li>
|
| 9980 | <li class=" tsd-kind-variable tsd-is-not-exported">
|
| 9981 | <a href="globals.html#dummyconsensushash" class="tsd-kind-icon">dummy<wbr>Consensus<wbr>Hash</a>
|
| 9982 | </li>
|
| 9983 | <li class=" tsd-kind-variable tsd-is-not-exported">
|
| 9984 | <a href="globals.html#dummyzonefilehash" class="tsd-kind-icon">dummy<wbr>Zonefile<wbr>Hash</a>
|
| 9985 | </li>
|
| 9986 | <li class=" tsd-kind-variable tsd-is-not-exported">
|
| 9987 | <a href="globals.html#ecurve" class="tsd-kind-icon">ecurve</a>
|
| 9988 | </li>
|
| 9989 | <li class=" tsd-kind-variable tsd-is-not-exported">
|
| 9990 | <a href="globals.html#inttolevel" class="tsd-kind-icon">int<wbr>ToLevel</a>
|
| 9991 | </li>
|
| 9992 | <li class=" tsd-kind-variable tsd-is-not-exported">
|
| 9993 | <a href="globals.html#leveltoint" class="tsd-kind-icon">level<wbr>ToInt</a>
|
| 9994 | </li>
|
| 9995 | <li class=" tsd-kind-variable">
|
| 9996 | <a href="globals.html#levels" class="tsd-kind-icon">levels</a>
|
| 9997 | </li>
|
| 9998 | <li class=" tsd-kind-function tsd-is-not-exported">
|
| 9999 | <a href="globals.html#addownerinput" class="tsd-kind-icon">add<wbr>Owner<wbr>Input</a>
|
| 10000 | </li>
|
| 10001 | <li class=" tsd-kind-function tsd-is-private">
|
| 10002 | <a href="globals.html#addutxostofund" class="tsd-kind-icon">addUTXOs<wbr>ToFund</a>
|
| 10003 | </li>
|
| 10004 | <li class=" tsd-kind-function tsd-is-not-exported">
|
| 10005 | <a href="globals.html#addresscanreceivename" class="tsd-kind-icon">address<wbr>Can<wbr>Receive<wbr>Name</a>
|
| 10006 | </li>
|
| 10007 | <li class=" tsd-kind-function tsd-is-not-exported">
|
| 10008 | <a href="globals.html#aes256cbcdecrypt" class="tsd-kind-icon">aes256<wbr>Cbc<wbr>Decrypt</a>
|
| 10009 | </li>
|
| 10010 | <li class=" tsd-kind-function tsd-is-not-exported">
|
| 10011 | <a href="globals.html#aes256cbcencrypt" class="tsd-kind-icon">aes256<wbr>Cbc<wbr>Encrypt</a>
|
| 10012 | </li>
|
| 10013 | <li class=" tsd-kind-function tsd-is-not-exported">
|
| 10014 | <a href="globals.html#asamountv2" class="tsd-kind-icon">as<wbr>Amount<wbr>V2</a>
|
| 10015 | </li>
|
| 10016 | <li class=" tsd-kind-function">
|
| 10017 | <a href="globals.html#connecttogaiahub" class="tsd-kind-icon">connect<wbr>ToGaia<wbr>Hub</a>
|
| 10018 | </li>
|
| 10019 | <li class=" tsd-kind-function">
|
| 10020 | <a href="globals.html#containsvalidaddressproofstatement" class="tsd-kind-icon">contains<wbr>Valid<wbr>Address<wbr>Proof<wbr>Statement</a>
|
| 10021 | </li>
|
| 10022 | <li class=" tsd-kind-function">
|
| 10023 | <a href="globals.html#containsvalidproofstatement" class="tsd-kind-icon">contains<wbr>Valid<wbr>Proof<wbr>Statement</a>
|
| 10024 | </li>
|
| 10025 | <li class=" tsd-kind-function">
|
| 10026 | <a href="globals.html#decodeb40" class="tsd-kind-icon">decode<wbr>B40</a>
|
| 10027 | </li>
|
| 10028 | <li class=" tsd-kind-function">
|
| 10029 | <a href="globals.html#decryptcontent" class="tsd-kind-icon">decrypt<wbr>Content</a>
|
| 10030 | </li>
|
| 10031 | <li class=" tsd-kind-function tsd-is-private">
|
| 10032 | <a href="globals.html#decryptecies" class="tsd-kind-icon">decryptECIES</a>
|
| 10033 | </li>
|
| 10034 | <li class=" tsd-kind-function tsd-is-private tsd-is-not-exported">
|
| 10035 | <a href="globals.html#decryptlegacy" class="tsd-kind-icon">decrypt<wbr>Legacy</a>
|
| 10036 | </li>
|
| 10037 | <li class=" tsd-kind-function tsd-is-private">
|
| 10038 | <a href="globals.html#decryptmnemonic" class="tsd-kind-icon">decrypt<wbr>Mnemonic</a>
|
| 10039 | </li>
|
| 10040 | <li class=" tsd-kind-function tsd-is-not-exported">
|
| 10041 | <a href="globals.html#decryptmnemonicbuffer" class="tsd-kind-icon">decrypt<wbr>Mnemonic<wbr>Buffer</a>
|
| 10042 | </li>
|
| 10043 | <li class=" tsd-kind-function tsd-is-private">
|
| 10044 | <a href="globals.html#decryptprivatekey" class="tsd-kind-icon">decrypt<wbr>Private<wbr>Key</a>
|
| 10045 | </li>
|
| 10046 | <li class=" tsd-kind-function">
|
| 10047 | <a href="globals.html#deletefile" class="tsd-kind-icon">delete<wbr>File</a>
|
| 10048 | </li>
|
| 10049 | <li class=" tsd-kind-function tsd-is-private">
|
| 10050 | <a href="globals.html#dopublickeysmatchissuer" class="tsd-kind-icon">do<wbr>Public<wbr>Keys<wbr>Match<wbr>Issuer</a>
|
| 10051 | </li>
|
| 10052 | <li class=" tsd-kind-function tsd-is-private">
|
| 10053 | <a href="globals.html#dopublickeysmatchusername" class="tsd-kind-icon">do<wbr>Public<wbr>Keys<wbr>Match<wbr>Username</a>
|
| 10054 | </li>
|
| 10055 | <li class=" tsd-kind-function tsd-is-private">
|
| 10056 | <a href="globals.html#dosignaturesmatchpublickeys" class="tsd-kind-icon">do<wbr>Signatures<wbr>Match<wbr>Public<wbr>Keys</a>
|
| 10057 | </li>
|
| 10058 | <li class=" tsd-kind-function">
|
| 10059 | <a href="globals.html#ecpairtoaddress" class="tsd-kind-icon">ec<wbr>Pair<wbr>ToAddress</a>
|
| 10060 | </li>
|
| 10061 | <li class=" tsd-kind-function">
|
| 10062 | <a href="globals.html#ecpairtohexstring" class="tsd-kind-icon">ec<wbr>Pair<wbr>ToHex<wbr>String</a>
|
| 10063 | </li>
|
| 10064 | <li class=" tsd-kind-function">
|
| 10065 | <a href="globals.html#encryptcontent" class="tsd-kind-icon">encrypt<wbr>Content</a>
|
| 10066 | </li>
|
| 10067 | <li class=" tsd-kind-function">
|
| 10068 | <a href="globals.html#encryptecies" class="tsd-kind-icon">encryptECIES</a>
|
| 10069 | </li>
|
| 10070 | <li class=" tsd-kind-function tsd-is-private">
|
| 10071 | <a href="globals.html#encryptmnemonic" class="tsd-kind-icon">encrypt<wbr>Mnemonic</a>
|
| 10072 | </li>
|
| 10073 | <li class=" tsd-kind-function tsd-is-private">
|
| 10074 | <a href="globals.html#encryptprivatekey" class="tsd-kind-icon">encrypt<wbr>Private<wbr>Key</a>
|
| 10075 | </li>
|
| 10076 | <li class=" tsd-kind-function tsd-is-not-exported">
|
| 10077 | <a href="globals.html#equalconsttime" class="tsd-kind-icon">equal<wbr>Const<wbr>Time</a>
|
| 10078 | </li>
|
| 10079 | <li class=" tsd-kind-function tsd-is-private tsd-is-not-exported">
|
| 10080 | <a href="globals.html#estimateannounce" class="tsd-kind-icon">estimate<wbr>Announce</a>
|
| 10081 | </li>
|
| 10082 | <li class=" tsd-kind-function tsd-is-private tsd-is-not-exported">
|
| 10083 | <a href="globals.html#estimatenameimport" class="tsd-kind-icon">estimate<wbr>Name<wbr>Import</a>
|
| 10084 | </li>
|
| 10085 | <li class=" tsd-kind-function tsd-is-private tsd-is-not-exported">
|
| 10086 | <a href="globals.html#estimatenamespacepreorder" class="tsd-kind-icon">estimate<wbr>Namespace<wbr>Preorder</a>
|
| 10087 | </li>
|
| 10088 | <li class=" tsd-kind-function tsd-is-private tsd-is-not-exported">
|
| 10089 | <a href="globals.html#estimatenamespaceready" class="tsd-kind-icon">estimate<wbr>Namespace<wbr>Ready</a>
|
| 10090 | </li>
|
| 10091 | <li class=" tsd-kind-function tsd-is-private tsd-is-not-exported">
|
| 10092 | <a href="globals.html#estimatenamespacereveal" class="tsd-kind-icon">estimate<wbr>Namespace<wbr>Reveal</a>
|
| 10093 | </li>
|
| 10094 | <li class=" tsd-kind-function tsd-is-private tsd-is-not-exported">
|
| 10095 | <a href="globals.html#estimatepreorder" class="tsd-kind-icon">estimate<wbr>Preorder</a>
|
| 10096 | </li>
|
| 10097 | <li class=" tsd-kind-function tsd-is-private tsd-is-not-exported">
|
| 10098 | <a href="globals.html#estimateregister" class="tsd-kind-icon">estimate<wbr>Register</a>
|
| 10099 | </li>
|
| 10100 | <li class=" tsd-kind-function tsd-is-private tsd-is-not-exported">
|
| 10101 | <a href="globals.html#estimaterenewal" class="tsd-kind-icon">estimate<wbr>Renewal</a>
|
| 10102 | </li>
|
| 10103 | <li class=" tsd-kind-function tsd-is-private tsd-is-not-exported">
|
| 10104 | <a href="globals.html#estimaterevoke" class="tsd-kind-icon">estimate<wbr>Revoke</a>
|
| 10105 | </li>
|
| 10106 | <li class=" tsd-kind-function">
|
| 10107 | <a href="globals.html#estimatetxbytes" class="tsd-kind-icon">estimateTXBytes</a>
|
| 10108 | </li>
|
| 10109 | <li class=" tsd-kind-function tsd-is-private tsd-is-not-exported">
|
| 10110 | <a href="globals.html#estimatetokentransfer" class="tsd-kind-icon">estimate<wbr>Token<wbr>Transfer</a>
|
| 10111 | </li>
|
| 10112 | <li class=" tsd-kind-function tsd-is-private tsd-is-not-exported">
|
| 10113 | <a href="globals.html#estimatetransfer" class="tsd-kind-icon">estimate<wbr>Transfer</a>
|
| 10114 | </li>
|
| 10115 | <li class=" tsd-kind-function tsd-is-private tsd-is-not-exported">
|
| 10116 | <a href="globals.html#estimateupdate" class="tsd-kind-icon">estimate<wbr>Update</a>
|
| 10117 | </li>
|
| 10118 | <li class=" tsd-kind-function">
|
| 10119 | <a href="globals.html#extractprofile" class="tsd-kind-icon">extract<wbr>Profile</a>
|
| 10120 | </li>
|
| 10121 | <li class=" tsd-kind-function tsd-is-private">
|
| 10122 | <a href="globals.html#fetchappmanifest" class="tsd-kind-icon">fetch<wbr>App<wbr>Manifest</a>
|
| 10123 | </li>
|
| 10124 | <li class=" tsd-kind-function tsd-is-not-exported">
|
| 10125 | <a href="globals.html#formataccount" class="tsd-kind-icon">format<wbr>Account</a>
|
| 10126 | </li>
|
| 10127 | <li class=" tsd-kind-function tsd-is-not-exported">
|
| 10128 | <a href="globals.html#fundtransaction" class="tsd-kind-icon">fund<wbr>Transaction</a>
|
| 10129 | </li>
|
| 10130 | <li class=" tsd-kind-function tsd-is-private">
|
| 10131 | <a href="globals.html#generatetransitkey" class="tsd-kind-icon">generate<wbr>Transit<wbr>Key</a>
|
| 10132 | </li>
|
| 10133 | <li class=" tsd-kind-function">
|
| 10134 | <a href="globals.html#getaddress" class="tsd-kind-icon">get<wbr>Address</a>
|
| 10135 | </li>
|
| 10136 | <li class=" tsd-kind-function">
|
| 10137 | <a href="globals.html#getaddressfromdid" class="tsd-kind-icon">get<wbr>Address<wbr>FromDID</a>
|
| 10138 | </li>
|
| 10139 | <li class=" tsd-kind-function">
|
| 10140 | <a href="globals.html#getappbucketurl" class="tsd-kind-icon">get<wbr>App<wbr>Bucket<wbr>Url</a>
|
| 10141 | </li>
|
| 10142 | <li class=" tsd-kind-function tsd-is-private">
|
| 10143 | <a href="globals.html#getauthrequestfromurl" class="tsd-kind-icon">get<wbr>Auth<wbr>Request<wbr>FromURL</a>
|
| 10144 | </li>
|
| 10145 | <li class=" tsd-kind-function">
|
| 10146 | <a href="globals.html#getauthresponsetoken" class="tsd-kind-icon">get<wbr>Auth<wbr>Response<wbr>Token</a>
|
| 10147 | </li>
|
| 10148 | <li class=" tsd-kind-function">
|
| 10149 | <a href="globals.html#getavatarurl" class="tsd-kind-icon">get<wbr>Avatar<wbr>Url</a>
|
| 10150 | </li>
|
| 10151 | <li class=" tsd-kind-function">
|
| 10152 | <a href="globals.html#getbirthdate" class="tsd-kind-icon">get<wbr>Birth<wbr>Date</a>
|
| 10153 | </li>
|
| 10154 | <li class=" tsd-kind-function">
|
| 10155 | <a href="globals.html#getbucketurl" class="tsd-kind-icon">get<wbr>Bucket<wbr>Url</a>
|
| 10156 | </li>
|
| 10157 | <li class=" tsd-kind-function tsd-is-not-exported">
|
| 10158 | <a href="globals.html#getbuffer" class="tsd-kind-icon">get<wbr>Buffer</a>
|
| 10159 | </li>
|
| 10160 | <li class=" tsd-kind-function">
|
| 10161 | <a href="globals.html#getconnections" class="tsd-kind-icon">get<wbr>Connections</a>
|
| 10162 | </li>
|
| 10163 | <li class=" tsd-kind-function tsd-is-private">
|
| 10164 | <a href="globals.html#getcoresession" class="tsd-kind-icon">get<wbr>Core<wbr>Session</a>
|
| 10165 | </li>
|
| 10166 | <li class=" tsd-kind-function">
|
| 10167 | <a href="globals.html#getdidtype" class="tsd-kind-icon">getDIDType</a>
|
| 10168 | </li>
|
| 10169 | <li class=" tsd-kind-function">
|
| 10170 | <a href="globals.html#getdescription" class="tsd-kind-icon">get<wbr>Description</a>
|
| 10171 | </li>
|
| 10172 | <li class=" tsd-kind-function">
|
| 10173 | <a href="globals.html#getentropy" class="tsd-kind-icon">get<wbr>Entropy</a>
|
| 10174 | </li>
|
| 10175 | <li class=" tsd-kind-function">
|
| 10176 | <a href="globals.html#getfamilyname" class="tsd-kind-icon">get<wbr>Family<wbr>Name</a>
|
| 10177 | </li>
|
| 10178 | <li class=" tsd-kind-function">
|
| 10179 | <a href="globals.html#getfile" class="tsd-kind-icon">get<wbr>File</a>
|
| 10180 | </li>
|
| 10181 | <li class=" tsd-kind-function tsd-is-not-exported">
|
| 10182 | <a href="globals.html#getfilecontents" class="tsd-kind-icon">get<wbr>File<wbr>Contents</a>
|
| 10183 | </li>
|
| 10184 | <li class=" tsd-kind-function tsd-is-not-exported">
|
| 10185 | <a href="globals.html#getfilesignedunencrypted" class="tsd-kind-icon">get<wbr>File<wbr>Signed<wbr>Unencrypted</a>
|
| 10186 | </li>
|
| 10187 | <li class=" tsd-kind-function">
|
| 10188 | <a href="globals.html#getfileurl" class="tsd-kind-icon">get<wbr>File<wbr>Url</a>
|
| 10189 | </li>
|
| 10190 | <li class=" tsd-kind-function">
|
| 10191 | <a href="globals.html#getfullreadurl" class="tsd-kind-icon">get<wbr>Full<wbr>Read<wbr>Url</a>
|
| 10192 | </li>
|
| 10193 | <li class=" tsd-kind-function tsd-is-not-exported">
|
| 10194 | <a href="globals.html#getgaiaaddress" class="tsd-kind-icon">get<wbr>Gaia<wbr>Address</a>
|
| 10195 | </li>
|
| 10196 | <li class=" tsd-kind-function">
|
| 10197 | <a href="globals.html#getgivenname" class="tsd-kind-icon">get<wbr>Given<wbr>Name</a>
|
| 10198 | </li>
|
| 10199 | <li class=" tsd-kind-function">
|
| 10200 | <a href="globals.html#gethexfrombn" class="tsd-kind-icon">get<wbr>Hex<wbr>FromBN</a>
|
| 10201 | </li>
|
| 10202 | <li class=" tsd-kind-function">
|
| 10203 | <a href="globals.html#getname" class="tsd-kind-icon">get<wbr>Name</a>
|
| 10204 | </li>
|
| 10205 | <li class=" tsd-kind-function tsd-is-not-exported">
|
| 10206 | <a href="globals.html#getnodeprivatekey" class="tsd-kind-icon">get<wbr>Node<wbr>Private<wbr>Key</a>
|
| 10207 | </li>
|
| 10208 | <li class=" tsd-kind-function tsd-is-not-exported">
|
| 10209 | <a href="globals.html#getnodepublickey" class="tsd-kind-icon">get<wbr>Node<wbr>Public<wbr>Key</a>
|
| 10210 | </li>
|
| 10211 | <li class=" tsd-kind-function">
|
| 10212 | <a href="globals.html#getorganizations" class="tsd-kind-icon">get<wbr>Organizations</a>
|
| 10213 | </li>
|
| 10214 | <li class=" tsd-kind-function">
|
| 10215 | <a href="globals.html#getpersonfromlegacyformat" class="tsd-kind-icon">get<wbr>Person<wbr>From<wbr>Legacy<wbr>Format</a>
|
| 10216 | </li>
|
| 10217 | <li class=" tsd-kind-function">
|
| 10218 | <a href="globals.html#getpublickeyfromprivate" class="tsd-kind-icon">get<wbr>Public<wbr>Key<wbr>From<wbr>Private</a>
|
| 10219 | </li>
|
| 10220 | <li class=" tsd-kind-function">
|
| 10221 | <a href="globals.html#gettokenfileurl" class="tsd-kind-icon">get<wbr>Token<wbr>File<wbr>Url</a>
|
| 10222 | </li>
|
| 10223 | <li class=" tsd-kind-function tsd-is-not-exported">
|
| 10224 | <a href="globals.html#gettransaction" class="tsd-kind-icon">get<wbr>Transaction</a>
|
| 10225 | </li>
|
| 10226 | <li class=" tsd-kind-function">
|
| 10227 | <a href="globals.html#gettransactioninsidebuilder" class="tsd-kind-icon">get<wbr>Transaction<wbr>Inside<wbr>Builder</a>
|
| 10228 | </li>
|
| 10229 | <li class=" tsd-kind-function tsd-is-not-exported">
|
| 10230 | <a href="globals.html#gettransactionsigner" class="tsd-kind-icon">get<wbr>Transaction<wbr>Signer</a>
|
| 10231 | </li>
|
| 10232 | <li class=" tsd-kind-function">
|
| 10233 | <a href="globals.html#getuserappfileurl" class="tsd-kind-icon">get<wbr>User<wbr>App<wbr>File<wbr>Url</a>
|
| 10234 | </li>
|
| 10235 | <li class=" tsd-kind-function">
|
| 10236 | <a href="globals.html#getverifiedaccounts" class="tsd-kind-icon">get<wbr>Verified<wbr>Accounts</a>
|
| 10237 | </li>
|
| 10238 | <li class=" tsd-kind-function">
|
| 10239 | <a href="globals.html#handlependingsignin" class="tsd-kind-icon">handle<wbr>Pending<wbr>Sign<wbr>In</a>
|
| 10240 | </li>
|
| 10241 | <li class=" tsd-kind-function tsd-is-not-exported">
|
| 10242 | <a href="globals.html#handlesignedencryptedcontents" class="tsd-kind-icon">handle<wbr>Signed<wbr>Encrypted<wbr>Contents</a>
|
| 10243 | </li>
|
| 10244 | <li class=" tsd-kind-function">
|
| 10245 | <a href="globals.html#hash128" class="tsd-kind-icon">hash128</a>
|
| 10246 | </li>
|
| 10247 | <li class=" tsd-kind-function">
|
| 10248 | <a href="globals.html#hash160" class="tsd-kind-icon">hash160</a>
|
| 10249 | </li>
|
| 10250 | <li class=" tsd-kind-function tsd-is-not-exported">
|
| 10251 | <a href="globals.html#hashcode" class="tsd-kind-icon">hash<wbr>Code</a>
|
| 10252 | </li>
|
| 10253 | <li class=" tsd-kind-function">
|
| 10254 | <a href="globals.html#hexstringtoecpair" class="tsd-kind-icon">hex<wbr>String<wbr>ToECPair</a>
|
| 10255 | </li>
|
| 10256 | <li class=" tsd-kind-function tsd-is-not-exported">
|
| 10257 | <a href="globals.html#hmacsha256" class="tsd-kind-icon">hmac<wbr>Sha256</a>
|
| 10258 | </li>
|
| 10259 | <li class=" tsd-kind-function tsd-is-not-exported">
|
| 10260 | <a href="globals.html#inputbytes" class="tsd-kind-icon">input<wbr>Bytes</a>
|
| 10261 | </li>
|
| 10262 | <li class=" tsd-kind-function tsd-is-not-exported">
|
| 10263 | <a href="globals.html#isaccountspendable" class="tsd-kind-icon">is<wbr>Account<wbr>Spendable</a>
|
| 10264 | </li>
|
| 10265 | <li class=" tsd-kind-function tsd-is-private">
|
| 10266 | <a href="globals.html#isexpirationdatevalid" class="tsd-kind-icon">is<wbr>Expiration<wbr>Date<wbr>Valid</a>
|
| 10267 | </li>
|
| 10268 | <li class=" tsd-kind-function tsd-is-not-exported">
|
| 10269 | <a href="globals.html#isingraceperiod" class="tsd-kind-icon">is<wbr>InGrace<wbr>Period</a>
|
| 10270 | </li>
|
| 10271 | <li class=" tsd-kind-function tsd-is-private">
|
| 10272 | <a href="globals.html#isissuancedatevalid" class="tsd-kind-icon">is<wbr>Issuance<wbr>Date<wbr>Valid</a>
|
| 10273 | </li>
|
| 10274 | <li class=" tsd-kind-function tsd-is-private">
|
| 10275 | <a href="globals.html#islaterversion" class="tsd-kind-icon">is<wbr>Later<wbr>Version</a>
|
| 10276 | </li>
|
| 10277 | <li class=" tsd-kind-function tsd-is-private">
|
| 10278 | <a href="globals.html#ismanifesturivalid" class="tsd-kind-icon">is<wbr>Manifest<wbr>Uri<wbr>Valid</a>
|
| 10279 | </li>
|
| 10280 | <li class=" tsd-kind-function tsd-is-not-exported">
|
| 10281 | <a href="globals.html#isnameavailable" class="tsd-kind-icon">is<wbr>Name<wbr>Available</a>
|
| 10282 | </li>
|
| 10283 | <li class=" tsd-kind-function tsd-is-not-exported">
|
| 10284 | <a href="globals.html#isnamevalid" class="tsd-kind-icon">is<wbr>Name<wbr>Valid</a>
|
| 10285 | </li>
|
| 10286 | <li class=" tsd-kind-function tsd-is-not-exported">
|
| 10287 | <a href="globals.html#isnamespaceavailable" class="tsd-kind-icon">is<wbr>Namespace<wbr>Available</a>
|
| 10288 | </li>
|
| 10289 | <li class=" tsd-kind-function tsd-is-not-exported">
|
| 10290 | <a href="globals.html#isnamespacevalid" class="tsd-kind-icon">is<wbr>Namespace<wbr>Valid</a>
|
| 10291 | </li>
|
| 10292 | <li class=" tsd-kind-function tsd-is-private">
|
| 10293 | <a href="globals.html#isredirecturivalid" class="tsd-kind-icon">is<wbr>Redirect<wbr>Uri<wbr>Valid</a>
|
| 10294 | </li>
|
| 10295 | <li class=" tsd-kind-function tsd-is-private">
|
| 10296 | <a href="globals.html#issameoriginabsoluteurl" class="tsd-kind-icon">is<wbr>Same<wbr>Origin<wbr>Absolute<wbr>Url</a>
|
| 10297 | </li>
|
| 10298 | <li class=" tsd-kind-function">
|
| 10299 | <a href="globals.html#issigninpending" class="tsd-kind-icon">is<wbr>Sign<wbr>InPending</a>
|
| 10300 | </li>
|
| 10301 | <li class=" tsd-kind-function">
|
| 10302 | <a href="globals.html#isusersignedin" class="tsd-kind-icon">is<wbr>User<wbr>Signed<wbr>In</a>
|
| 10303 | </li>
|
| 10304 | <li class=" tsd-kind-function">
|
| 10305 | <a href="globals.html#launchcustomprotocol" class="tsd-kind-icon">launch<wbr>Custom<wbr>Protocol</a>
|
| 10306 | </li>
|
| 10307 | <li class=" tsd-kind-function">
|
| 10308 | <a href="globals.html#listfiles" class="tsd-kind-icon">list<wbr>Files</a>
|
| 10309 | </li>
|
| 10310 | <li class=" tsd-kind-function tsd-is-private tsd-is-not-exported">
|
| 10311 | <a href="globals.html#listfilesloop" class="tsd-kind-icon">list<wbr>Files<wbr>Loop</a>
|
| 10312 | </li>
|
| 10313 | <li class=" tsd-kind-function">
|
| 10314 | <a href="globals.html#loaduserdata" class="tsd-kind-icon">load<wbr>User<wbr>Data</a>
|
| 10315 | </li>
|
| 10316 | <li class=" tsd-kind-function">
|
| 10317 | <a href="globals.html#lookupprofile" class="tsd-kind-icon">lookup<wbr>Profile</a>
|
| 10318 | </li>
|
| 10319 | <li class=" tsd-kind-function tsd-is-private tsd-is-not-exported">
|
| 10320 | <a href="globals.html#makeannounce" class="tsd-kind-icon">make<wbr>Announce</a>
|
| 10321 | </li>
|
| 10322 | <li class=" tsd-kind-function">
|
| 10323 | <a href="globals.html#makeannounceskeleton" class="tsd-kind-icon">make<wbr>Announce<wbr>Skeleton</a>
|
| 10324 | </li>
|
| 10325 | <li class=" tsd-kind-function">
|
| 10326 | <a href="globals.html#makeauthrequest" class="tsd-kind-icon">make<wbr>Auth<wbr>Request</a>
|
| 10327 | </li>
|
| 10328 | <li class=" tsd-kind-function tsd-is-private">
|
| 10329 | <a href="globals.html#makeauthresponse" class="tsd-kind-icon">make<wbr>Auth<wbr>Response</a>
|
| 10330 | </li>
|
| 10331 | <li class=" tsd-kind-function tsd-is-private tsd-is-not-exported">
|
| 10332 | <a href="globals.html#makebitcoinspend" class="tsd-kind-icon">make<wbr>Bitcoin<wbr>Spend</a>
|
| 10333 | </li>
|
| 10334 | <li class=" tsd-kind-function tsd-is-private">
|
| 10335 | <a href="globals.html#makecoresessionrequest" class="tsd-kind-icon">make<wbr>Core<wbr>Session<wbr>Request</a>
|
| 10336 | </li>
|
| 10337 | <li class=" tsd-kind-function">
|
| 10338 | <a href="globals.html#makedidfromaddress" class="tsd-kind-icon">makeDIDFrom<wbr>Address</a>
|
| 10339 | </li>
|
| 10340 | <li class=" tsd-kind-function">
|
| 10341 | <a href="globals.html#makedidfrompublickey" class="tsd-kind-icon">makeDIDFrom<wbr>Public<wbr>Key</a>
|
| 10342 | </li>
|
| 10343 | <li class=" tsd-kind-function">
|
| 10344 | <a href="globals.html#makeecprivatekey" class="tsd-kind-icon">makeECPrivate<wbr>Key</a>
|
| 10345 | </li>
|
| 10346 | <li class=" tsd-kind-function tsd-is-not-exported">
|
| 10347 | <a href="globals.html#makelegacyauthtoken" class="tsd-kind-icon">make<wbr>Legacy<wbr>Auth<wbr>Token</a>
|
| 10348 | </li>
|
| 10349 | <li class=" tsd-kind-function tsd-is-private tsd-is-not-exported">
|
| 10350 | <a href="globals.html#makenameimport" class="tsd-kind-icon">make<wbr>Name<wbr>Import</a>
|
| 10351 | </li>
|
| 10352 | <li class=" tsd-kind-function">
|
| 10353 | <a href="globals.html#makenameimportskeleton" class="tsd-kind-icon">make<wbr>Name<wbr>Import<wbr>Skeleton</a>
|
| 10354 | </li>
|
| 10355 | <li class=" tsd-kind-function tsd-is-private tsd-is-not-exported">
|
| 10356 | <a href="globals.html#makenamespacepreorder" class="tsd-kind-icon">make<wbr>Namespace<wbr>Preorder</a>
|
| 10357 | </li>
|
| 10358 | <li class=" tsd-kind-function">
|
| 10359 | <a href="globals.html#makenamespacepreorderskeleton" class="tsd-kind-icon">make<wbr>Namespace<wbr>Preorder<wbr>Skeleton</a>
|
| 10360 | </li>
|
| 10361 | <li class=" tsd-kind-function tsd-is-private tsd-is-not-exported">
|
| 10362 | <a href="globals.html#makenamespaceready" class="tsd-kind-icon">make<wbr>Namespace<wbr>Ready</a>
|
| 10363 | </li>
|
| 10364 | <li class=" tsd-kind-function">
|
| 10365 | <a href="globals.html#makenamespacereadyskeleton" class="tsd-kind-icon">make<wbr>Namespace<wbr>Ready<wbr>Skeleton</a>
|
| 10366 | </li>
|
| 10367 | <li class=" tsd-kind-function tsd-is-private tsd-is-not-exported">
|
| 10368 | <a href="globals.html#makenamespacereveal" class="tsd-kind-icon">make<wbr>Namespace<wbr>Reveal</a>
|
| 10369 | </li>
|
| 10370 | <li class=" tsd-kind-function">
|
| 10371 | <a href="globals.html#makenamespacerevealskeleton" class="tsd-kind-icon">make<wbr>Namespace<wbr>Reveal<wbr>Skeleton</a>
|
| 10372 | </li>
|
| 10373 | <li class=" tsd-kind-function tsd-is-private tsd-is-not-exported">
|
| 10374 | <a href="globals.html#makepreorder" class="tsd-kind-icon">make<wbr>Preorder</a>
|
| 10375 | </li>
|
| 10376 | <li class=" tsd-kind-function">
|
| 10377 | <a href="globals.html#makepreorderskeleton" class="tsd-kind-icon">make<wbr>Preorder<wbr>Skeleton</a>
|
| 10378 | </li>
|
| 10379 | <li class=" tsd-kind-function">
|
| 10380 | <a href="globals.html#makeprofilezonefile" class="tsd-kind-icon">make<wbr>Profile<wbr>Zone<wbr>File</a>
|
| 10381 | </li>
|
| 10382 | <li class=" tsd-kind-function tsd-is-private tsd-is-not-exported">
|
| 10383 | <a href="globals.html#makeregister" class="tsd-kind-icon">make<wbr>Register</a>
|
| 10384 | </li>
|
| 10385 | <li class=" tsd-kind-function">
|
| 10386 | <a href="globals.html#makeregisterskeleton" class="tsd-kind-icon">make<wbr>Register<wbr>Skeleton</a>
|
| 10387 | </li>
|
| 10388 | <li class=" tsd-kind-function tsd-is-private tsd-is-not-exported">
|
| 10389 | <a href="globals.html#makerenewal" class="tsd-kind-icon">make<wbr>Renewal</a>
|
| 10390 | </li>
|
| 10391 | <li class=" tsd-kind-function">
|
| 10392 | <a href="globals.html#makerenewalskeleton" class="tsd-kind-icon">make<wbr>Renewal<wbr>Skeleton</a>
|
| 10393 | </li>
|
| 10394 | <li class=" tsd-kind-function tsd-is-private tsd-is-not-exported">
|
| 10395 | <a href="globals.html#makerevoke" class="tsd-kind-icon">make<wbr>Revoke</a>
|
| 10396 | </li>
|
| 10397 | <li class=" tsd-kind-function">
|
| 10398 | <a href="globals.html#makerevokeskeleton" class="tsd-kind-icon">make<wbr>Revoke<wbr>Skeleton</a>
|
| 10399 | </li>
|
| 10400 | <li class=" tsd-kind-function tsd-is-not-exported">
|
| 10401 | <a href="globals.html#maketxbuilder" class="tsd-kind-icon">makeTXbuilder</a>
|
| 10402 | </li>
|
| 10403 | <li class=" tsd-kind-function tsd-is-private tsd-is-not-exported">
|
| 10404 | <a href="globals.html#maketokentransfer" class="tsd-kind-icon">make<wbr>Token<wbr>Transfer</a>
|
| 10405 | </li>
|
| 10406 | <li class=" tsd-kind-function">
|
| 10407 | <a href="globals.html#maketokentransferskeleton" class="tsd-kind-icon">make<wbr>Token<wbr>Transfer<wbr>Skeleton</a>
|
| 10408 | </li>
|
| 10409 | <li class=" tsd-kind-function tsd-is-private tsd-is-not-exported">
|
| 10410 | <a href="globals.html#maketransfer" class="tsd-kind-icon">make<wbr>Transfer</a>
|
| 10411 | </li>
|
| 10412 | <li class=" tsd-kind-function">
|
| 10413 | <a href="globals.html#maketransferskeleton" class="tsd-kind-icon">make<wbr>Transfer<wbr>Skeleton</a>
|
| 10414 | </li>
|
| 10415 | <li class=" tsd-kind-function tsd-is-private">
|
| 10416 | <a href="globals.html#makeuuid4" class="tsd-kind-icon">makeUUID4</a>
|
| 10417 | </li>
|
| 10418 | <li class=" tsd-kind-function tsd-is-private tsd-is-not-exported">
|
| 10419 | <a href="globals.html#makeupdate" class="tsd-kind-icon">make<wbr>Update</a>
|
| 10420 | </li>
|
| 10421 | <li class=" tsd-kind-function">
|
| 10422 | <a href="globals.html#makeupdateskeleton" class="tsd-kind-icon">make<wbr>Update<wbr>Skeleton</a>
|
| 10423 | </li>
|
| 10424 | <li class=" tsd-kind-function tsd-is-not-exported">
|
| 10425 | <a href="globals.html#makev1gaiaauthtoken" class="tsd-kind-icon">make<wbr>V1Gaia<wbr>Auth<wbr>Token</a>
|
| 10426 | </li>
|
| 10427 | <li class=" tsd-kind-function tsd-is-not-exported">
|
| 10428 | <a href="globals.html#namespaceisready" class="tsd-kind-icon">namespace<wbr>IsReady</a>
|
| 10429 | </li>
|
| 10430 | <li class=" tsd-kind-function tsd-is-not-exported">
|
| 10431 | <a href="globals.html#namespaceisrevealed" class="tsd-kind-icon">namespace<wbr>IsRevealed</a>
|
| 10432 | </li>
|
| 10433 | <li class=" tsd-kind-function">
|
| 10434 | <a href="globals.html#nexthour" class="tsd-kind-icon">next<wbr>Hour</a>
|
| 10435 | </li>
|
| 10436 | <li class=" tsd-kind-function">
|
| 10437 | <a href="globals.html#nextmonth" class="tsd-kind-icon">next<wbr>Month</a>
|
| 10438 | </li>
|
| 10439 | <li class=" tsd-kind-function tsd-is-private">
|
| 10440 | <a href="globals.html#nextyear" class="tsd-kind-icon">next<wbr>Year</a>
|
| 10441 | </li>
|
| 10442 | <li class=" tsd-kind-function tsd-has-type-parameter tsd-is-not-exported">
|
| 10443 | <a href="globals.html#normalizeoptions" class="tsd-kind-icon">normalize<wbr>Options</a>
|
| 10444 | </li>
|
| 10445 | <li class=" tsd-kind-function tsd-is-not-exported">
|
| 10446 | <a href="globals.html#opencode" class="tsd-kind-icon">op<wbr>Encode</a>
|
| 10447 | </li>
|
| 10448 | <li class=" tsd-kind-function tsd-is-not-exported">
|
| 10449 | <a href="globals.html#outputbytes" class="tsd-kind-icon">output<wbr>Bytes</a>
|
| 10450 | </li>
|
| 10451 | <li class=" tsd-kind-function tsd-is-not-exported">
|
| 10452 | <a href="globals.html#ownsname" class="tsd-kind-icon">owns<wbr>Name</a>
|
| 10453 | </li>
|
| 10454 | <li class=" tsd-kind-function">
|
| 10455 | <a href="globals.html#publickeytoaddress" class="tsd-kind-icon">public<wbr>Key<wbr>ToAddress</a>
|
| 10456 | </li>
|
| 10457 | <li class=" tsd-kind-function">
|
| 10458 | <a href="globals.html#putfile" class="tsd-kind-icon">put<wbr>File</a>
|
| 10459 | </li>
|
| 10460 | <li class=" tsd-kind-function">
|
| 10461 | <a href="globals.html#redirecttosignin" class="tsd-kind-icon">redirect<wbr>ToSign<wbr>In</a>
|
| 10462 | </li>
|
| 10463 | <li class=" tsd-kind-function">
|
| 10464 | <a href="globals.html#redirecttosigninwithauthrequest" class="tsd-kind-icon">redirect<wbr>ToSign<wbr>InWith<wbr>Auth<wbr>Request</a>
|
| 10465 | </li>
|
| 10466 | <li class=" tsd-kind-function tsd-is-private">
|
| 10467 | <a href="globals.html#redirectusertoapp" class="tsd-kind-icon">redirect<wbr>User<wbr>ToApp</a>
|
| 10468 | </li>
|
| 10469 | <li class=" tsd-kind-function">
|
| 10470 | <a href="globals.html#resolvezonefiletoperson" class="tsd-kind-icon">resolve<wbr>Zone<wbr>File<wbr>ToPerson</a>
|
| 10471 | </li>
|
| 10472 | <li class=" tsd-kind-function">
|
| 10473 | <a href="globals.html#resolvezonefiletoprofile" class="tsd-kind-icon">resolve<wbr>Zone<wbr>File<wbr>ToProfile</a>
|
| 10474 | </li>
|
| 10475 | <li class=" tsd-kind-function tsd-is-not-exported">
|
| 10476 | <a href="globals.html#returntransactionhex" class="tsd-kind-icon">return<wbr>Transaction<wbr>Hex</a>
|
| 10477 | </li>
|
| 10478 | <li class=" tsd-kind-function tsd-is-not-exported">
|
| 10479 | <a href="globals.html#revealednamespace" class="tsd-kind-icon">revealed<wbr>Namespace</a>
|
| 10480 | </li>
|
| 10481 | <li class=" tsd-kind-function tsd-is-private">
|
| 10482 | <a href="globals.html#sendcoresessionrequest" class="tsd-kind-icon">send<wbr>Core<wbr>Session<wbr>Request</a>
|
| 10483 | </li>
|
| 10484 | <li class=" tsd-kind-function tsd-is-not-exported">
|
| 10485 | <a href="globals.html#sharedsecrettokeys" class="tsd-kind-icon">shared<wbr>Secret<wbr>ToKeys</a>
|
| 10486 | </li>
|
| 10487 | <li class=" tsd-kind-function tsd-is-private">
|
| 10488 | <a href="globals.html#signecdsa" class="tsd-kind-icon">signECDSA</a>
|
| 10489 | </li>
|
| 10490 | <li class=" tsd-kind-function">
|
| 10491 | <a href="globals.html#signinputs" class="tsd-kind-icon">sign<wbr>Inputs</a>
|
| 10492 | </li>
|
| 10493 | <li class=" tsd-kind-function">
|
| 10494 | <a href="globals.html#signprofiletoken" class="tsd-kind-icon">sign<wbr>Profile<wbr>Token</a>
|
| 10495 | </li>
|
| 10496 | <li class=" tsd-kind-function">
|
| 10497 | <a href="globals.html#signuserout" class="tsd-kind-icon">sign<wbr>User<wbr>Out</a>
|
| 10498 | </li>
|
| 10499 | <li class=" tsd-kind-function">
|
| 10500 | <a href="globals.html#sumoutputvalues" class="tsd-kind-icon">sum<wbr>Output<wbr>Values</a>
|
| 10501 | </li>
|
| 10502 | <li class=" tsd-kind-function tsd-is-not-exported">
|
| 10503 | <a href="globals.html#transactionbytes" class="tsd-kind-icon">transaction<wbr>Bytes</a>
|
| 10504 | </li>
|
| 10505 | <li class=" tsd-kind-function tsd-is-private">
|
| 10506 | <a href="globals.html#updatequerystringparameter" class="tsd-kind-icon">update<wbr>Query<wbr>String<wbr>Parameter</a>
|
| 10507 | </li>
|
| 10508 | <li class=" tsd-kind-function">
|
| 10509 | <a href="globals.html#uploadtogaiahub" class="tsd-kind-icon">upload<wbr>ToGaia<wbr>Hub</a>
|
| 10510 | </li>
|
| 10511 | <li class=" tsd-kind-function">
|
| 10512 | <a href="globals.html#validateproofs" class="tsd-kind-icon">validate<wbr>Proofs</a>
|
| 10513 | </li>
|
| 10514 | <li class=" tsd-kind-function">
|
| 10515 | <a href="globals.html#verifyauthrequest" class="tsd-kind-icon">verify<wbr>Auth<wbr>Request</a>
|
| 10516 | </li>
|
| 10517 | <li class=" tsd-kind-function tsd-is-private">
|
| 10518 | <a href="globals.html#verifyauthrequestandloadmanifest" class="tsd-kind-icon">verify<wbr>Auth<wbr>Request<wbr>And<wbr>Load<wbr>Manifest</a>
|
| 10519 | </li>
|
| 10520 | <li class=" tsd-kind-function tsd-is-private">
|
| 10521 | <a href="globals.html#verifyauthresponse" class="tsd-kind-icon">verify<wbr>Auth<wbr>Response</a>
|
| 10522 | </li>
|
| 10523 | <li class=" tsd-kind-function tsd-is-private">
|
| 10524 | <a href="globals.html#verifyecdsa" class="tsd-kind-icon">verifyECDSA</a>
|
| 10525 | </li>
|
| 10526 | <li class=" tsd-kind-function">
|
| 10527 | <a href="globals.html#verifyprofiletoken" class="tsd-kind-icon">verify<wbr>Profile<wbr>Token</a>
|
| 10528 | </li>
|
| 10529 | <li class=" tsd-kind-function">
|
| 10530 | <a href="globals.html#wrapprofiletoken" class="tsd-kind-icon">wrap<wbr>Profile<wbr>Token</a>
|
| 10531 | </li>
|
| 10532 | <li class=" tsd-kind-object-literal tsd-is-not-exported">
|
| 10533 | <a href="globals.html#default_profile" class="tsd-kind-icon">DEFAULT_<wbr>PROFILE</a>
|
| 10534 | </li>
|
| 10535 | <li class=" tsd-kind-object-literal">
|
| 10536 | <a href="globals.html#error_codes" class="tsd-kind-icon">ERROR_<wbr>CODES</a>
|
| 10537 | </li>
|
| 10538 | <li class=" tsd-kind-object-literal tsd-is-not-exported">
|
| 10539 | <a href="globals.html#config" class="tsd-kind-icon">config</a>
|
| 10540 | </li>
|
| 10541 | <li class=" tsd-kind-object-literal">
|
| 10542 | <a href="globals.html#network" class="tsd-kind-icon">network</a>
|
| 10543 | </li>
|
| 10544 | <li class=" tsd-kind-object-literal">
|
| 10545 | <a href="globals.html#profileservices" class="tsd-kind-icon">profile<wbr>Services</a>
|
| 10546 | </li>
|
| 10547 | <li class=" tsd-kind-object-literal">
|
| 10548 | <a href="globals.html#safety" class="tsd-kind-icon">safety</a>
|
| 10549 | </li>
|
| 10550 | <li class=" tsd-kind-object-literal tsd-is-not-exported">
|
| 10551 | <a href="globals.html#schemadefinition" class="tsd-kind-icon">schema<wbr>Definition</a>
|
| 10552 | </li>
|
| 10553 | <li class=" tsd-kind-object-literal">
|
| 10554 | <a href="globals.html#transactions" class="tsd-kind-icon">transactions</a>
|
| 10555 | </li>
|
| 10556 | </ul>
|
| 10557 | </nav>
|
| 10558 | </div>
|
| 10559 | </div>
|
| 10560 | </div>
|
| 10561 | <footer class="with-border-bottom">
|
| 10562 | <div class="container">
|
| 10563 | <h2>Legend</h2>
|
| 10564 | <div class="tsd-legend-group">
|
| 10565 | <ul class="tsd-legend">
|
| 10566 | <li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
|
| 10567 | <li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
|
| 10568 | <li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
|
| 10569 | <li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
|
| 10570 | <li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
|
| 10571 | <li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
|
| 10572 | <li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
|
| 10573 | </ul>
|
| 10574 | <ul class="tsd-legend">
|
| 10575 | <li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
|
| 10576 | <li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
|
| 10577 | <li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
|
| 10578 | <li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
|
| 10579 | </ul>
|
| 10580 | <ul class="tsd-legend">
|
| 10581 | <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
|
| 10582 | <li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
|
| 10583 | <li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
|
| 10584 | <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
|
| 10585 | <li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
|
| 10586 | <li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
|
| 10587 | </ul>
|
| 10588 | <ul class="tsd-legend">
|
| 10589 | <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
|
| 10590 | <li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
|
| 10591 | <li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
|
| 10592 | <li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
|
| 10593 | <li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
|
| 10594 | <li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
|
| 10595 | <li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
|
| 10596 | </ul>
|
| 10597 | <ul class="tsd-legend">
|
| 10598 | <li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
|
| 10599 | <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
|
| 10600 | <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
|
| 10601 | <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
|
| 10602 | </ul>
|
| 10603 | <ul class="tsd-legend">
|
| 10604 | <li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
|
| 10605 | <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
|
| 10606 | <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
|
| 10607 | </ul>
|
| 10608 | <ul class="tsd-legend">
|
| 10609 | <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
|
| 10610 | <li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
|
| 10611 | <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
|
| 10612 | </ul>
|
| 10613 | <ul class="tsd-legend">
|
| 10614 | <li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
|
| 10615 | <li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
|
| 10616 | </ul>
|
| 10617 | </div>
|
| 10618 | </div>
|
| 10619 | </footer>
|
| 10620 | <div class="container tsd-generator">
|
| 10621 | <p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p>
|
| 10622 | </div>
|
| 10623 | <div class="overlay"></div>
|
| 10624 | <script src="assets/js/main.js"></script>
|
| 10625 | <script>if (location.protocol == 'file:') document.write('<script src="assets/js/search.js"><' + '/script>');</script>
|
| 10626 | </body>
|
| 10627 | </html> |
| \ | No newline at end of file |