P2Pool code documentation - Revision history

Burrito at 22:38, 6 May 2014

2014-05-06T22:38:24Z

← Older revision		Revision as of 22:38, 6 May 2014
Line 3:		Line 3:

	Will tidy up once initial pass done.		Will tidy up once initial pass done.

			<!-- Please use your user page! -->

	==Overview==		==Overview==
	The code consists of a number of main tasks.		The code consists of a number of main tasks.

Nibor: /* Overview */

2012-07-09T17:14:06Z

Overview

← Older revision		Revision as of 17:14, 9 July 2012
Line 6:		Line 6:
	The code consists of a number of main tasks.		The code consists of a number of main tasks.
	# Communicate with bitcoind. This mainly gets work - i.e. the latest block and all transactions that need including in the next block. The other communication is for checking the payout address is OK, and publishing newly found blocks to the bitcoin network.		# Communicate with bitcoind. This mainly gets work - i.e. the latest block and all transactions that need including in the next block. The other communication is for checking the payout address is OK, and publishing newly found blocks to the bitcoin network.
	# Store and track p2pool shares. We need to track what shares have been published by us and other users. We need this as to calculate the block generation transaction we need to know who created shares in ~~the previous few days~~.		# Store and track p2pool shares. We need to track what shares have been published by us and other users. We need this as to calculate the block generation transaction we need to know who created the previous 8640 shares (fewer if blocks being created in less than 8 hours).
	# Communicate with miners. We need to respond the their get work requests with a block header to try to "solve". Also need to handle LongPolling which is a way to inform miners instantly when they need to stop solving the current block header and solve a new one.		# Communicate with miners. We need to respond the their get work requests with a block header to try to "solve". Also need to handle LongPolling which is a way to inform miners instantly when they need to stop solving the current block header and solve a new one.
	# Communicate with p2pool network. We need to connect to other members of the pool and publish and receive shares.		# Communicate with p2pool network. We need to connect to other members of the pool and publish and receive shares.

Nibor: /* Files */

2012-07-09T16:48:39Z

Files

← Older revision		Revision as of 16:48, 9 July 2012
Line 44:		Line 44:
	\|[[p2pool_util_forest\|p2pool/util/forest.py]]		\|[[p2pool_util_forest\|p2pool/util/forest.py]]
	\|Contains Tracker class and other classes to track shares and which share is head/tail.		\|Contains Tracker class and other classes to track shares and which share is head/tail.
			\|-
			\|p2pool/util/skiplist.py]
			\|Base class for TrackerSkipList and DistanceSkipList.
	\|}		\|}

Nibor: /* Overview */

2012-06-26T21:41:45Z

Overview

← Older revision		Revision as of 21:41, 26 June 2012
Line 9:		Line 9:
	# Communicate with miners. We need to respond the their get work requests with a block header to try to "solve". Also need to handle LongPolling which is a way to inform miners instantly when they need to stop solving the current block header and solve a new one.		# Communicate with miners. We need to respond the their get work requests with a block header to try to "solve". Also need to handle LongPolling which is a way to inform miners instantly when they need to stop solving the current block header and solve a new one.
	# Communicate with p2pool network. We need to connect to other members of the pool and publish and receive shares.		# Communicate with p2pool network. We need to connect to other members of the pool and publish and receive shares.
			# Web status pages. Web pages that give users details on status of pool.

	==Files==		==Files==

Nibor: /* Overview */

2012-06-26T21:30:02Z

Overview

← Older revision		Revision as of 21:30, 26 June 2012
Line 4:		Line 4:
	Will tidy up once initial pass done.		Will tidy up once initial pass done.
	==Overview==		==Overview==
	The code consists of x main ~~processes~~		The code consists of a number of main tasks.
	# Communicate with bitcoind. This mainly gets work - i.e. the latest block and all transactions that need including in the next block. The other communication is for checking the payout address is OK, and publishing newly found blocks to the bitcoin network.		# Communicate with bitcoind. This mainly gets work - i.e. the latest block and all transactions that need including in the next block. The other communication is for checking the payout address is OK, and publishing newly found blocks to the bitcoin network.
	# Store and track p2pool shares. We need to track what shares have been published by us and other users. We need this as to calculate the block generation transaction we need to know who created shares in the previous few days.		# Store and track p2pool shares. We need to track what shares have been published by us and other users. We need this as to calculate the block generation transaction we need to know who created shares in the previous few days.

Nibor at 21:29, 26 June 2012

2012-06-26T21:29:38Z

← Older revision		Revision as of 21:29, 26 June 2012
Line 3:		Line 3:

	Will tidy up once initial pass done.		Will tidy up once initial pass done.
			==Overview==
			The code consists of x main processes
			# Communicate with bitcoind. This mainly gets work - i.e. the latest block and all transactions that need including in the next block. The other communication is for checking the payout address is OK, and publishing newly found blocks to the bitcoin network.
			# Store and track p2pool shares. We need to track what shares have been published by us and other users. We need this as to calculate the block generation transaction we need to know who created shares in the previous few days.
			# Communicate with miners. We need to respond the their get work requests with a block header to try to "solve". Also need to handle LongPolling which is a way to inform miners instantly when they need to stop solving the current block header and solve a new one.
			# Communicate with p2pool network. We need to connect to other members of the pool and publish and receive shares.

	==Files==		==Files==
	{\| border=1		{\| border=1

Forrestv at 21:45, 24 June 2012

2012-06-24T21:45:25Z

← Older revision		Revision as of 21:45, 24 June 2012
Line 186:		Line 186:
	\|coinbase		\|coinbase
	\|VarString		\|VarString
	\|?		\|coinbase script
	\|-		\|-
	\|nonce		\|nonce
	\|Int(32)		\|Int(32)
	\|?		\|internal P2Pool nonce
	\|-		\|-
	\|pubkey_hash		\|pubkey_hash
	\|Int(160)		\|Int(160)
	\|?		\|pubkey hash of Bitcoin address that this share's payouts will go to
	\|-		\|-
	\|subsidy		\|subsidy
	\|Int(64)		\|Int(64)
	\|?		\|total block value
	\|-		\|-
	\|donation		\|donation
	\|Int(16)		\|Int(16)
	\|?		\|donation to authors. 0 = 0%, 65535 = 100%
	\|-		\|-
	\|stale_info		\|stale_info
	\|String(32)		\|String(32)
	\|Enum (~~orpan~~, dao, unk253, unk252...???		\|Flag that tells whether the node that generated this share's last share was orphaned or dead. Used to compute pool statistics. Enum (orphan, dao, unk253, unk252...???
	\|-		\|-
	\|desired_version		\|desired_version
	\|VarInt		\|VarInt
	\|?		\|Vote for P2Pool version. Used to trigger upgrade warnings on other nodes
	\|}		\|}

Line 228:		Line 228:
	\|far_share_hash		\|far_share_hash
	\|none or int(256)		\|none or int(256)
	\|?		\|Hash of 100th parent of this share. Not currently used for anything, but has applications in timestamping and more secure sharechain bootstrapping
	\|-		\|-
	\|max_bits		\|max_bits
	\|Float Int		\|Float Int
	\|?		\|Maximum share target allowed
	\|-		\|-
	\|bits		\|bits
	\|Float Int		\|Float Int
	\|?		\|Share target this share was mined at
	\|-		\|-
	\|timestamp		\|timestamp
Line 254:		Line 254:
	\|min_header		\|min_header
	\|small_block_header_type		\|small_block_header_type
	\|?		\|Block header of mined share
	\|-		\|-
	\|share_info		\|share_info
	\|share_info_type		\|share_info_type
	\|?		\|see above
	\|-		\|-
	\|ref_merkle_link		\|ref_merkle_link
	\|ComposedType(branch:List(Int), index:VarInt)		\|ComposedType(branch:List(Int), index:VarInt)
	\|?		\|Merkle branch from hash(ref_type) to ref hash. Currently always empty in generated shares, but could be used by new merged mining implementations
	\|-		\|-
	\|hash_link		\|hash_link
	\|hash_link_type		\|hash_link_type
	\|?		\|Lets you compute the generation transaction hash as a function of this and the ref hash
	\|}		\|}

Line 284:		Line 284:
	\|merkle_link		\|merkle_link
	\|ComposedType(branch:List(Int), index:VarInt)		\|ComposedType(branch:List(Int), index:VarInt)
	\|?		\|Merkle branch from generation transaction hash to block header's merkle root
	\|}		\|}

Line 302:		Line 302:
	\|other_txs		\|other_txs
	\|List(bitcoin_data.tx_type)		\|List(bitcoin_data.tx_type)
	\|?		\|List of transactions included in the block besides the generation transaction
	\|}		\|}
	===ref_type===		===ref_type===
Line 315:		Line 315:
	\|identifier		\|identifier
	\|str(4)		\|str(4)
	\|?		\|Value different for every P2Pool instance (Bitcoin, Bitcoin-testnet, Litecoin...)
	\|-		\|-
	\|share_info		\|share_info
	\|share_info_type		\|share_info_type
	\|?		\|see above
	\|}		\|}
	===Class share===		===Class share===

Nibor: /* Files */

2012-06-24T16:19:46Z

Files

← Older revision		Revision as of 16:19, 24 June 2012
Line 34:		Line 34:
	\|Code to allow monitoring of when variables change and triggering events		\|Code to allow monitoring of when variables change and triggering events
	\|-		\|-
	\|p2pool/util/forest.py		\|[[p2pool_util_forest\|p2pool/util/forest.py]]
	\|Contains Tracker class and other classes to track shares and which share is head/tail.		\|Contains Tracker class and other classes to track shares and which share is head/tail.
	\|}		\|}

Nibor: /* Files */

2012-06-24T16:17:11Z

Files

← Older revision		Revision as of 16:17, 24 June 2012
Line 34:		Line 34:
	\|Code to allow monitoring of when variables change and triggering events		\|Code to allow monitoring of when variables change and triggering events
	\|-		\|-
	\|p2pool/util/...		\|p2pool/util/forest.py
	\|~~<needs expansion>~~		\|Contains Tracker class and other classes to track shares and which share is head/tail.
	\|}		\|}


	==p2pool/main.py==		==p2pool/main.py==

Nibor at 16:16, 24 June 2012

2012-06-24T16:16:12Z

← Older revision		Revision as of 16:16, 24 June 2012
Line 3:		Line 3:

	Will tidy up once initial pass done.		Will tidy up once initial pass done.
			==Files==
	{\| border=1		{\| border=1
	\|+ '''Files'''		\|+ '''Files'''