This commit is contained in:
Ken
2019-02-14 17:19:52 -05:00
parent 71daa81a01
commit 22b8dcf55d
4 changed files with 2330 additions and 1657 deletions

2714
dist/blockstack.js vendored

File diff suppressed because one or more lines are too long

1035
docs.json

File diff suppressed because it is too large Load Diff

View File

@@ -2,7 +2,7 @@
<html>
<head>
<meta charset='utf-8' />
<title>blockstack 19.0.0-alpha.4 | Documentation</title>
<title>blockstack 19.0.0-alpha.5 | Documentation</title>
<meta name='viewport' content='width=device-width,initial-scale=1'>
<link href='assets/bass.css' type='text/css' rel='stylesheet' />
<link href='assets/style.css' type='text/css' rel='stylesheet' />
@@ -15,7 +15,7 @@
<div id='split-left' class='overflow-auto fs0 height-viewport-100'>
<div class='py1 px2'>
<h3 class='mb0 no-anchor'>blockstack</h3>
<div class='mb1'><code>19.0.0-alpha.4</code></div>
<div class='mb1'><code>19.0.0-alpha.5</code></div>
<input
placeholder='Filter'
id='filter-input'
@@ -471,6 +471,16 @@
</li>
<li><a
href='#detectprotocollaunch'
class="">
detectProtocolLaunch
</a>
</li>
<li><a
href='#getnameprice'
class="">
@@ -600,16 +610,6 @@
</li>
<li><a
href='#estimatetokentransfer'
class="">
estimateTokenTransfer
</a>
</li>
</ul>
</div>
<div class='mt1 h6 quiet'>
@@ -5365,6 +5365,95 @@ returns
</section>
<section class='p2 mb2 clearfix bg-white minishadow'>
<div class='clearfix'>
<h3 class='fl m0' id='detectprotocollaunch'>
detectProtocolLaunch
</h3>
</div>
<p>Detects if the native auth-browser is installed and is successfully
launched via a custom protocol URI.</p>
<div class='pre p1 fill-light mt0'>detectProtocolLaunch(authRequest: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">String</a>, successCallback: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">String</a>, failCallback: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">String</a>): void</div>
<div class='py1 quiet mt1 prose-big'>Parameters</div>
<div class='prose'>
<div class='space-bottom0'>
<div>
<span class='code bold'>authRequest</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">String</a>)</code>
The encoded authRequest to be used as a query param in the custom URI.
</div>
</div>
<div class='space-bottom0'>
<div>
<span class='code bold'>successCallback</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">String</a>)</code>
The callback that is invoked when the protocol handler was detected.
</div>
</div>
<div class='space-bottom0'>
<div>
<span class='code bold'>failCallback</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">String</a>)</code>
The callback that is invoked when the protocol handler was not detected.
</div>
</div>
</div>
<div class='py1 quiet mt1 prose-big'>Returns</div>
<code>void</code>:
</section>
@@ -6318,127 +6407,6 @@ held by this account.
</section>
<section class='p2 mb2 clearfix bg-white minishadow'>
<div class='clearfix'>
<h3 class='fl m0' id='estimatetokentransfer'>
estimateTokenTransfer
</h3>
</div>
<p>Estimates the cost of a token-transfer transaction</p>
<div class='pre p1 fill-light mt0'>estimateTokenTransfer(recipientAddress: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">String</a>, tokenType: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">String</a>, tokenAmount: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a>, scratchArea: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">String</a>, senderUtxos: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number">Number</a>, additionalOutputs: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number">Number</a>): <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise">Promise</a></div>
<div class='py1 quiet mt1 prose-big'>Parameters</div>
<div class='prose'>
<div class='space-bottom0'>
<div>
<span class='code bold'>recipientAddress</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">String</a>)</code>
the recipient of the tokens
</div>
</div>
<div class='space-bottom0'>
<div>
<span class='code bold'>tokenType</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">String</a>)</code>
the type of token to spend
</div>
</div>
<div class='space-bottom0'>
<div>
<span class='code bold'>tokenAmount</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a>)</code>
a 64-bit unsigned BigInteger encoding the number of tokens
to spend
</div>
</div>
<div class='space-bottom0'>
<div>
<span class='code bold'>scratchArea</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">String</a>)</code>
an arbitrary string to store with the transaction
</div>
</div>
<div class='space-bottom0'>
<div>
<span class='code bold'>senderUtxos</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number">Number</a>
= <code>1</code>)</code>
the number of utxos we expect will
be required from the importer address
</div>
</div>
<div class='space-bottom0'>
<div>
<span class='code bold'>additionalOutputs</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number">Number</a>
= <code>1</code>)</code>
the number of outputs we expect to add beyond
just the recipient output (default = 1, if the token owner is also the bitcoin funder)
</div>
</div>
</div>
<div class='py1 quiet mt1 prose-big'>Returns</div>
<code><a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise">Promise</a></code>:
a promise which resolves to the satoshi cost to
fund this token-transfer transaction
</section>

View File

@@ -348,9 +348,7 @@ function detectProtocolLaunch(
* @private
*/
export function redirectToSignInWithAuthRequestImpl(caller: UserSession,
authRequest: string,
blockstackIDHost: string =
DEFAULT_BLOCKSTACK_HOST) {
authRequest: string) {
let httpsURI = `${DEFAULT_BLOCKSTACK_HOST}?authRequest=${authRequest}`
if (caller.appConfig