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 = 2**256 - 1
 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                     pass
 152             elif symbol == '/':
 153                 try:
 154                     desired_share_target = bitcoin_data.difficulty_to_target(float(parameter))
 155                 except:
 156                     pass
 157
 158         if random.uniform(0, 100) < self.worker_fee:
 159             pubkey_hash = self.my_pubkey_hash
 160         else:
 161             try:
 162                 pubkey_hash = bitcoin_data.address_to_pubkey_hash(user, self.node.net.PARENT)
 163             except: # XXX blah
 164                 pubkey_hash = self.my_pubkey_hash
 165
 166         return user, pubkey_hash, desired_share_target, desired_pseudoshare_target
 167
 168     def preprocess_request(self, user):
 169         user, pubkey_hash, desired_share_target, desired_pseudoshare_target = self.get_user_details(user)
 170         return pubkey_hash, desired_share_target, desired_pseudoshare_target
 171
 172     def get_work(self, pubkey_hash, desired_share_target, desired_pseudoshare_target):
 173         if (self.node.p2p_node is None or len(self.node.p2p_node.peers) == 0) and self.node.net.PERSIST:
 174             raise jsonrpc.Error_for_code(-12345)(u'p2pool is not connected to any peers')
 175         if self.node.best_share_var.value is None and self.node.net.PERSIST:
 176             raise jsonrpc.Error_for_code(-12345)(u'p2pool is downloading shares')
 177         if time.time() > self.current_work.value['last_update'] + 60:
 178             raise jsonrpc.Error_for_code(-12345)(u'lost contact with bitcoind')
 179
 180         if self.merged_work.value:
 181             tree, size = bitcoin_data.make_auxpow_tree(self.merged_work.value)
 182             mm_hashes = [self.merged_work.value.get(tree.get(i), dict(hash=0))['hash'] for i in xrange(size)]
 183             mm_data = '\xfa\xbemm' + bitcoin_data.aux_pow_coinbase_type.pack(dict(
 184                 merkle_root=bitcoin_data.merkle_hash(mm_hashes),
 185                 size=size,
 186                 nonce=0,
 187             ))
 188             mm_later = [(aux_work, mm_hashes.index(aux_work['hash']), mm_hashes) for chain_id, aux_work in self.merged_work.value.iteritems()]
 189         else:
 190             mm_data = ''
 191             mm_later = []
 192
 193         tx_hashes = [bitcoin_data.hash256(bitcoin_data.tx_type.pack(tx)) for tx in self.current_work.value['transactions']]
 194         tx_map = dict(zip(tx_hashes, self.current_work.value['transactions']))
 195
 196         if self.node.best_share_var.value is None:
 197             share_type = p2pool_data.Share
 198         else:
 199             previous_share = self.node.tracker.items[self.node.best_share_var.value]
 200             previous_share_type = type(previous_share)
 201
 202             if previous_share_type.SUCCESSOR is None or self.node.tracker.get_height(previous_share.hash) < self.node.net.CHAIN_LENGTH:
 203                 share_type = previous_share_type
 204             else:
 205                 successor_type = previous_share_type.SUCCESSOR
 206
 207                 counts = p2pool_data.get_desired_version_counts(self.node.tracker,
 208                     self.node.tracker.get_nth_parent_hash(previous_share.hash, self.node.net.CHAIN_LENGTH*9//10), self.node.net.CHAIN_LENGTH//10)
 209                 # Share -> NewShare only valid if 85% of hashes in [net.CHAIN_LENGTH*9//10, net.CHAIN_LENGTH] for new version
 210                 if counts.get(successor_type.VERSION, 0) > sum(counts.itervalues())*95//100:
 211                     share_type = successor_type
 212                 else:
 213                     share_type = previous_share_type
 214
 215         if True:
 216             share_info, gentx, other_transaction_hashes, get_share = share_type.generate_transaction(
 217                 tracker=self.node.tracker,
 218                 share_data=dict(
 219                     previous_share_hash=self.node.best_share_var.value,
 220                     coinbase=(script.create_push_script([
 221                         self.current_work.value['height'],
 222                         ] + ([mm_data] if mm_data else []) + [
 223                     ]) + self.current_work.value['coinbaseflags'])[:100],
 224                     nonce=random.randrange(2**32),
 225                     pubkey_hash=pubkey_hash,
 226                     subsidy=self.current_work.value['subsidy'],
 227                     donation=math.perfect_round(65535*self.donation_percentage/100),
 228                     stale_info=(lambda (orphans, doas), total, (orphans_recorded_in_chain, doas_recorded_in_chain):
 229                         'orphan' if orphans > orphans_recorded_in_chain else
 230                         'doa' if doas > doas_recorded_in_chain else
 231                         None
 232                     )(*self.get_stale_counts()),
 233                     desired_version=(share_type.SUCCESSOR if share_type.SUCCESSOR is not None else share_type).VOTING_VERSION,
 234                 ),
 235                 block_target=self.current_work.value['bits'].target,
 236                 desired_timestamp=int(time.time() + 0.5),
 237                 desired_target=desired_share_target,
 238                 ref_merkle_link=dict(branch=[], index=0),
 239                 desired_other_transaction_hashes_and_fees=zip(tx_hashes, self.current_work.value['transaction_fees']),
 240                 net=self.node.net,
 241                 known_txs=tx_map,
 242                 base_subsidy=self.node.net.PARENT.SUBSIDY_FUNC(self.current_work.value['height']),
 243             )
 244
 245         packed_gentx = bitcoin_data.tx_type.pack(gentx)
 246         other_transactions = [tx_map[tx_hash] for tx_hash in other_transaction_hashes]
 247
 248         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]
 249
 250         if desired_pseudoshare_target is None:
 251             target = 2**256-1
 252             if len(self.recent_shares_ts_work) == 50:
 253                 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])
 254                 if hash_rate:
 255                     target = min(target, int(2**256/hash_rate))
 256         else:
 257             target = desired_pseudoshare_target
 258         target = max(target, share_info['bits'].target)
 259         for aux_work, index, hashes in mm_later:
 260             target = max(target, aux_work['target'])
 261         target = math.clip(target, self.node.net.PARENT.SANE_TARGET_RANGE)
 262
 263         getwork_time = time.time()
 264         lp_count = self.new_work_event.times
 265         merkle_link = bitcoin_data.calculate_merkle_link([None] + other_transaction_hashes, 0)
 266
 267         print 'New work for worker! Difficulty: %.06f Share difficulty: %.06f Total block value: %.6f %s including %i transactions' % (
 268             bitcoin_data.target_to_difficulty(target),
 269             bitcoin_data.target_to_difficulty(share_info['bits'].target),
 270             self.current_work.value['subsidy']*1e-8, self.node.net.PARENT.SYMBOL,
 271             len(self.current_work.value['transactions']),
 272         )
 273
 274         ba = dict(
 275             version=min(self.current_work.value['version'], 2),
 276             previous_block=self.current_work.value['previous_block'],
 277             merkle_link=merkle_link,
 278             coinb1=packed_gentx[:-4-4],
 279             coinb2=packed_gentx[-4:],
 280             timestamp=self.current_work.value['time'],
 281             bits=self.current_work.value['bits'],
 282             share_target=target,
 283         )
 284
 285         received_header_hashes = set()
 286
 287         def got_response(header, user, coinbase_nonce):
 288             assert len(coinbase_nonce) == self.COINBASE_NONCE_LENGTH == 4
 289             new_packed_gentx = packed_gentx[:-4-4] + coinbase_nonce + packed_gentx[-4:] if coinbase_nonce != '\0'*self.COINBASE_NONCE_LENGTH else packed_gentx
 290             new_gentx = bitcoin_data.tx_type.unpack(new_packed_gentx) if coinbase_nonce != '\0'*self.COINBASE_NONCE_LENGTH else gentx
 291
 292             header_hash = bitcoin_data.hash256(bitcoin_data.block_header_type.pack(header))
 293             pow_hash = self.node.net.PARENT.POW_FUNC(bitcoin_data.block_header_type.pack(header))
 294             try:
 295                 if pow_hash <= header['bits'].target or p2pool.DEBUG:
 296                     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)
 297                     if pow_hash <= header['bits'].target:
 298                         print
 299                         print 'GOT BLOCK FROM MINER! Passing to bitcoind! %s%064x' % (self.node.net.PARENT.BLOCK_EXPLORER_URL_PREFIX, header_hash)
 300                         print
 301             except:
 302                 log.err(None, 'Error while processing potential block:')
 303
 304             user, _, _, _ = self.get_user_details(user)
 305             assert header['previous_block'] == ba['previous_block']
 306             assert header['merkle_root'] == bitcoin_data.check_merkle_link(bitcoin_data.hash256(new_packed_gentx), merkle_link)
 307             assert header['bits'] == ba['bits']
 308
 309             on_time = self.new_work_event.times == lp_count
 310
 311             for aux_work, index, hashes in mm_later:
 312                 try:
 313                     if pow_hash <= aux_work['target'] or p2pool.DEBUG:
 314                         df = deferral.retry('Error submitting merged block: (will retry)', 10, 10)(aux_work['merged_proxy'].rpc_getauxblock)(
 315                             pack.IntType(256, 'big').pack(aux_work['hash']).encode('hex'),
 316                             bitcoin_data.aux_pow_type.pack(dict(
 317                                 merkle_tx=dict(
 318                                     tx=new_gentx,
 319                                     block_hash=header_hash,
 320                                     merkle_link=merkle_link,
 321                                 ),
 322                                 merkle_link=bitcoin_data.calculate_merkle_link(hashes, index),
 323                                 parent_block_header=header,
 324                             )).encode('hex'),
 325                         )
 326                         @df.addCallback
 327                         def _(result, aux_work=aux_work):
 328                             if result != (pow_hash <= aux_work['target']):
 329                                 print >>sys.stderr, 'Merged block submittal result: %s Expected: %s' % (result, pow_hash <= aux_work['target'])
 330                             else:
 331                                 print 'Merged block submittal result: %s' % (result,)
 332                         @df.addErrback
 333                         def _(err):
 334                             log.err(err, 'Error submitting merged block:')
 335                 except:
 336                     log.err(None, 'Error while processing merged mining POW:')
 337
 338             if pow_hash <= share_info['bits'].target and header_hash not in received_header_hashes:
 339                 share = get_share(header, pack.IntType(32).unpack(coinbase_nonce))
 340
 341                 print 'GOT SHARE! %s %s prev %s age %.2fs%s' % (
 342                     user,
 343                     p2pool_data.format_hash(share.hash),
 344                     p2pool_data.format_hash(share.previous_hash),
 345                     time.time() - getwork_time,
 346                     ' DEAD ON ARRIVAL' if not on_time else '',
 347                 )
 348                 self.my_share_hashes.add(share.hash)
 349                 if not on_time:
 350                     self.my_doa_share_hashes.add(share.hash)
 351
 352                 self.node.tracker.add(share)
 353                 self.node.set_best_share()
 354
 355                 try:
 356                     if (pow_hash <= header['bits'].target or p2pool.DEBUG) and self.node.p2p_node is not None:
 357                         self.node.p2p_node.broadcast_share(share.hash)
 358                 except:
 359                     log.err(None, 'Error forwarding block solution:')
 360
 361                 self.share_received.happened(bitcoin_data.target_to_average_attempts(share.target), not on_time)
 362
 363             if pow_hash > target:
 364                 print 'Worker %s submitted share with hash > target:' % (user,)
 365                 print '    Hash:   %56x' % (pow_hash,)
 366                 print '    Target: %56x' % (target,)
 367             elif header_hash in received_header_hashes:
 368                 print >>sys.stderr, 'Worker %s submitted share more than once!' % (user,)
 369             else:
 370                 received_header_hashes.add(header_hash)
 371
 372                 self.pseudoshare_received.happened(bitcoin_data.target_to_average_attempts(target), not on_time, user)
 373                 self.recent_shares_ts_work.append((time.time(), bitcoin_data.target_to_average_attempts(target)))
 374                 while len(self.recent_shares_ts_work) > 50:
 375                     self.recent_shares_ts_work.pop(0)
 376                 self.local_rate_monitor.add_datum(dict(work=bitcoin_data.target_to_average_attempts(target), dead=not on_time, user=user))
 377
 378             return on_time
 379
 380         return ba, got_response