e5e5e11a90cabc4c1c2165aaf89eb912981929e7
[p2pool.git] / p2p.py
1 from __future__ import division
2
3 import random
4 import time
5 import traceback
6
7 from twisted.internet import defer, protocol, reactor
8
9 import bitcoin_p2p
10 import conv
11 import p2pool
12 import util
13
14 # mode
15 #     0: send hash first (high latency, low bandwidth)
16 #     1: send entire share (low latency, high bandwidth)
17
18 class Protocol(bitcoin_p2p.BaseProtocol):
19     version = 0
20     sub_version = ''
21     
22     def __init__(self, node):
23         self.node = node
24         
25         if self.node.testnet:
26             self._prefix = 'f77cea5d16a2183f'.decode('hex')
27         else:
28             self._prefix = '95ec1eda53c5e716'.decode('hex')
29     
30     use_checksum = True
31     
32     message_types = {
33         'version': bitcoin_p2p.ComposedType([
34             ('version', bitcoin_p2p.StructType('<I')),
35             ('services', bitcoin_p2p.StructType('<Q')),
36             ('addr_to', bitcoin_p2p.address),
37             ('addr_from', bitcoin_p2p.address),
38             ('nonce', bitcoin_p2p.StructType('<Q')),
39             ('sub_version', bitcoin_p2p.VarStrType()),
40             ('mode', bitcoin_p2p.StructType('<I')),
41             ('state', bitcoin_p2p.ComposedType([
42                 ('chain_id', p2pool.chain_id_type),
43                 ('highest', bitcoin_p2p.ComposedType([
44                     ('hash', bitcoin_p2p.HashType()),
45                     ('height', bitcoin_p2p.StructType('<Q')),
46                 ])),
47             ])),
48         ]),
49         
50         'update_mode': bitcoin_p2p.ComposedType([
51             ('mode', bitcoin_p2p.StructType('<I')),
52         ]),
53         
54         'ping': bitcoin_p2p.ComposedType([]),
55         
56         'addrme': bitcoin_p2p.ComposedType([
57             ('port', bitcoin_p2p.StructType('<H')),
58         ]),
59         'addrs': bitcoin_p2p.ComposedType([
60             ('addrs', bitcoin_p2p.ListType(bitcoin_p2p.ComposedType([
61                 ('timestamp', bitcoin_p2p.StructType('<Q')),
62                 ('address', bitcoin_p2p.address),
63             ]))),
64         ]),
65         'getaddrs': bitcoin_p2p.ComposedType([
66             ('count', bitcoin_p2p.StructType('<I')),
67         ]),
68         
69         'gettobest': bitcoin_p2p.ComposedType([
70             ('chain_id', p2pool.chain_id_type),
71             ('have', bitcoin_p2p.ListType(bitcoin_p2p.HashType())),
72         ]),
73         'getshares': bitcoin_p2p.ComposedType([
74             ('chain_id', p2pool.chain_id_type),
75             ('hashes', bitcoin_p2p.ListType(bitcoin_p2p.HashType())),
76         ]),
77         
78         'share0s': bitcoin_p2p.ComposedType([
79             ('chains', bitcoin_p2p.ListType(bitcoin_p2p.ComposedType([
80                 ('chain_id', p2pool.chain_id_type),
81                 ('hashes', bitcoin_p2p.ListType(bitcoin_p2p.HashType())),
82             ]))),
83         ]),
84         'share1s': bitcoin_p2p.ComposedType([
85             ('share1s', bitcoin_p2p.ListType(p2pool.share1)),
86         ]),
87         'share2s': bitcoin_p2p.ComposedType([
88             ('share2s', bitcoin_p2p.ListType(bitcoin_p2p.block)),
89         ]),
90     }
91     
92     other_version = None
93     node_var_watch = None
94     connected2 = False
95     
96     @property
97     def mode(self):
98         return min(self.node.mode_var.value, self.other_mode_var.value)
99     
100     def connectionMade(self):
101         bitcoin_p2p.BaseProtocol.connectionMade(self)
102         
103         chain = self.node.current_work.value['current_chain']
104         highest_share2 = chain.get_highest_share2()
105         self.send_version(
106             version=self.version,
107             services=0,
108             addr_to=dict(
109                 services=0,
110                 address='::ffff:' + self.transport.getPeer().host,
111                 port=self.transport.getPeer().port,
112             ),
113             addr_from=dict(
114                 services=0,
115                 address='::ffff:' + self.transport.getHost().host,
116                 port=self.transport.getHost().port,
117             ),
118             nonce=self.node.nonce,
119             sub_version=self.sub_version,
120             mode=self.node.mode_var.value,
121             state=dict(
122                 chain_id=p2pool.chain_id_type.unpack(chain.chain_id_data),
123                 highest=dict(
124                     hash=highest_share2.share.hash if highest_share2 is not None else 2**256-1,
125                     height=highest_share2.height if highest_share2 is not None else 0,
126                 ),
127             ),
128         )
129         
130         self.node_var_watch = self.node.mode_var.changed.watch(lambda new_mode: self.send_set_mode(mode=new_mode))
131         
132         reactor.callLater(10, self._connect_timeout)
133     
134     def _connect_timeout(self):
135         if not self.connected2 and self.transport.connected:
136             print 'Handshake timed out, disconnecting from %s:%i' % (self.transport.getPeer().host, self.transport.getPeer().port)
137             self.transport.loseConnection()
138     
139     @defer.inlineCallbacks
140     def _think(self):
141         while self.connected2:
142             self.send_ping()
143             yield util.sleep(random.expovariate(1/100))
144     
145     @defer.inlineCallbacks
146     def _think2(self):
147         while self.connected2:
148             self.send_addrme(port=self.node.port)
149             #print 'sending addrme'
150             yield util.sleep(random.expovariate(1/100))
151     
152     def handle_version(self, version, services, addr_to, addr_from, nonce, sub_version, mode, state):
153         self.other_version = version
154         self.other_services = services
155         self.other_mode_var = util.Variable(mode)
156         
157         if nonce == self.node.nonce:
158             #print 'Detected connection to self, disconnecting from %s:%i' % (self.transport.getPeer().host, self.transport.getPeer().port)
159             self.transport.loseConnection()
160             return
161         if nonce in self.node.peers:
162             print 'Detected duplicate connection, disconnecting from %s:%i' % (self.transport.getPeer().host, self.transport.getPeer().port)
163             self.transport.loseConnection()
164             return
165         
166         self.nonce = nonce
167         self.connected2 = True
168         self.node.got_conn(self)
169         
170         self._think()
171         self._think2()
172         
173         if state['highest']['hash'] != 2**256 - 1:
174             self.handle_share0s(chains=[dict(
175                 chain_id=state['chain_id'],
176                 hashes=[state['highest']['hash']],
177             )])
178     
179     def handle_set_mode(self, mode):
180         self.other_mode_var.set(mode)
181     
182     def handle_ping(self):
183         pass
184     
185     def handle_addrme(self, port):
186         host = self.transport.getPeer().host
187         #print 'addrme from', host, port
188         if host == '127.0.0.1':
189             if random.random() < .8 and self.node.peers:
190                 random.choice(self.node.peers.values()).send_addrme(port=port) # services...
191         else:
192             self.node.got_addr(('::ffff:' + self.transport.getPeer().host, port), self.other_services, int(time.time()))
193             if random.random() < .8 and self.node.peers:
194                 random.choice(self.node.peers.values()).send_addrs(addrs=[
195                     dict(
196                         address=dict(
197                             services=self.other_services,
198                             address='::ffff:' + host,
199                             port=port,
200                         ),
201                         timestamp=int(time.time()),
202                     ),
203                 ])
204     def handle_addrs(self, addrs):
205         for addr_record in addrs:
206             self.node.got_addr((addr_record['address']['address'], addr_record['address']['port']), addr_record['address']['services'], min(int(time.time()), addr_record['timestamp']))
207             if random.random() < .8 and self.node.peers:
208                 random.choice(self.node.peers.values()).send_addrs(addrs=[addr_record])
209     def handle_getaddrs(self, count):
210         self.send_addrs(addrs=[
211             dict(
212                 timestamp=self.node.addr_store[host, port][2],
213                 address=dict(
214                     services=self.node.addr_store[host, port][0],
215                     address=host,
216                     port=port,
217                 ),
218             ) for host, port in
219             random.sample(self.node.addr_store.keys(), min(count, len(self.node.addr_store)))
220         ])
221     
222     def handle_gettobest(self, chain_id, have):
223         self.node.handle_get_to_best(p2pool.chain_id_type.pack(chain_id), have, self)
224     
225     def handle_getshares(self, chain_id, hashes):
226         self.node.handle_get_shares(p2pool.chain_id_type.pack(chain_id), hashes, self)
227     
228     def handle_share0s(self, chains):
229         for chain in chains:
230             for hash_ in chain['hashes']:
231                 self.node.handle_share_hash(p2pool.chain_id_type.pack(chain['chain_id']), hash_, self)
232     def handle_share1s(self, share1s):
233         for share1 in share1s:
234             hash_ = bitcoin_p2p.block_hash(share1['header'])
235             if hash_ <= conv.bits_to_target(share1['header']['bits']):
236                 print 'Dropping peer %s:%i due to invalid share' % (self.transport.getPeer().host, self.transport.getPeer().port)
237                 self.transport.loseConnection()
238                 return
239             share = p2pool.Share(share1['header'], gentx=share1['gentx'])
240             self.node.handle_share(share, self)
241     def handle_share2s(self, share2s):
242         for share2 in share2s:
243             hash_ = bitcoin_p2p.block_hash(share2['header'])
244             if not hash_ <= conv.bits_to_target(share2['header']['bits']):
245                 print 'Dropping peer %s:%i due to invalid share' % (self.transport.getPeer().host, self.transport.getPeer().port)
246                 self.transport.loseConnection()
247                 return
248             share = p2pool.Share(share2['header'], txns=share2['txns'])
249             self.node.handle_share(share, self)
250     
251     def send_share(self, share, full=False):
252         if share.hash <= conv.bits_to_target(share.header['bits']):
253             self.send_share2s(share2s=[share.as_block()])
254         else:
255             if self.mode == 0 and not full:
256                 self.send_share0s(chains=[dict(
257                     chain_id=p2pool.chain_id_type.unpack(share.chain_id_data),
258                     hashes=[share.hash],
259                 )])
260             elif self.mode == 1 or full:
261                 self.send_share1s(share1s=[dict(
262                     header=share.header,
263                     gentx=share.gentx,
264                 )])
265             else:
266                 raise ValueError(self.mode)
267     
268     def connectionLost(self, reason):
269         if self.node_var_watch is not None:
270             self.node.mode_var.changed.unwatch(self.node_var_watch)
271         
272         if self.connected2:
273             self.node.lost_conn(self)
274
275 class ServerFactory(protocol.ServerFactory):
276     def __init__(self, node):
277         self.node = node
278     
279     def buildProtocol(self, addr):
280         p = Protocol(self.node)
281         p.factory = self
282         return p
283
284 class ClientFactory(protocol.ClientFactory):
285     def __init__(self, node):
286         self.node = node
287     
288     def buildProtocol(self, addr):
289         p = Protocol(self.node)
290         p.factory = self
291         return p
292     
293     def startedConnecting(self, connector):
294         self.node.attempt_started(connector)
295     
296     def clientConnectionFailed(self, connector, reason):
297         self.node.attempt_failed(connector)
298     
299     def clientConnectionLost(self, connector, reason):
300         self.node.attempt_ended(connector)
301
302 addrdb_key = bitcoin_p2p.ComposedType([
303     ('address', bitcoin_p2p.IPV6AddressType()),
304     ('port', bitcoin_p2p.StructType('>H')),
305 ])
306 addrdb_value = bitcoin_p2p.ComposedType([
307     ('services', bitcoin_p2p.StructType('<Q')),
308     ('first_seen', bitcoin_p2p.StructType('<Q')),
309     ('last_seen', bitcoin_p2p.StructType('<Q')),
310 ])
311
312 class AddrStore(util.DictWrapper):
313     def encode_key(self, (address, port)):
314         return addrdb_key.pack(dict(address=address, port=port))
315     def decode_key(self, encoded_key):
316         k = addrdb_key.unpack(encoded_key)
317         return k['address'], k['port']
318     
319     def encode_value(self, (services, first_seen, last_seen)):
320         return addrdb_value.pack(dict(services=services, first_seen=first_seen, last_seen=last_seen))
321     def decode_value(self, encoded_value):
322         v = addrdb_value.unpack(encoded_value)
323         return v['services'], v['first_seen'], v['last_seen']
324
325 class Node(object):
326     def __init__(self, current_work, port, testnet, addr_store=None, preferred_addrs=[], mode=0, desired_peers=10, max_attempts=100):
327         if addr_store is None:
328             addr_store = {}
329         
330         self.port = port
331         self.testnet = testnet
332         self.addr_store = AddrStore(addr_store)
333         self.preferred_addrs = preferred_addrs
334         self.mode_var = util.Variable(mode)
335         self.desired_peers = desired_peers
336         self.max_attempts = max_attempts
337         self.current_work = current_work
338         
339         self.nonce = random.randrange(2**64)
340         self.attempts = {}
341         self.peers = {}
342         self.running = False
343     
344     def start(self):
345         if self.running:
346             raise ValueError('already running')
347         
348         self.running = True
349         
350         self.listen_port = reactor.listenTCP(self.port, ServerFactory(self))
351         
352         self._think()
353         self._think2()
354     
355     @defer.inlineCallbacks
356     def _think(self):
357         while self.running:
358             try:
359                 if len(self.peers) < self.desired_peers and len(self.attempts) < self.max_attempts and (len(self.preferred_addrs) or len(self.addr_store)):
360                     if (random.randrange(2) and len(self.preferred_addrs)) or not len(self.addr_store):
361                         host, port = random.choice(self.preferred_addrs)
362                     else:
363                         host2, port = random.choice(self.addr_store.keys())
364                         prefix = '::ffff:'
365                         if not host2.startswith(prefix):
366                             raise ValueError('invalid address')
367                         host = host2[len(prefix):]
368                     
369                     if (host, port) not in self.attempts:
370                         #print 'Trying to connect to', host, port
371                         reactor.connectTCP(host, port, ClientFactory(self), timeout=10)
372             except:
373                 traceback.print_exc()
374             
375             yield util.sleep(random.expovariate(1/5))
376     
377     @defer.inlineCallbacks
378     def _think2(self):
379         while self.running:
380             try:
381                 if len(self.addr_store) < self.preferred_addrs and self.peers:
382                     random.choice(self.peers.values()).send_getaddrs(count=8)
383             except:
384                 traceback.print_exc()
385             
386             yield util.sleep(random.expovariate(1/20))
387     
388     def stop(self):
389         if not self.running:
390             raise ValueError('already stopped')
391         
392         self.running = False
393         
394         self.listen_port.stopListening()
395     
396     
397     def attempt_started(self, connector):
398         host, port = connector.getDestination().host, connector.getDestination().port
399         if (host, port) in self.attempts:
400             raise ValueError('already have attempt')
401         self.attempts[host, port] = connector
402     
403     def attempt_failed(self, connector):
404         self.attempt_ended(connector)
405     
406     def attempt_ended(self, connector):
407         host, port = connector.getDestination().host, connector.getDestination().port
408         if (host, port) not in self.attempts:
409             raise ValueError("don't have attempt")
410         if connector is not self.attempts[host, port]:
411             raise ValueError('wrong connector')
412         del self.attempts[host, port]
413     
414     
415     def got_conn(self, conn):
416         if conn.nonce in self.peers:
417             raise ValueError('already have peer')
418         self.peers[conn.nonce] = conn
419         
420         print 'Connected to peer %s:%i' % (conn.transport.getPeer().host, conn.transport.getPeer().port)
421     
422     def lost_conn(self, conn):
423         if conn.nonce not in self.peers:
424             raise ValueError("don't have peer")
425         if conn is not self.peers[conn.nonce]:
426             raise ValueError('wrong conn')
427         del self.peers[conn.nonce]
428         
429         print 'Lost peer %s:%i' % (conn.transport.getPeer().host, conn.transport.getPeer().port)
430     
431     
432     def got_addr(self, (host, port), services, timestamp):
433         if (host, port) in self.addr_store:
434             old_services, old_first_seen, old_last_seen = self.addr_store[host, port]
435             self.addr_store[host, port] = services, old_first_seen, max(old_last_seen, timestamp)
436         else:
437             self.addr_store[host, port] = services, timestamp, timestamp
438     
439     def handle_share(self, share, peer):
440         print 'handle_share', (share, peer)
441     
442     def handle_share_hash(self, chain_id_data, hash, peer):
443         print 'handle_share_hash', (chain_id_data, hash, peer)
444     
445     def handle_get_to_best(self, chain_id_data, have, peer):
446         print 'handle_get_to_best', (chain_id_data, have, peer)
447     
448     def handle_get_shares(self, chain_id_data, hashes, peer):
449         print 'handle_get_shares', (chain_id_data, hashes, peer)
450
451 if __name__ == '__main__':
452     p = random.randrange(2**15, 2**16)
453     for i in xrange(5):
454         p2 = random.randrange(2**15, 2**16)
455         print p, p2
456         n = Node(p2, True, {addrdb_key.pack(dict(address='::ffff:' + '127.0.0.1', port=p)): addrdb_value.pack(dict(services=0, first_seen=int(time.time())-10, last_seen=int(time.time())))})
457         n.start()
458         p = p2
459     
460     reactor.run()