Wallet Common Structures

wallet_common_structuresstructureswallet_common_structures

AccountAddressInfo

The AccountAddressInfo object includes the following items for active addresses in the activation response for a coin in HD mode:

Parameter	Type	Required	Description
address	string	✓	The account address for a specific derivation path under the `account_index`.
derivation_path	string	✓	The BIP44 derivation path of the address.
chain	string	✓	`External` or `Internal`, as defined in the activation request.
balance	object	✓	A standard BalanceInfo object.

Show Example

{
    "address": "RXNtAyDSsY3DS3VxTpJegzoHU9bUX54j56",
    "derivation_path": "m/44'/141'/0'/0/0",
    "chain": "External",
    "balance": {
        "spendable": "7.64018255",
        "unspendable": "0"
    }
}

AddressFormat

Parameter	Type	Required	Description
format	string (enum)	✓	address format to which the input address should be converted. Possible values: `mixedcase` for ETH/ERC20 coins; `cashaddress` or `standard` for UTXO coins; `contract` or `wallet` for QTUM/QRC20
network	string (enum)	–	Optional. Network prefix for `cashaddress` format. Possible values: `bitcoincash` for BCH mainnet; `bchtest` for BCH testnet; `bchreg` for BCH regtest

Show Examples

Example

{
  "format": "mixedcase"
}

{
  "format": "cashaddress",
  "network": "bitcoincash"
}

AddressInfo

The AddressInfo object includes the following items for a given address:

Parameter	Type	Required	Description
balances	object	–	A standard balanceInfos object. Not included in responses where `get_balances` is `false`
derivation_method	object	✓	A standard DerivationMethod object
pubkey	string	✓	The public key associated with the seed used to launch Komodo DeFi Framework
tickers	array	–	A list of tokens which were successfully activated. Only included in responses where `get_balances` is `false`

Show Examples

Example with balances

"bitcoincash:qrf5vpn78s7rjexrjhlwyzzeg7gw98k7t5qx64fztj": {
    "derivation_method": {
        "type": "Iguana"
    },
    "pubkey": "036879df230663db4cd083c8eeb0f293f46abc460ad3c299b0089b72e6d472202c",
    "balances": {
        "spendable": "0.11398301",
        "unspendable": "0.00001"
    }
}

Example without balances

"bitcoincash:qrf5vpn78s7rjexrjhlwyzzeg7gw98k7t5qx64fztj": {
    "derivation_method": {
        "type": "Iguana"
    },
    "pubkey": "036879df230663db4cd083c8eeb0f293f46abc460ad3c299b0089b72e6d472202c",
    "tickers": ["ASLP-SLP"]
}

AddressPath

The AddressPath object includes the following items:

Parameter	Type	Required	Description
account_id	integer	✓	The index of the account in the wallet, starting from `0`.
chain	integer	–	The `chain` is either `External` or `Internal`, and expressed as an integer with `External` being 0 and `Internal` being 1.
address_id	integer	–	The index of the address in the account, starting from `0`.
derivation_path	string	–	The derivation path of the address, following the format `m/44'/COIN_ID'/ACCOUNT_ID'/CHAIN/ADDRESS_ID` (or `m/84'/COIN_ID'/ACCOUNT_ID'/CHAIN/ADDRESS_ID` for segwit coins).

Show Account/Chain/Address Example

{
    "account_id": 1,
    "chain": "External",
    "address_id": 3
}

Show Derivation Path Example

{
  "derivation_path": "m/44'/141'/1'/0/3"
}

BalanceInfo

The BalanceInfo object includes the following items for a given coin or token:

Parameter	Type	Required	Description
spendable	string (numeric)	✓	The available amount of a coin or token which is ready to be traded or withdrawn.
unspendable	string (numeric)	✓	The amount of a coin or token which is awaiting confirmation on the block chain for an incoming or outgoing transaction.

Show Example

{
    "spendable": "12.11398301",
    "unspendable": "0.53"
}

DerivationMethod

The DerivationMethod object includes the following items for a given coin or token:

Parameter	Type	Required	Description
type	string	✓	Defines how keypairs will be generated. Possible values: `Iguana` or `HDWallet`

Where the value indicates:

Iguana: The coin or token is was activated using Iguana derivation (default).
HDWallet: The coin or token is was activated using a Hierarchical Deterministic (HD) Wallet derivation path.

Show Example

{
    "type": "Iguana"
}

ExtendedFeeInfo

Parameter	Type	Required	Description
coin	string	✓	the fee is paid from the user's balance of this coin. This coin name may differ from the `base` or `rel` coins. For example, ERC20 fees are paid by ETH (gas)
amount	string (numeric)	✓	fee amount (in decimal representation)
amount_rat	rational	✓	fee amount (in rational representation)
amount_fraction	fraction	✓	fee amount (in fraction representation)
paid_from_trading_vol	bool	✓	whether the fee is paid from trading volume and not use actual `coin` balance

FeeInfo

The FeeInfo response object includes the following items for withdraw (v2) requests:

Parameter	Type	Required	Description
type	string	✓	Type of transaction fee. Possible values: `UtxoFixed`, `UtxoPerKbyte`, `UtxoPriority`, `EthGas`, `Qrc20Gas`, `CosmosGas`
amount	string (numeric)	–	Fee amount in coin units, used only when type is `UtxoFixed` (fixed amount not depending on tx size) or `UtxoPerKbyte` (amount per Kbyte)
priority	string	–	Used only when type is `UtxoPriority`. Possible values: 'Low', 'Normal', 'High'.
gas_price	string (numeric)	–	Used only when fee type is `Qrc20Gas` or `EthGas`; sets the gas price in `gwei` units.
gas_price	number (double)	–	Used only when fee type is `CosmosGas`; sets the gas price.
gas	number (integer)	–	Used only when fee type is `EthGas`; sets the gas limit for transaction
gas_limit	number (integer)	–	Used only when fee type is `Qrc20Gas` or `CosmosGas`; sets the gas limit for transaction

HistoryTarget

Used to specify a HD wallet account_id or address_id for my_tx_history v2 requests.

Parameter	Type	Required	Description
type	string	✓	Filters results by `account_id` or `address_id` part of the derivation path.
account_id	integer	✓	`ACCOUNT_ID` child in the `m/44'/COIN'/ACCOUNT_ID'/CHAIN/ADDRESS_ID` BIP44 derivation path.
address_id	integer	–	Optional. `ADDRESS_ID` child in the `m/44'/COIN'/ACCOUNT_ID'/CHAIN/ADDRESS_ID` BIP44 derivation path.
chain	string	–	Optional. `Internal`, or `External`. External is used for addresses that are meant to be visible outside of the wallet (e.g. for receiving payments). Internal is used for addresses which are not meant to be visible outside of the wallet and is used for return transaction change.

InputTxns

The InputTxns object includes the following items:

Parameter	Type	Required	Description
tx_hash	string	✓	The transaction id of an unspent transaction from the same wallet output.
index	integer	✓	The output index of this unspent transaction output.
script_pub_key	string	✓	The scriptpubkey of this unspent transaction output.
amount	float	✓	The value of this unspent transaction output.

NewAddressInfo

The NewAddressInfo response object includes the following items for request in HD mode:

Parameter	Type	Required	Description
address	string	✓	The account address for a specific derivation path under the `account_index`.
derivation_path	string	✓	The BIP44 derivation path of the address. If there are no more addresses with balances within the gap limit, the address index will increment.
balance	object	✓	A standard BalanceInfo object.
chain	string	✓	`Internal`, or `External`. External is used for addresses that are meant to be visible outside of the wallet (e.g. for receiving payments). Internal is used for addresses which are not meant to be visible outside of the wallet and is used for return transaction change.

PayForGas

The PayForGas object includes the following items:

Parameter	Type	Required	Description
tx_type	string	✓	ETH/EVM coins and tokens only. Options are `Legacy` or `Eip1559`. The type of transaction values being configured.
gas_price	decimal	–	Optional. Only used if tx_type is `Legacy`. Values are in Gwei. The maximium price per gas unit the user is willing to pay for the transaction.
max_fee_per_gas	decimal	–	Optional. Only used if tx_type is `Eip1559`. Values are in Gwei. The maximum amount to pay per unit of gas to get your transaction included in a block.
max_priority_fee_per_gas	decimal	–	Optional. Only used if tx_type is `Eip1559`. Values are in Gwei. This is paid directly to the miner, and can be set by the user to attract minimal delay in transaction confirmation.
min_wait_time	integer	–	Optional. Only used if tx_type is `Eip1559`. Estimated minimum transaction wait time in mempool (in ms) for this priority level.
max_wait_time	integer	–	Optional. Only used if tx_type is `Eip1559`. Estimated maximum transaction wait time in mempool (in ms) for this priority level.

Note

Eip1559 allows users to save on gas fees. To use this feature for a coin/token, its entry in your coins file must include fields for chain_id and max_eth_tx_type. To allow eip-1559 transactions, max_eth_tx_type should be set to 2. To find the chain_id for an [EVM network(https://blog.thirdweb.com/evm-compatible-blockchains-and-ethereum-virtual-machine/)], refer to chainlist.org. There is also a new gas_fee_estimator parameter in the coins file, which can be set to Provider or Simple.

By default, Simple gas fee estimation suggests a fee based on fee history. If set gas_fee_estimator is set to Provider, users must set the gas_api setting in their MM2.json file to source recommended fee values from third party providers Infura or Blocknative.

To set or view the current swap transaction fee policy, use the get_swap_transaction_fee_policy and set_swap_transaction_fee_policy methods.

For more information about EIP1559, refer to https://www.blocknative.com/blog/eip-1559-fees

Show Legacy Example

{
    "tx_type": "Legacy",
    "gas_price": "1234.567"
}

Show EIP1559 Example

{
    "tx_type": "Eip1559",
    "max_fee_per_gas": "1234.567",
    "max_priority_fee_per_gas": "1.2"
}

StakingDetails

The StakingDetails object includes the following items:

Parameter	Type	Required	Description
type	string	✓	The coin type. Currently, only 'Cosmos' and `Qtum` are supported.
validator_address	string	✓	The address of the validator to delegate staking to.
amount	string	✓	The amount of coins to stake send to the validator for delegated staking (Cosmos only - QTUM will stake your whole balance).

Show Cosmos Example

{
    "type": "Cosmos",
    "validator_address": "iva1qq93sapmdcx36uz64vvw5gzuevtxsc7lcfxsat",
    "amount": "7.77"
}

Show Qtum Example

{
    "type": "Qtum",
    "validator_address": "qbgHcqxXYHVJZXHheGpHwLJsB5epDUtWxe"
}

StakingInfoDetails

The StakingInfoDetails object includes the following items:

Parameter	Type	Required	Description
type	string	✓	The coin type. Currently, only 'Cosmos' is supported.
filter_by_status	string	✓	Return only validators matching a specific status. Options are `Bonded`, `Unbonded`, and `All`. Defaults to `Bonded`.
limit	integer	–	Optional, defaults to `10`. The number of validators displayed per page in response.
page_number	integer	–	Optional, defaults to `1`. The page offset for items in response.

Show Example

{
    "type": "Cosmos",
    "filter_by_status": "Bonded",
    "limit": 20,
    "page_number": 1
}

ClaimingDetails

The ClaimingDetails object includes the following items:

Parameter	Type	Required	Description
type	string	✓	The coin type. Currently, only 'Cosmos' and `Qtum` are supported.
validator_address	string	✓	The address of the validator to delegate staking to.
force	boolean	–	Defaults to `false`. If `true`, will process unprofitable transactions (reward value less than network fees)

Show Example

{
    "type": "Cosmos",
    "validator_address": "iva1qq93sapmdcx36uz64vvw5gzuevtxsc7lcfxsat",
    "amount": "7.77"
}

PrivKeyPolicy

The PrivKeyPolicy object includes the following items:

Parameter	Type	Required	Description
type	string	✓	Options are `ContextPrivKey`, `WalletConnect`, `Metamask`, or `Trezor`. Defaults to `ContextPrivKey`.
data	list	–	`WalletConnect` type only. The `session_topic` hex string, returned from the response to wc_new_connection.

Show Trezor Example

  {
    "type": "Trezor"
  }

Show WalletConnect Example

{
  "type": "WalletConnect", "data": "3569914dd09a5cc4ac92dedab354f06ff5db17ef616233a8ba562cbea51269fd"
}

RawTxInfo

The RawTxInfo object includes the following items:

Parameter	Type	Required	Description
tx_hex	string	–	UTXO only. The raw unsigned hex of a proposed transaction.
prev_txns	list	–	UTXO only. A list of standard InputTxns objects.
to	string	–	ETH/EVM only. A destination address to send the funds to.
value	string	–	ETH/EVM only. The amount of funds to be sent as a string with a `0x` prefix, in wei units.
gas_limit	string	–	ETH/EVM only. The maximum gas to be used for sending the transaction, in gwei units.
pay_for_gas	object	–	ETH/EVM only. Used for EIP-1559 fee policy config. A standard PayForGas object.

Show UTXO Example

{
    "tx_hex": "02000000010d23d763f12d77a337cc16df2696ac3f48552dda373c9977fa1f5dd8d5025cb20100000000fdffffff01f40100000000000016001488accd2145b7232b958db5cdf09336ad619541e200000000",
    "prev_txns": [
        ...
    ]
}

Show ETH/EVM Example

  {
      "to": "0x927DaFDDa16F1742BeFcBEAE6798090354B294A9",
      "value": "0.85",
      "gas_limit": "21000",
      "pay_for_gas": {
          "tx_type": "Eip1559",
          "max_fee_per_gas": "1234.567",
          "max_priority_fee_per_gas": "1.2"
      }
  }

ScanAddressesInfo

The ScanAddressesInfo response object includes the following items for request in HD mode:

Parameter	Type	Required	Description
account_index	integer	✓	`ACCOUNT_ID` child in the `m/44'/COIN'/ACCOUNT_ID'/CHAIN/ADDRESS_ID` BIP44 derivation path. Please don't confuse with the global account.
derivation_path	string	✓	The BIP44 derivation path of the account.
new_addresses	list	✓	A list of standard NewAddressInfo objects.

TotalFeeInfo

Parameter	Type	Required	Description
coin	string	✓	the fee is paid from the user's balance of this coin. This coin name may differ from the `base` or `rel` coins. For example, ERC20 fees are paid by ETH (gas)
amount	string (numeric)	✓	fee amount (in decimal representation)
amount_rat	rational	✓	fee amount (in rational representation)
amount_fraction	fraction	✓	fee amount (in fraction representation)
required_balance	string (numeric)	✓	the required `coin` balance to pay the fee
required_balance_rat	rational	✓	`required_balance` in rational representation
required_balance_fraction	fraction	✓	`required_balance` in fraction representation

WithdrawFee

The WithdrawFee object varies depending on the coin or token type. Refer to the examples to view the object structure for each type.

Parameter	Type	Required	Description
type	string	✓	The fee type. Either `Utxo`, `Tendermint`, `Qrc20` or `Eth`.
amount	numeric string	–	`Utxo` or `Tendermint` type only. The fee amount.
coin	string	✓	The coin which will be used to pay the transaction fee.
gas	integer	–	`Eth` type only. The amount of gas to be used for the transaction.
gas_price	numeric string	–	`Eth` or `Qrc20` type only. Price per unit of gas to be used for the transaction.
gas_limit	numeric string	–	`Tendermint` or `Qrc20` type only. Maximum gas to be used for the transaction.
miner_fee	numeric string	–	`Tendermint` type only. Fee to mine the transaction.
total_fee	numeric string	–	`Eth` type only. Gas price multiplied by gas amount.
total_gas_fee	numeric string	–	`Qrc20` type only. Gas price multiplied by gas amount.

Show Examples

Example of Eth type

{
  "type": "Eth",
  "coin": "BNB",
  "gas": 109739,
  "gas_price": "0.000000003",
  "total_fee": "0.000329217"
}

Example of Qrc20 type

{
  "type": "Qrc20",
  "coin": "tQTUM",
  "miner_fee": "0.00000447",
  "gas_limit": 100000,
  "gas_price": 40,
  "total_gas_fee": "0.04"
}

Example of Tendermint type

{
  "type": "Tendermint",
  "coin": "IRIS",
  "amount": "0.038553",
  "gas_limit": 100000
}

Example of Utxo type

{
  "type": "Utxo",
  "amount": "0.00001"
}

WalletAccountInfo

The WalletAccountInfo object includes the following items in the activation response for a coin in HD mode:

Parameter	Type	Required	Description
account_index	integer	✓	`ACCOUNT_ID` child in the `m/44'/COIN'/ACCOUNT_ID'/CHAIN/ADDRESS_ID` BIP44 derivation path. Please don't confuse with the global account.
derivation_path	string	✓	Derivation path up to the `COIN` child. E.g. `"m/44'/141'/0'"`
total_balance	object	✓	A standard BalanceInfo object.
addresses	list	✓	A list of standard AccountAddressInfo objects.

{
    "account_index": 0,
    "derivation_path": "m/44'/141'/0'",
    "total_balance": {
        "spendable": "23.08710255",
        "unspendable": "0"
    },
    "addresses": [
        ...
    ]
}

WalletBalanceInfo

The WalletBalanceInfo object includes the following items in the activation response for a coin in HD mode:

Parameter	Type	Required	Description
wallet_type	string	✓	In HD wallet mode, this will return `HD`.
accounts	object	✓	A standard WalletAccountInfo object.

{
    "wallet_balance": {
        "wallet_type": "HD",
        "accounts": [
            ...
        ]
    }
}

WithdrawFromInfo

The WithdrawFromInfo response object includes the following items for HD Wallet withdraw (v2) requests. You can use either the derivation_path on its own, or the account_id, chain and address_id together.

Parameter	Type	Required	Description
derivation_path	string	–	Optional. The BIP44 derivation path of the address.
account_id	integer	–	Optional. `ACCOUNT_ID` child in the `m/44'/COIN'/ACCOUNT_ID'/CHAIN/ADDRESS_ID` BIP44 derivation path. Please don't confuse with the global account.
address_id	integer	–	Optional. `ADDRESS_ID` child in the `m/44'/COIN'/ACCOUNT_ID'/CHAIN/ADDRESS_ID` BIP44 derivation path.
chain	string	–	Optional. `Internal`, or `External`. External is used for addresses that are meant to be visible outside of the wallet (e.g. for receiving payments). Internal is used for addresses which are not meant to be visible outside of the wallet and is used for return transaction change.

AccountId

Identifier used across GUI-storage methods to reference a stored account.

Parameter	Type	Required	Description
type	string	✓	Defines account kind. Possible values: `iguana`, `hd`, `hw`.
account_idx	integer	–	Only when `type` = `hd`. Index of the HD account (starting at 0).
device_pubkey	string	–	Only when `type` = `hw`. Hex-encoded pubkey of the hardware wallet device.

Show Examples

// Iguana account
{ "type": "iguana" }

// HD account #2
{ "type": "hd", "account_idx": 2 }

// Hardware-wallet account
{ "type": "hw", "device_pubkey": "0xdeadbeefcafebabe..." }

HdCoinKeys

The HdCoinKeys object includes the following items for HD mode private key export responses:

Parameter	Type	Required	Description
coin	string	✓	The ticker symbol of the coin.
addresses	array	✓	Array of HdKeysInfo objects for each address.

Show Example

{
  "coin": "KMD",
  "addresses": [
    {
      "derivation_path": "m/44'/141'/0/0/0",
      "pubkey": "02416813acfc3d051f2a3163241528331cb1407814ca7eda035e29dd81ce1a7360",
      "address": "RLEiXpHJrBBFGLHfBVyKwB8pWyuZvTX46Q",
      "priv_key": "Ur57s4Btk5zv7ts2Rb1vHUjDzcBUuPGXZtuLUKK2yUTSCyNiA82f"
    }
  ]
}

HdKeysInfo

The HdKeysInfo object includes the following items for individual address information in HD mode:

Parameter	Type	Required	Description
derivation_path	string	✓	The BIP44 derivation path of the address.
pubkey	string	✓	The public key for the address.
address	string	✓	The wallet address.
priv_key	string	✓	The private key for the address.
viewing_key	string	–	The viewing key for the address. Only included for ZHTLC coins like ARRR that support enhanced privacy features.

Show Examples

Standard Coin Example (KMD)

{
  "derivation_path": "m/44'/141'/0/0/0",
  "pubkey": "02416813acfc3d051f2a3163241528331cb1407814ca7eda035e29dd81ce1a7360",
  "address": "RLEiXpHJrBBFGLHfBVyKwB8pWyuZvTX46Q",
  "priv_key": "Ur57s4Btk5zv7ts2Rb1vHUjDzcBUuPGXZtuLUKK2yUTSCyNiA82f"
}

ZHTLC Coin Example (ARRR with viewing key)

{
  "derivation_path": "m/44'/141'/0/0/0",
  "pubkey": "02416813acfc3d051f2a3163241528331cb1407814ca7eda035e29dd81ce1a7360",
  "address": "zs1tc85uguljgmhrhreqnsphanu4xura9lcn6zmz7qr3unsq5yr34kvl6938rvz7d2uml5g53ae3ys",
  "priv_key": "secret-extended-key-main1qd0cv2y2qqqqpqye077hevux884lgksjtcqrxnc2qtdrfs05qh3h2wc99s8zc2fpke4auwnrwhpzqfzdudqn2t34t08d8rfvx3df02cgff82x5spg7lq28tvsr9vvwx6sdsymjc7fgk2ued06z9rzkp6lfczlx5ykj3mrqcy4l4wavgqsgzem0nunwzllely77k0ra86nhl936auh2qkuc3j3k75nmdw3cwaaevty6pq5wv57nxfqhwc2q4a97wpg2duxezegpkqe4cg05smz",
  "viewing_key": "zxviews1qd0cv2y2qqqqpqye077hevux884lgksjtcqrxnc2qtdrfs05qh3h2wc99s8zc2fpkepkc20seu8dr44353s5ydt2vmlzr9jmk6dnqx2su6g2tp7jetqalgd45qweck6r54dexp2397m3qj2kwd5d8rq4fdu3lddh7fjc4awv4l4wavgqsgzem0nunwzllely77k0ra86nhl936auh2qkuc3j3k75nmdw3cwaaevty6pq5wv57nxfqhwc2q4a97wpg2duxezegpkqe4czeh3g2"
}

IguanaKeysInfo

The IguanaKeysInfo object includes the following items for private key information in Iguana mode:

Parameter	Type	Required	Description
coin	string	✓	The ticker symbol of the coin.
pubkey	string	✓	The public key for the coin.
address	string	✓	The wallet address for the coin.
priv_key	string	✓	The private key for the coin.

Show Examples

UTXO Coin Example (KMD)

{
  "coin": "KMD",
  "pubkey": "0399e7edd441d026ab62d915c6542464002c1634cacfa3afd69fb9c08b7b76355f",
  "address": "RQbyMz5jSBjidHkM4wRAhmbHUTSR7UehXG",
  "priv_key": "UpaMPnKdPZJWBGb8whpQWjP5A61WpT6e2SUYQz4KyfkE4JzVU9ZF"
}

ETH/EVM Coin Example (ETH)

{
  "coin": "ETH",
  "pubkey": "0x99e7edd441d026ab62d915c6542464002c1634cacfa3afd69fb9c08b7b76355f4e4a134020143df1d5cc243bb558db3eb94060247efd2c0a92878378ec424957",
  "address": "0x2E75c8e10541C1202bFA8E38440b51A78263a914",
  "priv_key": "0x10e0c6d3fcfdfe38f9200d83d5d17383f8bc756bfbcf01d7ec147110eccaf67a"
}

Tendermint Coin Example (ATOM)

{
  "coin": "ATOM",
  "pubkey": "0399e7edd441d026ab62d915c6542464002c1634cacfa3afd69fb9c08b7b76355f",
  "address": "cosmos14qtjek3vhdavfxv5q4mtywe75uvuatvud6fvv4",
  "priv_key": "10e0c6d3fcfdfe38f9200d83d5d17383f8bc756bfbcf01d7ec147110eccaf67a"
}

ZHTLC Coin Example (ARRR)

{
    "coin": "ARRR",
    "pubkey": "0399e7edd441d026ab62d915c6542464002c1634cacfa3afd69fb9c08b7b76355f",
    "address": "zs1dapmqsrrepxxw9qy4x97k5wpztjd2z6tzkgtgnyhyukzks92tttm9cnye02c2yd8qd6ug7uysvf",
    "priv_key": "secret-extended-key-main1qqqqqqqqqqqqqqqqn7vs773606gx6lu3yhnmefhmcq887pxauktferk7530gcjdag0ggkajtt2c0vprldflng26q20veqyeuywlfmzpvjypnup59mmcqzalxgdvh294lucfwa9dx9c4c5ufh8aqdnyuxcznuw87jdkcg6xg88f282k6f4vzkzprfqaxv0fe7spe7c7a0z35y4zrq9y8wllm0c680lp7rc6z555szreu2mh8kgztm2jp3u5e8erp320mftv30v7egzzg9tjxx5"
}

Error types

NotSufficientBalance

The available balance is not sufficient to transfer the specified amount.

Parameter	Type	Required	Description
coin	string	✓	the name of the coin which balance is not sufficient. This coin name may differ from the requested coin. For example, ERC20 fees are paid by ETH (gas)
available	string (numeric)	✓	the balance available for transfer
required	string (numeric)	✓	the amount required to transfer the specified amount. This amount is necessary but may not be sufficient

Response (NotSufficientBalance error)

{
  "mmrpc": "2.0",
  "error": "Not enough DOC to withdraw: available 69.75066225, required at least 1000.00001",
  "error_path": "utxo_common",
  "error_trace": "utxo_common:1379] utxo_common:449]",
  "error_type": "NotSufficientBalance",
  "error_data": {
    "coin": "DOC",
    "available": "69.75066225",
    "required": "1000.00001"
  },
  "id": 0
}

AmountTooLow

The specified amount is too low. Required at least threshold.

Parameter	Type	Required	Description
amount	string (numeric)	✓	the amount the user was willing to transfer
threshold	string (numeric)	✓	the `amount` has not to be less than the `threshold`

InvalidAddress

The specified to address is not valid.

Parameter	Type	Required	Description
(none)	string	✓	the error description

InvalidFeePolicy

The specified fee is not valid.

Parameter	Type	Required	Description
(none)	string	✓	the error description

Response (InvalidFeePolicy error - attempt to use EthGas for UTXO coin)

{
  "mmrpc": "2.0",
  "error": "Invalid fee policy: Expected 'UtxoFixed' or 'UtxoPerKbyte' fee types, found EthGas",
  "error_path": "utxo_common",
  "error_trace": "utxo_common:1371]",
  "error_type": "InvalidFeePolicy",
  "error_data": "Expected 'UtxoFixed' or 'UtxoPerKbyte' fee types, found EthGas",
  "id": 0
}

Response (InvalidFeePolicy error - attempt to use UtxoFixed or UtxoPerKbyte for ETH coin)

{
  "mmrpc": "2.0",
  "error": "Invalid fee policy: Expected 'EthGas' fee type, found UtxoFixed",
  "error_path": "eth",
  "error_trace": "eth:535]",
  "error_type": "InvalidFeePolicy",
  "error_data": "Expected 'EthGas' fee type, found UtxoFixed",
  "id": 0
}

AccruedRewards

Used in kmd_rewards_info

Parameter	Type	Required	Description
amount	string (numeric)	✓	the amount of accrued rewards

NotAccruedReason

Used in kmd_rewards_info

Parameter	Type	Required	Description
reason	string	✓	the reason why rewards were not accrued

Show Examples

Example with accrued rewards:

{
  "accrued_rewards": {
    "Accrued": "0.00450984"
  }
}

Example with reason for no rewards:

{
  "accrued_rewards": {
    "NotAccruedReason": "UtxoAmountLessThanTen"
  }
}

EnabledAccountId

Represents the identifier of an account that can be set as the enabled (active) GUI-storage account.

Parameter	Type	Required	Description
type	string	✓	Account kind. Accepted values are `iguana` and `hd`.
account_idx	integer	–	Optional. Required only when `type` = `hd`. The index of the HD account to enable (starting from `0`).

Show Examples

// Iguana account
{ "type": "iguana" }

// HD account (account #0)
{ "type": "hd", "account_idx": 0 }

NewAccount

Used when creating a brand-new account via the gui_storage::enable_account method (when policy = new) or the gui_storage::add_account method.

Parameter	Type	Required	Default	Description
account_id	EnabledAccountId	✓		Identifier of the new account.
name	string	✓		User-friendly name for the account (maximum 255 characters).
description	string	–		Optional. Optional longer description (maximum 600 characters).
balance_usd	string (numeric)	–	0	Optional, defaults to `0`. Optional initial USD balance shown in GUIs.

Show Example

{
  "account_id": { "type": "hd", "account_idx": 0 },
  "name": "HD-0",
  "description": "Hardware HD account",
  "balance_usd": "0"
}

Wallet Common Structures#