Console Commands (A-Z)
A
alias
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:
B
backupwallet
backupwallet
Safely copies the wallet.dat file to destination. The destination can be a directory or a path with filename.
Required parameter:
C
checkwallet
checkwallet
Returns the 'health status'. For example, if you are missing coins you can check the status with this command.
D
decryptAlias
decryptAlias
Decrypts an alias with associated address. You can get the associated address by using the statusList RPC.
Required Parameters:
Example:
decryptedMessageList
decryptedMessageList
Lists all received encrypted messages. Encrypted messages are decrypted locally for viewing in plain text.
Example:
downloadDecrypt
downloadDecrypt
Downloads data attached to an alias if the alias has not yet expired.
Required parameters:
Example:
downloadDecryptEPID
downloadDecryptEPID
Downloads data attached to an alias if the alias has expired. Instead of an alias use the public key.
Required parameters:
Example:
dumpprivkey
dumpprivkey
Reveals the private key corresponding to the given address or alias.
Required parameter:
dumpwallet
dumpwallet
Dumps all wallet keys in a human-readable format.
Required parameter:
Example:
G
getbalance
getbalance
Returns total wallet balance.
getbestblockhash
getbestblockhash
Returns the hash of the last block.
getblock
getblock
Returns details of a block with given block-hash.
Required parameter:
Example:
getblockcount
getblockcount
Returns the latest synced block.
getconnectioncount
getconnectioncount
Returns the number of connections to the network.
getdifficulty
getdifficulty
Returns the network difficulty.
Example:
getinfo
getinfo
Returns information about the node and the network.
Example:
getnewaddress
getnewaddress
Generates a new address.
Example:
getpeerinfo
getpeerinfo
Returns information about all peers your node is connected to.
Example:
gettransaction
gettransaction
Returns detailed information about a transaction.
Required parameter:
getreceivedbyaddress
getreceivedbyaddress
Returns the amount of IOC by the specified address.
Required parameter:
Example:
gra
gra
Short version of getreceivedbyaddress
.
H
help
help
Prints a list of available commands.
I
importprivkey
importprivkey
Adds a private key (as returned by dumpprivkey
) to your wallet.
importwallet
importwallet
Imports keys from a wallet dump file (see dumpwallet
).
Required parameter:
Example:
L
listunspent
listunspent
Lists all unspent balances.
Example:
M
myRSAKeys
myRSAKeys
Returns a list of available wallet addresses and aliases attached to them.
Example:
R
registerAliasGenerate
registerAliasGenerate
Registers an alias, see alias
.
repairwallet
repairwallet
If checkwallet
returns an error status you can try repairing the wallet with this command.
reservebalance
reservebalance
Shows whether a certain amount of IOC is reserved (not used for staking so that it is always available).
Example:
S
sendMessage
sendMessage
Sends a message from an address or alias to another address or alias over an encrypted tunnel.
Required parameters:
Example:
sendPublicKey
sendPublicKey
Sends an invite for an encrypted tunnel from one public alias to another.
Required parameters:
Example:
shade
shade
Generates a shade (stealth) address.
Example:
Output parameters:
shadesend
shadesend
Sends IOC to a shade (stealth) address.
Required parameters:
Example:
Output parameters:
statusList
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:
stop
stop
Closes daemon and wallet.
T
transferAlias
transferAlias
Transfers an alias to a given address or alias.
Required parameters:
transferEncryptedAlias
transferEncryptedAlias
Transfers an encrypted alias and returns a transaction ID.
Required parameters:
Example:
U
updateEncrypt
updateEncrypt
Associates data (e.g. a document) with an encrypted alias.
Required parameters:
V
validateaddress
validateaddress
Returns information about an address.
Required parameter:
Example:
validatepubkey
validatepubkey
Returns information about a public key.
Required parameter:
Example:
W
walletlock
walletlock
Locks your wallet if it is unlocked and a password has been set.
walletlockstatus
walletlockstatus
Returns whether your wallet is encrypted and whether it is locked.
Example:
walletpassphrase
walletpassphrase
Unlocks your wallet.
Required parameter:
walletpassphrasechange
walletpassphrasechange
Changes the wallet passphrase.
Required parameter:
Y
ydwiWhldw_base_diff
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 "".
Last updated