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