mirror of
https://github.com/seigler/dash-docs
synced 2025-07-27 17:56:16 +00:00
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
68 lines
3 KiB
Markdown
68 lines
3 KiB
Markdown
{% comment %}
|
|
This file is licensed under the MIT License (MIT) available on
|
|
http://opensource.org/licenses/MIT.
|
|
{% endcomment %}
|
|
{% assign filename="_includes/devdoc/ref_intro.md" %}
|
|
|
|
{% autocrossref %}
|
|
|
|
The Developer Reference aims to provide technical details and API information
|
|
to help you start building Dash-based applications, but it is [not a
|
|
specification][]. To make the best use of
|
|
this documentation, you may want to install the current version of Dash
|
|
Core, either from [source][core git] or from a [pre-compiled executable][core executable].
|
|
|
|
Questions about Dash development are best asked in one of the
|
|
[Dash development communities][dev communities].
|
|
Errors or suggestions related to
|
|
documentation on {Dash.org} can be [submitted as an issue][docs issue].
|
|
|
|
In the following documentation, some strings have been shortened or wrapped: "[...]"
|
|
indicates extra data was removed, and lines ending in a single backslash "\\"
|
|
are continued below. If you hover your mouse over a paragraph, cross-reference
|
|
links will be shown in blue. If you hover over a cross-reference link, a brief
|
|
definition of the term will be displayed in a tooltip.
|
|
|
|
{% endautocrossref %}
|
|
|
|
#### Not A Specification
|
|
{:.no_toc}
|
|
{% include helpers/subhead-links.md %}
|
|
|
|
{% autocrossref %}
|
|
|
|
The {Dash.org} Developer Documentation describes how Dash works to
|
|
help educate new Dash developers, but it is not a specification---and
|
|
it never will be.
|
|
|
|
Dash security depends on consensus. Should your program diverge from
|
|
consensus, its security is weakened or destroyed. The cause of the
|
|
divergence doesn't matter: it could be a bug in your program, it could
|
|
be an [error in this documentation][errors in docs] which you
|
|
implemented as described, or it could be you do everything right but
|
|
other software on the network [behaves unexpectedly][v0.8 chain
|
|
fork] as in the case of Bitcoin's v0.8 chain fork. The specific cause
|
|
will not matter to the users of your software whose wealth is lost.
|
|
|
|
The only correct specification of consensus behavior is the actual
|
|
behavior of programs on the network which maintain consensus. As that
|
|
behavior is subject to arbitrary inputs<!--noref--> in a large variety
|
|
of unique environments, it cannot ever be fully documented here or
|
|
anywhere else.
|
|
|
|
<!--Is this true for Dash???
|
|
However, the Bitcoin Core developers are working on making their
|
|
consensus code portable so other implementations can use it. Bitcoin
|
|
Core 0.10.0 will provide `libbitcoinconsensus`, a first attempt at
|
|
exporting some consensus code. Future versions of Bitcoin Core will
|
|
likely provide consensus code that is more complete, more portable, and
|
|
more consistent in diverse environments.
|
|
-->
|
|
In addition, we also warn you that this documentation has not been
|
|
extensively reviewed by Dash experts and so likely contains numerous
|
|
errors. At the bottom of the menu on the left, you will find links that
|
|
allow you to report an issue or to edit the documentation on GitHub.
|
|
Please use those links if you find any errors or important missing
|
|
information.
|
|
|
|
{% endautocrossref %}
|