mirror of
https://github.com/seigler/dash-docs
synced 2025-07-27 09:46:12 +00:00
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
This commit is contained in:
thephez
GitHub
parent
17c265f5fd
commit
703c54ffbc
183 changed files with 9570 additions and 1373 deletions
|
|
@ -1,241 +0,0 @@
|
|||
{% comment %}
|
||||
This file is licensed under the MIT License (MIT) available on
|
||||
http://opensource.org/licenses/MIT.
|
||||
{% endcomment %}
|
||||
{% assign filename="_includes/devdoc/bitcoin-core/rpcs/quick-reference.md" %}
|
||||
|
||||
#### Quick Reference {#rpc-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 %}
|
||||
|
||||
<!-- Deprecated -->
|
||||
{% assign DEPRECATED='**<abbr title="Deprecated; will be removed in a future version of Bitcoin Core">Deprecated</abbr>**' %}
|
||||
|
||||
<!-- 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>**' %}
|
||||
|
||||
<!-- 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 UPDATED0_14_0='**<abbr title="Updated in Bitcoin Core v0.14.0">Updated in 0.14.0</abbr>**' %}
|
||||
|
||||
<!-- 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>*' %}
|
||||
|
||||
<!-- 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 UPDATED0_13_0='*<abbr title="Updated in Bitcoin Core v0.13.0">Updated in 0.13.0</abbr>*' %}
|
||||
|
||||
<!-- 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>*' %}
|
||||
|
||||
<!-- 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 UPDATED0_12_0='*<abbr title="Updated in Bitcoin Core v0.12.0">Updated in 0.12.0</abbr>*' %}
|
||||
|
||||
<!-- 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>*' %}
|
||||
|
||||
<!-- the summaries used below are defined in the files for the
|
||||
particular RPC and aggregated into this helper file by the makefile
|
||||
function manual-update-summaries-file. For example, to edit the
|
||||
summary for GetBestBlockHash, edit
|
||||
_includes/rpc/getbestblockhash.md and run `make manual-update-summaries`. -->
|
||||
{% include helpers/summaries.md %}
|
||||
|
||||
#### Block Chain RPCs
|
||||
{:.no_toc}
|
||||
<!-- no subhead-links here -->
|
||||
|
||||
{% 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}}
|
||||
* [GetBlockHeader][rpc getblockheader]: {{summary_getBlockHeader}} {{NEW0_12_0}}
|
||||
* [GetChainTips][rpc getchaintips]: {{summary_getChainTips}}
|
||||
* [GetDifficulty][rpc getdifficulty]: {{summary_getDifficultly}}
|
||||
* [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}}
|
||||
* [GetRawMemPool][rpc getrawmempool]: {{summary_getRawMemPool}} {{UPDATED0_13_0}}
|
||||
* [GetTxOut][rpc gettxout]: {{summary_getTxOut}}
|
||||
* [GetTxOutProof][rpc gettxoutproof]: {{summary_getTxOutProof}} {{NEW0_11_0}}
|
||||
* [GetTxOutSetInfo][rpc gettxoutsetinfo]: {{summary_getTxOutSetInfo}}
|
||||
* [PreciousBlock][rpc preciousblock]: {{summary_preciousBlock}} {{NEW0_14_0}}
|
||||
* [PruneBlockChain][rpc pruneblockchain]: {{summary_pruneBlockChain}} {{NEW0_14_0}}
|
||||
* [VerifyChain][rpc verifychain]: {{summary_verifyChain}}
|
||||
* [VerifyTxOutProof][rpc verifytxoutproof]: {{summary_verifyTxOutProof}} {{NEW0_11_0}}
|
||||
|
||||
{% endautocrossref %}
|
||||
|
||||
#### Control RPCs
|
||||
{:.no_toc}
|
||||
<!-- no subhead-links here -->
|
||||
|
||||
{% autocrossref %}
|
||||
|
||||
* [GetInfo][rpc getinfo]: {{summary_getInfo}} {{DEPRECATED}}
|
||||
* [Help][rpc help]: {{summary_help}}
|
||||
* [Stop][rpc stop]: {{summary_stop}}
|
||||
|
||||
{% endautocrossref %}
|
||||
|
||||
#### Generating RPCs
|
||||
{:.no_toc}
|
||||
<!-- no subhead-links here -->
|
||||
|
||||
{% autocrossref %}
|
||||
|
||||
* [Generate][rpc generate]: {{summary_generate}} {{NEW0_11_0}}, {{UPDATED0_13_0}}
|
||||
* [GenerateToAddress][rpc generatetoaddress]: {{summary_generateToAddress}} {{NEW0_13_0}}
|
||||
|
||||
{% endautocrossref %}
|
||||
|
||||
#### Mining RPCs
|
||||
{:.no_toc}
|
||||
<!-- no subhead-links here -->
|
||||
|
||||
{% 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}
|
||||
<!-- no subhead-links here -->
|
||||
|
||||
{% 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}
|
||||
<!-- no subhead-links here -->
|
||||
|
||||
{% autocrossref %}
|
||||
|
||||
* [CreateRawTransaction][rpc createrawtransaction]: {{summary_createRawTransaction}} {{UPDATED0_14_1}}
|
||||
* [FundRawTransaction][rpc fundrawtransaction]: {{summary_fundRawTransaction}} {{NEW0_12_0}}, {{UPDATED0_14_0}}
|
||||
* [DecodeRawTransaction][rpc decoderawtransaction]: {{summary_decodeRawTransaction}} {{UPDATED0_13_0}}
|
||||
* [DecodeScript][rpc decodescript]: {{summary_decodeScript}}
|
||||
* [GetRawTransaction][rpc getrawtransaction]: {{summary_getRawTransaction}} {{UPDATED0_14_0}}
|
||||
* [SendRawTransaction][rpc sendrawtransaction]: {{summary_sendRawTransaction}}
|
||||
* [SignRawTransaction][rpc signrawtransaction]: {{summary_signRawTransaction}}
|
||||
|
||||
{% endautocrossref %}
|
||||
|
||||
#### Utility RPCs
|
||||
{:.no_toc}
|
||||
<!-- no subhead-links here -->
|
||||
|
||||
{% autocrossref %}
|
||||
|
||||
* [CreateMultiSig][rpc createmultisig]: {{summary_createMultiSig}}
|
||||
* [EstimateFee][rpc estimatefee]: {{summary_estimateFee}} {{UPDATED0_14_0}}
|
||||
* [EstimatePriority][rpc estimatepriority]: {{summary_estimatePriority}} {{DEPRECATED}}
|
||||
* [GetMemoryInfo][rpc getmemoryinfo]: {{summary_getMemoryInfo}} {{NEW_14_0}}
|
||||
* [ValidateAddress][rpc validateaddress]: {{summary_validateAddress}} {{UPDATED0_13_0}}
|
||||
* [VerifyMessage][rpc verifymessage]: {{summary_verifyMessage}}
|
||||
|
||||
{% endautocrossref %}
|
||||
|
||||
#### Wallet RPCs
|
||||
{:.no_toc}
|
||||
<!-- no subhead-links here -->
|
||||
|
||||
{% autocrossref %}
|
||||
|
||||
**Note:** the wallet RPCs are only available if Bitcoin Core was built
|
||||
with [wallet support][]{:#term-wallet-support}{:.term}, which is the
|
||||
default.
|
||||
|
||||
* [AbandonTransaction][rpc abandontransaction]: {{summary_abandonTransaction}} {{NEW0_12_0}}
|
||||
* [AddWitnessAddress][rpc addwitnessaddress]: {{summary_addWitnessAddress}} {{NEW0_13_0}}
|
||||
* [AddMultiSigAddress][rpc addmultisigaddress]: {{summary_addMultiSigAddress}}
|
||||
* [BackupWallet][rpc backupwallet]: {{summary_backupWallet}}
|
||||
* [BumpFee][rpc bumpfee]: {{summary_bumpFee}} {{NEW0_14_0}}
|
||||
* [DumpPrivKey][rpc dumpprivkey]: {{summary_dumpPrivKey}}
|
||||
* [DumpWallet][rpc dumpwallet]: {{summary_dumpWallet}}
|
||||
* [EncryptWallet][rpc encryptwallet]: {{summary_encryptWallet}}
|
||||
* [GetAccountAddress][rpc getaccountaddress]: {{summary_getAccountAddress}} {{DEPRECATED}}
|
||||
* [GetAccount][rpc getaccount]: {{summary_getAccount}}
|
||||
* [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}}
|
||||
* [ImportMulti][rpc importmulti]: {{summary_importMulti}} {{NEW0_14_0}}
|
||||
* [ImportPrunedFunds][rpc importprunedfunds]: {{summary_importPrunedFunds}} {{NEW0_13_0}}
|
||||
* [ImportPrivKey][rpc importprivkey]: {{summary_importPrivKey}}
|
||||
* [ImportWallet][rpc importwallet]: {{summary_importWallet}}
|
||||
* [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}}
|
||||
* [RemovePrunedFunds][rpc removeprunedfunds]: {{summary_removePrunedFunds}} {{NEW0_13_0}}
|
||||
* [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}}
|
||||
* [SignMessageWithPrivKey][rpc signmessagewithprivkey]: {{summary_signMessageWithPrivKey}} {{NEW0_13_0}}
|
||||
* [WalletLock][rpc walletlock]: {{summary_walletLock}}
|
||||
* [WalletPassphrase][rpc walletpassphrase]: {{summary_walletPassphrase}}
|
||||
* [WalletPassphraseChange][rpc walletpassphrasechange]: {{summary_walletPassphraseChange}}
|
||||
|
||||
{% endautocrossref %}
|
||||
|
||||
#### Removed RPCs
|
||||
{:.no_toc}
|
||||
<!-- no subhead-links here -->
|
||||
|
||||
{% autocrossref %}
|
||||
|
||||
* [GetGenerate][rpc getgenerate]: {{summary_getGenerate}}
|
||||
* [GetHashesPerSec][rpc gethashespersec]: {{summary_getHashesPerSec}}
|
||||
* [GetWork][rpc getwork]: {{summary_getWork}}
|
||||
* [SetGenerate][rpc setgenerate]: {{summary_setGenerate}}
|
||||
|
||||
{% endautocrossref %}
|
||||
Loading…
Add table
Add a link
Reference in a new issue