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