RPC developer docs for HUSH full node
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Duke Leto c366d8b6e4 Merge remote-tracking branch 'origin/jahway603' 2 years ago
script hush-cli must be in your PATH, using /usr/bin is dumb af 3 years ago
FSMaddress.html initial hush3 generation using v3.6.3 3 years ago
FSMcreate.html initial hush3 generation using v3.6.3 3 years ago
FSMinfo.html initial hush3 generation using v3.6.3 3 years ago
FSMlist.html initial hush3 generation using v3.6.3 3 years ago
MoMoMdata.html initial hush3 generation using v3.6.3 3 years ago
README.md initial hush3 generation using v3.6.3 3 years ago
addmultisigaddress.html initial hush3 generation using v3.6.3 3 years ago
addnode.html initial hush3 generation using v3.6.3 3 years ago
assetchainproof.html initial hush3 generation using v3.6.3 3 years ago
assetsaddress.html initial hush3 generation using v3.6.3 3 years ago
auctionaddress.html initial hush3 generation using v3.6.3 3 years ago
backupwallet.html initial hush3 generation using v3.6.3 3 years ago
bootstrap.min.css first commit 6 years ago
calc_MoM.html initial hush3 generation using v3.6.3 3 years ago
cclib.html initial hush3 generation using v3.6.3 3 years ago
cclibaddress.html initial hush3 generation using v3.6.3 3 years ago
cclibinfo.html initial hush3 generation using v3.6.3 3 years ago
channelsaddress.html initial hush3 generation using v3.6.3 3 years ago
channelsclose.html initial hush3 generation using v3.6.3 3 years ago
channelsinfo.html initial hush3 generation using v3.6.3 3 years ago
channelslist.html initial hush3 generation using v3.6.3 3 years ago
channelsopen.html initial hush3 generation using v3.6.3 3 years ago
channelspayment.html initial hush3 generation using v3.6.3 3 years ago
channelsrefund.html initial hush3 generation using v3.6.3 3 years ago
checknotarization.html initial hush3 generation using v3.6.3 3 years ago
cleanwallettransactions.html initial hush3 generation using v3.6.3 3 years ago
clearbanned.html initial hush3 generation using v3.6.3 3 years ago
coinsupply.html initial hush3 generation using v3.6.3 3 years ago
convertpassphrase.html initial hush3 generation using v3.6.3 3 years ago
createmultisig.html initial hush3 generation using v3.6.3 3 years ago
createrawtransaction.html initial hush3 generation using v3.6.3 3 years ago
decodeccopret.html initial hush3 generation using v3.6.3 3 years ago
decoderawtransaction.html initial hush3 generation using v3.6.3 3 years ago
decodescript.html initial hush3 generation using v3.6.3 3 years ago
diceaddfunds.html initial hush3 generation using v3.6.3 3 years ago
diceaddress.html initial hush3 generation using v3.6.3 3 years ago
dicebet.html initial hush3 generation using v3.6.3 3 years ago
dicefinish.html initial hush3 generation using v3.6.3 3 years ago
dicefund.html initial hush3 generation using v3.6.3 3 years ago
diceinfo.html initial hush3 generation using v3.6.3 3 years ago
dicelist.html initial hush3 generation using v3.6.3 3 years ago
dicestatus.html initial hush3 generation using v3.6.3 3 years ago
disconnectnode.html initial hush3 generation using v3.6.3 3 years ago
dumpprivkey.html initial hush3 generation using v3.6.3 3 years ago
dumpwallet.html initial hush3 generation using v3.6.3 3 years ago
encryptwallet.html initial hush3 generation using v3.6.3 3 years ago
estimatefee.html initial hush3 generation using v3.6.3 3 years ago
estimatepriority.html initial hush3 generation using v3.6.3 3 years ago
faucetaddress.html initial hush3 generation using v3.6.3 3 years ago
faucetfund.html initial hush3 generation using v3.6.3 3 years ago
faucetget.html initial hush3 generation using v3.6.3 3 years ago
faucetinfo.html initial hush3 generation using v3.6.3 3 years ago
fundrawtransaction.html initial hush3 generation using v3.6.3 3 years ago
gatewaysaddress.html initial hush3 generation using v3.6.3 3 years ago
gatewaysbind.html initial hush3 generation using v3.6.3 3 years ago
gatewaysclaim.html initial hush3 generation using v3.6.3 3 years ago
gatewayscompletesigning.html initial hush3 generation using v3.6.3 3 years ago
gatewaysdeposit.html initial hush3 generation using v3.6.3 3 years ago
gatewaysdumpprivkey.html initial hush3 generation using v3.6.3 3 years ago
gatewaysexternaladdress.html initial hush3 generation using v3.6.3 3 years ago
gatewaysinfo.html initial hush3 generation using v3.6.3 3 years ago
gatewayslist.html initial hush3 generation using v3.6.3 3 years ago
gatewaysmarkdone.html initial hush3 generation using v3.6.3 3 years ago
gatewayspartialsign.html initial hush3 generation using v3.6.3 3 years ago
gatewayspendingdeposits.html initial hush3 generation using v3.6.3 3 years ago
gatewayspendingwithdraws.html initial hush3 generation using v3.6.3 3 years ago
gatewaysprocessed.html initial hush3 generation using v3.6.3 3 years ago
gatewayswithdraw.html initial hush3 generation using v3.6.3 3 years ago
generate.html initial hush3 generation using v3.6.3 3 years ago
genminingCSV.html initial hush3 generation using v3.6.3 3 years ago
getNotarizationsForBlock.html initial hush3 generation using v3.6.3 3 years ago
getaccount.html initial hush3 generation using v3.6.3 3 years ago
getaccountaddress.html initial hush3 generation using v3.6.3 3 years ago
getaddednodeinfo.html initial hush3 generation using v3.6.3 3 years ago
getaddressbalance.html initial hush3 generation using v3.6.3 3 years ago
getaddressdeltas.html initial hush3 generation using v3.6.3 3 years ago
getaddressesbyaccount.html initial hush3 generation using v3.6.3 3 years ago
getaddressmempool.html initial hush3 generation using v3.6.3 3 years ago
getaddresstxids.html initial hush3 generation using v3.6.3 3 years ago
getaddressutxos.html initial hush3 generation using v3.6.3 3 years ago
getalldata.html initial hush3 generation using v3.6.3 3 years ago
getbalance.html initial hush3 generation using v3.6.3 3 years ago
getbestblockhash.html initial hush3 generation using v3.6.3 3 years ago
getblock.html initial hush3 generation using v3.6.3 3 years ago
getblockchaininfo.html initial hush3 generation using v3.6.3 3 years ago
getblockcount.html initial hush3 generation using v3.6.3 3 years ago
getblockhash.html initial hush3 generation using v3.6.3 3 years ago
getblockhashes.html initial hush3 generation using v3.6.3 3 years ago
getblockheader.html initial hush3 generation using v3.6.3 3 years ago
getblocksubsidy.html initial hush3 generation using v3.6.3 3 years ago
getblocktemplate.html initial hush3 generation using v3.6.3 3 years ago
getchaintips.html initial hush3 generation using v3.6.3 3 years ago
getchaintxstats.html initial hush3 generation using v3.6.3 3 years ago
getconnectioncount.html initial hush3 generation using v3.6.3 3 years ago
getdeprecationinfo.html initial hush3 generation using v3.6.3 3 years ago
getdifficulty.html initial hush3 generation using v3.6.3 3 years ago
getdragonjson.html initial hush3 generation using v3.6.3 3 years ago
geterablockheights.html initial hush3 generation using v3.6.3 3 years ago
getgenerate.html initial hush3 generation using v3.6.3 3 years ago
getimports.html initial hush3 generation using v3.6.3 3 years ago
getinfo.html initial hush3 generation using v3.6.3 3 years ago
getlocalsolps.html initial hush3 generation using v3.6.3 3 years ago
getmempoolinfo.html initial hush3 generation using v3.6.3 3 years ago
getmininginfo.html initial hush3 generation using v3.6.3 3 years ago
getnettotals.html initial hush3 generation using v3.6.3 3 years ago
getnetworkhashps.html initial hush3 generation using v3.6.3 3 years ago
getnetworkinfo.html initial hush3 generation using v3.6.3 3 years ago
getnetworksolps.html initial hush3 generation using v3.6.3 3 years ago
getnewaddress.html initial hush3 generation using v3.6.3 3 years ago
getnotarypayinfo.html initial hush3 generation using v3.6.3 3 years ago
getnotarysendmany.html initial hush3 generation using v3.6.3 3 years ago
getpeerinfo.html initial hush3 generation using v3.6.3 3 years ago
getrawchangeaddress.html initial hush3 generation using v3.6.3 3 years ago
getrawmempool.html initial hush3 generation using v3.6.3 3 years ago
getrawtransaction.html initial hush3 generation using v3.6.3 3 years ago
getreceivedbyaccount.html initial hush3 generation using v3.6.3 3 years ago
getreceivedbyaddress.html initial hush3 generation using v3.6.3 3 years ago
getsnapshot.html initial hush3 generation using v3.6.3 3 years ago
getspentinfo.html initial hush3 generation using v3.6.3 3 years ago
gettransaction.html initial hush3 generation using v3.6.3 3 years ago
gettxout.html initial hush3 generation using v3.6.3 3 years ago
gettxoutproof.html initial hush3 generation using v3.6.3 3 years ago
gettxoutsetinfo.html initial hush3 generation using v3.6.3 3 years ago
getunconfirmedbalance.html initial hush3 generation using v3.6.3 3 years ago
getwalletburntransactions.html initial hush3 generation using v3.6.3 3 years ago
getwalletinfo.html initial hush3 generation using v3.6.3 3 years ago
height_MoM.html initial hush3 generation using v3.6.3 3 years ago
heiradd.html initial hush3 generation using v3.6.3 3 years ago
heiraddress.html initial hush3 generation using v3.6.3 3 years ago
heirclaim.html initial hush3 generation using v3.6.3 3 years ago
heirfund.html initial hush3 generation using v3.6.3 3 years ago
heirinfo.html initial hush3 generation using v3.6.3 3 years ago
heirlist.html initial hush3 generation using v3.6.3 3 years ago
help.html initial hush3 generation using v3.6.3 3 years ago
importaddress.html initial hush3 generation using v3.6.3 3 years ago
importdual.html initial hush3 generation using v3.6.3 3 years ago
importgatewaybind.html initial hush3 generation using v3.6.3 3 years ago
importgatewaycompletesigning.html initial hush3 generation using v3.6.3 3 years ago
importgatewayddress.html initial hush3 generation using v3.6.3 3 years ago
importgatewaydeposit.html initial hush3 generation using v3.6.3 3 years ago
importgatewaymarkdone.html initial hush3 generation using v3.6.3 3 years ago
importgatewaypendingwithdraws.html initial hush3 generation using v3.6.3 3 years ago
importgatewayprocessed.html initial hush3 generation using v3.6.3 3 years ago
importgatewayspartialsign.html initial hush3 generation using v3.6.3 3 years ago
importgatewaywithdraw.html initial hush3 generation using v3.6.3 3 years ago
importprivkey.html initial hush3 generation using v3.6.3 3 years ago
importwallet.html initial hush3 generation using v3.6.3 3 years ago
index.html initial hush3 generation using v3.6.3 3 years ago
invalidateblock.html initial hush3 generation using v3.6.3 3 years ago
keypoolrefill.html initial hush3 generation using v3.6.3 3 years ago
kvsearch.html initial hush3 generation using v3.6.3 3 years ago
kvupdate.html initial hush3 generation using v3.6.3 3 years ago
listaccounts.html initial hush3 generation using v3.6.3 3 years ago
listaddressgroupings.html initial hush3 generation using v3.6.3 3 years ago
listbanned.html initial hush3 generation using v3.6.3 3 years ago
listlockunspent.html initial hush3 generation using v3.6.3 3 years ago
listreceivedbyaccount.html initial hush3 generation using v3.6.3 3 years ago
listreceivedbyaddress.html initial hush3 generation using v3.6.3 3 years ago
listsinceblock.html initial hush3 generation using v3.6.3 3 years ago
listtransactions.html initial hush3 generation using v3.6.3 3 years ago
listunspent.html initial hush3 generation using v3.6.3 3 years ago
lockunspent.html initial hush3 generation using v3.6.3 3 years ago
lottoaddress.html initial hush3 generation using v3.6.3 3 years ago
migrate_checkburntransactionsource.html initial hush3 generation using v3.6.3 3 years ago
migrate_completeimporttransaction.html initial hush3 generation using v3.6.3 3 years ago
migrate_converttoexport.html initial hush3 generation using v3.6.3 3 years ago
migrate_createburntransaction.html initial hush3 generation using v3.6.3 3 years ago
migrate_createimporttransaction.html initial hush3 generation using v3.6.3 3 years ago
migrate_createnotaryapprovaltransaction.html initial hush3 generation using v3.6.3 3 years ago
minerids.html initial hush3 generation using v3.6.3 3 years ago
move.html initial hush3 generation using v3.6.3 3 years ago
mytokenorders.html initial hush3 generation using v3.6.3 3 years ago
notaries.html initial hush3 generation using v3.6.3 3 years ago
nspv_broadcast.html initial hush3 generation using v3.6.3 3 years ago
nspv_getinfo.html initial hush3 generation using v3.6.3 3 years ago
nspv_hdrsproof.html initial hush3 generation using v3.6.3 3 years ago
nspv_listccmoduleunspent.html initial hush3 generation using v3.6.3 3 years ago
nspv_listtransactions.html initial hush3 generation using v3.6.3 3 years ago
nspv_listunspent.html initial hush3 generation using v3.6.3 3 years ago
nspv_login.html initial hush3 generation using v3.6.3 3 years ago
nspv_logout.html initial hush3 generation using v3.6.3 3 years ago
nspv_mempool.html initial hush3 generation using v3.6.3 3 years ago
nspv_notarizations.html initial hush3 generation using v3.6.3 3 years ago
nspv_spend.html initial hush3 generation using v3.6.3 3 years ago
nspv_spentinfo.html initial hush3 generation using v3.6.3 3 years ago
nspv_txproof.html initial hush3 generation using v3.6.3 3 years ago
opreturn_burn.html initial hush3 generation using v3.6.3 3 years ago
oraclesaddress.html initial hush3 generation using v3.6.3 3 years ago
oraclescreate.html initial hush3 generation using v3.6.3 3 years ago
oraclesdata.html initial hush3 generation using v3.6.3 3 years ago
oraclesfund.html initial hush3 generation using v3.6.3 3 years ago
oraclesinfo.html initial hush3 generation using v3.6.3 3 years ago
oracleslist.html initial hush3 generation using v3.6.3 3 years ago
oraclesregister.html initial hush3 generation using v3.6.3 3 years ago
oraclessample.html initial hush3 generation using v3.6.3 3 years ago
oraclessamples.html initial hush3 generation using v3.6.3 3 years ago
oraclessubscribe.html initial hush3 generation using v3.6.3 3 years ago
payments_airdroptokens.html initial hush3 generation using v3.6.3 3 years ago
paymentsaddress.html initial hush3 generation using v3.6.3 3 years ago
paymentsairdrop.html initial hush3 generation using v3.6.3 3 years ago
paymentscreate.html initial hush3 generation using v3.6.3 3 years ago
paymentsfund.html initial hush3 generation using v3.6.3 3 years ago
paymentsinfo.html initial hush3 generation using v3.6.3 3 years ago
paymentslist.html initial hush3 generation using v3.6.3 3 years ago
paymentsmerge.html initial hush3 generation using v3.6.3 3 years ago
paymentsrelease.html initial hush3 generation using v3.6.3 3 years ago
paymentstxidopret.html initial hush3 generation using v3.6.3 3 years ago
pegsaccounthistory.html initial hush3 generation using v3.6.3 3 years ago
pegsaccountinfo.html initial hush3 generation using v3.6.3 3 years ago
pegscreate.html initial hush3 generation using v3.6.3 3 years ago
pegsexchange.html initial hush3 generation using v3.6.3 3 years ago
pegsfund.html initial hush3 generation using v3.6.3 3 years ago
pegsget.html initial hush3 generation using v3.6.3 3 years ago
pegsinfo.html initial hush3 generation using v3.6.3 3 years ago
pegsliquidate.html initial hush3 generation using v3.6.3 3 years ago
pegsredeem.html initial hush3 generation using v3.6.3 3 years ago
pegssaddress.html initial hush3 generation using v3.6.3 3 years ago
pegsworstaccounts.html initial hush3 generation using v3.6.3 3 years ago
ping.html initial hush3 generation using v3.6.3 3 years ago
prioritisetransaction.html initial hush3 generation using v3.6.3 3 years ago
reconsiderblock.html initial hush3 generation using v3.6.3 3 years ago
rescan.html initial hush3 generation using v3.6.3 3 years ago
resendwallettransactions.html initial hush3 generation using v3.6.3 3 years ago
rewardsaddfunding.html initial hush3 generation using v3.6.3 3 years ago
rewardsaddress.html initial hush3 generation using v3.6.3 3 years ago
rewardscreatefunding.html initial hush3 generation using v3.6.3 3 years ago
rewardsinfo.html initial hush3 generation using v3.6.3 3 years ago
rewardslist.html initial hush3 generation using v3.6.3 3 years ago
rewardslock.html initial hush3 generation using v3.6.3 3 years ago
rewardsunlock.html initial hush3 generation using v3.6.3 3 years ago
scanNotarizationsDB.html initial hush3 generation using v3.6.3 3 years ago
selfimport.html initial hush3 generation using v3.6.3 3 years ago
sendfrom.html initial hush3 generation using v3.6.3 3 years ago
sendmany.html initial hush3 generation using v3.6.3 3 years ago
sendrawtransaction.html initial hush3 generation using v3.6.3 3 years ago
sendtoaddress.html initial hush3 generation using v3.6.3 3 years ago
setaccount.html initial hush3 generation using v3.6.3 3 years ago
setban.html initial hush3 generation using v3.6.3 3 years ago
setgenerate.html initial hush3 generation using v3.6.3 3 years ago
setmocktime.html initial hush3 generation using v3.6.3 3 years ago
setpubkey.html initial hush3 generation using v3.6.3 3 years ago
settxfee.html initial hush3 generation using v3.6.3 3 years ago
signmessage.html initial hush3 generation using v3.6.3 3 years ago
signrawtransaction.html initial hush3 generation using v3.6.3 3 years ago
stop.html initial hush3 generation using v3.6.3 3 years ago
submitblock.html initial hush3 generation using v3.6.3 3 years ago
tokenaddress.html initial hush3 generation using v3.6.3 3 years ago
tokenask.html initial hush3 generation using v3.6.3 3 years ago
tokenbalance.html initial hush3 generation using v3.6.3 3 years ago
tokenbid.html initial hush3 generation using v3.6.3 3 years ago
tokencancelask.html initial hush3 generation using v3.6.3 3 years ago
tokencancelbid.html initial hush3 generation using v3.6.3 3 years ago
tokenconvert.html initial hush3 generation using v3.6.3 3 years ago
tokencreate.html initial hush3 generation using v3.6.3 3 years ago
tokenfillask.html initial hush3 generation using v3.6.3 3 years ago
tokenfillbid.html initial hush3 generation using v3.6.3 3 years ago
tokeninfo.html initial hush3 generation using v3.6.3 3 years ago
tokenlist.html initial hush3 generation using v3.6.3 3 years ago
tokenorders.html initial hush3 generation using v3.6.3 3 years ago
tokentransfer.html initial hush3 generation using v3.6.3 3 years ago
txnotarizedconfirmed.html initial hush3 generation using v3.6.3 3 years ago
validateaddress.html initial hush3 generation using v3.6.3 3 years ago
verifychain.html initial hush3 generation using v3.6.3 3 years ago
verifymessage.html initial hush3 generation using v3.6.3 3 years ago
verifytxoutproof.html initial hush3 generation using v3.6.3 3 years ago
z_exportkey.html initial hush3 generation using v3.6.3 3 years ago
z_exportviewingkey.html initial hush3 generation using v3.6.3 3 years ago
z_exportwallet.html initial hush3 generation using v3.6.3 3 years ago
z_getbalance.html initial hush3 generation using v3.6.3 3 years ago
z_getinfo.html initial hush3 generation using v3.6.3 3 years ago
z_getnewaddress.html initial hush3 generation using v3.6.3 3 years ago
z_getnotescount.html initial hush3 generation using v3.6.3 3 years ago
z_getoperationresult.html initial hush3 generation using v3.6.3 3 years ago
z_getoperationstatus.html initial hush3 generation using v3.6.3 3 years ago
z_gettotalbalance.html initial hush3 generation using v3.6.3 3 years ago
z_importkey.html initial hush3 generation using v3.6.3 3 years ago
z_importviewingkey.html initial hush3 generation using v3.6.3 3 years ago
z_importwallet.html initial hush3 generation using v3.6.3 3 years ago
z_listaddresses.html initial hush3 generation using v3.6.3 3 years ago
z_listnullifiers.html initial hush3 generation using v3.6.3 3 years ago
z_listoperationids.html initial hush3 generation using v3.6.3 3 years ago
z_listreceivedaddress.html initial hush3 generation using v3.6.3 3 years ago
z_listreceivedbyaddress.html initial hush3 generation using v3.6.3 3 years ago
z_listsentbyaddress.html initial hush3 generation using v3.6.3 3 years ago
z_listunspent.html initial hush3 generation using v3.6.3 3 years ago
z_mergetoaddress.html initial hush3 generation using v3.6.3 3 years ago
z_sendmany.html initial hush3 generation using v3.6.3 3 years ago
z_shieldcoinbase.html initial hush3 generation using v3.6.3 3 years ago
z_validateaddress.html initial hush3 generation using v3.6.3 3 years ago
z_viewtransaction.html initial hush3 generation using v3.6.3 3 years ago

README.md

Hush RPC Documentation Generator

This tool extracts and formats the help text for each of the Hush RPC calls. The output of this script is hosted at rpc.hush.is

See the script directory for the hush.go script that generates the output and template.

How to use

Ensure that you have Go installed and a working and running hushd instance and that the hush-cli executable is within your path. From the script directory simply run go run hush.go and the documentation will be produced for all Hush RPC calls and styled according to the template in template.html.

License

Released under the GPLv3 or later.

The Hush Developers, 2021
Karel Bilek, 2018 (MIT)