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