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

Update some reference documents

Browse source 
- Adjust ref_intro to reference Dash
 - Start updating p2p network ref
 - Adjust some items in references.md to point to Dash URLs
This commit is contained in:
thephez 2017-09-05 14:04:39 -04:00
parent 788e378280
commit f82767d1f1
3 changed files with 45 additions and 46 deletions
Download patch file Download diff file Expand all files Collapse all files

25
_includes/devdoc/ref_intro.md
View file

@ -7,15 +7,15 @@ http://opensource.org/licenses/MIT.
{% autocrossref %} {% autocrossref %}
The Developer Reference aims to provide technical details and API information The Developer Reference aims to provide technical details and API information
to help you start building Bitcoin-based applications, but it is [not a to help you start building Dash-based applications, but it is [not a
specification][]. To make the best use of specification][]. To make the best use of
this documentation, you may want to install the current version of Bitcoin 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]. Core, either from [source][core git] or from a [pre-compiled executable][core executable].
Questions about Bitcoin development are best asked in one of the Questions about Dash development are best asked in one of the
[Bitcoin development communities][dev communities]. [Dash development communities][dev communities].
Errors or suggestions related to Errors or suggestions related to
documentation on Bitcoin.org can be [submitted as an issue][docs issue] documentation on {Dash.org} can be [submitted as an issue][docs issue]
or posted to the [bitcoin-documentation mailing list][]. or posted to the [bitcoin-documentation mailing list][].
In the following documentation, some strings have been shortened or wrapped: "[...]" In the following documentation, some strings have been shortened or wrapped: "[...]"
@ -32,18 +32,18 @@ definition of the term will be displayed in a tooltip.
{% autocrossref %} {% autocrossref %}
The Bitcoin.org Developer Documentation describes how Bitcoin works to The {Dash.org} Developer Documentation describes how Dash works to
help educate new Bitcoin developers, but it is not a specification---and help educate new Dash developers, but it is not a specification---and
it never will be. it never will be.
Bitcoin security depends on consensus. Should your program diverge from Dash security depends on consensus. Should your program diverge from
consensus, its security is weakened or destroyed. The cause of the 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 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 be an [error in this documentation][errors in docs] which you
implemented as described, or it could be you do everything right but implemented as described, or it could be you do everything right but
other software on the network [behaves unexpectedly][v0.8 chain other software on the network [behaves unexpectedly][v0.8 chain
fork]. The specific cause will not matter to the users of your software fork] as in the case of Bitcoin's v0.8 chain fork. The specific cause
whose wealth is lost. will not matter to the users of your software whose wealth is lost.
The only correct specification of consensus behavior is the actual The only correct specification of consensus behavior is the actual
behavior of programs on the network which maintain consensus. As that behavior of programs on the network which maintain consensus. As that
@ -51,15 +51,16 @@ behavior is subject to arbitrary inputs<!--noref--> in a large variety
of unique environments, it cannot ever be fully documented here or of unique environments, it cannot ever be fully documented here or
anywhere else. anywhere else.
<!--Is this true for Dash???
However, the Bitcoin Core developers are working on making their However, the Bitcoin Core developers are working on making their
consensus code portable so other implementations can use it. Bitcoin consensus code portable so other implementations can use it. Bitcoin
Core 0.10.0 will provide `libbitcoinconsensus`, a first attempt at Core 0.10.0 will provide `libbitcoinconsensus`, a first attempt at
exporting some consensus code. Future versions of Bitcoin Core will exporting some consensus code. Future versions of Bitcoin Core will
likely provide consensus code that is more complete, more portable, and likely provide consensus code that is more complete, more portable, and
more consistent in diverse environments. more consistent in diverse environments.
-->
In addition, we also warn you that this documentation has not been In addition, we also warn you that this documentation has not been
extensively reviewed by Bitcoin experts and so likely contains numerous 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 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. 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 Please use those links if you find any errors or important missing

30
_includes/devdoc/ref_p2p_networking.md
View file

@ -9,11 +9,11 @@ http://opensource.org/licenses/MIT.
{% autocrossref %} {% autocrossref %}
This section describes the Bitcoin P2P network protocol (but it is [not a This section describes the Dash P2P network protocol (but it is [not a
specification][]). It does not describe the discontinued direct [IP-to-IP specification][]). It does not describe the
payment protocol][], the [BIP70 payment protocol][/en/glossary/payment-protocol], the [BIP70 payment protocol][/en/glossary/payment-protocol], the
[GetBlockTemplate mining protocol][section getblocktemplate], or any [GetBlockTemplate mining protocol][section getblocktemplate], or any
network protocol never implemented in an official version of Bitcoin Core. network protocol never implemented in an official version of Dash Core.
All peer-to-peer communication occurs entirely over TCP. All peer-to-peer communication occurs entirely over TCP.
@ -27,27 +27,25 @@ integers mentioned in this section are transmitted in little-endian order.
{% autocrossref %} {% autocrossref %}
The following constants and defaults are taken from Bitcoin Core's The following constants and defaults are taken from Dash Core's
[chainparams.cpp][core chainparams.cpp] source code file. [chainparams.cpp][core chainparams.cpp] source code file.
| Network | Default Port | [Start String][/en/glossary/start-string]{:#term-start-string}{:.term} | Max nBits | Network | Default Port | Magic Value | [Start String][/en/glossary/start-string]{:#term-start-string}{:.term} | Max nBits
|---------|--------------|-----------------------------------------------|--------------- |---------|--------------|-----------------------------------------------|---------------
| Mainnet | 8333 | 0xf9beb4d9 | 0x1d00ffff | Mainnet | 9999 | 0xBD6B0CBF | 0xBF0C6BBD | 0x1e0ffff0
| Testnet | 18333 | 0x0b110907 | 0x1d00ffff | Testnet | 19999 | 0xFFCAE2CE | 0xCEE2CAFF | 0x1e0ffff0
| Regtest | 18444 | 0xfabfb5da | 0x207fffff | Regtest | 19994 | 0xDCB7C1FC | 0xFCC1B7DC | 0x207fffff
Note: the testnet start string and nBits above are for testnet3; the Note: the testnet start string and nBits above are for testnet3.
original testnet used a different string and higher (less difficult)
nBits.
Command line parameters can change what port a node listens on (see Command line parameters can change what port a node listens on (see
`-help`). Start strings are hardcoded constants that appear at the start `-help`). Start strings are hardcoded constants that appear at the start
of all messages sent on the Bitcoin network; they may also appear in of all messages sent on the Bitcoin network; they may also appear in
data files such as Bitcoin Core's block database. The nBits displayed data files such as Dash Core's block database. The Magic Value and nBits
above are in big-endian order; they're sent over the network in displayed above are in big-endian order; they're sent over the network in
little-endian order. little-endian order. The Start String is simply the endian reversed Magic Value.
Bitcoin Core's [chainparams.cpp][core chainparams.cpp] also includes Dash Core's [chainparams.cpp][core chainparams.cpp] also includes
other constants useful to programs, such as the hash of the genesis other constants useful to programs, such as the hash of the genesis
blocks for the different networks. blocks for the different networks.

36
_includes/references.md
View file

@ -261,8 +261,8 @@ http://opensource.org/licenses/MIT.
[bitcoinpdf]: https://bitcoin.org/en/bitcoin-paper [bitcoinpdf]: https://bitcoin.org/en/bitcoin-paper
[choose your wallet]: /en/choose-your-wallet [choose your wallet]: /en/choose-your-wallet
[communities]: /en/community [communities]: /en/community
[core executable]: /en/download [core executable]: https://www.dash.org/wallets/#wallets
[dev communities]: /en/development#devcommunities [dev communities]: https://www.dash.org/community/
[developer documentation]: /en/developer-documentation [developer documentation]: /en/developer-documentation
[devex complex raw transaction]: /en/developer-examples#complex-raw-transaction [devex complex raw transaction]: /en/developer-examples#complex-raw-transaction
[devex payment protocol]: /en/developer-examples#payment-protocol [devex payment protocol]: /en/developer-examples#payment-protocol
@ -347,12 +347,12 @@ http://opensource.org/licenses/MIT.
[#bitcoin-mining]: https://webchat.freenode.net/?channels=bitcoin-mining&uio=d4 [#bitcoin-mining]: https://webchat.freenode.net/?channels=bitcoin-mining&uio=d4
[#bitcoin-wiki]: https://webchat.freenode.net/?channels=bitcoin-wiki&uio=d4 [#bitcoin-wiki]: https://webchat.freenode.net/?channels=bitcoin-wiki&uio=d4
[0bin]: http://0bin.net/ [0bin]: http://0bin.net/
[bcc automated testing]: https://github.com/bitcoin/bitcoin/blob/master/README.md#automated-testing [bcc automated testing]: https://github.com/dashpay/dash/blob/master/README.md#automated-testing
[bcc configuration]: https://en.bitcoin.it/wiki/Running_Bitcoin [bcc configuration]: https://en.bitcoin.it/wiki/Running_Bitcoin
[bcc data directory]: https://en.bitcoin.it/wiki/Data_directory [bcc data directory]: https://en.bitcoin.it/wiki/Data_directory
[bcc issues]: https://github.com/bitcoin/bitcoin/issues [bcc issues]: https://github.com/dashpay/dash/issues
[bcc new issue]: https://github.com/bitcoin/bitcoin/issues/new [bcc new issue]: https://github.com/dashpay/dash/issues/new
[bcc pulls]: https://github.com/bitcoin/bitcoin/pulls [bcc pulls]: https://github.com/dashpay/dash/pulls
[bcc tor]: https://en.bitcoin.it/wiki/Tor [bcc tor]: https://en.bitcoin.it/wiki/Tor
[bcc tor hs]: https://en.bitcoin.it/wiki/Tor#Hidden_services [bcc tor hs]: https://en.bitcoin.it/wiki/Tor#Hidden_services
[core github tag]: https://github.com/bitcoin-dot-org/bitcoin.org/labels/Core [core github tag]: https://github.com/bitcoin-dot-org/bitcoin.org/labels/Core
@ -364,11 +364,11 @@ http://opensource.org/licenses/MIT.
[Bitcoin Core 0.3.11]: https://github.com/bitcoin/bitcoin/commit/343328c6b8db85e58a1feea85f0d10e62967fa19 [Bitcoin Core 0.3.11]: https://github.com/bitcoin/bitcoin/commit/343328c6b8db85e58a1feea85f0d10e62967fa19
[Bitcoin Core 0.3.15]: https://github.com/bitcoin/bitcoin/commit/c891967b6fcab2e8dc4ce0c787312b36c07efa4d [Bitcoin Core 0.3.15]: https://github.com/bitcoin/bitcoin/commit/c891967b6fcab2e8dc4ce0c787312b36c07efa4d
[Bitcoin Core 0.3.18]: https://github.com/bitcoin/bitcoin/commit/82201801336f64ee77851b9eaab9383ee4e442f0 [Bitcoin Core 0.3.18]: https://github.com/bitcoin/bitcoin/commit/82201801336f64ee77851b9eaab9383ee4e442f0
[Bitcoin Core build unix]: https://github.com/bitcoin/bitcoin/blob/master/doc/build-unix.md [Bitcoin Core build unix]: https://github.com/dashpay/dash/blob/master/doc/build-unix.md
[Bitcoin Core docs directory]: https://github.com/bitcoin/bitcoin/tree/master/doc [Bitcoin Core docs directory]: https://github.com/dashpay/dash/tree/master/doc
[bitcoin core fee drop commit]: https://github.com/bitcoin/bitcoin/commit/6a4c196dd64da2fd33dc7ae77a8cdd3e4cf0eff1 [bitcoin core fee drop commit]: https://github.com/bitcoin/bitcoin/commit/6a4c196dd64da2fd33dc7ae77a8cdd3e4cf0eff1
[Bitcoin Core issue #2381]: https://github.com/bitcoin/bitcoin/issues/2381 [Bitcoin Core issue #2381]: https://github.com/bitcoin/bitcoin/issues/2381
[Bitcoin Core master]: https://github.com/bitcoin/bitcoin [Bitcoin Core master]: https://github.com/dashpay/dash
[Bitcoin Core pull #4468]: https://github.com/bitcoin/bitcoin/pull/4468 [Bitcoin Core pull #4468]: https://github.com/bitcoin/bitcoin/pull/4468
[Bitcoin core transifex]: https://www.transifex.com/projects/p/bitcoin/ [Bitcoin core transifex]: https://www.transifex.com/projects/p/bitcoin/
[Bitcoin reddit]: http://www.reddit.com/r/Bitcoin [Bitcoin reddit]: http://www.reddit.com/r/Bitcoin
@ -382,22 +382,22 @@ http://opensource.org/licenses/MIT.
[bitcoinj micropayment tutorial]: https://bitcoinj.github.io/working-with-micropayments [bitcoinj micropayment tutorial]: https://bitcoinj.github.io/working-with-micropayments
[block170]: https://www.biteasy.com/block/00000000d1145790a8694403d4063f323d499e655c83426834d4ce2f8dd4a2ee [block170]: https://www.biteasy.com/block/00000000d1145790a8694403d4063f323d499e655c83426834d4ce2f8dd4a2ee
[casascius address utility]: https://github.com/casascius/Bitcoin-Address-Utility [casascius address utility]: https://github.com/casascius/Bitcoin-Address-Utility
[core base58.h]: https://github.com/bitcoin/bitcoin/blob/master/src/base58.h [core base58.h]: https://github.com/dashpay/dash/blob/master/src/base58.h
[core chainparams.cpp]: https://github.com/bitcoin/bitcoin/blob/master/src/chainparams.cpp [core chainparams.cpp]: https://github.com/dashpay/dash/blob/master/src/chainparams.cpp
[core git]: https://github.com/bitcoin/bitcoin [core git]: https://github.com/dashpay/dash/
[core paymentrequest.proto]: https://github.com/bitcoin/bitcoin/blob/master/src/qt/paymentrequest.proto [core paymentrequest.proto]: https://github.com/dashpay/dash/blob/master/src/qt/paymentrequest.proto
[core script.h]: https://github.com/bitcoin/bitcoin/blob/master/src/script/script.h [core script.h]: https://github.com/dashpay/dash/blob/master/src/script/script.h
[creative commons attribution 3.0 license]: https://creativecommons.org/licenses/by/3.0/ [creative commons attribution 3.0 license]: https://creativecommons.org/licenses/by/3.0/
[DER]: https://en.wikipedia.org/wiki/X.690#DER_encoding [DER]: https://en.wikipedia.org/wiki/X.690#DER_encoding
[dig command]: https://en.wikipedia.org/wiki/Dig_%28Unix_command%29 [dig command]: https://en.wikipedia.org/wiki/Dig_%28Unix_command%29
[DNS A records]: http://tools.ietf.org/html/rfc1035#section-3.2.2 [DNS A records]: http://tools.ietf.org/html/rfc1035#section-3.2.2
[DNS Seed Policy]: https://github.com/bitcoin/bitcoin/blob/master/doc/dnsseed-policy.md [DNS Seed Policy]: https://github.com/dashpay/dash/blob/master/doc/dnsseed-policy.md
[docs issue]: https://github.com/bitcoin-dot-org/bitcoin.org/issues [docs issue]: https://github.com/thephez/dash.org/issues
[ECDSA]: https://en.wikipedia.org/wiki/Elliptic_Curve_DSA [ECDSA]: https://en.wikipedia.org/wiki/Elliptic_Curve_DSA
[edit bandwidth sharing guide]: https://github.com/bitcoin-dot-org/bitcoin.org/edit/master/en/full-node.md [edit bandwidth sharing guide]: https://github.com/bitcoin-dot-org/bitcoin.org/edit/master/en/full-node.md
[Electrum server]: https://github.com/spesmilo/electrum-server [Electrum server]: https://github.com/spesmilo/electrum-server
[Eloipool]: https://github.com/luke-jr/eloipool [Eloipool]: https://github.com/luke-jr/eloipool
[errors in docs]: https://github.com/bitcoin-dot-org/bitcoin.org/issues?q=is%3Aissue+label%3A%22Dev+Docs%22 [errors in docs]: https://github.com/thephez/dash.org/issues?q=is%3Aissue+label%3A%22Dev+Docs%22
[fake satoshi transaction]: https://www.reddit.com/r/Bitcoin/comments/3fv42j/blockchaininfo_spoofed_transactions_problem_aug_4/ [fake satoshi transaction]: https://www.reddit.com/r/Bitcoin/comments/3fv42j/blockchaininfo_spoofed_transactions_problem_aug_4/
[forum tech support]: https://bitcointalk.org/index.php?board=4.0 [forum tech support]: https://bitcointalk.org/index.php?board=4.0
[ghash betcoin double spend]: https://bitcointalk.org/index.php?topic=321630.msg3445371 [ghash betcoin double spend]: https://bitcointalk.org/index.php?topic=321630.msg3445371
@ -417,7 +417,7 @@ http://opensource.org/licenses/MIT.
[libblkmaker]: https://github.com/bitcoin/libblkmaker [libblkmaker]: https://github.com/bitcoin/libblkmaker
[localhost]: https://en.wikipedia.org/wiki/Localhost [localhost]: https://en.wikipedia.org/wiki/Localhost
[lying consistently is hard]: https://groups.google.com/forum/#!msg/bitcoinj/Ys13qkTwcNg/9qxnhwnkeoIJ [lying consistently is hard]: https://groups.google.com/forum/#!msg/bitcoinj/Ys13qkTwcNg/9qxnhwnkeoIJ
[makeseeds script]: https://github.com/bitcoin/bitcoin/tree/master/contrib/seeds [makeseeds script]: https://github.com/dashpay/dash/tree/master/contrib/seeds
[mozilla's bug reporting documentation]: https://developer.mozilla.org/en-US/docs/Mozilla/QA/Bug_writing_guidelines#Writing_precise_steps_to_reproduce [mozilla's bug reporting documentation]: https://developer.mozilla.org/en-US/docs/Mozilla/QA/Bug_writing_guidelines#Writing_precise_steps_to_reproduce
[murmur3]: https://en.wikipedia.org/wiki/MurmurHash [murmur3]: https://en.wikipedia.org/wiki/MurmurHash
[man-in-the-middle]: https://en.wikipedia.org/wiki/Man-in-the-middle_attack [man-in-the-middle]: https://en.wikipedia.org/wiki/Man-in-the-middle_attack