729438bb07615bea707e306dea3053aeb1254e88
[p2pool.git] / p2pool / node.py
1 import random
2 import sys
3 import time
4
5 from twisted.internet import defer, reactor, task
6 from twisted.python import log
7
8 from p2pool import data as p2pool_data, p2p
9 from p2pool.bitcoin import data as bitcoin_data, helper, height_tracker
10 from p2pool.util import deferral, variable
11
12
13 class P2PNode(p2p.Node):
14     def __init__(self, node, p2pool_port, p2pool_conns, addrs, connect_addrs):
15         self.node = node
16         p2p.Node.__init__(self,
17             best_share_hash_func=lambda: node.best_share_var.value,
18             port=p2pool_port,
19             net=node.net,
20             addr_store=addrs,
21             connect_addrs=connect_addrs,
22             max_incoming_conns=p2pool_conns,
23             known_txs_var=node.known_txs_var,
24             mining_txs_var=node.mining_txs_var,
25         )
26     
27     def handle_shares(self, shares, peer):
28         if len(shares) > 5:
29             print 'Processing %i shares from %s...' % (len(shares), '%s:%i' % peer.addr if peer is not None else None)
30         
31         new_count = 0
32         for share in shares:
33             if share.hash in self.node.tracker.items:
34                 #print 'Got duplicate share, ignoring. Hash: %s' % (p2pool_data.format_hash(share.hash),)
35                 continue
36             
37             new_count += 1
38             
39             #print 'Received share %s from %r' % (p2pool_data.format_hash(share.hash), share.peer.addr if share.peer is not None else None)
40             
41             self.node.tracker.add(share)
42         
43         if new_count:
44             self.node.set_best_share()
45         
46         if len(shares) > 5:
47             print '... done processing %i shares. New: %i Have: %i/~%i' % (len(shares), new_count, len(self.node.tracker.items), 2*self.node.net.CHAIN_LENGTH)
48     
49     @defer.inlineCallbacks
50     def handle_share_hashes(self, hashes, peer):
51         new_hashes = [x for x in hashes if x not in self.node.tracker.items]
52         if not new_hashes:
53             return
54         try:
55             shares = yield peer.get_shares(
56                 hashes=new_hashes,
57                 parents=0,
58                 stops=[],
59             )
60         except:
61             log.err(None, 'in handle_share_hashes:')
62         else:
63             self.handle_shares(shares, peer)
64     
65     def handle_get_shares(self, hashes, parents, stops, peer):
66         parents = min(parents, 1000//len(hashes))
67         stops = set(stops)
68         shares = []
69         for share_hash in hashes:
70             for share in self.node.tracker.get_chain(share_hash, min(parents + 1, self.node.tracker.get_height(share_hash))):
71                 if share.hash in stops:
72                     break
73                 shares.append(share)
74         print 'Sending %i shares to %s:%i' % (len(shares), peer.addr[0], peer.addr[1])
75         return shares
76     
77     def handle_bestblock(self, header, peer):
78         if self.node.net.PARENT.POW_FUNC(bitcoin_data.block_header_type.pack(header)) > header['bits'].target:
79             raise p2p.PeerMisbehavingError('received block header fails PoW test')
80         self.node.handle_header(header)
81     
82     @defer.inlineCallbacks
83     def broadcast_share(self, share_hash):
84         shares = []
85         for share in self.node.tracker.get_chain(share_hash, min(5, self.node.tracker.get_height(share_hash))):
86             if share.hash in self.shared_share_hashes:
87                 break
88             self.shared_share_hashes.add(share.hash)
89             shares.append(share)
90         
91         for peer in list(self.peers.itervalues()):
92             yield peer.sendShares([share for share in shares if share.peer is not peer], self.node.tracker, self.node.known_txs_var.value, include_txs_with=[share_hash])
93     
94     def start(self):
95         p2p.Node.start(self)
96         
97         self.shared_share_hashes = set(self.node.tracker.items)
98         self.node.tracker.removed.watch_weakref(self, lambda self, share: self.shared_share_hashes.discard(share.hash))
99         
100         @apply
101         @defer.inlineCallbacks
102         def download_shares():
103             while True:
104                 desired = yield self.node.desired_var.get_when_satisfies(lambda val: len(val) != 0)
105                 peer2, share_hash = random.choice(desired)
106                 
107                 if len(self.peers) == 0:
108                     yield deferral.sleep(1)
109                     continue
110                 peer = random.choice(self.peers.values())
111                 
112                 print 'Requesting parent share %s from %s' % (p2pool_data.format_hash(share_hash), '%s:%i' % peer.addr)
113                 try:
114                     shares = yield peer.get_shares(
115                         hashes=[share_hash],
116                         parents=500,
117                         stops=[],
118                     )
119                 except:
120                     log.err(None, 'in download_shares:')
121                     continue
122                 
123                 if not shares:
124                     yield deferral.sleep(1) # sleep so we don't keep rerequesting the same share nobody has
125                     continue
126                 self.handle_shares(shares, peer)
127         
128         
129         @self.node.best_block_header.changed.watch
130         def _(header):
131             for peer in self.peers.itervalues():
132                 peer.send_bestblock(header=header)
133         
134         # send share when the chain changes to their chain
135         self.node.best_share_var.changed.watch(self.broadcast_share)
136         
137         @self.node.tracker.verified.added.watch
138         def _(share):
139             if not (share.pow_hash <= share.header['bits'].target):
140                 return
141             
142             def spread():
143                 if (self.node.get_height_rel_highest(share.header['previous_block']) > -5 or
144                     self.node.bitcoind_work.value['previous_block'] in [share.header['previous_block'], share.header_hash]):
145                     self.broadcast_share(share.hash)
146             spread()
147             reactor.callLater(5, spread) # so get_height_rel_highest can update
148         
149
150 class Node(object):
151     def __init__(self, factory, bitcoind, shares, known_verified_share_hashes, net):
152         self.factory = factory
153         self.bitcoind = bitcoind
154         self.net = net
155         
156         self.tracker = p2pool_data.OkayTracker(self.net)
157         
158         for share in shares:
159             self.tracker.add(share)
160         
161         for share_hash in known_verified_share_hashes:
162             if share_hash in self.tracker.items:
163                 self.tracker.verified.add(self.tracker.items[share_hash])
164         
165         self.p2p_node = None # overwritten externally
166     
167     @defer.inlineCallbacks
168     def start(self):
169         stop_signal = variable.Event()
170         self.stop = stop_signal.happened
171         
172         # BITCOIND WORK
173         
174         self.bitcoind_work = variable.Variable((yield helper.getwork(self.bitcoind)))
175         @defer.inlineCallbacks
176         def work_poller():
177             while stop_signal.times == 0:
178                 flag = self.factory.new_block.get_deferred()
179                 try:
180                     self.bitcoind_work.set((yield helper.getwork(self.bitcoind, self.bitcoind_work.value['use_getblocktemplate'])))
181                 except:
182                     log.err()
183                 yield defer.DeferredList([flag, deferral.sleep(15)], fireOnOneCallback=True)
184         work_poller()
185         
186         # PEER WORK
187         
188         self.best_block_header = variable.Variable(None)
189         def handle_header(new_header):
190             # check that header matches current target
191             if not (self.net.PARENT.POW_FUNC(bitcoin_data.block_header_type.pack(new_header)) <= self.bitcoind_work.value['bits'].target):
192                 return
193             bitcoind_best_block = self.bitcoind_work.value['previous_block']
194             if (self.best_block_header.value is None
195                 or (
196                     new_header['previous_block'] == bitcoind_best_block and
197                     bitcoin_data.hash256(bitcoin_data.block_header_type.pack(self.best_block_header.value)) == bitcoind_best_block
198                 ) # new is child of current and previous is current
199                 or (
200                     bitcoin_data.hash256(bitcoin_data.block_header_type.pack(new_header)) == bitcoind_best_block and
201                     self.best_block_header.value['previous_block'] != bitcoind_best_block
202                 )): # new is current and previous is not a child of current
203                 self.best_block_header.set(new_header)
204         self.handle_header = handle_header
205         @defer.inlineCallbacks
206         def poll_header():
207             if self.factory.conn.value is None:
208                 return
209             handle_header((yield self.factory.conn.value.get_block_header(self.bitcoind_work.value['previous_block'])))
210         self.bitcoind_work.changed.watch(lambda _: poll_header())
211         yield deferral.retry('Error while requesting best block header:')(poll_header)()
212         
213         # BEST SHARE
214         
215         self.known_txs_var = variable.Variable({}) # hash -> tx
216         self.mining_txs_var = variable.Variable({}) # hash -> tx
217         self.get_height_rel_highest = yield height_tracker.get_height_rel_highest_func(self.bitcoind, self.factory, lambda: self.bitcoind_work.value['previous_block'], self.net)
218         
219         self.best_share_var = variable.Variable(None)
220         self.desired_var = variable.Variable(None)
221         self.bitcoind_work.changed.watch(lambda _: self.set_best_share())
222         self.set_best_share()
223         
224         # setup p2p logic and join p2pool network
225         
226         # update mining_txs according to getwork results
227         @self.bitcoind_work.changed.run_and_watch
228         def _(_=None):
229             new_mining_txs = {}
230             new_known_txs = dict(self.known_txs_var.value)
231             for tx_hash, tx in zip(self.bitcoind_work.value['transaction_hashes'], self.bitcoind_work.value['transactions']):
232                 new_mining_txs[tx_hash] = tx
233                 new_known_txs[tx_hash] = tx
234             self.mining_txs_var.set(new_mining_txs)
235             self.known_txs_var.set(new_known_txs)
236         # add p2p transactions from bitcoind to known_txs
237         @self.factory.new_tx.watch
238         def _(tx):
239             new_known_txs = dict(self.known_txs_var.value)
240             new_known_txs[bitcoin_data.hash256(bitcoin_data.tx_type.pack(tx))] = tx
241             self.known_txs_var.set(new_known_txs)
242         # forward transactions seen to bitcoind
243         @self.known_txs_var.transitioned.watch
244         @defer.inlineCallbacks
245         def _(before, after):
246             yield deferral.sleep(random.expovariate(1/1))
247             if self.factory.conn.value is None:
248                 return
249             for tx_hash in set(after) - set(before):
250                 self.factory.conn.value.send_tx(tx=after[tx_hash])
251         
252         @self.tracker.verified.added.watch
253         def _(share):
254             if not (share.pow_hash <= share.header['bits'].target):
255                 return
256             
257             block = share.as_block(self.tracker, self.known_txs_var.value)
258             if block is None:
259                 print >>sys.stderr, 'GOT INCOMPLETE BLOCK FROM PEER! %s bitcoin: %s%064x' % (p2pool_data.format_hash(share.hash), self.net.PARENT.BLOCK_EXPLORER_URL_PREFIX, share.header_hash)
260                 return
261             helper.submit_block(block, True, self.factory, self.bitcoind, self.bitcoind_work, self.net)
262             print
263             print 'GOT BLOCK FROM PEER! Passing to bitcoind! %s bitcoin: %s%064x' % (p2pool_data.format_hash(share.hash), self.net.PARENT.BLOCK_EXPLORER_URL_PREFIX, share.header_hash)
264             print
265         
266         def forget_old_txs():
267             new_known_txs = {}
268             if self.p2p_node is not None:
269                 for peer in self.p2p_node.peers.itervalues():
270                     new_known_txs.update(peer.remembered_txs)
271             new_known_txs.update(self.mining_txs_var.value)
272             for share in self.tracker.get_chain(self.best_share_var.value, min(120, self.tracker.get_height(self.best_share_var.value))):
273                 for tx_hash in share.new_transaction_hashes:
274                     if tx_hash in self.known_txs_var.value:
275                         new_known_txs[tx_hash] = self.known_txs_var.value[tx_hash]
276             self.known_txs_var.set(new_known_txs)
277         t = task.LoopingCall(forget_old_txs)
278         t.start(10)
279         stop_signal.watch(t.stop)
280         
281         t = task.LoopingCall(self.clean_tracker)
282         t.start(5)
283         stop_signal.watch(t.stop)
284     
285     def set_best_share(self):
286         best, desired, decorated_heads = self.tracker.think(self.get_height_rel_highest, self.bitcoind_work.value['previous_block'], self.bitcoind_work.value['bits'], self.known_txs_var.value)
287         
288         self.best_share_var.set(best)
289         self.desired_var.set(desired)
290     
291     def get_current_txouts(self):
292         return p2pool_data.get_expected_payouts(self.tracker, self.best_share_var.value, self.bitcoind_work.value['bits'].target, self.bitcoind_work.value['subsidy'], self.net)
293     
294     def clean_tracker(self):
295         best, desired, decorated_heads = self.tracker.think(self.get_height_rel_highest, self.bitcoind_work.value['previous_block'], self.bitcoind_work.value['bits'], self.known_txs_var.value)
296         
297         # eat away at heads
298         if decorated_heads:
299             for i in xrange(1000):
300                 to_remove = set()
301                 for share_hash, tail in self.tracker.heads.iteritems():
302                     if share_hash in [head_hash for score, head_hash in decorated_heads[-5:]]:
303                         #print 1
304                         continue
305                     if self.tracker.items[share_hash].time_seen > time.time() - 300:
306                         #print 2
307                         continue
308                     if share_hash not in self.tracker.verified.items and max(self.tracker.items[after_tail_hash].time_seen for after_tail_hash in self.tracker.reverse.get(tail)) > time.time() - 120: # XXX stupid
309                         #print 3
310                         continue
311                     to_remove.add(share_hash)
312                 if not to_remove:
313                     break
314                 for share_hash in to_remove:
315                     if share_hash in self.tracker.verified.items:
316                         self.tracker.verified.remove(share_hash)
317                     self.tracker.remove(share_hash)
318                 #print "_________", to_remove
319         
320         # drop tails
321         for i in xrange(1000):
322             to_remove = set()
323             for tail, heads in self.tracker.tails.iteritems():
324                 if min(self.tracker.get_height(head) for head in heads) < 2*self.tracker.net.CHAIN_LENGTH + 10:
325                     continue
326                 to_remove.update(self.tracker.reverse.get(tail, set()))
327             if not to_remove:
328                 break
329             # if removed from this, it must be removed from verified
330             #start = time.time()
331             for aftertail in to_remove:
332                 if self.tracker.items[aftertail].previous_hash not in self.tracker.tails:
333                     print "erk", aftertail, self.tracker.items[aftertail].previous_hash
334                     continue
335                 if aftertail in self.tracker.verified.items:
336                     self.tracker.verified.remove(aftertail)
337                 self.tracker.remove(aftertail)
338             #end = time.time()
339             #print "removed! %i %f" % (len(to_remove), (end - start)/len(to_remove))
340         
341         self.set_best_share()