p2pool/work.py

   1 from __future__ import division
   2
   3 import base64
   4 import random
   5 import re
   6 import sys
   7 import time
   8
   9 from twisted.internet import defer
  10 from twisted.python import log
  11
  12 import bitcoin.getwork as bitcoin_getwork, bitcoin.data as bitcoin_data
  13 from bitcoin import helper, script, worker_interface
  14 from util import forest, jsonrpc, variable, deferral, math, pack
  15 import p2pool, p2pool.data as p2pool_data
  16
  17 class WorkerBridge(worker_interface.WorkerBridge):
  18     COINBASE_NONCE_LENGTH = 4
  19
  20     def __init__(self, node, my_pubkey_hash, donation_percentage, merged_urls, worker_fee):
  21         worker_interface.WorkerBridge.__init__(self)
  22         self.recent_shares_ts_work = []
  23
  24         self.node = node
  25         self.my_pubkey_hash = my_pubkey_hash
  26         self.donation_percentage = donation_percentage
  27         self.worker_fee = worker_fee
  28
  29         self.net = self.node.net.PARENT
  30         self.running = True
  31         self.pseudoshare_received = variable.Event()
  32         self.share_received = variable.Event()
  33         self.local_rate_monitor = math.RateMonitor(10*60)
  34
  35         self.removed_unstales_var = variable.Variable((0, 0, 0))
  36         self.removed_doa_unstales_var = variable.Variable(0)
  37
  38
  39         self.my_share_hashes = set()
  40         self.my_doa_share_hashes = set()
  41
  42         self.tracker_view = forest.TrackerView(self.node.tracker, forest.get_attributedelta_type(dict(forest.AttributeDelta.attrs,
  43             my_count=lambda share: 1 if share.hash in self.my_share_hashes else 0,
  44             my_doa_count=lambda share: 1 if share.hash in self.my_doa_share_hashes else 0,
  45             my_orphan_announce_count=lambda share: 1 if share.hash in self.my_share_hashes and share.share_data['stale_info'] == 'orphan' else 0,
  46             my_dead_announce_count=lambda share: 1 if share.hash in self.my_share_hashes and share.share_data['stale_info'] == 'doa' else 0,
  47         )))
  48
  49         @self.node.tracker.verified.removed.watch
  50         def _(share):
  51             if share.hash in self.my_share_hashes and self.node.tracker.is_child_of(share.hash, self.node.best_share_var.value):
  52                 assert share.share_data['stale_info'] in [None, 'orphan', 'doa'] # we made these shares in this instance
  53                 self.removed_unstales_var.set((
  54                     self.removed_unstales_var.value[0] + 1,
  55                     self.removed_unstales_var.value[1] + (1 if share.share_data['stale_info'] == 'orphan' else 0),
  56                     self.removed_unstales_var.value[2] + (1 if share.share_data['stale_info'] == 'doa' else 0),
  57                 ))
  58             if share.hash in self.my_doa_share_hashes and self.node.tracker.is_child_of(share.hash, self.node.best_share_var.value):
  59                 self.removed_doa_unstales_var.set(self.removed_doa_unstales_var.value + 1)
  60
  61         # MERGED WORK
  62
  63         self.merged_work = variable.Variable({})
  64
  65         @defer.inlineCallbacks
  66         def set_merged_work(merged_url, merged_userpass):
  67             merged_proxy = jsonrpc.HTTPProxy(merged_url, dict(Authorization='Basic ' + base64.b64encode(merged_userpass)))
  68             while self.running:
  69                 auxblock = yield deferral.retry('Error while calling merged getauxblock:', 30)(merged_proxy.rpc_getauxblock)()
  70                 self.merged_work.set(dict(self.merged_work.value, **{auxblock['chainid']: dict(
  71                     hash=int(auxblock['hash'], 16),
  72                     target='p2pool' if auxblock['target'] == 'p2pool' else pack.IntType(256).unpack(auxblock['target'].decode('hex')),
  73                     merged_proxy=merged_proxy,
  74                 )}))
  75                 yield deferral.sleep(1)
  76         for merged_url, merged_userpass in merged_urls:
  77             set_merged_work(merged_url, merged_userpass)
  78
  79         @self.merged_work.changed.watch
  80         def _(new_merged_work):
  81             print 'Got new merged mining work!'
  82
  83         # COMBINE WORK
  84
  85         self.current_work = variable.Variable(None)
  86         def compute_work():
  87             t = self.node.bitcoind_work.value
  88             bb = self.node.best_block_header.value
  89             if bb is not None and bb['previous_block'] == t['previous_block'] and self.node.net.PARENT.POW_FUNC(bitcoin_data.block_header_type.pack(bb)) <= t['bits'].target:
  90                 print 'Skipping from block %x to block %x!' % (bb['previous_block'],
  91                     bitcoin_data.hash256(bitcoin_data.block_header_type.pack(bb)))
  92                 t = dict(
  93                     version=bb['version'],
  94                     previous_block=bitcoin_data.hash256(bitcoin_data.block_header_type.pack(bb)),
  95                     bits=bb['bits'], # not always true
  96                     coinbaseflags='',
  97                     height=t['height'] + 1,
  98                     time=bb['timestamp'] + 600, # better way?
  99                     transactions=[],
 100                     transaction_fees=[],
 101                     merkle_link=bitcoin_data.calculate_merkle_link([None], 0),
 102                     subsidy=self.node.net.PARENT.SUBSIDY_FUNC(self.node.bitcoind_work.value['height']),
 103                     last_update=self.node.bitcoind_work.value['last_update'],
 104                 )
 105
 106             self.current_work.set(t)
 107         self.node.bitcoind_work.changed.watch(lambda _: compute_work())
 108         self.node.best_block_header.changed.watch(lambda _: compute_work())
 109         compute_work()
 110
 111         self.new_work_event = variable.Event()
 112         @self.current_work.transitioned.watch
 113         def _(before, after):
 114             # trigger LP if version/previous_block/bits changed or transactions changed from nothing
 115             if any(before[x] != after[x] for x in ['version', 'previous_block', 'bits']) or (not before['transactions'] and after['transactions']):
 116                 self.new_work_event.happened()
 117         self.merged_work.changed.watch(lambda _: self.new_work_event.happened())
 118         self.node.best_share_var.changed.watch(lambda _: self.new_work_event.happened())
 119
 120     def stop(self):
 121         self.running = False
 122
 123     def get_stale_counts(self):
 124         '''Returns (orphans, doas), total, (orphans_recorded_in_chain, doas_recorded_in_chain)'''
 125         my_shares = len(self.my_share_hashes)
 126         my_doa_shares = len(self.my_doa_share_hashes)
 127         delta = self.tracker_view.get_delta_to_last(self.node.best_share_var.value)
 128         my_shares_in_chain = delta.my_count + self.removed_unstales_var.value[0]
 129         my_doa_shares_in_chain = delta.my_doa_count + self.removed_doa_unstales_var.value
 130         orphans_recorded_in_chain = delta.my_orphan_announce_count + self.removed_unstales_var.value[1]
 131         doas_recorded_in_chain = delta.my_dead_announce_count + self.removed_unstales_var.value[2]
 132
 133         my_shares_not_in_chain = my_shares - my_shares_in_chain
 134         my_doa_shares_not_in_chain = my_doa_shares - my_doa_shares_in_chain
 135
 136         return (my_shares_not_in_chain - my_doa_shares_not_in_chain, my_doa_shares_not_in_chain), my_shares, (orphans_recorded_in_chain, doas_recorded_in_chain)
 137
 138     def get_user_details(self, username):
 139         contents = re.split('([+/])', username)
 140         assert len(contents) % 2 == 1
 141
 142         user, contents2 = contents[0], contents[1:]
 143
 144         desired_pseudoshare_target = None
 145         desired_share_target = None
 146         for symbol, parameter in zip(contents2[::2], contents2[1::2]):
 147             if symbol == '+':
 148                 try:
 149                     desired_pseudoshare_target = bitcoin_data.difficulty_to_target(float(parameter))
 150                 except:
 151                     if p2pool.DEBUG:
 152                         log.err()
 153             elif symbol == '/':
 154                 try:
 155                     desired_share_target = bitcoin_data.difficulty_to_target(float(parameter))
 156                 except:
 157                     if p2pool.DEBUG:
 158                         log.err()
 159
 160         if random.uniform(0, 100) < self.worker_fee:
 161             pubkey_hash = self.my_pubkey_hash
 162         else:
 163             try:
 164                 pubkey_hash = bitcoin_data.address_to_pubkey_hash(user, self.node.net.PARENT)
 165             except: # XXX blah
 166                 pubkey_hash = self.my_pubkey_hash
 167
 168         return user, pubkey_hash, desired_share_target, desired_pseudoshare_target
 169
 170     def preprocess_request(self, user):
 171         user, pubkey_hash, desired_share_target, desired_pseudoshare_target = self.get_user_details(user)
 172         return pubkey_hash, desired_share_target, desired_pseudoshare_target
 173
 174     def _estimate_local_hash_rate(self):
 175         if len(self.recent_shares_ts_work) == 50:
 176             hash_rate = sum(work for ts, work in self.recent_shares_ts_work[1:])//(self.recent_shares_ts_work[-1][0] - self.recent_shares_ts_work[0][0])
 177             if hash_rate:
 178                 return hash_rate
 179         return None
 180
 181     def get_work(self, pubkey_hash, desired_share_target, desired_pseudoshare_target):
 182         if (self.node.p2p_node is None or len(self.node.p2p_node.peers) == 0) and self.node.net.PERSIST:
 183             raise jsonrpc.Error_for_code(-12345)(u'p2pool is not connected to any peers')
 184         if self.node.best_share_var.value is None and self.node.net.PERSIST:
 185             raise jsonrpc.Error_for_code(-12345)(u'p2pool is downloading shares')
 186         if time.time() > self.current_work.value['last_update'] + 60:
 187             raise jsonrpc.Error_for_code(-12345)(u'lost contact with bitcoind')
 188
 189         if self.merged_work.value:
 190             tree, size = bitcoin_data.make_auxpow_tree(self.merged_work.value)
 191             mm_hashes = [self.merged_work.value.get(tree.get(i), dict(hash=0))['hash'] for i in xrange(size)]
 192             mm_data = '\xfa\xbemm' + bitcoin_data.aux_pow_coinbase_type.pack(dict(
 193                 merkle_root=bitcoin_data.merkle_hash(mm_hashes),
 194                 size=size,
 195                 nonce=0,
 196             ))
 197             mm_later = [(aux_work, mm_hashes.index(aux_work['hash']), mm_hashes) for chain_id, aux_work in self.merged_work.value.iteritems()]
 198         else:
 199             mm_data = ''
 200             mm_later = []
 201
 202         tx_hashes = [bitcoin_data.hash256(bitcoin_data.tx_type.pack(tx)) for tx in self.current_work.value['transactions']]
 203         tx_map = dict(zip(tx_hashes, self.current_work.value['transactions']))
 204
 205         if self.node.best_share_var.value is None:
 206             share_type = p2pool_data.Share
 207         else:
 208             previous_share = self.node.tracker.items[self.node.best_share_var.value]
 209             previous_share_type = type(previous_share)
 210
 211             if previous_share_type.SUCCESSOR is None or self.node.tracker.get_height(previous_share.hash) < self.node.net.CHAIN_LENGTH:
 212                 share_type = previous_share_type
 213             else:
 214                 successor_type = previous_share_type.SUCCESSOR
 215
 216                 counts = p2pool_data.get_desired_version_counts(self.node.tracker,
 217                     self.node.tracker.get_nth_parent_hash(previous_share.hash, self.node.net.CHAIN_LENGTH*9//10), self.node.net.CHAIN_LENGTH//10)
 218                 # Share -> NewShare only valid if 85% of hashes in [net.CHAIN_LENGTH*9//10, net.CHAIN_LENGTH] for new version
 219                 if counts.get(successor_type.VERSION, 0) > sum(counts.itervalues())*95//100:
 220                     share_type = successor_type
 221                 else:
 222                     share_type = previous_share_type
 223
 224         if desired_share_target is None:
 225             desired_share_target = 2**256-1
 226             local_hash_rate = self._estimate_local_hash_rate()
 227             if local_hash_rate is not None:
 228                 desired_share_target = min(desired_share_target,
 229                     bitcoin_data.average_attempts_to_target(local_hash_rate * self.node.net.SHARE_PERIOD / 0.05)) # limit to 5% of pool shares by modulating share difficulty
 230
 231         if True:
 232             share_info, gentx, other_transaction_hashes, get_share = share_type.generate_transaction(
 233                 tracker=self.node.tracker,
 234                 share_data=dict(
 235                     previous_share_hash=self.node.best_share_var.value,
 236                     coinbase=(script.create_push_script([
 237                         self.current_work.value['height'],
 238                         ] + ([mm_data] if mm_data else []) + [
 239                     ]) + self.current_work.value['coinbaseflags'])[:100],
 240                     nonce=random.randrange(2**32),
 241                     pubkey_hash=pubkey_hash,
 242                     subsidy=self.current_work.value['subsidy'],
 243                     donation=math.perfect_round(65535*self.donation_percentage/100),
 244                     stale_info=(lambda (orphans, doas), total, (orphans_recorded_in_chain, doas_recorded_in_chain):
 245                         'orphan' if orphans > orphans_recorded_in_chain else
 246                         'doa' if doas > doas_recorded_in_chain else
 247                         None
 248                     )(*self.get_stale_counts()),
 249                     desired_version=(share_type.SUCCESSOR if share_type.SUCCESSOR is not None else share_type).VOTING_VERSION,
 250                 ),
 251                 block_target=self.current_work.value['bits'].target,
 252                 desired_timestamp=int(time.time() + 0.5),
 253                 desired_target=desired_share_target,
 254                 ref_merkle_link=dict(branch=[], index=0),
 255                 desired_other_transaction_hashes_and_fees=zip(tx_hashes, self.current_work.value['transaction_fees']),
 256                 net=self.node.net,
 257                 known_txs=tx_map,
 258                 base_subsidy=self.node.net.PARENT.SUBSIDY_FUNC(self.current_work.value['height']),
 259             )
 260
 261         packed_gentx = bitcoin_data.tx_type.pack(gentx)
 262         other_transactions = [tx_map[tx_hash] for tx_hash in other_transaction_hashes]
 263
 264         mm_later = [(dict(aux_work, target=aux_work['target'] if aux_work['target'] != 'p2pool' else share_info['bits'].target), index, hashes) for aux_work, index, hashes in mm_later]
 265
 266         if desired_pseudoshare_target is None:
 267             target = 2**256-1
 268             local_hash_rate = self._estimate_local_hash_rate()
 269             if local_hash_rate is not None:
 270                 target = min(target,
 271                     bitcoin_data.average_attempts_to_target(local_hash_rate * 1)) # limit to 1 share response every second by modulating pseudoshare difficulty
 272         else:
 273             target = desired_pseudoshare_target
 274         target = max(target, share_info['bits'].target)
 275         for aux_work, index, hashes in mm_later:
 276             target = max(target, aux_work['target'])
 277         target = math.clip(target, self.node.net.PARENT.SANE_TARGET_RANGE)
 278
 279         getwork_time = time.time()
 280         lp_count = self.new_work_event.times
 281         merkle_link = bitcoin_data.calculate_merkle_link([None] + other_transaction_hashes, 0)
 282
 283         print 'New work for worker! Difficulty: %.06f Share difficulty: %.06f Total block value: %.6f %s including %i transactions' % (
 284             bitcoin_data.target_to_difficulty(target),
 285             bitcoin_data.target_to_difficulty(share_info['bits'].target),
 286             self.current_work.value['subsidy']*1e-8, self.node.net.PARENT.SYMBOL,
 287             len(self.current_work.value['transactions']),
 288         )
 289
 290         ba = dict(
 291             version=min(self.current_work.value['version'], 2),
 292             previous_block=self.current_work.value['previous_block'],
 293             merkle_link=merkle_link,
 294             coinb1=packed_gentx[:-4-4],
 295             coinb2=packed_gentx[-4:],
 296             timestamp=self.current_work.value['time'],
 297             bits=self.current_work.value['bits'],
 298             share_target=target,
 299         )
 300
 301         received_header_hashes = set()
 302
 303         def got_response(header, user, coinbase_nonce):
 304             assert len(coinbase_nonce) == self.COINBASE_NONCE_LENGTH == 4
 305             new_packed_gentx = packed_gentx[:-4-4] + coinbase_nonce + packed_gentx[-4:] if coinbase_nonce != '\0'*self.COINBASE_NONCE_LENGTH else packed_gentx
 306             new_gentx = bitcoin_data.tx_type.unpack(new_packed_gentx) if coinbase_nonce != '\0'*self.COINBASE_NONCE_LENGTH else gentx
 307
 308             header_hash = bitcoin_data.hash256(bitcoin_data.block_header_type.pack(header))
 309             pow_hash = self.node.net.PARENT.POW_FUNC(bitcoin_data.block_header_type.pack(header))
 310             try:
 311                 if pow_hash <= header['bits'].target or p2pool.DEBUG:
 312                     helper.submit_block(dict(header=header, txs=[new_gentx] + other_transactions), False, self.node.factory, self.node.bitcoind, self.node.bitcoind_work, self.node.net)
 313                     if pow_hash <= header['bits'].target:
 314                         print
 315                         print 'GOT BLOCK FROM MINER! Passing to bitcoind! %s%064x' % (self.node.net.PARENT.BLOCK_EXPLORER_URL_PREFIX, header_hash)
 316                         print
 317             except:
 318                 log.err(None, 'Error while processing potential block:')
 319
 320             user, _, _, _ = self.get_user_details(user)
 321             assert header['previous_block'] == ba['previous_block']
 322             assert header['merkle_root'] == bitcoin_data.check_merkle_link(bitcoin_data.hash256(new_packed_gentx), merkle_link)
 323             assert header['bits'] == ba['bits']
 324
 325             on_time = self.new_work_event.times == lp_count
 326
 327             for aux_work, index, hashes in mm_later:
 328                 try:
 329                     if pow_hash <= aux_work['target'] or p2pool.DEBUG:
 330                         df = deferral.retry('Error submitting merged block: (will retry)', 10, 10)(aux_work['merged_proxy'].rpc_getauxblock)(
 331                             pack.IntType(256, 'big').pack(aux_work['hash']).encode('hex'),
 332                             bitcoin_data.aux_pow_type.pack(dict(
 333                                 merkle_tx=dict(
 334                                     tx=new_gentx,
 335                                     block_hash=header_hash,
 336                                     merkle_link=merkle_link,
 337                                 ),
 338                                 merkle_link=bitcoin_data.calculate_merkle_link(hashes, index),
 339                                 parent_block_header=header,
 340                             )).encode('hex'),
 341                         )
 342                         @df.addCallback
 343                         def _(result, aux_work=aux_work):
 344                             if result != (pow_hash <= aux_work['target']):
 345                                 print >>sys.stderr, 'Merged block submittal result: %s Expected: %s' % (result, pow_hash <= aux_work['target'])
 346                             else:
 347                                 print 'Merged block submittal result: %s' % (result,)
 348                         @df.addErrback
 349                         def _(err):
 350                             log.err(err, 'Error submitting merged block:')
 351                 except:
 352                     log.err(None, 'Error while processing merged mining POW:')
 353
 354             if pow_hash <= share_info['bits'].target and header_hash not in received_header_hashes:
 355                 share = get_share(header, pack.IntType(32).unpack(coinbase_nonce))
 356
 357                 print 'GOT SHARE! %s %s prev %s age %.2fs%s' % (
 358                     user,
 359                     p2pool_data.format_hash(share.hash),
 360                     p2pool_data.format_hash(share.previous_hash),
 361                     time.time() - getwork_time,
 362                     ' DEAD ON ARRIVAL' if not on_time else '',
 363                 )
 364                 self.my_share_hashes.add(share.hash)
 365                 if not on_time:
 366                     self.my_doa_share_hashes.add(share.hash)
 367
 368                 self.node.tracker.add(share)
 369                 self.node.set_best_share()
 370
 371                 try:
 372                     if (pow_hash <= header['bits'].target or p2pool.DEBUG) and self.node.p2p_node is not None:
 373                         self.node.p2p_node.broadcast_share(share.hash)
 374                 except:
 375                     log.err(None, 'Error forwarding block solution:')
 376
 377                 self.share_received.happened(bitcoin_data.target_to_average_attempts(share.target), not on_time)
 378
 379             if pow_hash > target:
 380                 print 'Worker %s submitted share with hash > target:' % (user,)
 381                 print '    Hash:   %56x' % (pow_hash,)
 382                 print '    Target: %56x' % (target,)
 383             elif header_hash in received_header_hashes:
 384                 print >>sys.stderr, 'Worker %s submitted share more than once!' % (user,)
 385             else:
 386                 received_header_hashes.add(header_hash)
 387
 388                 self.pseudoshare_received.happened(bitcoin_data.target_to_average_attempts(target), not on_time, user)
 389                 self.recent_shares_ts_work.append((time.time(), bitcoin_data.target_to_average_attempts(target)))
 390                 while len(self.recent_shares_ts_work) > 50:
 391                     self.recent_shares_ts_work.pop(0)
 392                 self.local_rate_monitor.add_datum(dict(work=bitcoin_data.target_to_average_attempts(target), dead=not on_time, user=user))
 393
 394             return on_time
 395
 396         return ba, got_response