1 from __future__ import division
7 from . import base58, skiplists
8 from p2pool.util import bases, math, variable
11 class EarlyEnd(Exception):
14 class LateEnd(Exception):
17 def read((data, pos), length):
18 data2 = data[pos:pos + length]
19 if len(data2) != length:
21 return data2, (data, pos + length)
23 def size((data, pos)):
24 return len(data) - pos
27 # the same data can have only one unpacked representation, but multiple packed binary representations
30 # return hash(tuple(self.__dict__.items()))
32 #def __eq__(self, other):
33 # if not isinstance(other, Type):
34 # raise NotImplementedError()
35 # return self.__dict__ == other.__dict__
37 def _unpack(self, data):
38 obj, (data2, pos) = self.read((data, 0))
48 f = self.write(None, obj)
58 def unpack(self, data):
59 obj = self._unpack(data)
62 data2 = self._pack(obj)
64 if self._unpack(data2) != obj:
65 raise AssertionError()
70 data = self._pack(obj)
73 if self._unpack(data) != obj:
74 raise AssertionError()
79 def pack_base58(self, obj):
80 return base58.base58_encode(self.pack(obj))
82 def unpack_base58(self, base58_data):
83 return self.unpack(base58.base58_decode(base58_data))
86 def hash160(self, obj):
87 return ShortHashType().unpack(hashlib.new('ripemd160', hashlib.sha256(self.pack(obj)).digest()).digest())
89 def hash256(self, obj):
90 return HashType().unpack(hashlib.sha256(hashlib.sha256(self.pack(obj)).digest()).digest())
92 class VarIntType(Type):
93 # redundancy doesn't matter here because bitcoin and p2pool both reencode before hashing
95 data, file = read(file, 1)
100 desc, length = '<H', 2
102 desc, length = '<I', 4
104 desc, length = '<Q', 8
106 raise AssertionError()
107 data, file = read(file, length)
108 return struct.unpack(desc, data)[0], file
110 def write(self, file, item):
112 file = file, struct.pack('<B', item)
114 file = file, struct.pack('<BH', 0xfd, item)
115 elif item <= 0xffffffff:
116 file = file, struct.pack('<BI', 0xfe, item)
117 elif item <= 0xffffffffffffffff:
118 file = file, struct.pack('<BQ', 0xff, item)
120 raise ValueError('int too large for varint')
123 class VarStrType(Type):
124 _inner_size = VarIntType()
126 def read(self, file):
127 length, file = self._inner_size.read(file)
128 return read(file, length)
130 def write(self, file, item):
131 return self._inner_size.write(file, len(item)), item
133 class FixedStrType(Type):
134 def __init__(self, length):
137 def read(self, file):
138 return read(file, self.length)
140 def write(self, file, item):
141 if len(item) != self.length:
142 raise ValueError('incorrect length item!')
145 class EnumType(Type):
146 def __init__(self, inner, values):
151 for k, v in values.iteritems():
153 raise ValueError('duplicate value in values')
156 def read(self, file):
157 data, file = self.inner.read(file)
158 if data not in self.keys:
159 raise ValueError('enum data (%r) not in values (%r)' % (data, self.values))
160 return self.keys[data], file
162 def write(self, file, item):
163 if item not in self.values:
164 raise ValueError('enum item (%r) not in values (%r)' % (item, self.values))
165 return self.inner.write(file, self.values[item])
167 class HashType(Type):
168 def read(self, file):
169 data, file = read(file, 256//8)
170 return int(data[::-1].encode('hex'), 16), file
172 def write(self, file, item):
173 if not 0 <= item < 2**256:
174 raise ValueError('invalid hash value - %r' % (item,))
175 if item != 0 and item < 2**160:
176 print 'Very low hash value - maybe you meant to use ShortHashType? %x' % (item,)
177 return file, ('%064x' % (item,)).decode('hex')[::-1]
179 class ShortHashType(Type):
180 def read(self, file):
181 data, file = read(file, 160//8)
182 return int(data[::-1].encode('hex'), 16), file
184 def write(self, file, item):
185 if not 0 <= item < 2**160:
186 raise ValueError('invalid hash value - %r' % (item,))
187 return file, ('%040x' % (item,)).decode('hex')[::-1]
189 class ListType(Type):
190 _inner_size = VarIntType()
192 def __init__(self, type):
195 def read(self, file):
196 length, file = self._inner_size.read(file)
198 for i in xrange(length):
199 item, file = self.type.read(file)
203 def write(self, file, item):
204 file = self._inner_size.write(file, len(item))
206 file = self.type.write(file, subitem)
209 class StructType(Type):
210 def __init__(self, desc):
212 self.length = struct.calcsize(self.desc)
214 def read(self, file):
215 data, file = read(file, self.length)
216 res, = struct.unpack(self.desc, data)
219 def write(self, file, item):
220 data = struct.pack(self.desc, item)
221 if struct.unpack(self.desc, data)[0] != item:
222 # special test because struct doesn't error on some overflows
223 raise ValueError('''item didn't survive pack cycle (%r)''' % (item,))
226 class IPV6AddressType(Type):
227 def read(self, file):
228 data, file = read(file, 16)
229 if data[:12] != '00000000000000000000ffff'.decode('hex'):
230 raise ValueError('ipv6 addresses not supported yet')
231 return '.'.join(str(ord(x)) for x in data[12:]), file
233 def write(self, file, item):
234 bits = map(int, item.split('.'))
236 raise ValueError('invalid address: %r' % (bits,))
237 data = '00000000000000000000ffff'.decode('hex') + ''.join(chr(x) for x in bits)
238 assert len(data) == 16, len(data)
243 def get_record(fields):
244 fields = tuple(sorted(fields))
247 if fields not in _record_types:
248 class _Record(object):
250 def __getitem__(self, key):
251 return getattr(self, key)
252 def __setitem__(self, key, value):
253 setattr(self, key, value)
255 # for field in self.__slots__:
256 # yield field, getattr(self, field)
258 return self.__slots__
259 def __eq__(self, other):
260 if isinstance(other, dict):
261 return dict(self) == other
262 elif isinstance(other, _Record):
263 return all(self[k] == other[k] for k in self.keys())
265 def __ne__(self, other):
266 return not (self == other)
267 _record_types[fields] = _Record
268 return _record_types[fields]()
270 class ComposedType(Type):
271 def __init__(self, fields):
274 def read(self, file):
275 item = get_record(k for k, v in self.fields)
276 for key, type_ in self.fields:
277 item[key], file = type_.read(file)
280 def write(self, file, item):
281 for key, type_ in self.fields:
282 file = type_.write(file, item[key])
285 class ChecksummedType(Type):
286 def __init__(self, inner):
289 def read(self, file):
290 obj, file = self.inner.read(file)
291 data = self.inner.pack(obj)
293 checksum, file = read(file, 4)
294 if checksum != hashlib.sha256(hashlib.sha256(data).digest()).digest()[:4]:
295 raise ValueError('invalid checksum')
299 def write(self, file, item):
300 data = self.inner.pack(item)
301 return (file, data), hashlib.sha256(hashlib.sha256(data).digest()).digest()[:4]
303 class FloatingIntegerType(Type):
304 # redundancy doesn't matter here because bitcoin checks binary bits against its own computed bits
305 # so it will always be encoded 'normally' in blocks (they way bitcoin does it)
306 _inner = StructType('<I')
308 def read(self, file):
309 bits, file = self._inner.read(file)
310 target = self._bits_to_target(bits)
312 if self._target_to_bits(target) != bits:
313 raise ValueError('bits in non-canonical form')
316 def write(self, file, item):
317 return self._inner.write(file, self._target_to_bits(item))
319 def truncate_to(self, x):
320 return self._bits_to_target(self._target_to_bits(x, _check=False))
322 def _bits_to_target(self, bits2):
323 target = math.shift_left(bits2 & 0x00ffffff, 8 * ((bits2 >> 24) - 3))
325 assert target == self._bits_to_target1(struct.pack('<I', bits2))
326 assert self._target_to_bits(target, _check=False) == bits2, (target, self._target_to_bits(target, _check=False), bits2)
329 def _bits_to_target1(self, bits):
331 length = ord(bits[0])
332 return bases.string_to_natural((bits[1:] + '\0'*length)[:length])
334 def _target_to_bits(self, target, _check=True):
335 n = bases.natural_to_string(target)
336 if n and ord(n[0]) >= 128:
338 bits2 = (chr(len(n)) + (n + 3*chr(0))[:3])[::-1]
339 bits = struct.unpack('<I', bits2)[0]
341 if self._bits_to_target(bits) != target:
342 raise ValueError(repr((target, self._bits_to_target(bits, _check=False))))
345 class PossiblyNone(Type):
346 def __init__(self, none_value, inner):
347 self.none_value = none_value
350 def read(self, file):
351 value, file = self.inner.read(file)
352 return None if value == self.none_value else value, file
354 def write(self, file, item):
355 if item == self.none_value:
356 raise ValueError('none_value used')
357 return self.inner.write(file, self.none_value if item is None else item)
359 address_type = ComposedType([
360 ('services', StructType('<Q')),
361 ('address', IPV6AddressType()),
362 ('port', StructType('>H')),
365 tx_type = ComposedType([
366 ('version', StructType('<I')),
367 ('tx_ins', ListType(ComposedType([
368 ('previous_output', PossiblyNone(dict(hash=0, index=2**32 - 1), ComposedType([
369 ('hash', HashType()),
370 ('index', StructType('<I')),
372 ('script', VarStrType()),
373 ('sequence', PossiblyNone(2**32 - 1, StructType('<I'))),
375 ('tx_outs', ListType(ComposedType([
376 ('value', StructType('<Q')),
377 ('script', VarStrType()),
379 ('lock_time', StructType('<I')),
382 block_header_type = ComposedType([
383 ('version', StructType('<I')),
384 ('previous_block', PossiblyNone(0, HashType())),
385 ('merkle_root', HashType()),
386 ('timestamp', StructType('<I')),
387 ('target', FloatingIntegerType()),
388 ('nonce', StructType('<I')),
391 block_type = ComposedType([
392 ('header', block_header_type),
393 ('txs', ListType(tx_type)),
397 merkle_record_type = ComposedType([
398 ('left', HashType()),
399 ('right', HashType()),
402 def merkle_hash(tx_list):
405 hash_list = map(tx_type.hash256, tx_list)
406 while len(hash_list) > 1:
407 hash_list = [merkle_record_type.hash256(dict(left=left, right=left if right is None else right))
408 for left, right in zip(hash_list[::2], hash_list[1::2] + [None])]
411 def target_to_average_attempts(target):
412 return 2**256//(target + 1)
416 def tx_get_sigop_count(tx):
417 return sum(script.get_sigop_count(txin['script']) for txin in tx['tx_ins']) + sum(script.get_sigop_count(txout['script']) for txout in tx['tx_outs'])
421 human_address_type = ChecksummedType(ComposedType([
422 ('version', StructType('<B')),
423 ('pubkey_hash', ShortHashType()),
426 pubkey_type = FixedStrType(65)
428 def pubkey_hash_to_address(pubkey_hash, net):
429 return human_address_type.pack_base58(dict(version=net.BITCOIN_ADDRESS_VERSION, pubkey_hash=pubkey_hash))
431 def pubkey_to_address(pubkey, net):
432 return pubkey_hash_to_address(pubkey_type.hash160(pubkey), net)
434 def address_to_pubkey_hash(address, net):
435 x = human_address_type.unpack_base58(address)
436 if x['version'] != net.BITCOIN_ADDRESS_VERSION:
437 raise ValueError('address not for this net!')
438 return x['pubkey_hash']
442 def pubkey_to_script2(pubkey):
443 return ('\x41' + pubkey_type.pack(pubkey)) + '\xac'
445 def pubkey_hash_to_script2(pubkey_hash):
446 return '\x76\xa9' + ('\x14' + ShortHashType().pack(pubkey_hash)) + '\x88\xac'
448 def script2_to_human(script2, net):
450 pubkey = script2[1:-1]
451 script2_test = pubkey_to_script2(pubkey)
455 if script2_test == script2:
456 return 'Pubkey. Address: %s' % (pubkey_to_address(pubkey, net),)
459 pubkey_hash = ShortHashType().unpack(script2[3:-2])
460 script2_test2 = pubkey_hash_to_script2(pubkey_hash)
464 if script2_test2 == script2:
465 return 'Address. Address: %s' % (pubkey_hash_to_address(pubkey_hash, net),)
467 return 'Unknown. Script: %s' % (script2.encode('hex'),)
469 # linked list tracker
471 class Tracker(object):
473 self.shares = {} # hash -> share
474 #self.ids = {} # hash -> (id, height)
475 self.reverse_shares = {} # previous_hash -> set of share_hashes
477 self.heads = {} # head hash -> tail_hash
478 self.tails = {} # tail hash -> set of head hashes
480 self.heights = {} # share_hash -> height_to, ref, work_inc
481 self.reverse_heights = {} # ref -> set of share_hashes
483 self.ref_generator = itertools.count()
484 self.height_refs = {} # ref -> height, share_hash, work_inc
485 self.reverse_height_refs = {} # share_hash -> ref
487 self.get_nth_parent_hash = skiplists.DistanceSkipList(self)
489 self.added = variable.Event()
490 self.removed = variable.Event()
492 def add(self, share):
493 assert not isinstance(share, (int, long, type(None)))
494 if share.hash in self.shares:
495 raise ValueError('share already present')
497 if share.hash in self.tails:
498 heads = self.tails.pop(share.hash)
500 heads = set([share.hash])
502 if share.previous_hash in self.heads:
503 tail = self.heads.pop(share.previous_hash)
505 tail = self.get_last(share.previous_hash)
506 #tail2 = share.previous_hash
507 #while tail2 in self.shares:
508 # tail2 = self.shares[tail2].previous_hash
509 #assert tail == tail2
511 self.shares[share.hash] = share
512 self.reverse_shares.setdefault(share.previous_hash, set()).add(share.hash)
514 self.tails.setdefault(tail, set()).update(heads)
515 if share.previous_hash in self.tails[tail]:
516 self.tails[tail].remove(share.previous_hash)
519 self.heads[head] = tail
521 self.added.happened(share)
525 for s in self.shares.itervalues():
528 assert self.shares == t.shares, (self.shares, t.shares)
529 assert self.reverse_shares == t.reverse_shares, (self.reverse_shares, t.reverse_shares)
530 assert self.heads == t.heads, (self.heads, t.heads)
531 assert self.tails == t.tails, (self.tails, t.tails)
533 def remove(self, share_hash):
534 assert isinstance(share_hash, (int, long, type(None)))
535 if share_hash not in self.shares:
538 share = self.shares[share_hash]
541 children = self.reverse_shares.get(share.hash, set())
543 # move height refs referencing children down to this, so they can be moved up in one step
544 if share.previous_hash in self.reverse_height_refs:
545 for x in list(self.reverse_heights.get(self.reverse_height_refs.get(share.hash, object()), set())):
547 assert share.hash not in self.reverse_height_refs, list(self.reverse_heights.get(self.reverse_height_refs.get(share.hash, None), set()))
549 if share.hash in self.heads and share.previous_hash in self.tails:
550 tail = self.heads.pop(share.hash)
551 self.tails[tail].remove(share.hash)
552 if not self.tails[share.previous_hash]:
553 self.tails.pop(share.previous_hash)
554 elif share.hash in self.heads:
555 tail = self.heads.pop(share.hash)
556 self.tails[tail].remove(share.hash)
557 if self.reverse_shares[share.previous_hash] != set([share.hash]):
560 self.tails[tail].add(share.previous_hash)
561 self.heads[share.previous_hash] = tail
562 elif share.previous_hash in self.tails:
563 heads = self.tails[share.previous_hash]
564 if len(self.reverse_shares[share.previous_hash]) > 1:
565 raise NotImplementedError()
567 del self.tails[share.previous_hash]
569 self.heads[head] = share.hash
570 self.tails[share.hash] = set(heads)
572 raise NotImplementedError()
574 # move ref pointing to this up
575 if share.previous_hash in self.reverse_height_refs:
576 assert share.hash not in self.reverse_height_refs, list(self.reverse_heights.get(self.reverse_height_refs.get(share.hash, object()), set()))
578 ref = self.reverse_height_refs[share.previous_hash]
579 cur_height, cur_hash, cur_work = self.height_refs[ref]
580 assert cur_hash == share.previous_hash
581 self.height_refs[ref] = cur_height - 1, share.hash, cur_work - target_to_average_attempts(share.target)
582 del self.reverse_height_refs[share.previous_hash]
583 self.reverse_height_refs[share.hash] = ref
585 # delete height entry, and ref if it is empty
586 if share.hash in self.heights:
587 _, ref, _ = self.heights.pop(share.hash)
588 self.reverse_heights[ref].remove(share.hash)
589 if not self.reverse_heights[ref]:
590 del self.reverse_heights[ref]
591 _, ref_hash, _ = self.height_refs.pop(ref)
592 del self.reverse_height_refs[ref_hash]
594 self.shares.pop(share.hash)
595 self.reverse_shares[share.previous_hash].remove(share.hash)
596 if not self.reverse_shares[share.previous_hash]:
597 self.reverse_shares.pop(share.previous_hash)
599 #assert self.test() is None
600 self.removed.happened(share)
602 def get_height(self, share_hash):
603 height, work, last = self.get_height_work_and_last(share_hash)
606 def get_work(self, share_hash):
607 height, work, last = self.get_height_work_and_last(share_hash)
610 def get_last(self, share_hash):
611 height, work, last = self.get_height_work_and_last(share_hash)
614 def get_height_and_last(self, share_hash):
615 height, work, last = self.get_height_work_and_last(share_hash)
618 def _get_height_jump(self, share_hash):
619 if share_hash in self.heights:
620 height_to1, ref, work_inc1 = self.heights[share_hash]
621 height_to2, share_hash, work_inc2 = self.height_refs[ref]
622 height_inc = height_to1 + height_to2
623 work_inc = work_inc1 + work_inc2
625 height_inc, share_hash, work_inc = 1, self.shares[share_hash].previous_hash, target_to_average_attempts(self.shares[share_hash].target)
626 return height_inc, share_hash, work_inc
628 def _set_height_jump(self, share_hash, height_inc, other_share_hash, work_inc):
629 if other_share_hash not in self.reverse_height_refs:
630 ref = self.ref_generator.next()
631 assert ref not in self.height_refs
632 self.height_refs[ref] = 0, other_share_hash, 0
633 self.reverse_height_refs[other_share_hash] = ref
636 ref = self.reverse_height_refs[other_share_hash]
637 ref_height_to, ref_share_hash, ref_work_inc = self.height_refs[ref]
638 assert ref_share_hash == other_share_hash
640 if share_hash in self.heights:
641 prev_ref = self.heights[share_hash][1]
642 self.reverse_heights[prev_ref].remove(share_hash)
643 if not self.reverse_heights[prev_ref] and prev_ref != ref:
644 self.reverse_heights.pop(prev_ref)
645 _, x, _ = self.height_refs.pop(prev_ref)
646 self.reverse_height_refs.pop(x)
647 self.heights[share_hash] = height_inc - ref_height_to, ref, work_inc - ref_work_inc
648 self.reverse_heights.setdefault(ref, set()).add(share_hash)
650 def get_height_work_and_last(self, share_hash):
651 assert isinstance(share_hash, (int, long, type(None)))
656 while share_hash in self.shares:
657 updates.append((share_hash, height, work))
658 height_inc, share_hash, work_inc = self._get_height_jump(share_hash)
661 for update_hash, height_then, work_then in updates:
662 self._set_height_jump(update_hash, height - height_then, share_hash, work - work_then)
663 return height, work, share_hash
665 def get_chain_known(self, start_hash):
666 assert isinstance(start_hash, (int, long, type(None)))
668 Chain starting with item of hash I{start_hash} of items that this Tracker contains
670 item_hash_to_get = start_hash
672 if item_hash_to_get not in self.shares:
674 share = self.shares[item_hash_to_get]
675 assert not isinstance(share, long)
677 item_hash_to_get = share.previous_hash
679 def get_chain_to_root(self, start_hash, root=None):
680 assert isinstance(start_hash, (int, long, type(None)))
681 assert isinstance(root, (int, long, type(None)))
683 Chain of hashes starting with share_hash of shares to the root (doesn't include root)
684 Raises an error if one is missing
686 share_hash_to_get = start_hash
687 while share_hash_to_get != root:
688 share = self.shares[share_hash_to_get]
690 share_hash_to_get = share.previous_hash
692 def get_best_hash(self):
694 Returns hash of item with the most items in its chain
698 return max(self.heads, key=self.get_height_and_last)
700 def get_highest_height(self):
701 return max(self.get_height_and_last(head)[0] for head in self.heads) if self.heads else 0
703 class FakeShare(object):
704 def __init__(self, **kwargs):
705 self.__dict__.update(kwargs)
707 if __name__ == '__main__':
711 for i in xrange(10000):
712 t.add(FakeShare(hash=i, previous_hash=i - 1 if i > 0 else None))
716 print 'HEADS', t.heads
717 print 'TAILS', t.tails
726 for i in xrange(random.randrange(100)):
727 x = random.choice(list(t.shares) + [None])
729 t.add(FakeShare(i, x))
731 x = random.choice(list(t.shares))
732 print 'DEL', x, t.__dict__
735 except NotImplementedError:
736 print 'aborted; not implemented'
739 print 'HEADS', t.heads
740 print 'TAILS', t.tails
742 #for share_hash, share in sorted(t.shares.iteritems()):
743 # print share_hash, share.previous_hash, t.heads.get(share_hash), t.tails.get(share_hash)
745 #import sys;sys.exit()
747 print t.get_nth_parent_hash(9000, 5000)
748 print t.get_nth_parent_hash(9001, 412)
749 #print t.get_nth_parent_hash(90, 51)
751 for share_hash in sorted(t.shares):
752 print str(share_hash).rjust(4),
753 x = t.skips.get(share_hash, None)
755 print str(x[0]).rjust(4),
757 print str(a).rjust(10),
760 # network definitions
762 class Mainnet(object):
763 BITCOIN_P2P_PREFIX = 'f9beb4d9'.decode('hex')
764 BITCOIN_P2P_PORT = 8333
765 BITCOIN_ADDRESS_VERSION = 0
767 class Testnet(object):
768 BITCOIN_P2P_PREFIX = 'fabfb5da'.decode('hex')
769 BITCOIN_P2P_PORT = 18333
770 BITCOIN_ADDRESS_VERSION = 111