dash-docs/_includes/devdoc/dash-core/rpcs/quick-reference.md

18 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_14_1='New in Dash Core 0.14.1' %} {% assign DASH_UPDATED0_14_1='Updated in Dash Core 0.14.1' %}

{% assign DASH_NEW0_14_0='New in Dash Core 0.14.0' %} {% assign DASH_UPDATED0_14_0='Updated in Dash Core 0.14.0' %}

{% assign DASH_NEW0_13_2='New in Dash Core 0.13.2' %} {% assign DASH_UPDATED0_13_2='Updated in Dash Core 0.13.2' %}

{% assign DASH_NEW0_13_1='New in Dash Core 0.13.1' %} {% assign DASH_UPDATED0_13_1='Updated in Dash Core 0.13.1' %}

{% assign DASH_NEW0_13_0='New in Dash Core 0.13.0' %} {% assign DASH_UPDATED0_13_0='Updated in Dash Core 0.13.0' %}

{% 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}} {{DASH_UPDATED0_14_0}}
  • [GetBlockChainInfo][rpc getblockchaininfo]: {{summary_getBlockChainInfo}} {{DASH_UPDATED0_13_0}} {{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_3}}
  • [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}} {{DASH_UPDATED0_12_3}} {{UPDATED0_13_0}}
  • [GetMerkleBlocks][rpc getmerkleblocks]: {{summary_getMerkleBlocks}} {{DASH_NEW0_14_1}}
  • [GetSpecialTxes][rpc getspecialtxes]: {{summary_getSpecialTxes}} {{DASH_NEW0_13_1}}
  • [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}}
  • [PruneBlockChain][rpc pruneblockchain]: {{summary_pruneBlockChain}} {{DASH_NEW0_12_3}} {{NEW0_14_0}}
  • [VerifyChain][rpc verifychain]: {{summary_verifyChain}}
  • [VerifyTxOutProof][rpc verifytxoutproof]: {{summary_verifyTxOutProof}} {{NEW0_11_0}}

{% endautocrossref %}

Control RPCs

{:.no_toc}

{% autocrossref %}

  • [Debug][rpc debug]: {{summary_debug}} {{DASH_UPDATED0_14_0}}
  • [GetInfo][rpc getinfo]: {{summary_getInfo}} {{DASH_UPDATED0_14_0}} {{DEPRECATED}}
  • [GetMemoryInfo][rpc getmemoryinfo]: {{summary_getMemoryInfo}} {{DASH_UPDATED0_14_1}} {{NEW_14_0}}
  • [Help][rpc help]: {{summary_help}}
  • [Stop][rpc stop]: {{summary_stop}}

{% endautocrossref %}

Dash RPCs

{:.no_toc}

{% autocrossref %}

  • [GetGovernanceInfo][rpc getgovernanceinfo]: {{summary_getGovernanceInfo}} {{DASH_UPDATED0_14_0}}
  • [GetPoolInfo][rpc getpoolinfo]: {{summary_getPoolInfo}}
  • [GetSuperblockBudget][rpc getsuperblockbudget]: {{summary_getSuperblockBudget}}
  • [GObject][rpc gobject]: {{summary_gObject}} {{DASH_UPDATED0_14_0}}
  • [Masternode][rpc masternode]: {{summary_masternode}} {{DASH_UPDATED0_14_0}}
  • [MasternodeList][rpc masternodelist]: {{summary_masternodeList}} {{DASH_UPDATED0_14_0}}
  • [MnSync][rpc mnsync]: {{summary_mnSync}} {{DASH_UPDATED0_14_0}}
  • [PrivateSend][rpc privatesend]: {{summary_privateSend}} {{DASH_UPDATED0_12_3}}
  • [Spork][rpc spork]: {{summary_spork-rpc}}
  • [VoteRaw][rpc voteraw]: {{summary_voteRaw}}

{% endautocrossref %}

Evolution RPCs

{:.no_toc}

{% autocrossref %}

  • [BLS][rpc bls]: {{summary_bls}} {{DASH_UPDATED0_14_0}}
  • [ProTx][rpc protx]: {{summary_proTx}} {{DASH_UPDATED0_14_0}}
  • [Quorum][rpc quorum]: {{summary_quorum}} {{DASH_NEW0_14_0}}

{% 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_13_0}}
  • [GetMiningInfo][rpc getmininginfo]: {{summary_getMiningInfo}} {{UPDATED0_14_0}}
  • [GetNetworkHashPS][rpc getnetworkhashps]: {{summary_getNetworkHashPS}}
  • [PrioritiseTransaction][rpc prioritisetransaction]: {{summary_prioritiseTransaction}} {{UPDATED0_14_0}}
  • [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_14_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_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}}
  • [EstimateSmartFee][rpc estimatesmartfee]: {{summary_estimateSmartFee}} {{DEPRECATED}}
  • [SetBIP69Enabled][rpc setbip69enabled]: {{summary_setBIP69Enabled}} {{DASH_NEW0_12_3}}
  • [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}} {{DASH_UPDATED0_13_0}}

  • [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}} {{DASH_UPDATED0_13_0}}

  • [GetNewAddress][rpc getnewaddress]: {{summary_getNewAddress}}

  • [GetRawChangeAddress][rpc getrawchangeaddress]: {{summary_getRawChangeAddress}}

  • [GetReceivedByAccount][rpc getreceivedbyaccount]: {{summary_getReceivedByAccount}} {{DASH_UPDATED0_13_0}} {{DEPRECATED}}

  • [GetReceivedByAddress][rpc getreceivedbyaddress]: {{summary_getReceivedByAddress}} {{DASH_UPDATED0_13_0}}

  • [GetTransaction][rpc gettransaction]: {{summary_getTransaction}} {{DASH_UPDATED0_14_0}}

  • [GetUnconfirmedBalance][rpc getunconfirmedbalance]: {{summary_getUnconfirmedBalance}}

  • [GetWalletInfo][rpc getwalletinfo]: {{summary_getWalletInfo}} {{DASH_UPDATED0_12_3}}

  • [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}}

  • [ImportPrunedFunds][rpc importprunedfunds]: {{summary_importPrunedFunds}} {{DASH_NEW0_12_3}} {{NEW0_13_0}}

  • [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}} {{DASH_UPDATED0_13_0}} {{DEPRECATED}}

  • [ListAddressBalances][rpc listaddressbalances]: {{summary_listAddressBalances}} {{DASH_NEW0_12_3}}

  • [ListAddressGroupings][rpc listaddressgroupings]: {{summary_listAddressGroupings}}

  • [ListLockUnspent][rpc listlockunspent]: {{summary_listLockUnspent}}

  • [ListReceivedByAccount][rpc listreceivedbyaccount]: {{summary_listReceivedByAccount}} {{DASH_UPDATED0_13_0}} {{DEPRECATED}}

  • [ListReceivedByAddress][rpc listreceivedbyaddress]: {{summary_listReceivedByAddress}} {{DASH_UPDATED0_13_0}}

  • [ListSinceBlock][rpc listsinceblock]: {{summary_listSinceBlock}} {{DASH_UPDATED0_14_0}}

  • [ListTransactions][rpc listtransactions]: {{summary_listTransactions}} {{DASH_UPDATED0_14_0}}

  • [ListUnspent][rpc listunspent]: {{summary_listUnspent}} {{DASH_UPDATED0_14_0}}

  • [LockUnspent][rpc lockunspent]: {{summary_lockUnspent}}

  • [Move][rpc move]: {{summary_move}} {{DEPRECATED}}

  • [RemovePrunedFunds][rpc removeprunedfunds]: {{summary_removePrunedFunds}} {{DASH_NEW0_12_3}} {{NEW0_13_0}}

  • [SendFrom][rpc sendfrom]: {{summary_sendFrom}} {{DASH_UPDATED0_13_0}} {{DEPRECATED}}

  • [SendMany][rpc sendmany]: {{summary_sendMany}} {{DASH_UPDATED0_13_0}}

  • [SendToAddress][rpc sendtoaddress]: {{summary_sendToAddress}}

  • [SetAccount][rpc setaccount]: {{summary_setAccount}} {{DEPRECATED}}

  • [SetPrivateSendAmount][rpc setprivatesendamount]: {{summary_setPrivateSendAmount}}

  • [SetPrivateSendRounds][rpc setprivatesendrounds]: {{summary_setPrivateSendRounds}}

  • [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}}

{% endautocrossref %}

Removed RPCs

{:.no_toc}

{% autocrossref %}

  • [EstimatePriority][rpc estimatepriority]: {{summary_estimatePriority}}
  • [EstimateSmartPriority][rpc estimatesmartpriority]: {{summary_estimateSmartPriority}}
  • [GetHashesPerSec][rpc gethashespersec]: {{summary_getHashesPerSec}}
  • [GetWork][rpc getwork]: {{summary_getWork}}
  • [GetGenerate][rpc getgenerate]: {{summary_getGenerate}}
  • [MasternodeBroadcast][rpc masternodebroadcast]: {{summary_masternodeBroadcast}}
  • [SentinelPing][rpc sentinelping]: {{summary_sentinelPing}}
  • [SetGenerate][rpc setgenerate]: {{summary_setGenerate}} {% endautocrossref %}