p2pool/bitcoin/data.py

   1 from __future__ import division
   2
   3 import binascii
   4 import hashlib
   5 import struct
   6
   7 from . import base58
   8 from p2pool.util import bases, math
   9 import p2pool
  10
  11 class EarlyEnd(Exception):
  12     pass
  13
  14 class LateEnd(Exception):
  15     pass
  16
  17 def read((data, pos), length):
  18     data2 = data[pos:pos + length]
  19     if len(data2) != length:
  20         raise EarlyEnd()
  21     return data2, (data, pos + length)
  22
  23 def size((data, pos)):
  24     return len(data) - pos
  25
  26 class Type(object):
  27     __slots__ = []
  28
  29     # the same data can have only one unpacked representation, but multiple packed binary representations
  30
  31     def __hash__(self):
  32         rval = getattr(self, '_hash', None)
  33         if rval is None:
  34             try:
  35                 rval = self._hash = hash((type(self), frozenset(self.__dict__.items())))
  36             except:
  37                 print self.__dict__
  38                 raise
  39         return rval
  40
  41     def __eq__(self, other):
  42         return type(other) is type(self) and other.__dict__ == self.__dict__
  43
  44     def __ne__(self, other):
  45         return not (self == other)
  46
  47     def _unpack(self, data):
  48         obj, (data2, pos) = self.read((data, 0))
  49
  50         assert data2 is data
  51
  52         if pos != len(data):
  53             raise LateEnd()
  54
  55         return obj
  56
  57     def _pack(self, obj):
  58         f = self.write(None, obj)
  59
  60         res = []
  61         while f is not None:
  62             res.append(f[1])
  63             f = f[0]
  64         res.reverse()
  65         return ''.join(res)
  66
  67
  68     def unpack(self, data):
  69         obj = self._unpack(data)
  70
  71         if p2pool.DEBUG:
  72             data2 = self._pack(obj)
  73             if data2 != data:
  74                 if self._unpack(data2) != obj:
  75                     raise AssertionError()
  76
  77         return obj
  78
  79     def pack(self, obj):
  80         data = self._pack(obj)
  81
  82         if p2pool.DEBUG:
  83             if self._unpack(data) != obj:
  84                 raise AssertionError((self._unpack(data), obj))
  85
  86         return data
  87
  88
  89     def pack_base58(self, obj):
  90         return base58.encode(self.pack(obj))
  91
  92     def unpack_base58(self, base58_data):
  93         return self.unpack(base58.decode(base58_data))
  94
  95
  96     def hash160(self, obj):
  97         return IntType(160).unpack(hashlib.new('ripemd160', hashlib.sha256(self.pack(obj)).digest()).digest())
  98
  99     def hash256(self, obj):
 100         return IntType(256).unpack(hashlib.sha256(hashlib.sha256(self.pack(obj)).digest()).digest())
 101
 102     def scrypt(self, obj):
 103         import ltc_scrypt
 104         return IntType(256).unpack(ltc_scrypt.getPoWHash(self.pack(obj)))
 105
 106 class VarIntType(Type):
 107     # redundancy doesn't matter here because bitcoin and p2pool both reencode before hashing
 108     def read(self, file):
 109         data, file = read(file, 1)
 110         first = ord(data)
 111         if first < 0xfd:
 112             return first, file
 113         elif first == 0xfd:
 114             desc, length = '<H', 2
 115         elif first == 0xfe:
 116             desc, length = '<I', 4
 117         elif first == 0xff:
 118             desc, length = '<Q', 8
 119         else:
 120             raise AssertionError()
 121         data, file = read(file, length)
 122         return struct.unpack(desc, data)[0], file
 123
 124     def write(self, file, item):
 125         if item < 0xfd:
 126             file = file, struct.pack('<B', item)
 127         elif item <= 0xffff:
 128             file = file, struct.pack('<BH', 0xfd, item)
 129         elif item <= 0xffffffff:
 130             file = file, struct.pack('<BI', 0xfe, item)
 131         elif item <= 0xffffffffffffffff:
 132             file = file, struct.pack('<BQ', 0xff, item)
 133         else:
 134             raise ValueError('int too large for varint')
 135         return file
 136
 137 class VarStrType(Type):
 138     _inner_size = VarIntType()
 139
 140     def read(self, file):
 141         length, file = self._inner_size.read(file)
 142         return read(file, length)
 143
 144     def write(self, file, item):
 145         return self._inner_size.write(file, len(item)), item
 146
 147 class PassthruType(Type):
 148     def read(self, file):
 149         return read(file, size(file))
 150
 151     def write(self, file, item):
 152         return file, item
 153
 154 class EnumType(Type):
 155     def __init__(self, inner, values):
 156         self.inner = inner
 157         self.values = values
 158
 159         keys = {}
 160         for k, v in values.iteritems():
 161             if v in keys:
 162                 raise ValueError('duplicate value in values')
 163             keys[v] = k
 164         self.keys = keys
 165
 166     def read(self, file):
 167         data, file = self.inner.read(file)
 168         if data not in self.keys:
 169             raise ValueError('enum data (%r) not in values (%r)' % (data, self.values))
 170         return self.keys[data], file
 171
 172     def write(self, file, item):
 173         if item not in self.values:
 174             raise ValueError('enum item (%r) not in values (%r)' % (item, self.values))
 175         return self.inner.write(file, self.values[item])
 176
 177 class ListType(Type):
 178     _inner_size = VarIntType()
 179
 180     def __init__(self, type):
 181         self.type = type
 182
 183     def read(self, file):
 184         length, file = self._inner_size.read(file)
 185         res = []
 186         for i in xrange(length):
 187             item, file = self.type.read(file)
 188             res.append(item)
 189         return res, file
 190
 191     def write(self, file, item):
 192         file = self._inner_size.write(file, len(item))
 193         for subitem in item:
 194             file = self.type.write(file, subitem)
 195         return file
 196
 197 class StructType(Type):
 198     __slots__ = 'desc length'.split(' ')
 199
 200     def __init__(self, desc):
 201         self.desc = desc
 202         self.length = struct.calcsize(self.desc)
 203
 204     def read(self, file):
 205         data, file = read(file, self.length)
 206         return struct.unpack(self.desc, data)[0], file
 207
 208     def write(self, file, item):
 209         return file, struct.pack(self.desc, item)
 210
 211 class IntType(Type):
 212     __slots__ = 'bytes step format_str max'.split(' ')
 213
 214     def __new__(cls, bits, endianness='little'):
 215         assert bits % 8 == 0
 216         assert endianness in ['little', 'big']
 217         if bits in [8, 16, 32, 64]:
 218             return StructType(('<' if endianness == 'little' else '>') + {8: 'B', 16: 'H', 32: 'I', 64: 'Q'}[bits])
 219         else:
 220             return object.__new__(cls, bits, endianness)
 221
 222     def __init__(self, bits, endianness='little'):
 223         assert bits % 8 == 0
 224         assert endianness in ['little', 'big']
 225         self.bytes = bits//8
 226         self.step = -1 if endianness == 'little' else 1
 227         self.format_str = '%%0%ix' % (2*self.bytes)
 228         self.max = 2**bits
 229
 230     def read(self, file, b2a_hex=binascii.b2a_hex):
 231         data, file = read(file, self.bytes)
 232         return int(b2a_hex(data[::self.step]), 16), file
 233
 234     def write(self, file, item, a2b_hex=binascii.a2b_hex):
 235         if not 0 <= item < self.max:
 236             raise ValueError('invalid int value - %r' % (item,))
 237         return file, a2b_hex(self.format_str % (item,))[::self.step]
 238
 239 class IPV6AddressType(Type):
 240     def read(self, file):
 241         data, file = read(file, 16)
 242         if data[:12] != '00000000000000000000ffff'.decode('hex'):
 243             raise ValueError('ipv6 addresses not supported yet')
 244         return '.'.join(str(ord(x)) for x in data[12:]), file
 245
 246     def write(self, file, item):
 247         bits = map(int, item.split('.'))
 248         if len(bits) != 4:
 249             raise ValueError('invalid address: %r' % (bits,))
 250         data = '00000000000000000000ffff'.decode('hex') + ''.join(chr(x) for x in bits)
 251         assert len(data) == 16, len(data)
 252         return file, data
 253
 254 _record_types = {}
 255
 256 def get_record(fields):
 257     fields = tuple(sorted(fields))
 258     if 'keys' in fields:
 259         raise ValueError()
 260     if fields not in _record_types:
 261         class _Record(object):
 262             __slots__ = fields
 263             def __repr__(self):
 264                 return repr(dict(self))
 265             def __getitem__(self, key):
 266                 return getattr(self, key)
 267             def __setitem__(self, key, value):
 268                 setattr(self, key, value)
 269             #def __iter__(self):
 270             #    for field in self.__slots__:
 271             #        yield field, getattr(self, field)
 272             def keys(self):
 273                 return self.__slots__
 274             def __eq__(self, other):
 275                 if isinstance(other, dict):
 276                     return dict(self) == other
 277                 elif isinstance(other, _Record):
 278                     return all(self[k] == other[k] for k in self.keys())
 279                 raise TypeError()
 280             def __ne__(self, other):
 281                 return not (self == other)
 282         _record_types[fields] = _Record
 283     return _record_types[fields]()
 284
 285 class ComposedType(Type):
 286     def __init__(self, fields):
 287         self.fields = tuple(fields)
 288
 289     def read(self, file):
 290         item = get_record(k for k, v in self.fields)
 291         for key, type_ in self.fields:
 292             item[key], file = type_.read(file)
 293         return item, file
 294
 295     def write(self, file, item):
 296         for key, type_ in self.fields:
 297             file = type_.write(file, item[key])
 298         return file
 299
 300 class ChecksummedType(Type):
 301     def __init__(self, inner):
 302         self.inner = inner
 303
 304     def read(self, file):
 305         obj, file = self.inner.read(file)
 306         data = self.inner.pack(obj)
 307
 308         checksum, file = read(file, 4)
 309         if checksum != hashlib.sha256(hashlib.sha256(data).digest()).digest()[:4]:
 310             raise ValueError('invalid checksum')
 311
 312         return obj, file
 313
 314     def write(self, file, item):
 315         data = self.inner.pack(item)
 316         return (file, data), hashlib.sha256(hashlib.sha256(data).digest()).digest()[:4]
 317
 318 class FloatingInteger(object):
 319     __slots__ = ['bits', '_target']
 320
 321     @classmethod
 322     def from_target_upper_bound(cls, target):
 323         n = bases.natural_to_string(target)
 324         if n and ord(n[0]) >= 128:
 325             n = '\x00' + n
 326         bits2 = (chr(len(n)) + (n + 3*chr(0))[:3])[::-1]
 327         bits = struct.unpack('<I', bits2)[0]
 328         return cls(bits)
 329
 330     def __init__(self, bits, target=None):
 331         self.bits = bits
 332         self._target = None
 333         if target is not None and self.target != target:
 334             raise ValueError('target does not match')
 335
 336     @property
 337     def target(self):
 338         res = self._target
 339         if res is None:
 340             res = self._target = math.shift_left(self.bits & 0x00ffffff, 8 * ((self.bits >> 24) - 3))
 341         return res
 342
 343     def __hash__(self):
 344         return hash(self.bits)
 345
 346     def __eq__(self, other):
 347         return self.bits == other.bits
 348
 349     def __ne__(self, other):
 350         return not (self == other)
 351
 352     def __cmp__(self, other):
 353         assert False
 354
 355     def __repr__(self):
 356         return 'FloatingInteger(bits=%s, target=%s)' % (hex(self.bits), hex(self.target))
 357
 358 class FloatingIntegerType(Type):
 359     _inner = IntType(32)
 360
 361     def read(self, file):
 362         bits, file = self._inner.read(file)
 363         return FloatingInteger(bits), file
 364
 365     def write(self, file, item):
 366         return self._inner.write(file, item.bits)
 367
 368 class PossiblyNoneType(Type):
 369     def __init__(self, none_value, inner):
 370         self.none_value = none_value
 371         self.inner = inner
 372
 373     def read(self, file):
 374         value, file = self.inner.read(file)
 375         return None if value == self.none_value else value, file
 376
 377     def write(self, file, item):
 378         if item == self.none_value:
 379             raise ValueError('none_value used')
 380         return self.inner.write(file, self.none_value if item is None else item)
 381
 382 address_type = ComposedType([
 383     ('services', IntType(64)),
 384     ('address', IPV6AddressType()),
 385     ('port', IntType(16, 'big')),
 386 ])
 387
 388 tx_type = ComposedType([
 389     ('version', IntType(32)),
 390     ('tx_ins', ListType(ComposedType([
 391         ('previous_output', PossiblyNoneType(dict(hash=0, index=2**32 - 1), ComposedType([
 392             ('hash', IntType(256)),
 393             ('index', IntType(32)),
 394         ]))),
 395         ('script', VarStrType()),
 396         ('sequence', PossiblyNoneType(2**32 - 1, IntType(32))),
 397     ]))),
 398     ('tx_outs', ListType(ComposedType([
 399         ('value', IntType(64)),
 400         ('script', VarStrType()),
 401     ]))),
 402     ('lock_time', IntType(32)),
 403 ])
 404
 405 merkle_branch_type = ListType(IntType(256))
 406
 407 merkle_tx_type = ComposedType([
 408     ('tx', tx_type),
 409     ('block_hash', IntType(256)),
 410     ('merkle_branch', merkle_branch_type),
 411     ('index', IntType(32)),
 412 ])
 413
 414 block_header_type = ComposedType([
 415     ('version', IntType(32)),
 416     ('previous_block', PossiblyNoneType(0, IntType(256))),
 417     ('merkle_root', IntType(256)),
 418     ('timestamp', IntType(32)),
 419     ('bits', FloatingIntegerType()),
 420     ('nonce', IntType(32)),
 421 ])
 422
 423 block_type = ComposedType([
 424     ('header', block_header_type),
 425     ('txs', ListType(tx_type)),
 426 ])
 427
 428 aux_pow_type = ComposedType([
 429     ('merkle_tx', merkle_tx_type),
 430     ('merkle_branch', merkle_branch_type),
 431     ('index', IntType(32)),
 432     ('parent_block_header', block_header_type),
 433 ])
 434
 435
 436 merkle_record_type = ComposedType([
 437     ('left', IntType(256)),
 438     ('right', IntType(256)),
 439 ])
 440
 441 def merkle_hash(hashes):
 442     if not hashes:
 443         return 0
 444     hash_list = list(hashes)
 445     while len(hash_list) > 1:
 446         hash_list = [merkle_record_type.hash256(dict(left=left, right=left if right is None else right))
 447             for left, right in zip(hash_list[::2], hash_list[1::2] + [None])]
 448     return hash_list[0]
 449
 450 def calculate_merkle_branch(hashes, index):
 451     # XXX optimize this
 452
 453     hash_list = [(h, i == index, []) for i, h in enumerate(hashes)]
 454
 455     while len(hash_list) > 1:
 456         hash_list = [
 457             (
 458                 merkle_record_type.hash256(dict(left=left, right=right)),
 459                 left_f or right_f,
 460                 (left_l if left_f else right_l) + [dict(side=1, hash=right) if left_f else dict(side=0, hash=left)],
 461             )
 462             for (left, left_f, left_l), (right, right_f, right_l) in
 463                 zip(hash_list[::2], hash_list[1::2] + [hash_list[::2][-1]])
 464         ]
 465
 466     res = [x['hash'] for x in hash_list[0][2]]
 467
 468     assert hash_list[0][1]
 469     assert check_merkle_branch(hashes[index], index, res) == hash_list[0][0]
 470     assert index == sum(k*2**i for i, k in enumerate([1-x['side'] for x in hash_list[0][2]]))
 471
 472     return res
 473
 474 def check_merkle_branch(tip_hash, index, merkle_branch):
 475     return reduce(lambda c, (i, h): merkle_record_type.hash256(
 476         dict(left=h, right=c) if 2**i & index else
 477         dict(left=c, right=h)
 478     ), enumerate(merkle_branch), tip_hash)
 479
 480 def target_to_average_attempts(target):
 481     return 2**256//(target + 1)
 482
 483 def target_to_difficulty(target):
 484     return (0xffff0000 * 2**(256-64) + 1)/(target + 1)
 485
 486 # tx
 487
 488 def tx_get_sigop_count(tx):
 489     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'])
 490
 491 # human addresses
 492
 493 human_address_type = ChecksummedType(ComposedType([
 494     ('version', IntType(8)),
 495     ('pubkey_hash', IntType(160)),
 496 ]))
 497
 498 pubkey_type = PassthruType()
 499
 500 def pubkey_hash_to_address(pubkey_hash, net):
 501     return human_address_type.pack_base58(dict(version=net.ADDRESS_VERSION, pubkey_hash=pubkey_hash))
 502
 503 def pubkey_to_address(pubkey, net):
 504     return pubkey_hash_to_address(pubkey_type.hash160(pubkey), net)
 505
 506 def address_to_pubkey_hash(address, net):
 507     x = human_address_type.unpack_base58(address)
 508     if x['version'] != net.ADDRESS_VERSION:
 509         raise ValueError('address not for this net!')
 510     return x['pubkey_hash']
 511
 512 # transactions
 513
 514 def pubkey_to_script2(pubkey):
 515     return ('\x41' + pubkey_type.pack(pubkey)) + '\xac'
 516
 517 def pubkey_hash_to_script2(pubkey_hash):
 518     return '\x76\xa9' + ('\x14' + IntType(160).pack(pubkey_hash)) + '\x88\xac'
 519
 520 def script2_to_address(script2, net):
 521     try:
 522         pubkey = script2[1:-1]
 523         script2_test = pubkey_to_script2(pubkey)
 524     except:
 525         pass
 526     else:
 527         if script2_test == script2:
 528             return pubkey_to_address(pubkey, net)
 529
 530     try:
 531         pubkey_hash = IntType(160).unpack(script2[3:-2])
 532         script2_test2 = pubkey_hash_to_script2(pubkey_hash)
 533     except:
 534         pass
 535     else:
 536         if script2_test2 == script2:
 537             return pubkey_hash_to_address(pubkey_hash, net)
 538
 539 def script2_to_human(script2, net):
 540     try:
 541         pubkey = script2[1:-1]
 542         script2_test = pubkey_to_script2(pubkey)
 543     except:
 544         pass
 545     else:
 546         if script2_test == script2:
 547             return 'Pubkey. Address: %s' % (pubkey_to_address(pubkey, net),)
 548
 549     try:
 550         pubkey_hash = IntType(160).unpack(script2[3:-2])
 551         script2_test2 = pubkey_hash_to_script2(pubkey_hash)
 552     except:
 553         pass
 554     else:
 555         if script2_test2 == script2:
 556             return 'Address. Address: %s' % (pubkey_hash_to_address(pubkey_hash, net),)
 557
 558     return 'Unknown. Script: %s'  % (script2.encode('hex'),)