API Calls List - Hemis-Blockchain/Hemis GitHub Wiki
Hemis API call list (as of version 1.2.0)
Listing the Hemis addresses in your wallet is easily done via listreceivedbyaddress. It normally lists only addresses which already have received transactions, however you can list all the addresses by setting the first argument to 0, and the second one to true.
Labels are used to organize addresses.
Required arguments are denoted inside < and > Optional arguments are inside [and].
| Command | Parameters | Description | Requires unlocked wallet? |
|---|---|---|---|
| Blockchain | |||
getbestblockhash
|
Returns the hash of the best (tip) block in the longest block chain. | N | |
getblock
|
<hash> [verbose] | Returns information about the block with the given hash. | N |
getbestsaplinganchor
|
<hash> [verbose] | Returns the most recent SaplingMerkleTree root. | N |
getblockchaininfo
|
Returns an object containing various state info regarding block chain processing. | N | |
getblockcount
|
Returns the number of blocks in the longest block chain. | N | |
getblockhash
|
<index> | Returns hash of block in best-block-chain at index provided. | N |
getblockheader
|
<hash> [verbose] | If verbose is false, returns a string that is serialized, hex-encoded data for block 'hash' header. If verbose is true, returns an Object with information about block <hash> header. | N |
getchaintips
|
Return information about all known tips in the block tree, including the main chain as well as orphaned branches. | N | |
getdifficulty
|
Returns the proof-of-work difficulty as a multiple of the minimum difficulty. | N | |
getfeeinfo
|
<index> | Returns fee info of block provided. | N |
getmempoolinfo
|
Returns details on the active state of the TX memory pool. | N | |
getrawmempool
|
[verbose] | Returns all transaction ids in memory pool as a json array of string transaction ids. | N |
getsupplyinfo
|
[force_update] | return the last cached money supply (sum of spendable transaction outputs) and the height of the chain when it was last updated | N |
gettxout
|
<txid> <n> [includemempool=true] | Returns details about an unspent transaction output. | N |
gettxoutsetinfo
|
Returns statistics about the unspent transaction output set. | N | |
scantxoutset
|
<action> [<scanobjects>] | Scans the unspent transaction output set for entries that match certain output descriptors. | N |
verifychain
|
[numblocks=288] | Verifies blockchain database. | N |
| Budget | |||
checkbudgets
|
Initiates a budget check cycle manually. | N | |
getbudgetinfo
|
[proposal] | Show current gamemaster budgets with optional filter by proposal name. | N |
getbudgetprojection
|
Show the projection of which proposals will be paid the next cycle. | N | |
getbudgetvotes
|
<proposal> | Print vote information for a budget proposal. | N |
getnextsuperblock
|
Print the next super block height | N | |
gmbudgetrawvote
|
<gamemaster-tx-hash> <gamemaster-tx-index> <proposal-hash> <yes|no> <time> <vote-sig> | Compile and relay a proposal vote with provided external signature instead of signing vote internally. | N |
gmbudgetvote
|
<local|many|alias> <votehash> <yes|no> [alias] | Vote on a budget proposal. | N |
gmfinalbudget
|
<command> [passphrase] | Vote or show current budgets. | Y/N |
preparebudget
|
<proposal-name> <url> <payment-count> <block-start> <hemis-address> <monthly-payment> | Prepare proposal for network by signing and creating tx. | Y |
submitbudget
|
<proposal-name> <url> <payment-count> <block-start> <hemis-address> <monthly-payment> <fee-tx> | Submit proposal to the network. | N |
| Control | |||
getinfo
|
Returns an object containing various state info. | N | |
getmemoryinfo
|
Returns an object containing information about memory usage. | N | |
help
|
[command] | List all commands, or get help for a specified command. | N |
spork
|
[name] <value> | Return spork values or their active state | N |
stop
|
Stop Hemis server. | N | |
| Evo | |||
generateblskeypair
|
?????????? | N | |
getminedcommitment
|
<llmq_type> <quorum_hash> | Return information about the commitment for given quorum. | N |
getquoruminfo
|
<llmq_type> <quorum_hash> | ?????????? | N |
getquorummembers
|
<llmq_type> <quorum_hash> | Return the list of proTx hashes for given quorum. | N |
listquorums
|
?????????? | N | |
protx_list
|
[detailed] | ?????????? | ? |
protx_register
|
<collateralHash> <collateralIndex> <ipAndPort> <ownerAddress> <operatorPubKey> <votingAddress> <payoutAddress> [operatorReward] | ?????????? | ? |
protx_register_fund
|
<collateralAddress> <ipAndPort> <ownerAddress> <operatorPubKey> <votingAddress> <payoutAddress> [operatorReward] | Creates, funds and sends a ProTx to the network. The resulting transaction will move collateral amount HMS to the address specified by collateralAddress and will then function as gamemaster collateral. Requires wallet passphrase to be set with walletpassphrase call. | Y |
protx_register_prepare
|
<collateralHash> <collateralIndex> <ipAndPort> <ownerAddress> <operatorPubKey> <votingAddress> <payoutAddress> [operatorReward] | Creates an unsigned ProTx and returns it. The ProTx must be signed externally with the collateral key and then passed to "protx_register_submit". The collateral is specified through "collateralHash" and "collateralIndex" and must be an unspent transaction output. Requires wallet passphrase to be set with walletpassphrase call. | Y |
protx_register_submit
|
<tx> <sig> | Submits the specified ProTx to the network. This command will also sign the inputs of the transaction which were previously added by "protx_register_prepare" to cover transaction fees. Requires wallet passphrase to be set with walletpassphrase call. | Y |
protx_update_revoke
|
<proTxHash> [<operatorKey>] | ?????????? | ? |
protx_update_registrar
|
<ProTxHash> <operatorPubKey> <votingAddress> <payoutAddress> [<ownerKey>] | Creates and sends a ProUpRegTx to the network. This will update the operator key, voting key and payout address of the gamemaster specified by "proTxHash". The owner key of this gamemaster must be known to your wallet.Requires wallet passphrase to be set with walletpassphrase call. | Y |
protx_update_service
|
<proTxHash> <ipAndPort> [<operatorPayoutAddress>] | Creates and sends a ProUpServTx to the network. This will update the IP address of a gamemaster, and/or the operator payout address. If the IP is changed for a gamemaster that got PoSe-banned, the ProUpServTx will also revive this gamemaster. Requires wallet passphrase to be set with walletpassphrase call. | Y |
quorumdkgsimerror
|
<error_type> <rate> | This enables simulation of errors and malicious behaviour in the DKG. | ? |
quorumdkgstatus
|
?????????? | ? | |
| Gamemaster | |||
creategamemasterbroadcast
|
<command> ( <alias> ) | Creates a gamemaster broadcast message for one or all gamemasters configured in gamemaster.conf. Requires wallet passphrase to be set with walletpassphrase call. | N |
creategamemasterkey
|
Create a new gamemaster private key. | N | |
decodegamemasterbroadcast
|
<hexstring> | Command to decode gamemaster broadcast messages | N |
gamemastercurrent
|
????????????????????? | N | |
getgamemastercount
|
Get gamemaster count values. | N | |
getgamemasteroutputs
|
Print all gamemaster transaction outputs. | N | |
getgamemasterscores
|
[blocks=10] | Print list of winning gamemaster by score. | N |
getgamemasterstatus
|
Print gamemaster status. | N | |
getgamemasterwinners
|
[blocks=10] [filter] | Print the gamemaster winners for the last n blocks | N |
initgamemaster
|
<privkey> [<address>] | Initialize gamemaster on demand if it's not already initialized. | N |
listgamemasterconf
|
[filter] | Print gamemaster.conf in JSON format. | N |
listgamemasters
|
[filter] | Get a ranked list of gamemasters. Optional filter by txhash, status, or payment address. | N |
relaygamemasterbroadcast
|
<hexstring> | Command to relay gamemaster broadcast messages | N |
startgamemaster
|
<local|all|many|missing|disabled|alias> <lockwallet> [alias] | Attempts to start one or more gamemaster(s). | Y/N |
| Mining | |||
prioritisetransaction
|
<txid> <priority delta> <fee delta> | Accepts the transaction into mined blocks at a higher (or lower) priority | N |
| Network | |||
addnode
|
<node> <add|remove|onetry> | Attempts add or remove a node from the addnode list. Or try a connection to a node once. | N |
clearbanned
|
version 1.1.1 Clear all banned IPs. | N | |
disconnectnode
|
<node> | version 1.1.1 Immediately disconnects from the specified node. | N |
getaddednodeinfo
|
<dns> [node] | Returns information about the given added node, or all added nodes. Note that onetry addnodes are not listed here. If dns is false, only a list of added nodes will be provided, otherwise connected information will also be available. | N |
getconnectioncount
|
Returns the number of connections to other nodes. | N | |
getnettotals
|
Returns information about network traffic, including bytes in, bytes out, and current time. | N | |
getnetworkinfo
|
Returns an object containing various state info regarding P2P networking. | N | |
getpeerinfo
|
Returns data about each connected network node as a json array of objects. | N | |
listbanned
|
version 1.1.1 List all banned IPs/Subnets. | N | |
ping
|
Requests that a ping be sent to all other nodes, to measure ping time. | N | |
setban
|
<ip(/netmask)> <add|remove> [bantime] [absolute] | version 1.1.1 Attempts add or remove a IP/Subnet from the banned list. | N |
setnetworkactive
|
false> | Disable/enable all p2p network activity. | N |
| Raw Transactions | |||
createrawtransaction
|
[{"txid":txid,"vout":n},...] {address:amount,...} | Creates a raw transaction spending given inputs. | N |
decoderawtransaction
|
<hex string> | Produces a human-readable JSON object for a raw transaction. | N |
decodescript
|
<hex> | Decode a hex-encoded script. | N |
getrawtransaction
|
<txid> [verbose=0] | Returns raw transaction representation for given transaction id. | N |
sendrawtransaction
|
<hexstring> [allowhighfees=false] [swiftx=false] | Submits raw transaction (serialized, hex-encoded) to local node and network. | N |
signrawtransaction
|
<hexstring&rt; [{"txid":txid,"vout":n,"scriptPubKey":hex},...] [<privatekey1>,...] [sighashtype=ALL] | Adds signatures to a raw transaction and returns the resulting raw transaction. | Y/N |
| Utility | |||
createmultisig
|
<nrequired> <'["key",...]'> | Creates a multi-signature address with n signature of m keys required. | N |
estimatefee
|
<nblocks> | Estimates the approximate fee per kilobyte needed for a transaction to begin confirmation within nblocks blocks. | N |
estimatesmartfee
|
<nblocks> | DEPRECATED. WARNING: This interface is unstable and may disappear or change! Estimates the approximate fee per kilobyte needed for a transaction to begin confirmation within nblocks blocks if possible and return the number of blocks for which the estimate is valid. | N |
validateaddress
|
<hemisaddress> | Return information about the given Hemis address. | N |
verifymessage
|
<hemisaddress> <signature> <message> | Verify a signed message. | N |
| Wallet | |||
abandontransaction
|
<txid> | Mark in-wallet transaction "txid" as abandoned. This will mark this transaction and all its in-wallet descendants as abandoned which will allow for their inputs to be respent. It can be used to replace "stuck" or evicted transactions. It only works on transactions which are not included in a block and are not currently in the mempool. It has no effect on transactions which are already abandoned. | Y/N |
abortrescan
|
??????????? | Y/N | |
addmultisigaddress
|
<nrequired> <'["key",...]'> [label] | Add a nrequired-to-sign multisignature address to the wallet. Each key is a Hemis address or hex-encoded public key. If 'label' is specified, assign address to that label. | Y/N |
backupwallet
|
<destination> | Safely copies wallet.dat to destination, which can be a directory or a path with filename. | N |
bip38decrypt
|
<hemisaddress> <passphrase> | Decrypts and then imports password protected private key. | Y |
bip38encrypt
|
<hemisaddress> <passphrase> | Encrypts a private key corresponding to 'hemisaddress'. | Y |
delegatestake
|
<staking_addr> <amount> [<owner_addr>] | delegatestake "staking_addr" amount ( "owner_addr" ext_owner include_delegated from_shield force ) Delegate an amount to a given address for cold staking. The amount is a real and is rounded to the nearest 0.00000001. Requires wallet passphrase to be set with walletpassphrase call. | Y |
delegatoradd
|
<address> [<label>] | Add the provided address <address></address> into the allowed delegators AddressBook. This enables the staking of coins delegated to this wallet, owned by <addr></addr> | N |
delegatorremove
|
<address> | Updates the provided address <address></address> from the allowed delegators keystore to a "delegable" status. This disables the staking of coins delegated to this wallet, owned by <addr></addr> | N |
dumpprivkey
|
<hemisaddress> | Reveals the private key corresponding to 'hemisaddress'. | Y |
dumpwallet
|
<filename> | Dumps all wallet keys in a human-readable format. | Y |
encryptwallet
|
<passphrase> | Encrypts the wallet with <passphrase>. | N |
exportsaplingkey
|
<shield_addr> | Reveals the key corresponding to the 'shield_addr'. Then the importsaplingkey can be used with this output. Requires wallet passphrase to be set with walletpassphrase call | Y |
exportsaplingviewingkey
|
<shield_addr> | Reveals the viewing key corresponding to 'shield_addr'. Then the importsaplingviewingkey can be used with this output. Requires wallet passphrase to be set with walletpassphrase call. | Y |
exportsaplingviewingkey
|
<shield_addr> | Reveals the viewing key corresponding to 'shield_addr'. Then the importsaplingviewingkey can be used with this output. Requires wallet passphrase to be set with walletpassphrase call. | Y |
fundrawtransaction
|
<hexstring> [options] | Add inputs to a transaction until it has enough in value to meet its out value. This will not modify existing inputs, and will add one change output to the outputs. | N |
getaddressesbylabel
|
<label> | Returns the list of addresses assigned the specified label. | N |
getaddressinfo
|
<address> | Return information about the given HMS address. Some of the information will only be present if the address is in the active wallet. | N |
getautocombinethreshold
|
Returns the current auto-combine threshold value. | N | |
getbalance
|
[label] [minconf=1] [includeWatchonly=false] |
If [label] is not specified, returns the server's total available balance. If [label] is specified, returns the balance in the label. |
N |
getcoldstakingbalance
|
Returns the balance currently delegated to you as a delegate. | N | |
getdelegatedbalance
|
Returns the balance currently delegated to a delegate through cold staking. | N | |
getnewaddress
|
[label] | Returns a new Hemis address for receiving payments. If [label] is specified payments received with the address will be credited to [label]. | Y |
getnewshieldaddress
|
[label] | Shield addresses are disbled for Hemis | Y |
getnewstakingaddress
|
[label] | generates a new staking address | N |
getrawchangeaddress
|
Returns a new Hemis address for receiving change. This is for use with raw transactions, NOT normal use. | N | |
getreceivedbyaddress
|
<hemisaddress> [minconf=1] | Returns the amount received by <hemisaddress> in transactions with at least [minconf] confirmations. It correctly handles the case where someone has sent to the address in multiple transactions. Keep in mind that addresses are only ever used for receiving transactions. Works only for addresses in the local wallet, external addresses will always show 0. | N |
getreceivedbylabel
|
<label> [minconf=1] | Returns the total amount received by addresses with [label] in transactions with at least [minconf] confirmations. If [label] not provided return will include all transactions to all labels. | N |
getsaplingnotescount
|
[minconf=1] | ????????????? | N |
getshieldbalance
|
<hemisaddress> [minconf=1] | ????????????????? | N |
getstakesplitthreshold
|
  | Returns the threshold for stake splitting. | N |
getstakingstatus
|
  | Returns an object containing various staking information. | N |
gettransaction
|
<txid> [includeWatchonly] | Get detailed information about in-wallet transaction <txid>. | N |
getunconfirmedbalance
|
Returns the server's total unconfirmed balance. | N | |
getwalletinfo
|
Returns an object containing various wallet state info. | N | |
importaddress
|
<address> [label] [rescan=true] | Adds an address or script (in hex) that can be watched as if it were in your wallet but cannot be used to spend. | Y |
importmulti
|
<requests> [options] | Import addresses/scripts (with private or public keys, redeem script (P2SH)), rescanning all addresses in one-shot-only (rescan can be disabled via options). Requires a new wallet backup. Requires wallet passphrase to be set with walletpassphrase call. | Y |
importprivkey
|
<hemisPrivkey> [label] [rescan=true] [is_staking_address=true] | Adds a private key (as returned by dumpprivkey) to your wallet. | Y |
importpubkey
|
<hemisPubkey> [label] [rescan=true] | Adds a public key to your wallet. | ? |
importwallet
|
<filename> | Imports keys from a wallet dump file (see dumpwallet). | Y |
keypoolrefill
|
<newsize> | Fills the keypool. | Y |
listaddressgroupings
|
Returns all addresses in the wallet and info used for coincontrol. | N | |
listcoldutxos
|
[not_whitelisted] | Lists all UTXOs currently delegated to a delegate through cold staking. | N |
listdelegators
|
[blacklist] | ???????????? | N |
listlabels
|
[<purpose>] | Returns the list of all labels, or labels that are assigned to addresses with a specific purpose. | N |
listlockunspent
|
Returns list of temporarily unspendable outputs. | N | |
listreceivedbyaddress
|
[minconf=1] [includeempty=false] [includeWatchonly=false] | List balances by receiving address. | N |
listreceivedbylabel
|
[minconf=1] [includeempty=false] [includeWatchonly=false] | List balances by label. | N |
listreceivedbyshieldaddress
|
<address> [minconf=1] | Shield addresses are disabled for Hemis | N |
listshieldaddress
|
[include_watchonly] | Shield addresses are disabled for Hemis | N |
listshieldunspent
|
[minconf=1] [maxconf=1] [include_watchonly] [<shieldaddress>,...] | Shield addresses are disabled for Hemis | N |
listsinceblock
|
[blockhash] [target-confirmations] [includeWatchonly=false] | Get all transactions in blocks since block [blockhash], or all transactions if omitted. | N |
liststakingaddresses
|
????????????? | ? | |
listtransactions
|
[label] [count=10] [from=0] [includeWatchonly=false] | Returns up to [count] most recent transactions skipping the first [from] transactions for label [label]. If [label] not provided it'll return recent transactions from all labels. | N |
listunspent
|
[minconf=1] [maxconf=9999999] ['["addresses",...]'] | Returns array of unspent transaction outputs with between minconf and maxconf (inclusive) confirmations. Optionally filter to only include txouts paid to specified addresses. | N |
listwallets
|
Returns a list of currently loaded wallets. | N | |
lockunspent
|
<unlock> <'[{"txid":"txid","vout":n},...]'> | Updates list of temporarily unspendable outputs. | Y |
rawdelegatestake
|
<stakingaddr> <amount> [<owner_addr>] [ext_owner] [include_delegated] [from_shield] | ????? | ? |
rawshieldsendmany
|
<fromaddress> [<address>:...,....] [minconf] | Creates a transaction sending to many recipients (without committing it), and returns the hex string. Amounts are decimal numbers with at most 8 digits of precision. Change generated from a transparent addr flows to a new transparent addr address, while change generated from a shield addr returns to itself. When sending coinbase UTXOs to a shield addr, change is not allowed. The entire value of the UTXO(s) must be consumed. Requires wallet passphrase to be set with walletpassphrase call. | N |
rescanblockchain
|
<start_height> <stop_height> | rescans blockchain files from block start_height to block stop_height | Y |
sendmany
|
{address:amount,...} [minconf=1] [comment] | Send multiple times. Amounts are double-precision floating point numbers | Y |
sendtoaddress
|
<hemisaddress> <amount> [comment] [comment-to] | Send an amount to a given address. <amount> is a real and is rounded to 8 decimal places. Returns the transaction ID <txid> if successful. | Y |
setautocombinetreshold
|
<enable> [<amount>] | This will set the auto-combine threshold value. Wallet will automatically monitor for any coins with value below the threshold amount, and combine them if they reside with the same Hemis address. When auto-combine runs it will create a transaction, and therefore will be subject to transaction fees. | Y |
sethdseed
|
[newkeypool] | Set or generate a new HD wallet seed. Non-HD wallets will not be upgraded to being a HD wallet. Wallets that are already HD will have a new HD seed set so that new keys added to the keypool will be derived from this new seed. Note that you will need to MAKE A NEW BACKUP of your wallet after setting the HD wallet seed. Requires wallet passphrase to be set with walletpassphrase call if wallet is encrypted. | Y |
setlabel
|
<hemisaddress> <label> | Sets the label associated with the given address. Assigning an address that is already assigned to the same label will create a new address associated with that label. | N |
setstakesplitthreshold
|
<value> | This will set the output size of your stakes to never be below the given value. | Y |
settxfee
|
<amount> | Set the transaction fee per kB. | N |
shieldsendmany
|
{address:amount,...} [minconf=1] [fee] [subtract_fee_from] | ????? | Y |
signmessage
|
<hemisaddress> <message> | Sign a message with the private key of an address. | Y |
upgradewallet
|
????????????????? | ? | |
viewshieldtransaction
|
<txid> | Shield addresses are disabled for Hemis | ? |
walletlock
|
Removes the wallet encryption key from memory, locking the wallet. | Y | |
walletpassphrase
|
<passphrase> <timeout> [anonymizeonly=false] | Stores the wallet decryption key in memory for 'timeout' seconds. | N |
walletpassphrasechange
|
<oldpassphrase> <newpassphrase> | Changes the wallet passphrase from 'oldpassphrase' to 'newpassphrase'. | N |
See rpcprotocol.h for the list of error codes and their meanings.