p2pool/bitcoin/p2p.py

   1 '''
   2 Implementation of Bitcoin's p2p protocol
   3 '''
   4
   5 from __future__ import division
   6
   7 import hashlib
   8 import random
   9 import struct
  10 import time
  11 import zlib
  12
  13 from twisted.internet import defer, protocol, reactor, task
  14 from twisted.python import log
  15
  16 from . import data as bitcoin_data
  17 from p2pool.util import variable, datachunker, deferral
  18
  19 class TooLong(Exception):
  20     pass
  21
  22 class BaseProtocol(protocol.Protocol):
  23     def connectionMade(self):
  24         self.dataReceived = datachunker.DataChunker(self.dataReceiver())
  25
  26     def dataReceiver(self):
  27         while True:
  28             start = ''
  29             while start != self._prefix:
  30                 start = (start + (yield 1))[-len(self._prefix):]
  31
  32             command = (yield 12).rstrip('\0')
  33             length, = struct.unpack('<I', (yield 4))
  34
  35             if length > self.max_net_payload_length:
  36                 print 'length too long'
  37                 continue
  38
  39             if self.use_checksum:
  40                 checksum = yield 4
  41             else:
  42                 checksum = None
  43
  44             compressed_payload = yield length
  45
  46             if self.compress:
  47                 try:
  48                     d = zlib.decompressobj()
  49                     payload = d.decompress(compressed_payload, self.max_payload_length)
  50                     if d.unconsumed_tail:
  51                         print 'compressed payload expanded too much'
  52                         continue
  53                     assert not len(payload) > self.max_payload_length
  54                 except:
  55                     log.err(None, 'Failure decompressing message:')
  56                     continue
  57             else:
  58                 if len(compressed_payload) > self.max_payload_length:
  59                     print 'compressed payload expanded too much'
  60                     continue
  61                 payload = compressed_payload
  62
  63             if checksum is not None:
  64                 if hashlib.sha256(hashlib.sha256(payload).digest()).digest()[:4] != checksum:
  65                     print 'invalid hash for', repr(command), checksum.encode('hex') if checksum is not None else None, repr(payload[:100].encode('hex')), len(payload)
  66                     continue
  67
  68             type_ = getattr(self, 'message_' + command, None)
  69             if type_ is None:
  70                 print 'no type for', repr(command)
  71                 continue
  72
  73             try:
  74                 payload2 = type_.unpack(payload)
  75             except:
  76                 print 'RECV', command, checksum.encode('hex') if checksum is not None else None, repr(payload.encode('hex')), len(payload)
  77                 log.err(None, 'Error parsing message: (see RECV line)')
  78                 continue
  79
  80             handler = getattr(self, 'handle_' + command, None)
  81             if handler is None:
  82                 print 'no handler for', repr(command)
  83                 continue
  84
  85             try:
  86                 handler(**payload2)
  87             except:
  88                 print 'RECV', command, repr(payload2)[:100]
  89                 log.err(None, 'Error handling message: (see RECV line)')
  90                 continue
  91
  92     def sendPacket(self, command, payload2):
  93         if len(command) >= 12:
  94             raise ValueError('command too long')
  95         type_ = getattr(self, 'message_' + command, None)
  96         if type_ is None:
  97             raise ValueError('invalid command')
  98         #print 'SEND', command, repr(payload2)[:500]
  99         payload = type_.pack(payload2)
 100         if len(payload) > self.max_payload_length:
 101             raise TooLong('payload too long')
 102         if self.use_checksum:
 103             checksum = hashlib.sha256(hashlib.sha256(payload).digest()).digest()[:4]
 104         else:
 105             checksum = ''
 106         compressed_payload = zlib.compress(payload) if self.compress else payload
 107         if len(compressed_payload) > self.max_net_payload_length:
 108             raise TooLong('compressed payload too long')
 109         data = self._prefix + struct.pack('<12sI', command, len(compressed_payload)) + checksum + compressed_payload
 110         self.transport.write(data)
 111
 112     def __getattr__(self, attr):
 113         prefix = 'send_'
 114         if attr.startswith(prefix):
 115             command = attr[len(prefix):]
 116             return lambda **payload2: self.sendPacket(command, payload2)
 117         #return protocol.Protocol.__getattr__(self, attr)
 118         raise AttributeError(attr)
 119
 120 class Protocol(BaseProtocol):
 121     def __init__(self, net):
 122         self._prefix = net.BITCOIN_P2P_PREFIX
 123
 124     version = 0
 125
 126     max_payload_length = max_net_payload_length = 1000000
 127
 128     compress = False
 129     @property
 130     def use_checksum(self):
 131         return self.version >= 209
 132
 133
 134     null_order = '\0'*60
 135
 136     def connectionMade(self):
 137         BaseProtocol.connectionMade(self)
 138
 139         self.send_version(
 140             version=32200,
 141             services=1,
 142             time=int(time.time()),
 143             addr_to=dict(
 144                 services=1,
 145                 address=self.transport.getPeer().host,
 146                 port=self.transport.getPeer().port,
 147             ),
 148             addr_from=dict(
 149                 services=1,
 150                 address=self.transport.getHost().host,
 151                 port=self.transport.getHost().port,
 152             ),
 153             nonce=random.randrange(2**64),
 154             sub_version_num='',
 155             start_height=0,
 156         )
 157
 158     message_version = bitcoin_data.ComposedType([
 159         ('version', bitcoin_data.StructType('<I')),
 160         ('services', bitcoin_data.StructType('<Q')),
 161         ('time', bitcoin_data.StructType('<Q')),
 162         ('addr_to', bitcoin_data.address_type),
 163         ('addr_from', bitcoin_data.address_type),
 164         ('nonce', bitcoin_data.StructType('<Q')),
 165         ('sub_version_num', bitcoin_data.VarStrType()),
 166         ('start_height', bitcoin_data.StructType('<I')),
 167     ])
 168     def handle_version(self, version, services, time, addr_to, addr_from, nonce, sub_version_num, start_height):
 169         #print 'VERSION', locals()
 170         self.version_after = version
 171         self.send_verack()
 172
 173     message_verack = bitcoin_data.ComposedType([])
 174     def handle_verack(self):
 175         self.version = self.version_after
 176
 177         self.ready()
 178
 179     def ready(self):
 180         self.check_order = deferral.GenericDeferrer(2**256, lambda id, order: self.send_checkorder(id=id, order=order))
 181         self.submit_order = deferral.GenericDeferrer(2**256, lambda id, order: self.send_submitorder(id=id, order=order))
 182         self.get_block = deferral.ReplyMatcher(lambda hash: self.send_getdata(requests=[dict(type='block', hash=hash)]))
 183         self.get_block_header = deferral.ReplyMatcher(lambda hash: self.send_getheaders(version=1, have=[], last=hash))
 184         self.get_tx = deferral.ReplyMatcher(lambda hash: self.send_getdata(requests=[dict(type='tx', hash=hash)]))
 185
 186         if hasattr(self.factory, 'resetDelay'):
 187             self.factory.resetDelay()
 188         if hasattr(self.factory, 'gotConnection'):
 189             self.factory.gotConnection(self)
 190
 191     message_inv = bitcoin_data.ComposedType([
 192         ('invs', bitcoin_data.ListType(bitcoin_data.ComposedType([
 193             ('type', bitcoin_data.EnumType(bitcoin_data.StructType('<I'), {'tx': 1, 'block': 2})),
 194             ('hash', bitcoin_data.HashType()),
 195         ]))),
 196     ])
 197     def handle_inv(self, invs):
 198         for inv in invs:
 199             if inv['type'] == 'tx':
 200                 self.factory.new_tx.happened(inv['hash'])
 201             elif inv['type'] == 'block':
 202                 self.factory.new_block.happened(inv['hash'])
 203             else:
 204                 print 'Unknown inv type', item
 205
 206     message_getdata = bitcoin_data.ComposedType([
 207         ('requests', bitcoin_data.ListType(bitcoin_data.ComposedType([
 208             ('type', bitcoin_data.EnumType(bitcoin_data.StructType('<I'), {'tx': 1, 'block': 2})),
 209             ('hash', bitcoin_data.HashType()),
 210         ]))),
 211     ])
 212     message_getblocks = bitcoin_data.ComposedType([
 213         ('version', bitcoin_data.StructType('<I')),
 214         ('have', bitcoin_data.ListType(bitcoin_data.HashType())),
 215         ('last', bitcoin_data.PossiblyNone(0, bitcoin_data.HashType())),
 216     ])
 217     message_getheaders = bitcoin_data.ComposedType([
 218         ('version', bitcoin_data.StructType('<I')),
 219         ('have', bitcoin_data.ListType(bitcoin_data.HashType())),
 220         ('last', bitcoin_data.PossiblyNone(0, bitcoin_data.HashType())),
 221     ])
 222     message_getaddr = bitcoin_data.ComposedType([])
 223     message_checkorder = bitcoin_data.ComposedType([
 224         ('id', bitcoin_data.HashType()),
 225         ('order', bitcoin_data.FixedStrType(60)), # XXX
 226     ])
 227     message_submitorder = bitcoin_data.ComposedType([
 228         ('id', bitcoin_data.HashType()),
 229         ('order', bitcoin_data.FixedStrType(60)), # XXX
 230     ])
 231
 232     message_addr = bitcoin_data.ComposedType([
 233         ('addrs', bitcoin_data.ListType(bitcoin_data.ComposedType([
 234             ('timestamp', bitcoin_data.StructType('<I')),
 235             ('address', bitcoin_data.address_type),
 236         ]))),
 237     ])
 238     def handle_addr(self, addrs):
 239         for addr in addrs:
 240             pass
 241
 242     message_tx = bitcoin_data.ComposedType([
 243         ('tx', bitcoin_data.tx_type),
 244     ])
 245     def handle_tx(self, tx):
 246         self.get_tx.got_response(bitcoin_data.tx_type.hash256(tx), tx)
 247
 248     message_block = bitcoin_data.ComposedType([
 249         ('block', bitcoin_data.block_type),
 250     ])
 251     def handle_block(self, block):
 252         block_hash = bitcoin_data.block_header_type.hash256(block['header'])
 253         self.get_block.got_response(block_hash, block)
 254         self.get_block_header.got_response(block_hash, block['header'])
 255
 256     message_headers = bitcoin_data.ComposedType([
 257         ('headers', bitcoin_data.ListType(bitcoin_data.block_type)),
 258     ])
 259     def handle_headers(self, headers):
 260         for header in headers:
 261             header = header['header']
 262             self.get_block_header.got_response(bitcoin_data.block_header_type.hash256(header), header)
 263         self.factory.new_headers.happened([header['header'] for header in headers])
 264
 265     message_reply = bitcoin_data.ComposedType([
 266         ('hash', bitcoin_data.HashType()),
 267         ('reply',  bitcoin_data.EnumType(bitcoin_data.StructType('<I'), {'success': 0, 'failure': 1, 'denied': 2})),
 268         ('script', bitcoin_data.PossiblyNone('', bitcoin_data.VarStrType())),
 269     ])
 270     def handle_reply(self, hash, reply, script):
 271         self.check_order.got_response(hash, dict(reply=reply, script=script))
 272         self.submit_order.got_response(hash, dict(reply=reply, script=script))
 273
 274     message_ping = bitcoin_data.ComposedType([])
 275     def handle_ping(self):
 276         pass
 277
 278     message_alert = bitcoin_data.ComposedType([
 279         ('message', bitcoin_data.VarStrType()),
 280         ('signature', bitcoin_data.VarStrType()),
 281     ])
 282     def handle_alert(self, message, signature):
 283         print 'ALERT:', (message, signature)
 284
 285     def connectionLost(self, reason):
 286         if hasattr(self.factory, 'gotConnection'):
 287             self.factory.gotConnection(None)
 288
 289 class ClientFactory(protocol.ReconnectingClientFactory):
 290     protocol = Protocol
 291
 292     maxDelay = 1
 293
 294     def __init__(self, net):
 295         self.net = net
 296         self.conn = variable.Variable(None)
 297
 298         self.new_block = variable.Event()
 299         self.new_tx = variable.Event()
 300         self.new_headers = variable.Event()
 301
 302     def buildProtocol(self, addr):
 303         p = self.protocol(self.net)
 304         p.factory = self
 305         return p
 306
 307     def gotConnection(self, conn):
 308         self.conn.set(conn)
 309
 310     def getProtocol(self):
 311         return self.conn.get_not_none()
 312
 313 class HeaderWrapper(object):
 314     target = 0
 315     __slots__ = 'hash previous_hash'.split(' ')
 316
 317     def __init__(self, header):
 318         self.hash = bitcoin_data.block_header_type.hash256(header)
 319         self.previous_hash = header['previous_block']
 320
 321 class HeightTracker(object):
 322     '''Point this at a factory and let it take care of getting block heights'''
 323
 324     def __init__(self, factory):
 325         self.factory = factory
 326         self.tracker = bitcoin_data.Tracker()
 327         self.most_recent = None
 328
 329         self._watch1 = self.factory.new_headers.watch(self.heard_headers)
 330         self._watch2 = self.factory.new_block.watch(self.heard_block)
 331
 332         self.requested = set()
 333         self._clear_task = task.LoopingCall(self.requested.clear)
 334         self._clear_task.start(60)
 335
 336         self.last_notified_size = 0
 337
 338         self.updated = variable.Event()
 339
 340         self.think()
 341
 342     def think(self):
 343         highest_head = max(self.tracker.heads, key=lambda h: self.tracker.get_height_and_last(h)[0]) if self.tracker.heads else None
 344         height, last = self.tracker.get_height_and_last(highest_head)
 345         cur = highest_head
 346         cur_height = height
 347         have = []
 348         step = 1
 349         while cur is not None:
 350             have.append(cur)
 351             if step > cur_height:
 352                 break
 353             cur = self.tracker.get_nth_parent_hash(cur, step)
 354             cur_height -= step
 355             if len(have) > 10:
 356                 step *= 2
 357         if height:
 358             have.append(self.tracker.get_nth_parent_hash(highest_head, height - 1))
 359         if not have:
 360             have.append(0)
 361         self.request(have, None)
 362
 363         for tail in self.tracker.tails:
 364             if tail is None:
 365                 continue
 366             self.request([], tail)
 367         for head in self.tracker.heads:
 368             if head == highest_head:
 369                 continue
 370             self.request([head], None)
 371
 372     def heard_headers(self, headers):
 373         changed = False
 374         for header in headers:
 375             hw = HeaderWrapper(header)
 376             if hw.hash in self.tracker.shares:
 377                 continue
 378             changed = True
 379             self.tracker.add(hw)
 380         if changed:
 381             self.updated.happened()
 382         self.think()
 383
 384         if len(self.tracker.shares) > self.last_notified_size + 10:
 385             print 'Have %i block headers' % len(self.tracker.shares)
 386             self.last_notified_size = len(self.tracker.shares)
 387
 388     def heard_block(self, block_hash):
 389         self.request([], block_hash)
 390
 391     @defer.inlineCallbacks
 392     def request(self, have, last):
 393         if (tuple(have), last) in self.requested:
 394             return
 395         self.requested.add((tuple(have), last))
 396         (yield self.factory.getProtocol()).send_getheaders(version=1, have=have, last=last)
 397
 398     def getHeight(self, block_hash):
 399         height, last = self.tracker.get_height_and_last(block_hash)
 400         if last is not None:
 401             #self.request([], last)
 402             raise ValueError()
 403         return height
 404
 405     def get_min_height(self, block_hash):
 406         height, last = self.tracker.get_height_and_last(block_hash)
 407         #if last is not None:
 408         #    self.request([], last)
 409         return height
 410
 411     def get_highest_height(self):
 412         return self.tracker.get_highest_height()
 413
 414     def stop(self):
 415         self.factory.new_headers.unwatch(self._watch1)
 416         self.factory.new_block.unwatch(self._watch2)
 417         self._clear_task.stop()
 418
 419 if __name__ == '__main__':
 420     factory = ClientFactory(bitcoin_data.Mainnet)
 421     reactor.connectTCP('127.0.0.1', 8333, factory)
 422     h = HeightTracker(factory)
 423
 424     @repr
 425     @apply
 426     @defer.inlineCallbacks
 427     def think():
 428         while True:
 429             yield deferral.sleep(1)
 430             print h.get_min_height(0xa285c3cb2a90ac7194cca034512748289e2526d9d7ae6ee7523)
 431
 432     reactor.run()