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