joshua/dash-docs
1
0
Fork 0
mirror of https://github.com/seigler/dash-docs synced 2025-07-28 10:16:15 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update RPCs quick-ref

Browse source 
- Added descriptions for Dash
 - Updated description for Bitcoin related items for clarity
This commit is contained in:
thephez 2017-10-05 13:13:28 -04:00
parent 4b356105b0
commit 0553044117
1 changed files with 42 additions and 43 deletions
Download patch file Download diff file Expand all files Collapse all files

85
_includes/devdoc/dash-core/rpcs/quick-reference.md
View file

@ -16,32 +16,39 @@ changes made more than two years ago.
Use v0.n.n in abbreviation title to prevent autocrossrefing. Use v0.n.n in abbreviation title to prevent autocrossrefing.
{% endcomment %} {% endcomment %}
<!-- Dash - Not Implemented -->
{% assign DASH_NOT_IMPLEMENTED='**<abbr title="Not Implemented in Dash">Not Implemented</abbr>**' %}
<!-- Dash Core 0.12.1.0 Feb 2017 -->
{% assign DASH_NEW0_12_1='*<abbr title="New in Dash Core v0.12.1">New in Dash Core 0.12.0</abbr>*' %}
{% assign DASH_UPDATED0_12_1='**<abbr title="Updated in Dash Core v0.12.1">Updated in Dash Core 0.12.1</abbr>**' %}
<!-- Deprecated --> <!-- Deprecated -->
{% assign DEPRECATED='**<abbr title="Deprecated; will be removed in a future version of Bitcoin Core">Deprecated</abbr>**' %} {% assign DEPRECATED='**<abbr title="Deprecated; will be removed in a future version of Bitcoin Core">Deprecated</abbr>**' %}
<!-- Bitcoin Core 0.14.1 April 2017 --> <!-- Bitcoin Core 0.14.1 April 2017 -->
{% assign UPDATED0_14_0='**<abbr title="Updated in Bitcoin Core v0.14.1">Updated in 0.14.1</abbr>**' %} {% assign UPDATED0_14_0='**<abbr title="Updated in Bitcoin Core v0.14.1">Updated in Bitcoin Core 0.14.1</abbr>**' %}
<!-- Bitcoin Core 0.14.0 March 2017 --> <!-- Bitcoin Core 0.14.0 March 2017 -->
{% assign NEW0_14_0='**<abbr title="New in Bitcoin Core v0.14.0">New in 0.14.0</abbr>**' %} {% assign NEW0_14_0='**<abbr title="New in Bitcoin Core v0.14.0">New in Bitcoin Core 0.14.0</abbr>**' %}
{% assign UPDATED0_14_0='**<abbr title="Updated in Bitcoin Core v0.14.0">Updated in 0.14.0</abbr>**' %} {% assign UPDATED0_14_0='**<abbr title="Updated in Bitcoin Core v0.14.0">Updated in Bitcoin Core 0.14.0</abbr>**' %}
<!-- Bitcoin Core 0.13.1 September 2016 --> <!-- Bitcoin Core 0.13.1 September 2016 -->
{% assign UPDATED0_13_1='*<abbr title="Updated in Bitcoin Core v0.13.1">Updated in 0.13.1</abbr>*' %} {% assign UPDATED0_13_1='*<abbr title="Updated in Bitcoin Core v0.13.1">Updated in Bitcoin Core 0.13.1</abbr>*' %}
<!-- Bitcoin Core 0.13.0 August 2016 --> <!-- Bitcoin Core 0.13.0 August 2016 -->
{% assign NEW0_13_0='*<abbr title="New in Bitcoin Core v0.13.0">New in 0.13.0</abbr>*' %} {% assign NEW0_13_0='*<abbr title="New in Bitcoin Core v0.13.0">New in Bitcoin Core 0.13.0</abbr>*' %}
{% assign UPDATED0_13_0='*<abbr title="Updated in Bitcoin Core v0.13.0">Updated in 0.13.0</abbr>*' %} {% assign UPDATED0_13_0='*<abbr title="Updated in Bitcoin Core v0.13.0">Updated in Bitcoin Core 0.13.0</abbr>*' %}
<!-- Bitcoin Core 0.12.1 April 2016 --> <!-- Bitcoin Core 0.12.1 April 2016 -->
{% assign UPDATED0_12_1='*<abbr title="Updated in Bitcoin Core v0.12.1">Updated in 0.12.1</abbr>*' %} {% assign UPDATED0_12_1='*<abbr title="Updated in Bitcoin Core v0.12.1">Updated in Bitcoin Core 0.12.1</abbr>*' %}
<!-- Bitcoin Core 0.12.0 February 2016 --> <!-- Bitcoin Core 0.12.0 February 2016 -->
{% assign NEW0_12_0='*<abbr title="New in Bitcoin Core v0.12.0">New in 0.12.0</abbr>*' %} {% assign NEW0_12_0='*<abbr title="New in Bitcoin Core v0.12.0">New in Bitcoin Core 0.12.0</abbr>*' %}
{% assign UPDATED0_12_0='*<abbr title="Updated in Bitcoin Core v0.12.0">Updated in 0.12.0</abbr>*' %} {% assign UPDATED0_12_0='*<abbr title="Updated in Bitcoin Core v0.12.0">Updated in Bitcoin Core 0.12.0</abbr>*' %}
<!-- Bitcoin Core 0.11.0 July 2015 --> <!-- Bitcoin Core 0.11.0 July 2015 -->
{% assign NEW0_11_0='*<abbr title="New in Bitcoin Core v0.11.0">New in 0.11.0</abbr>*' %} {% assign NEW0_11_0='*<abbr title="New in Bitcoin Core v0.11.0">New in Bitcoin Core 0.11.0</abbr>*' %}
<!-- the summaries used below are defined in the files for the <!-- the summaries used below are defined in the files for the
particular RPC and aggregated into this helper file by the makefile particular RPC and aggregated into this helper file by the makefile
@ -51,6 +58,7 @@ Use v0.n.n in abbreviation title to prevent autocrossrefing.
{% include helpers/summaries.md %} {% include helpers/summaries.md %}
#### Addressindex RPCs #### Addressindex RPCs
These RPCs are all Dash-specific and not found in Bitcoin Core
{:.no_toc} {:.no_toc}
<!-- no subhead-links here --> <!-- no subhead-links here -->
@ -79,28 +87,31 @@ Use v0.n.n in abbreviation title to prevent autocrossrefing.
* [GetBlockHashes][rpc getblockhashes]: {{summary_getBlockHashes}} * [GetBlockHashes][rpc getblockhashes]: {{summary_getBlockHashes}}
* [GetBlockHeader][rpc getblockheader]: {{summary_getBlockHeader}} {{NEW0_12_0}} * [GetBlockHeader][rpc getblockheader]: {{summary_getBlockHeader}} {{NEW0_12_0}}
* [GetBlockHeaders][rpc getblockheaders]: {{summary_getBlockHeaders}} * [GetBlockHeaders][rpc getblockheaders]: {{summary_getBlockHeaders}}
* [GetChainTips][rpc getchaintips]: {{summary_getChainTips}} * [GetChainTips][rpc getchaintips]: {{summary_getChainTips}} {{DASH_UPDATED0_12_1}}
* [GetDifficulty][rpc getdifficulty]: {{summary_getDifficultly}} * [GetDifficulty][rpc getdifficulty]: {{summary_getDifficultly}}
<!-- Not in Dash
* [GetMemPoolAncestors][rpc getmempoolancestors]: {{summary_getMemPoolAncestors}} {{NEW0_13_0}}
* [GetMemPoolDescendants][rpc getmempooldescendants]: {{summary_getMemPoolDescendants}} {{NEW0_13_0}}
* [GetMemPoolEntry][rpc getmempoolentry]: {{summary_getMemPoolEntry}} {{NEW0_13_0}}
-->
* [GetMemPoolInfo][rpc getmempoolinfo]: {{summary_getMemPoolInfo}} {{UPDATED0_12_0}} * [GetMemPoolInfo][rpc getmempoolinfo]: {{summary_getMemPoolInfo}} {{UPDATED0_12_0}}
* [GetRawMemPool][rpc getrawmempool]: {{summary_getRawMemPool}} {{UPDATED0_13_0}} * [GetRawMemPool][rpc getrawmempool]: {{summary_getRawMemPool}} {{UPDATED0_13_0}}
* [GetSpentInfo][rpc getspentifo]: {{summary_getSpentInfo}} * [GetSpentInfo][rpc getspentifo]: {{summary_getSpentInfo}}
* [GetTxOut][rpc gettxout]: {{summary_getTxOut}} * [GetTxOut][rpc gettxout]: {{summary_getTxOut}}
* [GetTxOutProof][rpc gettxoutproof]: {{summary_getTxOutProof}} {{NEW0_11_0}} * [GetTxOutProof][rpc gettxoutproof]: {{summary_getTxOutProof}} {{NEW0_11_0}}
* [GetTxOutSetInfo][rpc gettxoutsetinfo]: {{summary_getTxOutSetInfo}} * [GetTxOutSetInfo][rpc gettxoutsetinfo]: {{summary_getTxOutSetInfo}}
<!-- Not in Dash
* [PreciousBlock][rpc preciousblock]: {{summary_preciousBlock}} {{NEW0_14_0}}
* [PruneBlockChain][rpc pruneblockchain]: {{summary_pruneBlockChain}} {{NEW0_14_0}}
-->
* [VerifyChain][rpc verifychain]: {{summary_verifyChain}} * [VerifyChain][rpc verifychain]: {{summary_verifyChain}}
* [VerifyTxOutProof][rpc verifytxoutproof]: {{summary_verifyTxOutProof}} {{NEW0_11_0}} * [VerifyTxOutProof][rpc verifytxoutproof]: {{summary_verifyTxOutProof}} {{NEW0_11_0}}
{% endautocrossref %} {% endautocrossref %}
##### Not implemented in Dash
{% autocrossref %}
* {{DASH_NOT_IMPLEMENTED}} [GetMemPoolAncestors][rpc getmempoolancestors]: {{summary_getMemPoolAncestors}} {{NEW0_13_0}}
* {{DASH_NOT_IMPLEMENTED}} [GetMemPoolDescendants][rpc getmempooldescendants]: {{summary_getMemPoolDescendants}} {{NEW0_13_0}}
* {{DASH_NOT_IMPLEMENTED}} [GetMemPoolEntry][rpc getmempoolentry]: {{summary_getMemPoolEntry}} {{NEW0_13_0}}
* {{DASH_NOT_IMPLEMENTED}} [PreciousBlock][rpc preciousblock]: {{summary_preciousBlock}} {{NEW0_14_0}}
* {{DASH_NOT_IMPLEMENTED}} [PruneBlockChain][rpc pruneblockchain]: {{summary_pruneBlockChain}} {{NEW0_14_0}}
{% endautocrossref %}
#### Control RPCs #### Control RPCs
{:.no_toc} {:.no_toc}
<!-- no subhead-links here --> <!-- no subhead-links here -->
@ -143,9 +154,7 @@ Use v0.n.n in abbreviation title to prevent autocrossrefing.
* [Generate][rpc generate]: {{summary_generate}} {{NEW0_11_0}}, {{UPDATED0_13_0}} * [Generate][rpc generate]: {{summary_generate}} {{NEW0_11_0}}, {{UPDATED0_13_0}}
* [GetGenerate][rpc getgenerate]: {{summary_getgenerate}} * [GetGenerate][rpc getgenerate]: {{summary_getgenerate}}
* [SetGenerate][rpc setgenerate]: {{summary_setgenerate}} * [SetGenerate][rpc setgenerate]: {{summary_setgenerate}}
<!-- Not in Dash * {{DASH_NOT_IMPLEMENTED}} [GenerateToAddress][rpc generatetoaddress]: {{summary_generateToAddress}} {{NEW0_13_0}}
* [GenerateToAddress][rpc generatetoaddress]: {{summary_generateToAddress}} {{NEW0_13_0}}
-->
{% endautocrossref %} {% endautocrossref %}
@ -211,12 +220,11 @@ Use v0.n.n in abbreviation title to prevent autocrossrefing.
* [EstimatePriority][rpc estimatepriority]: {{summary_estimatePriority}} * [EstimatePriority][rpc estimatepriority]: {{summary_estimatePriority}}
* [EstimateSmartFee][rpc estimatesmartfee]: {{summary_estimateSmartFee}} {{DEPRECATED}} * [EstimateSmartFee][rpc estimatesmartfee]: {{summary_estimateSmartFee}} {{DEPRECATED}}
* [EstimateSmartPriority][rpc estimatesmartpriority]: {{summary_estimateSmartPriority}} {{DEPRECATED}} * [EstimateSmartPriority][rpc estimatesmartpriority]: {{summary_estimateSmartPriority}} {{DEPRECATED}}
<!-- Not in Dash
* [GetMemoryInfo][rpc getmemoryinfo]: {{summary_getMemoryInfo}} {{NEW_14_0}}
-->
* [ValidateAddress][rpc validateaddress]: {{summary_validateAddress}} {{UPDATED0_13_0}} * [ValidateAddress][rpc validateaddress]: {{summary_validateAddress}} {{UPDATED0_13_0}}
* [VerifyMessage][rpc verifymessage]: {{summary_verifyMessage}} * [VerifyMessage][rpc verifymessage]: {{summary_verifyMessage}}
* {{DASH_NOT_IMPLEMENTED}} [GetMemoryInfo][rpc getmemoryinfo]: {{summary_getMemoryInfo}} {{NEW_14_0}}
{% endautocrossref %} {% endautocrossref %}
#### Wallet RPCs #### Wallet RPCs
@ -230,14 +238,8 @@ with [wallet support][]{:#term-wallet-support}{:.term}, which is the
default. default.
* [AbandonTransaction][rpc abandontransaction]: {{summary_abandonTransaction}} {{NEW0_12_0}} * [AbandonTransaction][rpc abandontransaction]: {{summary_abandonTransaction}} {{NEW0_12_0}}
<!-- Not in Dash
* [AddWitnessAddress][rpc addwitnessaddress]: {{summary_addWitnessAddress}} {{NEW0_13_0}}
-->
* [AddMultiSigAddress][rpc addmultisigaddress]: {{summary_addMultiSigAddress}} * [AddMultiSigAddress][rpc addmultisigaddress]: {{summary_addMultiSigAddress}}
* [BackupWallet][rpc backupwallet]: {{summary_backupWallet}} * [BackupWallet][rpc backupwallet]: {{summary_backupWallet}}
<!-- Not in Dash
* [BumpFee][rpc bumpfee]: {{summary_bumpFee}} {{NEW0_14_0}}
-->
* [DumpHDInfo][rpc dumphdinfo]: {{summary_dumpHdInfo}} * [DumpHDInfo][rpc dumphdinfo]: {{summary_dumpHdInfo}}
* [DumpPrivKey][rpc dumpprivkey]: {{summary_dumpPrivKey}} * [DumpPrivKey][rpc dumpprivkey]: {{summary_dumpPrivKey}}
* [DumpWallet][rpc dumpwallet]: {{summary_dumpWallet}} * [DumpWallet][rpc dumpwallet]: {{summary_dumpWallet}}
@ -254,11 +256,7 @@ default.
* [GetUnconfirmedBalance][rpc getunconfirmedbalance]: {{summary_getUnconfirmedBalance}} * [GetUnconfirmedBalance][rpc getunconfirmedbalance]: {{summary_getUnconfirmedBalance}}
* [GetWalletInfo][rpc getwalletinfo]: {{summary_getWalletInfo}} * [GetWalletInfo][rpc getwalletinfo]: {{summary_getWalletInfo}}
* [ImportAddress][rpc importaddress]: {{summary_importAddress}} * [ImportAddress][rpc importaddress]: {{summary_importAddress}}
* [ImportElectrumWallet][rpc importelecturmwallet]: {{summary_importElectrumWallet}} * [ImportElectrumWallet][rpc importelecturmwallet]: {{summary_importElectrumWallet}} {{DASH_NEW0_12_1}}
<!-- Not in Dash
* [ImportMulti][rpc importmulti]: {{summary_importMulti}} {{NEW0_14_0}}
* [ImportPrunedFunds][rpc importprunedfunds]: {{summary_importPrunedFunds}} {{NEW0_13_0}}
-->
* [ImportPrivKey][rpc importprivkey]: {{summary_importPrivKey}} * [ImportPrivKey][rpc importprivkey]: {{summary_importPrivKey}}
* [ImportPubKey][rpc importpubkey]: {{summary_importPubKey}} * [ImportPubKey][rpc importpubkey]: {{summary_importPubKey}}
* [ImportWallet][rpc importwallet]: {{summary_importWallet}} * [ImportWallet][rpc importwallet]: {{summary_importWallet}}
@ -275,22 +273,23 @@ default.
* [ListUnspent][rpc listunspent]: {{summary_listUnspent}} {{UPDATED0_13_0}} * [ListUnspent][rpc listunspent]: {{summary_listUnspent}} {{UPDATED0_13_0}}
* [LockUnspent][rpc lockunspent]: {{summary_lockUnspent}} * [LockUnspent][rpc lockunspent]: {{summary_lockUnspent}}
* [Move][rpc move]: {{summary_move}} {{DEPRECATED}} * [Move][rpc move]: {{summary_move}} {{DEPRECATED}}
<!-- Not in Dash
* [RemovePrunedFunds][rpc removeprunedfunds]: {{summary_removePrunedFunds}} {{NEW0_13_0}}
-->
* [SendFrom][rpc sendfrom]: {{summary_sendFrom}} {{DEPRECATED}} * [SendFrom][rpc sendfrom]: {{summary_sendFrom}} {{DEPRECATED}}
* [SendMany][rpc sendmany]: {{summary_sendMany}} * [SendMany][rpc sendmany]: {{summary_sendMany}}
* [SendToAddress][rpc sendtoaddress]: {{summary_sendToAddress}} * [SendToAddress][rpc sendtoaddress]: {{summary_sendToAddress}}
* [SetAccount][rpc setaccount]: {{summary_setAccount}} {{DEPRECATED}} * [SetAccount][rpc setaccount]: {{summary_setAccount}} {{DEPRECATED}}
* [SetTxFee][rpc settxfee]: {{summary_setTxFee}} * [SetTxFee][rpc settxfee]: {{summary_setTxFee}}
* [SignMessage][rpc signmessage]: {{summary_signMessage}} * [SignMessage][rpc signmessage]: {{summary_signMessage}}
<!-- Not in Dash
* [SignMessageWithPrivKey][rpc signmessagewithprivkey]: {{summary_signMessageWithPrivKey}} {{NEW0_13_0}}
-->
* [WalletLock][rpc walletlock]: {{summary_walletLock}} * [WalletLock][rpc walletlock]: {{summary_walletLock}}
* [WalletPassphrase][rpc walletpassphrase]: {{summary_walletPassphrase}} * [WalletPassphrase][rpc walletpassphrase]: {{summary_walletPassphrase}}
* [WalletPassphraseChange][rpc walletpassphrasechange]: {{summary_walletPassphraseChange}} * [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}} [ImportMulti][rpc importmulti]: {{summary_importMulti}} {{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}}
* {{DASH_NOT_IMPLEMENTED}} [SignMessageWithPrivKey][rpc signmessagewithprivkey]: {{summary_signMessageWithPrivKey}} {{NEW0_13_0}}
{% endautocrossref %} {% endautocrossref %}
#### Removed RPCs #### Removed RPCs