-
Notifications
You must be signed in to change notification settings - Fork 2
API Reference
martinbtm edited this page Sep 6, 2021
·
1 revision
Default JSON-RPC endpoints:
| Client | URL |
|---|---|
| Go | http://localhost:9888 |
A complete request example via curl:
The complete request and response are as follows:
// curl -X POST url/method -d data
curl -X POST http://localhost:9888/create-key -d '{"alias": "alice", "password": "123456", "language": "en"}'
// response
{
"status": "success",
"data": {
"alias": "alice",
"xpub": "66008ba54d0fb103e075c0ab403f2ac1527a3b9d23dc16312dede67c85199423f912c4f84c9515e87e14874bd405953abfced87f66926c25ba8c31968094c05b",
"file": "/home/.bytom/keystore/UTC--2018-11-01T06-44-28.250301455Z--6c794d3a-53b3-4c79-92d0-7b0e216667ae",
"mnemonic": "ocean exotic route sad volume grace knock frame pumpkin fetch december capital orange cake copper exercise elephant sound aware shiver silver donate pool interest"
}
}create-keylist-keysupdate-key-aliasdelete-keycheck-key-passwordreset-key-passwordcreate-accountlist-accountsupdate-account-aliasdelete-accountcreate-account-receiverlist-addressesvalidate-addressget-mining-addressset-mining-addressget-coinbase-arbitraryset-coinbase-arbitrarylist-pubkeyscreate-assetget-assetlist-assetsupdate-asset-aliaslist-balanceslist-unspent-outputsbackup-walletrestore-walletrescan-walletrecovery-walletwallet-infosign-messagedecode-programget-transactionlist-transactionsbuild-transactionbuild-chain-transactionssign-transactionsign-transactions
submit-transactionsubmit-transactionsestimate-transaction-gascreate-access-tokenlist-access-tokensdelete-access-tokencheck-access-tokencreate-transaction-feedget-transaction-feedlist-transaction-feedsdelete-transaction-feedupdate-transaction-feedget-unconfirmed-transactionlist-unconfirmed-transactionsdecode-raw-transactionget-block-countget-block-hashget-blockget-block-headerget-difficultyget-hash-ratenet-infois-miningset-mininggas-rateverify-messagecompilelist-peersdisconnect-peerconnect-peerget-worksubmit-workget-work-jsonsubmit-work-json
It is to create private key essentially, returns the information of key. The private key is encrypted in the file and not visible to the user.
Object:
-
String- alias, name of the key. -
String- password, password of the key. -
String- language, mnemonic language of the key.
Optional:
-
String- mnemonic, mnemonic of the key, create key by specified mnemonic.
Object:
-
String- alias, name of the key. -
String- xpub, root pubkey of the key. -
String- file, path to the file of key.
Optional:
-
String- mnemonic, mnemonic of the key, exist when the request mnemonic is null.
create key by random pattern:
// Request
curl -X POST create-key -d '{"alias": "alice", "password": "123456", "language": "en"}'
// Result
{
"alias": "alice",
"xpub": "a85e6eccb22f4c5fdade905f9a969003a17b6f35c237183a4313354b819a92689d52da3bcfe55f15a550877e8d789bd2bb9620f46e5049ea36470ab1b588a986",
"file": "/home/yang/.bytom/keystore/UTC--2018-10-10T07-09-17.509894697Z--341695b9-9223-470c-a26d-bea210f8e1bb",
"mnemonic": "verb smoke glory dentist annual peanut oval dragon fiction current orbit lab load total language female mushroom coyote regular toy slide welcome employ three"
}create key by specified mnemonic:
// Request
curl -X POST create-key -d '{"alias":"jack", "password":"123456", "mnemonic":"please observe raw beauty blue sea believe then boat float beyond position", "language":"en"}'
// Result
{
"alias": "jack",
"xpub": "c7bcb65febd31c6d900bc84c386d95c3d5b047090628d9bf5c51a848945b6986e99ff70388018a7681fa37a240dbd8df39a994c86f9314a61e75feb33563ca72",
"file": "/home/yang/.bytom/keystore/UTC--2018-10-10T07-08-51.815030323Z--46ee932e-88d3-4680-a5c1-dd9e63918fcc"
}Returns the list of all available keys.
none
-
Array of Object, keys owned by the client.-
Object:-
String- alias, name of the key. -
String- xpub, pubkey of the key.
-
-
// Request
curl -X POST list-keys
// Result
[
{
"alias": "alice",
"xpub": "a7dae957c2d35b42efe7e6871cf5a75ebd2a0d0e51caffe767db42d3e6d69dbe211d1ca492ecf05908fe6fa625ad61b3253375ea744c9442dd5551613ba50aea",
"file": "/Path/To/Library/Bytom/keystore/UTC--2018-04-21T02-35-15.035935116Z--4f2b8bd7-0576-4b82-8941-6cc6da05efe3"
},
{
"alias": "bob",
"xpub": "d30a810e88532f73816b7b5007d413cbd21e526ae9159023e5262511893adc1526b8eacd691b27c080201d7d79336a4f3d2cb4c167d997821cad445765916254",
"file": "/Path/To/Library/Bytom/keystore/UTC--2018-04-22T06-30-27.609315219Z--0e34293c-8856-4f5f-b934-37456a3820fa"
}
]Update alias for the existed key.
Object:
-
String- xpub, pubkey of the key. -
String- new_alias, new alias of the key.
none if the key alias is updated successfully.
// Request
curl -X POST update-key-alias -d '{"xpub": "a7dae957c2d35b42efe7e6871cf5a75ebd2a0d0e51caffe767db42d3e6d69dbe211d1ca492ecf05908fe6fa625ad61b3253375ea744c9442dd5551613ba50aea", "new_alias": "new_key"}'
// ResultDelete existed key, please make sure that there is no balance in the related accounts.
Object:
-
String- xpub, pubkey of the key. -
String- password, password of the key.
none if the key is deleted successfully.
// Request
curl -X POST delete-key -d '{"xpub": "a7dae957c2d35b42efe7e6871cf5a75ebd2a0d0e51caffe767db42d3e6d69dbe211d1ca492ecf05908fe6fa625ad61b3253375ea744c9442dd5551613ba50aea", "password": "123456"}'
// ResultCheck key password.
Object:
-
String- xpub, pubkey of the key. -
String- password, password of the key.
Object:
-
Boolean- check_result, result of check key password, true is check successfully, otherwise is false.
// Request
curl -X POST check-key-password -d '{"xpub": "a7dae957c2d35b42efe7e6871cf5a75ebd2a0d0e51caffe767db42d3e6d69dbe211d1ca492ecf05908fe6fa625ad61b3253375ea744c9442dd5551613ba50aea", "password": "123456"}'
// Result
{
"check_result": true
}Reset key password.
Object:
-
String- xpub, pubkey of the key. -
String- old_password, old password of the key. -
String- new_password, new password of the key.
Object:
-
Boolean- changed, result of reset key password, true is reset successfully, otherwise is false.
// Request
curl -X POST reset-key-password -d '{"xpub": "a7dae957c2d35b42efe7e6871cf5a75ebd2a0d0e51caffe767db42d3e6d69dbe211d1ca492ecf05908fe6fa625ad61b3253375ea744c9442dd5551613ba50aea", "old_password": "123456", "new_password": "654321"}'
// Result
{
"changed": true
}Create account to manage addresses. single sign account contain only one root_xpubs and quorum; however multi sign account contain many number of root_xpubs and quorum, quorum is the number of verify signature, the range is [1, len(root_xpubs)].
Object:
-
Array of String- root_xpubs, pubkey array. -
String- alias, name of the account. -
Integer- quorum, the default value is1, threshold of keys that must sign a transaction to spend asset units controlled by the account.
Optional:
-
String- access_token, if optional when creating account locally. However, if you want to create account remotely, it's indispensable.
Object:
-
String- id, account id. -
String- alias, name of account. -
Integer- key_index, key index of account. -
Integer- quorom, threshold of keys that must sign a transaction to spend asset units controlled by the account. -
Array of Object- xpubs, pubkey array.
// Request
curl -X POST create-account -d '{"root_xpubs":["2d6c07cb1ff7800b0793e300cd62b6ec5c0943d308799427615be451ef09c0304bee5dd492c6b13aaa854d303dc4f1dcb229f9578786e19c52d860803efa3b9a"],"quorum":1,"alias":"alice"}'
// Result
{
"alias": "alice",
"id": "08FO663C00A02",
"key_index": 1,
"quorum": 1,
"xpubs": [
"2d6c07cb1ff7800b0793e300cd62b6ec5c0943d308799427615be451ef09c0304bee5dd492c6b13aaa854d303dc4f1dcb229f9578786e19c52d860803efa3b9a"
]
}Returns the list of all available accounts.
Optional:
-
String- id, account id. -
String- alias, name of account.
-
Array of Object, account array.-
Object:-
String- id, account id. -
String- alias, name of account. -
Integer- key_index, key index of account. -
Integer- quorom, threshold of keys that must sign a transaction to spend asset units controlled by the account. -
Array of Object- xpubs, pubkey array.
-
-
list all the available accounts:
// Request
curl -X POST list-accounts -d '{"alias":"alice"}'
// Result
[
{
"alias": "alice",
"id": "086KQD75G0A02",
"key_index": 1,
"quorum": 1,
"xpubs": [
"180aab8bf247932a7cf68da5cc9a873266279155097612f1e5fdda4add88d5e91e2e7ce5b736f3ac933824cdee9effcf1531b90dfcb388e5cc306d14e9a2c85e"
]
}
]Update alias for the existed account.
Object: account_alias | account_id
-
String- new_alias, new alias of account.
optional:
-
String- account_alias, alias of account. -
String- account_id, id of account.
none if the account alias is updated successfully.
// Request
curl -X POST update-account-alias -d '{"account_id": "08FO663C00A02", "new_alias": "new_account"}'
or
curl -X POST update-account-alias -d '{"account_alias": "alice", "new_alias": "new_account"}'
// ResultDelete existed account, please make sure that there is no balance in the related addresses.
Object: account_alias | account_id
optional:
-
String- account_alias, alias of account. -
String- account_id, id of account.
none if the account is deleted successfully.
// Request
curl -X POST delete-account -d '{"account_id": "08FO663C00A02"}'
or
curl -X POST delete-account -d '{"account_alias": "alice"}'
// Resultcreate address and control program, the address and control program is are one to one relationship. in build-transaction API, receiver is address when action type is control_address, and receiver is control program when action type is control_program, they are the same result.
Object: account_alias | account_id
optional:
-
String- account_alias, alias of account. -
String- account_id, id of account.
Object:
-
String- address, address of account. -
String- control_program, control program of account.
//Request
curl -X POST create-account-receiver -d '{"account_alias": "alice", "account_id": "0BDQARM800A02"}'// Result
{
"address": "bm1q5u8u4eldhjf3lvnkmyl78jj8a75neuryzlknk0",
"control_program": "0014a70fcae7edbc931fb276d93fe3ca47efa93cf064"
}Returns the sub list of all available addresses by account.
-
String- account_alias, alias of account. -
String- account_id, id of account. -
Integer- from, the start position of first address -
Integer- count, the number of returned
-
Array of Object, account address array.-
Object:-
String- account_alias, alias of account. -
String- account_id, id of account. -
String- address, address of account. -
Boolean- change, whether the account address is change.
-
-
list three addresses from first position by account_id or account_alias:
// Request
curl -X POST list-addresses -d '{"account_alias": "alice", "account_id": "086KQD75G0A02", "from": 0, "count": 3}'
// Result
[
{
"account_alias": "alice",
"account_id": "086KQD75G0A02",
"address": "bm1qcn9lf7nxhswratvmg6d78nq7r7yupm36qgsv55",
"change": false
},
{
"account_alias": "alice",
"account_id": "086KQD75G0A02",
"address": "bm1qew4h5uvt5ssrtg2alms0j77r94c30m78ucrcxy",
"change": false
},
{
"account_alias": "alice",
"account_id": "086KQD75G0A02",
"address": "bm1qgnp4lte7wge0rsekevjlrdh39vkzz0c2alheue",
"change": false
}
]Verify the address is valid, and judge the address is own.
Object:
-
string- address, address of account.
Object:
-
Boolean- valid, whether the account address is valid. -
Boolean- is_local, whether the account address is local.
check whether the address is valid or not.
// Request
curl -X POST validate-address -d '{"address": "bm1qcn9lf7nxhswratvmg6d78nq7r7yupm36qgsv55"}'
// Result
{
"valid": true,
"is_local": true,
}Query the current mining address.
none
Object:
-
String- mining_address, the current mining address being used.
// Request
curl -X POST get-mining-address
// Result
{
"mining_address":"bm1qnhr65jq3q9gf8uymza8vp0ew8tfyh642wddxh6"
}Set the current mining address, no matter whethere the address is a local one. It returns an error message if the address format is incorrect.
Object:
-
String- mining_address, mining address to set.
Object:
-
String- mining_address, the new mining address.
// Request
curl -X POST set-mining-address -d '{"mining_address":"bm1qnhr65jq3q9gf8uymza8vp0ew8tfyh642wddxh6"}'
// Result
{
"mining_address":"bm1qnhr65jq3q9gf8uymza8vp0ew8tfyh642wddxh6"
}Get coinbase arbitrary.
none
Object:
-
String- arbitrary, the abitrary data append to coinbase, in hexdecimal format. (The full coinbase data for a block will be0x00&block_height&abitrary.)
// Request
curl -X POST get-coinbase-arbitrary
// Result
{
"arbitrary":"ff"
}Set coinbase arbitrary.
Object:
-
String- arbitrary, the abitrary data to be appended to coinbase, in hexdecimal format.
Object:
-
String- arbitrary, the abitrary data being appended to coinbase, in hexdecimal format. (The full coinbase data for a block will be0x00&block_height&abitrary.)
// Request
curl -X POST set-coinbase-arbitrary -d '{"arbitrary":"ff"}'
// Result
{
"arbitrary":"ff"
}Returns the list of all available pubkeys by account.
Object: account_alias | account_id
optional:
-
String- account_alias, alias of account. -
String- account_id, id of account. -
string- public_key, public key.
Object:
-
string- root_xpub, root xpub. -
Array of Object-pubkey_infos, public key array.-
String- pubkey, public key. -
Object- derivation_path, derivated path for root xpub.
-
// Request
curl -X POST list-pubkeys -d '{"account_id": "0GO0LLUV00A02"}'
// Result
{
"pubkey_infos": [
{
"derivation_path": [
"010100000000000000",
"0100000000000000"
],
"pubkey": "b7730319feac582056379548360da5c08258e248e5c29de08a97a6614df1425d"
},
{
"derivation_path": [
"010100000000000000",
"0200000000000000"
],
"pubkey": "5044a0d6113faaf4cb2550f63a820ab579a2af6134e503b76378490d5fe75af4"
},
{
"derivation_path": [
"010100000000000000",
"0300000000000000"
],
"pubkey": "ff5c28ce257b25c2a6e172ded490a708a8e654253836d92eb0a68b81ce63bea3"
}
],
"root_xpub": "94a909319eac179f7694b99b8367b9c02b4414b95961e2e3a5bd887e0616af05a7c5e4448df92cd6cdfd82e57cd7aefc1ee0a7fd0d6a2194b5e5faf82556bedc"
}Create asset definition, it prepares for the issuance of asset.
Object:
-
String- alias, name of the asset. -
Object- definition, definition of asset.
Optional:(please pick one form the following two ways)
-
Array of String- root_xpubs, xpub array. -
Integer- quorum, the default value is1, threshold of keys that must sign a transaction to spend asset units controlled by the account.
or
-
String- issuance_program, user-defined contract program.
Object:
-
String- id, asset id. -
String- alias, name of the asset. -
String- issuance_program, control program of the issuance of asset. -
Array of Object- keys, information of asset pubkey. -
String- definition, definition of asset. -
Integer- quorum, threshold of keys that must sign a transaction to spend asset units controlled by the account.
create asset by xpubs:
// Request
curl -X POST create-asset -d '{"alias": "GOLD", "root_xpubs": ["f6a16704f745a168642712060e6c5a69866147e21ec2447ae628f87d756bb68cc9b91405ad0a95f004090e864fde472f62ba97053ea109837bc89d63a64040d5"], "quorum":1}'
// Result
{
"id": "3c1cf4c9436e3f942cb2f1d70a584f1c61df3697698dacccdc89e46f46a003d0",
"alias": "GOLD",
"issuance_program": "766baa209683b893483c0a5a317bf9868a8e2a09691f8aa8c1f3e2a7bb62b157e76712e05151ad696c00c0",
"keys": [
{
"root_xpub": "f6a16704f745a168642712060e6c5a69866147e21ec2447ae628f87d756bb68cc9b91405ad0a95f004090e864fde472f62ba97053ea109837bc89d63a64040d5",
"asset_pubkey": "9683b893483c0a5a317bf9868a8e2a09691f8aa8c1f3e2a7bb62b157e76712e012bd443fa7d56a0627df0a29dffcdc52641672a0f5cba54d104ad76ebeb8dfc3",
"asset_derivation_path": [
"000200000000000000"
]
}
],
"quorum": 1,
"definition": {}
}create asset by issuance_program:
// Request
curl -X POST create-asset -d '{"alias": "TESTASSET","issuance_program": "20e9108d3ca8049800727f6a3505b3a2710dc579405dde03c250f16d9a7e1e6e78160014c5a5b563c4623018557fb299259542b8739f6bc20163201e074b22ed7ae8470c7ba5d8a7bc95e83431a753a17465e8673af68a82500c22741a547a6413000000007b7b51547ac1631a000000547a547aae7cac00c0", "definition":{"name":"TESTASSET","symbol":"TESTASSET","decimals":8,"description":{}}}'
// Result
{
"id": "59621aa82c047bd21f73711d4a7905b7a9fbb49bc1a3fdc309b13807cc8b9094",
"alias": "TESTASSET",
"issuance_program": "20e9108d3ca8049800727f6a3505b3a2710dc579405dde03c250f16d9a7e1e6e78160014c5a5b563c4623018557fb299259542b8739f6bc20163201e074b22ed7ae8470c7ba5d8a7bc95e83431a753a17465e8673af68a82500c22741a547a6413000000007b7b51547ac1631a000000547a547aae7cac00c0",
"keys": null,
"quorum": 0,
"definition": {
"decimals": 8,
"description": {},
"name": "TESTASSET",
"symbol": "TESTASSET"
}
}Query detail asset by asset ID.
Object:
-
String- id, id of asset.
Object:
-
String- id, asset id. -
String- alias, name of the asset. -
String- issuance_program, control program of the issuance of asset. -
Integer- key_index, index of key for xpub. -
Integer- quorum, threshold of keys that must sign a transaction to spend asset units controlled by the account. -
Array of Object- xpubs, pubkey array. -
String- type, type of asset. -
Integer- vm_version, version of VM. -
String- raw_definition_byte, byte of asset definition. -
Object- definition, description of asset.
get asset by assetID.
// Request
curl -X POST get-asset -d '{"id": "50ec80b6bc48073f6aa8fa045131a71213c33f3681203b15ddc2e4b81f1f4730"}'
// Result
{
"alias": "SILVER",
"definition": null,
"id": "50ec80b6bc48073f6aa8fa045131a71213c33f3681203b15ddc2e4b81f1f4730",
"issue_program": "ae2029cd61d9ef31d40af7541f9a50831d6317fdb0870249d0564fcfa9a8f843589c5151ad",
"key_index": 1,
"quorum": 1,
"raw_definition_byte": "",
"type": "asset",
"vm_version": 1,
"xpubs": [
"34b16ee500615cd325f8b84099f83c1ebecaca67977c5dc9b71ae32ceaf18207f996b0a9725b901d3792689b2babcb60febe3b81a684d9b56b65f67f307d453d"
]
}Returns the list of all available assets.
none
-
Array of Object, asset array.-
Object:-
String- id, asset id. -
String- alias, name of the asset. -
String- issuance_program, control program of the issuance of asset. -
Integer- key_index, index of key for xpub. -
Integer- quorum, threshold of keys that must sign a transaction to spend asset units controlled by the account. -
Array of Object- xpubs, pubkey array. -
String- type, type of asset. -
Integer- vm_version, version of VM. -
String- raw_definition_byte, byte of asset definition. -
Object- definition, description of asset.
-
-
list all the available assets:
// Request
curl -X POST list-assets -d {}
// Result
[
{
"alias": "BTM",
"definition": {
"decimals": 8,
"description": "Bytom Official Issue",
"name": "BTM",
"symbol": "BTM"
},
"id": "ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff",
"issue_program": "",
"key_index": 0,
"quorum": 0,
"raw_definition_byte": "7b0a202022646563696d616c73223a20382c0a2020226465736372697074696f6e223a20224279746f6d204f6666696369616c204973737565222c0a2020226e616d65223a202262746d222c0a20202273796d626f6c223a202262746d220a7d",
"type": "internal",
"vm_version": 1,
"xpubs": null
},
{
"alias": "SILVER",
"definition": null,
"id": "50ec80b6bc48073f6aa8fa045131a71213c33f3681203b15ddc2e4b81f1f4730",
"issue_program": "ae2029cd61d9ef31d40af7541f9a50831d6317fdb0870249d0564fcfa9a8f843589c5151ad",
"key_index": 1,
"quorum": 1,
"raw_definition_byte": "",
"type": "asset",
"vm_version": 1,
"xpubs": [
"34b16ee500615cd325f8b84099f83c1ebecaca67977c5dc9b71ae32ceaf18207f996b0a9725b901d3792689b2babcb60febe3b81a684d9b56b65f67f307d453d"
]
}
]Update asset alias by assetID.
Object:
-
String- id, id of asset. -
String- alias, new alias of asset.
none if the asset alias is updated success.
update asset alias.
// Request
curl -X POST update-asset-alias -d '{"id":"50ec80b6bc48073f6aa8fa045131a71213c33f3681203b15ddc2e4b81f1f4730", "alias":"GOLD"}'
// ResultReturns the list of all available account balances.
Optional:
-
String- account_id, account id. -
String- account_alias, name of account.
-
Array of Object, balances owned by the account.-
Object:-
String- account_id, account id. -
String- account_alias, name of account. -
String- asset_id, asset id. -
String- asset_alias, name of asset. -
Integer- amount, specified asset balance of account.
-
-
list all the available account balances.
// Request
curl -X POST list-balances -d {}
// Result
[
{
"account_alias": "default",
"account_id": "0BDQ9AP100A02",
"amount": 35508000000000,
"asset_alias": "BTM",
"asset_id": "ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff"
},
{
"account_alias": "alice",
"account_id": "0BDQARM800A04",
"amount": 60000000000,
"asset_alias": "BTM",
"asset_id": "ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff"
}
]list available account balances by the given account_id:
// Request
curl -X POST list-balances -d {"account_id":"0BDQ9AP100A02"}
// Result
[
{
"account_alias": "default",
"account_id": "0BDQ9AP100A02",
"amount": 35508000000000,
"asset_alias": "BTM",
"asset_id": "ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff"
}
]Returns the sub list of all available unspent outputs for all accounts in your wallet.
Object:
optional:
-
String- id, id of unspent output. -
Boolean- unconfirmed, is include unconfirmed utxo -
Boolean- smart_contract, is contract utxo -
Integer- from, the start position of first utxo -
Integer- count, the number of returned -
String- account_id, account id. -
String- account_alias, name of account.
-
Array of Object, unspent output array.-
Object:-
String- account_id, account id. -
String- account_alias, name of account. -
String- asset_id, asset id. -
String- asset_alias, name of asset. -
Integer- amount, specified asset balance of account. -
String- address, address of account. -
Boolean- change, whether the account address is change. -
String- id, unspent output id. -
String- program, program of account. -
String- control_program_index, index of program. -
String- source_id, source unspent output id. -
String- source_pos, position of source unspent output id in block. -
String- valid_height, valid height.
-
-
list all the available unspent outputs:
// Request
curl -X POST list-unspent-outputs -d {}
// Result
[
{
"account_alias": "alice",
"account_id": "0BKBR6VR00A06",
"address": "bm1qv3htuvug7qdv46ywcvvzytrwrsyg0swltfa0dm",
"amount": 2000,
"asset_alias": "GOLD",
"asset_id": "1883cce6aab82cf9af8cd085a3115dd4a92cdb8e6a9152acd73d7ae4adb9030a",
"change": false,
"control_program_index": 2,
"id": "58f29f0f85f7bd2a91088bcbe536dee41cd0642dfb1480d3a88589bdbfd642d9",
"program": "0014646ebe3388f01acae88ec318222c6e1c0887c1df",
"source_id": "5988c1630c1f325e69bb92cb4b19af14286aa107311bc64b8f1a54629a33e0f4",
"source_pos": 2,
"valid_height": 0
},
{
"account_alias": "default",
"account_id": "0BKBR2D2G0A02",
"address": "bm1qx7ylnhszg24995d5e0nftu9e87kt9vnxcn633r",
"amount": 624000000000,
"asset_alias": "BTM",
"asset_id": "ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff",
"change": false,
"control_program_index": 12,
"id": "5af9d3c9b69470983377c1fc0c9125c4ac3bfd32c8d505f2a6042aade8503bc9",
"program": "00143789f9de0242aa52d1b4cbe695f0b93facb2b266",
"source_id": "233d1dd49e591980f98e11f333c6c28a867e78448e272011f045131df5aa260b",
"source_pos": 0,
"valid_height": 12
}
]list the unspent output matching the given id:
// Request
curl -X POST list-unspent-outputs -d '{"id": "58f29f0f85f7bd2a91088bcbe536dee41cd0642dfb1480d3a88589bdbfd642d9"}'
// Result
{
"account_alias": "alice",
"account_id": "0BKBR6VR00A06",
"address": "bm1qv3htuvug7qdv46ywcvvzytrwrsyg0swltfa0dm",
"amount": 2000,
"asset_alias": "GOLD",
"asset_id": "1883cce6aab82cf9af8cd085a3115dd4a92cdb8e6a9152acd73d7ae4adb9030a",
"change": false,
"control_program_index": 2,
"id": "58f29f0f85f7bd2a91088bcbe536dee41cd0642dfb1480d3a88589bdbfd642d9",
"program": "0014646ebe3388f01acae88ec318222c6e1c0887c1df",
"source_id": "5988c1630c1f325e69bb92cb4b19af14286aa107311bc64b8f1a54629a33e0f4",
"source_pos": 2,
"valid_height": 0
}Backup wallet to image file, it contain accounts image, assets image and keys image.
none
Object:
-
Object- account_image, account image. -
Object- asset_image, asset image. -
Object- key_images, key image.
// Request
curl -X backup-wallet -d {}
// Result
{
"account_image": {
"slices": [
{
"account": {
"type": "account",
"xpubs": [
"395d6e0ac25978c3f52f9c7bdfdf75ce6af02639fd7875b4b1f40778ab1120c6dcf461b7ab6fd310983afb54a9a0fb3e09b6ec0d4364c4808c94383d50fb0681"
],
"quorum": 1,
"key_index": 1,
"ID": "0CQTA3EOG0A02",
"Alias": "def"
},
"contract_index": 2
}
]
},
"asset_image": {
"assets": []
},
"key_images": {
"xkeys": [
{
"crypto": {
"cipher": "aes-128-ctr",
"ciphertext": "bf44766fec149478af9500e25ce0a6bc50bb2fa04e40465781da6ff64e9b3a4c9af3d214cd92c5a41d8498db5f4376526740f960ff429b16e52876aec6860e1d",
"cipherparams": {
"iv": "1b0fc61ae4dacb15f0f77d2b4ba67635"
},
"kdf": "scrypt",
"kdfparams": {
"dklen": 32,
"n": 4096,
"p": 6,
"r": 8,
"salt": "e133b1e7caae771ff1ab34b14824d6e27ef399f2b7ded4ad3500f080ede4a1dd"
},
"mac": "bc6bf411fb63e61a17bc15b94f29cf0d5a0f084c328955da1f7e2b26757cfc23"
},
"id": "1f40be59-7400-4fdc-b46b-15009f65363a",
"type": "bytom_kd",
"version": 1,
"alias": "default",
"xpub": "c4ec9bfd5df19d175e17ff7fed89193c37a4a64e1c0928387da01387ca76c3bfd99390e3373ec4d438522cc2d4644214cd2ec3b00965f7a1fa3546809583191c"
},
{
"crypto": {
"cipher": "aes-128-ctr",
"ciphertext": "f0887c8603cbbafc0a66d5b45f71488e089708c7dea4342625a67858a49d6d08c79cd3f1800627e3c8b4668e8df34fcf0be9df5d9d4503acff05373976c312a9",
"cipherparams": {
"iv": "c111b46f9104f49f2c40aedb827e53b5"
},
"kdf": "scrypt",
"kdfparams": {
"dklen": 32,
"n": 4096,
"p": 6,
"r": 8,
"salt": "d9ef588b258b111dea1d99a4e4c5a4f968ab69072176bb95b111922e3bbea9e6"
},
"mac": "336f5fee643776e139f05ebe5e4f209d992ff97e16b906105fadac9e86133554"
},
"id": "611d407c-9e97-4297-a02a-13cd68e47983",
"type": "bytom_kd",
"version": 1,
"alias": "def",
"xpub": "395d6e0ac25978c3f52f9c7bdfdf75ce6af02639fd7875b4b1f40778ab1120c6dcf461b7ab6fd310983afb54a9a0fb3e09b6ec0d4364c4808c94383d50fb0681"
}
]
}
}Restore wallet by image file.
Object:
-
Object- account_image, account image. -
Object- asset_image, asset image. -
Object- key_images, key image.
none if restore wallet success.
// Request
curl -X POST restore-wallet -d '{"account_image":{"slices":[{"account":{"type":"account","xpubs":["395d6e0ac25978c3f52f9c7bdfdf75ce6af02639fd7875b4b1f40778ab1120c6dcf461b7ab6fd310983afb54a9a0fb3e09b6ec0d4364c4808c94383d50fb0681"],"quorum":1,"key_index":1,"ID":"0CQTA3EOG0A02","Alias":"def"},"contract_index":2}]},"asset_image":{"assets":[]},"key_images":{"xkeys":[{"crypto":{"cipher":"aes-128-ctr","ciphertext":"bf44766fec149478af9500e25ce0a6bc50bb2fa04e40465781da6ff64e9b3a4c9af3d214cd92c5a41d8498db5f4376526740f960ff429b16e52876aec6860e1d","cipherparams":{"iv":"1b0fc61ae4dacb15f0f77d2b4ba67635"},"kdf":"scrypt","kdfparams":{"dklen":32,"n":4096,"p":6,"r":8,"salt":"e133b1e7caae771ff1ab34b14824d6e27ef399f2b7ded4ad3500f080ede4a1dd"},"mac":"bc6bf411fb63e61a17bc15b94f29cf0d5a0f084c328955da1f7e2b26757cfc23"},"id":"1f40be59-7400-4fdc-b46b-15009f65363a","type":"bytom_kd","version":1,"alias":"default","xpub":"c4ec9bfd5df19d175e17ff7fed89193c37a4a64e1c0928387da01387ca76c3bfd99390e3373ec4d438522cc2d4644214cd2ec3b00965f7a1fa3546809583191c"},{"crypto":{"cipher":"aes-128-ctr","ciphertext":"f0887c8603cbbafc0a66d5b45f71488e089708c7dea4342625a67858a49d6d08c79cd3f1800627e3c8b4668e8df34fcf0be9df5d9d4503acff05373976c312a9","cipherparams":{"iv":"c111b46f9104f49f2c40aedb827e53b5"},"kdf":"scrypt","kdfparams":{"dklen":32,"n":4096,"p":6,"r":8,"salt":"d9ef588b258b111dea1d99a4e4c5a4f968ab69072176bb95b111922e3bbea9e6"},"mac":"336f5fee643776e139f05ebe5e4f209d992ff97e16b906105fadac9e86133554"},"id":"611d407c-9e97-4297-a02a-13cd68e47983","type":"bytom_kd","version":1,"alias":"def","xpub":"395d6e0ac25978c3f52f9c7bdfdf75ce6af02639fd7875b4b1f40778ab1120c6dcf461b7ab6fd310983afb54a9a0fb3e09b6ec0d4364c4808c94383d50fb0681"}]}}'
// ResultTrigger to rescan block information into related wallet.
none
none if restore wallet success.
// Request
curl -X POST rescan-wallet -d '{}'
// ResultRecovery wallet and accounts from root XPubs. All accounts and balances of bip44 multi-account hierarchy for deterministic wallets can be restored via root xpubs.
Object:
-
Object- xpubs, root XPubs.
Status of recovery wallet.
// Request
curl -X POST recovery-wallet -d '{ "xpubs":["c536a2c11fafd8278e02e9393dcbf5aa420eb51a1761a7e5da7f2b9b37969b52a8f8e2b692e7dcaf79dfa0d1e28c63eb9fda42942f20feaa8a71b383d9a4668c"]}'
// Result
{
"status": "success"
}Return the information of wallet.
none
Object:
-
Integer- best_block_height, current block height. -
Integer- wallet_height, current block height for wallet.
// Request
curl -X POST wallet-info -d '{}'
// Result
{
"best_block_height": 150,
"wallet_height": 150
}Sign a message with the key password(decode encrypted private key) of an address.
Object:
-
String- address, address for account. -
String- message, message for signature by address xpub. -
String- password, password of account.
Object:
-
String- derived_xpub, derived xpub. -
String- signature, signature of message.
// Request
curl -X POST sign-message -d '{"address":"bm1qx2qgvvjz734ur8x5lpfdtlau74aaa5djs0a5jn", "message":"this is a test message", "password":"123456"}'
// Result
{
"signature": "74da3d6572233736e3a439166719244dab57dd0047f8751b1efa2da26eeab251d915c1211dcad77e8b013267b86d96e91ae67ff0be520ef4ec326e911410b609",
"derived_xpub": "6ff8c3d1321ce39a3c3550f57ba70b67dcbcef821e9b85f6150edb7f2f3f91009e67f3075e6e76ed5f657ee4b1a5f4749b7a8c74c8e7e6a1b0e5918ebd5df4d0"
}Decode program.
Object:
-
String- program, program for account.
Object:
-
String- instructions, instructions and data for program.
// Request
curl -X POST decode-program -d '{"program":"0014a86c83ee12e6d790fb388345cc2e2b87056a0773"}'
// Result
{
"instructions": "DUP \nHASH160 \nDATA_20 a86c83ee12e6d790fb388345cc2e2b87056a0773\nEQUALVERIFY \nTXSIGHASH \nSWAP \nCHECKSIG \n"
}Query the account related transaction by transaction ID.
Object:
-
String- tx_id, transaction id, hash of transaction.
Object:
-
String- tx_id, transaction id, hash of the transaction. -
Integer- block_time, the unix timestamp for when the requst was responsed. -
String- block_hash, hash of the block where this transaction was in. -
Integer- block_height, block height where this transaction was in. -
Integer- block_index, position of the transaction in the block. -
Integer- block_transactions_count, transactions count where this transaction was in the block. -
Boolean- status_fail, whether the state of the transaction request has failed. -
Integer- size, size of transaction. -
Array of Object- inputs, object of inputs for the transaction.-
String- type, the type of input action, available option include: 'spend', 'issue', 'coinbase'. -
String- asset_id, asset id. -
String- asset_alias, name of asset. -
Object- asset_definition, definition of asset(json object). -
Integer- amount, amount of asset. -
Object- issuance_program, issuance program, it only exist when type is 'issue'. -
Object- control_program, control program of account, it only exist when type is 'spend'. -
String- address, address of account, it only exist when type is 'spend'. -
String- spent_output_id, the front of outputID to be spent in this input, it only exist when type is 'spend'. -
String- account_id, account id. -
String- account_alias, name of account. -
Object- arbitrary, arbitrary infomation can be set by miner, it only exist when type is 'coinbase'. -
String- input_id, hash of input action. -
Array of String- witness_arguments, witness arguments.
-
-
Array of Object- outputs, object of outputs for the transaction.-
String- type, the type of output action, available option include: 'retire', 'control'. -
String- id, outputid related to utxo. -
Integer- position, position of outputs. -
String- asset_id, asset id. -
String- asset_alias, name of asset. -
Object- asset_definition, definition of asset(json object). -
Integer- amount, amount of asset. -
String- account_id, account id. -
String- account_alias, name of account. -
Object- control_program, control program of account. -
String- address, address of account.
-
// Request
curl -X POST get-transaction -d '{"tx_id": "15b8d66e227feff47b3de0f278934ea16d6c828371ec6c13c8f84713dd11703b"}'
// Result
{
"block_hash": "1fa9bb389cf974a9b37b63ca38c0cf3453c30f394b9e8ae7f04f2d1b52c329b4",
"block_height": 530,
"block_index": 1,
"block_time": 1528772056,
"block_transactions_count": 2,
"inputs": [
{
"account_alias": "default",
"account_id": "0ER7MEFGG0A02",
"address": "sm1q4pkg8msjumtep7ecsdzuct3tsuzk5pmnm3p8nr",
"amount": 41250000000,
"asset_alias": "BTM",
"asset_definition": {
"decimals": 8,
"description": "Bytom Official Issue",
"name": "BTM",
"symbol": "BTM"
},
"asset_id": "ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff",
"control_program": "0014a86c83ee12e6d790fb388345cc2e2b87056a0773",
"input_id": "02702fe116e052aaf4473b034ed40720bfb3aba77df64625311ca3947d367336",
"spent_output_id": "002025b727148d04197cc7b9cf7eafd9986041f07641ca82dc0a1d9e227b52f6",
"type": "spend",
"witness_arguments": [
"944a35f256a49712f95319743671152b12360df859deedbfa9f37f9fe6a81b5ff2dce36d9ee6fc19e8be8b1dd5915719d4341f66f5569aad26283859d3c1bc05",
"bedfd27f48007c59555da672b6207ac997add62241894ff181bb9d8cba3b7e25"
]
}
],
"outputs": [
{
"account_alias": "default",
"account_id": "0ER7MEFGG0A02",
"address": "sm1qmt6jxrr8etssufr8qp98emyaly3lknxyndh5cj",
"amount": 29450000000,
"asset_alias": "BTM",
"asset_definition": {
"decimals": 8,
"description": "Bytom Official Issue",
"name": "BTM",
"symbol": "BTM"
},
"asset_id": "ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff",
"control_program": "0014daf5230c67cae10e2467004a7cec9df923fb4cc4",
"id": "35a46dd36eb27b1ffdfdefbe5366175b6325e8f56e5bc3dd2aa1a47197e26e6c",
"position": 0,
"type": "control"
},
{
"account_alias": "alice",
"account_id": "0ER7OAK400A02",
"address": "sm1qxe4jwhkekgnxkezu7xutu5gqnnpmyc8ppq98me",
"amount": 11700000000,
"asset_alias": "BTM",
"asset_definition": {
"decimals": 8,
"description": "Bytom Official Issue",
"name": "BTM",
"symbol": "BTM"
},
"asset_id": "ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff",
"control_program": "0014366b275ed9b2266b645cf1b8be51009cc3b260e1",
"id": "ae791bbde0cc5b370e28a505933b85082d67be8db81bdcc56b8202f200b883e7",
"position": 1,
"type": "control"
}
],
"size": 332,
"status_fail": false,
"tx_id": "15b8d66e227feff47b3de0f278934ea16d6c828371ec6c13c8f84713dd11703b"
}Returns the sub list of all the account related transactions.
Object:
optional:
-
String- id, transaction id, hash of transaction. -
String- account_id, id of account. -
Boolean- detail , flag of detail transactions, default false (only return transaction summary) -
Boolean- unconfirmed, flag of unconfirmed transactions(query result include all confirmed and unconfirmed transactions), default false. -
Integer- from, the start position of first transaction -
Integer- count, the number of returned
Array of Object, transaction array.
optional:
-
Object:(summary transaction)-
String- tx_id, transaction id, hash of the transaction. -
Integer- block_time, the unix timestamp for when the requst was responsed. -
Array of Object- inputs, object of summary inputs for the transaction.-
String- type, the type of input action, available option include: 'spend', 'issue', 'coinbase'. -
String- asset_id, asset id. -
String- asset_alias, name of asset. -
Integer- amount, amount of asset. -
String- account_id, account id. -
String- account_alias, name of account. -
Object- arbitrary, arbitrary infomation can be set by miner, it only exist when type is 'coinbase'.
-
-
Array of Object- outputs, object of summary outputs for the transaction.-
String- type, the type of output action, available option include: 'retire', 'control'. -
String- asset_id, asset id. -
String- asset_alias, name of asset. -
Integer- amount, amount of asset. -
String- account_id, account id. -
String- account_alias, name of account. -
Object- arbitrary, arbitrary infomation can be set by miner, it only exist when type is input 'coinbase'(this place is empty).
-
-
-
Object:(detail transaction)-
String- tx_id, transaction id, hash of the transaction. -
Integer- block_time, the unix timestamp for when the requst was responsed. -
String- block_hash, hash of the block where this transaction was in. -
Integer- block_height, block height where this transaction was in. -
Integer- block_index, position of the transaction in the block. -
Integer- block_transactions_count, transactions count where this transaction was in the block. -
Boolean- status_fail, whether the state of the transaction request has failed. -
Integer- size, size of transaction. -
Array of Object- inputs, object of inputs for the transaction.-
String- type, the type of input action, available option include: 'spend', 'issue', 'coinbase'. -
String- asset_id, asset id. -
String- asset_alias, name of asset. -
Object- asset_definition, definition of asset(json object). -
Integer- amount, amount of asset. -
Object- issuance_program, issuance program, it only exist when type is 'issue'. -
Object- control_program, control program of account, it only exist when type is 'spend'. -
String- address, address of account, it only exist when type is 'spend'. -
String- spent_output_id, the front of outputID to be spent in this input, it only exist when type is 'spend'. -
String- account_id, account id. -
String- account_alias, name of account. -
Object- arbitrary, arbitrary infomation can be set by miner, it only exist when type is 'coinbase'. -
String- input_id, hash of input action. -
Array of String- witness_arguments, witness arguments.
-
-
Array of Object- outputs, object of outputs for the transaction.-
String- type, the type of output action, available option include: 'retire', 'control'. -
String- id, outputid related to utxo. -
Integer- position, position of outputs. -
String- asset_id, asset id. -
String- asset_alias, name of asset. -
Object- asset_definition, definition of asset(json object). -
Integer- amount, amount of asset. -
String- account_id, account id. -
String- account_alias, name of account. -
Object- control_program, control program of account. -
String- address, address of account.
-
-
list all the available transactions:
// Request
curl -X POST list-transactions -d {}
// Result
[
{
"block_time": 1521771059,
"inputs": [
{
"arbitrary": "06",
"asset_id": "0000000000000000000000000000000000000000000000000000000000000000",
"type": "coinbase"
}
],
"outputs": [
{
"account_alias": "default",
"account_id": "0BMHBOBVG0A02",
"amount": 41250000000,
"asset_alias": "BTM",
"asset_id": "ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff",
"type": "control"
}
],
"tx_id": "c631a8de401913a512c338bcf4a61cb2de6cede12a7385d9d11637eaa6578f33"
},
{
"block_time": 1521770515,
"inputs": [
{
"account_alias": "default",
"account_id": "0BMHBOBVG0A02",
"amount": 41250000000,
"asset_alias": "BTM",
"asset_id": "ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff",
"type": "spend"
}
],
"outputs": [
{
"account_alias": "default",
"account_id": "0BMHBOBVG0A02",
"amount": 34649500000,
"asset_alias": "BTM",
"asset_id": "ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff",
"type": "control"
},
{
"account_alias": "alice",
"account_id": "0BMHDI1P00A04",
"amount": 6600000000,
"asset_alias": "BTM",
"asset_id": "ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff",
"type": "control"
}
],
"tx_id": "1151ce5c7b32b8755b5e48109ec7ed956fb1783eaea9558bf5a2ad957825e4b7"
}
]list the transaction matching the given tx_id with detail:
// Request
curl -X POST list-transactions -d '{"id": "7e9f9b999381da936e3cae48b5bac2b9bc28bb56c6c862be6c110448f7e2f6b3","detail": true}'
// Result
[
{
"block_hash": "1b2d0efa025256603e9330273d37f5a900cd3dfb213e015ac53cf645e2315a6d",
"block_height": 72,
"block_index": 1,
"block_time": 1528528584,
"block_transactions_count": 2,
"inputs": [
{
"account_alias": "default",
"account_id": "0ER7MEFGG0A02",
"address": "sm1q4pkg8msjumtep7ecsdzuct3tsuzk5pmnm3p8nr",
"amount": 41250000000,
"asset_alias": "BTM",
"asset_definition": {
"decimals": 8,
"description": "Bytom Official Issue",
"name": "BTM",
"symbol": "BTM"
},
"asset_id": "ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff",
"control_program": "0014a86c83ee12e6d790fb388345cc2e2b87056a0773",
"input_id": "adcef046c3f61fb6ba0d6a7107122f6e31cd4b49c7a3b05aa3391e5b0529d69a",
"spent_output_id": "0072a2c1cee30a7c7b7b006ca08a48c2b479bc81c0ec6463fe4865ef37626ab6",
"type": "spend",
"witness_arguments": [
"944a35f256a49712f95319743671152b12360df859deedbfa9f37f9fe6a81b5ff2dce36d9ee6fc19e8be8b1dd5915719d4341f66f5569aad26283859d3c1bc05",
"bedfd27f48007c59555da672b6207ac997add62241894ff181bb9d8cba3b7e25"
]
}
],
"outputs": [
{
"account_alias": "default",
"account_id": "0ER7MEFGG0A02",
"address": "sm1qskj096x5w7ejcmk746g3djmv84dpxts62dewvd",
"amount": 34649500000,
"asset_alias": "BTM",
"asset_definition": {
"decimals": 8,
"description": "Bytom Official Issue",
"name": "BTM",
"symbol": "BTM"
},
"asset_id": "ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff",
"control_program": "001485a4f2e8d477b32c6edeae9116cb6c3d5a132e1a",
"id": "b08c9bfc816064ca33da8b569998229774fc9552da7d4f16870b2c5a8f645b3b",
"position": 0,
"type": "control"
},
{
"account_alias": "alice",
"account_id": "0ER7OAK400A02",
"address": "sm1qxe4jwhkekgnxkezu7xutu5gqnnpmyc8ppq98me",
"amount": 6600000000,
"asset_alias": "BTM",
"asset_definition": {
"decimals": 8,
"description": "Bytom Official Issue",
"name": "BTM",
"symbol": "BTM"
},
"asset_id": "ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff",
"control_program": "0014366b275ed9b2266b645cf1b8be51009cc3b260e1",
"id": "0e8f8dc83a39b2b6d00a77759a797102d047f82f800fe21f5b1d80bb4d5e2e39",
"position": 1,
"type": "control"
}
],
"size": 333,
"status_fail": false,
"tx_id": "7e9f9b999381da936e3cae48b5bac2b9bc28bb56c6c862be6c110448f7e2f6b3"
}
]list the transaction matching the given account_id and unconfirmed flag(unconfirmed transaction's block_hash, block_height and block_index is default for zero):
// Request
curl -X POST list-transactions -d '{"account_id": "0F1MQVI500A02", "unconfirmed": true, "detail": true}'
// Result
[
{
"block_hash": "0000000000000000000000000000000000000000000000000000000000000000",
"block_height": 0,
"block_index": 0,
"block_time": 1529032899,
"inputs": [
{
"account_alias": "default",
"account_id": "0F1L5Q3V00A02",
"address": "sm1ql67n04pj8mfqzv3wjq8num3yrltdykemgrr45j",
"amount": 41250000000,
"asset_alias": "BTM",
"asset_definition": {
"decimals": 8,
"description": "Bytom Official Issue",
"name": "BTM",
"symbol": "BTM"
},
"asset_id": "ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff",
"control_program": "0014febd37d4323ed201322e900f3e6e241fd6d25b3b",
"input_id": "192ac93bad580cd53626b7f11c17e6eca64f66d1947add13a5620b78f666693e",
"spent_output_id": "00570443cbac4f68638ff565e8b04db2062800b9e23b7701913ddf6b190dbe65",
"type": "spend",
"witness_arguments": [
"512a2b60324433de96cd4274bd298b4b109a29c4d9d68582952065dfd0d7c00663cbc49e8e42fdef740a7e1b78622ee31abf2e9b0d5609755f275afd6751590b",
"bedfd27f48007c59555da672b6207ac997add62241894ff181bb9d8cba3b7e25"
]
},
{
"account_alias": "default",
"account_id": "0F1L5Q3V00A02",
"address": "sm1ql67n04pj8mfqzv3wjq8num3yrltdykemgrr45j",
"amount": 41250000000,
"asset_alias": "BTM",
"asset_definition": {
"decimals": 8,
"description": "Bytom Official Issue",
"name": "BTM",
"symbol": "BTM"
},
"asset_id": "ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff",
"control_program": "0014febd37d4323ed201322e900f3e6e241fd6d25b3b",
"input_id": "83713c02b52eb18f782de67b322c43571d83793e082596b6410e2d3a8a41387d",
"spent_output_id": "01df9011ca0bed4bb9b95dc84da4c5103fed06ca28c03d92d34ee3d61b945288",
"type": "spend",
"witness_arguments": [
"512a2b60324433de96cd4274bd298b4b109a29c4d9d68582952065dfd0d7c00663cbc49e8e42fdef740a7e1b78622ee31abf2e9b0d5609755f275afd6751590b",
"bedfd27f48007c59555da672b6207ac997add62241894ff181bb9d8cba3b7e25"
]
}
],
"outputs": [
{
"account_alias": "default",
"account_id": "0F1L5Q3V00A02",
"address": "sm1qdcfprk7wjy6flavkzhcjh3dxyrwlm935trrs5m",
"amount": 41249100000,
"asset_alias": "BTM",
"asset_definition": {
"decimals": 8,
"description": "Bytom Official Issue",
"name": "BTM",
"symbol": "BTM"
},
"asset_id": "ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff",
"control_program": "00146e1211dbce91349ff59615f12bc5a620ddfd9634",
"id": "09fabb1a2bac44c45054175453e23e81a764557147523d8df70d8a190cf2eb17",
"position": 0,
"type": "control"
},
{
"account_alias": "default",
"account_id": "0F1L5Q3V00A02",
"address": "sm1qt92xx2f4ys63dyhy58jle87nttcf37zftweklh",
"amount": 39150000000,
"asset_alias": "BTM",
"asset_definition": {
"decimals": 8,
"description": "Bytom Official Issue",
"name": "BTM",
"symbol": "BTM"
},
"asset_id": "ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff",
"control_program": "0014595463293524351692e4a1e5fc9fd35af098f849",
"id": "6efae48663e872193e8a672eb85b8bbf29d8aee98e42816340fa0b2340cc355d",
"position": 1,
"type": "control"
},
{
"account_alias": "alice",
"account_id": "0F1MQVI500A02",
"address": "sm1qum6ly8aq9u9k7xrkuck9pq64xg67gw40khnnxu",
"amount": 2100000000,
"asset_alias": "BTM",
"asset_definition": {
"decimals": 8,
"description": "Bytom Official Issue",
"name": "BTM",
"symbol": "BTM"
},
"asset_id": "ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff",
"control_program": "0014e6f5f21fa02f0b6f1876e62c5083553235e43aaf",
"id": "aca1ecc59d8bcf548e4f5afb8a97e38f0eb56e1387b17400fd3c693c074a703d",
"position": 2,
"type": "control"
}
],
"size": 1194,
"status_fail": false,
"tx_id": "9c28a6a2a039ed5bdebe81eea44cdb22a951c472bc25cb1e8188ae423a98f251"
},
{
"block_hash": "474b9c28b225fba02278ad3b097d561bf8f5c562ff2a548226fc10fc1d75b7ed",
"block_height": 255,
"block_index": 1,
"block_time": 1528963126,
"block_transactions_count": 2,
"inputs": [
{
"account_alias": "alice",
"account_id": "0F1MQVI500A02",
"address": "sm1qum6ly8aq9u9k7xrkuck9pq64xg67gw40khnnxu",
"amount": 10000000000,
"asset_alias": "BTM",
"asset_definition": {
"decimals": 8,
"description": "Bytom Official Issue",
"name": "BTM",
"symbol": "BTM"
},
"asset_id": "ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff",
"control_program": "0014e6f5f21fa02f0b6f1876e62c5083553235e43aaf",
"input_id": "0705bb7f4aea4ef869f22ab5e4a26e051b066e41290c1b74734a82aee8c03dfc",
"spent_output_id": "767649aafdfe2c22d46d641a5b74d934e2590330f7280b0fc55b978812a99a58",
"type": "spend",
"witness_arguments": [
"a4d4f09a04371516d37e1d27f92c9cb41e4b1e7f62762cf23ed3904a9dfd2d794195862fffd00bf7ac373e5891c8d2eb660dc5ff9c040ec4e01f973bbfd31c23",
"2ecb3f55bfde18ec95a93c456dd3d44cb55da83148a68cbc059ea04e7b12d3bc"
]
},
{
"account_alias": "alice",
"account_id": "0F1MQVI500A02",
"address": "sm1qum6ly8aq9u9k7xrkuck9pq64xg67gw40khnnxu",
"amount": 1000000000000,
"asset_alias": "GOLD",
"asset_definition": {
"decimals": 8,
"description": {},
"name": "",
"symbol": ""
},
"asset_id": "71deb74415f16a1f7bffb04c61d427bb1f93adfba257ffba2673f102d602e78f",
"control_program": "0014e6f5f21fa02f0b6f1876e62c5083553235e43aaf",
"input_id": "35764d80217d0d2a3c1b000dc2dd47cf0c8bc152c842ce6e3a7783140087d3d6",
"spent_output_id": "5d7a88851f5696ded279cb9bc380e050024c555258ea7851dfdedc2797b0d820",
"type": "spend",
"witness_arguments": [
"a4d4f09a04371516d37e1d27f92c9cb41e4b1e7f62762cf23ed3904a9dfd2d794195862fffd00bf7ac373e5891c8d2eb660dc5ff9c040ec4e01f973bbfd31c23",
"2ecb3f55bfde18ec95a93c456dd3d44cb55da83148a68cbc059ea04e7b12d3bc"
]
}
],
"outputs": [
{
"account_alias": "alice",
"account_id": "0F1MQVI500A02",
"address": "sm1q39sztlh4jq5nknstn2udvvpm6v5ugussx2djc0",
"amount": 9980000000,
"asset_alias": "BTM",
"asset_definition": {
"decimals": 8,
"description": "Bytom Official Issue",
"name": "BTM",
"symbol": "BTM"
},
"asset_id": "ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff",
"control_program": "0014896025fef590293b4e0b9ab8d6303bd329c47210",
"id": "2b44969d28d79544006e792411d6cd1d245f9af20419f6138494b4b5aac2a72e",
"position": 0,
"type": "control"
},
{
"account_alias": "alice",
"account_id": "0F1MQVI500A02",
"address": "sm1q258yd0gvatje4pn0qc8z9w8cdv45j9tvhfpjh8",
"amount": 999999999901,
"asset_alias": "GOLD",
"asset_definition": {
"decimals": 8,
"description": {},
"name": "",
"symbol": ""
},
"asset_id": "71deb74415f16a1f7bffb04c61d427bb1f93adfba257ffba2673f102d602e78f",
"control_program": "0014550e46bd0ceae59a866f060e22b8f86b2b49156c",
"id": "54be1bc876d1deccb9845acec79eabf62d7eacd5935e337850233657914d0f9d",
"position": 1,
"type": "control"
},
{
"amount": 99,
"asset_alias": "GOLD",
"asset_definition": {
"decimals": 8,
"description": {},
"name": "",
"symbol": ""
},
"asset_id": "71deb74415f16a1f7bffb04c61d427bb1f93adfba257ffba2673f102d602e78f",
"control_program": "20e864761d8181103b6476435a805cba97361df9a05c40fae644c27f69ce045d3c16001464d928e181900d382fa33def66534c7323c778c4015820684d6683d014abb4e019878b50fbbb547bcbf9c4739498d8eeef565d37f9a82f741a547a6413000000007b7b51547ac1631a000000547a547aae7cac00c0",
"id": "347553923bb550c236a703e46600d53f25161e3eb74ee3183884d398e5d894b0",
"position": 2,
"type": "control"
}
],
"size": 691,
"status_fail": false,
"tx_id": "383f8636842301b2fe292c5b8b2f540c6ed7867ba5751680b2e77827c300e41e"
}
]Build transaction.
Object:
-
String- base_transaction, base data for the transaction, default is null. -
Integer- ttl, integer of the time to live in milliseconds, it means utxo will be reserved(locked) for builded transaction in this time range, if the transaction will not to be submitted into block, it will be auto unlocked for build transaction again after this ttl time. it will be set to 5 minutes(300 seconds) defaultly when ttl is 0. -
Integer- time_range, the block height at which this transaction will be allowed to be included in a block. If the block height of the main chain exceeds this value, the transaction will expire and no longer be valid. -
Arrary of Object- actions:-
Object:-
String- account_id | account_alias, (type is spend_account) alias or ID of account. -
String- asset_id | asset_alias, (type is spend_account, issue, retire, control_program and control_address) alias or ID of asset. -
Integer- amount, (type is spend_account, issue, retire, control_program and control_address) the specified asset of the amount sent with this transaction. -
String- type, type of transaction, valid types: 'spend_account', 'issue', 'spend_account_unspent_output', 'control_address', 'control_program', 'retire'. -
String- address, (type is control_address) address of receiver, the style of address is P2PKH or P2SH. -
String- control_program, (type is control_program) control program of receiver. -
String- use_unconfirmed, (type is spend_account and spend_account_unspent_output) flag of use unconfirmed UTXO, default is false. -
String- arbitrary, (type is retire) arbitrary additional data by hexadecimal. -
Arrary of Object- arguments, (type is issue and spend_account_unspent_output) arguments of contract, null when it's not contract.-
String- type, type of argument, valid types: 'raw_tx_signature', 'data'. -
Object- raw_data, json object of argument content.-
String- xpub, (type is raw_tx_signature) root xpub. -
String- derivation_path, (type is raw_tx_signature) derived path. -
String- value, (type is data) string of binary value.
-
-
-
-
-
Object of build-transaction- transaction, builded transaction.
-
spend- transaction type is spend
// Request
curl -X POST build-transaction -d '{"base_transaction":null,"actions":[{"account_id":"0BF63M2U00A04","amount":20000000,"asset_id":"ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff","type":"spend_account"},{"account_id":"0BF63M2U00A04","amount":99,"asset_id":"3152a15da72be51b330e1c0f8e1c0db669269809da4f16443ff266e07cc43680","type":"spend_account"},{"amount":99,"asset_id":"3152a15da72be51b330e1c0f8e1c0db669269809da4f16443ff266e07cc43680","address":"bm1q50u3z8empm5ke0g3ngl2t3sqtr6sd7cepd3z68","type":"control_address"}],"ttl":0,"time_range": 43432}'-
issue- transaction type is issue
// Request
curl -X POST build-transaction -d '{"base_transaction":null,"actions":[{"account_id":"0BF63M2U00A04","amount":20000000,"asset_id":"ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff","type":"spend_account"},{"amount":10000,"asset_id":"3152a15da72be51b330e1c0f8e1c0db669269809da4f16443ff266e07cc43680","type":"issue"},{"amount":10000,"asset_id":"3152a15da72be51b330e1c0f8e1c0db669269809da4f16443ff266e07cc43680","address":"bm1q50u3z8empm5ke0g3ngl2t3sqtr6sd7cepd3z68","type":"control_address"}],"ttl":0,"time_range": 43432}'-
address- transaction type is address
// Request
curl -X POST build-transaction -d '{"base_transaction":null,"actions":[{"account_id":"0BF63M2U00A04","amount":20000000,"asset_id":"ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff","type":"spend_account"},{"account_id":"0BF63M2U00A04","amount":99,"asset_id":"3152a15da72be51b330e1c0f8e1c0db669269809da4f16443ff266e07cc43680","type":"spend_account"},{"amount":99,"asset_id":"3152a15da72be51b330e1c0f8e1c0db669269809da4f16443ff266e07cc43680","address":"bm1q50u3z8empm5ke0g3ngl2t3sqtr6sd7cepd3z68","type":"control_address"}],"ttl":0,"time_range": 43432}'-
retire- transaction type is retire
// Request
curl -X POST build-transaction -d '{"base_transaction":null,"actions":[{"account_id":"0BF63M2U00A04","amount":20000000,"asset_id":"ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff","type":"spend_account"},{"account_id":"0BF63M2U00A04","amount":99,"asset_id":"3152a15da72be51b330e1c0f8e1c0db669269809da4f16443ff266e07cc43680","type":"spend_account"},{"amount":99,"asset_id":"3152a15da72be51b330e1c0f8e1c0db669269809da4f16443ff266e07cc43680","arbitrary":"77656c636f6d65efbc8ce6aca2e8bf8ee69da5e588b0e58e9fe5ad90e4b896e7958c","type":"retire"}],"ttl":0,"time_range":43432}'-
spend_account_unspent_output- transaction type is spend_account_unspent_output(user can get UTXO information by calllist-unspent-outputsAPI)attention:
- action field
output_idcorrespond to UTXO resultidfield - UTXO asset and amount will be spent in this transaction
- transaction fee is (utxo asset_amount - output asset_amount)
- action field
// Request
curl -X POST build-transaction -d '{"base_transaction":null,"actions":[{"type":"spend_account_unspent_output","output_id":"01c6ccc6f522228cd4518bba87e9c43fbf55fdf7eb17f5aa300a037db7dca0cb"},{"amount":41243000000,"asset_id":"ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff","address":"sm1qmw8c5s29zlexknfahrze3ghvlqrtn2huuntvpn","type":"control_address"}],"ttl":0,"time_range":0}'// Result(this type is spend, the other types are similar.)
{
"allow_additional_actions": false,
"local": true,
"raw_transaction": "07010000020161015fb6a63a3361170afca03c9d5ce1f09fe510187d69545e09f95548b939cd7fffa3ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff80fc93afdf01000116001426bd1b851cf6eb8a701c20c184352ad8720eeee90100015d015bb6a63a3361170afca03c9d5ce1f09fe510187d69545e09f95548b939cd7fffa33152a15da72be51b330e1c0f8e1c0db669269809da4f16443ff266e07cc43680c03e0101160014489a678741ccc844f9e5c502f7fac0a665bedb25010003013effffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff80a2cfa5df0101160014948fb4f500e66d20fbacb903fe108ee81f9b6d9500013a3152a15da72be51b330e1c0f8e1c0db669269809da4f16443ff266e07cc43680dd3d01160014cd5a822b34e3084413506076040d508bb12232c70001393152a15da72be51b330e1c0f8e1c0db669269809da4f16443ff266e07cc436806301160014a3f9111f3b0ee96cbd119a3ea5c60058f506fb1900",
"signing_instructions": [
{
"position": 0,
"witness_components": [
{
"keys": [
{
"derivation_path": [
"010100000000000000",
"0500000000000000"
],
"xpub": "ee9dd8affdef7e0cacd0fbbf310217c7f588156c28e414db74c27afaedd8f876cf54547a672b431ff06ee8a146207df9595638a041b55ada1a764a8b5b30bda0"
}
],
"quorum": 1,
"signatures": null,
"type": "raw_tx_signature"
},
{
"type": "data",
"value": "62a73b6b7ffe52b6ad782b0e0efdc8309bf2f057d88f9a17d125e41bb11dbb88"
}
]
},
{
"position": 1,
"witness_components": [
{
"keys": [
{
"derivation_path": [
"010100000000000000",
"0600000000000000"
],
"xpub": "ee9dd8affdef7e0cacd0fbbf310217c7f588156c28e414db74c27afaedd8f876cf54547a672b431ff06ee8a146207df9595638a041b55ada1a764a8b5b30bda0"
}
],
"quorum": 1,
"signatures": null,
"type": "raw_tx_signature"
},
{
"type": "data",
"value": "ba5a63e7416caeb945eefc2ce874f40bc4aaf6005a1fc792557e41046f7e502f"
}
]
}
]
}Build chain transactions. To solve the problem of excessive utxo causing the transaction to fail, the utxo merge will be performed automatically. Currently, only btm transactions are supported.Warning, this feature requires the mine pool bytomd software to be higher than v1.0.6.
Object:
-
String- base_transaction, base data for the transaction, default is null. -
Integer- ttl, integer of the time to live in milliseconds, it means utxo will be reserved(locked) for builded transaction in this time range, if the transaction will not to be submitted into block, it will be auto unlocked for build transaction again after this ttl time. it will be set to 5 minutes(300 seconds) defaultly when ttl is 0. -
Integer- time_range, time stamp(block height)is maximum survival time for the transaction, the transaction will be not submit into block after this time stamp. -
Arrary of Object- actions:-
Object:-
String- account_id | account_alias, (type is spend_account) alias or ID of account. -
String- asset_id | asset_alias, (type is spend_account, issue, retire, control_program and control_address) alias or ID of asset. -
Integer- amount, (type is spend_account, issue, retire, control_program and control_address) the specified asset of the amount sent with this transaction. -
String- type, type of transaction, valid types: 'spend_account', 'issue', 'spend_account_unspent_output', 'control_address', 'control_program', 'retire'. -
String- address, (type is control_address) address of receiver, the style of address is P2PKH or P2SH. -
String- control_program, (type is control_program) control program of receiver. -
String- use_unconfirmed, (type is spend_account and spend_account_unspent_output) flag of use unconfirmed UTXO, default is false. -
Arrary of Object- arguments, (type is issue and spend_account_unspent_output) arguments of contract, null when it's not contract.-
String- type, type of argument, valid types: 'raw_tx_signature', 'data'. -
Object- raw_data, json object of argument content.-
String- xpub, (type is raw_tx_signature) root xpub. -
String- derivation_path, (type is raw_tx_signature) derived path. -
String- value, (type is data) string of binary value.
-
-
-
-
-
Object of raw_transaction- raw_transaction, builded transactions. -
Object of signing_instructions- signing_instructions, Information used to sign a transactions.
-
spend- transaction type is spend
// Request
curl -X POST localhost:9888/build-chain-transactions -d '{"base_transaction": null,"actions":[{"account_id":"0JCH28A600A02","amount":30000500000000,"asset_id":"ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff","type": "spend_account"}, {"amount": 30000490000000,"asset_id": "ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff","address": "sm1qx93sge8jkgzclc7pled7uqr596hjm2xe558lkr","type": "control_address"}],"ttl": 1000000,"time_range": 0}'// Result
{
"status": "success",
"data": [{
"raw_transaction": "0701000201620160a0d36052ca3d1335120ae48e1ffb2fb6b25588628eff90fa88bef3117dfb4301ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff80ddb2c490e906010116001431630464f2b2058fe3c1fe5bee00742eaf2da8d901000161015f72de2064ab999acf22c05b5cf9c7d53164f80038b46b1ce426708514a30a3485ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff80d4f4f69901000116001431630464f2b2058fe3c1fe5bee00742eaf2da8d9010001013fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff8084c5b6aaea060116001431630464f2b2058fe3c1fe5bee00742eaf2da8d900",
"signing_instructions": [{
"position": 0,
"witness_components": [{
"type": "raw_tx_signature",
"quorum": 1,
"keys": [{
"xpub": "b4d084e77bcda7fd8a37e31135200b2a6af98d19018674125dc6290dd14176f92523f229d9f1f3514b461f6931ac2073f586a35cd628c90270063725e6e1e983",
"derivation_path": ["010100000000000000", "0100000000000000"]
}],
"signatures": null
}, {
"type": "data",
"value": "a86ab33efa9d71994270898ad99f198d60889ef617d5eaf25e776929a8973919"
}]
}, {
"position": 1,
"witness_components": [{
"type": "raw_tx_signature",
"quorum": 1,
"keys": [{
"xpub": "b4d084e77bcda7fd8a37e31135200b2a6af98d19018674125dc6290dd14176f92523f229d9f1f3514b461f6931ac2073f586a35cd628c90270063725e6e1e983",
"derivation_path": ["010100000000000000", "0100000000000000"]
}],
"signatures": null
}, {
"type": "data",
"value": "a86ab33efa9d71994270898ad99f198d60889ef617d5eaf25e776929a8973919"
}]
}],
"allow_additional_actions": false
}, {
"raw_transaction": "0701000101620160571cc5d99a2994ff6b192bc9387838a3651245cb66dad4a6bc5f660310cebfa9ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff8084c5b6aaea06000116001431630464f2b2058fe3c1fe5bee00742eaf2da8d9010002013effffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff80faafed99010116001431630464f2b2058fe3c1fe5bee00742eaf2da8d900013fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff80ddb2c490e9060116001431630464f2b2058fe3c1fe5bee00742eaf2da8d900",
"signing_instructions": [{
"position": 0,
"witness_components": [{
"type": "raw_tx_signature",
"quorum": 1,
"keys": [{
"xpub": "b4d084e77bcda7fd8a37e31135200b2a6af98d19018674125dc6290dd14176f92523f229d9f1f3514b461f6931ac2073f586a35cd628c90270063725e6e1e983",
"derivation_path": ["010100000000000000", "0100000000000000"]
}],
"signatures": null
}, {
"type": "data",
"value": "a86ab33efa9d71994270898ad99f198d60889ef617d5eaf25e776929a8973919"
}]
}],
"allow_additional_actions": false
}]
}Sign transaction.
Object:
-
String- password, signature of the password. -
Object- transaction, builded transaction.
Object:
-
Boolean- sign_complete, returns true if sign succesfully and false otherwise. -
Object of sign-transaction- transaction, signed transaction.
// Request
curl -X POST sign-transaction -d '{"password":"123456","transaction":{"allow_additional_actions":false,"local":true,"raw_transaction":"07010000020161015fb6a63a3361170afca03c9d5ce1f09fe510187d69545e09f95548b939cd7fffa3ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff80fc93afdf01000116001426bd1b851cf6eb8a701c20c184352ad8720eeee90100015d015bb6a63a3361170afca03c9d5ce1f09fe510187d69545e09f95548b939cd7fffa33152a15da72be51b330e1c0f8e1c0db669269809da4f16443ff266e07cc43680c03e0101160014489a678741ccc844f9e5c502f7fac0a665bedb25010003013effffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff80a2cfa5df0101160014948fb4f500e66d20fbacb903fe108ee81f9b6d9500013a3152a15da72be51b330e1c0f8e1c0db669269809da4f16443ff266e07cc43680dd3d01160014cd5a822b34e3084413506076040d508bb12232c70001393152a15da72be51b330e1c0f8e1c0db669269809da4f16443ff266e07cc436806301160014a3f9111f3b0ee96cbd119a3ea5c60058f506fb1900","signing_instructions":[{"position":0,"witness_components":[{"keys":[{"derivation_path":["010100000000000000","0500000000000000"],"xpub":"ee9dd8affdef7e0cacd0fbbf310217c7f588156c28e414db74c27afaedd8f876cf54547a672b431ff06ee8a146207df9595638a041b55ada1a764a8b5b30bda0"}],"quorum":1,"signatures":null,"type":"raw_tx_signature"},{"type":"data","value":"62a73b6b7ffe52b6ad782b0e0efdc8309bf2f057d88f9a17d125e41bb11dbb88"}]},{"position":1,"witness_components":[{"keys":[{"derivation_path":["010100000000000000","0600000000000000"],"xpub":"ee9dd8affdef7e0cacd0fbbf310217c7f588156c28e414db74c27afaedd8f876cf54547a672b431ff06ee8a146207df9595638a041b55ada1a764a8b5b30bda0"}],"quorum":1,"signatures":null,"type":"raw_tx_signature"},{"type":"data","value":"ba5a63e7416caeb945eefc2ce874f40bc4aaf6005a1fc792557e41046f7e502f"}]}]}}'
// Result
{
"sign_complete": true,
"transaction": {
"allow_additional_actions": false,
"local": true,
"raw_transaction": "07010000020161015fb6a63a3361170afca03c9d5ce1f09fe510187d69545e09f95548b939cd7fffa3ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff80fc93afdf01000116001426bd1b851cf6eb8a701c20c184352ad8720eeee96302400d432e6f0e22da3168d76552273e60d23d432d61b4dac53e6769d39a1097f1cd1bd8e54c7d39eda334803e5c904bc2de2f27ff29748166e0334dcfded20e980b2062a73b6b7ffe52b6ad782b0e0efdc8309bf2f057d88f9a17d125e41bb11dbb88015d015bb6a63a3361170afca03c9d5ce1f09fe510187d69545e09f95548b939cd7fffa33152a15da72be51b330e1c0f8e1c0db669269809da4f16443ff266e07cc43680c03e0101160014489a678741ccc844f9e5c502f7fac0a665bedb256302401eadd84ad07c3643f71a35cc5669a2c1def96ae98e790d287217e6a3543fe602dd90afffe853c729bd5237a28f33538df631572847d9870829fb1fd1100ff20820ba5a63e7416caeb945eefc2ce874f40bc4aaf6005a1fc792557e41046f7e502f03013effffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff80a2cfa5df0101160014948fb4f500e66d20fbacb903fe108ee81f9b6d9500013a3152a15da72be51b330e1c0f8e1c0db669269809da4f16443ff266e07cc43680dd3d01160014cd5a822b34e3084413506076040d508bb12232c70001393152a15da72be51b330e1c0f8e1c0db669269809da4f16443ff266e07cc436806301160014a3f9111f3b0ee96cbd119a3ea5c60058f506fb1900",
"signing_instructions": [
{
"position": 0,
"witness_components": [
{
"keys": [
{
"derivation_path": [
"010100000000000000",
"0500000000000000"
],
"xpub": "ee9dd8affdef7e0cacd0fbbf310217c7f588156c28e414db74c27afaedd8f876cf54547a672b431ff06ee8a146207df9595638a041b55ada1a764a8b5b30bda0"
}
],
"quorum": 1,
"signatures": [
"0d432e6f0e22da3168d76552273e60d23d432d61b4dac53e6769d39a1097f1cd1bd8e54c7d39eda334803e5c904bc2de2f27ff29748166e0334dcfded20e980b"
],
"type": "raw_tx_signature"
},
{
"type": "data",
"value": "62a73b6b7ffe52b6ad782b0e0efdc8309bf2f057d88f9a17d125e41bb11dbb88"
}
]
},
{
"position": 1,
"witness_components": [
{
"keys": [
{
"derivation_path": [
"010100000000000000",
"0600000000000000"
],
"xpub": "ee9dd8affdef7e0cacd0fbbf310217c7f588156c28e414db74c27afaedd8f876cf54547a672b431ff06ee8a146207df9595638a041b55ada1a764a8b5b30bda0"
}
],
"quorum": 1,
"signatures": [
"1eadd84ad07c3643f71a35cc5669a2c1def96ae98e790d287217e6a3543fe602dd90afffe853c729bd5237a28f33538df631572847d9870829fb1fd1100ff208"
],
"type": "raw_tx_signature"
},
{
"type": "data",
"value": "ba5a63e7416caeb945eefc2ce874f40bc4aaf6005a1fc792557e41046f7e502f"
}
]
}
]
}
}Sign transactions used for batch signing transactions.
Object:
-
String- password, signature of the password. -
Object- transaction, builded transactions.
Object:
-
Boolean- sign_complete, returns true if sign succesfully and false otherwise. -
Object of sign-transactions- transaction, signed transactions.
// Request
curl -X POST localhost:9888/sign-transactions -d '{"password":"123456","transactions":[{"raw_transaction":"0701000201620160a0d36052ca3d1335120ae48e1ffb2fb6b25588628eff90fa88bef3117dfb4301ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff80ddb2c490e906010116001431630464f2b2058fe3c1fe5bee00742eaf2da8d901000161015f72de2064ab999acf22c05b5cf9c7d53164f80038b46b1ce426708514a30a3485ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff80d4f4f69901000116001431630464f2b2058fe3c1fe5bee00742eaf2da8d9010001013fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff8084c5b6aaea060116001431630464f2b2058fe3c1fe5bee00742eaf2da8d900","signing_instructions":[{"position":0,"witness_components":[{"type":"raw_tx_signature","quorum":1,"keys":[{"xpub":"b4d084e77bcda7fd8a37e31135200b2a6af98d19018674125dc6290dd14176f92523f229d9f1f3514b461f6931ac2073f586a35cd628c90270063725e6e1e983","derivation_path":["010100000000000000","0100000000000000"]}],"signatures":null},{"type":"data","value":"a86ab33efa9d71994270898ad99f198d60889ef617d5eaf25e776929a8973919"}]},{"position":1,"witness_components":[{"type":"raw_tx_signature","quorum":1,"keys":[{"xpub":"b4d084e77bcda7fd8a37e31135200b2a6af98d19018674125dc6290dd14176f92523f229d9f1f3514b461f6931ac2073f586a35cd628c90270063725e6e1e983","derivation_path":["010100000000000000","0100000000000000"]}],"signatures":null},{"type":"data","value":"a86ab33efa9d71994270898ad99f198d60889ef617d5eaf25e776929a8973919"}]}],"allow_additional_actions":false},{"raw_transaction":"0701000101620160571cc5d99a2994ff6b192bc9387838a3651245cb66dad4a6bc5f660310cebfa9ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff8084c5b6aaea06000116001431630464f2b2058fe3c1fe5bee00742eaf2da8d9010002013effffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff80faafed99010116001431630464f2b2058fe3c1fe5bee00742eaf2da8d900013fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff80ddb2c490e9060116001431630464f2b2058fe3c1fe5bee00742eaf2da8d900","signing_instructions":[{"position":0,"witness_components":[{"type":"raw_tx_signature","quorum":1,"keys":[{"xpub":"b4d084e77bcda7fd8a37e31135200b2a6af98d19018674125dc6290dd14176f92523f229d9f1f3514b461f6931ac2073f586a35cd628c90270063725e6e1e983","derivation_path":["010100000000000000","0100000000000000"]}],"signatures":null},{"type":"data","value":"a86ab33efa9d71994270898ad99f198d60889ef617d5eaf25e776929a8973919"}]}],"allow_additional_actions":false}]}'// Result
{
"status": "success",
"data": {
"transaction": [{
"raw_transaction": "0701000201620160a0d36052ca3d1335120ae48e1ffb2fb6b25588628eff90fa88bef3117dfb4301ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff80ddb2c490e906010116001431630464f2b2058fe3c1fe5bee00742eaf2da8d9630240acb57bc06f7e5de99ef3e630ce34fc74c33d4694301202968092ca50ae7842e3331bfeb0cf7b65f383e27670c4d58aeeeb0b77e5355957ca729298d2b4e2470c20a86ab33efa9d71994270898ad99f198d60889ef617d5eaf25e776929a89739190161015f72de2064ab999acf22c05b5cf9c7d53164f80038b46b1ce426708514a30a3485ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff80d4f4f69901000116001431630464f2b2058fe3c1fe5bee00742eaf2da8d96302404298424e89e5528f1d0cdd9028489b9d9e3f031ec34a74440cacc7900dc1eac9359c408a4342fc6cef935d2978919df8b23f3912ac4419800d375fac06ddb50620a86ab33efa9d71994270898ad99f198d60889ef617d5eaf25e776929a897391901013fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff8084c5b6aaea060116001431630464f2b2058fe3c1fe5bee00742eaf2da8d900",
"signing_instructions": [{
"position": 0,
"witness_components": [{
"type": "raw_tx_signature",
"quorum": 1,
"keys": [{
"xpub": "b4d084e77bcda7fd8a37e31135200b2a6af98d19018674125dc6290dd14176f92523f229d9f1f3514b461f6931ac2073f586a35cd628c90270063725e6e1e983",
"derivation_path": [
"010100000000000000",
"0100000000000000"
]
}],
"signatures": [
"acb57bc06f7e5de99ef3e630ce34fc74c33d4694301202968092ca50ae7842e3331bfeb0cf7b65f383e27670c4d58aeeeb0b77e5355957ca729298d2b4e2470c"
]
},
{
"type": "data",
"value": "a86ab33efa9d71994270898ad99f198d60889ef617d5eaf25e776929a8973919"
}
]
},
{
"position": 1,
"witness_components": [{
"type": "raw_tx_signature",
"quorum": 1,
"keys": [{
"xpub": "b4d084e77bcda7fd8a37e31135200b2a6af98d19018674125dc6290dd14176f92523f229d9f1f3514b461f6931ac2073f586a35cd628c90270063725e6e1e983",
"derivation_path": [
"010100000000000000",
"0100000000000000"
]
}],
"signatures": [
"4298424e89e5528f1d0cdd9028489b9d9e3f031ec34a74440cacc7900dc1eac9359c408a4342fc6cef935d2978919df8b23f3912ac4419800d375fac06ddb506"
]
},
{
"type": "data",
"value": "a86ab33efa9d71994270898ad99f198d60889ef617d5eaf25e776929a8973919"
}
]
}
],
"allow_additional_actions": false
},
{
"raw_transaction": "0701000101620160571cc5d99a2994ff6b192bc9387838a3651245cb66dad4a6bc5f660310cebfa9ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff8084c5b6aaea06000116001431630464f2b2058fe3c1fe5bee00742eaf2da8d96302408c742d77eba6c56a8db8c114e60be6c6263df6120aefd7538376129d04ec71b78b718c2085bba85254b44bf4600ba31d4c5a7869d0be0c46d88bd5eb27490e0820a86ab33efa9d71994270898ad99f198d60889ef617d5eaf25e776929a897391902013effffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff80faafed99010116001431630464f2b2058fe3c1fe5bee00742eaf2da8d900013fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff80ddb2c490e9060116001431630464f2b2058fe3c1fe5bee00742eaf2da8d900",
"signing_instructions": [{
"position": 0,
"witness_components": [{
"type": "raw_tx_signature",
"quorum": 1,
"keys": [{
"xpub": "b4d084e77bcda7fd8a37e31135200b2a6af98d19018674125dc6290dd14176f92523f229d9f1f3514b461f6931ac2073f586a35cd628c90270063725e6e1e983",
"derivation_path": [
"010100000000000000",
"0100000000000000"
]
}],
"signatures": [
"8c742d77eba6c56a8db8c114e60be6c6263df6120aefd7538376129d04ec71b78b718c2085bba85254b44bf4600ba31d4c5a7869d0be0c46d88bd5eb27490e08"
]
},
{
"type": "data",
"value": "a86ab33efa9d71994270898ad99f198d60889ef617d5eaf25e776929a8973919"
}
]
}],
"allow_additional_actions": false
}
],
"sign_complete": true
}
}
Submit transaction.
Object:
-
Object- raw_transaction, raw_transaction of signed transaction.
Object:
-
String- tx_id, transaction id, hash of transaction.
// Request
curl -X POST submit-transaction -d '{"raw_transaction":"07010000010161015ffe8bdb49bbd08f711a54f0fbed4141b74c276de44c831999aac43bdd56f98309ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff80c0b1ca94120001160014d61f9b3354771283461e6cb269bec98e7ee975f6630240403d7b35ec72a80816b21822d645adc98af2c1f07d5b379dda4527d8585ec12ef213ada312e3807ae0ccf7206575f313ffe2b405a286309d3172feabe07e7e0620d013706a314a57e84c2b262c2a291e8e2b063785aea9338476a66d41be4de4f202013effffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff80bc82eb931201160014bdf260424fd2f322dbec9ce4ddbaed8618d8e959000139ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff6301160014a3f9111f3b0ee96cbd119a3ea5c60058f506fb1900"}'
// Result
{
"tx_id": "2c0624a7d251c29d4d1ad14297c69919214e78d995affd57e73fbf84ece316cb"
}Submit transactions used for batch submit transactions.
Object:
-
Object- raw_transactions, raw_transactions of signed transactions.
Object:
-
String- tx_id, transactions id, hash of transactions.
// Request
curl -X POST localhost:9888/submit-transactions -d '{"raw_transactions":["0701000201620160a0d36052ca3d1335120ae48e1ffb2fb6b25588628eff90fa88bef3117dfb4301ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff80ddb2c490e906010116001431630464f2b2058fe3c1fe5bee00742eaf2da8d9630240acb57bc06f7e5de99ef3e630ce34fc74c33d4694301202968092ca50ae7842e3331bfeb0cf7b65f383e27670c4d58aeeeb0b77e5355957ca729298d2b4e2470c20a86ab33efa9d71994270898ad99f198d60889ef617d5eaf25e776929a89739190161015f72de2064ab999acf22c05b5cf9c7d53164f80038b46b1ce426708514a30a3485ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff80d4f4f69901000116001431630464f2b2058fe3c1fe5bee00742eaf2da8d96302404298424e89e5528f1d0cdd9028489b9d9e3f031ec34a74440cacc7900dc1eac9359c408a4342fc6cef935d2978919df8b23f3912ac4419800d375fac06ddb50620a86ab33efa9d71994270898ad99f198d60889ef617d5eaf25e776929a897391901013fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff8084c5b6aaea060116001431630464f2b2058fe3c1fe5bee00742eaf2da8d900","0701000101620160571cc5d99a2994ff6b192bc9387838a3651245cb66dad4a6bc5f660310cebfa9ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff8084c5b6aaea06000116001431630464f2b2058fe3c1fe5bee00742eaf2da8d96302408c742d77eba6c56a8db8c114e60be6c6263df6120aefd7538376129d04ec71b78b718c2085bba85254b44bf4600ba31d4c5a7869d0be0c46d88bd5eb27490e0820a86ab33efa9d71994270898ad99f198d60889ef617d5eaf25e776929a897391902013effffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff80faafed99010116001431630464f2b2058fe3c1fe5bee00742eaf2da8d900013fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff80ddb2c490e9060116001431630464f2b2058fe3c1fe5bee00742eaf2da8d900"]}'// Result
{
"status": "success",
"data": {
"tx_id": ["8524bf38701c17c57e2ad7368c0d6c815eb30e92713ff5dd86c1a931cddf2e95", "a0bbfb75c9a00bb2d4801aa95ed0479993a67acfd1cec5b77a8ff86966f52dac"]
}
}
Estimate consumed neu(1BTM = 10^8NEU) for the transaction.
Object:
-
Object- transaction_template, builded transaction response.
Object:
-
Integer- total_neu, total consumed neu(1BTM = 10^8NEU) for execute transaction, total_neu is rounded up storage_neu + vm_neu. -
Integer- storage_neu, consumed neu for storage transaction . -
Integer- vm_neu, consumed neu for execute VM.
// Request
curl -X POST estimate-transaction-gas -d '{"transaction_template":{"allow_additional_actions":false,"raw_transaction":"070100010161015ffe8a1209937a6a8b22e8c01f056fd5f1730734ba8964d6b79de4a639032cecddffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff8099c4d59901000116001485eb6eee8023332da85df60157dc9b16cc553fb2010002013dffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff80afa08b4f011600142b4fd033bc76b4ddf5cb00f625362c4bc7b10efa00013dffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff8090dfc04a011600146eea1ce6cfa5b718ae8094376be9bc1a87c9c82700","signing_instructions":[{"position":0,"witness_components":[{"keys":[{"derivation_path":["010100000000000000","0100000000000000"],"xpub":"cb4e5932d808ee060df9552963d87f60edac42360b11d4ad89558ef2acea4d4aaf4818f2ebf5a599382b8dfce0a0c798c7e44ec2667b3a1d34c61ba57609de55"}],"quorum":1,"signatures":null,"type":"raw_tx_signature"},{"type":"data","value":"1c9b5c1db7f4afe31fd1b7e0495a8bb042a271d8d7924d4fc1ff7cf1bff15813"}]}]}}'
// Result
{
"storage_neu": 3840000,
"total_neu": 5259000,
"vm_neu": 1419000
}Create access token, it provides basic access authentication for HTTP protocol, returns token contain username and password, they are separated by a colon.
Object:
-
String- id, token ID.
optional:
-
String- type, type of token.
Object:
-
String- token, access token, authentication username and password are separated by a colon. -
String- id, token ID. -
String- type, type of token. -
Object- created_at, time to create token.
create access token.
// Request
curl -X POST create-access-token -d '{"id":"token1"}'
// Result
{
"token": "token1:1fee70f537128a201338bd5f25a3adbf33dad02eae4f4c9ac43f336a069df8f3",
"id": "token1",
"created_at": "2018-03-20T18:56:01.043919771+08:00"
}Returns the list of all available access tokens.
none
-
Array of Object, access token array.-
Object:-
String- token, access token. -
String- id, token ID. -
String- type, type of token. -
Object- created_at, time to create token.
-
-
list all the available access tokens.
// Request
curl -X POST list-access-tokens -d {}
// Result
[
{
"token": "token1:1fee70f537128a201338bd5f25a3adbf33dad02eae4f4c9ac43f336a069df8f3",
"id": "token1",
"created_at": "2018-03-20T18:56:01.043919771+08:00"
},
{
"token": "alice:78598c6d9fb9e3258d01f78005d4e5725ad0d45e20af90a30b577b407d4a2edd",
"id": "alice",
"created_at": "2018-03-20T18:56:01.043919771+08:00"
}
]Delete existed access token.
Object:
-
String- id, token ID.
none if the access token is deleted successfully.
delete access token.
// Request
curl -X POST delete-access-token -d '{"id": "token1"}'
// ResultCheck access token is valid.
Object:
-
String- id, token ID. -
String- secret, secret of token, the second part of the colon division for token.
none if the access token is checked valid.
check whether the access token is vaild or not.
// Request
curl -X POST check-access-token -d '{"id": "token1", "secret": "1fee70f537128a201338bd5f25a3adbf33dad02eae4f4c9ac43f336a069df8f3"}'
// ResultCreate transaction feed.
Object:
-
String- alias, name of the transaction feed. -
String- filter, filter of the transaction feed.
none if the transaction feed is created success.
// Request
curl -X POST create-transaction-feed -d '{"alias": "test1", "filter": "asset_id='84778a666fe453cf73b2e8c783dbc9e04bc4fd7cbb4f50caeaee99cf9967ebed' AND amount_lower_limit = 50 AND amount_upper_limit = 100"}'
// ResultQuery detail transaction feed by name.
Object:
-
String- alias, name of the transaction feed.
Object:
-
String- id, id of the transaction feed. -
String- alias, name of the transaction feed. -
String- filter, filter of the transaction feed. -
Object- param, param of the transaction feed.-
String- assetid, asset id. -
Integer- lowerlimit, the lower limit of asset amount. -
Integer- upperlimit, the upper limit of asset amount. -
String- transtype, type of transaction.
-
list the available txfeed by alias:
// Request
curl -X POST get-transaction-feed -d '{"alias": "test1"}'
// Result
{
"alias": "test1",
"filter": "asset_id='84778a666fe453cf73b2e8c783dbc9e04bc4fd7cbb4f50caeaee99cf9967ebed' AND amount_lower_limit = 50 AND amount_upper_limit = 100",
"param": {}
}Returns the list of all available transaction feeds.
none
-
Array of Object, the transaction feeds.-
Object:-
String- id, id of the transaction feed. -
String- alias, name of the transaction feed. -
String- filter, filter of the transaction feed. -
Object- param, param of the transaction feed.-
String- assetid, asset id. -
Integer- lowerlimit, the lower limit of asset amount. -
Integer- upperlimit, the upper limit of asset amount. -
String- transtype, type of transaction.
-
-
-
list all the available txfeed:
// Request
curl -X POST list-transaction-feeds -d {}
// Result
[
{
"alias": "test1",
"filter": "asset_id='84778a666fe453cf73b2e8c783dbc9e04bc4fd7cbb4f50caeaee99cf9967ebed' AND amount_lower_limit = 50 AND amount_upper_limit = 100",
"param": {}
},
{
"alias": "test2",
"filter": "asset_id='cee6a588cc3fc280749021ef42d5209952a1e6feceada4e69dd8a424ad22b199' AND amount_lower_limit = 30 AND amount_upper_limit = 100",
"param": {}
}
]Delete transaction feed by name.
Object:
-
String- alias, name of the transaction feed.
none if the transaction feed is deleted success.
// Request
curl -X POST delete-transaction-feed -d '{"alias": "test1"}'
// ResultUpdate transaction feed.
Object:
-
String- alias, name of the transaction feed. -
String- filter, filter of the transaction feed.
none if the transaction feed is updated success.
deleted when the txfeed exists, and create it with alias and filter:
// Request
curl -X POST update-transaction-feed -d '{"alias": "test1", "filter": "asset_id='84778a666fe453cf73b2e8c783dbc9e04bc4fd7cbb4f50caeaee99cf9967ebed' AND amount_lower_limit = 60 AND amount_upper_limit = 80"}'
// ResultQuery mempool transaction by transaction ID.
Object:
-
String- tx_id, transaction id, hash of transaction.
Object:
-
String- id, transaction id, hash of the transaction. -
Integer- version, version of transaction. -
Integer- size, size of transaction. -
Integer- time_range, the time range of transaction. -
Boolean- status_fail, whether the state of the request has failed. -
String- mux_id, the previous transaction mux id(wallet enable can be acquired, this place is empty). -
Array of Object- inputs, object of inputs for the transaction(input struct please refer to get-transction API description). -
Array of Object- outputs, object of outputs for the transaction(output struct please refer to get-transction API description).
// Request
curl -X POST get-unconfirmed-transaction -d '{"tx_id": "382090f24fbfc2f737fa7372b9d161a43f00d1c597a7130a56589d1f469d04b5"}'
// Result
{
"id": "382090f24fbfc2f737fa7372b9d161a43f00d1c597a7130a56589d1f469d04b5",
"inputs": [
{
"address": "bm1qqrm7ruecx7yrg9smtwmnmgj3umg9vcukgy5sdj",
"amount": 41250000000,
"asset_definition": {},
"asset_id": "ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff",
"control_program": "001400f7e1f338378834161b5bb73da251e6d0566396",
"input_id": "a0c2fa0719bfe1446681537dcf1f8d0f03add093e29d12481eb807e07778d7b3",
"spent_output_id": "161b44e547a6cc68d732eb64fa38031da98211a99319e088cfe632223f9ac6d8",
"type": "spend",
"witness_arguments": [
"cf0e1b217ab92ade8e81fab10f9f307bb5cc1ad947b5629e3f7a760aba722f5044f2ab59ec92fa4264ff5811de4361abb6eabd7e75ffd28a813a98ceff434c01",
"6890a19b21c326059eef211cd8414282a79d3b9203f2592064221fd360e778a7"
]
}
],
"mux_id": "842cd07eed050b547377b5b123f14a5ec0d76933d564f030cf4d5d5c15769645",
"outputs": [
{
"address": "bm1qehxd5cdnepckh5jc72ggn30havd78lsgcqmt7k",
"amount": 21230000000,
"asset_definition": {},
"asset_id": "ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff",
"control_program": "0014cdccda61b3c8716bd258f29089c5f7eb1be3fe08",
"id": "a8f21ad24689c290634db85278f56d152efe6fe08bc194e5dee5127ed6d3ebee",
"position": 0,
"type": "control"
},
{
"address": "bm1q2me9gwccnm3ehpnrcr99gcnj730js2zfucms3r",
"amount": 20000000000,
"asset_definition": {},
"asset_id": "ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff",
"control_program": "001456f2543b189ee39b8663c0ca546272f45f282849",
"id": "78219e422ea3257aeb32f6d952b5ce5560dab1d6440c9f3aebcdaad2a852d2a8",
"position": 1,
"type": "control"
}
],
"size": 664,
"status_fail": false,
"time_range": 0,
"version": 1
}Returns the total number of mempool transactions and the list of transaction IDs.
none
Object:
-
Integer- total, version of transaction. -
Array of Object- tx_ids, list of transaction id.
// Request
curl -X POST list-unconfirmed-transactions -d {}
// Result
{
"total": 2,
"tx_ids": [
"382090f24fbfc2f737fa7372b9d161a43f00d1c597a7130a56589d1f469d04b5",
"fc2da5dfa094c2170144f149fa07a312983157aec0ec95063a1319eedcb2d23b"
]
}Decode a serialized transaction hex string into a JSON object describing the transaction.
Object:
-
String- raw_transaction, hexstring of raw transaction.
Object:
-
String- tx_id, transaction ID. -
Integer- version, version of transaction. -
String- size, size of transaction. -
String- time_range, time range of transaction. -
String- fee, fee for sending transaction. -
Array of Object- inputs, object of inputs for the transaction(input struct please refer to get-transction API description). -
Array of Object- outputs, object of outputs for the transaction (output struct please refer to get-transction API description).
// Request
curl -X POST decode-raw-transaction -d '{"raw_transaction": "070100010161015fc8215913a270d3d953ef431626b19a89adf38e2486bb235da732f0afed515299ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff8099c4d59901000116001456ac170c7965eeac1cc34928c9f464e3f88c17d8630240b1e99a3590d7db80126b273088937a87ba1e8d2f91021a2fd2c36579f7713926e8c7b46c047a43933b008ff16ecc2eb8ee888b4ca1fe3fdf082824e0b3899b02202fb851c6ed665fcd9ebc259da1461a1e284ac3b27f5e86c84164aa518648222602013effffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff80bbd0ec980101160014c3d320e1dc4fe787e9f13c1464e3ea5aae96a58f00013cffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff8084af5f01160014bb93cdb4eca74b068321eeb84ac5d33686281b6500"}'
// Result
{
"fee": 20000000,
"inputs": [
{
"address": "sm1q26kpwrrevhh2c8xrfy5vnaryu0ugc97csrdy69",
"amount": 41250000000,
"asset_definition": {},
"asset_id": "ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff",
"control_program": "001456ac170c7965eeac1cc34928c9f464e3f88c17d8",
"input_id": "9963265eb601df48501cc240e1480780e9ed6e0c8f18fd7dd57954068c5dfd02",
"spent_output_id": "01bb3309666618a1507cb5be845b17dee5eb8028ee7e71b17d74b4dc97085bc8",
"type": "spend",
"witness_arguments": [
"b1e99a3590d7db80126b273088937a87ba1e8d2f91021a2fd2c36579f7713926e8c7b46c047a43933b008ff16ecc2eb8ee888b4ca1fe3fdf082824e0b3899b02",
"2fb851c6ed665fcd9ebc259da1461a1e284ac3b27f5e86c84164aa5186482226"
]
}
],
"outputs": [
{
"address": "sm1qc0fjpcwuflnc06038s2xfcl2t2hfdfv0lxzg7s",
"amount": 41030000000,
"asset_definition": {},
"asset_id": "ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff",
"control_program": "0014c3d320e1dc4fe787e9f13c1464e3ea5aae96a58f",
"id": "567b34857614d16292220beaca16ce34b939c75023a49cc43fa432fff51ca0dd",
"position": 0,
"type": "control"
},
{
"address": "sm1qhwfumd8v5a9sdqepa6uy43wnx6rzsxm9essn4l",
"amount": 200000000,
"asset_definition": {},
"asset_id": "ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff",
"control_program": "0014bb93cdb4eca74b068321eeb84ac5d33686281b65",
"id": "a8069d412e48c2b2994d2816758078cff46b215421706b4bad41f72a32928d92",
"position": 1,
"type": "control"
}
],
"size": 332,
"time_range": 0,
"tx_id": "4c97d7412b04d49acc33762fc748cd0780d8b44086c229c1a6d0f2adfaaac2db",
"version": 1
}Returns the current block height for blockchain.
none
Object:
-
Integer- block_count, recent block height of the blockchain.
// Request
curl -X POST get-block-count
// Result
{
"block_count": 519
}Returns the current block hash for blockchain.
none
Object:
-
String- block_hash, recent block hash of the blockchain.
// Request
curl -X POST get-block-hash
// Result
{
"block_hash": "997bf5cecb4df097991a7a121a7fd3cb5a404fa856e3d6032c791ac07bc7c74c"
}Returns the detail block by block height or block hash.
Object: block_height | block_hash
optional:
-
String- block_hash, hash of block. -
Integer- block_height, height of block.
Object:
-
String- hash, hash of block. -
Integer- size, size of block. -
Integer- version, version of block. -
Integer- height, height of block. -
String- previous_block_hash, previous block hash. -
Integer- timestamp, timestamp of block. -
Integer- nonce, nonce value. -
Integer- bits, bits of difficulty. -
String- difficulty, difficulty value(String type). -
String- transaction_merkle_root, merkle root of transaction. -
String- transaction_status_hash, merkle root of transaction status. -
Array of Object- transactions, transaction object:-
String- id, transaction id, hash of the transaction. -
Integer- version, version of transaction. -
Integer- size, size of transaction. -
Integer- time_range, the unix timestamp for when the requst was responsed. -
Boolean- status_fail, whether the state of the request has failed. -
String- mux_id, the previous transaction mux id(source id of utxo). -
Array of Object- inputs, object of inputs for the transaction.-
String- type, the type of input action, available option include: 'spend', 'issue', 'coinbase'. -
String- asset_id, asset id. -
String- asset_alias, name of asset. -
Object- asset_definition, definition of asset(json object). -
Integer- amount, amount of asset. -
Object- issuance_program, issuance program, it only exist when type is 'issue'. -
Object- control_program, control program of account, it only exist when type is 'spend'. -
String- address, address of account, it only exist when type is 'spend'. -
String- spent_output_id, the front of outputID to be spent in this input, it only exist when type is 'spend'. -
String- account_id, account id. -
String- account_alias, name of account. -
Object- arbitrary, arbitrary infomation can be set by miner, it only exist when type is 'coinbase'. -
String- input_id, hash of input action. -
Array of String- witness_arguments, witness arguments.
-
-
Array of Object- outputs, object of outputs for the transaction.-
String- type, the type of output action, available option include: 'retire', 'control'. -
String- id, outputid related to utxo. -
Integer- position, position of outputs. -
String- asset_id, asset id. -
String- asset_alias, name of asset. -
Object- asset_definition, definition of asset(json object). -
Integer- amount, amount of asset. -
String- account_id, account id. -
String- account_alias, name of account. -
Object- control_program, control program of account. -
String- address, address of account.
-
-
get specified block information by block_hash or block_height, if both exists, the block result is querying by hash.
// Request
curl -X POST get-block -d '{"block_height": 43, "block_hash": "886a8e85b275e7d65b569ba510875c0e63dece1a94569914d7624c0dac8002f9"}'
// Result
{
"bits": 2305843009222082600,
"difficulty": "5549086336",
"hash": "886a8e85b275e7d65b569ba510875c0e63dece1a94569914d7624c0dac8002f9",
"height": 43,
"nonce": 3,
"previous_block_hash": "2c72ccbd53b92a4f9423c5b610b4e106bbe8fbf3ecf2e16a1266b17ee323ff9d",
"size": 386,
"timestamp": 1521614189,
"transaction_merkle_root": "77d40262cfeca3a16d4587132974552ef00951e43ce567a26801ebc3dbdb4d96",
"transaction_status_hash": "53c0ab896cb7a3778cc1d35a271264d991792b7c44f5c334116bb0786dbc5635",
"transactions": [
{
"id": "4576b1b1ec251da3263dbdd5486bcbf9a1cd1f712172dbe7a7a5fe46ab194629",
"inputs": [
{
"amount": 0,
"arbitrary": "09",
"asset_definition": "7b7d",
"asset_id": "0000000000000000000000000000000000000000000000000000000000000000",
"input_id": "6cb8491e4b1cbdc052c2fdb5f2849194d59118b954d5ea5244bbd20e3cff3b80",
"type": "coinbase",
"witness_arguments": null
}
],
"mux_id": "2383cefe8a34ea5810cc0706f2cf8cf08a106f90fc3eb3441f723cecdbc61331",
"outputs": [
{
"address": "sm1q4pkg8msjumtep7ecsdzuct3tsuzk5pmnm3p8nr",
"amount": 624000000000,
"asset_definition": "7b7d",
"asset_id": "ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff",
"control_program": "0014f3403bcd8b443d03882a280b50f6f98986e1a255",
"id": "da87b40854a9b93be72ecdc24fe7bb03986ea3530e344b0f918f0788c3d83717",
"position": 0,
"type": "control"
}
],
"size": 77,
"status_fail": false,
"time_range": 0,
"version": 1
}
],
"version": 1
}Returns the detail block header by block height or block hash.
Object: block_height | block_hash
optional:
-
String- block_hash, hash of block. -
Integer- block_height, height of block.
Object:
-
Object- block_header, header of block. -
Integer- reward, reward.
// Request
curl -X POST get-block-header -d '{"block_height": 43, "block_hash": "886a8e85b275e7d65b569ba510875c0e63dece1a94569914d7624c0dac8002f9"}'
// Result
{
"block_header": "01019601e87da37e7d73f31d54304c719c9058ec7bc7de7819deda89a7c8834a99bc05b8fbdbe6d60540eba9e5d5cb79fd87b3c0fad32f6772c1e4483f2a070e093a6176d85226d986a8c9c377e5192668bc0a367e4a4764f11e7c725ecced1d7b6a492974fab1b6d5bc00ad918480808080801e",
"reward": 41250000000
}Returns the block difficulty by block height or block hash.
Object:
optional:
-
String- block_hash, hash of block. -
Integer- block_height, height of block.
Object:
-
Integer- bits, bits of block. -
String- difficulty, difficulty of block. -
String- hash, block hash. -
Integer- height, block height.
Get difficulty for specified block hash / height.
// Request
curl -X POST get-difficulty -d '{"block_height": 506, "block_hash": "d1fce60caea5466eae2b812e4586b55120c52aca27b6c92bd7c51e9cda82dcdf"}'
// Result
{
"bits": 2161727821137910500,
"difficulty": "15154807",
"hash": "d1fce60caea5466eae2b812e4586b55120c52aca27b6c92bd7c51e9cda82dcdf",
"height": 506
}Returns the block hash rate by block height or block hash, it returns the current block hash rate when request is empty.
Object:
optional:
-
String- block_hash, hash of block. -
Integer- block_height, height of block.
Object:
-
Integer- hash_rate, difficulty of block. -
String- hash, block hash. -
Integer- height, block height.
Get hash rate for specified block hash / height.
// Request
curl -X POST get-hash-rate -d '{"block_height": 506, "block_hash": "d1fce60caea5466eae2b812e4586b55120c52aca27b6c92bd7c51e9cda82dcdf"}'
// Result
{
"hash": "d1fce60caea5466eae2b812e4586b55120c52aca27b6c92bd7c51e9cda82dcdf",
"hash_rate": 7577403,
"height": 506
}Returns the information of current network node.
none
Object:
-
Boolean- listening, whether the node is listening. -
Boolean- syncing, whether the node is syncing. -
Boolean- mining, whether the node is mining. -
Integer- peer_count, current count of connected peers. -
Integer- current_block, current block height in the node's blockchain. -
Integer- highest_block, current highest block of the connected peers. -
String- network_id, network id. -
Object- version_info, bytomd version information:-
String- version, current version of the runningbytomd. -
uint16- update, whether there exists an update.- 0: no update;
- 1: small update;
- 2: significant update.
-
String- new_version, the newest version ofbytomdif there is one.
-
// Request
curl -X POST net-info
// Result
{
"listening": true,
"syncing": true,
"mining": true,
"peer_count": 0,
"current_block": 627,
"highest_block": 0,
"network_id": "mainnet",
"version": "0.5.0"
}Returns the mining status.
none
Object:
-
Boolean- is_mining, whether the node is mining.
// Request
curl -X POST is-mining
// Result
{
"is_mining": true
}Start up node mining.
Object:
-
Boolean- is_mining, whether the node is mining.
// Request
curl -X POST set-mining -d '{"is_mining": true}'
// ResultQuary gas rate.
none
Object:
-
Integer- gas_rate, gas rate.
// Request
curl -X POST gas-rate -d '{}'
// Result
{
"gas_rate": 1000
}Verify a signed message with derived pubkey of the address.
Object:
-
String- address, address for account. -
String- derived_xpub, derived xpub. -
String- message, message for signature by derived_xpub. -
String- signature, signature for message.
Object:
-
Boolean- result, verify result.
// Request
curl -X POST verify-message -d '{"address":"bm1qx2qgvvjz734ur8x5lpfdtlau74aaa5djs0a5jn", "derived_xpub":"6ff8c3d1321ce39a3c3550f57ba70b67dcbcef821e9b85f6150edb7f2f3f91009e67f3075e6e76ed5f657ee4b1a5f4749b7a8c74c8e7e6a1b0e5918ebd5df4d0", "message":"this is a test message", "signature":"74da3d6572233736e3a439166719244dab57dd0047f8751b1efa2da26eeab251d915c1211dcad77e8b013267b86d96e91ae67ff0be520ef4ec326e911410b609"}'
// Result
{
"result": true
}Compile equity contract.
Object:
-
String- contract, content of equity contract.
Optional:
-
Array of Object- args, parameters of contract.-
Boolean- boolean, boolean parameter. -
Integer- integer, integer parameter. -
String- string, string parameter.
-
Object:
-
String- name, contract name. -
String- source, source content of contract. -
String- program, generated program by compiling contract. -
Array of Object- params, parameters of contract. -
String- value, locked value name of contract. -
Array of Object- clause_info, clauses of contract. -
String- opcodes, opcodes of contract. -
String- error, returned error information for compiling contract.
// Request
{
"contract": "contract LockWithPublicKey(publicKey: PublicKey) locks locked { clause unlockWithSig(sig: Signature) { verify checkTxSig(publicKey, sig) unlock locked }}",
"args": [
{
"string": "e9108d3ca8049800727f6a3505b3a2710dc579405dde03c250f16d9a7e1e6e78"
}
]
}
// Result
{
"name": "LockWithPublicKey",
"source": "contract LockWithPublicKey(publicKey: PublicKey) locks locked { clause unlockWithSig(sig: Signature) { verify checkTxSig(publicKey, sig) unlock locked }}",
"program": "20e9108d3ca8049800727f6a3505b3a2710dc579405dde03c250f16d9a7e1e6e787403ae7cac00c0",
"params": [
{
"name": "publicKey",
"type": "PublicKey"
}
],
"value": "locked",
"clause_info": [
{
"name": "unlockWithSig",
"args": [
{
"name": "sig",
"type": "Signature"
}
],
"value_info": [
{
"name": "locked"
}
],
"block_heights": [],
"hash_calls": null
}
],
"opcodes": "0xe9108d3ca8049800727f6a3505b3a2710dc579405dde03c250f16d9a7e1e6e78 DEPTH 0xae7cac FALSE CHECKPREDICATE",
"error": ""
}Returns the list of connected peers.
none
-
Array of Object, connected peers.-
Object:-
String- peer_id, peer id. -
String- remote_addr, the address(IP and port) of connected peer. -
Integer- height, the current height of connected peer. -
String- ping, the delay time of connected peer. -
String- duration, the connected time. -
Integer- total_sent, total data sent in byte. -
Integer- total_received, total data received in byte. -
Integer- average_sent_rate, average data sent rate in byte. -
Integer- average_received_rate, average data received rate in byte. -
Integer- current_sent_rate, current data sent rate in byte. -
Integer- current_received_rate, current data received rate in byte.
-
-
// Request
curl -X POST list-peers -d '{}'
// Result
[
{
"peer_id":"3B58D7139B53066F2031FC1F027D2B3423FA4CE01F1FB1CC2DC4003C78413C24",
"remote_addr":"52.83.251.197:46656",
"height":84222,
"ping":"40ms",
"duration":"17.26s",
"total_sent":17565,
"total_received":3642187,
"average_sent_rate":1018,
"average_received_rate":211019,
"current_sent_rate":2420,
"current_received_rate":157087
}
]Disconnect to specified peer.
Object:
-
String- peer_id, peer id.
none if disconnect peer successfully.
// Request
curl -X POST disconnect-peer -d '{"peer_id":"29661E8BB9A8149F01C6594E49EA80C6B18BF247946A7E2E01D8235BBBFC3594"}'
// ResultConnect to specified peer.
Object:
-
String- ip, peer IP address. -
Integer- port, peer port.
Object:
-
String- peer_id, peer id. -
String- remote_addr, the address(IP and port) of connected peer. -
Integer- height, the current height of connected peer. -
Integer- delay, the delay time of connected peer.
// Request
curl -X POST connect-peer -d '{"ip":"139.198.177.164", "port":46657}'
// Result
{
"peer_id": "29661E8BB9A8149F01C6594E49EA80C6B18BF247946A7E2E01D8235BBBFC3594",
"remote_addr": "139.198.177.164:46657",
"height": 65941,
"delay": 0
}Get the proof of work.
none
Object:
-
Object- block_header, raw block header. -
String- seed, seed.
type GetWorkResp struct {
BlockHeader *types.BlockHeader `json:"block_header"`
Seed *bc.Hash `json:"seed"`
}// Request
curl -X POST get-work -d '{}'
// Result
{
"block_header": "0101870103f2c7495164c8f3af43697e81faa21dcb2d60aa5e10ce4f233491e62420742fbeadfcd50540bef2670a5fade2e58ad4955e2375a04ad1e4cb9c104faddab43f4a79e35be253c9c377e5192668bc0a367e4a4764f11e7c725ecced1d7b6a492974fab1b6d5bc00ffffff838080808020",
"seed": "702bef3f1707577fd0d75b6359a2919fa216487fe306771e27710acbaa9164ce"
}Submit the proof of work.
Object:
-
Object- block_header, raw block header.
type SubmitWorkReq struct {
BlockHeader *types.BlockHeader `json:"block_header"`
}true if success
// Request
curl -X POST submit-work -d '{"block_header": "0101870103f2c7495164c8f3af43697e81faa21dcb2d60aa5e10ce4f233491e62420742fbeadfcd50540bef2670a5fade2e58ad4955e2375a04ad1e4cb9c104faddab43f4a79e35be253c9c377e5192668bc0a367e4a4764f11e7c725ecced1d7b6a492974fab1b6d5bc00ffffff838080808020"}'
// Result
true / errorGet the proof of work by json.
none
Object:
-
Object- block_header, Object of block header.-
Integer- version, version of block. -
Integer- height, height of block. -
String- previous_block_hash, previous block hash. -
Integer- timestamp, timestamp of block. -
Integer- nonce, nonce value. -
Integer- bits, bits of difficulty. -
Object- block_commitment, Object of block commitment.-
String- transaction_merkle_root, merkle root of transaction. -
String- transaction_status_hash, merkle root of transaction status.
-
-
-
String- seed, seed.
// Request
curl -X POST get-work-json -d '{}'
// Result
{
"block_header": {
"version": 1,
"height": 62960,
"previous_block_hash": "dabdb926f8635791ac43f5d5fc62a4597e10e140f00aced3af621a77ead4e9fd",
"timestamp": 1533006396,
"nonce": 0,
"bits": 2017612633069711400,
"block_commitment": {
"transaction_merkle_root": "a13fc86af3852ab73e30c3ae30e8cedbe990560a3c0f20dc37c4c14562b94802",
"transaction_status_hash": "c9c377e5192668bc0a367e4a4764f11e7c725ecced1d7b6a492974fab1b6d5bc"
}
},
"seed": "2e2010e11289d6b273b7b1ea947f98cc5ad60d206df184b1501f8ac903fa01a9"
}Submit the proof of work by json.
Object:
-
Object- block_header, Object of block header.-
Integer- version, version of block. -
Integer- height, height of block. -
String- previous_block_hash, previous block hash. -
Integer- timestamp, timestamp of block. -
Integer- nonce, nonce value. -
Integer- bits, bits of difficulty. -
Object- block_commitment, Object of block commitment.-
String- transaction_merkle_root, merkle root of transaction. -
String- transaction_status_hash, merkle root of transaction status.
-
-
true if success
// Request
curl -X POST submit-work-json -d '{"block_header":{"version":1,"height":62960,"previous_block_hash":"dabdb926f8635791ac43f5d5fc62a4597e10e140f00aced3af621a77ead4e9fd","timestamp":1533006396,"nonce":0,"bits":2017612633069711400,"block_commitment":{"transaction_merkle_root":"a13fc86af3852ab73e30c3ae30e8cedbe990560a3c0f20dc37c4c14562b94802","transaction_status_hash":"c9c377e5192668bc0a367e4a4764f11e7c725ecced1d7b6a492974fab1b6d5bc"}}}'
// Result
true / error