- Update GetBlockChainInfo and GetBlockTemplate - Add ImportMulti - Some minor generate RPC updates for removed commands
15 KiB
{% comment %} This file is licensed under the MIT License (MIT) available on http://opensource.org/licenses/MIT. {% endcomment %} {% assign filename="_includes/devdoc/dash-core/rpcs/quick-reference.md" %}
Quick Reference
{% include helpers/subhead-links.md %}
{% comment %} Styling notes: use highly-visible style for upcoming changes (not yet released) and changes made in the last 6 months. Use less-visible style for changes made up to two years ago. Don't point out changes made more than two years ago.
Use v0.n.n in abbreviation title to prevent autocrossrefing. {% endcomment %}
{% assign DASH_NOT_IMPLEMENTED='Not Implemented' %}
{% assign DASH_NEW0_12_3='New in Dash Core 0.12.3' %} {% assign DASH_UPDATED0_12_3='Updated in Dash Core 0.12.3' %}
{% assign DASH_NEW0_12_2='New in Dash Core 0.12.2' %} {% assign DASH_UPDATED0_12_2='Updated in Dash Core 0.12.2' %}
{% assign DASH_NEW0_12_1='New in Dash Core 0.12.1' %} {% assign DASH_UPDATED0_12_1='Updated in Dash Core 0.12.1' %}
{% assign DARKCOIN_NEW0_11_0='New in Darkcoin Core 0.11.0' %} {% assign DARKCOIN_UPDATED0_11_0='Updated in Darkcoin Core 0.11.0' %}
{% assign DEPRECATED='Deprecated' %}
{% assign UPDATED0_14_0='Updated in Bitcoin Core 0.14.1' %}
{% assign NEW0_14_0='New in Bitcoin Core 0.14.0' %} {% assign UPDATED0_14_0='Updated in Bitcoin Core 0.14.0' %}
{% assign UPDATED0_13_1='Updated in Bitcoin Core 0.13.1' %}
{% assign NEW0_13_0='New in Bitcoin Core 0.13.0' %} {% assign UPDATED0_13_0='Updated in Bitcoin Core 0.13.0' %}
{% assign UPDATED0_12_1='Updated in Bitcoin Core 0.12.1' %}
{% assign NEW0_12_0='New in Bitcoin Core 0.12.0' %} {% assign UPDATED0_12_0='Updated in Bitcoin Core 0.12.0' %}
{% assign NEW0_11_0='New in Bitcoin Core 0.11.0' %}
{% include helpers/summaries.md %}
####RPC Summary Table
{% include layout/base/rpc-table.html %}
Addressindex RPCs
{:.no_toc}
These RPCs are all Dash-specific and not found in Bitcoin Core
{% autocrossref %}
- [GetAddressBalance][rpc getaddressbalance]: {{summary_getAddressBalance}}
- [GetAddressDeltas][rpc getaddressdeltas]: {{summary_getAddressDeltas}}
- [GetAddressMempool][rpc getaddressmempool]: {{summary_getAddressMempool}}
- [GetAddressTxids][rpc getaddresstxids]: {{summary_getAddressTxids}}
- [GetAddressUtxos][rpc getaddressutxos]: {{summary_getAddressUtxos}}
{% endautocrossref %}
Block Chain RPCs
{:.no_toc}
{% autocrossref %}
- [GetBestBlockHash][rpc getbestblockhash]: {{summary_getBestBlockHash}}
- [GetBlock][rpc getblock]: {{summary_getBlock}} {{UPDATED0_13_0}}
- [GetBlockChainInfo][rpc getblockchaininfo]: {{summary_getBlockChainInfo}} {{DASH_UPDATED0_12_3}} {{UPDATED0_12_1}}
- [GetBlockCount][rpc getblockcount]: {{summary_getBlockCount}}
- [GetBlockHash][rpc getblockhash]: {{summary_getBlockHash}}
- [GetBlockHashes][rpc getblockhashes]: {{summary_getBlockHashes}} {{DASH_NEW0_12_1}}
- [GetBlockHeader][rpc getblockheader]: {{summary_getBlockHeader}} {{NEW0_12_0}}
- [GetBlockHeaders][rpc getblockheaders]: {{summary_getBlockHeaders}} {{DASH_NEW0_12_1}}
- [GetChainTips][rpc getchaintips]: {{summary_getChainTips}} {{DASH_UPDATED0_12_1}}
- [GetDifficulty][rpc getdifficulty]: {{summary_getDifficulty}}
- [GetMemPoolAncestors][rpc getmempoolancestors]: {{summary_getMemPoolAncestors}} {{DASH_NEW0_12_3}} {{NEW0_13_0}}
- [GetMemPoolDescendants][rpc getmempooldescendants]: {{summary_getMemPoolDescendants}} {{DASH_NEW0_12_3}} {{NEW0_13_0}}
- [GetMemPoolEntry][rpc getmempoolentry]: {{summary_getMemPoolEntry}} {{DASH_NEW0_12_3}} {{NEW0_13_0}}
- [GetMemPoolInfo][rpc getmempoolinfo]: {{summary_getMemPoolInfo}} {{UPDATED0_12_0}}
- [GetRawMemPool][rpc getrawmempool]: {{summary_getRawMemPool}} {{UPDATED0_13_0}}
- [GetSpentInfo][rpc getspentinfo]: {{summary_getSpentInfo}} {{DASH_NEW0_12_1}}
- [GetTxOut][rpc gettxout]: {{summary_getTxOut}}
- [GetTxOutProof][rpc gettxoutproof]: {{summary_getTxOutProof}} {{NEW0_11_0}}
- [GetTxOutSetInfo][rpc gettxoutsetinfo]: {{summary_getTxOutSetInfo}}
- [PreciousBlock][rpc preciousblock]: {{summary_preciousBlock}} {{DASH_NEW0_12_3}} {{NEW0_14_0}}
- [VerifyChain][rpc verifychain]: {{summary_verifyChain}}
- [VerifyTxOutProof][rpc verifytxoutproof]: {{summary_verifyTxOutProof}} {{NEW0_11_0}}
{% endautocrossref %}
Not implemented in Dash
{% autocrossref %}
- {{DASH_NOT_IMPLEMENTED}} [PruneBlockChain][rpc pruneblockchain]: {{summary_pruneBlockChain}} {{NEW0_14_0}}
{% endautocrossref %}
Control RPCs
{:.no_toc}
{% autocrossref %}
- [Debug][rpc debug]: {{summary_debug}} {{DASH_UPDATED0_12_3}}
- [GetInfo][rpc getinfo]: {{summary_getInfo}} {{DEPRECATED}}
- [GetMemoryInfo][rpc getmemoryinfo]: {{summary_getMemoryInfo}} {{DASH_NEW0_12_3}} {{NEW_14_0}}
- [Help][rpc help]: {{summary_help}}
- [Stop][rpc stop]: {{summary_stop}}
{% endautocrossref %}
Dash RPCs
{:.no_toc}
{% autocrossref %}
- [GetGovernanceInfo][rpc getgovernanceinfo]: {{summary_getGovernanceInfo}}
- [GetPoolInfo][rpc getpoolinfo]: {{summary_getPoolInfo}}
- [GetSuperblockBudget][rpc getsuperblockbudget]: {{summary_getSuperblockBudget}}
- [GObject][rpc gobject]: {{summary_gObject}} {{DASH_UPDATED0_12_3}}
- [Masternode][rpc masternode]: {{summary_masternode}} {{DASH_UPDATED0_12_3}}
- [MasternodeBroadcast][rpc masternodebroadcast]: {{summary_masternodeBroadcast}}
- [MasternodeList][rpc masternodelist]: {{summary_masternodeList}}
- [MnSync][rpc mnsync]: {{summary_mnSync}}
- [PrivateSend][rpc privatesend]: {{summary_privateSend}}
- [SentinelPing][rpc sentinelping]: {{summary_sentinelPing}}
- [Spork][rpc spork]: {{summary_spork-rpc}}
- [VoteRaw][rpc voteraw]: {{summary_voteRaw}}
{% endautocrossref %}
Generating RPCs
{:.no_toc}
{% autocrossref %}
- [Generate][rpc generate]: {{summary_generate}} {{DASH_UPDATED0_12_3}} {{UPDATED0_13_0}}
- [GenerateToAddress][rpc generatetoaddress]: {{summary_generateToAddress}} {{DASH_NEW0_12_3}} {{NEW0_13_0}}
{% endautocrossref %}
Mining RPCs
{:.no_toc}
{% autocrossref %}
- [GetBlockTemplate][rpc getblocktemplate]: {{summary_getBlockTemplate}} {{DASH_UPDATED0_12_3}}
- [GetMiningInfo][rpc getmininginfo]: {{summary_getMiningInfo}} {{UPDATED0_14_0}}
- [GetNetworkHashPS][rpc getnetworkhashps]: {{summary_getNetworkHashPS}}
- [PrioritiseTransaction][rpc prioritisetransaction]: {{summary_prioritiseTransaction}}
- [SubmitBlock][rpc submitblock]: {{summary_submitBlock}}
{% endautocrossref %}
Network RPCs
{:.no_toc}
{% autocrossref %}
- [AddNode][rpc addnode]: {{summary_addNode}} {{UPDATED0_14_0}}
- [ClearBanned][rpc clearbanned]: {{summary_clearBanned}} {{NEW0_12_0}}
- [DisconnectNode][rpc disconnectnode]: {{summary_disconnectNode}} {{NEW0_12_0}} {{UPDATED0_14_1}}
- [GetAddedNodeInfo][rpc getaddednodeinfo]: {{summary_getAddedNodeInfo}} {{DASH_UPDATED0_12_3}} {{UPDATED0_14_0}}
- [GetConnectionCount][rpc getconnectioncount]: {{summary_getConnectionCount}}
- [GetNetTotals][rpc getnettotals]: {{summary_getNetTotals}} {{UPDATED0_12_0}}
- [GetNetworkInfo][rpc getnetworkinfo]: {{summary_getNetworkInfo}} {{DASH_UPDATED0_12_3}} {{UPDATED0_13_0}}
- [GetPeerInfo][rpc getpeerinfo]: {{summary_getPeerInfo}} {{UPDATED0_13_0}}
- [ListBanned][rpc listbanned]: {{summary_listBanned}} {{NEW0_12_0}}
- [Ping][rpc ping]: {{summary_ping-rpc}}
- [SetBan][rpc setban]: {{summary_setBan}} {{NEW0_12_0}}
- [SetNetworkActive][rpc setnetworkactive]: {{summary_setNetworkActive}} {{NEW0_14_0}}
{% endautocrossref %}
Raw Transaction RPCs
{:.no_toc}
{% autocrossref %}
- [CreateRawTransaction][rpc createrawtransaction]: {{summary_createRawTransaction}} {{DASH_UPDATED0_12_3}} {{UPDATED0_14_1}}
- [DecodeRawTransaction][rpc decoderawtransaction]: {{summary_decodeRawTransaction}} {{UPDATED0_13_0}}
- [DecodeScript][rpc decodescript]: {{summary_decodeScript}}
- [FundRawTransaction][rpc fundrawtransaction]: {{summary_fundRawTransaction}} {{DASH_UPDATED0_12_3}} {{UPDATED0_14_0}}
- [GetRawTransaction][rpc getrawtransaction]: {{summary_getRawTransaction}} {{DASH_UPDATED0_12_3}} {{UPDATED0_14_0}}
- [SendRawTransaction][rpc sendrawtransaction]: {{summary_sendRawTransaction}}
- [SignRawTransaction][rpc signrawtransaction]: {{summary_signRawTransaction}}
{% endautocrossref %}
Utility RPCs
{:.no_toc}
{% autocrossref %}
- [CreateMultiSig][rpc createmultisig]: {{summary_createMultiSig}}
- [EstimateFee][rpc estimatefee]: {{summary_estimateFee}}
- [EstimatePriority][rpc estimatepriority]: {{summary_estimatePriority}} {{DEPRECATED}}
- [EstimateSmartFee][rpc estimatesmartfee]: {{summary_estimateSmartFee}} {{DEPRECATED}}
- [EstimateSmartPriority][rpc estimatesmartpriority]: {{summary_estimateSmartPriority}} {{DEPRECATED}}
- [SignMessageWithPrivKey][rpc signmessagewithprivkey]: {{summary_signMessageWithPrivKey}} {{DASH_NEW0_12_3}} {{NEW0_13_0}}
- [ValidateAddress][rpc validateaddress]: {{summary_validateAddress}} {{DASH_UPDATED0_12_3}} {{UPDATED0_13_0}}
- [VerifyMessage][rpc verifymessage]: {{summary_verifyMessage}}
{% endautocrossref %}
Wallet RPCs
{:.no_toc}
{% autocrossref %}
Note: the wallet RPCs are only available if Dash Core was built with [wallet support][]{:#term-wallet-support}{:.term}, which is the default.
-
[AbandonTransaction][rpc abandontransaction]: {{summary_abandonTransaction}} {{NEW0_12_0}}
-
[AddMultiSigAddress][rpc addmultisigaddress]: {{summary_addMultiSigAddress}}
-
[BackupWallet][rpc backupwallet]: {{summary_backupWallet}}
-
[DumpHDInfo][rpc dumphdinfo]: {{summary_dumpHDInfo}} {{DASH_NEW0_12_2}}
-
[DumpPrivKey][rpc dumpprivkey]: {{summary_dumpPrivKey}}
-
[DumpWallet][rpc dumpwallet]: {{summary_dumpWallet}}
-
[EncryptWallet][rpc encryptwallet]: {{summary_encryptWallet}}
-
[GetAccount][rpc getaccount]: {{summary_getAccount}} {{DEPRECATED}}
-
[GetAccountAddress][rpc getaccountaddress]: {{summary_getAccountAddress}} {{DEPRECATED}}
-
[GetAddressesByAccount][rpc getaddressesbyaccount]: {{summary_getAddressesByAccount}} {{DEPRECATED}}
-
[GetBalance][rpc getbalance]: {{summary_getBalance}}
-
[GetNewAddress][rpc getnewaddress]: {{summary_getNewAddress}}
-
[GetRawChangeAddress][rpc getrawchangeaddress]: {{summary_getRawChangeAddress}}
-
[GetReceivedByAccount][rpc getreceivedbyaccount]: {{summary_getReceivedByAccount}} {{DEPRECATED}}
-
[GetReceivedByAddress][rpc getreceivedbyaddress]: {{summary_getReceivedByAddress}}
-
[GetTransaction][rpc gettransaction]: {{summary_getTransaction}} {{UPDATED0_12_0}}
-
[GetUnconfirmedBalance][rpc getunconfirmedbalance]: {{summary_getUnconfirmedBalance}}
-
[GetWalletInfo][rpc getwalletinfo]: {{summary_getWalletInfo}}
-
[ImportAddress][rpc importaddress]: {{summary_importAddress}}
-
[ImportElectrumWallet][rpc importelectrumwallet]: {{summary_importElectrumWallet}} {{DASH_NEW0_12_1}}
-
[ImportMulti][rpc importmulti]: {{summary_importMulti}} {{DASH_NEW0_12_3}} {{NEW0_14_0}}
-
[ImportPrivKey][rpc importprivkey]: {{summary_importPrivKey}}
-
[ImportPubKey][rpc importpubkey]: {{summary_importPubKey}}
-
[ImportWallet][rpc importwallet]: {{summary_importWallet}}
-
[InstantSendToAddress][rpc instantsendtoaddress]: {{summary_instantSendToAddress}}
-
[KeePass][rpc keepass]: {{summary_keepass}} {{DARKCOIN_NEW0_11_0}}
-
[KeyPoolRefill][rpc keypoolrefill]: {{summary_keyPoolRefill}}
-
[ListAccounts][rpc listaccounts]: {{summary_listAccounts}} {{DEPRECATED}}
-
[ListAddressGroupings][rpc listaddressgroupings]: {{summary_listAddressGroupings}}
-
[ListLockUnspent][rpc listlockunspent]: {{summary_listLockUnspent}}
-
[ListReceivedByAccount][rpc listreceivedbyaccount]: {{summary_listReceivedByAccount}} {{DEPRECATED}}
-
[ListReceivedByAddress][rpc listreceivedbyaddress]: {{summary_listReceivedByAddress}}
-
[ListSinceBlock][rpc listsinceblock]: {{summary_listSinceBlock}}
-
[ListTransactions][rpc listtransactions]: {{summary_listTransactions}} {{UPDATED0_12_1}}
-
[ListUnspent][rpc listunspent]: {{summary_listUnspent}} {{DASH_UPDATED0_12_3}} {{UPDATED0_13_0}}
-
[LockUnspent][rpc lockunspent]: {{summary_lockUnspent}}
-
[Move][rpc move]: {{summary_move}} {{DEPRECATED}}
-
[SendFrom][rpc sendfrom]: {{summary_sendFrom}} {{DEPRECATED}}
-
[SendMany][rpc sendmany]: {{summary_sendMany}}
-
[SendToAddress][rpc sendtoaddress]: {{summary_sendToAddress}}
-
[SetAccount][rpc setaccount]: {{summary_setAccount}} {{DEPRECATED}}
-
[SetTxFee][rpc settxfee]: {{summary_setTxFee}}
-
[SignMessage][rpc signmessage]: {{summary_signMessage}}
-
[WalletLock][rpc walletlock]: {{summary_walletLock}}
-
[WalletPassphrase][rpc walletpassphrase]: {{summary_walletPassphrase}}
-
[WalletPassphraseChange][rpc walletpassphrasechange]: {{summary_walletPassphraseChange}}
-
{{DASH_NOT_IMPLEMENTED}} [AddWitnessAddress][rpc addwitnessaddress]: {{summary_addWitnessAddress}} {{NEW0_13_0}}
-
{{DASH_NOT_IMPLEMENTED}} [BumpFee][rpc bumpfee]: {{summary_bumpFee}} {{NEW0_14_0}}
-
{{DASH_NOT_IMPLEMENTED}} [ImportPrunedFunds][rpc importprunedfunds]: {{summary_importPrunedFunds}} {{NEW0_13_0}}
-
{{DASH_NOT_IMPLEMENTED}} [RemovePrunedFunds][rpc removeprunedfunds]: {{summary_removePrunedFunds}} {{NEW0_13_0}}
{% endautocrossref %}
Removed RPCs
{:.no_toc}
{% autocrossref %}
- [GetHashesPerSec][rpc gethashespersec]: {{summary_getHashesPerSec}}
- [GetWork][rpc getwork]: {{summary_getWork}}
- [GetGenerate][rpc getgenerate]: {{summary_getGenerate}}
- [SetGenerate][rpc setgenerate]: {{summary_setGenerate}} {% endautocrossref %}