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