joshua/dash-docs
1
0
Fork 0
mirror of https://github.com/seigler/dash-docs synced 2025-07-27 09:46:12 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
dash-docs/_includes/devdoc/dash-core/rpcs/quick-reference.md
thephez 703c54ffbc Dev ref conversion (#2) 
Developer reference/guide updates to this point

* Update some reference documents
 - Adjust ref_intro to reference Dash
 - Start updating p2p network ref
 - Adjust some items in references.md to point to Dash URLs

* Update P2P networking protocol versions and message headers sections
Update subheading-links
Update more items in references.md

* Update inventories to include Dash specific items
 - Update references.md with them also
Update disclaimer (Bitcoin -> Dash)

* Remove reference to bitcoin mailing list from ref_intro

* Add Spork/GetSporks message details
Add placeholders for Dash specific messages
 - Added subsections for InstantSend, PrivateSend, Masternodes, and
Governance

* Some Bitcoin->Dash conversions
 - Update title / section name for Dev Doc/Dev Reference
 - Updated favicon

* Updates for the Data Network section of P2P reference

* Added Alert message details from Bitcoin back and removed feefilter

* More updates for Control Messages section of P2P network
 - Bitcoin->Dash reference changes
 - Reject and Version message updates

* InstantSend subsection of P2P reference detail
 - Added ix, txlvote message details and associated references

* Governance subsection (P2P)
 - Start adding govobj, govobjvote details
 - Add spork references

* Missed spork xref in previous

* Governance (P2P) updates
 - Add details to govobjvote and govsync

* Governance object P2P messages
 - Add additional description/details

* PrivateSend P2P messages
 - Added details for dsa, dsc, dsf, dsi, dsq, dss, dssu, and dstx
messages
  - Added references also
  - Hexdump examples for all but dsi and dss

* PrivateSend P2P minor updates

* Masternode P2P messages
 - Add descriptions
 - Add hexdump details

* Masternode P2P messages (dseg, mnb, mnget, mnp, mnv, mnw, mnwb, ssc)
 - Add reference/crossref entries
 - Add message structure

* P2P messages - minor formatting and corrections

* Block chain reference
 - Version info updates

* Update Block Chain reference (Headers)
 - Update version details
 - Update block reward info

* Update Transactions reference
 - Add some Dash specific updates

* Minor Transactions reference change

* RPC reference updates

* RPC reference updates
 - Added/removed commands to match available Dash commands

* Core API updates

* Renamed devdocs/bitcoin-core to dash-core
 - Updated developer-reference.md to point at new location

* Update filename to use dash-core instead of bitcoin-core

* Add Dash-specific GetAddressBalance RPC command and associated updates
Update RPC quick reference list

* Added cross reference/reference placeholders for remaining GetAddress... RPC commands
Added RPC template placeholder files for remaining GetAddress...
commands

* Scripts for environment setup and frequently used builds

* Add details for GetAddressDeltas/Mempool RPCs
Update path in Makefile bitcoin-core -> dash-core

* Add GetAddressTxids/Utxos details
Update minor formatting, etc. for GetAddressBalance/Deltas/Mempool
Changed reference to Dash Core and updated denominations for Dash

* Misc minor cleanup

* Work on updating existing Block Chain RPCs
 - GetBestBlockHash, GetBlock, GetBlockChainInfo, GetBlockCount,
GetBlockHash

* Continue updating existing Block Chain RPCs
 - GetBlockHeader, GetChainTips, GetDifficulty, GetMemPoolInfo,
GetRawMemPool

* Update RPCs quick-ref
 - Added descriptions for Dash
 - Updated description for Bitcoin related items for clarity

* Comment out content of non-implemented Block chain RPCs (GetMemPoolAncestors, GetMemPoolDescendants, GetMemPoolEntry, PreciousBlock, PruneBlockChain)

* Continue updating existing Block Chain RPCs
 - GetTxOut, GetTxOutProof, GetTxOutSetInfo, VerifyChain,
VerifyTxOutProof
Update previous block hash type to indicate X11 instead of double SHA256

* Add script to create basic RPC md file
Set up empty GetBlockHashes/Headers and GetSpentInfo RPCs

* Add GetBlockhashes details
Minor correction in Empty RPC generation script

* Add GetBlockHeaders details
Minor formatting updates

* Update Address Index related RPCs to indicate the necessity of enabling addressindex to use them

* Actual details of GetBlockHeaders

* Add details for GetSpentInfo

* Update existing Control RPCs (GetInfo, Help, Stop)

* Add Debug RPC

* Expand empty RPC generation script to add example section and fix format

* Added empty RPC files and cross-ref details for all Dash RPCs

* Add details for some Dash RPCs
- GetGovernanceInfo, GetPoolInfo, GetSuperblockBudget

* Add details for MasternodeList RPC (Dash section)

* Add details for MnSync RPC (Dash section)

* Dash RPC updates
 - Add Result section to MasternodeList
 - Formatting updates to MnSync

* Expand script to add placeholders for parameters/resuls/example

* Add details for PrivateSend RPC (Dash section)

* Update Generating RPCs
 - Added details back for GetGenerate/SetGenerate which were deprecated
in Bitcoin

* Formatting and example updates

* Add result detail and example to GetBlockTemplate

* Update existing Mining RPCs
 - GetMiningInfo, GetNetworkHashPs, PrioritiseTransaction, SubmitBlock

* Minor formatting updates

* Update most existing Network RPCs
 - AddNode, ClearBanned, DisconnectNode, GetAddedNodeInfo,
GetConnectionCount, GetNetTotals,GetNetworkInfo, GetPeerInfo,
ListBanned, Ping, SetBan
 - Added some norefs as needed (Network RPCs only)

* Misc cleanup

* SetNetworkActive (Network RPC)

* Misc updates
 - Change logo
 - Disable some headers (alert, donation)
 - Disable footer

* Governance updates
 - Add description of govsync to P2P guide
 - Updates to P2P reference

* Governance
 - Add governance message SVG image
 - Typo fixes

* Dseg updates
 - Added clarifying details regarding how to request single/all nodes
 - Ban warning

* Minor governance updates

* Governance updates / MN sync
 - Correct some reference links
 - Add MN sync info to guide
 - Update dseg, mnget, ssc, and govsync messages to include more detail

* Governance updates
 - Guide updated to show both stages of govsync
 - Reference
  - Correcte ssc typo and add sync item detail
  - Update govobjvote to include detail about propagation
  - Update govsync details

* Governance updates
 - More clarification on govsync (guide and reference)

* Raw Transaction RPC
 - Previously uncommitted CreateRawTransaction update

* Dash RPC (Gobject)
 - Add details for count and get sub-commands

Also added description for govobj types

* P2P messages
 - Spork updated to include verification details and a hexdump

Minor typo / note updates

* P2P Message - mnv
 - Draft details regarding use and operation

* P2P message (mnv)
 - Additional detail updates based on info from Udjin

Minor update to mnp

* Guide - Masternode payment
 - Add section and start putting in details

* P2P Messages - deprecated
 - Move deprecated messages to their own group

* Misc minor non-content updates
2017-10-25 09:17:55 -04:00

14 KiB
Raw Blame History

{% 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_1='New in Dash Core 0.12.1' %} {% assign DASH_UPDATED0_12_1='Updated in Dash Core 0.12.1' %}

{% 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 %}

Addressindex RPCs

These RPCs are all Dash-specific and not found in Bitcoin Core {:.no_toc}

{% 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}} {{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}}
  • [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}}
  • [VerifyChain][rpc verifychain]: {{summary_verifyChain}}
  • [VerifyTxOutProof][rpc verifytxoutproof]: {{summary_verifyTxOutProof}} {{NEW0_11_0}}

{% 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

{:.no_toc}

{% autocrossref %}

  • [Debug][rpc debug]: {{summary_debug}}
  • [GetInfo][rpc getinfo]: {{summary_getInfo}} {{DEPRECATED}}
  • [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}}
  • [Masternode][rpc masternode]: {{summary_masternode}}
  • [MasternodeBroadcast][rpc masternodebroadcast]: {{summary_masternodeBroadcast}}
  • [MasternodeList][rpc masternodelist]: {{summary_masternodeList}}
  • [MnSync][rpc mnsync]: {{summary_mnSync}}
  • [PrivateSend][rpc privatesend]: {{summary_privateSend}}
  • [Spork][rpc spork]: {{summary_spork-rpc}}
  • [VoteRaw][rpc voteraw]: {{summary_voteRaw}}

{% endautocrossref %}

Generating RPCs

{:.no_toc}

{% autocrossref %}

  • [Generate][rpc generate]: {{summary_generate}} {{NEW0_11_0}}, {{UPDATED0_13_0}}
  • [GetGenerate][rpc getgenerate]: {{summary_getGenerate}}
  • [SetGenerate][rpc setgenerate]: {{summary_setGenerate}}
  • {{DASH_NOT_IMPLEMENTED}} [GenerateToAddress][rpc generatetoaddress]: {{summary_generateToAddress}} {{NEW0_13_0}}

{% endautocrossref %}

Mining RPCs

{:.no_toc}

{% autocrossref %}

  • [GetBlockTemplate][rpc getblocktemplate]: {{summary_getBlockTemplate}}
  • [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}} {{UPDATED0_14_0}}
  • [GetConnectionCount][rpc getconnectioncount]: {{summary_getConnectionCount}}
  • [GetNetTotals][rpc getnettotals]: {{summary_getNetTotals}} {{UPDATED0_12_0}}
  • [GetNetworkInfo][rpc getnetworkinfo]: {{summary_getNetworkInfo}} {{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}} {{UPDATED0_14_1}}
  • [DecodeRawTransaction][rpc decoderawtransaction]: {{summary_decodeRawTransaction}} {{UPDATED0_13_0}}
  • [DecodeScript][rpc decodescript]: {{summary_decodeScript}}
  • [FundRawTransaction][rpc fundrawtransaction]: {{summary_fundRawTransaction}} {{NEW0_12_0}}, {{UPDATED0_14_0}}
  • [GetRawTransaction][rpc getrawtransaction]: {{summary_getRawTransaction}} {{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}}

    • [EstimateSmartFee][rpc estimatesmartfee]: {{summary_estimateSmartFee}} {{DEPRECATED}}
    • [EstimateSmartPriority][rpc estimatesmartpriority]: {{summary_estimateSmartPriority}} {{DEPRECATED}}

  • [ValidateAddress][rpc validateaddress]: {{summary_validateAddress}} {{UPDATED0_13_0}}

  • [VerifyMessage][rpc verifymessage]: {{summary_verifyMessage}}

  • {{DASH_NOT_IMPLEMENTED}} [GetMemoryInfo][rpc getmemoryinfo]: {{summary_getMemoryInfo}} {{NEW_14_0}}

{% 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}}

  • [DumpPrivKey][rpc dumpprivkey]: {{summary_dumpPrivKey}}

  • [DumpWallet][rpc dumpwallet]: {{summary_dumpWallet}}

  • [EncryptWallet][rpc encryptwallet]: {{summary_encryptWallet}}

  • [GetAccount][rpc getaccount]: {{summary_getAccount}}

  • [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 importelecturmwallet]: {{summary_importElectrumWallet}} {{DASH_NEW0_12_1}}

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

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

Removed RPCs

{:.no_toc}

{% autocrossref %}

  • [GetHashesPerSec][rpc gethashespersec]: {{summary_getHashesPerSec}}
  • [GetWork][rpc getwork]: {{summary_getWork}}

{% endautocrossref %}