FANDOM



What is a RPC call Edit

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 Edit

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 Edit

Syntax: addmultisigaddress <nrequired> <'["key","key"]'> [account]

Example: example in monospace

Description: lipsum in regular font.

addnode Edit

Syntax: addnode <node> <add|remove|onetry><var>

Example: example in monospace

Description: lipsum in regular font.

backupwallet Edit

Syntax: backupwallet <destination>

Example: example in monospace

Description: lipsum in regular font.

cccustomchange Edit

Syntax: cccustomchange <address>

Example: example in monospace

Description: lipsum in regular font.

cclistcoins Edit

Syntax: cccustomchange <address>

Example: example in monospace

Description: lipsum in regular font.

cclistselected Edit

Syntax: cccustomchange <address>

Example: example in monospace

Description: lipsum in regular font.

ccreset Edit

Syntax: cccustomchange <address>

Example: example in monospace

Description: lipsum in regular font.

ccreturnchange Edit

Syntax: ccreturnchange <true|false>

Example: example in monospace

Description: lipsum in regular font.

ccselect Edit

Syntax: ccselect <Output Hash> <Output

Example:

Description: lipsum in regular font.

ccsend Edit

Syntax: ccsend <HyperStakeaddress> <amount>

Example: example in monospace

Description: lipsum in regular font.

checkwallet Edit

Syntax:

Example: example in monospace

Description: lipsum in regular font.

createrawtransaction Edit

Syntax: createrawtransaction [{"txid":txid,"vout":n},...] {address:amount,...}

Example: example in monospace

Description: lipsum in regular font.

decoderawtransaction Edit

Syntax: decoderawtransaction <hex string>

Example: example in monospace

Description: lipsum in regular font.

delete Edit

Syntax: delete <address>

Example: example in monospace

Description: lipsum in regular font.

disablestake Edit

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 Edit

Syntax: dumpprivkey <HyperStakeaddress>

Example: example in monospace

Description: lipsum in regular font.

export difficulty Edit

Syntax: export difficulty <interval> <directory>

Example: example in monospace

Description: lipsum in regular font.

getaccount Edit

Syntax: getaccount <HyperStakeaddress>

Example: example in monospace

Description: lipsum in regular font.

getaccountaddress Edit

Syntax: getaccountaddress <account>

Example: example in monospace

Description: lipsum in regular font.

getaddednodeinfo Edit

Syntax: getaddednodeinfo <dns> [node]

Example: example in monospace

Description: lipsum in regular font.

getaddressesbyaccount Edit

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 Edit

Syntax: getbalance [account] [minconf=1]

Example: example in monospace

Description: lipsum in regular font.

getblock Edit

Syntax: getblock <hash> [txinfo]

Example: example in monospace

Description: lipsum in regular font.

getblock Edit

Syntax: getblock <number> [txinfo]

Example: example in monospace

Description: lipsum in regular font.

getblockcount Edit

Syntax:

Example: example in monospace

Description: lipsum in regular font.

getblockhash Edit

Syntax: getblockhash <index>

Example: example in monospace

Description: lipsum in regular font.

getblocktemplate Edit

Syntax: getblocktemplate [params]

Example: example in monospace

Description: lipsum in regular font.

getcheckpoint Edit

Syntax:

Example: example in monospace

Description: lipsum in regular font.

getconnectioncount Edit

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 Edit

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 Edit

Returns true or false.

This command has no argument. Its purpose is uncertain.

getinfo Edit

Returns an object containing various state info.

This command gives you a lot of useful info, especially when debugging. It has no parameter.

getmininginfo Edit

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 Edit

Syntax: getmoneysupply [height]

Example: example in monospace

Description: lipsum in regular font.

getnewaddress Edit

Syntax: getnewaddress [account]

Example: example in monospace

Description: lipsum in regular font.

getnewpubkey Edit

Syntax: getnewpubkey [account]

Description: lipsum in regular font.

getpeerinfo Edit

Syntax:

Example: example in monospace

Description: lipsum in regular font.

getrawmempool Edit

Syntax:

Example: example in monospace

Description: lipsum in regular font.

getrawtransaction Edit

Syntax: getrawtransaction <txid> [verbose=0]

Example: example in monospace

Description: lipsum in regular font.

getreceivedbyaccount Edit

Syntax: getreceivedbyaccount <account> [minconf=1]

Example: example in monospace

Description: lipsum in regular font.

getreceivedbyaddress Edit

Syntax: getreceivedbyaddress <HyperStakeaddress> [minconf=1]

Example: example in monospace

Description: lipsum in regular font.

getstakesplitthreshold Edit

Syntax:

Example: example in monospace

Description: lipsum in regular font.

getstaketx Edit

Syntax: getstaketx <txid>

Example: example in monospace

Description: lipsum in regular font.

gettransaction Edit

Syntax: gettransaction <txid>

Example: example in monospace

Description: lipsum in regular font.

getwork Edit

Syntax: getwork [data]

Example: example in monospace

Description: lipsum in regular font.

getworkex Edit

Syntax: getworkex [data, coinbase]

Example: example in monospace

Description: lipsum in regular font.

help Edit

Syntax: help [command]

Example: example in monospace

Description: lipsum in regular font.

importprivkey Edit

Syntax: importprivkey <HyperStakeprivkey> [label]

Example: example in monospace

Description: lipsum in regular font.

keypoolrefill Edit

Syntax:

Example: example in monospace

Description: lipsum in regular font.

listaccounts Edit

Syntax: listaccounts [minconf=1]

Example: example in monospace

Description: lipsum in regular font.

listaddressgroupings Edit

Syntax:

Example: example in monospace

Description: lipsum in regular font.

listreceivedbyaccount Edit

Syntax: listreceivedbyaccount [minconf=1] [includeempty=false]

Example: example in monospace

Description: lipsum in regular font.

listreceivedbyaddress Edit

Syntax: listreceivedbyaddress [minconf=1] [includeempty=false]

Example: example in monospace

Description: lipsum in regular font.

listsinceblock Edit

Syntax: listsinceblock [blockhash] [target-confirmations]

Example: example in monospace

Description: lipsum in regular font.

listtransactions Edit

Syntax: listtransactions [account] [count=10] [from=0]

Example: example in monospace

Description: lipsum in regular font.

listunspent Edit

Syntax: listunspent [minconf=1] [maxconf=9999999] ["address",...]

Description: lipsum in regular font.

makekeypair Edit

Syntax: makekeypair [prefix]

Description: lipsum in regular font.

moneysupply Edit

Syntax:

Example: example in monospace

Description: lipsum in regular font.

move Edit

Syntax: move <fromaccount> <toaccount> <amount> [minconf=1] [comment]

Description: lipsum in regular font.

repairwallet Edit

Syntax:

Example: example in monospace

Description: lipsum in regular font.

rescanfromblock Edit

Syntax: rescanfromblock <block height>

Example: example in monospace

Description: lipsum in regular font.

resendtx Edit

Syntax:

Example: example in monospace

Description: lipsum in regular font.

reservebalance Edit

Syntax: reservebalance [<reserve> [amount]]

Description: lipsum in regular font.

sendalert Edit

Syntax: sendalert <message> <privatekey> <minver> <maxver> <priority> <id> [cancelupto]

Description: lipsum in regular font.

sendfrom Edit

Syntax: sendfrom <fromaccount> <toHyperStakeaddress> <amount> [minconf=1] [comment] [comment-to]

Description: lipsum in regular font.

sendmany Edit

Syntax: sendmany <fromaccount> {address:amount,...} [minconf=1] [comment]

Description: lipsum in regular font.

sendrawtransaction Edit

Syntax: sendrawtransaction <hex string>

Description: lipsum in regular font.

sendtoaddress Edit

Syntax: sendtoaddress <HyperStakeaddress> <amount> [comment] [comment-to]

Description: lipsum in regular font.

setaccount Edit

Syntax: setaccount <HyperStakeaddress> <account>

Description: lipsum in regular font.

setstakesplitthreshold Edit

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 Edit

Syntax: settxfee <amount>

Description: lipsum in regular font.

signmessage Edit

Syntax: signmessage <HyperStakeaddress> <message>

Description: lipsum in regular font.

signrawtransaction Edit

Syntax: signrawtransaction <hex string> [{"txid":txid,"vout":n,"scriptPubKey":hex},...] [<privatekey1>,...] [sighashtype="ALL"]

Description: lipsum in regular font.

stakeforcharity Edit

Syntax: stakeforcharity <HyperStake Address> <percent> [Change Address] [min amount] [max amount]

Description: lipsum in regular font.

strictprotocol Edit

Syntax:

Description: temporary documentation

strictincoming Edit

Syntax:

Description: temporary documentation

stop Edit

Syntax:stop <detach>

Description: lipsum in regular font.

submitblock Edit

Syntax: submitblock <hex data> [optional-params-obj]

Description: lipsum in regular font.

validateaddress Edit

Syntax: validateaddress <HyperStakeaddress>

Description: lipsum in regular font.

validatepubkey Edit

Syntax: validatepubkey <HyperStakepubkey>

Description: lipsum in regular font.

verifymessage Edit

Syntax: verifymessage <HyperStakeaddress> <signature> <message>

Description: lipsum in regular font.

walletlock Edit

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 Edit

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 Edit

Syntax: walletpassphrasechange <oldpassphrase> <newpassphrase>

Description: lipsum in regular font.

Ad blocker interference detected!


Wikia is a free-to-use site that makes money from advertising. We have a modified experience for viewers using ad blockers

Wikia is not accessible if you’ve made further modifications. Remove the custom ad blocker rule(s) and the page will load as expected.