mirror of https://github.com/zcash/rpc.git
e356b5af86
|
||
|---|---|---|
| script | ||
| README.md | ||
| addmultisigaddress.html | ||
| addnode.html | ||
| backupwallet.html | ||
| bootstrap.min.css | ||
| clearbanned.html | ||
| createmultisig.html | ||
| createrawtransaction.html | ||
| decoderawtransaction.html | ||
| decodescript.html | ||
| disconnectnode.html | ||
| dumpprivkey.html | ||
| dumpwallet.html | ||
| encryptwallet.html | ||
| estimatefee.html | ||
| estimatepriority.html | ||
| fundrawtransaction.html | ||
| generate.html | ||
| getaccount.html | ||
| getaccountaddress.html | ||
| getaddednodeinfo.html | ||
| getaddressbalance.html | ||
| getaddressdeltas.html | ||
| getaddressesbyaccount.html | ||
| getaddressmempool.html | ||
| getaddresstxids.html | ||
| getaddressutxos.html | ||
| getbalance.html | ||
| getbestblockhash.html | ||
| getblock.html | ||
| getblockchaininfo.html | ||
| getblockcount.html | ||
| getblockdeltas.html | ||
| getblockhash.html | ||
| getblockhashes.html | ||
| getblockheader.html | ||
| getblocksubsidy.html | ||
| getblocktemplate.html | ||
| getchaintips.html | ||
| getconnectioncount.html | ||
| getdeprecationinfo.html | ||
| getdifficulty.html | ||
| getexperimentalfeatures.html | ||
| getgenerate.html | ||
| getinfo.html | ||
| getlocalsolps.html | ||
| getmemoryinfo.html | ||
| getmempoolinfo.html | ||
| getmininginfo.html | ||
| getnettotals.html | ||
| getnetworkhashps.html | ||
| getnetworkinfo.html | ||
| getnetworksolps.html | ||
| getnewaddress.html | ||
| getpeerinfo.html | ||
| getrawchangeaddress.html | ||
| getrawmempool.html | ||
| getrawtransaction.html | ||
| getreceivedbyaccount.html | ||
| getreceivedbyaddress.html | ||
| getspentinfo.html | ||
| gettransaction.html | ||
| gettxout.html | ||
| gettxoutproof.html | ||
| gettxoutsetinfo.html | ||
| getunconfirmedbalance.html | ||
| getwalletinfo.html | ||
| help.html | ||
| importaddress.html | ||
| importprivkey.html | ||
| importpubkey.html | ||
| importwallet.html | ||
| index.html | ||
| keypoolrefill.html | ||
| listaccounts.html | ||
| listaddresses.html | ||
| listaddressgroupings.html | ||
| listbanned.html | ||
| listlockunspent.html | ||
| listreceivedbyaccount.html | ||
| listreceivedbyaddress.html | ||
| listsinceblock.html | ||
| listtransactions.html | ||
| listunspent.html | ||
| lockunspent.html | ||
| move.html | ||
| ping.html | ||
| prioritisetransaction.html | ||
| sendfrom.html | ||
| sendmany.html | ||
| sendrawtransaction.html | ||
| sendtoaddress.html | ||
| setaccount.html | ||
| setban.html | ||
| setgenerate.html | ||
| setlogfilter.html | ||
| settxfee.html | ||
| signmessage.html | ||
| signrawtransaction.html | ||
| stop.html | ||
| submitblock.html | ||
| validateaddress.html | ||
| verifychain.html | ||
| verifymessage.html | ||
| verifytxoutproof.html | ||
| walletconfirmbackup.html | ||
| z_converttex.html | ||
| z_exportkey.html | ||
| z_exportviewingkey.html | ||
| z_exportwallet.html | ||
| z_getaddressforaccount.html | ||
| z_getbalance.html | ||
| z_getbalanceforaccount.html | ||
| z_getbalanceforviewingkey.html | ||
| z_getmigrationstatus.html | ||
| z_getnewaccount.html | ||
| z_getnewaddress.html | ||
| z_getnotescount.html | ||
| z_getoperationresult.html | ||
| z_getoperationstatus.html | ||
| z_getpaymentdisclosure.html | ||
| z_getsubtreesbyindex.html | ||
| z_gettotalbalance.html | ||
| z_gettreestate.html | ||
| z_importkey.html | ||
| z_importviewingkey.html | ||
| z_importwallet.html | ||
| z_listaccounts.html | ||
| z_listaddresses.html | ||
| z_listoperationids.html | ||
| z_listreceivedbyaddress.html | ||
| z_listunifiedreceivers.html | ||
| z_listunspent.html | ||
| z_mergetoaddress.html | ||
| z_sendmany.html | ||
| z_setmigration.html | ||
| z_shieldcoinbase.html | ||
| z_validateaddress.html | ||
| z_validatepaymentdisclosure.html | ||
| z_viewtransaction.html | ||
| zcbenchmark.html | ||
| zcrawjoinsplit.html | ||
| zcrawkeygen.html | ||
| zcrawreceive.html | ||
| zcsamplejoinsplit.html | ||
README.md
Zcash RPC Documentation Generator
This tool extracts and formats the help text for each of the Zcash RPC calls. The output of this script is hosted at zcash-rpc.github.io.
See the script directory for the zcash.go script that generates the output and template.
How to use
Ensure that you have Go installed and a working and running zcashd instance and that the zcash-cli executable is available in /usr/bin/zcash-cli (or update the path to your zcash-cli executable in zcash.go). From the script directory simply run go run zcash.go and the documentation will be produced for all Zcash RPC calls and styled according to the template in template.html.
License
License of the docs is MIT (see https://github.com/zcash/zcash), license of the scripts and webpage is also MIT ((C) 2018 Karel Bilek)