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