Difference between revisions of "P2Pool code documentation"

From Bitcoin Wiki
Jump to: navigation, search
(x)
(x)
Line 85: Line 85:
 
|}
 
|}
  
===x===
+
===share_data_type===
 
{| border=1
 
{| border=1
   |+ '''x'''
+
   |+ '''share_data_type'''
 
|-
 
|-
 
   !Field
 
   !Field
Line 93: Line 93:
 
   !Description
 
   !Description
 
|-
 
|-
   |name
+
   |previous_share_hash
 +
  |None or int(256)
 +
  |?
 +
|-
 +
  |coinbase
 +
  |VarString
 +
  |?
 +
|-
 +
  |nonce
 +
  |Int(32)
 +
  |?
 +
|-
 +
  |pubkey_hash
 +
  |Int(160)
 +
  |?
 +
|-
 +
  |subsidy
 +
  |Int(64)
 +
  |?
 +
|-
 +
  |donation
 +
  |Int(16)
 +
  |?
 +
|-
 +
  |stale_info
 
   |String(32)
 
   |String(32)
 +
  |Enum (orpan, dao, unk253, unk252...???
 +
|-
 +
  |desired_version
 +
  |VarInt
 
   |?
 
   |?
 
|}
 
|}
 +
 
===x===
 
===x===
 
{| border=1
 
{| border=1

Revision as of 21:23, 13 June 2012

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

Files
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


p2pool/main.py

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.

p2pool/data.py

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

hash_link_type

hash_link_type
Field Type Description
state String(32) ?
extra_data String(0) Comments say this is a hack
length VarInt ?

small_block_header

small_block_header
Field Type Description
version VarInt ?
previous_block None or Int(256) ?
timestamp Int(32) ?
bits FloatingInteger(32) ?
nonce Int(32) ?

share_data_type

share_data_type
Field Type Description
previous_share_hash None or int(256) ?
coinbase VarString ?
nonce Int(32) ?
pubkey_hash Int(160) ?
subsidy Int(64) ?
donation Int(16) ?
stale_info String(32) Enum (orpan, dao, unk253, unk252...???
desired_version VarInt ?

x

x
Field Type Description
name String(32) ?

x

x
Field Type Description
name String(32) ?

x

x
Field Type Description
name String(32) ?

x

x
Field Type Description
name String(32) ?

p2pool/util/pack.py

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.

p2pool/__init__.py

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