p2pool/data.py

   1 from __future__ import division
   2
   3 import itertools
   4 import random
   5 import time
   6 import os
   7
   8 from twisted.python import log
   9
  10 import p2pool
  11 from p2pool import skiplists
  12 from p2pool.bitcoin import data as bitcoin_data, script
  13 from p2pool.util import memoize, expiring_dict, math, forest
  14
  15
  16 share_data_type = bitcoin_data.ComposedType([
  17     ('previous_share_hash', bitcoin_data.PossiblyNoneType(0, bitcoin_data.HashType())),
  18     ('coinbase', bitcoin_data.VarStrType()),
  19     ('nonce', bitcoin_data.VarStrType()),
  20     ('new_script', bitcoin_data.VarStrType()),
  21     ('subsidy', bitcoin_data.StructType('<Q')),
  22     ('donation', bitcoin_data.StructType('<H')),
  23     ('stale_frac', bitcoin_data.StructType('<B')),
  24 ])
  25
  26 share_info_type = bitcoin_data.ComposedType([
  27     ('share_data', share_data_type),
  28     ('target', bitcoin_data.FloatingIntegerType()),
  29     ('timestamp', bitcoin_data.StructType('<I')),
  30 ])
  31
  32 share1a_type = bitcoin_data.ComposedType([
  33     ('header', bitcoin_data.block_header_type),
  34     ('share_info', share_info_type),
  35     ('merkle_branch', bitcoin_data.merkle_branch_type),
  36 ])
  37
  38 share1b_type = bitcoin_data.ComposedType([
  39     ('header', bitcoin_data.block_header_type),
  40     ('share_info', share_info_type),
  41     ('other_txs', bitcoin_data.ListType(bitcoin_data.tx_type)),
  42 ])
  43
  44 # type:
  45 # 0: share1a
  46 # 1: share1b
  47
  48 share_type = bitcoin_data.ComposedType([
  49     ('type', bitcoin_data.VarIntType()),
  50     ('contents', bitcoin_data.VarStrType()),
  51 ])
  52
  53 class Share(object):
  54     __slots__ = 'header previous_block share_info merkle_branch other_txs timestamp share_data new_script subsidy previous_hash previous_share_hash target nonce pow_hash header_hash hash time_seen peer donation stale_frac'.split(' ')
  55
  56     @classmethod
  57     def from_share(cls, share, net):
  58         if share['type'] == 0:
  59             res = cls.from_share1a(share1a_type.unpack(share['contents']), net)
  60             if not (res.pow_hash > res.header['target']):
  61                 raise ValueError('invalid share type')
  62             return res
  63         elif share['type'] == 1:
  64             res = cls.from_share1b(share1b_type.unpack(share['contents']), net)
  65             if not (res.pow_hash <= res.header['target']):
  66                 raise ValueError('invalid share type')
  67             return res
  68         else:
  69             raise ValueError('unknown share type: %r' % (share['type'],))
  70
  71     @classmethod
  72     def from_share1a(cls, share1a, net):
  73         return cls(net, **share1a)
  74
  75     @classmethod
  76     def from_share1b(cls, share1b, net):
  77         return cls(net, **share1b)
  78
  79     def __init__(self, net, header, share_info, merkle_branch=None, other_txs=None):
  80         if merkle_branch is None and other_txs is None:
  81             raise ValueError('need either merkle_branch or other_txs')
  82         if other_txs is not None:
  83             new_merkle_branch = bitcoin_data.calculate_merkle_branch([dict(version=0, tx_ins=[], tx_outs=[], lock_time=0)] + other_txs, 0)
  84             if merkle_branch is not None:
  85                 if merke_branch != new_merkle_branch:
  86                     raise ValueError('invalid merkle_branch and other_txs')
  87             merkle_branch = new_merkle_branch
  88
  89         if len(merkle_branch) > 16:
  90             raise ValueError('merkle_branch too long!')
  91
  92         self.header = header
  93         self.previous_block = header['previous_block']
  94         self.share_info = share_info
  95         self.merkle_branch = merkle_branch
  96
  97         self.share_data = self.share_info['share_data']
  98         self.target = self.share_info['target']
  99         self.timestamp = self.share_info['timestamp']
 100
 101         self.new_script = self.share_data['new_script']
 102         self.subsidy = self.share_data['subsidy']
 103         self.donation = self.share_data['donation']
 104
 105         if len(self.new_script) > 100:
 106             raise ValueError('new_script too long!')
 107
 108         self.previous_hash = self.previous_share_hash = self.share_data['previous_share_hash']
 109         self.nonce = self.share_data['nonce']
 110
 111         if len(self.nonce) > 100:
 112             raise ValueError('nonce too long!')
 113
 114         if len(self.share_data['coinbase']) > 100:
 115             raise ValueError('''coinbase too large! %i bytes''' % (len(self.share_data['coinbase']),))
 116
 117         self.pow_hash = net.BITCOIN_POW_FUNC(header)
 118         self.header_hash = bitcoin_data.block_header_type.hash256(header)
 119
 120         self.hash = share1a_type.hash256(self.as_share1a())
 121
 122         if self.pow_hash > self.target:
 123             print 'hash %x' % self.pow_hash
 124             print 'targ %x' % self.target
 125             raise ValueError('not enough work!')
 126
 127         self.stale_frac = self.share_data['stale_frac']/254 if self.share_data['stale_frac'] != 255 else None
 128
 129         self.other_txs = other_txs if self.pow_hash <= self.header['target'] else None
 130
 131         # XXX eww
 132         self.time_seen = time.time()
 133         self.peer = None
 134
 135     def __repr__(self):
 136         return '<Share %s>' % (' '.join('%s=%r' % (k, getattr(self, k)) for k in self.__slots__),)
 137
 138     def check(self, tracker, now, net):
 139         if script.get_sigop_count(self.new_script) > 1:
 140             raise ValueError('too many sigops!')
 141
 142         share_info, gentx = generate_transaction(tracker, self.share_info['share_data'], self.header['target'], self.share_info['timestamp'], net)
 143         if share_info != self.share_info:
 144             raise ValueError('share difficulty invalid')
 145
 146         if bitcoin_data.check_merkle_branch(gentx, 0, self.merkle_branch) != self.header['merkle_root']:
 147             raise ValueError('''gentx doesn't match header via merkle_branch''')
 148
 149     def as_share(self):
 150         if self.pow_hash > self.header['target']: # share1a
 151             return dict(type=0, contents=share1a_type.pack(self.as_share1a()))
 152         elif self.pow_hash <= self.header['target']: # share1b
 153             return dict(type=1, contents=share1b_type.pack(self.as_share1b()))
 154         else:
 155             raise AssertionError()
 156
 157     def as_share1a(self):
 158         return dict(header=self.header, share_info=self.share_info, merkle_branch=self.merkle_branch)
 159
 160     def as_share1b(self):
 161         if self.other_txs is None:
 162             raise ValueError('share does not contain all txs')
 163
 164         return dict(header=self.header, share_info=self.share_info, other_txs=self.other_txs)
 165
 166     def as_block(self, tracker, net):
 167         if self.other_txs is None:
 168             raise ValueError('share does not contain all txs')
 169
 170         share_info, gentx = generate_transaction(tracker, self.share_info['share_data'], self.header['target'], self.share_info['timestamp'], net)
 171         assert share_info == self.share_info
 172
 173         return dict(header=self.header, txs=[gentx] + self.other_txs)
 174
 175 def get_pool_attempts_per_second(tracker, previous_share_hash, dist):
 176     near = tracker.shares[previous_share_hash]
 177     far = tracker.shares[tracker.get_nth_parent_hash(previous_share_hash, dist - 1)]
 178     attempts = tracker.get_work(near.hash) - tracker.get_work(far.hash)
 179     time = near.timestamp - far.timestamp
 180     if time == 0:
 181         time = 1
 182     return attempts//time
 183
 184 def generate_transaction(tracker, share_data, block_target, desired_timestamp, net):
 185     previous_share_hash = share_data['previous_share_hash']
 186     new_script = share_data['new_script']
 187     subsidy = share_data['subsidy']
 188     donation = share_data['donation']
 189     assert 0 <= donation <= 65535
 190
 191     if len(share_data['coinbase']) > 100:
 192         raise ValueError('coinbase too long!')
 193
 194     previous_share = tracker.shares[previous_share_hash] if previous_share_hash is not None else None
 195
 196     chain_length = getattr(net, 'REAL_CHAIN_LENGTH_FUNC', lambda _: net.REAL_CHAIN_LENGTH)(previous_share.timestamp if previous_share is not None else None)
 197
 198     height, last = tracker.get_height_and_last(previous_share_hash)
 199     assert height >= chain_length or last is None
 200     if height < net.TARGET_LOOKBEHIND:
 201         target = bitcoin_data.FloatingInteger.from_target_upper_bound(net.MAX_TARGET)
 202     else:
 203         attempts_per_second = get_pool_attempts_per_second(tracker, previous_share_hash, net.TARGET_LOOKBEHIND)
 204         pre_target = 2**256//(net.SHARE_PERIOD*attempts_per_second) - 1
 205         pre_target2 = math.clip(pre_target, (previous_share.target*9//10, previous_share.target*11//10))
 206         pre_target3 = math.clip(pre_target2, (0, net.MAX_TARGET))
 207         target = bitcoin_data.FloatingInteger.from_target_upper_bound(pre_target3)
 208
 209     attempts_to_block = bitcoin_data.target_to_average_attempts(block_target)
 210     max_att = net.SPREAD * attempts_to_block
 211
 212     this_att = min(bitcoin_data.target_to_average_attempts(target), max_att)
 213     other_weights, other_total_weight, other_donation_weight = tracker.get_cumulative_weights(previous_share_hash, min(height, chain_length), 65535*max(0, max_att - this_att))
 214     assert other_total_weight == sum(other_weights.itervalues()) + other_donation_weight, (other_total_weight, sum(other_weights.itervalues()) + other_donation_weight)
 215     weights, total_weight, donation_weight = math.add_dicts([{new_script: this_att*(65535-donation)}, other_weights]), this_att*65535 + other_total_weight, this_att*donation + other_donation_weight
 216     assert total_weight == sum(weights.itervalues()) + donation_weight, (total_weight, sum(weights.itervalues()) + donation_weight)
 217
 218     SCRIPT = '4104ffd03de44a6e11b9917f3a29f9443283d9871c9d743ef30d5eddcd37094b64d1b3d8090496b53256786bf5c82932ec23c3b74d9f05a6f95a8b5529352656664bac'.decode('hex')
 219
 220     # 1 satoshi is always donated so that a list of p2pool generated blocks can be easily found by looking at the donation address
 221     amounts = dict((script, (subsidy-1)*(199*weight)//(200*total_weight)) for (script, weight) in weights.iteritems())
 222     amounts[new_script] = amounts.get(new_script, 0) + (subsidy-1)//200
 223     amounts[SCRIPT] = amounts.get(SCRIPT, 0) + (subsidy-1)*(199*donation_weight)//(200*total_weight)
 224     amounts[SCRIPT] = amounts.get(SCRIPT, 0) + subsidy - sum(amounts.itervalues()) # collect any extra satoshis :P
 225
 226     if sum(amounts.itervalues()) != subsidy:
 227         raise ValueError()
 228     if any(x < 0 for x in amounts.itervalues()):
 229         raise ValueError()
 230
 231     dests = sorted(amounts.iterkeys(), key=lambda script: (amounts[script], script))
 232     dests = dests[-4000:] # block length limit, unlikely to ever be hit
 233
 234     share_info = dict(
 235         share_data=share_data,
 236         target=target,
 237         timestamp=math.clip(desired_timestamp, (previous_share.timestamp - 60, previous_share.timestamp + 60)) if previous_share is not None else desired_timestamp,
 238     )
 239
 240     return share_info, dict(
 241         version=1,
 242         tx_ins=[dict(
 243             previous_output=None,
 244             sequence=None,
 245             script=share_data['coinbase'].ljust(2, '\x00'),
 246         )],
 247         tx_outs=[dict(value=0, script='\x20' + bitcoin_data.HashType().pack(share_info_type.hash256(share_info)))] + [dict(value=amounts[script], script=script) for script in dests if amounts[script]],
 248         lock_time=0,
 249     )
 250
 251
 252 class OkayTracker(forest.Tracker):
 253     def __init__(self, net):
 254         forest.Tracker.__init__(self)
 255         self.net = net
 256         self.verified = forest.Tracker()
 257         self.verified.get_nth_parent_hash = self.get_nth_parent_hash # self is a superset of self.verified
 258
 259         self.get_cumulative_weights = skiplists.WeightsSkipList(self)
 260
 261     def attempt_verify(self, share, now):
 262         if share.hash in self.verified.shares:
 263             return True
 264         height, last = self.get_height_and_last(share.hash)
 265         if height < self.net.CHAIN_LENGTH + 1 and last is not None:
 266             raise AssertionError()
 267         try:
 268             share.check(self, now, self.net)
 269         except:
 270             log.err(None, 'Share check failed:')
 271             return False
 272         else:
 273             self.verified.add(share)
 274             return True
 275
 276     def think(self, ht, previous_block, now):
 277         desired = set()
 278
 279         # O(len(self.heads))
 280         #   make 'unverified heads' set?
 281         # for each overall head, attempt verification
 282         # if it fails, attempt on parent, and repeat
 283         # if no successful verification because of lack of parents, request parent
 284         bads = set()
 285         for head in set(self.heads) - set(self.verified.heads):
 286             head_height, last = self.get_height_and_last(head)
 287
 288             for share in itertools.islice(self.get_chain_known(head), None if last is None else min(5, max(0, head_height - self.net.CHAIN_LENGTH))):
 289                 if self.attempt_verify(share, now):
 290                     break
 291                 if share.hash in self.heads:
 292                     bads.add(share.hash)
 293             else:
 294                 if last is not None:
 295                     desired.add((self.shares[random.choice(list(self.reverse_shares[last]))].peer, last))
 296         for bad in bads:
 297             assert bad not in self.verified.shares
 298             assert bad in self.heads
 299             if p2pool.DEBUG:
 300                 print "BAD", bad
 301             self.remove(bad)
 302
 303         # try to get at least CHAIN_LENGTH height for each verified head, requesting parents if needed
 304         for head in list(self.verified.heads):
 305             head_height, last_hash = self.verified.get_height_and_last(head)
 306             last_height, last_last_hash = self.get_height_and_last(last_hash)
 307             # XXX review boundary conditions
 308             want = max(self.net.CHAIN_LENGTH - head_height, 0)
 309             can = max(last_height - 1 - self.net.CHAIN_LENGTH, 0) if last_last_hash is not None else last_height
 310             get = min(want, can)
 311             #print 'Z', head_height, last_hash is None, last_height, last_last_hash is None, want, can, get
 312             for share in itertools.islice(self.get_chain_known(last_hash), get):
 313                 if not self.attempt_verify(share, now):
 314                     break
 315             if head_height < self.net.CHAIN_LENGTH and last_last_hash is not None:
 316                 desired.add((self.verified.shares[random.choice(list(self.verified.reverse_shares[last_hash]))].peer, last_last_hash))
 317         if p2pool.DEBUG:
 318             print len(self.verified.tails), "tails:"
 319             for x in self.verified.tails:
 320                 print format_hash(x), self.score(max(self.verified.tails[x], key=self.verified.get_height), ht)
 321
 322         # decide best tree
 323         best_tail = max(self.verified.tails, key=lambda h: self.score(max(self.verified.tails[h], key=self.verified.get_height), ht)) if self.verified.tails else None
 324         # decide best verified head
 325         scores = sorted(self.verified.tails.get(best_tail, []), key=lambda h: (
 326             self.verified.get_work(self.verified.get_nth_parent_hash(h, min(5, self.verified.get_height(h)))),
 327             #self.verified.shares[h].peer is None,
 328             ht.get_height_rel_highest(self.verified.shares[h].previous_block),
 329             -self.verified.shares[h].time_seen
 330         ))
 331
 332
 333         if p2pool.DEBUG:
 334             print len(self.verified.tails), "chain tails and", len(self.verified.tails.get(best_tail, [])), 'chain heads. Top 10 heads:'
 335             if len(scores) > 10:
 336                 print '    ...'
 337             for h in scores[-10:]:
 338                 print '   ', format_hash(h), format_hash(self.verified.shares[h].previous_hash), (
 339                     self.verified.get_work(self.verified.get_nth_parent_hash(h, min(5, self.verified.get_height(h)))),
 340                     self.verified.shares[h].peer is None,
 341                     ht.get_height_rel_highest(self.verified.shares[h].previous_block),
 342                     -self.verified.shares[h].time_seen
 343                 )
 344
 345         # eat away at heads
 346         if scores:
 347             for i in xrange(1000):
 348                 to_remove = set()
 349                 for share_hash, tail in self.heads.iteritems():
 350                     if share_hash in scores[-5:]:
 351                         #print 1
 352                         continue
 353                     if self.shares[share_hash].time_seen > time.time() - 300:
 354                         #print 2
 355                         continue
 356                     if share_hash not in self.verified.shares and max(self.shares[after_tail_hash].time_seen for after_tail_hash in self.reverse_shares.get(tail)) > time.time() - 120: # XXX stupid
 357                         #print 3
 358                         continue
 359                     to_remove.add(share_hash)
 360                 if not to_remove:
 361                     break
 362                 for share_hash in to_remove:
 363                     self.remove(share_hash)
 364                     if share_hash in self.verified.shares:
 365                         self.verified.remove(share_hash)
 366                 #print "_________", to_remove
 367
 368         # drop tails
 369         for i in xrange(1000):
 370             to_remove = set()
 371             for tail, heads in self.tails.iteritems():
 372                 if min(self.get_height(head) for head in heads) < 2*self.net.CHAIN_LENGTH + 10:
 373                     continue
 374                 for aftertail in self.reverse_shares.get(tail, set()):
 375                     if len(self.reverse_shares[self.shares[aftertail].previous_hash]) > 1: # XXX
 376                         print "raw"
 377                         continue
 378                     to_remove.add(aftertail)
 379             if not to_remove:
 380                 break
 381             # if removed from this, it must be removed from verified
 382             #start = time.time()
 383             for aftertail in to_remove:
 384                 if self.shares[aftertail].previous_hash not in self.tails:
 385                     print "erk", aftertail, self.shares[aftertail].previous_hash
 386                     continue
 387                 self.remove(aftertail)
 388                 if aftertail in self.verified.shares:
 389                     self.verified.remove(aftertail)
 390             #end = time.time()
 391             #print "removed! %i %f" % (len(to_remove), (end - start)/len(to_remove))
 392
 393         best = scores[-1] if scores else None
 394
 395         if best is not None:
 396             best_share = self.verified.shares[best]
 397             if ht.get_height_rel_highest(best_share.header['previous_block']) < ht.get_height_rel_highest(previous_block) and best_share.header_hash != previous_block and best_share.peer is not None:
 398                 if p2pool.DEBUG:
 399                     print 'Stale detected! %x < %x' % (best_share.header['previous_block'], previous_block)
 400                 best = best_share.previous_hash
 401
 402         return best, desired
 403
 404     @memoize.memoize_with_backing(expiring_dict.ExpiringDict(5, get_touches=False))
 405     def score(self, share_hash, ht):
 406         head_height, last = self.verified.get_height_and_last(share_hash)
 407         score2 = 0
 408         block_height = 0
 409         max_height = min(self.net.CHAIN_LENGTH, head_height)
 410         for share in reversed(list(itertools.islice(self.verified.get_chain_known(self.verified.get_nth_parent_hash(share_hash, max_height//2)), max_height//2))):
 411             block_height = max(block_height, ht.get_height_rel_highest(share.header['previous_block']))
 412             this_score = (self.verified.get_work(share_hash) - self.verified.get_work(share.hash))//(0 - block_height + 1)
 413             if this_score > score2:
 414                 score2 = this_score
 415         return min(head_height, self.net.CHAIN_LENGTH), score2
 416
 417 def format_hash(x):
 418     if x is None:
 419         return 'xxxxxxxx'
 420     return '%08x' % (x % 2**32)
 421
 422 class ShareStore(object):
 423     def __init__(self, prefix, net):
 424         self.filename = prefix
 425         self.dirname = os.path.dirname(os.path.abspath(prefix))
 426         self.filename = os.path.basename(os.path.abspath(prefix))
 427         self.net = net
 428         self.known = None # will be filename -> set of share hashes, set of verified hashes
 429         self.known_desired = None
 430
 431     def get_shares(self):
 432         if self.known is not None:
 433             raise AssertionError()
 434         known = {}
 435         filenames, next = self.get_filenames_and_next()
 436         for filename in filenames:
 437             share_hashes, verified_hashes = known.setdefault(filename, (set(), set()))
 438             with open(filename, 'rb') as f:
 439                 for line in f:
 440                     try:
 441                         type_id_str, data_hex = line.strip().split(' ')
 442                         type_id = int(type_id_str)
 443                         if type_id == 0:
 444                             pass
 445                         elif type_id == 1:
 446                             pass
 447                         elif type_id == 2:
 448                             verified_hash = int(data_hex, 16)
 449                             yield 'verified_hash', verified_hash
 450                             verified_hashes.add(verified_hash)
 451                         elif type_id == 5:
 452                             share = Share.from_share(share_type.unpack(data_hex.decode('hex')), self.net)
 453                             yield 'share', share
 454                             share_hashes.add(share.hash)
 455                         else:
 456                             raise NotImplementedError("share type %i" % (type_id,))
 457                     except Exception:
 458                         log.err(None, "Error while reading saved shares, continuing where left off:")
 459         self.known = known
 460         self.known_desired = dict((k, (set(a), set(b))) for k, (a, b) in known.iteritems())
 461
 462     def _add_line(self, line):
 463         filenames, next = self.get_filenames_and_next()
 464         if filenames and os.path.getsize(filenames[-1]) < 10e6:
 465             filename = filenames[-1]
 466         else:
 467             filename = next
 468
 469         with open(filename, 'ab') as f:
 470             f.write(line + '\n')
 471
 472         return filename
 473
 474     def add_share(self, share):
 475         for filename, (share_hashes, verified_hashes) in self.known.iteritems():
 476             if share.hash in share_hashes:
 477                 break
 478         else:
 479             filename = self._add_line("%i %s" % (5, share_type.pack(share.as_share()).encode('hex')))
 480             share_hashes, verified_hashes = self.known.setdefault(filename, (set(), set()))
 481             share_hashes.add(share.hash)
 482         share_hashes, verified_hashes = self.known_desired.setdefault(filename, (set(), set()))
 483         share_hashes.add(share.hash)
 484
 485     def add_verified_hash(self, share_hash):
 486         for filename, (share_hashes, verified_hashes) in self.known.iteritems():
 487             if share_hash in verified_hashes:
 488                 break
 489         else:
 490             filename = self._add_line("%i %x" % (2, share_hash))
 491             share_hashes, verified_hashes = self.known.setdefault(filename, (set(), set()))
 492             verified_hashes.add(share_hash)
 493         share_hashes, verified_hashes = self.known_desired.setdefault(filename, (set(), set()))
 494         verified_hashes.add(share_hash)
 495
 496     def get_filenames_and_next(self):
 497         suffixes = sorted(int(x[len(self.filename):]) for x in os.listdir(self.dirname) if x.startswith(self.filename) and x[len(self.filename):].isdigit())
 498         return [os.path.join(self.dirname, self.filename + str(suffix)) for suffix in suffixes], os.path.join(self.dirname, self.filename + (str(suffixes[-1] + 1) if suffixes else str(0)))
 499
 500     def forget_share(self, share_hash):
 501         for filename, (share_hashes, verified_hashes) in self.known_desired.iteritems():
 502             if share_hash in share_hashes:
 503                 share_hashes.remove(share_hash)
 504         self.check_remove()
 505
 506     def forget_verified_share(self, share_hash):
 507         for filename, (share_hashes, verified_hashes) in self.known_desired.iteritems():
 508             if share_hash in verified_hashes:
 509                 verified_hashes.remove(share_hash)
 510         self.check_remove()
 511
 512     def check_remove(self):
 513         to_remove = set()
 514         for filename, (share_hashes, verified_hashes) in self.known_desired.iteritems():
 515             #print filename, len(share_hashes) + len(verified_hashes)
 516             if not share_hashes and not verified_hashes:
 517                 to_remove.add(filename)
 518         for filename in to_remove:
 519             self.known.pop(filename)
 520             self.known_desired.pop(filename)
 521             os.remove(filename)
 522             print "REMOVED", filename