i
i
iOC Wiki
Search…
⌃K

Console Commands (A-Z)

A

alias

Registers a new encrypted alias and returns the transaction ID. The alias remains valid for 210000 blocks from any given update.
Required parameter:
Example:
alias "my alias"[ "aa5d7b8d74d9e69ef4d029dd12fe635bed91f388e3c026d10b8fc1715f925108"]

B

backupwallet

Safely copies the wallet.dat file to destination. The destination can be a directory or a path with filename.
Required parameter:

C

checkwallet

Returns the 'health status'. For example, if you are missing coins you can check the status with this command.

D

decryptAlias

Decrypts an alias with associated address. You can get the associated address by using the statusList RPC.
Required Parameters:
Example:
decryptAlias "demo" "ipGtai2w5dsSC53C9fZLjxXN9wpdBXgsec"

decryptedMessageList

Lists all received encrypted messages. Encrypted messages are decrypted locally for viewing in plain text.
Example:
decryptedMessageList[ { "sender" : "ipFAdkYm9JD3UsoFCfUnCqHvKdGkDkDHsr", "recipient" : "ifURRvG6asxQJauo9G8gGEfqnbYKzq3UYK", "encrypted_message" : "Klt7ch/FyubdWlGG6Jj1Xg==", "time" : "2018-04-12 05:20:48 UTC", "plain_text" : "Test", "iv128Base64" : "vlYaWjucdK3aOtZGjZsK2g==", "signature" : "H0ZJ43IefH6LeKzrLMiBMrfdQvnXSC013czsbAWF3NrbJIwVNL4+qdBLf5KCGVPBIVcjjqlVsNSFfipy0jD85+0=" }]

downloadDecrypt

Downloads data attached to an alias if the alias has not yet expired.
Required parameters:
Example:
downloadDecrypt myalias C:\Users\username\Desktop\test.txt

downloadDecryptEPID

Downloads data attached to an alias if the alias has expired. Instead of an alias use the public key.
Required parameters:
Example:
downloadDecryptEPID ib388VZfBNnbrJv86PVXeeUwAF8BZdKKGs C:\Users\username\Desktop\test.txt

dumpprivkey

Reveals the private key corresponding to the given address or alias.
Required parameter:

dumpwallet

Dumps all wallet keys in a human-readable format.
Required parameter:
Example:
dumpwallet C:\Users\username\Desktop\dumpwallet.txt

G

getbalance

Returns total wallet balance.

getbestblockhash

Returns the hash of the last block.

getblock

Returns details of a block with given block-hash.
Required parameter:
Example:
getblock b6ba34ce95454a917568cfe4b70de15e82f03dbb37b3de8f56ff5c14ed40c17c{ "hash": "b6ba34ce95454a917568cfe4b70de15e82f03dbb37b3de8f56ff5c14ed40c17c", "confirmations": 6, "size": 446, "height": 2643501, "version": 8, "merkleroot": "adc5a98860ecb0fc8c4972a018faf1927860e4cee1569651c4e1feeaf7210f34", "mint": 1.5, "time": 1578829520, "nonce": 0, "bits": "1a1158b9", "difficulty": 967162.80039584, "blocktrust": "ec2098ef04cd1", "chaintrust": "1195c84cb46af88513f", "previousblockhash": "1dd56fb0b1d5b4bf765b350687c9bb2089cf44197b29b58f2b404a6bb387badf", "nextblockhash": "4648d4ad7fa597473aa9cd9f5c4c28a6dfe68fac5e0333042c2d1e521a55e56f", "flags": "proof-of-stake", "proofhash": "00001c730a10a6c2f51e5de03eb9427a63ee0dbffee6b47ea3a547461c783e0c", "entropybit": 0, "modifier": "db2a9ab12bcdd765", "modifierchecksum": "1bb3c654", "tx": [ "db4c299dc4e3aacefffa5bd07abb539e1d694481a4ade507dd23e12b184d2c2d", "9dc2ead91b0071cb84cbd2f1c9e815d0975998d410957f58cda6df56df639e8d" ], "signature": "30450221008525924c71aacd4bf94f66e38bc8d4a0248163b6393a7c773dff5fd634bae15902205abd41db33eb721c574d6bd0af96d45a82f96c1c8a2ee72f5b07abc21be52956"}

getblockcount

Returns the latest synced block.

getconnectioncount

Returns the number of connections to the network.

getdifficulty

Returns the network difficulty.
Example:
getdifficulty{ "proof-of-work": 4385.27795334, "proof-of-stake": 535379.1863659, "search-interval": 16}

getinfo

Returns information about the node and the network.
Example:
getinfo{ "version": "v5.0.0.0-g5729cf1", "protocolversion": 60022, "walletversion": 80000, "balance": 10.00000000, ...}

getnewaddress

Generates a new address.
Example:
getnewaddressifmHfbbH7MgAwvrWdpKzwhWMTyCNNUqUjE

getpeerinfo

Returns information about all peers your node is connected to.
Example:
getpeerinfo[ { "addr": "81.169.204.110:33764", "services": "00000001", "lastsend": 1578836938, "lastrecv": 1578836940, "conntime": 1578834767, "version": 60022, "subver": "/Satoshi:15.0.0/", "inbound": false, "startingheight": 2643577, "banscore": 0 }, ...]

gettransaction

Returns detailed information about a transaction.
Required parameter:

getreceivedbyaddress

Returns the amount of IOC by the specified address.
Required parameter:
Example:
getreceivedbyaddress iVYhLnwCbG1eHNFFpvZv8pwutKYkrk3AwW18.818

gra

Short version of getreceivedbyaddress.

H

help

Prints a list of available commands.

I

importprivkey

Adds a private key (as returned by dumpprivkey) to your wallet.

importwallet

Imports keys from a wallet dump file (see dumpwallet).
Required parameter:
Example:
importwallet C:\Users\username\Desktop\dumpwallet.txt

L

listunspent

Lists all unspent balances.
Example:
listunspent[ { "txid": "015eee770c21df3a1b4711060d986b7bbd0586a1e2fe6636500463a76b19dbe3", "vout": 1, "address": "idTJNU3LcjYzGVnZHMbyXnUuNVFMyA3sj1", "scriptPubKey": "76a91474b8f4f6258fc0290ae1ad61b98b9b2da1b4882688ac", "amount": 2, "confirmations": 259 }, ...]

M

myRSAKeys

Returns a list of available wallet addresses and aliases attached to them.
Example:
myRSAKeys[ { "address": "iVkULcH2Fm6t6dKU9zuuiV4DxefJ25noW3", "alias": "DION1" }, { "address": "iU7Gf9stZo61Zhj8WgDA1PNtHftgMNLfTs", "alias": "DION2" }, ...]

R

registerAliasGenerate

Registers an alias, see alias.

repairwallet

If checkwallet returns an error status you can try repairing the wallet with this command.

reservebalance

Shows whether a certain amount of IOC is reserved (not used for staking so that it is always available).
Example:
reservebalance{ "reserve": true, "amount": 5}

S

sendMessage

Sends a message from an address or alias to another address or alias over an encrypted tunnel.
Required parameters:
Example:
sendMessage ipFAdkYm9JD3UsoFCfUnCqHvKdGkDkDHsr "Hello World" ifURRvG6asxQJauo9G8gGEfqnbYKzq3UYK

sendPublicKey

Sends an invite for an encrypted tunnel from one public alias to another.
Required parameters:
Example:
sendPublicKey ipFAdkYm9JD3UsoFCfUnCqHvKdGkDkDHsr ifURRvG6asxQJauo9G8gGEfqnbYKzq3UYK

shade

Generates a shade (stealth) address.
Example:
shade[ "mi6Sv2ow1ywQgRF7P2ueH6U5Ykii1rCG8c", "mtqcQSz5vpqEa4fuQaH1gJxGy6K6RdRpYX", "iH9fMZjDrVp8MY7S5cZcTTV5btT8zPnGYqnQx7BRjvm9aySYXdJTfYtECMrr5eNgFvDT1JvTTY1SX1uigbBv2cjenG m"]
Output parameters:

shadesend

Sends IOC to a shade (stealth) address.
Required parameters:
Example:
shadesend iH9fMZjDrVp8MY7S5cZcTTV5btT8zPnGYqnQx7BRjvm9aySYXdJTfYtECMrr5eNgFvDT1JvTTY1SX1uigbBv2cjenGm 10[ { "abs" : "mi6Sv2ow1ywQgRF7P2ueH6U5Ykii1rCG8c", "ord" : "mtqcQSz5vpqEa4fuQaH1gJxGy6K6RdRpYX", "target" : "mm9PnZRGWVRWAdiTxZTtWRbx42MCyUsgxW", "trace" : "n1Xi7itgxnVgbAw7jA6WepMP26dMr5BJjQ", "txid" : "b59acd8eb59cf753414e5e064a39041815fb3779a88f34120d06da148401d717" }{
Output parameters:

statusList

Lists the status of all aliases and their address. You can check the status of a specific alias by adding the alias as optional paramater.
Optional parameter:
Example:
statusList myalias [ { "alias": "myalias", "encrypted": "true", "xtu": 0, "address": "WmHymK9bDSQeAJmoFzafwiMRPbjyfHDfC", "nHeigt": 1733471, "expires_in": 209729, "xtuVector": "transform" }]

stop

Closes daemon and wallet.

T

transferAlias

Transfers an alias to a given address or alias.
Required parameters:

transferEncryptedAlias

Transfers an encrypted alias and returns a transaction ID.
Required parameters:
Example:
transferEncryptedAlias myalias iWTgoUFgAyBCbAfbLB9qXQBn1RsHhHrWir ikQHhA73EnmBsoV7ZBxrZYzPK5WtAM9UXR

U

updateEncrypt

Associates data (e.g. a document) with an encrypted alias.
Required parameters:

V

validateaddress

Returns information about an address.
Required parameter:
Example:
validateaddress idTJNU3LcjYzGVnZHMbyXnUuNVFMyA3sj1{ "isvalid": true, "address": "idTJNU3LcjYzGVnZHMbyXnUuNVFMyA3sj1", "ismine": true, "isscript": false, "pubkey": "03cf08d549b3c196780b75266c871e355b0021fe50db57d15b20c8180e34d9e883", "iscompressed": true}

validatepubkey

Returns information about a public key.
Required parameter:
Example:
validatepubkey 03cf08d549b3c196780b75266c871e355b0021fe50db57d15b20c8180e34d9e883{ "isvalid": true, "address": "idTJNU3LcjYzGVnZHMbyXnUuNVFMyA3sj1", "ismine": true, "iscompressed": true, "isscript": false, "pubkey": "03cf08d549b3c196780b75266c871e355b0021fe50db57d15b20c8180e34d9e883"}

W

walletlock

Locks your wallet if it is unlocked and a password has been set.

walletlockstatus

Returns whether your wallet is encrypted and whether it is locked.
Example:
walletlockstatus{ "isEncrypted": true, "isLocked": false}

walletpassphrase

Unlocks your wallet.
Required parameter:

walletpassphrasechange

Changes the wallet passphrase.
Required parameter:

Y

ydwiWhldw_base_diff

Returns a list of all addresses in your wallet with the label you assigned to it. If no label has been assigned it shows "".
ydwiWhldw_base_diff[ { "": "ioPCtbu4WWCmAUQ4XrEN49pvEkb1vNi3jw" }, { "test1": "iXM4RPBuoba5GG5moRpdBvdz2KnoJuE1tN" }, ...]