Commit graph

621 commits

Author SHA1 Message Date
David A. Harding
25dc0228f6 Merge remote-tracking branch 'saivann/protocolversions' into control-messages 2014-11-20 20:39:20 -05:00
Saivann
12685e71f3 Fix a few typos 2014-11-20 19:49:16 -05:00
Saivann
022ad12eaf Normalize references to protocol versions 2014-11-20 19:41:03 -05:00
David A. Harding
ff9c3f9886
Dev Docs: Warn That GetWork RPC Will Be Removed In 0.10
Just saw this mentioned in IRC and it's a trivial change.
2014-11-18 10:31:43 -05:00
David A. Harding
a149ae1f37
Dev Docs: Describe Almost All Remaining P2P Network Messages
* 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.
2014-11-17 01:23:11 -05:00
David A. Harding
e29104fb82
Dev Docs: Fix Broken BitcoinJ Link
The makefile tests caught this, but it looks like I broke it back in
4553439e. Strangely, I did a full build before merging that commit---and
several more full builds since---and this is the first I'm noticing the
error. I'm fixing the broken link now; I'll look into the tests later.
2014-11-16 13:35:16 -05:00
David A. Harding
cc13a10623
Merge branch 'data-messages' (pull #642) 2014-11-16 13:20:54 -05:00
Saivann
bf2a40bdb7 Update hu translations 2014-11-15 16:21:14 -05:00
David A. Harding
9ee7b8b73b
Dev Docs: Fix Typos/Confusions In P2P Data Messages As Reported By @saivann (Thanks!) 2014-11-15 12:12:56 -05:00
David A. Harding
ade6d1aca1
Dev Docs: Tweak Revised Protocol Versions Table Style 2014-11-15 10:41:51 -05:00
Saivann
0437d7c434 Format "protocol versions" table content to improve readability 2014-11-14 20:01:33 -05:00
David A. Harding
1634212dd5
Dev Docs: Add P2P Messages That Request Or Reply With Data
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.
2014-11-12 12:39:36 -05:00
saivann
b9a6c105a1 Merge pull request #636 from bitcoin/bits
Add mentions and definitions for bits
2014-11-11 12:13:36 -05:00
Saivann
01bf6de924 Revert another mention for "bits" 2014-11-11 12:12:27 -05:00
David A. Harding
63b4d03400
Dev Docs: Merkle Tree/nBits Minor Proofreading Edits
Based on feedback from @saivann (thanks!)
2014-11-08 16:39:01 -05:00
Saivann
7a8493124a Display uBTC and bits on a single row 2014-11-08 12:36:17 -05:00
Saivann
8bb1b18498 Drop post-decimal delimiter (thanks @luke-jr) 2014-11-08 11:10:10 -05:00
Saivann
604473059d Add mention for uBTC (thanks @luke-jr) 2014-11-08 11:09:30 -05:00
David A. Harding
a8f8f750c8
Dev Docs: Describe Serialized Block Header And Block Format
* 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.
2014-11-07 22:50:27 -05:00
Saivann
adaba05941 Add mentions and definitions for bits 2014-11-07 19:13:32 -05:00
David A. Harding
6ae33424e5
Change Text Alignment & Fix Some Typos
* Replaced text justification with left-align (raggedright) for all text
  in dev docs.

    * Removed previous manual left-align in RPC byte order table

* Changed placement of See Below text partly based on a suggestion by
  @saivann (thanks!)

* Normalized capitialization of special structures (e.g. s/TxIn/txIn/)
  to be consistent with some other parts of the docs. (I don't think
  we're fully consistent on this in all parts of the docs. I'll put a
  rule in the style guide today and then we can make changes on the next
  global proofread.)

* Fixed missing period found by @saivann (thanks!) and a related missing
  preposition.
2014-11-04 14:30:57 -05:00
David A. Harding
0af6ef09ff
Dev Docs: Detail Transaction Format
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.
2014-11-02 22:21:36 -05:00
David A. Harding
ea6e486fea
Merge branch 'checkmsig-order' (pull #623) 2014-10-29 11:12:14 -04:00
David A. Harding
10f6de368d
Treat Mainnet And Testnet As Common Nouns, Lowercasing When Appropriate
Suggested by @saivann (thanks!)
2014-10-29 08:16:59 -04:00
David A. Harding
1ec71148da
Dev Docs Correction: CHECKMULTISIG Requires Sigs In Same Order As PubKeys
As reported by @gsalgado (thanks!), the docs incorrectly state that all
sigs are compared against all pubkeys.  This commit provides a corrected
description, additional details, and references in other parts of the
text where we mention multisig. (Fixes #622)
2014-10-28 21:33:26 -04:00
David A. Harding
1604ed54e3
Describe Hardcoded Peers & BCCore Command-Line Fallbacks
Suggested by @gmaxwell (thanks!)
2014-10-25 18:02:25 -04:00
David A. Harding
4553439eda
Dev Docs: Describe Initial Peer Discovery & DNS Seeds
* 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".
2014-10-25 16:14:32 -04:00
David A. Harding
0f8504e204
Reorder Links (No URL Or Text Changes) & Fix Tiny Typo
* Sorted the _includes/references.md file as it became unclear where
  links should be added.

* Fixed accidentally lowercased "merkle" at start of sentence.
2014-10-25 15:12:55 -04:00
David A. Harding
d5900e3df4
Merge branches 'consensus-forking' (pull #615) and 'byte-order' (pull #583) 2014-10-25 14:57:07 -04:00
David A. Harding
a59b576abc
Link To Detecting Forks From Verifying Payment Section (thanks @saivann!) 2014-10-24 09:45:13 -04:00
David A. Harding
2e8ceb26df
Describe Soft And Hard Forks
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.
2014-10-24 09:44:50 -04:00
David A. Harding
1061571b13
Revise Note About Op Codes In Signature Scripts (closes #563)
Based on text and revisions by @petertodd and @luke-jr in pull #563.
2014-10-23 16:03:26 -04:00
David A. Harding
e65d86de21
Mention Bitcoin's RPC Hash Byte Order
* 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!)
2014-10-23 14:53:52 -04:00
Saivann
5959721141 Fix a typo 2014-10-23 14:48:03 -04:00
David A. Harding
2147b830f1
Merge branch 'devhelp' (pull #595) 2014-10-06 18:09:09 -04:00
David A. Harding
a3f687142d
Use Mirror For Secg Paper. Closes #598 (thanks @alecalve!) 2014-10-04 15:22:11 -04:00
David A. Harding
1a305a735a
Add "Developer Communities" To Development Page
* Adds the #bitcoin-dev IRC channel, Bitcoin StackExchange, and
  BitcoinTalk Dev & Tech board to the development page.

* Links to that section of the page from the devel docs.
2014-10-04 11:22:53 -04:00
Saivann
89b86f6b66 Merge remote-tracking branch 'remotes/luke-jr/master' into master 2014-10-03 15:36:09 -04:00
Luke Dashjr
f85c631cae DevDocs: Block Chain: Transaction Data: Many corrections 2014-10-03 19:17:44 +00:00
Luke Dashjr
66edff8d73 DevDocs: Block Chain: Block Height and Forking: Many corrections 2014-10-03 19:17:44 +00:00
David A. Harding
69125fd86c
Link Dust Limit (546 sat) To Bitcoin Core Commit 614c196 (closes #592) 2014-10-03 11:34:08 -04:00
Luke Dashjr
24708ae969 DevDocs: Block Chain: Proof of Work: Many corrections 2014-10-02 01:34:07 +00:00
Luke Dashjr
71f6b293d5 DevDocs: Block Chain: Overview: Many corrections 2014-10-02 01:34:07 +00:00
Luke Dashjr
9360489490 DevDocs: Block Chain: The important part is ordering, not timestamping 2014-10-02 01:19:18 +00:00
Luke Dashjr
78962123fa Bugfix: "merkle root" and "merkle tree" are common nouns, so generally lowercase 2014-10-02 01:19:05 +00:00
David A. Harding
e26b0e3819
Revise TX Overview Image
* Replace previous TX Overview image with a simplified illustration.
  The previous overview image was commented out in pull #566 / commit
  6afc683.  New image incorporates suggestions by @saivann (thanks!)

* Add new illustration showing the specifics of outputs and inputs (and
  how they're related). This replaces most of the detail lost by using a
  simplified overview image

* Add two short paragraphs briefly describing the ouput and input
  features, leading into the existing detailed P2PKH description
2014-10-01 18:40:38 -04:00
Luke Dashjr
00ccadba59 Refer to BitcoinTalk by name 2014-10-01 19:38:53 +00:00
Luke Dashjr
9d01c3aa67 DevDocs: Don't recommend BitcoinTalk 2014-10-01 19:36:14 +00:00
theymos
8490061706 Update/fix block size limits
Bitcoin limits are usually defined using decimal-friendly numbers of bytes. The block size is limited to 1 MB, not 1 MiB, for example. Also, the latest block size limit is 750 KB, not 350 KB.
2014-09-26 15:52:10 -05:00
David A. Harding
6b4e8e3a66
Remove reference to removed image. Thanks @garethtdavies! (fixes #576) 2014-09-25 09:23:01 -04:00