This is an old revision of the document!


The Iridium RPC Wallet embed an HTTP server which provides a JSON 2.0 RPC interface for Iridium payment operations and address management.
You will find here the description of all the methods included in Iridium RPC Wallet API (iridium_walletd).

To make a JSON RPC query to your running Iridium RPC Wallet use POST requests to http://iridium_walled IP:iridium_walled port/json_rp

  • iridium_walled IP is an IP of Iridium RPC Wallet, if RPC Wallet is located on local machine it is either 127.0.0.1 or localhost
  • iridium_walled port is Iridium RPC Wallet port, by default it is binded to 14007 port.

For starting and configuring the iridium_walletd, look at the command line and configuration file options.

Method Description
resetRe-synchronize your wallet
saveSave changes into your wallet file
getViewKeyReturn the view-only address key.
getSpendKeysReturn address spend keys.
getStatusReturn informations about the current Iridium RPC Wallet state: block_count, known_block_count, last_block_hash and peer_count.
getAddressesReturn an array of the Iridium RPC wallet's addresses.
createAddressCreate an address.
deleteAddressDelete a specified address.
getBalanceReturn a balance for a specified address. If address is not specified, returns a cumulative balance of all wallet's addresses.
getBlockHashesReturn an array of block hashes for a specified block range.
getTransactionHashesReturn an array of block and transaction hashes
getTransactionReturn information about the transactions in specified block range or for specified addresses.
getUnconfirmedTransactionHashesReturn information about the current unconfirmed transaction pool or for a specified addresses.
getTransactionReturn information about the specified transaction.
sendTransactionCreates and send a transaction.
createDelayedTransactionCreates but not send a transaction.
getDelayedTransactionHashesReturn hashes of delayed transactions.
deleteDelayedTransactionDelete a specified delayed transaction.
sendDelayedTransactionSend a specified delayed transaction.
sendFusionTransactionCreate and send a fusion transaction.
estimateFusionEstimate a number of outputs that can be optimized with fusion transactions

The reset method allows you to re-sync your wallet.

Input.

ArgumentMandatoryDescriptionFormatExample
viewSecretKey No Private view key string ir2qzAzr1KfCk2sTsLdEq8BRSRyHnahcKJrPRZg8rHtkRCNBHJiiyNz8vWjwoM6F4PSbPQuNusEgGXc2A4NoDrQr2dH4rbmGs

No output in case of success.

Important: If the view_secret_key is not specified, the reset methods resets the wallet and re-syncs it. If the view_secret_key argument is specified, the reset method substitutes the existing wallet with a new one with the specified view_secret_key and creates an address for it.

Input :

{'params':{
   'viewSecretKey':'ir2qzAzr1KfCk2sTsLdEq8BRSRyHnahcKJrPRZg8rHtkRCNBHJiiyNz8vWjwoM6F4PSbPQuNusEgGXc2A4NoDrQr2dH4rbmGs'
   },
 'jsonrpc':'2.0',
 'id':'test',
 'method':'reset'
}

Return :

{  
  'jsonrpc':'2.0',
  'id':'test',
  'result':{  
  }
}

Save your wallet.

No parameters.

No return in case of success.

Input :

{  
  'params':{  
  },
  'jsonrpc':'2.0',
  'id':'test',
  'method':'save'
}

Return :

{  
  'jsonrpc':'2.0',
  'id':'test',
  'result':{  
  }
}

getViewKey

getSpendKeys

getStatus

getAddresses

createAddress

deleteAddress

getBalance

getBlockHashes

getTransactionHashes

getTransaction

getUnconfirmedTransactionHashes

getTransaction

sendTransaction

createDelayedTransaction

getDelayedTransactionHashes

deleteDelayedTransaction

sendDelayedTransaction

sendFusionTransaction

estimateFusion