update doc

diff --git a/docs/global.html b/docs/global.html
index bd60b96..9c743b9 100644 (file)
--- a/docs/global.html
+++ b/docs/global.html
@@ -2730,7 +2730,7 @@ the unspent output set.</p>
 <span class="jsdoc-message">
        Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
        
-               on 2018-05-21T13:04:20+08:00
+               on 2018-05-24T14:04:59+08:00
        
        using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/index.html b/docs/index.html
index c637ccc..e900eee 100644 (file)
--- a/docs/index.html
+++ b/docs/index.html
@@ -93,40 +93,51 @@
 
 
     <section class="readme-section">
-        <article><h1>Bytom Node.js SDK</h1><h2>Terminology</h2><h3><a href="https://bytom-node-sdk.github.io/global.html#Key__anchor">Keys</a></h3><p>Cryptographic keys are the primary authorization mechanism on a blockchain.</p>
+        <article><h1>Bytom Node.js SDK</h1><h2>Terminology</h2><h3><a href="https://bytom.github.io/node-sdk/global.html#Key__anchor">Keys</a></h3><p>Cryptographic keys are the primary authorization mechanism on a blockchain.</p>
 <p>To create accounts or assets, xpub of keys are required. With this sdk, we can
 <code>create/delete/list/resetPassword</code> the key. Please check the 
-<a href="https://bytom-node-sdk.github.io/module-KeysApi.html">API doc</a> if you want
+<a href="https://bytom.github.io/node-sdk/module-KeysApi.html">API doc</a> if you want
 to operate with keys.</p>
-<h3><a href="https://bytom-node-sdk.github.io/global.html#Account__anchor">Account</a></h3><p>An account is an object in Bytom that tracks ownership of assets on a blockchain. 
+<h3><a href="https://bytom.github.io/node-sdk/global.html#Account__anchor">Account</a></h3><p>An account is an object in Bytom that tracks ownership of assets on a blockchain. 
 It's defined under one Bytom node created with one or serveral keys.  </p>
-<p><a href="https://bytom-node-sdk.github.io/module-AccountsApi.html">Related API</a></p>
-<h3><a href="https://bytom-node-sdk.github.io/global.html#Asset__anchor">Asset</a></h3><p>An asset is a type of value that can be issued on a blockchain. All units of
+<p><a href="https://bytom.github.io/node-sdk/module-AccountsApi.html">Related API</a></p>
+<h3><a href="https://bytom.github.io/node-sdk/global.html#Asset__anchor">Asset</a></h3><p>An asset is a type of value that can be issued on a blockchain. All units of
 a given asset are fungible. Units of an asset can be transacted directly
 between parties without the involvement of the issuer.</p>
-<p><a href="https://bytom-node-sdk.github.io/module-AssetsApi.html">Related API</a></p>
-<h3><a href="https://bytom-node-sdk.github.io/global.html#Transaction__anchor">Transaction</a></h3><p>Blockchain is chain of blocks, while block consists of numbers of transactions.</p>
-<p><a href="https://bytom-node-sdk.github.io/module-TransactionsApi.html">Related API</a></p>
-<h3><a href="https://bytom-node-sdk.github.io/global.html#UnspentOutput__anchor">Unspent Output(UTXO)</a></h3><p>Bytom is UTXO based blockchain. One transaction spend some UTXOs, and produces new UTXOs.</p>
-<p><a href="https://bytom-node-sdk.github.io/module-UnspentOutputsApi.html">Related API</a></p>
-<h3><a href="https://bytom-node-sdk.github.io/global.html#Balance__anchor">Balance</a></h3><p>Any balance on the blockchain is simply a summation of UTXOs. In one bytomd, balance means
+<p><a href="https://bytom.github.io/node-sdk/module-AssetsApi.html">Related API</a></p>
+<h3><a href="https://bytom.github.io/node-sdk/global.html#Transaction__anchor">Transaction</a></h3><p>Blockchain is chain of blocks, while block consists of numbers of transactions.</p>
+<p><a href="https://bytom.github.io/node-sdk/module-TransactionsApi.html">Related API</a></p>
+<h3><a href="https://bytom.github.io/node-sdk/global.html#UnspentOutput__anchor">Unspent Output(UTXO)</a></h3><p>Bytom is UTXO based blockchain. One transaction spend some UTXOs, and produces new UTXOs.</p>
+<p><a href="https://bytom.github.io/node-sdk/module-UnspentOutputsApi.html">Related API</a></p>
+<h3><a href="https://bytom.github.io/node-sdk/global.html#Balance__anchor">Balance</a></h3><p>Any balance on the blockchain is simply a summation of UTXOs. In one bytomd, balance means
 summation of UTXOs of one account.</p>
-<p><a href="https://bytom-node-sdk.github.io/module-BalancesApi.html">Related API</a></p>
-<h2>Usage</h2><h3>In your code</h3><pre class="prettyprint source"><code>const bytom = require('bytom-sdk')
+<p><a href="https://bytom.github.io/node-sdk/module-BalancesApi.html">Related API</a></p>
+<h2>Usage</h2><h3>In your code</h3><pre class="prettyprint source lang-javascript"><code>const bytom = require('bytom-sdk')
 const url = 'http://localhost:9888'
 
-// access token is required when client is not in same origin with the request bytom node
+// access token is required when client is not in same origin
+// with the request bytom node
 const accessToken = ''
 
 const client = new bytom.Client(url, accessToken)</code></pre><h2>Interaction with bytom</h2><p>We will walk you through the process to issue some assets.</p>
 <h3>Step 1: create a key</h3><pre class="prettyprint source lang-javascript"><code>const keyPromise = client.keys.create('alias', 'password')</code></pre><p>It will create a key whose alias is 'alias' while password is 'password'.</p>
-<h3>Step 2: create a account</h3><pre class="prettyprint source lang-javascript"><code>const accountPromise = keyPromise.then(key => client.accounts.create([key.xpub], 1, 'account'))</code></pre><h3>Step 3: create account address</h3><p>const addressPromise = accountPromise.then(account =&gt; {
+<h3>Step 2: create a account</h3><pre class="prettyprint source lang-javascript"><code>const accountPromise = keyPromise.then(key => {
+ client.accounts.create([key.xpub], 1, 'account')
+})</code></pre><h3>Step 3: create account address</h3><pre class="prettyprint source lang-javascript"><code>const addressPromise = accountPromise.then(account => {
   return client.accounts.createReceiverById(account.id)
-})</p>
-<h3>Step 4: create asset</h3><pre class="prettyprint source lang-javascript"><code>const definition = {name: &quot;GOLD&quot;, symobol: &quot;GOLD&quot;, decimals: 8, description: {}}
+})</code></pre><h3>Step 4: create asset</h3><pre class="prettyprint source lang-javascript"><code>const definition = {
+  name: &quot;GOLD&quot;,
+  symobol: &quot;GOLD&quot;,
+  decimals: 8,
+  description: {}
+}
 const assetPromise = keyPromise.then(key => {
   return client.assets.create([key.xpub], 1, 'asset', definition)
-})</code></pre><h3>Step 5: issue asset</h3><h4>First, build the transaction</h4><pre class="prettyprint source lang-javascript"><code>const buildPromise = Promise.all([accountPromise, addressPromise, assetPromise]).then(([account, address, asset]) => {
+})</code></pre><h3>Step 5: issue asset</h3><h4>First, build the transaction</h4><pre class="prettyprint source lang-javascript"><code>const buildPromise = Promise.all([
+  accountPromise,
+  addressPromise,
+  assetPromise]
+  ).then(([account, address, asset]) => {
   const issueAction = {
     amount: 10000000000,
     asset_alias: asset.alias,
@@ -147,7 +158,8 @@ const assetPromise = keyPromise.then(key => {
     address: address.address
   }
 
-  return client.transactions.build(null, [issueAction, gasAction, controlAction])
+  return client.transactions.build(null,
+  [issueAction, gasAction, controlAction])
 })
 </code></pre><h4>Second, sign the transaction</h4><pre class="prettyprint source lang-javascript"><code>const signPromise = buildPromise.then(transactionTemplate => {
   return client.transactions.sign(transactionTemplate, 'password')
@@ -199,7 +211,7 @@ const assetPromise = keyPromise.then(key => {
 <span class="jsdoc-message">
        Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
        
-               on 2018-05-21T13:04:20+08:00
+               on 2018-05-24T14:05:00+08:00
        
        using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/module-AccessTokensApi.html b/docs/module-AccessTokensApi.html
index 29f5bec..58e9c8a 100644 (file)
--- a/docs/module-AccessTokensApi.html
+++ b/docs/module-AccessTokensApi.html
@@ -578,7 +578,7 @@
 <span class="jsdoc-message">
        Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
        
-               on 2018-05-21T13:04:21+08:00
+               on 2018-05-24T14:05:00+08:00
        
        using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/module-AccountsApi.html b/docs/module-AccountsApi.html
index 41d05fa..489565c 100644 (file)
--- a/docs/module-AccountsApi.html
+++ b/docs/module-AccountsApi.html
@@ -1562,7 +1562,7 @@
 <span class="jsdoc-message">
        Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
        
-               on 2018-05-21T13:04:21+08:00
+               on 2018-05-24T14:05:00+08:00
        
        using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/module-AssetsApi.html b/docs/module-AssetsApi.html
index 1b14912..5ace80b 100644 (file)
--- a/docs/module-AssetsApi.html
+++ b/docs/module-AssetsApi.html
@@ -1185,7 +1185,7 @@
 <span class="jsdoc-message">
        Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
        
-               on 2018-05-21T13:04:21+08:00
+               on 2018-05-24T14:05:00+08:00
        
        using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/module-BalancesApi.html b/docs/module-BalancesApi.html
index 8220637..97b4bd1 100644 (file)
--- a/docs/module-BalancesApi.html
+++ b/docs/module-BalancesApi.html
@@ -298,7 +298,7 @@
 <span class="jsdoc-message">
        Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
        
-               on 2018-05-21T13:04:21+08:00
+               on 2018-05-24T14:05:00+08:00
        
        using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/module-KeysApi.html b/docs/module-KeysApi.html
index df09837..e74dfb2 100644 (file)
--- a/docs/module-KeysApi.html
+++ b/docs/module-KeysApi.html
@@ -798,7 +798,7 @@
 <span class="jsdoc-message">
        Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
        
-               on 2018-05-21T13:04:21+08:00
+               on 2018-05-24T14:05:00+08:00
        
        using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/module-TransactionsApi.html b/docs/module-TransactionsApi.html
index d7ea84b..e65a763 100644 (file)
--- a/docs/module-TransactionsApi.html
+++ b/docs/module-TransactionsApi.html
@@ -1690,7 +1690,7 @@ Asset info(either asset_id or asset_alias ) is required for all kinds of action.
 <span class="jsdoc-message">
        Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
        
-               on 2018-05-21T13:04:21+08:00
+               on 2018-05-24T14:05:00+08:00
        
        using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/module-UnspentOutputsApi.html b/docs/module-UnspentOutputsApi.html
index 7b3fe69..719ab7a 100644 (file)
--- a/docs/module-UnspentOutputsApi.html
+++ b/docs/module-UnspentOutputsApi.html
@@ -450,7 +450,7 @@
 <span class="jsdoc-message">
        Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
        
-               on 2018-05-21T13:04:21+08:00
+               on 2018-05-24T14:05:00+08:00
        
        using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/modules.list.html b/docs/modules.list.html
index cf01d6d..ce90ecd 100644 (file)
--- a/docs/modules.list.html
+++ b/docs/modules.list.html
@@ -195,7 +195,7 @@
 <span class="jsdoc-message">
        Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
        
-               on 2018-05-21T13:04:20+08:00
+               on 2018-05-24T14:04:59+08:00
        
        using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/quicksearch.html b/docs/quicksearch.html
index 43dafac..050b7e5 100644 (file)
--- a/docs/quicksearch.html
+++ b/docs/quicksearch.html
@@ -7,7 +7,7 @@
     <script src="scripts/fulltext-search.js"></script>
 
     <script type="text/x-docstrap-searchdb">
-    {"global.html":{"id":"global.html","title":"Global","body":" Bytom Node.js SDK Modules AccessTokensApiAccountsApiAssetsApiBalancesApiKeysApiTransactionsApiUnspentOutputsApi Global Global Global Type Definitions AccessToken Access tokens are name:secret-token pairs that are granted authorization for accessing Chain Core features. Type: Object Properties: Name Type Description id String User specified, unique identifier. token String Only returned in the response from AccessTokensApi~create. created_at String Timestamp of token creation, RFC3339 formatted. Account An account is an object in Bytom that tracks ownership of assets on a blockchain. Type: Object Properties: Name Type Description id String Unique account identifier in one Bytom node. alias String User specified, unique identifier in one Bytom node. keys Array.&lt;Key&gt; The list of keys used to create control programs under the account. Signatures from these keys are required for spending funds held in the account. key_index Number The index of keys. quorum Number The number of keys required to sign transactions for the account. Asset An asset is a type of value that can be issued on a blockchain. All units of a given asset are fungible. Units of an asset can be transacted directly between parties without the involvement of the issuer. Type: Object Properties: Name Type Description id String Globally unique identifier of the asset. Asset specifies the asset id as the hash of: the asset's issuance program the core's VM version the hash of asset definition alias String User specified, unique identifier in one Bytom node. issuanceProgram String keys Array.&lt;Key&gt; The list of keys used to issue units of the asset. quorum Number The number of signatures required to issue new units of the asset. defintion Object User-specified, arbitrary/unstructured data visible across Bytom blockchain networks. assets specify the definition in their issuance programs, rendering the definition immutable. Balance Any balance on the blockchain is simply a summation of unspent outputs. Type: Object Properties: Name Type Description amount Number Sum of the unspent outputs. account_alias String Account alias. account_id String Account id. asset_id String Asset id. asset_alias String Asset alias. asset_definition Object Asset definition Key Cryptographic private keys are the primary authorization mechanism on a blockchain. Type: Object Properties: Name Type Description alias String User specified, unique identifier of the key. xpub String Hex-encoded string representation of the key. Receiver A receiver is an object that wraps an account control program with the corresponding address. Type: Object Properties: Name Type Description control_program String The underlying control program that will be used in transactions paying to the address. address String The target address one transaction can pay UTXO to. Transaction A blockchain consists of an immutable set of cryptographically linked transactions. Each transaction contains one or more actions. Type: Object Properties: Name Type Description tx_id String Unique transaction identifier. block_time String Time of transaction. inputs Array.&lt;TransactionInput&gt; List of specified inputs for a transaction. outputs Array.&lt;TransactionOutput&gt; List of specified outputs for a transaction. TransactionInput Type: Object Properties: Name Type Description type String The type of the input. Possible values are &quot;issue&quot;, &quot;spend&quot;. asset_id String The id of the asset being issued or spent. asset_alias String The alias of the asset being issued or spent (possibly null). asset_definition Hash The definition of the asset being issued or spent (possibly null). amount Integer The number of units of the asset being issued or spent. spentOutputId String The id of the output consumed by this input. ID is nil if this is an issuance input. account_id String The id of the account transferring the asset (possibly null if the input is an issuance or an unspent output is specified). account_alias String The alias of the account transferring the asset (possibly null if the input is an issuance or an unspent output is specified). issuance_program String A program specifying a predicate for issuing an asset (possibly null if input is not an issuance). control_program String A UTXO control program. address String The UTXO address. TransactionOutput Each new transaction in the blockchain consumes some unspent outputs and creates others. An output is considered unspent when it has not yet been used as an input to a new transaction. All asset units on a blockchain exist in the unspent output set. Type: Object Properties: Name Type Description id String The id of the output. type String The type of the output. Possible values are &quot;control&quot; and &quot;retire&quot;. transaction_id String Id of the transaction. position Number The output's position in a transaction's list of outputs. asset_id String The id of the asset being issued or spent. asset_alias String The alias of the asset being issued or spent (possibly null). asset_definition Hash The definition of the asset being issued or spent (possibly null). amount Integer The number of units of the asset being issued or spent. account_id String The id of the account transferring the asset (possibly null). account_alias String The alias of the account transferring the asset (possibly null). control_program String The control program which must be satisfied to transfer this output. UnspentOutput Each new transaction in the blockchain consumes some unspent outputs and creates others. An output is considered unspent when it has not yet been used as an input to a new transaction. All asset units on a blockchain exist in the unspent output set. Type: Object Properties: Name Type Description account_alias String The alias of the account transferring the asset (possibly null). account_id String The id of the account transferring the asset (possibly null). address String The output address. id String Unique transaction identifier. amount Number The number of units of the asset being issued or spent. asset_alias String The alias of the asset being issued or spent (possibly null). asset_id String The id of the asset being issued or spent. source_pos Number The output's position in a transaction's list of outputs. change Boolean Whether this output is asset change of one spend. control_program_index Number Control program index. program String The control program which must be satisfied to transfer this output. source_id String The source unspent output id. valid_height Number It means coinbase utxo if valid_height &gt; 0. × Search results Close Documentation generated by JSDoc 3.5.5 on 2018-05-21T13:04:20+08:00 using the DocStrap template. "},"modules.list.html":{"id":"modules.list.html","title":"Modules","body":" Bytom Node.js SDK Modules AccessTokensApiAccountsApiAssetsApiBalancesApiKeysApiTransactionsApiUnspentOutputsApi Global Global Modules × Search results Close Documentation generated by JSDoc 3.5.5 on 2018-05-21T13:04:20+08:00 using the DocStrap template. "},"index.html":{"id":"index.html","title":"Index","body":" Bytom Node.js SDK Modules AccessTokensApiAccountsApiAssetsApiBalancesApiKeysApiTransactionsApiUnspentOutputsApi Global Global Bytom Node.js SDKTerminologyKeysCryptographic keys are the primary authorization mechanism on a blockchain. To create accounts or assets, xpub of keys are required. With this sdk, we can create/delete/list/resetPassword the key. Please check the API doc if you want to operate with keys. AccountAn account is an object in Bytom that tracks ownership of assets on a blockchain. It's defined under one Bytom node created with one or serveral keys. Related API AssetAn asset is a type of value that can be issued on a blockchain. All units of a given asset are fungible. Units of an asset can be transacted directly between parties without the involvement of the issuer. Related API TransactionBlockchain is chain of blocks, while block consists of numbers of transactions. Related API Unspent Output(UTXO)Bytom is UTXO based blockchain. One transaction spend some UTXOs, and produces new UTXOs. Related API BalanceAny balance on the blockchain is simply a summation of UTXOs. In one bytomd, balance means summation of UTXOs of one account. Related API UsageIn your codeconst bytom = require('bytom-sdk') const url = 'http://localhost:9888' // access token is required when client is not in same origin with the request bytom node const accessToken = '' const client = new bytom.Client(url, accessToken)Interaction with bytomWe will walk you through the process to issue some assets. Step 1: create a keyconst keyPromise = client.keys.create('alias', 'password')It will create a key whose alias is 'alias' while password is 'password'. Step 2: create a accountconst accountPromise = keyPromise.then(key =&gt; client.accounts.create([key.xpub], 1, 'account'))Step 3: create account addressconst addressPromise = accountPromise.then(account =&gt; { return client.accounts.createReceiverById(account.id) }) Step 4: create assetconst definition = {name: &quot;GOLD&quot;, symobol: &quot;GOLD&quot;, decimals: 8, description: {}} const assetPromise = keyPromise.then(key =&gt; { return client.assets.create([key.xpub], 1, 'asset', definition) })Step 5: issue assetFirst, build the transactionconst buildPromise = Promise.all([accountPromise, addressPromise, assetPromise]).then(([account, address, asset]) =&gt; { const issueAction = { amount: 10000000000, asset_alias: asset.alias, type: 'issue' } const gasAction = { type: 'spend_account', account_alias: account.alias, asset_alias: 'BTM', amount: 50000000 } const controlAction = { type: 'control_address', amount: 10000000000, asset_alias: asset.alias, address: address.address } return client.transactions.build(null, [issueAction, gasAction, controlAction]) }) Second, sign the transactionconst signPromise = buildPromise.then(transactionTemplate =&gt; { return client.transactions.sign(transactionTemplate, 'password') })Finally, submit the signed transaction to the bytom networksignPromise.then(signed =&gt; { return client.transactions.submit(signed.transaction.raw_transaction) }) × Search results Close Documentation generated by JSDoc 3.5.5 on 2018-05-21T13:04:20+08:00 using the DocStrap template. "},"module-AccessTokensApi.html":{"id":"module-AccessTokensApi.html","title":"Module: AccessTokensApi","body":" Bytom Node.js SDK Modules AccessTokensApiAccountsApiAssetsApiBalancesApiKeysApiTransactionsApiUnspentOutputsApi Global Global Module: AccessTokensApi API for interacting with access tokens. Methods &lt;inner&gt; create(id) Create a new access token. Parameters: Name Type Description id String User specified, unique identifier. Returns: Newly created access token. Type Promise.&lt;AccessToken&gt; &lt;inner&gt; delete(id) Delete the target access token. Parameters: Name Type Description id String The to be deleted token id. &lt;inner&gt; list() Get all access tokens. Returns: All access tokens. Type Promise.&lt;Array.&lt;AccessToken&gt;&gt; × Search results Close Documentation generated by JSDoc 3.5.5 on 2018-05-21T13:04:21+08:00 using the DocStrap template. "},"module-AccountsApi.html":{"id":"module-AccountsApi.html","title":"Module: AccountsApi","body":" Bytom Node.js SDK Modules AccessTokensApiAccountsApiAssetsApiBalancesApiKeysApiTransactionsApiUnspentOutputsApi Global Global Module: AccountsApi API for interacting with accounts. Methods &lt;inner&gt; create(xpubs, quorum, alias) Create a new account. Parameters: Name Type Description xpubs module:AccountsApi~xpubs Xpub of Keys for account creation. quorum module:AccountsApi~quorum The number of keys required to sign transactions for the account. alias module:AccountsApi~alias Account alias. Returns: Newly created account response. Type Promise.&lt;Account&gt; &lt;inner&gt; createReceiverById(accountId) Create account receiver. Parameters: Name Type Description accountId module:AccountsApi~id Id for the target account. Returns: Target receiver. Type Promise.&lt;Receiver&gt; &lt;inner&gt; deleteById(id) Delete account. Parameters: Name Type Description id module:AccountsApi~id Target account id. &lt;inner&gt; listAddressesById(accountId) List all addresses for one account. Parameters: Name Type Description accountId module:AccountsApi~id Id for the target account. Returns: target addresses response. Type Promise.&lt;module:AccountApi~AddressInfo&gt; &lt;inner&gt; listAll() List all accounts in the target Bytom node. Returns: All accounts promise. Type Promise.&lt;Array.&lt;Account&gt;&gt; &lt;inner&gt; listById(id) List accounts whose id is the given one. Parameters: Name Type Description id module:AccountsApi~id Account id. Returns: Target accounts promise. Type Promise.&lt;Array.&lt;Account&gt;&gt; Type Definitions AddressInfo Type: Object Properties: Name Type Description account_alias String account_id String adddress String change Boolean Indicate whether this address is for change UTXO. alias User specified, unique identifier. Type: String id Unique account identifier in one Bytom node. Type: String quorum The number of keys required to sign transactions for the account. Type: Number xpubs The list of keys used to create control programs under the account. Type: Array.&lt;String&gt; × Search results Close Documentation generated by JSDoc 3.5.5 on 2018-05-21T13:04:21+08:00 using the DocStrap template. "},"module-AssetsApi.html":{"id":"module-AssetsApi.html","title":"Module: AssetsApi","body":" Bytom Node.js SDK Modules AccessTokensApiAccountsApiAssetsApiBalancesApiKeysApiTransactionsApiUnspentOutputsApi Global Global Module: AssetsApi API for interacting with assets. Methods &lt;inner&gt; create(xpubs, quorum, alias, definition) Create a new asset. Parameters: Name Type Description xpubs module:AssetsApi~xpubs Keys for asseet creation. quorum module:AssetsApi~quorum The number of keys required to sign transactions for the account. alias module:AssetsApi~alias Asset alias. definition module:AssetsApi~definition Asset definition. Returns: Newly created asset. Type Promise.&lt;Asset&gt; &lt;inner&gt; getById(id) Get asset by the asset id. Parameters: Name Type Description id module:AssetsApi~id Asset id. Returns: target asset. Type Promise.&lt;Asset&gt; &lt;inner&gt; list() List all assets in one Bytom node. Returns: target assets. Type Promise.&lt;Array.&lt;Asset&gt;&gt; &lt;inner&gt; updateAlias(id, newAlias) Update asset alias. Parameters: Name Type Description id module:AssetsApi~id Asset id. newAlias String new alias. Type Definitions alias User specified, unique identifier. Type: String definition User-specified, asset attributes accross Bytom blockchain network. Type: Object id Unique account identifier in one Bytom node. Type: String quorum The number of signatures required to issue new units of the asset. Type: Number xpubs The list of keys used to issue units of the asset. Type: Array.&lt;String&gt; × Search results Close Documentation generated by JSDoc 3.5.5 on 2018-05-21T13:04:21+08:00 using the DocStrap template. "},"module-BalancesApi.html":{"id":"module-BalancesApi.html","title":"Module: BalancesApi","body":" Bytom Node.js SDK Modules AccessTokensApiAccountsApiAssetsApiBalancesApiKeysApiTransactionsApiUnspentOutputsApi Global Global Module: BalancesApi API for interacting with balances. Methods &lt;inner&gt; list() Get all asset balances of all accounts. Returns: The result balances. Type Promise.&lt;Array.&lt;Balance&gt;&gt; × Search results Close Documentation generated by JSDoc 3.5.5 on 2018-05-21T13:04:21+08:00 using the DocStrap template. "},"module-KeysApi.html":{"id":"module-KeysApi.html","title":"Module: KeysApi","body":" Bytom Node.js SDK Modules AccessTokensApiAccountsApiAssetsApiBalancesApiKeysApiTransactionsApiUnspentOutputsApi Global Global Module: KeysApi API for interacting with keys. Methods &lt;inner&gt; create(alias, password) Create a new key. Parameters: Name Type Description alias String User specified, unique identifier. password String User specified, key password. Returns: Newly created key. Type Promise.&lt;Key&gt; &lt;inner&gt; delete(xpub, password) Parameters: Name Type Description xpub String Hex-encoded string representation of the key. password String Key password. &lt;inner&gt; list() Got all the keys in one Bytom node. Returns: All keys. Type Promise.&lt;Array.&lt;Key&gt;&gt; &lt;inner&gt; resetPassword(xpub, oldPassword, newPassword) Reset key password. Parameters: Name Type Description xpub String Hex-encoded string representation of the key. oldPassword String Old password. newPassword String New password. × Search results Close Documentation generated by JSDoc 3.5.5 on 2018-05-21T13:04:21+08:00 using the DocStrap template. "},"module-TransactionsApi.html":{"id":"module-TransactionsApi.html","title":"Module: TransactionsApi","body":" Bytom Node.js SDK Modules AccessTokensApiAccountsApiAssetsApiBalancesApiKeysApiTransactionsApiUnspentOutputsApi Global Global Module: TransactionsApi API for interacting with transactions. Methods &lt;inner&gt; build(baseTransaction, actions, ttl) Build an unsigned transaction from a set of actions and base transction(possibly null). Parameters: Name Type Description baseTransaction String Encoded base raw transaction. actions Array.&lt;module:TransactionsApi~Action&gt; Set of actions to compose the transaction. ttl Number Time duration to spent UTXOs will be reserverd(can't be spent during this time duration). Returns: Unsigned transaction template. Type Promise.&lt;Object&gt; &lt;inner&gt; estimateGas(transaction) Estimate how much gas one trasaction may use. Parameters: Name Type Description transaction Object The transaction template to estimate. Returns: Estimation result. Type Object &lt;inner&gt; listAll() List all local transactions. Returns: All local transactions. Type Promise.&lt;Array.&lt;Transaction&gt;&gt; &lt;inner&gt; listByAccountId(accountId) List all local transactions by account id. Parameters: Name Type Description accountId String Account id. Returns: The result transactions. Type Promise.&lt;Array.&lt;Transaction&gt;&gt; &lt;inner&gt; listById(id) List local transactions by id. Parameters: Name Type Description id String The transaction id. Returns: The result transactions. Type Promise.&lt;Array.&lt;Transaction&gt;&gt; &lt;inner&gt; sign(transaction, password) Sign transaction. Parameters: Name Type Description transaction Object The built transaction template. password Object Password of the key which will sign the transaction template. Returns: Sign result. Type Promise.&lt;module:TransactionsApi~SignResult&gt; &lt;inner&gt; submit(raw_transaction) Submit a signed transaction to the blockchain. Parameters: Name Type Description raw_transaction String Encoded fully signed transaction. Returns: Submit result. It will return tx_id if submit successfully else error. Type Promise.&lt;Object&gt; Type Definitions Action Basic unit to build a transaction. For spend transaction, either account_id or account_alias is required to specify account info. Asset info(either asset_id or asset_alias ) is required for all kinds of action. Type: Object Properties: Name Type Description type String Currently 4 types of action is supported: spend_account: action to spend UTXO from account. issue: action to issue asset. retire: action to retire asset. control_address: action to receive asset with address. account_alias String The alias of the account transferring the asset (possibly null). account_id String The id of the account transferring the asset (possibly null). asset_id String The id of the asset being issued or spent (possibly null). asset_alias String The alias of the asset being issued or spent (possibly null). address String Address to receive the transfered asset(possibly null, required for control_address action). SignResult Data structure /sign-transaction api will return. Type: Object Properties: Name Type Description transaction Transaction The signed transaction if sign success. sign_complete Boolean Whether all input actions are signed. It means this transaction can be submit if true, else not. × Search results Close Documentation generated by JSDoc 3.5.5 on 2018-05-21T13:04:21+08:00 using the DocStrap template. "},"module-UnspentOutputsApi.html":{"id":"module-UnspentOutputsApi.html","title":"Module: UnspentOutputsApi","body":" Bytom Node.js SDK Modules AccessTokensApiAccountsApiAssetsApiBalancesApiKeysApiTransactionsApiUnspentOutputsApi Global Global Module: UnspentOutputsApi API for interacting with unspent outputs. Methods &lt;inner&gt; list() Get all unspent outputs. Returns: Target unspent outputs. Type Promise.&lt;Array.&lt;UnspentOutput&gt;&gt; &lt;inner&gt; listById(id) Get target unspent outputs by id. Parameters: Name Type Description id String Unspent output id. Returns: Target unspent outputs. Type Promise.&lt;Array.&lt;UnspentOutput&gt;&gt; × Search results Close Documentation generated by JSDoc 3.5.5 on 2018-05-21T13:04:21+08:00 using the DocStrap template. "}}
+    {"global.html":{"id":"global.html","title":"Global","body":" Bytom Node.js SDK Modules AccessTokensApiAccountsApiAssetsApiBalancesApiKeysApiTransactionsApiUnspentOutputsApi Global Global Global Type Definitions AccessToken Access tokens are name:secret-token pairs that are granted authorization for accessing Chain Core features. Type: Object Properties: Name Type Description id String User specified, unique identifier. token String Only returned in the response from AccessTokensApi~create. created_at String Timestamp of token creation, RFC3339 formatted. Account An account is an object in Bytom that tracks ownership of assets on a blockchain. Type: Object Properties: Name Type Description id String Unique account identifier in one Bytom node. alias String User specified, unique identifier in one Bytom node. keys Array.&lt;Key&gt; The list of keys used to create control programs under the account. Signatures from these keys are required for spending funds held in the account. key_index Number The index of keys. quorum Number The number of keys required to sign transactions for the account. Asset An asset is a type of value that can be issued on a blockchain. All units of a given asset are fungible. Units of an asset can be transacted directly between parties without the involvement of the issuer. Type: Object Properties: Name Type Description id String Globally unique identifier of the asset. Asset specifies the asset id as the hash of: the asset's issuance program the core's VM version the hash of asset definition alias String User specified, unique identifier in one Bytom node. issuanceProgram String keys Array.&lt;Key&gt; The list of keys used to issue units of the asset. quorum Number The number of signatures required to issue new units of the asset. defintion Object User-specified, arbitrary/unstructured data visible across Bytom blockchain networks. assets specify the definition in their issuance programs, rendering the definition immutable. Balance Any balance on the blockchain is simply a summation of unspent outputs. Type: Object Properties: Name Type Description amount Number Sum of the unspent outputs. account_alias String Account alias. account_id String Account id. asset_id String Asset id. asset_alias String Asset alias. asset_definition Object Asset definition Key Cryptographic private keys are the primary authorization mechanism on a blockchain. Type: Object Properties: Name Type Description alias String User specified, unique identifier of the key. xpub String Hex-encoded string representation of the key. Receiver A receiver is an object that wraps an account control program with the corresponding address. Type: Object Properties: Name Type Description control_program String The underlying control program that will be used in transactions paying to the address. address String The target address one transaction can pay UTXO to. Transaction A blockchain consists of an immutable set of cryptographically linked transactions. Each transaction contains one or more actions. Type: Object Properties: Name Type Description tx_id String Unique transaction identifier. block_time String Time of transaction. inputs Array.&lt;TransactionInput&gt; List of specified inputs for a transaction. outputs Array.&lt;TransactionOutput&gt; List of specified outputs for a transaction. TransactionInput Type: Object Properties: Name Type Description type String The type of the input. Possible values are &quot;issue&quot;, &quot;spend&quot;. asset_id String The id of the asset being issued or spent. asset_alias String The alias of the asset being issued or spent (possibly null). asset_definition Hash The definition of the asset being issued or spent (possibly null). amount Integer The number of units of the asset being issued or spent. spentOutputId String The id of the output consumed by this input. ID is nil if this is an issuance input. account_id String The id of the account transferring the asset (possibly null if the input is an issuance or an unspent output is specified). account_alias String The alias of the account transferring the asset (possibly null if the input is an issuance or an unspent output is specified). issuance_program String A program specifying a predicate for issuing an asset (possibly null if input is not an issuance). control_program String A UTXO control program. address String The UTXO address. TransactionOutput Each new transaction in the blockchain consumes some unspent outputs and creates others. An output is considered unspent when it has not yet been used as an input to a new transaction. All asset units on a blockchain exist in the unspent output set. Type: Object Properties: Name Type Description id String The id of the output. type String The type of the output. Possible values are &quot;control&quot; and &quot;retire&quot;. transaction_id String Id of the transaction. position Number The output's position in a transaction's list of outputs. asset_id String The id of the asset being issued or spent. asset_alias String The alias of the asset being issued or spent (possibly null). asset_definition Hash The definition of the asset being issued or spent (possibly null). amount Integer The number of units of the asset being issued or spent. account_id String The id of the account transferring the asset (possibly null). account_alias String The alias of the account transferring the asset (possibly null). control_program String The control program which must be satisfied to transfer this output. UnspentOutput Each new transaction in the blockchain consumes some unspent outputs and creates others. An output is considered unspent when it has not yet been used as an input to a new transaction. All asset units on a blockchain exist in the unspent output set. Type: Object Properties: Name Type Description account_alias String The alias of the account transferring the asset (possibly null). account_id String The id of the account transferring the asset (possibly null). address String The output address. id String Unique transaction identifier. amount Number The number of units of the asset being issued or spent. asset_alias String The alias of the asset being issued or spent (possibly null). asset_id String The id of the asset being issued or spent. source_pos Number The output's position in a transaction's list of outputs. change Boolean Whether this output is asset change of one spend. control_program_index Number Control program index. program String The control program which must be satisfied to transfer this output. source_id String The source unspent output id. valid_height Number It means coinbase utxo if valid_height &gt; 0. × Search results Close Documentation generated by JSDoc 3.5.5 on 2018-05-24T14:04:59+08:00 using the DocStrap template. "},"modules.list.html":{"id":"modules.list.html","title":"Modules","body":" Bytom Node.js SDK Modules AccessTokensApiAccountsApiAssetsApiBalancesApiKeysApiTransactionsApiUnspentOutputsApi Global Global Modules × Search results Close Documentation generated by JSDoc 3.5.5 on 2018-05-24T14:04:59+08:00 using the DocStrap template. "},"index.html":{"id":"index.html","title":"Index","body":" Bytom Node.js SDK Modules AccessTokensApiAccountsApiAssetsApiBalancesApiKeysApiTransactionsApiUnspentOutputsApi Global Global Bytom Node.js SDKTerminologyKeysCryptographic keys are the primary authorization mechanism on a blockchain. To create accounts or assets, xpub of keys are required. With this sdk, we can create/delete/list/resetPassword the key. Please check the API doc if you want to operate with keys. AccountAn account is an object in Bytom that tracks ownership of assets on a blockchain. It's defined under one Bytom node created with one or serveral keys. Related API AssetAn asset is a type of value that can be issued on a blockchain. All units of a given asset are fungible. Units of an asset can be transacted directly between parties without the involvement of the issuer. Related API TransactionBlockchain is chain of blocks, while block consists of numbers of transactions. Related API Unspent Output(UTXO)Bytom is UTXO based blockchain. One transaction spend some UTXOs, and produces new UTXOs. Related API BalanceAny balance on the blockchain is simply a summation of UTXOs. In one bytomd, balance means summation of UTXOs of one account. Related API UsageIn your codeconst bytom = require('bytom-sdk') const url = 'http://localhost:9888' // access token is required when client is not in same origin // with the request bytom node const accessToken = '' const client = new bytom.Client(url, accessToken)Interaction with bytomWe will walk you through the process to issue some assets. Step 1: create a keyconst keyPromise = client.keys.create('alias', 'password')It will create a key whose alias is 'alias' while password is 'password'. Step 2: create a accountconst accountPromise = keyPromise.then(key =&gt; { client.accounts.create([key.xpub], 1, 'account') })Step 3: create account addressconst addressPromise = accountPromise.then(account =&gt; { return client.accounts.createReceiverById(account.id) })Step 4: create assetconst definition = { name: &quot;GOLD&quot;, symobol: &quot;GOLD&quot;, decimals: 8, description: {} } const assetPromise = keyPromise.then(key =&gt; { return client.assets.create([key.xpub], 1, 'asset', definition) })Step 5: issue assetFirst, build the transactionconst buildPromise = Promise.all([ accountPromise, addressPromise, assetPromise] ).then(([account, address, asset]) =&gt; { const issueAction = { amount: 10000000000, asset_alias: asset.alias, type: 'issue' } const gasAction = { type: 'spend_account', account_alias: account.alias, asset_alias: 'BTM', amount: 50000000 } const controlAction = { type: 'control_address', amount: 10000000000, asset_alias: asset.alias, address: address.address } return client.transactions.build(null, [issueAction, gasAction, controlAction]) }) Second, sign the transactionconst signPromise = buildPromise.then(transactionTemplate =&gt; { return client.transactions.sign(transactionTemplate, 'password') })Finally, submit the signed transaction to the bytom networksignPromise.then(signed =&gt; { return client.transactions.submit(signed.transaction.raw_transaction) }) × Search results Close Documentation generated by JSDoc 3.5.5 on 2018-05-24T14:05:00+08:00 using the DocStrap template. "},"module-AccessTokensApi.html":{"id":"module-AccessTokensApi.html","title":"Module: AccessTokensApi","body":" Bytom Node.js SDK Modules AccessTokensApiAccountsApiAssetsApiBalancesApiKeysApiTransactionsApiUnspentOutputsApi Global Global Module: AccessTokensApi API for interacting with access tokens. Methods &lt;inner&gt; create(id) Create a new access token. Parameters: Name Type Description id String User specified, unique identifier. Returns: Newly created access token. Type Promise.&lt;AccessToken&gt; &lt;inner&gt; delete(id) Delete the target access token. Parameters: Name Type Description id String The to be deleted token id. &lt;inner&gt; list() Get all access tokens. Returns: All access tokens. Type Promise.&lt;Array.&lt;AccessToken&gt;&gt; × Search results Close Documentation generated by JSDoc 3.5.5 on 2018-05-24T14:05:00+08:00 using the DocStrap template. "},"module-AccountsApi.html":{"id":"module-AccountsApi.html","title":"Module: AccountsApi","body":" Bytom Node.js SDK Modules AccessTokensApiAccountsApiAssetsApiBalancesApiKeysApiTransactionsApiUnspentOutputsApi Global Global Module: AccountsApi API for interacting with accounts. Methods &lt;inner&gt; create(xpubs, quorum, alias) Create a new account. Parameters: Name Type Description xpubs module:AccountsApi~xpubs Xpub of Keys for account creation. quorum module:AccountsApi~quorum The number of keys required to sign transactions for the account. alias module:AccountsApi~alias Account alias. Returns: Newly created account response. Type Promise.&lt;Account&gt; &lt;inner&gt; createReceiverById(accountId) Create account receiver. Parameters: Name Type Description accountId module:AccountsApi~id Id for the target account. Returns: Target receiver. Type Promise.&lt;Receiver&gt; &lt;inner&gt; deleteById(id) Delete account. Parameters: Name Type Description id module:AccountsApi~id Target account id. &lt;inner&gt; listAddressesById(accountId) List all addresses for one account. Parameters: Name Type Description accountId module:AccountsApi~id Id for the target account. Returns: target addresses response. Type Promise.&lt;module:AccountApi~AddressInfo&gt; &lt;inner&gt; listAll() List all accounts in the target Bytom node. Returns: All accounts promise. Type Promise.&lt;Array.&lt;Account&gt;&gt; &lt;inner&gt; listById(id) List accounts whose id is the given one. Parameters: Name Type Description id module:AccountsApi~id Account id. Returns: Target accounts promise. Type Promise.&lt;Array.&lt;Account&gt;&gt; Type Definitions AddressInfo Type: Object Properties: Name Type Description account_alias String account_id String adddress String change Boolean Indicate whether this address is for change UTXO. alias User specified, unique identifier. Type: String id Unique account identifier in one Bytom node. Type: String quorum The number of keys required to sign transactions for the account. Type: Number xpubs The list of keys used to create control programs under the account. Type: Array.&lt;String&gt; × Search results Close Documentation generated by JSDoc 3.5.5 on 2018-05-24T14:05:00+08:00 using the DocStrap template. "},"module-AssetsApi.html":{"id":"module-AssetsApi.html","title":"Module: AssetsApi","body":" Bytom Node.js SDK Modules AccessTokensApiAccountsApiAssetsApiBalancesApiKeysApiTransactionsApiUnspentOutputsApi Global Global Module: AssetsApi API for interacting with assets. Methods &lt;inner&gt; create(xpubs, quorum, alias, definition) Create a new asset. Parameters: Name Type Description xpubs module:AssetsApi~xpubs Keys for asseet creation. quorum module:AssetsApi~quorum The number of keys required to sign transactions for the account. alias module:AssetsApi~alias Asset alias. definition module:AssetsApi~definition Asset definition. Returns: Newly created asset. Type Promise.&lt;Asset&gt; &lt;inner&gt; getById(id) Get asset by the asset id. Parameters: Name Type Description id module:AssetsApi~id Asset id. Returns: target asset. Type Promise.&lt;Asset&gt; &lt;inner&gt; list() List all assets in one Bytom node. Returns: target assets. Type Promise.&lt;Array.&lt;Asset&gt;&gt; &lt;inner&gt; updateAlias(id, newAlias) Update asset alias. Parameters: Name Type Description id module:AssetsApi~id Asset id. newAlias String new alias. Type Definitions alias User specified, unique identifier. Type: String definition User-specified, asset attributes accross Bytom blockchain network. Type: Object id Unique account identifier in one Bytom node. Type: String quorum The number of signatures required to issue new units of the asset. Type: Number xpubs The list of keys used to issue units of the asset. Type: Array.&lt;String&gt; × Search results Close Documentation generated by JSDoc 3.5.5 on 2018-05-24T14:05:00+08:00 using the DocStrap template. "},"module-BalancesApi.html":{"id":"module-BalancesApi.html","title":"Module: BalancesApi","body":" Bytom Node.js SDK Modules AccessTokensApiAccountsApiAssetsApiBalancesApiKeysApiTransactionsApiUnspentOutputsApi Global Global Module: BalancesApi API for interacting with balances. Methods &lt;inner&gt; list() Get all asset balances of all accounts. Returns: The result balances. Type Promise.&lt;Array.&lt;Balance&gt;&gt; × Search results Close Documentation generated by JSDoc 3.5.5 on 2018-05-24T14:05:00+08:00 using the DocStrap template. "},"module-KeysApi.html":{"id":"module-KeysApi.html","title":"Module: KeysApi","body":" Bytom Node.js SDK Modules AccessTokensApiAccountsApiAssetsApiBalancesApiKeysApiTransactionsApiUnspentOutputsApi Global Global Module: KeysApi API for interacting with keys. Methods &lt;inner&gt; create(alias, password) Create a new key. Parameters: Name Type Description alias String User specified, unique identifier. password String User specified, key password. Returns: Newly created key. Type Promise.&lt;Key&gt; &lt;inner&gt; delete(xpub, password) Parameters: Name Type Description xpub String Hex-encoded string representation of the key. password String Key password. &lt;inner&gt; list() Got all the keys in one Bytom node. Returns: All keys. Type Promise.&lt;Array.&lt;Key&gt;&gt; &lt;inner&gt; resetPassword(xpub, oldPassword, newPassword) Reset key password. Parameters: Name Type Description xpub String Hex-encoded string representation of the key. oldPassword String Old password. newPassword String New password. × Search results Close Documentation generated by JSDoc 3.5.5 on 2018-05-24T14:05:00+08:00 using the DocStrap template. "},"module-TransactionsApi.html":{"id":"module-TransactionsApi.html","title":"Module: TransactionsApi","body":" Bytom Node.js SDK Modules AccessTokensApiAccountsApiAssetsApiBalancesApiKeysApiTransactionsApiUnspentOutputsApi Global Global Module: TransactionsApi API for interacting with transactions. Methods &lt;inner&gt; build(baseTransaction, actions, ttl) Build an unsigned transaction from a set of actions and base transction(possibly null). Parameters: Name Type Description baseTransaction String Encoded base raw transaction. actions Array.&lt;module:TransactionsApi~Action&gt; Set of actions to compose the transaction. ttl Number Time duration to spent UTXOs will be reserverd(can't be spent during this time duration). Returns: Unsigned transaction template. Type Promise.&lt;Object&gt; &lt;inner&gt; estimateGas(transaction) Estimate how much gas one trasaction may use. Parameters: Name Type Description transaction Object The transaction template to estimate. Returns: Estimation result. Type Object &lt;inner&gt; listAll() List all local transactions. Returns: All local transactions. Type Promise.&lt;Array.&lt;Transaction&gt;&gt; &lt;inner&gt; listByAccountId(accountId) List all local transactions by account id. Parameters: Name Type Description accountId String Account id. Returns: The result transactions. Type Promise.&lt;Array.&lt;Transaction&gt;&gt; &lt;inner&gt; listById(id) List local transactions by id. Parameters: Name Type Description id String The transaction id. Returns: The result transactions. Type Promise.&lt;Array.&lt;Transaction&gt;&gt; &lt;inner&gt; sign(transaction, password) Sign transaction. Parameters: Name Type Description transaction Object The built transaction template. password Object Password of the key which will sign the transaction template. Returns: Sign result. Type Promise.&lt;module:TransactionsApi~SignResult&gt; &lt;inner&gt; submit(raw_transaction) Submit a signed transaction to the blockchain. Parameters: Name Type Description raw_transaction String Encoded fully signed transaction. Returns: Submit result. It will return tx_id if submit successfully else error. Type Promise.&lt;Object&gt; Type Definitions Action Basic unit to build a transaction. For spend transaction, either account_id or account_alias is required to specify account info. Asset info(either asset_id or asset_alias ) is required for all kinds of action. Type: Object Properties: Name Type Description type String Currently 4 types of action is supported: spend_account: action to spend UTXO from account. issue: action to issue asset. retire: action to retire asset. control_address: action to receive asset with address. account_alias String The alias of the account transferring the asset (possibly null). account_id String The id of the account transferring the asset (possibly null). asset_id String The id of the asset being issued or spent (possibly null). asset_alias String The alias of the asset being issued or spent (possibly null). address String Address to receive the transfered asset(possibly null, required for control_address action). SignResult Data structure /sign-transaction api will return. Type: Object Properties: Name Type Description transaction Transaction The signed transaction if sign success. sign_complete Boolean Whether all input actions are signed. It means this transaction can be submit if true, else not. × Search results Close Documentation generated by JSDoc 3.5.5 on 2018-05-24T14:05:00+08:00 using the DocStrap template. "},"module-UnspentOutputsApi.html":{"id":"module-UnspentOutputsApi.html","title":"Module: UnspentOutputsApi","body":" Bytom Node.js SDK Modules AccessTokensApiAccountsApiAssetsApiBalancesApiKeysApiTransactionsApiUnspentOutputsApi Global Global Module: UnspentOutputsApi API for interacting with unspent outputs. Methods &lt;inner&gt; list() Get all unspent outputs. Returns: Target unspent outputs. Type Promise.&lt;Array.&lt;UnspentOutput&gt;&gt; &lt;inner&gt; listById(id) Get target unspent outputs by id. Parameters: Name Type Description id String Unspent output id. Returns: Target unspent outputs. Type Promise.&lt;Array.&lt;UnspentOutput&gt;&gt; × Search results Close Documentation generated by JSDoc 3.5.5 on 2018-05-24T14:05:00+08:00 using the DocStrap template. "}}
     </script>
 
     <script type="text/javascript">