P2Pool code documentation

From Bitcoin Wiki
Revision as of 10:01, 12 June 2012 by Nibor (talk | contribs)
Jump to: navigation, search

Ignore this page for the minute. Is just a scratch pad for documenting the p2pool code. Will tidy up once initial pass done.

Files Name Description
p2pool/main.py Main Startup and initialisation code
p2pool/data.py P2Pool main data structures
p2pool/util/pack.py Handling of over the wire data structures


Makes extensive use of twisted.defer. This allows it to "yield" to allow long running network code to complete. Read up on Python Generators and this before progressing!

Contains main startup code.

Tests connection to bitcoind. Prints hash of latest block to show bitcoind is up to date.

Tests connection to p2pool network.

Gets address to use for payout either from file or bitcoind. Validates address and checks local bitcoind owns it.


Contains the main data structures used in p2pool. These are:


I think this handles all the binary data types used in the bitcoin protocol to send data over the network wire. These are nasty as very low level and many big endian/little endian complications. The p2pool network protocol uses these also. Do not think you need to really understand this unless making changes at this low level.


At bottom has DEBUG flag. Change to true to get more output. Other than that just returns version number for git if it can.