Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
iridium_walletd_rpc_call [2018/02/26 23:42]
stevebrush
iridium_walletd_rpc_call [2019/01/11 00:47] (current)
Line 5: Line 5:
 You will find here the description of all the methods included in Iridium RPC Wallet API (iridium_walletd).\\   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+To make a JSON RPC query to your running Iridium RPC Wallet use POST requests to %%http://%%''iridium_wallet IP'':''iridium_wallet port''/json_rpc
  
-  *''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_wallet 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.+  *''iridium_wallet port'' is Iridium RPC Wallet port, by default it is binded to 14007 port.
  
 For starting and configuring the iridium_walletd, look at the [[iridium_walletd#Command line and configuration file options|command line and configuration file options]]. For starting and configuring the iridium_walletd, look at the [[iridium_walletd#Command line and configuration file options|command line and configuration file options]].
Line 14: Line 14:
 ==== Iridium RPC Wallet API methods summary ==== ==== Iridium RPC Wallet API methods summary ====
 ^ Method       ^ Description          ^ ^ Method       ^ Description          ^
-|[[iridium_walletd_rpc_call#reset|reset]]|Re-synchronize your wallet| +|[[walletd_reset|reset]]|Re-synchronize your wallet| 
-|[[iridium_walletd_rpc_call#save |save]]|Save changes into your wallet file| +|[[walletd_save |save]]|Save changes into your wallet file| 
-|[[iridium_walletd_rpc_call#getViewKey|getViewKey]]|Return the view-only address key.| +|[[walletd_getViewKey|getViewKey]]|Return the view-only address key.| 
-|[[iridium_walletd_rpc_call#getSpendKeys|getSpendKeys]]|Return address spend keys.| +|[[walletd_getSpendKeys|getSpendKeys]]|Return address spend keys.| 
-|[[iridium_walletd_rpc_call#getStatus|getStatus]]|Return informations about the current Iridium RPC Wallet state: block_count, known_block_count, last_block_hash and peer_count.| +|[[walletd_getStatus|getStatus]]|Return informations about the current Iridium RPC Wallet state: block_count, known_block_count, last_block_hash and peer_count.| 
-|[[iridium_walletd_rpc_call#getAddresses |getAddresses]]|Return an array of the Iridium RPC wallet's addresses.| +|[[walletd_getAddresses |getAddresses]]|Return an array of the Iridium RPC wallet's addresses.| 
-|[[iridium_walletd_rpc_call#createAddress |createAddress]]|Create an address.| +|[[walletd_createAddress |createAddress]]|Create an address.| 
-|[[iridium_walletd_rpc_call#deleteAddress |deleteAddress]]|Delete a specified address.| +|[[walletd_deleteAddress |deleteAddress]]|Delete a specified address.| 
-|[[iridium_walletd_rpc_call#getBalance|getBalance]]|Return a balance for a specified address. If address is not specified, returns a cumulative balance of all wallet's addresses.| +|[[walletd_getBalance|getBalance]]|Return a balance for a specified address. If address is not specified, returns a cumulative balance of all wallet's addresses.| 
-|[[iridium_walletd_rpc_call#getBlockHashes|getBlockHashes]]|Return an array of block hashes for a specified block range.| +|[[walletd_getBlockHashes|getBlockHashes]]|Return an array of block hashes for a specified block range.| 
-|[[iridium_walletd_rpc_call#getTransactionHashes|getTransactionHashes]]|Return an array of block and transaction hashes| +|[[walletd_getTransactionHashes|getTransactionHashes]]|Return an array of block and transaction hashes| 
-|[[iridium_walletd_rpc_call#getTransaction|getTransaction]]|Return information about the transactions in specified block range or for specified addresses.| +|[[walletd_getTransactions|getTransactions]]|Return information about the transactions in specified block range or for specified addresses.| 
-|[[iridium_walletd_rpc_call#getUnconfirmedTransactionHashes|getUnconfirmedTransactionHashes]]|Return information about the current unconfirmed transaction pool or for a specified addresses.| +|[[walletd_getUnconfirmedTransactionHashes|getUnconfirmedTransactionHashes]]|Return information about the current unconfirmed transaction pool or for a specified addresses.| 
-|[[iridium_walletd_rpc_call#getTransaction|getTransaction]]|Return information about the specified transaction.| +|[[walletd_getTransaction|getTransaction]]|Return information about the specified transaction.| 
-|[[iridium_walletd_rpc_call#sendTransaction|sendTransaction]]|Creates and send a transaction.| +|[[walletd_sendTransaction|sendTransaction]]|Creates and send a transaction.| 
-|[[iridium_walletd_rpc_call#createDelayedTransaction|createDelayedTransaction]]|Creates but not send a transaction.| +|[[walletd_createDelayedTransaction|createDelayedTransaction]]|Creates but not send a transaction.| 
-|[[iridium_walletd_rpc_call#getDelayedTransactionHashes|getDelayedTransactionHashes]]|Return hashes of delayed transactions.| +|[[walletd_getDelayedTransactionHashes|getDelayedTransactionHashes]]|Return hashes of delayed transactions.| 
-|[[iridium_walletd_rpc_call#deleteDelayedTransaction|deleteDelayedTransaction]]|Delete a specified delayed transaction.| +|[[walletd_deleteDelayedTransaction|deleteDelayedTransaction]]|Delete a specified delayed transaction.| 
-|[[iridium_walletd_rpc_call#sendDelayedTransaction|sendDelayedTransaction]]|Send a specified delayed transaction.| +|[[walletd_sendDelayedTransaction|sendDelayedTransaction]]|Send a specified delayed transaction.| 
-|[[iridium_walletd_rpc_call#sendFusionTransaction|sendFusionTransaction]]|Create and send a fusion transaction.| +|[[walletd_sendFusionTransaction|sendFusionTransaction]]|Create and send a fusion transaction.| 
-|[[iridium_walletd_rpc_call#estimateFusion|estimateFusion]]|Estimate a number of outputs that can be optimized with fusion transactions| +|[[walletd_estimateFusion|estimateFusion]]|Estimate a number of outputs that can be optimized with fusion transactions| 
-==== Iridium RPC Wallet API methods ==== +[[iridium_walletd_rpc_call#Iridium RPC Wallet API methods summary|back to top]]
- +
- +
----- +
- +
- +
-==== reset ==== +
-The reset method allows you to re-sync your wallet. +
- +
-Input. +
- +
-^Argument^Mandatory^Description^Format^Example^ +
-|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 : +
-<code json> +
-{'params':+
-   'viewSecretKey':'ir2qzAzr1KfCk2sTsLdEq8BRSRyHnahcKJrPRZg8rHtkRCNBHJiiyNz8vWjwoM6F4PSbPQuNusEgGXc2A4NoDrQr2dH4rbmGs' +
-   }, +
- 'jsonrpc':'2.0', +
- 'id':'test', +
- 'method':'reset' +
-+
-</code> +
- +
-Return : +
-<code json> +
-{   +
-  'jsonrpc':'2.0', +
-  'id':'test', +
-  'result':  +
-  } +
-+
-</code> +
- +
- +
----- +
- +
- +
-==== save ==== +
- +
-Save your wallet. +
- +
-No parameters. +
- +
-No return in case of success. +
- +
-Input : +
- +
-<code json> +
-{   +
-  'params':  +
-  }, +
-  'jsonrpc':'2.0', +
-  'id':'test', +
-  'method':'save' +
-+
-</code> +
- +
-Return : +
- +
-<code json> +
-{   +
-  'jsonrpc':'2.0', +
-  'id':'test', +
-  'result':  +
-  } +
-+
-</code> +
- +
-=== getViewKey === +
- +
-=== getSpendKeys === +
- +
-=== getStatus === +
- +
-=== getAddresses === +
-=== createAddress === +
-=== deleteAddress === +
-=== getBalance === +
-=== getBlockHashes === +
-=== getTransactionHashes === +
-=== getTransaction === +
-=== getUnconfirmedTransactionHashes === +
-=== getTransaction === +
-=== sendTransaction === +
-=== createDelayedTransaction === +
-=== getDelayedTransactionHashes === +
-=== deleteDelayedTransaction === +
-=== sendDelayedTransaction === +
-=== sendFusionTransaction === +
-=== estimateFusion ===+