Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Dev Docs: Describe P2P Messages That Request Or Reply With Data #642

Merged
merged 4 commits into from
Nov 16, 2014

Conversation

harding
Copy link
Contributor

@harding harding commented Nov 12, 2014

P2P Reference Preview: http://dg0.dtrt.org/en/developer-reference#p2p-network
P2P Examples Preview: http://dg0.dtrt.org/en/developer-examples#p2p-network

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.

Note: I'm working on documenting the remaining P2P messages in a separate branch.

harding and others added 2 commits November 12, 2014 12:39
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.

Many of the data messages use
[inventories][inventory]{:#term-inventory}{:.term} as unique identifiers for
for transactions and blocks. Inventories have a simple 36-byte
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

s/for for transactions/for transactions

@ghost1542
Copy link
Contributor

@harding I've commented on everything that seemed worth reporting. Really amazing work!!!

@harding
Copy link
Contributor Author

harding commented Nov 15, 2014

@saivann thank you so much for your review! (I know it was a giant pull request---thanks for taking the time.) All your comments look reasonable to me; I'll start implementing them and comment on any that I discover don't work. Thanks again!

@harding
Copy link
Contributor Author

harding commented Nov 15, 2014

Updated text and preview with corrections suggested by @saivann. (Thanks!)

In the absence of critical feedback, I'll merge this pull around 18:00 UTC Sunday.

@harding harding merged commit 9ee7b8b into bitcoin-dot-org:master Nov 16, 2014
harding added a commit that referenced this pull request Nov 16, 2014
@harding harding deleted the data-messages branch February 25, 2015 01:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants