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
Added a node glossary term
Added descriptions of full nodes, archival nodes, and pruned nodes to the dev guide.
Linked the term "peer" to node instead of original location.
This reverts commit e3dcf0ce1f, reversing
changes made to c71e9fdf2d.
Once again we had a broken new plugin that Travis CI and local building
didn't catch.
* Add flowchart illustration to blocks-first section to match new
headers-first flowchart
* Add new headers-first initial block download (IBD) section
* Revise Block Broadcasting section
* Add paragraph about orphan block handling in headers-first to the
Orphan Blocks section
* Ran `make manual-updates` to grab new summary
* Clarified that GHPS is part of 0.10.0 and is removed in master
* Autocrossref'd "Bitcoin Core master" to GitHub repo
* Removed GHPS from list of Mining RPCs now that it's in Removed RPCs
This commit provides a detailed overview of the current block download
method, which I've retroactively named blocks-first for parallelism with
headers-first.
New And Significantly Revised:
* New Initial Block Download (IBD) section (h3) with Blocks-First
subsection (h4)
* New Orphan Block subsection (under Blocks Broadcasting) describing
orphan blocks and how they're handled under blocks-first. Also
includes a simple illustration of the difference between orphan blocks
and stale blocks. Thanks to luke-jr for his s/orphan block/stale
block/ commit a couple months ago---that made this commit much easier.
Edits:
* Cleaned up a couple cases missed by previous s/orphan/stale/ commit
because they used past tense (orphaned).
* In P2P reference section, mentioned that a `block` message can be sent
unsolicited by miners.
* Mention that `getheaders` and `headers` were added in protocol
version 31800.
* Moved a few internal links around and added a few new internal links.
Administrivia:
* Started adding "TODOv0.10" in HTML comments to places that need to be
updated when 0.10 is released so that I can easily git grep for that
tag later.
* All previously-documented RPCs have had their text completely
rewritten.
* All new RPCs and changed RPCs in Bitcoin Core 0.10.0 have been
documented, except for hidden RPCs.
* A new RPC "Quick Reference" section has been added to make finding the
right RPC easier.
* A "See Also" subsection has been added to the end of every RPC
pointing to other relevant information.
* All previous examples in the RPC section have been re-run and updated
as necessary.
* Syntax highlighting has been added wherever possible.
* Hash byte order has been specified as RPC byte order everywhere it's
used in RPCs.
New material:
* Add documentation for `filterload` message to devref. This is the last
P2P protocol message which needed documentation.
* Add an example for creating a bloom filter to the devex, as well as an
example of checking data against that filter.
Edits:
* Change "object" to "element" in previous `filteradd` text. I decided
"transaction element" made more sense than the more generic "object".
Text should be fully consistent across both `filterload` and
`filteradd` descriptions.
* Mentioned that I think the example hexdump in the `alert` section is
public domain. (Only the hex is taken from the wiki; the annotation is
my own work.)
* Describes all remaining messages except filterload. Specificially, the
following messages are described: Addr, Alert, FilterAdd, FilterClear,
GetAddr, Ping, Pong, Reject, VerAck, and Version
* New makefile test: report broken markdown tables
* Put relevant protocol version changes at the top of all message
subsections.
Adds to the devel reference page detailed documentation on the following
messages: block, getblocks, getdata, getheaders, headers, inv, mempool,
merkleblock, notfound, and tx.
Adds to the devel examples page an example of requesting and parsing a
merkleblock message.
Adds to the devel docs overview pages links to the above two new
P2P sections.
Tweaks the autocrossref plugin ignore pattern to not crossref in the
middle of a GIF image name; this allows the inclusion of animated GIFs.
* Replace current description of the block header with a better
description.
* Describe the various version numbers.
* Describe how the merkle root is constructed.
* Describe how nBits is parsed and how to correctly create it to
avoid negative values.
* Describe the serialized block format used to calculate max block size.
Provides a detailed description of the transaction format, replacing an
example hexdump taken from the wiki.
I'm putting this in the transaction section as the format is necessary
for the creation of txids, which are used as merkle leaves (so are
covered by consensus rules). However, this is also the format used by
several P2P network messages to transmit transactions, so I'll be
linking back to it from there as I document those messages.
* Revise P2P Networking section to provide a more detailed description
of initial peer discovery and DNS seeds.
* Tweak autocrossref.rb to allow term blacklisting. Use this new feature
to prevent cross referencing "address" in "IP address" to the
definition of Bitcoin P2PKH/P2SH addresses. This avoids a bunch of
manual "norefs".
Based on a suggestion made by @petertodd to the -devel mailing list and
the discussion in that thread by him and other participants.
* We've been using the term "consensus", but this commit introduces a
formal definition for it and "consensus rules" as part of the block
chain introduction.
* Describe that consensus rules may change and may happen when they
do: hard or soft forks.
* Describe how full nodes can detect hard or soft forks, then describe
how SPV clients can detect hard and soft forks using the more limited
information available to them.
* Add a short subsection about the different byte orders used with
hashes in Bitcoin Core and other software.
* Re-word some text in other sections to mention the byte order
differences
This commit created based on comments from @SergioDemianLerner (thanks!)
