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