2 Implementation of Bitcoin's p2p protocol
5 from __future__ import division
13 from twisted.internet import defer, protocol, reactor, task
14 from twisted.python import log
16 from . import data as bitcoin_data
17 from p2pool.util import variable, datachunker, deferral
19 class BaseProtocol(protocol.Protocol):
20 def connectionMade(self):
21 self.dataReceived = datachunker.DataChunker(self.dataReceiver())
23 def dataReceiver(self):
26 while start != self._prefix:
27 start = (start + (yield 1))[-len(self._prefix):]
29 command = (yield 12).rstrip('\0')
30 length, = struct.unpack('<I', (yield 4))
32 if length > self.max_net_payload_length:
33 print "length too long"
41 compressed_payload = yield length
45 d = zlib.decompressobj()
46 payload = d.decompress(compressed_payload, self.max_payload_length)
48 print "compressed payload expanded too much"
50 assert not len(payload) > self.max_payload_length
52 print 'FAILURE DECOMPRESSING'
56 if len(compressed_payload) > self.max_payload_length:
57 print "compressed payload expanded too much"
59 payload = compressed_payload
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)
67 type_ = getattr(self, 'message_' + command, 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)
74 payload2 = type_.unpack(payload)
76 print 'RECV', command, checksum.encode('hex') if checksum is not None else None, repr(payload.encode('hex')), len(payload)
80 handler = getattr(self, 'handle_' + command, 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
86 #print 'RECV', command, repr(payload2)[:500]
91 print 'RECV', command, checksum.encode('hex') if checksum is not None else None, repr(payload.encode('hex')), len(payload)
95 def sendPacket(self, command, payload2):
96 if len(command) >= 12:
97 raise ValueError('command too long')
98 type_ = getattr(self, 'message_' + command, 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]
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)
115 def __getattr__(self, attr):
117 if attr.startswith(prefix):
118 command = attr[len(prefix):]
119 return lambda **payload2: self.sendPacket(command, payload2)
120 #return protocol.Protocol.__getattr__(self, attr)
121 raise AttributeError(attr)
123 class Protocol(BaseProtocol):
124 def __init__(self, net):
125 self._prefix = net.BITCOIN_P2P_PREFIX
129 max_payload_length = max_net_payload_length = 1000000
133 def use_checksum(self):
134 return self.version >= 209
139 def connectionMade(self):
140 BaseProtocol.connectionMade(self)
145 time=int(time.time()),
148 address=self.transport.getPeer().host,
149 port=self.transport.getPeer().port,
153 address=self.transport.getHost().host,
154 port=self.transport.getHost().port,
156 nonce=random.randrange(2**64),
161 message_version = bitcoin_data.ComposedType([
162 ('version', bitcoin_data.StructType('<I')),
163 ('services', bitcoin_data.StructType('<Q')),
164 ('time', bitcoin_data.StructType('<Q')),
165 ('addr_to', bitcoin_data.address_type),
166 ('addr_from', bitcoin_data.address_type),
167 ('nonce', bitcoin_data.StructType('<Q')),
168 ('sub_version_num', bitcoin_data.VarStrType()),
169 ('start_height', bitcoin_data.StructType('<I')),
171 def handle_version(self, version, services, time, addr_to, addr_from, nonce, sub_version_num, start_height):
172 #print 'VERSION', locals()
173 self.version_after = version
176 message_verack = bitcoin_data.ComposedType([])
177 def handle_verack(self):
178 self.version = self.version_after
183 self.check_order = deferral.GenericDeferrer(2**256, lambda id, order: self.send_checkorder(id=id, order=order))
184 self.submit_order = deferral.GenericDeferrer(2**256, lambda id, order: self.send_submitorder(id=id, order=order))
185 self.get_block = deferral.ReplyMatcher(lambda hash: self.send_getdata(requests=[dict(type='block', hash=hash)]))
186 self.get_block_header = deferral.ReplyMatcher(lambda hash: self.send_getheaders(version=1, have=[], last=hash))
187 self.get_tx = deferral.ReplyMatcher(lambda hash: self.send_getdata(requests=[dict(type='tx', hash=hash)]))
189 if hasattr(self.factory, 'resetDelay'):
190 self.factory.resetDelay()
191 if hasattr(self.factory, 'gotConnection'):
192 self.factory.gotConnection(self)
194 message_inv = bitcoin_data.ComposedType([
195 ('invs', bitcoin_data.ListType(bitcoin_data.ComposedType([
196 ('type', bitcoin_data.EnumType(bitcoin_data.StructType('<I'), {'tx': 1, 'block': 2})),
197 ('hash', bitcoin_data.HashType()),
200 def handle_inv(self, invs):
202 if inv['type'] == 'tx':
203 self.factory.new_tx.happened(inv['hash'])
204 elif inv['type'] == 'block':
205 self.factory.new_block.happened(inv['hash'])
207 print 'Unknown inv type', item
209 message_getdata = bitcoin_data.ComposedType([
210 ('requests', bitcoin_data.ListType(bitcoin_data.ComposedType([
211 ('type', bitcoin_data.EnumType(bitcoin_data.StructType('<I'), {'tx': 1, 'block': 2})),
212 ('hash', bitcoin_data.HashType()),
215 message_getblocks = bitcoin_data.ComposedType([
216 ('version', bitcoin_data.StructType('<I')),
217 ('have', bitcoin_data.ListType(bitcoin_data.HashType())),
218 ('last', bitcoin_data.PossiblyNone(0, bitcoin_data.HashType())),
220 message_getheaders = bitcoin_data.ComposedType([
221 ('version', bitcoin_data.StructType('<I')),
222 ('have', bitcoin_data.ListType(bitcoin_data.HashType())),
223 ('last', bitcoin_data.PossiblyNone(0, bitcoin_data.HashType())),
225 message_getaddr = bitcoin_data.ComposedType([])
226 message_checkorder = bitcoin_data.ComposedType([
227 ('id', bitcoin_data.HashType()),
228 ('order', bitcoin_data.FixedStrType(60)), # XXX
230 message_submitorder = bitcoin_data.ComposedType([
231 ('id', bitcoin_data.HashType()),
232 ('order', bitcoin_data.FixedStrType(60)), # XXX
235 message_addr = bitcoin_data.ComposedType([
236 ('addrs', bitcoin_data.ListType(bitcoin_data.ComposedType([
237 ('timestamp', bitcoin_data.StructType('<I')),
238 ('address', bitcoin_data.address_type),
241 def handle_addr(self, addrs):
245 message_tx = bitcoin_data.ComposedType([
246 ('tx', bitcoin_data.tx_type),
248 def handle_tx(self, tx):
249 self.get_tx.got_response(bitcoin_data.tx_type.hash256(tx), tx)
251 message_block = bitcoin_data.ComposedType([
252 ('block', bitcoin_data.block_type),
254 def handle_block(self, block):
255 block_hash = bitcoin_data.block_header_type.hash256(block['header'])
256 self.get_block.got_response(block_hash, block)
257 self.get_block_header.got_response(block_hash, block['header'])
259 message_headers = bitcoin_data.ComposedType([
260 ('headers', bitcoin_data.ListType(bitcoin_data.block_type)),
262 def handle_headers(self, headers):
263 for header in headers:
264 header = header['header']
265 self.get_block_header.got_response(bitcoin_data.block_header_type.hash256(header), header)
266 self.factory.new_headers.happened([header['header'] for header in headers])
268 message_reply = bitcoin_data.ComposedType([
269 ('hash', bitcoin_data.HashType()),
270 ('reply', bitcoin_data.EnumType(bitcoin_data.StructType('<I'), {'success': 0, 'failure': 1, 'denied': 2})),
271 ('script', bitcoin_data.PossiblyNone('', bitcoin_data.VarStrType())),
273 def handle_reply(self, hash, reply, script):
274 self.check_order.got_response(hash, dict(reply=reply, script=script))
275 self.submit_order.got_response(hash, dict(reply=reply, script=script))
277 message_ping = bitcoin_data.ComposedType([])
278 def handle_ping(self):
281 message_alert = bitcoin_data.ComposedType([
282 ('message', bitcoin_data.VarStrType()),
283 ('signature', bitcoin_data.VarStrType()),
285 def handle_alert(self, message, signature):
286 print 'ALERT:', (message, signature)
288 def connectionLost(self, reason):
289 if hasattr(self.factory, 'gotConnection'):
290 self.factory.gotConnection(None)
292 class ClientFactory(protocol.ReconnectingClientFactory):
297 def __init__(self, net):
299 self.conn = variable.Variable(None)
301 self.new_block = variable.Event()
302 self.new_tx = variable.Event()
303 self.new_headers = variable.Event()
305 def buildProtocol(self, addr):
306 p = self.protocol(self.net)
310 def gotConnection(self, conn):
313 def getProtocol(self):
314 return self.conn.get_not_none()
316 class HeaderWrapper(object):
317 def __init__(self, header):
318 self.hash = bitcoin_data.block_header_type.hash256(header)
319 self.previous_hash = header['previous_block']
321 class HeightTracker(object):
322 '''Point this at a factory and let it take care of getting block heights'''
324 def __init__(self, factory):
325 self.factory = factory
326 self.tracker = bitcoin_data.Tracker()
327 self.most_recent = None
329 self._watch1 = self.factory.new_headers.watch(self.heard_headers)
330 self._watch2 = self.factory.new_block.watch(self.heard_block)
332 self.requested = set()
333 self._clear_task = task.LoopingCall(self.requested.clear)
334 self._clear_task.start(60)
339 highest_head = max(self.tracker.heads, key=lambda h: self.tracker.get_height_and_last(h)[0]) if self.tracker.heads else None
340 height, last = self.tracker.get_height_and_last(highest_head)
345 while cur is not None:
347 if step > cur_height:
349 cur = self.tracker.get_nth_parent_hash(cur, step)
354 have.append(self.tracker.get_nth_parent_hash(highest_head, height - 1))
357 self.request(have, None)
359 for tail in self.tracker.tails:
362 self.request([], tail)
363 for head in self.tracker.heads:
364 self.request([head], None)
366 def heard_headers(self, headers):
367 for header in headers:
368 self.tracker.add(HeaderWrapper(header))
371 def heard_block(self, block_hash):
372 self.request([], block_hash)
374 @defer.inlineCallbacks
375 def request(self, have, last):
376 if (tuple(have), last) in self.requested:
378 self.requested.add((tuple(have), last))
379 (yield self.factory.getProtocol()).send_getheaders(version=1, have=have, last=last)
381 #@defer.inlineCallbacks
383 def getHeight(self, block_hash):
384 height, last = self.tracker.get_height_and_last(block_hash)
386 self.request([], last)
390 def get_min_height(self, block_hash):
391 height, last = self.tracker.get_height_and_last(block_hash)
393 self.request([], last)
396 def get_highest_height(self):
397 return self.tracker.get_highest_height()
400 self.factory.new_headers.unwatch(self._watch1)
401 self.factory.new_block.unwatch(self._watch2)
402 self._clear_task.stop()
404 if __name__ == '__main__':
405 factory = ClientFactory(bitcoin_data.Mainnet)
406 reactor.connectTCP('127.0.0.1', 8333, factory)
407 h = HeightTracker(factory)
411 @defer.inlineCallbacks
414 yield deferral.sleep(1)
415 print h.get_min_height(0xa285c3cb2a90ac7194cca034512748289e2526d9d7ae6ee7523)