Client
Client class for Cron RPC. Node.js CRON integration example
Kind: global class
- Client
- new Client([url], [protocol], [host], [port])
- .newPrivateKey() ⇒
String
- .getKeys(id) ⇒
Promise
- .generateKeyPair(id) ⇒
Promise
- .getBalance(address, id) ⇒
Promise
- .getUnspents(address,, asset, id) ⇒
Promise
- .getTxHeight(txId, id) ⇒
Promise
- .getTxOut(txId, index, id) ⇒
Promise
- .getTxInfo(txId, verbose, id) ⇒
Promise
- .getTxs(wallet) ⇒
Promise
- .sendTransaction(data, id) ⇒
Promise
- .getBlockCount() ⇒
Promise
- .callRpc(method, id, params) ⇒
Promise
new Client([url], [protocol], [host], [port])
Param | Type | Default | Description |
---|---|---|---|
[url] | string |
connection url (use other params if not specified) | |
[protocol] | string |
"http" |
connection protocol |
[host] | string |
connection host | |
[port] | string |
connection port |
String
client.newPrivateKey() ⇒ Generate new privateKey
Kind: instance method of Client
Returns: String
- new privateKey
Promise
client.getKeys(id) ⇒ get keys info by privateKey
Kind: instance method of Client
Returns: Promise
- Promise object with object with publicKey, privateKey and other key info
Param | Type | Default |
---|---|---|
id | number |
1 |
Promise
client.generateKeyPair(id) ⇒ Generate new key pair
Kind: instance method of Client
Returns: Promise
- Promise object with object with publicKey and privateKey
Param | Type | Default |
---|---|---|
id | number |
1 |
Promise
client.getBalance(address, id) ⇒ Get address current balance
Kind: instance method of Client
Returns: Promise
- Promise object with current balance of given address
Param | Type | Default |
---|---|---|
address | string |
|
id | number |
1 |
Promise
client.getUnspents(address,, asset, id) ⇒ Get address unspents
Kind: instance method of Client
Returns: Promise
- Promise object with current unspents
Param | Type | Description |
---|---|---|
address, | string |
|
asset | string |
(not required), |
id | number |
Promise
client.getTxHeight(txId, id) ⇒ Get transaction height
Kind: instance method of Client
Returns: Promise
- txBlock
Param | Type | Default |
---|---|---|
txId | string |
|
id | number |
1 |
Promise
client.getTxOut(txId, index, id) ⇒ Get transaction out
Kind: instance method of Client
Returns: Promise
- tx data
Param | Type | Default | Description |
---|---|---|---|
txId | string |
||
index | number |
0 |
The index of the transaction output to be obtained in the transaction (starts from 0) |
id | number |
1 |
Promise
client.getTxInfo(txId, verbose, id) ⇒ Get transaction info (getrawtransaction)
Kind: instance method of Client
Returns: Promise
- tx data
Param | Type | Default | Description |
---|---|---|---|
txId | string |
||
verbose | number |
1 |
When verbose is 1, detailed information of the corresponding block in Json format string, is returned |
id | number |
1 |
Promise
client.getTxs(wallet) ⇒ Get transactions by address (cron_get_transactions)
Kind: instance method of Client
Returns: Promise
- txs list
Param | Type | Description |
---|---|---|
wallet | string/array |
address |
Promise
client.sendTransaction(data, id) ⇒ Send transaction
Kind: instance method of Client
Returns: Promise
- Promise object with hash of new transaction
Param | Type | Default | Description |
---|---|---|---|
data | object |
Object with privateKey, to, amount, asset(optional), message(optional), fee(optional) | |
id | number |
1 |
Promise
client.getBlockCount() ⇒ Get blockchain block count
Kind: instance method of Client
Returns: Promise
- Promise object with blockCount
Promise
client.callRpc(method, id, params) ⇒ Call RPC API-method
Kind: instance method of Client
Returns: Promise
- Promise object with blockCount
Param | Type |
---|---|
method | string |
id | number |
params | object |