<li class="dropdown">
<a href="modules.list.html" class="dropdown-toggle" data-toggle="dropdown">Modules<b class="caret"></b></a>
<ul class="dropdown-menu ">
- <li><a href="module-AccessTokensApi.html">AccessTokensApi</a></li><li><a href="module-AccountsApi.html">AccountsApi</a></li><li><a href="module-AssetsApi.html">AssetsApi</a></li><li><a href="module-BalancesApi.html">BalancesApi</a></li><li><a href="module-KeysApi.html">KeysApi</a></li><li><a href="module-TransactionsApi.html">TransactionsApi</a></li><li><a href="module-UnspentOutputsApi.html">UnspentOutputsApi</a></li>
+ <li><a href="module-AccessTokensApi.html">AccessTokensApi</a></li><li><a href="module-AccountsApi.html">AccountsApi</a></li><li><a href="module-AssetsApi.html">AssetsApi</a></li><li><a href="module-BalancesApi.html">BalancesApi</a></li><li><a href="module-BlockAPI.html">BlockAPI</a></li><li><a href="module-ConfigApi.html">ConfigApi</a></li><li><a href="module-KeysApi.html">KeysApi</a></li><li><a href="module-TransactionsApi.html">TransactionsApi</a></li><li><a href="module-UnspentOutputsApi.html">UnspentOutputsApi</a></li>
+ </ul>
+ </li>
+
+ <li class="dropdown">
+ <a href="classes.list.html" class="dropdown-toggle" data-toggle="dropdown">Classes<b class="caret"></b></a>
+ <ul class="dropdown-menu ">
+ <li><a href="TransactionBuilder.html">TransactionBuilder</a></li>
</ul>
</li>
<dd>
<div class="description">
- <p>Access tokens are <code>name:secret-token</code> pairs that are granted authorization for accessing Chain Core features.</p>
+ <p>Access tokens are <code>name:secret-token</code> pairs that are granted authorization for accessing Bytom Core features.</p>
</div>
<hr>
+<dt class="name" id="BlockInfo">
+ <h4 id="BlockInfo">BlockInfo</h4>
+
+
+</dt>
+<dd>
+
+
+
+ <h5>Type:</h5>
+ <ul>
+ <li>
+
+<span class="param-type">Object</span>
+
+
+
+ </li>
+ </ul>
+
+
+
+<dl class="details">
+
+
+ <h5 class="subsection-title">Properties:</h5>
+
+ <dl>
+
+<table class="props table table-striped">
+ <thead>
+ <tr>
+
+ <th>Name</th>
+
+
+ <th>Type</th>
+
+
+
+
+
+ <th class="last">Description</th>
+ </tr>
+ </thead>
+
+ <tbody>
+
+
+ <tr>
+
+ <td class="name"><code>hash</code></td>
+
+
+ <td class="type">
+
+
+<span class="param-type">String</span>
+
+
+
+
+ </td>
+
+
+
+
+
+ <td class="description last"><p>hash of block.</p></td>
+ </tr>
+
+
+
+ <tr>
+
+ <td class="name"><code>size</code></td>
+
+
+ <td class="type">
+
+
+<span class="param-type">Integer</span>
+
+
+
+
+ </td>
+
+
+
+
+
+ <td class="description last"><p>size of block.</p></td>
+ </tr>
+
+
+
+ <tr>
+
+ <td class="name"><code>version</code></td>
+
+
+ <td class="type">
+
+
+<span class="param-type">Integer</span>
+
+
+
+
+ </td>
+
+
+
+
+
+ <td class="description last"><p>version of block.</p></td>
+ </tr>
+
+
+
+ <tr>
+
+ <td class="name"><code>height</code></td>
+
+
+ <td class="type">
+
+
+<span class="param-type">Integer</span>
+
+
+
+
+ </td>
+
+
+
+
+
+ <td class="description last"><p>height of block.</p></td>
+ </tr>
+
+
+
+ <tr>
+
+ <td class="name"><code>previous_block_hash</code></td>
+
+
+ <td class="type">
+
+
+<span class="param-type">String</span>
+
+
+
+
+ </td>
+
+
+
+
+
+ <td class="description last"><p>previous block hash.</p></td>
+ </tr>
+
+
+
+ <tr>
+
+ <td class="name"><code>timestamp</code></td>
+
+
+ <td class="type">
+
+
+<span class="param-type">Integer</span>
+
+
+
+
+ </td>
+
+
+
+
+
+ <td class="description last"><p>timestamp of block.</p></td>
+ </tr>
+
+
+
+ <tr>
+
+ <td class="name"><code>nonce</code></td>
+
+
+ <td class="type">
+
+
+<span class="param-type">Integer</span>
+
+
+
+
+ </td>
+
+
+
+
+
+ <td class="description last"><p>nonce value.</p></td>
+ </tr>
+
+
+
+ <tr>
+
+ <td class="name"><code>bits</code></td>
+
+
+ <td class="type">
+
+
+<span class="param-type">Integer</span>
+
+
+
+
+ </td>
+
+
+
+
+
+ <td class="description last"><p>bits of difficulty.</p></td>
+ </tr>
+
+
+
+ <tr>
+
+ <td class="name"><code>difficulty</code></td>
+
+
+ <td class="type">
+
+
+<span class="param-type">String</span>
+
+
+
+
+ </td>
+
+
+
+
+
+ <td class="description last"><p>difficulty value(String type).</p></td>
+ </tr>
+
+
+
+ <tr>
+
+ <td class="name"><code>transaction_merkle_root</code></td>
+
+
+ <td class="type">
+
+
+<span class="param-type">String</span>
+
+
+
+
+ </td>
+
+
+
+
+
+ <td class="description last"><p>merkle root of transaction.</p></td>
+ </tr>
+
+
+
+ <tr>
+
+ <td class="name"><code>transaction_status_hash</code></td>
+
+
+ <td class="type">
+
+
+<span class="param-type">String</span>
+
+
+
+
+ </td>
+
+
+
+
+
+ <td class="description last"><p>merkle root of transaction status.</p></td>
+ </tr>
+
+
+
+ <tr>
+
+ <td class="name"><code>transactions</code></td>
+
+
+ <td class="type">
+
+
+<span class="param-type">Array.<Object></span>
+
+
+
+
+ </td>
+
+
+
+
+
+ <td class="description last"><p>transaction object:</p>
+ <h6>Properties</h6>
+
+<table class="props table table-striped">
+ <thead>
+ <tr>
+
+ <th>Name</th>
+
+
+ <th>Type</th>
+
+
+
+
+
+ <th class="last">Description</th>
+ </tr>
+ </thead>
+
+ <tbody>
+
+
+ <tr>
+
+ <td class="name"><code>id</code></td>
+
+
+ <td class="type">
+
+
+<span class="param-type">String</span>
+
+
+
+
+ </td>
+
+
+
+
+
+ <td class="description last"><p>transaction id, hash of the transaction.</p></td>
+ </tr>
+
+
+
+ <tr>
+
+ <td class="name"><code>version</code></td>
+
+
+ <td class="type">
+
+
+<span class="param-type">Integer</span>
+
+
+
+
+ </td>
+
+
+
+
+
+ <td class="description last"><p>version of transaction.</p></td>
+ </tr>
+
+
+
+ <tr>
+
+ <td class="name"><code>size</code></td>
+
+
+ <td class="type">
+
+
+<span class="param-type">Integer</span>
+
+
+
+
+ </td>
+
+
+
+
+
+ <td class="description last"><p>size of transaction.</p></td>
+ </tr>
+
+
+
+ <tr>
+
+ <td class="name"><code>time_range</code></td>
+
+
+ <td class="type">
+
+
+<span class="param-type">Integer</span>
+
+
+
+
+ </td>
+
+
+
+
+
+ <td class="description last"><p>the unix timestamp for when the requst was responsed.</p></td>
+ </tr>
+
+
+
+ <tr>
+
+ <td class="name"><code>status_fail</code></td>
+
+
+ <td class="type">
+
+
+<span class="param-type">Boolean</span>
+
+
+
+
+ </td>
+
+
+
+
+
+ <td class="description last"><p>whether the state of the request has failed.</p></td>
+ </tr>
+
+
+
+ <tr>
+
+ <td class="name"><code>mux_id</code></td>
+
+
+ <td class="type">
+
+
+<span class="param-type">String</span>
+
+
+
+
+ </td>
+
+
+
+
+
+ <td class="description last"><p>the previous transaction mux id(source id of utxo).</p></td>
+ </tr>
+
+
+ </tbody>
+</table>
+
+ </td>
+ </tr>
+
+
+
+ <tr>
+
+ <td class="name"><code>inputs</code></td>
+
+
+ <td class="type">
+
+
+<span class="param-type">Array.<Object></span>
+
+
+
+
+ </td>
+
+
+
+
+
+ <td class="description last"><p>object of inputs for the transaction.</p>
+ <h6>Properties</h6>
+
+<table class="props table table-striped">
+ <thead>
+ <tr>
+
+ <th>Name</th>
+
+
+ <th>Type</th>
+
+
+
+
+
+ <th class="last">Description</th>
+ </tr>
+ </thead>
+
+ <tbody>
+
+
+ <tr>
+
+ <td class="name"><code>type</code></td>
+
+
+ <td class="type">
+
+
+<span class="param-type">String</span>
+
+
+
+
+ </td>
+
+
+
+
+
+ <td class="description last"><p>the type of input action, available option include: 'spend', 'issue', 'coinbase'.</p></td>
+ </tr>
+
+
+
+ <tr>
+
+ <td class="name"><code>asset_id</code></td>
+
+
+ <td class="type">
+
+
+<span class="param-type">String</span>
+
+
+
+
+ </td>
+
+
+
+
+
+ <td class="description last"><p>asset id.</p></td>
+ </tr>
+
+
+
+ <tr>
+
+ <td class="name"><code>asset_alias</code></td>
+
+
+ <td class="type">
+
+
+<span class="param-type">String</span>
+
+
+
+
+ </td>
+
+
+
+
+
+ <td class="description last"><p>name of asset.</p></td>
+ </tr>
+
+
+
+ <tr>
+
+ <td class="name"><code>asset_definition</code></td>
+
+
+ <td class="type">
+
+
+<span class="param-type">Object</span>
+
+
+
+
+ </td>
+
+
+
+
+
+ <td class="description last"><p>definition of asset(json object).</p></td>
+ </tr>
+
+
+
+ <tr>
+
+ <td class="name"><code>amount</code></td>
+
+
+ <td class="type">
+
+
+<span class="param-type">Integer</span>
+
+
+
+
+ </td>
+
+
+
+
+
+ <td class="description last"><p>amount of asset.</p></td>
+ </tr>
+
+
+
+ <tr>
+
+ <td class="name"><code>issuance_program</code></td>
+
+
+ <td class="type">
+
+
+<span class="param-type">Object</span>
+
+
+
+
+ </td>
+
+
+
+
+
+ <td class="description last"><p>issuance program, it only exist when type is 'issue'.</p></td>
+ </tr>
+
+
+
+ <tr>
+
+ <td class="name"><code>control_program</code></td>
+
+
+ <td class="type">
+
+
+<span class="param-type">Object</span>
+
+
+
+
+ </td>
+
+
+
+
+
+ <td class="description last"><p>control program of account, it only exist when type is 'spend'.</p></td>
+ </tr>
+
+
+
+ <tr>
+
+ <td class="name"><code>address</code></td>
+
+
+ <td class="type">
+
+
+<span class="param-type">String</span>
+
+
+
+
+ </td>
+
+
+
+
+
+ <td class="description last"><p>address of account, it only exist when type is 'spend'.</p></td>
+ </tr>
+
+
+
+ <tr>
+
+ <td class="name"><code>spent_output_id</code></td>
+
+
+ <td class="type">
+
+
+<span class="param-type">String</span>
+
+
+
+
+ </td>
+
+
+
+
+
+ <td class="description last"><p>the front of outputID to be spent in this input, it only exist when type is 'spend'.</p></td>
+ </tr>
+
+
+
+ <tr>
+
+ <td class="name"><code>account_id</code></td>
+
+
+ <td class="type">
+
+
+<span class="param-type">String</span>
+
+
+
+
+ </td>
+
+
+
+
+
+ <td class="description last"><p>account id.</p></td>
+ </tr>
+
+
+
+ <tr>
+
+ <td class="name"><code>account_alias</code></td>
+
+
+ <td class="type">
+
+
+<span class="param-type">String</span>
+
+
+
+
+ </td>
+
+
+
+
+
+ <td class="description last"><p>name of account.</p></td>
+ </tr>
+
+
+
+ <tr>
+
+ <td class="name"><code>arbitrary</code></td>
+
+
+ <td class="type">
+
+
+<span class="param-type">Object</span>
+
+
+
+
+ </td>
+
+
+
+
+
+ <td class="description last"><p>arbitrary infomation can be set by miner, it only exist when type is 'coinbase'.</p></td>
+ </tr>
+
+
+
+ <tr>
+
+ <td class="name"><code>input_id</code></td>
+
+
+ <td class="type">
+
+
+<span class="param-type">String</span>
+
+
+
+
+ </td>
+
+
+
+
+
+ <td class="description last"><p>hash of input action.</p></td>
+ </tr>
+
+
+
+ <tr>
+
+ <td class="name"><code>witness_arguments</code></td>
+
+
+ <td class="type">
+
+
+<span class="param-type">Array.<String></span>
+
+
+
+
+ </td>
+
+
+
+
+
+ <td class="description last"><p>witness arguments.</p></td>
+ </tr>
+
+
+ </tbody>
+</table>
+
+ </td>
+ </tr>
+
+
+
+ <tr>
+
+ <td class="name"><code>outputs</code></td>
+
+
+ <td class="type">
+
+
+<span class="param-type">Array.<Object></span>
+
+
+
+
+ </td>
+
+
+
+
+
+ <td class="description last"><p>object of outputs for the transaction.</p>
+ <h6>Properties</h6>
+
+<table class="props table table-striped">
+ <thead>
+ <tr>
+
+ <th>Name</th>
+
+
+ <th>Type</th>
+
+
+
+
+
+ <th class="last">Description</th>
+ </tr>
+ </thead>
+
+ <tbody>
+
+
+ <tr>
+
+ <td class="name"><code>type</code></td>
+
+
+ <td class="type">
+
+
+<span class="param-type">String</span>
+
+
+
+
+ </td>
+
+
+
+
+
+ <td class="description last"><p>the type of output action, available option include: 'retire', 'control'.</p></td>
+ </tr>
+
+
+
+ <tr>
+
+ <td class="name"><code>id</code></td>
+
+
+ <td class="type">
+
+
+<span class="param-type">String</span>
+
+
+
+
+ </td>
+
+
+
+
+
+ <td class="description last"><p>outputid related to utxo.</p></td>
+ </tr>
+
+
+
+ <tr>
+
+ <td class="name"><code>position</code></td>
+
+
+ <td class="type">
+
+
+<span class="param-type">Integer</span>
+
+
+
+
+ </td>
+
+
+
+
+
+ <td class="description last"><p>position of outputs.</p></td>
+ </tr>
+
+
+
+ <tr>
+
+ <td class="name"><code>asset_id</code></td>
+
+
+ <td class="type">
+
+
+<span class="param-type">String</span>
+
+
+
+
+ </td>
+
+
+
+
+
+ <td class="description last"><p>asset id.</p></td>
+ </tr>
+
+
+
+ <tr>
+
+ <td class="name"><code>asset_alias</code></td>
+
+
+ <td class="type">
+
+
+<span class="param-type">String</span>
+
+
+
+
+ </td>
+
+
+
+
+
+ <td class="description last"><p>name of asset.</p></td>
+ </tr>
+
+
+
+ <tr>
+
+ <td class="name"><code>asset_definition</code></td>
+
+
+ <td class="type">
+
+
+<span class="param-type">Object</span>
+
+
+
+
+ </td>
+
+
+
+
+
+ <td class="description last"><p>definition of asset(json object).</p></td>
+ </tr>
+
+
+
+ <tr>
+
+ <td class="name"><code>amount</code></td>
+
+
+ <td class="type">
+
+
+<span class="param-type">Integer</span>
+
+
+
+
+ </td>
+
+
+
+
+
+ <td class="description last"><p>amount of asset.</p></td>
+ </tr>
+
+
+
+ <tr>
+
+ <td class="name"><code>account_id</code></td>
+
+
+ <td class="type">
+
+
+<span class="param-type">String</span>
+
+
+
+
+ </td>
+
+
+
+
+
+ <td class="description last"><p>account id.</p></td>
+ </tr>
+
+
+
+ <tr>
+
+ <td class="name"><code>account_alias</code></td>
+
+
+ <td class="type">
+
+
+<span class="param-type">String</span>
+
+
+
+
+ </td>
+
+
+
+
+
+ <td class="description last"><p>name of account.</p></td>
+ </tr>
+
+
+
+ <tr>
+
+ <td class="name"><code>control_program</code></td>
+
+
+ <td class="type">
+
+
+<span class="param-type">Object</span>
+
+
+
+
+ </td>
+
+
+
+
+
+ <td class="description last"><p>control program of account.</p></td>
+ </tr>
+
+
+
+ <tr>
+
+ <td class="name"><code>address</code></td>
+
+
+ <td class="type">
+
+
+<span class="param-type">String</span>
+
+
+
+
+ </td>
+
+
+
+
+
+ <td class="description last"><p>address of account.</p></td>
+ </tr>
+
+
+ </tbody>
+</table>
+
+ </td>
+ </tr>
+
+
+ </tbody>
+</table>
+</dl>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+</dl>
+
+
+
+</dd>
+
+
+
+<hr>
+<dt class="name" id="CoreInfo">
+ <h4 id="CoreInfo">CoreInfo</h4>
+
+
+</dt>
+<dd>
+
+ <div class="description">
+ <p>Basic information about the configuration of Bytom Core, as well as any
+errors encountered when updating the local state of the blockchain</p>
+<p>More info: {}</p>
+ </div>
+
+
+
+ <h5>Type:</h5>
+ <ul>
+ <li>
+
+<span class="param-type">Object</span>
+
+
+
+ </li>
+ </ul>
+
+
+
+<dl class="details">
+
+
+ <h5 class="subsection-title">Properties:</h5>
+
+ <dl>
+
+<table class="props table table-striped">
+ <thead>
+ <tr>
+
+ <th>Name</th>
+
+
+ <th>Type</th>
+
+
+
+
+
+ <th class="last">Description</th>
+ </tr>
+ </thead>
+
+ <tbody>
+
+
+ <tr>
+
+ <td class="name"><code>listening</code></td>
+
+
+ <td class="type">
+
+
+<span class="param-type">Boolean</span>
+
+
+
+
+ </td>
+
+
+
+
+
+ <td class="description last"><p>whether the node is listening.</p></td>
+ </tr>
+
+
+
+ <tr>
+
+ <td class="name"><code>syncing</code></td>
+
+
+ <td class="type">
+
+
+<span class="param-type">Boolean</span>
+
+
+
+
+ </td>
+
+
+
+
+
+ <td class="description last"><p>whether the node is syncing.</p></td>
+ </tr>
+
+
+
+ <tr>
+
+ <td class="name"><code>mining</code></td>
+
+
+ <td class="type">
+
+
+<span class="param-type">Boolean</span>
+
+
+
+
+ </td>
+
+
+
+
+
+ <td class="description last"><p>whether the node is mining.</p></td>
+ </tr>
+
+
+
+ <tr>
+
+ <td class="name"><code>peer_count</code></td>
+
+
+ <td class="type">
+
+
+<span class="param-type">Integer</span>
+
+
+
+
+ </td>
+
+
+
+
+
+ <td class="description last"><p>current count of connected peers.</p></td>
+ </tr>
+
+
+
+ <tr>
+
+ <td class="name"><code>current_block</code></td>
+
+
+ <td class="type">
+
+
+<span class="param-type">Integer</span>
+
+
+
+
+ </td>
+
+
+
+
+
+ <td class="description last"><p>current block height in the node's blockchain.</p></td>
+ </tr>
+
+
+
+ <tr>
+
+ <td class="name"><code>highest_block</code></td>
+
+
+ <td class="type">
+
+
+<span class="param-type">Integer</span>
+
+
+
+
+ </td>
+
+
+
+
+
+ <td class="description last"><p>current highest block of the connected peers.</p></td>
+ </tr>
+
+
+
+ <tr>
+
+ <td class="name"><code>network_id</code></td>
+
+
+ <td class="type">
+
+
+<span class="param-type">String</span>
+
+
+
+
+ </td>
+
+
+
+
+
+ <td class="description last"><p>network id.</p></td>
+ </tr>
+
+
+
+ <tr>
+
+ <td class="name"><code>version_info</code></td>
+
+
+ <td class="type">
+
+
+<span class="param-type">Object</span>
+
+
+
+
+ </td>
+
+
+
+
+
+ <td class="description last"><p>bytomd version information:</p></td>
+ </tr>
+
+
+
+ <tr>
+
+ <td class="name"><code>version</code></td>
+
+
+ <td class="type">
+
+
+<span class="param-type">String</span>
+
+
+
+
+ </td>
+
+
+
+
+
+ <td class="description last"><p>current version of the running bytomd.</p></td>
+ </tr>
+
+
+
+ <tr>
+
+ <td class="name"><code>update</code></td>
+
+
+ <td class="type">
+
+
+<span class="param-type">uint16</span>
+
+
+
+
+ </td>
+
+
+
+
+
+ <td class="description last"><p>whether there exists an update.
+ 0: no update;
+ 1: small update;
+ 2: significant update.</p></td>
+ </tr>
+
+
+
+ <tr>
+
+ <td class="name"><code>new_version</code></td>
+
+
+ <td class="type">
+
+
+<span class="param-type">String</span>
+
+
+
+
+ </td>
+
+
+
+
+
+ <td class="description last"><p>the newest version of bytomd if there is one.</p></td>
+ </tr>
+
+
+ </tbody>
+</table>
+</dl>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+</dl>
+
+
+
+</dd>
+
+
+
+<hr>
<dt class="name" id="Key">
<h4 id="Key">Key</h4>
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
- on 2018-05-24T14:04:59+08:00
+ on 2018-11-26T16:28:32+08:00
using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
</span>
OSDN Git Service
