p2pool/node.py

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