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