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