Version 1.0.1.
RPC methods available in the hot wallet mode.
Force the wallet to scan the remaining blocks from node until the tip is reached
Parameters:
{}
Returns:
nothing
Rescan the blockchain and re-detect all operations related to the selected account in this wallet
Parameters:
{}
Returns:
nothing
Parameters:
{}
Returns:
{
"id": hex string,
"height": number,
}
Creates a new account with an optional name. Returns an error if the last created account does not have a transaction history.
Parameters:
{ "name": EITHER OF
1) string
2) null }
Returns:
{
"account": number,
"name": EITHER OF
1) string
2) null,
}
Renames the selected account with an optional name. If the name is not specified, it will remove any existing name for the account.
Parameters:
{
"account": number,
"name": EITHER OF
1) string
2) null,
}
Returns:
{
"account": number,
"name": EITHER OF
1) string
2) null,
}
Add, rename or delete a label to an already added standalone address. Specifying a label will add or replace the existing one, and not specifying a label will remove the existing one.
Parameters:
{
"account": number,
"address": bech32 string,
"label": EITHER OF
1) string
2) null,
}
Returns:
nothing
Add a new standalone watch only address not derived from the selected account's key chain
Parameters:
{
"account": number,
"address": bech32 string,
"label": EITHER OF
1) string
2) null,
"no_rescan": EITHER OF
1) bool
2) null,
}
Returns:
nothing
Add a new standalone private key not derived from the selected account's key chain to be watched
Parameters:
{
"account": number,
"hex_private_key": hex string,
"label": EITHER OF
1) string
2) null,
"no_rescan": EITHER OF
1) bool
2) null,
}
Returns:
nothing
Add a new standalone multi signature address
Use the transaction_compose command to use the new multisig address as input or output
Parameters:
{
"account": number,
"min_required_signatures": number,
"public_keys": [ bech32 string, .. ],
"label": EITHER OF
1) string
2) null,
"no_rescan": EITHER OF
1) bool
2) null,
}
Returns:
string
Lists all the utxos owned by a multisig watched by this account
Parameters:
{
"account": number,
"utxo_types": [ EITHER OF
1) "Transfer"
2) "LockThenTransfer"
3) "IssueNft"
4) "CreateStakePool"
5) "ProduceBlockFromStake"
6) "Htlc", .. ],
"utxo_states": [ EITHER OF
1) "Confirmed"
2) "Conflicted"
3) "Inactive"
4) "Abandoned"
5) "InMempool", .. ],
"with_locked": EITHER OF
1) "Any"
2) "Unlocked"
3) "Locked"
4) null,
}
Returns:
[ {
"outpoint": {
"source_id": EITHER OF
1) {
"type": "Transaction",
"content": { "tx_id": hex string },
}
2) {
"type": "BlockReward",
"content": { "block_id": hex string },
},
"index": number,
},
"output": EITHER OF
1) {
"type": "Transfer",
"content": {
"value": EITHER OF
1) {
"type": "Coin",
"content": { "amount": {
"atoms": number string,
"decimal": decimal string,
} },
}
2) {
"type": "Token",
"content": {
"id": bech32 string,
"amount": {
"atoms": number string,
"decimal": decimal string,
},
},
},
"destination": bech32 string,
},
}
2) {
"type": "LockThenTransfer",
"content": {
"value": EITHER OF
1) {
"type": "Coin",
"content": { "amount": {
"atoms": number string,
"decimal": decimal string,
} },
}
2) {
"type": "Token",
"content": {
"id": bech32 string,
"amount": {
"atoms": number string,
"decimal": decimal string,
},
},
},
"destination": bech32 string,
"timelock": EITHER OF
1) {
"type": "UntilHeight",
"content": number,
}
2) {
"type": "UntilTime",
"content": { "timestamp": number },
}
3) {
"type": "ForBlockCount",
"content": number,
}
4) {
"type": "ForSeconds",
"content": number,
},
},
}
3) {
"type": "Burn",
"content": { "value": EITHER OF
1) {
"type": "Coin",
"content": { "amount": {
"atoms": number string,
"decimal": decimal string,
} },
}
2) {
"type": "Token",
"content": {
"id": bech32 string,
"amount": {
"atoms": number string,
"decimal": decimal string,
},
},
} },
}
4) {
"type": "CreateStakePool",
"content": {
"pool_id": bech32 string,
"data": {
"pledge": {
"atoms": number string,
"decimal": decimal string,
},
"staker": bech32 string,
"vrf_public_key": bech32 string,
"decommission_key": bech32 string,
"margin_ratio_per_thousand": string,
"cost_per_block": {
"atoms": number string,
"decimal": decimal string,
},
},
},
}
5) {
"type": "ProduceBlockFromStake",
"content": {
"destination": bech32 string,
"pool_id": bech32 string,
},
}
6) {
"type": "CreateDelegationId",
"content": {
"destination": bech32 string,
"pool_id": bech32 string,
},
}
7) {
"type": "DelegateStaking",
"content": {
"amount": {
"atoms": number string,
"decimal": decimal string,
},
"delegation_id": bech32 string,
},
}
8) {
"type": "IssueFungibleToken",
"content": { "data": {
"token_ticker": {
"text": EITHER OF
1) string
2) null,
"hex": hex string,
},
"number_of_decimals": number,
"metadata_uri": {
"text": EITHER OF
1) string
2) null,
"hex": hex string,
},
"total_supply": EITHER OF
1) {
"type": "Fixed",
"content": { "amount": {
"atoms": number string,
"decimal": decimal string,
} },
}
2) { "type": "Lockable" }
3) { "type": "Unlimited" },
"authority": bech32 string,
"is_freezable": bool,
} },
}
9) {
"type": "IssueNft",
"content": {
"token_id": bech32 string,
"data": { "metadata": {
"creator": EITHER OF
1) bech32 string
2) null,
"name": {
"text": EITHER OF
1) string
2) null,
"hex": hex string,
},
"description": {
"text": EITHER OF
1) string
2) null,
"hex": hex string,
},
"ticker": {
"text": EITHER OF
1) string
2) null,
"hex": hex string,
},
"icon_uri": EITHER OF
1) {
"text": EITHER OF
1) string
2) null,
"hex": hex string,
}
2) null,
"additional_metadata_uri": EITHER OF
1) {
"text": EITHER OF
1) string
2) null,
"hex": hex string,
}
2) null,
"media_uri": EITHER OF
1) {
"text": EITHER OF
1) string
2) null,
"hex": hex string,
}
2) null,
"media_hash": hex string,
} },
"destination": bech32 string,
},
}
10) {
"type": "DataDeposit",
"content": { "data": hex string },
}
11) {
"type": "Htlc",
"content": {
"value": EITHER OF
1) {
"type": "Coin",
"content": { "amount": {
"atoms": number string,
"decimal": decimal string,
} },
}
2) {
"type": "Token",
"content": {
"id": bech32 string,
"amount": {
"atoms": number string,
"decimal": decimal string,
},
},
},
"htlc": {
"secret_hash": hex string,
"spend_key": bech32 string,
"refund_timelock": EITHER OF
1) {
"type": "UntilHeight",
"content": number,
}
2) {
"type": "UntilTime",
"content": { "timestamp": number },
}
3) {
"type": "ForBlockCount",
"content": number,
}
4) {
"type": "ForSeconds",
"content": number,
},
"refund_key": bech32 string,
},
},
}
12) {
"type": "CreateOrder",
"content": {
"authority": bech32 string,
"ask_value": EITHER OF
1) {
"type": "Coin",
"content": { "amount": {
"atoms": number string,
"decimal": decimal string,
} },
}
2) {
"type": "Token",
"content": {
"id": bech32 string,
"amount": {
"atoms": number string,
"decimal": decimal string,
},
},
},
"give_value": EITHER OF
1) {
"type": "Coin",
"content": { "amount": {
"atoms": number string,
"decimal": decimal string,
} },
}
2) {
"type": "Token",
"content": {
"id": bech32 string,
"amount": {
"atoms": number string,
"decimal": decimal string,
},
},
},
},
},
}, .. ]
Get the total balance in the selected account in this wallet. See available options to include more categories, like locked coins.
Parameters:
{
"account": number,
"utxo_states": [ EITHER OF
1) "Confirmed"
2) "Conflicted"
3) "Inactive"
4) "Abandoned"
5) "InMempool", .. ],
"with_locked": EITHER OF
1) "Any"
2) "Unlocked"
3) "Locked"
4) null,
}
Returns:
{
"coins": {
"atoms": number string,
"decimal": decimal string,
},
"tokens": { bech32 string: {
"atoms": number string,
"decimal": decimal string,
}, .. },
}
Lists all the utxos owned by this account
Parameters:
{ "account": number }
Returns:
[ {
"outpoint": {
"source_id": EITHER OF
1) {
"type": "Transaction",
"content": { "tx_id": hex string },
}
2) {
"type": "BlockReward",
"content": { "block_id": hex string },
},
"index": number,
},
"output": EITHER OF
1) {
"type": "Transfer",
"content": {
"value": EITHER OF
1) {
"type": "Coin",
"content": { "amount": {
"atoms": number string,
"decimal": decimal string,
} },
}
2) {
"type": "Token",
"content": {
"id": bech32 string,
"amount": {
"atoms": number string,
"decimal": decimal string,
},
},
},
"destination": bech32 string,
},
}
2) {
"type": "LockThenTransfer",
"content": {
"value": EITHER OF
1) {
"type": "Coin",
"content": { "amount": {
"atoms": number string,
"decimal": decimal string,
} },
}
2) {
"type": "Token",
"content": {
"id": bech32 string,
"amount": {
"atoms": number string,
"decimal": decimal string,
},
},
},
"destination": bech32 string,
"timelock": EITHER OF
1) {
"type": "UntilHeight",
"content": number,
}
2) {
"type": "UntilTime",
"content": { "timestamp": number },
}
3) {
"type": "ForBlockCount",
"content": number,
}
4) {
"type": "ForSeconds",
"content": number,
},
},
}
3) {
"type": "Burn",
"content": { "value": EITHER OF
1) {
"type": "Coin",
"content": { "amount": {
"atoms": number string,
"decimal": decimal string,
} },
}
2) {
"type": "Token",
"content": {
"id": bech32 string,
"amount": {
"atoms": number string,
"decimal": decimal string,
},
},
} },
}
4) {
"type": "CreateStakePool",
"content": {
"pool_id": bech32 string,
"data": {
"pledge": {
"atoms": number string,
"decimal": decimal string,
},
"staker": bech32 string,
"vrf_public_key": bech32 string,
"decommission_key": bech32 string,
"margin_ratio_per_thousand": string,
"cost_per_block": {
"atoms": number string,
"decimal": decimal string,
},
},
},
}
5) {
"type": "ProduceBlockFromStake",
"content": {
"destination": bech32 string,
"pool_id": bech32 string,
},
}
6) {
"type": "CreateDelegationId",
"content": {
"destination": bech32 string,
"pool_id": bech32 string,
},
}
7) {
"type": "DelegateStaking",
"content": {
"amount": {
"atoms": number string,
"decimal": decimal string,
},
"delegation_id": bech32 string,
},
}
8) {
"type": "IssueFungibleToken",
"content": { "data": {
"token_ticker": {
"text": EITHER OF
1) string
2) null,
"hex": hex string,
},
"number_of_decimals": number,
"metadata_uri": {
"text": EITHER OF
1) string
2) null,
"hex": hex string,
},
"total_supply": EITHER OF
1) {
"type": "Fixed",
"content": { "amount": {
"atoms": number string,
"decimal": decimal string,
} },
}
2) { "type": "Lockable" }
3) { "type": "Unlimited" },
"authority": bech32 string,
"is_freezable": bool,
} },
}
9) {
"type": "IssueNft",
"content": {
"token_id": bech32 string,
"data": { "metadata": {
"creator": EITHER OF
1) bech32 string
2) null,
"name": {
"text": EITHER OF
1) string
2) null,
"hex": hex string,
},
"description": {
"text": EITHER OF
1) string
2) null,
"hex": hex string,
},
"ticker": {
"text": EITHER OF
1) string
2) null,
"hex": hex string,
},
"icon_uri": EITHER OF
1) {
"text": EITHER OF
1) string
2) null,
"hex": hex string,
}
2) null,
"additional_metadata_uri": EITHER OF
1) {
"text": EITHER OF
1) string
2) null,
"hex": hex string,
}
2) null,
"media_uri": EITHER OF
1) {
"text": EITHER OF
1) string
2) null,
"hex": hex string,
}
2) null,
"media_hash": hex string,
} },
"destination": bech32 string,
},
}
10) {
"type": "DataDeposit",
"content": { "data": hex string },
}
11) {
"type": "Htlc",
"content": {
"value": EITHER OF
1) {
"type": "Coin",
"content": { "amount": {
"atoms": number string,
"decimal": decimal string,
} },
}
2) {
"type": "Token",
"content": {
"id": bech32 string,
"amount": {
"atoms": number string,
"decimal": decimal string,
},
},
},
"htlc": {
"secret_hash": hex string,
"spend_key": bech32 string,
"refund_timelock": EITHER OF
1) {
"type": "UntilHeight",
"content": number,
}
2) {
"type": "UntilTime",
"content": { "timestamp": number },
}
3) {
"type": "ForBlockCount",
"content": number,
}
4) {
"type": "ForSeconds",
"content": number,
},
"refund_key": bech32 string,
},
},
}
12) {
"type": "CreateOrder",
"content": {
"authority": bech32 string,
"ask_value": EITHER OF
1) {
"type": "Coin",
"content": { "amount": {
"atoms": number string,
"decimal": decimal string,
} },
}
2) {
"type": "Token",
"content": {
"id": bech32 string,
"amount": {
"atoms": number string,
"decimal": decimal string,
},
},
},
"give_value": EITHER OF
1) {
"type": "Coin",
"content": { "amount": {
"atoms": number string,
"decimal": decimal string,
} },
}
2) {
"type": "Token",
"content": {
"id": bech32 string,
"amount": {
"atoms": number string,
"decimal": decimal string,
},
},
},
},
},
}, .. ]
Submits a transaction to mempool, and if it is valid, broadcasts it to the network
Parameters:
{
"tx": hex string,
"do_not_store": bool,
"options": { "trust_policy": EITHER OF
1) "Trusted"
2) "Untrusted" },
}
Returns:
{ "tx_id": hex string }
Send a given coin amount to a given address. The wallet will automatically calculate the required information Optionally, one can also mention the utxos to be used.
Parameters:
{
"account": number,
"address": bech32 string,
"amount": EITHER OF
1) { "atoms": number string }
2) { "decimal": decimal string },
"selected_utxos": [ {
"source_id": EITHER OF
1) {
"type": "Transaction",
"content": { "tx_id": hex string },
}
2) {
"type": "BlockReward",
"content": { "block_id": hex string },
},
"index": number,
}, .. ],
"options": { "in_top_x_mb": EITHER OF
1) number
2) null },
}
Returns:
{ "tx_id": hex string }
Sweep all spendable coins or tokens from an address or addresses to a given address. Spendable coins are any coins that are not locked, and tokens that are not frozen or locked. The wallet will automatically calculate the required fees
Parameters:
{
"account": number,
"destination_address": bech32 string,
"from_addresses": [ bech32 string, .. ],
"options": { "in_top_x_mb": EITHER OF
1) number
2) null },
}
Returns:
{ "tx_id": hex string }
Sweep all the coins from a delegation to a given address. The wallet will automatically calculate the required fees
Parameters:
{
"account": number,
"destination_address": bech32 string,
"delegation_id": bech32 string,
"options": { "in_top_x_mb": EITHER OF
1) number
2) null },
}
Returns:
{ "tx_id": hex string }
Creates a transaction that spends from a specific address, and returns the change to the same address (unless one is specified), without signature. This transaction is used for "withdrawing" small amounts from a cold storage without changing the ownership address. Once this is created, it can be signed using account-sign-raw-transaction in the cold wallet and then broadcast through any hot wallet. In summary, this creates a transaction with one input and two outputs, with one of the outputs being change returned to the same owner of the input.
Parameters:
{
"account": number,
"address": bech32 string,
"amount": EITHER OF
1) { "atoms": number string }
2) { "decimal": decimal string },
"selected_utxo": {
"source_id": EITHER OF
1) {
"type": "Transaction",
"content": { "tx_id": hex string },
}
2) {
"type": "BlockReward",
"content": { "block_id": hex string },
},
"index": number,
},
"change_address": EITHER OF
1) bech32 string
2) null,
"options": { "in_top_x_mb": EITHER OF
1) number
2) null },
}
Returns:
{
"hex": string,
"fees": {
"coins": {
"atoms": number string,
"decimal": decimal string,
},
"tokens": { bech32 string: {
"atoms": number string,
"decimal": decimal string,
}, .. },
},
}
Print the summary of the transaction
Parameters:
{ "transaction": hex string }
Returns:
{
"tx": hex string,
"fees": EITHER OF
1) {
"coins": {
"atoms": number string,
"decimal": decimal string,
},
"tokens": { bech32 string: {
"atoms": number string,
"decimal": decimal string,
}, .. },
}
2) null,
"stats": {
"num_inputs": number,
"total_signatures": number,
"validated_signatures": EITHER OF
1) {
"num_valid_signatures": number,
"num_invalid_signatures": number,
"signature_statuses": [ EITHER OF
1) { "type": "NotSigned" }
2) { "type": "InvalidSignature" }
3) { "type": "UnknownSignature" }
4) { "type": "FullySigned" }
5) {
"type": "PartialMultisig",
"content": {
"required_signatures": number,
"num_signatures": number,
},
}, .. ],
}
2) null,
},
}
Create a staking pool. The pool will be capable of creating blocks and gaining rewards, and will be capable of taking delegations from other users and staking. The decommission key is the key that can decommission the pool. Cost per block, and margin ratio are parameters that control how delegators receive rewards. The cost per block is an amount in coins to be subtracted from the total rewards in a block first, and handed to the staking pool. After subtracting the cost per block, a fraction equal to margin ratio is taken from what is left, and given to the staking pool. Finally, what is left is distributed among delegators, pro-rata, based on their delegation amounts.
Parameters:
{
"account": number,
"amount": EITHER OF
1) { "atoms": number string }
2) { "decimal": decimal string },
"cost_per_block": EITHER OF
1) { "atoms": number string }
2) { "decimal": decimal string },
"margin_ratio_per_thousand": string,
"decommission_address": bech32 string,
"options": { "in_top_x_mb": EITHER OF
1) number
2) null },
}
Returns:
{ "tx_id": hex string }
Decommission a staking pool, given its id. This assumes that the decommission key is owned by the selected account in this wallet.
Parameters:
{
"account": number,
"pool_id": bech32 string,
"output_address": EITHER OF
1) bech32 string
2) null,
"options": { "in_top_x_mb": EITHER OF
1) number
2) null },
}
Returns:
{ "tx_id": hex string }
Create a request to decommission a pool. This assumes that the decommission key is owned by another wallet. The output of this command should be passed to account-sign-raw-transaction in the wallet that owns the decommission key. The result from signing, assuming success, can then be broadcast to network to commence with decommissioning.
Parameters:
{
"account": number,
"pool_id": bech32 string,
"output_address": EITHER OF
1) bech32 string
2) null,
"options": { "in_top_x_mb": EITHER OF
1) number
2) null },
}
Returns:
hex string
Create a delegation to a given pool id and the owner address/destination. The owner of a delegation is the key authorized to withdraw from the delegation. The delegation creation will result in creating a delegation id, where coins sent to that id will be staked by the pool id provided, automatically. The pool, to which the delegation is made, doesn't have the authority to spend the coins.
Parameters:
{
"account": number,
"address": bech32 string,
"pool_id": bech32 string,
"options": { "in_top_x_mb": EITHER OF
1) number
2) null },
}
Returns:
{
"tx_id": hex string,
"delegation_id": bech32 string,
}
Send coins to a delegation id to be staked
Parameters:
{
"account": number,
"amount": EITHER OF
1) { "atoms": number string }
2) { "decimal": decimal string },
"delegation_id": bech32 string,
"options": { "in_top_x_mb": EITHER OF
1) number
2) null },
}
Returns:
{ "tx_id": hex string }
Send coins from a delegation id (that you own) to stop staking them. Note that stopping the delegation requires a lock period.
Parameters:
{
"account": number,
"address": bech32 string,
"amount": EITHER OF
1) { "atoms": number string }
2) { "decimal": decimal string },
"delegation_id": bech32 string,
"options": { "in_top_x_mb": EITHER OF
1) number
2) null },
}
Returns:
{ "tx_id": hex string }
Start staking, assuming there are staking pools in the selected account in this wallet.
Parameters:
{ "account": number }
Returns:
nothing
Stop staking, assuming there are staking pools staking currently in the selected account in this wallet.
Parameters:
{ "account": number }
Returns:
nothing
Show the staking status for the currently selected account in this wallet.
Parameters:
{ "account": number }
Returns:
EITHER OF
1) "Staking"
2) "NotStaking"
List ids of pools that are controlled by the selected account in this wallet
Parameters:
{ "account": number }
Returns:
[ {
"pool_id": bech32 string,
"pledge": {
"atoms": number string,
"decimal": decimal string,
},
"balance": {
"atoms": number string,
"decimal": decimal string,
},
"height": number,
"block_timestamp": { "timestamp": number },
"vrf_public_key": bech32 string,
"decommission_key": bech32 string,
"staker": bech32 string,
"margin_ratio_per_thousand": string,
"cost_per_block": {
"atoms": number string,
"decimal": decimal string,
},
}, .. ]
List pools that can be decommissioned by the selected account in this wallet
Parameters:
{ "account": number }
Returns:
[ {
"pool_id": bech32 string,
"pledge": {
"atoms": number string,
"decimal": decimal string,
},
"balance": {
"atoms": number string,
"decimal": decimal string,
},
"height": number,
"block_timestamp": { "timestamp": number },
"vrf_public_key": bech32 string,
"decommission_key": bech32 string,
"staker": bech32 string,
"margin_ratio_per_thousand": string,
"cost_per_block": {
"atoms": number string,
"decimal": decimal string,
},
}, .. ]
Print the balance of available staking pools
Parameters:
{ "pool_id": bech32 string }
Returns:
{ "balance": EITHER OF
1) string
2) null }
List delegation ids controlled by the selected account in this wallet with their balances
Parameters:
{ "account": number }
Returns:
[ {
"delegation_id": bech32 string,
"pool_id": bech32 string,
"balance": {
"atoms": number string,
"decimal": decimal string,
},
}, .. ]
List the blocks created by the selected account in this wallet through staking/mining/etc
Parameters:
{ "account": number }
Returns:
[ {
"id": hex string,
"height": number,
"pool_id": string,
}, .. ]
Issue a new non-fungible token (NFT) from scratch
Parameters:
{
"account": number,
"destination_address": bech32 string,
"metadata": {
"media_hash": string,
"name": EITHER OF
1) string
2) { "hex": hex string },
"description": EITHER OF
1) string
2) { "hex": hex string },
"ticker": string,
"creator": EITHER OF
1) hex string
2) null,
"icon_uri": EITHER OF
1) string
2) { "hex": hex string }
3) null,
"media_uri": EITHER OF
1) string
2) { "hex": hex string }
3) null,
"additional_metadata_uri": EITHER OF
1) string
2) { "hex": hex string }
3) null,
},
"options": { "in_top_x_mb": EITHER OF
1) number
2) null },
}
Returns:
{
"token_id": bech32 string,
"tx_id": hex string,
}
Issue a new fungible token from scratch. Notice that issuing a token fills an issuers supply. To have tokens that are spendable, the issuer must "mint" tokens to take from the supply
Parameters:
{
"account": number,
"destination_address": bech32 string,
"metadata": {
"token_ticker": EITHER OF
1) string
2) { "hex": hex string },
"number_of_decimals": number,
"metadata_uri": EITHER OF
1) string
2) { "hex": hex string },
"token_supply": EITHER OF
1) {
"type": "Fixed",
"content": EITHER OF
1) { "atoms": number string }
2) { "decimal": decimal string },
}
2) { "type": "Lockable" }
3) { "type": "Unlimited" },
"is_freezable": bool,
},
"options": { "in_top_x_mb": EITHER OF
1) number
2) null },
}
Returns:
{
"token_id": bech32 string,
"tx_id": hex string,
}
Change the authority of a token; i.e., the cryptographic authority that can do all authority token operations
Parameters:
{
"account": number,
"token_id": bech32 string,
"address": bech32 string,
"options": { "in_top_x_mb": EITHER OF
1) number
2) null },
}
Returns:
{ "tx_id": hex string }
Change the metadata URI of a token
Parameters:
{
"account": number,
"token_id": bech32 string,
"metadata_uri": hex string,
"options": { "in_top_x_mb": EITHER OF
1) number
2) null },
}
Returns:
{ "tx_id": hex string }
Given a token that is already issued, mint new tokens and increase the total supply
Parameters:
{
"account": number,
"token_id": bech32 string,
"address": bech32 string,
"amount": EITHER OF
1) { "atoms": number string }
2) { "decimal": decimal string },
"options": { "in_top_x_mb": EITHER OF
1) number
2) null },
}
Returns:
{ "tx_id": hex string }
Unmint existing tokens and reduce the total supply Unminting reduces the total supply and puts the unminted tokens back at the issuer's control. The wallet must own the tokens that are being unminted.
Parameters:
{
"account": number,
"token_id": bech32 string,
"amount": EITHER OF
1) { "atoms": number string }
2) { "decimal": decimal string },
"options": { "in_top_x_mb": EITHER OF
1) number
2) null },
}
Returns:
{ "tx_id": hex string }
Lock the circulating supply for the token. THIS IS IRREVERSIBLE.
Once locked, tokens lose the ability to be minted/unminted.
Parameters:
{
"account_index": number,
"token_id": bech32 string,
"options": { "in_top_x_mb": EITHER OF
1) number
2) null },
}
Returns:
{ "tx_id": hex string }
Freezing the token (by token authority) forbids any operation with all the tokens (except for the optional unfreeze).
After a token is frozen, no transfers, spends, or any other operation can be done. This wallet (and selected account) must own the authority keys to be able to freeze.
Parameters:
{
"account": number,
"token_id": bech32 string,
"is_unfreezable": bool,
"options": { "in_top_x_mb": EITHER OF
1) number
2) null },
}
Returns:
{ "tx_id": hex string }
By unfreezing the token all operations are available for the tokens again.
Notice that this is only possible if the tokens were made to be unfreezable during freezing. This wallet (and selected account) must own the authority keys to be able to unfreeze.
Parameters:
{
"account": number,
"token_id": bech32 string,
"options": { "in_top_x_mb": EITHER OF
1) number
2) null },
}
Returns:
{ "tx_id": hex string }
Send the given token amount to the given address. The wallet will automatically calculate the required information.
Parameters:
{
"account": number,
"token_id": bech32 string,
"address": bech32 string,
"amount": EITHER OF
1) { "atoms": number string }
2) { "decimal": decimal string },
"options": { "in_top_x_mb": EITHER OF
1) number
2) null },
}
Returns:
{ "tx_id": hex string }
Create a transaction for sending tokens to the given address, without submitting it. The wallet will automatically calculate the required information.
The "intent" is an arbitrary string that will be concatenated with the id of the created transaction and signed by all the keys that were used to sign the transaction itself; this can be used to declare the intent of the transaction. E.g. when bridging Mintlayer tokens to another chain, you need to send tokens to an address provided by the bridge and provide the bridge with the destination address on the foreign chain where you want to receive them. In this case you will set "intent" to this foreign destination address; the signed intent will then serve as a proof to the bridge that the provided destination address is what it's meant to be.
Parameters:
{
"account": number,
"token_id": bech32 string,
"address": bech32 string,
"amount": EITHER OF
1) { "atoms": number string }
2) { "decimal": decimal string },
"intent": string,
"options": { "in_top_x_mb": EITHER OF
1) number
2) null },
}
Returns:
[
hex string,
hex string,
]
Create a transaction for sending tokens from a multisig address to other addresses, returning the change to the original multisig address.
The utxos to pay fees from will be selected automatically; these will be normal, single-sig utxos.
The fee_change_address parameter specifies the destination for the change for the fee payment;
If it's None, the destination will be taken from one of existing single-sig utxos.
Parameters:
{
"account_arg": number,
"from_address": bech32 string,
"fee_change_address": EITHER OF
1) bech32 string
2) null,
"outputs": [ object, .. ],
"options": { "in_top_x_mb": EITHER OF
1) number
2) null },
}
Returns:
{
"transaction": hex string,
"current_signatures": [ EITHER OF
1) { "type": "NotSigned" }
2) { "type": "InvalidSignature" }
3) { "type": "UnknownSignature" }
4) { "type": "FullySigned" }
5) {
"type": "PartialMultisig",
"content": {
"required_signatures": number,
"num_signatures": number,
},
}, .. ],
"fees": {
"coins": {
"atoms": number string,
"decimal": decimal string,
},
"tokens": { bech32 string: {
"atoms": number string,
"decimal": decimal string,
}, .. },
},
}
Store data on the blockchain, the data is provided as hex encoded string. Note that there is a high fee for storing data on the blockchain.
Parameters:
{
"account": number,
"data": hex string,
"options": { "in_top_x_mb": EITHER OF
1) number
2) null },
}
Returns:
{ "tx_id": hex string }
Creates a transaction that locks a given number of coins or tokens in a Hashed Timelock Contract. Created transaction is not broadcasted by this function.
Parameters:
{
"account": number,
"amount": EITHER OF
1) { "atoms": number string }
2) { "decimal": decimal string },
"token_id": EITHER OF
1) bech32 string
2) null,
"htlc": {
"secret_hash": hex string,
"spend_address": bech32 string,
"refund_address": bech32 string,
"refund_timelock": EITHER OF
1) {
"type": "UntilHeight",
"content": number,
}
2) {
"type": "UntilTime",
"content": { "timestamp": number },
}
3) {
"type": "ForBlockCount",
"content": number,
}
4) {
"type": "ForSeconds",
"content": number,
},
},
"options": { "in_top_x_mb": EITHER OF
1) number
2) null },
}
Returns:
hex string
Create an order for exchanging "given" amount of an arbitrary currency (coins or tokens) for an arbitrary amount of "asked" currency. Conclude key is the key that can authorize a conclude order command closing the order and withdrawing all the remaining funds from it.
Parameters:
{
"account": number,
"ask": EITHER OF
1) {
"type": "Coin",
"content": { "amount": EITHER OF
1) { "atoms": number string }
2) { "decimal": decimal string } },
}
2) {
"type": "Token",
"content": {
"id": bech32 string,
"amount": EITHER OF
1) { "atoms": number string }
2) { "decimal": decimal string },
},
},
"give": EITHER OF
1) {
"type": "Coin",
"content": { "amount": EITHER OF
1) { "atoms": number string }
2) { "decimal": decimal string } },
}
2) {
"type": "Token",
"content": {
"id": bech32 string,
"amount": EITHER OF
1) { "atoms": number string }
2) { "decimal": decimal string },
},
},
"conclude_address": bech32 string,
"options": { "in_top_x_mb": EITHER OF
1) number
2) null },
}
Returns:
{
"tx_id": hex string,
"order_id": bech32 string,
}
Conclude an order, given its id. This assumes that the conclude key is owned by the selected account in this wallet. Optionally output address can be provided where remaining funds from the order are transferred.
Parameters:
{
"account": number,
"order_id": bech32 string,
"output_address": EITHER OF
1) bech32 string
2) null,
"options": { "in_top_x_mb": EITHER OF
1) number
2) null },
}
Returns:
{ "tx_id": hex string }
Fill order completely or partially given its id and an amount that satisfy what an order can offer. Optionally output address can be provided where the exchanged funds from the order are transferred.
Parameters:
{
"account": number,
"order_id": bech32 string,
"fill_amount_in_ask_currency": EITHER OF
1) { "atoms": number string }
2) { "decimal": decimal string },
"output_address": EITHER OF
1) bech32 string
2) null,
"options": { "in_top_x_mb": EITHER OF
1) number
2) null },
}
Returns:
{ "tx_id": hex string }
Node version
Parameters:
{}
Returns:
{ "version": string }
Node shutdown
Parameters:
{}
Returns:
nothing
Enable or disable p2p networking in the node
Parameters:
{ "enable": bool }
Returns:
nothing
Connect to a remote peer in the node
Parameters:
{ "address": string }
Returns:
nothing
Disconnected a remote peer in the node
Parameters:
{ "peer_id": number }
Returns:
nothing
List banned addresses/peers in the node
Parameters:
{}
Returns:
[ [
string,
{ "time": [
secs number,
nanos number,
] },
], .. ]
Ban an address in the node for the specified duration
Parameters:
{
"address": string,
"duration": [
secs number,
nanos number,
],
}
Returns:
nothing
Unban address in the node
Parameters:
{ "address": string }
Returns:
nothing
List discouraged addresses/peers in the node
Parameters:
{}
Returns:
[ [
string,
{ "time": [
secs number,
nanos number,
] },
], .. ]
Undiscourage address in the node
Parameters:
{ "address": string }
Returns:
nothing
Get the number of connected peer in the node
Parameters:
{}
Returns:
number
Get connected peers in the node
Parameters:
{}
Returns:
[ {
"peer_id": number,
"address": string,
"peer_role": EITHER OF
1) "Inbound"
2) "OutboundFullRelay"
3) "OutboundBlockRelay"
4) "OutboundReserved"
5) "OutboundManual"
6) "Feeler",
"ban_score": number,
"user_agent": string,
"software_version": string,
"ping_wait": EITHER OF
1) number
2) null,
"ping_last": EITHER OF
1) number
2) null,
"ping_min": EITHER OF
1) number
2) null,
}, .. ]
Get reserved peers in the node
Parameters:
{}
Returns:
[ string, .. ]
Add a reserved peer in the node
Parameters:
{ "address": string }
Returns:
nothing
Remove a reserved peer from the node
Parameters:
{ "address": string }
Returns:
nothing
Submit a block to be included in the chain
Parameters:
{ "block": hex string }
Returns:
nothing
Returns the current node's chainstate (block height information and more)
Parameters:
{}
Returns:
{
"best_block_height": number,
"best_block_id": hex string,
"best_block_timestamp": { "timestamp": number },
"median_time": { "timestamp": number },
"is_initial_block_download": bool,
}
Abandon an unconfirmed transaction in the wallet database, and make the consumed inputs available to be used again Note that this doesn't necessarily mean that the network will agree. This assumes the transaction is either still not confirmed in the network or somehow invalid.
Parameters:
{
"account": number,
"transaction_id": hex string,
}
Returns:
nothing
List the pending transactions that can be abandoned
Parameters:
{ "account": number }
Returns:
[ hex string, .. ]
List mainchain transactions with optional address filter
Parameters:
{
"account": number,
"address": EITHER OF
1) bech32 string
2) null,
"limit": number,
}
Returns:
[ {
"id": hex string,
"height": number,
"timestamp": { "timestamp": number },
}, .. ]
Get a transaction from the wallet, if present
Parameters:
{
"account": number,
"transaction_id": hex string,
}
Returns:
json
Get a transaction from the wallet, if present, as hex encoded raw transaction
Parameters:
{
"account": number,
"transaction_id": hex string,
}
Returns:
hex string
Get a signed transaction from the wallet, if present, as hex encoded raw transaction
Parameters:
{
"account": number,
"transaction_id": hex string,
}
Returns:
hex string
Compose a new transaction from the specified outputs and selected utxos The transaction is returned in a hex encoded form that can be passed to account-sign-raw-transaction and also prints the fees that will be paid by the transaction
Parameters:
{
"inputs": [ {
"source_id": EITHER OF
1) {
"type": "Transaction",
"content": { "tx_id": hex string },
}
2) {
"type": "BlockReward",
"content": { "block_id": hex string },
},
"index": number,
}, .. ],
"outputs": [ object, .. ],
"htlc_secrets": EITHER OF
1) [ EITHER OF
1) hex string
2) null, .. ]
2) null,
"only_transaction": bool,
}
Returns:
{
"hex": string,
"fees": {
"coins": {
"atoms": number string,
"decimal": decimal string,
},
"tokens": { bech32 string: {
"atoms": number string,
"decimal": decimal string,
}, .. },
},
}
Returns the current best block hash
Parameters:
{}
Returns:
hex string
Returns the current best block height
Parameters:
{}
Returns:
number
Get the block ID of the block at a given height
Parameters:
{ "block_height": number }
Returns:
EITHER OF
1) hex string
2) null
Generate a block with the given transactions to the specified reward destination. If transactions are None, the block will be generated with available transactions in the mempool
Parameters:
{
"account": number,
"transactions": [ hex string, .. ],
}
Returns:
nothing
Parameters:
{
"account": number,
"block_count": number,
}
Returns:
nothing
For each block height in the specified range, find timestamps where staking is/was possible for the given pool.
min_height must not be zero; max_height must not exceed the best block height plus one.
If check_all_timestamps_between_blocks is false, seconds_to_check_for_height + 1 is the number
of seconds that will be checked at each height in the range.
If check_all_timestamps_between_blocks is true, seconds_to_check_for_height only applies to the
last height in the range; for all other heights the maximum timestamp is the timestamp
of the next block.
Parameters:
{
"pool_id": bech32 string,
"min_height": number,
"max_height": EITHER OF
1) number
2) null,
"seconds_to_check_for_height": number,
"check_all_timestamps_between_blocks": bool,
}
Returns:
{ number: [ { "timestamp": number }, .. ], .. }
Get a block by its hash, represented with hex encoded bytes
Parameters:
{ "block_id": hex string }
Returns:
EITHER OF
1) hex string
2) null
Returns mainchain block ids with heights in the range start_height..end_height using the given step.
Parameters:
{
"start_height": number,
"end_height": number,
"step": non-zero number,
}
Returns:
[ [
number,
hex string,
], .. ]
RPC methods available in the cold wallet mode.
Parameters:
{}
Returns:
nothing
Print the version of the wallet software and possibly the git commit hash, if found WWW!!
Parameters:
{}
Returns:
string
Create new wallet
Parameters:
{
"path": string,
"store_seed_phrase": bool,
"mnemonic": EITHER OF
1) string
2) null,
"passphrase": EITHER OF
1) string
2) null,
}
Returns:
{ "mnemonic": EITHER OF
1) { "type": "UserProvided" }
2) {
"type": "NewlyGenerated",
"content": {
"mnemonic": string,
"passphrase": EITHER OF
1) string
2) null,
},
} }
Open an exiting wallet by specifying the file location of the wallet file
Parameters:
{
"path": string,
"password": EITHER OF
1) string
2) null,
"force_migrate_wallet_type": EITHER OF
1) bool
2) null,
}
Returns:
nothing
Close the currently open wallet file
Parameters:
{}
Returns:
nothing
Check the current wallet's number of accounts and their names
Parameters:
{}
Returns:
{
"wallet_id": hex string,
"account_names": [ EITHER OF
1) string
2) null, .. ],
}
Encrypts the private keys with a new password, expects the wallet to be unlocked
Parameters:
{ "password": string }
Returns:
nothing
Completely and totally remove any existing encryption, expects the wallet to be unlocked. WARNING: After this, your wallet file will be USABLE BY ANYONE without a password.
Parameters:
{}
Returns:
nothing
Unlocks the private keys for usage.
Parameters:
{ "password": string }
Returns:
nothing
Locks the private keys so they can't be used until they are unlocked again
Parameters:
{}
Returns:
nothing
Show the seed phrase for the loaded wallet if it has been stored.
Parameters:
{}
Returns:
EITHER OF
1) {
"seed_phrase": [ string, .. ],
"passphrase": EITHER OF
1) string
2) null,
}
2) null
Delete the seed phrase from the loaded wallet's database, if it has been stored.
Parameters:
{}
Returns:
EITHER OF
1) {
"seed_phrase": [ string, .. ],
"passphrase": EITHER OF
1) string
2) null,
}
2) null
Set the lookahead size for key generation.
The lookahead size, also known as the gap limit, determines the number of addresses to generate and monitor on the blockchain for incoming transactions, following the last known address with a transaction. Only reduce this value if you are certain there are no incoming transactions on these addresses.
Parameters:
{
"lookahead_size": number,
"i_know_what_i_am_doing": bool,
}
Returns:
nothing
Show receive-addresses with their usage state. Note that whether an address is used isn't based on the wallet, but on the blockchain. So if an address is used in a transaction, it will be marked as used only when the transaction is included in a block.
Parameters:
{ "account": number }
Returns:
[ {
"address": bech32 string,
"index": string,
"used": bool,
}, .. ]
Show standalone added addresses with their labels.
Parameters:
{ "account": number }
Returns:
{
"watch_only_addresses": [ {
"address": bech32 string,
"label": EITHER OF
1) string
2) null,
}, .. ],
"multisig_addresses": [ {
"address": bech32 string,
"label": EITHER OF
1) string
2) null,
}, .. ],
"private_key_addresses": [ {
"public_key": bech32 string,
"public_key_hash": bech32 string,
"label": EITHER OF
1) string
2) null,
}, .. ],
}
Show standalone addresses details.
Parameters:
{
"account": number,
"address": bech32 string,
}
Returns:
{
"address": string,
"label": EITHER OF
1) string
2) null,
"details": EITHER OF
1) { "type": "WatchOnly" }
2) { "type": "FromPrivateKey" }
3) {
"type": "Multisig",
"content": {
"min_required_signatures": number,
"public_keys": [ bech32 string, .. ],
},
},
"balances": {
"coins": {
"atoms": number string,
"decimal": decimal string,
},
"tokens": { bech32 string: {
"atoms": number string,
"decimal": decimal string,
}, .. },
},
}
Generate a new unused address
Parameters:
{ "account": number }
Returns:
{
"address": string,
"index": string,
}
Reveal the public key behind this address in hex encoding and address encoding. Note that this isn't a normal address to be used in transactions. It's preferred to take the address from address-show command
Parameters:
{
"account": number,
"address": bech32 string,
}
Returns:
{
"public_key_hex": hex string,
"public_key_address": bech32 string,
}
Issue a new staking VRF (Verifiable Random Function) key for this account. VRF keys are used as a trustless mechanism to ensure the randomness of the staking process, where no one can control the possible outcomes, to ensure decentralization. NOTE: Under normal circumstances you don't need to generate VRF keys manually. Creating a new staking pool will do it for you. This is available for specialized use-cases.
Parameters:
{ "account": number }
Returns:
{
"vrf_public_key": bech32 string,
"child_number": number,
"used": bool,
}
Shows the legacy VRF key that uses an abandoned derivation mechanism. This will not be used for new pools and should be avoided
Parameters:
{ "account": number }
Returns:
{ "vrf_public_key": string }
Show the issued staking VRF (Verifiable Random Function) keys for this account. These keys are generated when pools are created. VRF keys are used as a trustless mechanism to ensure the randomness of the staking process, where no one can control the possible outcomes, to ensure decentralization.
Parameters:
{ "account": number }
Returns:
[ {
"vrf_public_key": bech32 string,
"child_number": number,
"used": bool,
}, .. ]
Signs the inputs that are not yet signed. The input is a special format of the transaction serialized to hex. This format is automatically used in this wallet in functions such as staking-decommission-pool-request. Once all signatures are complete, the result can be broadcast to the network.
Parameters:
{
"account": number,
"raw_tx": hex string,
"options": { "in_top_x_mb": EITHER OF
1) number
2) null },
}
Returns:
{
"hex": string,
"is_complete": bool,
"previous_signatures": [ EITHER OF
1) { "type": "NotSigned" }
2) { "type": "InvalidSignature" }
3) { "type": "UnknownSignature" }
4) { "type": "FullySigned" }
5) {
"type": "PartialMultisig",
"content": {
"required_signatures": number,
"num_signatures": number,
},
}, .. ],
"current_signatures": [ EITHER OF
1) { "type": "NotSigned" }
2) { "type": "InvalidSignature" }
3) { "type": "UnknownSignature" }
4) { "type": "FullySigned" }
5) {
"type": "PartialMultisig",
"content": {
"required_signatures": number,
"num_signatures": number,
},
}, .. ],
}
Signs a challenge with a private key corresponding to the provided address destination.
Parameters:
{
"account": number,
"challenge": string,
"address": bech32 string,
}
Returns:
hex string
Signs a challenge with a private key corresponding to the provided address destination.
Parameters:
{
"account": number,
"challenge": hex string,
"address": bech32 string,
}
Returns:
hex string
Verifies a signed challenge against an address destination
Parameters:
{
"message": string,
"signed_challenge": hex string,
"address": bech32 string,
}
Returns:
nothing
Verifies a signed challenge against an address destination
Parameters:
{
"message": hex string,
"signed_challenge": hex string,
"address": bech32 string,
}
Returns:
nothing