What is a RPC call[]
RPC call is a useful tool to be used by HyperStake programmers to code web applications.
A remote procedure call (RPC) is an inter-process communication that allows a computer program, normally coded in php, to cause a subroutine or procedure to be executed in an HYPERSTAKE wallet, configured for that purpose (commonly on another computer on a shared network).
That is, the programmer writes essentially the same code whether the command is typed directly in the console of the wallet.
You can code almost all the API calls listed in the help command of HYPERSTAKE wallet. See next paragraph.
List of RPC calls for HYP[]
This is meant to be the reference but it may not be exhaustive.
To point someone directly to the right section, use the following URL (replace "section" by the right title):
http://hyperstake.wikia.com/wiki/RPC#section
To get help on a particular commande, follow the command name with "help", like this:
walletlock help
addmultisigaddress[]
Syntax: addmultisigaddress <nrequired> <'["key","key"]'> [account]
Example: example in monospace
Description: lipsum in regular font.
addnode[]
Syntax: addnode <node> <add|remove|onetry>
Example: example in monospace
Description: lipsum in regular font.
backupwallet[]
Syntax: backupwallet <destination>
Example: example in monospace
Description: lipsum in regular font.
cccustomchange[]
Syntax: cccustomchange <address>
Example: example in monospace
Description: lipsum in regular font.
cclistcoins[]
Syntax: cccustomchange <address>
Example: example in monospace
Description: lipsum in regular font.
cclistselected[]
Syntax: cccustomchange <address>
Example: example in monospace
Description: lipsum in regular font.
ccreset[]
Syntax: cccustomchange <address>
Example: example in monospace
Description: lipsum in regular font.
ccreturnchange[]
Syntax: ccreturnchange <true|false>
Example: example in monospace
Description: lipsum in regular font.
ccselect[]
Syntax: ccselect <Output Hash> <Output
Example:
Description: lipsum in regular font.
ccsend[]
Syntax: ccsend <HyperStakeaddress> <amount>
Example: example in monospace
Description: lipsum in regular font.
checkwallet[]
Syntax:
Example: example in monospace
Description: lipsum in regular font.
createrawtransaction[]
Syntax: createrawtransaction [{"txid":txid,"vout":n},...] {address:amount,...}
Example: example in monospace
Description: lipsum in regular font.
decoderawtransaction[]
Syntax: decoderawtransaction <hex string>
Example: example in monospace
Description: lipsum in regular font.
delete[]
Syntax: delete <address>
Example: example in monospace
Description: lipsum in regular font.
disablestake[]
This will disable staking if set true
Useful to prevent staking when diff is too high
Syntax: disablestake <true/false>
Example: disablestake true diff >5 options: diff, weight
dumpprivkey[]
Syntax: dumpprivkey <HyperStakeaddress>
Example: example in monospace
Description: lipsum in regular font.
export difficulty[]
Syntax: export difficulty <interval> <directory>
Example: example in monospace
Description: lipsum in regular font.
getaccount[]
Syntax: getaccount <HyperStakeaddress>
Example: example in monospace
Description: lipsum in regular font.
getaccountaddress[]
Syntax: getaccountaddress <account>
Example: example in monospace
Description: lipsum in regular font.
getaddednodeinfo[]
Syntax: getaddednodeinfo <dns> [node]
Example: example in monospace
Description: lipsum in regular font.
getaddressesbyaccount[]
Syntax: getaddressesbyaccount <account>
Example: getaddressesbyaccount "HYPloan"
Description: Returns the list of addresses for the given account. Surrounding the account by quote is only mandatory if there is a space in the account. If the same account has several addresses, they will all get listed.
getbalance[]
Syntax: getbalance [account] [minconf=1]
Example: example in monospace
Description: lipsum in regular font.
getblock[]
Syntax: getblock <hash> [txinfo]
Example: example in monospace
Description: lipsum in regular font.
getblock[]
Syntax: getblock <number> [txinfo]
Example: example in monospace
Description: lipsum in regular font.
getblockcount[]
Syntax:
Example: example in monospace
Description: lipsum in regular font.
getblockhash[]
Syntax: getblockhash <index>
Example: example in monospace
Description: lipsum in regular font.
getblocktemplate[]
Syntax: getblocktemplate [params]
Example: example in monospace
Description: lipsum in regular font.
getcheckpoint[]
Syntax:
Example: example in monospace
Description: lipsum in regular font.
getconnectioncount[]
Returns the number of connections to other nodes.
This command has no argument. It gives the same result as looking at one of the popup in the lower right corner.
getdifficulty[]
Returns the difficulty as a multiple of the minimum difficulty.
This command has no argument. You can get the same information on the GUI by looking at a popup on the lower right. Still, getdifficulty will also tell you the proof-of-stake difficulty (even when the proof-of-stake period is over)
getgenerate[]
Returns true or false.
This command has no argument. Its purpose is uncertain.
getinfo[]
Returns an object containing various state info.
This command gives you a lot of useful info, especially when debugging. It has no parameter.
getmininginfo[]
Returns an object containing mining-related information.
This command has no argument. The GUI can give the same information by looking at one of the popup in the lower right corner.
getmoneysupply[]
Syntax: getmoneysupply [height]
Example: example in monospace
Description: lipsum in regular font.
getnewaddress[]
Syntax: getnewaddress [account]
Example: example in monospace
Description: lipsum in regular font.
getnewpubkey[]
Syntax: getnewpubkey [account]
Description: lipsum in regular font.
getpeerinfo[]
Syntax:
Example: example in monospace
Description: lipsum in regular font.
getrawmempool[]
Syntax:
Example: example in monospace
Description: lipsum in regular font.
getrawtransaction[]
Syntax: getrawtransaction <txid> [verbose=0]
Example: example in monospace
Description: lipsum in regular font.
getreceivedbyaccount[]
Syntax: getreceivedbyaccount <account> [minconf=1]
Example: example in monospace
Description: lipsum in regular font.
getreceivedbyaddress[]
Syntax: getreceivedbyaddress <HyperStakeaddress> [minconf=1]
Example: example in monospace
Description: lipsum in regular font.
getstakesplitthreshold[]
Syntax:
Example: example in monospace
Description: lipsum in regular font.
getstaketx[]
Syntax: getstaketx <txid>
Example: example in monospace
Description: lipsum in regular font.
gettransaction[]
Syntax: gettransaction <txid>
Example: example in monospace
Description: lipsum in regular font.
getwork[]
Syntax: getwork [data]
Example: example in monospace
Description: lipsum in regular font.
getworkex[]
Syntax: getworkex [data, coinbase]
Example: example in monospace
Description: lipsum in regular font.
help[]
Syntax: help [command]
Example: example in monospace
Description: lipsum in regular font.
importprivkey[]
Syntax: importprivkey <HyperStakeprivkey> [label]
Example: example in monospace
Description: lipsum in regular font.
keypoolrefill[]
Syntax:
Example: example in monospace
Description: lipsum in regular font.
listaccounts[]
Syntax: listaccounts [minconf=1]
Example: example in monospace
Description: lipsum in regular font.
listaddressgroupings[]
Syntax:
Example: example in monospace
Description: lipsum in regular font.
listreceivedbyaccount[]
Syntax: listreceivedbyaccount [minconf=1] [includeempty=false]
Example: example in monospace
Description: lipsum in regular font.
listreceivedbyaddress[]
Syntax: listreceivedbyaddress [minconf=1] [includeempty=false]
Example: example in monospace
Description: lipsum in regular font.
listsinceblock[]
Syntax: listsinceblock [blockhash] [target-confirmations]
Example: example in monospace
Description: lipsum in regular font.
listtransactions[]
Syntax: listtransactions [account] [count=10] [from=0]
Example: example in monospace
Description: lipsum in regular font.
listunspent[]
Syntax: listunspent [minconf=1] [maxconf=9999999] ["address",...]
Description: lipsum in regular font.
makekeypair[]
Syntax: makekeypair [prefix]
Description: lipsum in regular font.
moneysupply[]
Syntax:
Example: example in monospace
Description: lipsum in regular font.
move[]
Syntax: move <fromaccount> <toaccount> <amount> [minconf=1] [comment]
Description: lipsum in regular font.
repairwallet[]
Syntax:
Example: example in monospace
Description: lipsum in regular font.
rescanfromblock[]
Syntax: rescanfromblock <block height>
Example: example in monospace
Description: lipsum in regular font.
resendtx[]
Syntax:
Example: example in monospace
Description: lipsum in regular font.
reservebalance[]
Syntax: reservebalance [<reserve> [amount]]
Description: lipsum in regular font.
sendalert[]
Syntax: sendalert <message> <privatekey> <minver> <maxver> <priority> <id> [cancelupto]
Description: lipsum in regular font.
sendfrom[]
Syntax: sendfrom <fromaccount> <toHyperStakeaddress> <amount> [minconf=1] [comment] [comment-to]
Description: lipsum in regular font.
sendmany[]
Syntax: sendmany <fromaccount> {address:amount,...} [minconf=1] [comment]
Description: lipsum in regular font.
sendrawtransaction[]
Syntax: sendrawtransaction <hex string>
Description: lipsum in regular font.
sendtoaddress[]
Syntax: sendtoaddress <HyperStakeaddress> <amount> [comment] [comment-to]
Description: lipsum in regular font.
setaccount[]
Syntax: setaccount <HyperStakeaddress> <account>
Description: lipsum in regular font.
setstakesplitthreshold[]
Syntax: setstakesplitthreshold <1 - 999,999>
Description: A stake output will split (in two parts), when the resulting amount for each of the outputs equals or exceeds the threshold value specified. For example: by setting a threshold of 5,000, stake outputs greater than 10,000 will be split into two.
settxfee[]
Syntax: settxfee <amount>
Description: lipsum in regular font.
signmessage[]
Syntax: signmessage <HyperStakeaddress> <message>
Description: lipsum in regular font.
signrawtransaction[]
Syntax: signrawtransaction <hex string> [{"txid":txid,"vout":n,"scriptPubKey":hex},...] [<privatekey1>,...] [sighashtype="ALL"]
Description: lipsum in regular font.
stakeforcharity[]
Syntax: stakeforcharity <HyperStake Address> <percent> [Change Address] [min amount] [max amount]
Description: lipsum in regular font.
strictprotocol[]
Syntax:
Description: temporary documentation
strictincoming[]
Syntax:
Description: temporary documentation
stop[]
Syntax:stop <detach>
Description: lipsum in regular font.
submitblock[]
Syntax: submitblock <hex data> [optional-params-obj]
Description: lipsum in regular font.
validateaddress[]
Syntax: validateaddress <HyperStakeaddress>
Description: lipsum in regular font.
validatepubkey[]
Syntax: validatepubkey <HyperStakepubkey>
Description: lipsum in regular font.
verifymessage[]
Syntax: verifymessage <HyperStakeaddress> <signature> <message>
Description: lipsum in regular font.
walletlock[]
Removes the wallet encryption key from memory, locking the wallet. After calling this method, you will need to call walletpassphrase again before being able to call any methods which require the wallet to be unlocked.
This command has no parameter. Once you used it, you unlock the wallet with walletpassphrase — see below for details
walletpassphrase[]
Stores the wallet decryption key in memory for <timeout> seconds. mintonly is optional true/false allowing only block minting.
walletpassphrase <passphrase> <timeout> [mintonly]
So walletpassphrase <passphrase> 3600 true means "unlock for pos for one hour". Note that the GUI allows for a permanent unlock for pos, but the RPC requires a timeout; that being said, a very long timeout like 999999999 is akin to permanent. You cannot move from true to false directly (from "unlock for pos" to "unlock"), you must use walletlock in the middle. So to set to unlock for pos then to unlock, you must use these three commands
walletpassphrase <passphrase> 3600 true walletpasslock walletpassphrase <passphrase> 3600 false
walletpassphrasechange[]
Syntax: walletpassphrasechange <oldpassphrase> <newpassphrase>
Description: lipsum in regular font.