p2pool/work.py

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