1 from __future__ import division
8 from twisted.internet import defer, protocol, reactor
9 from twisted.python import failure, log
12 from p2pool import data as p2pool_data
13 from p2pool.bitcoin import data as bitcoin_data
14 from p2pool.util import deferral, p2protocol, pack, variable
16 class PeerMisbehavingError(Exception):
20 def fragment(f, **kwargs):
23 except p2protocol.TooLong:
24 fragment(f, **dict((k, v[:len(v)//2]) for k, v in kwargs.iteritems()))
25 return fragment(f, **dict((k, v[len(v)//2:]) for k, v in kwargs.iteritems()))
27 class Protocol(p2protocol.Protocol):
28 max_remembered_txs_size = 2500000
30 def __init__(self, node, incoming):
31 p2protocol.Protocol.__init__(self, node.net.PREFIX, 1000000, node.traffic_happened)
33 self.incoming = incoming
35 self.other_version = None
36 self.connected2 = False
38 def connectionMade(self):
39 p2protocol.Protocol.connectionMade(self)
41 self.factory.proto_made_connection(self)
43 self.connection_lost_event = variable.Event()
45 self.addr = self.transport.getPeer().host, self.transport.getPeer().port
52 address=self.transport.getPeer().host,
53 port=self.transport.getPeer().port,
57 address=self.transport.getHost().host,
58 port=self.transport.getHost().port,
60 nonce=self.node.nonce,
61 sub_version=p2pool.__version__,
63 best_share_hash=self.node.best_share_hash_func(),
66 self.timeout_delayed = reactor.callLater(10, self._connect_timeout)
68 self.get_shares = deferral.GenericDeferrer(
70 func=lambda id, hashes, parents, stops: self.send_sharereq(id=id, hashes=hashes, parents=parents, stops=stops),
72 on_timeout=self.transport.loseConnection,
75 self.remote_tx_hashes = set() # view of peer's known_txs # not actually initially empty, but sending txs instead of tx hashes won't hurt
76 self.remote_remembered_txs_size = 0
78 self.remembered_txs = {} # view of peer's mining_txs
79 self.remembered_txs_size = 0
80 self.known_txs_cache = {}
82 def _connect_timeout(self):
83 self.timeout_delayed = None
84 print 'Handshake timed out, disconnecting from %s:%i' % self.addr
85 self.transport.loseConnection()
87 def packetReceived(self, command, payload2):
89 if command != 'version' and not self.connected2:
90 raise PeerMisbehavingError('first message was not version message')
91 p2protocol.Protocol.packetReceived(self, command, payload2)
92 except PeerMisbehavingError, e:
93 print 'Peer %s:%i misbehaving, will drop and ban. Reason:' % self.addr, e.message
94 self.badPeerHappened()
96 def badPeerHappened(self):
98 print "Bad peer banned:", self.addr
99 self.transport.loseConnection()
100 if self.transport.getPeer().host != '127.0.0.1': # never ban localhost
101 self.node.bans[self.transport.getPeer().host] = time.time() + 60*60
104 self.timeout_delayed = None
105 print 'Connection timed out, disconnecting from %s:%i' % self.addr
106 self.transport.loseConnection()
108 message_version = pack.ComposedType([
109 ('version', pack.IntType(32)),
110 ('services', pack.IntType(64)),
111 ('addr_to', bitcoin_data.address_type),
112 ('addr_from', bitcoin_data.address_type),
113 ('nonce', pack.IntType(64)),
114 ('sub_version', pack.VarStrType()),
115 ('mode', pack.IntType(32)), # always 1 for legacy compatibility
116 ('best_share_hash', pack.PossiblyNoneType(0, pack.IntType(256))),
118 def handle_version(self, version, services, addr_to, addr_from, nonce, sub_version, mode, best_share_hash):
119 if self.other_version is not None:
120 raise PeerMisbehavingError('more than one version message')
122 raise PeerMisbehavingError('peer too old')
124 self.other_version = version
125 self.other_sub_version = sub_version[:512]
126 self.other_services = services
128 if nonce == self.node.nonce:
129 raise PeerMisbehavingError('was connected to self')
130 if nonce in self.node.peers:
132 print 'Detected duplicate connection, disconnecting from %s:%i' % self.addr
133 self.transport.loseConnection()
137 self.connected2 = True
139 self.timeout_delayed.cancel()
140 self.timeout_delayed = reactor.callLater(100, self._timeout)
142 old_dataReceived = self.dataReceived
143 def new_dataReceived(data):
144 if self.timeout_delayed is not None:
145 self.timeout_delayed.reset(100)
146 old_dataReceived(data)
147 self.dataReceived = new_dataReceived
149 self.factory.proto_connected(self)
151 self._stop_thread = deferral.run_repeatedly(lambda: [
153 random.expovariate(1/100)][-1])
155 self._stop_thread2 = deferral.run_repeatedly(lambda: [
156 self.send_addrme(port=self.node.port),
157 random.expovariate(1/(100*len(self.node.peers) + 1))][-1])
159 if best_share_hash is not None:
160 self.node.handle_share_hashes([best_share_hash], self)
162 if self.other_version < 8:
165 def update_remote_view_of_my_known_txs(before, after):
166 added = set(after) - set(before)
167 removed = set(before) - set(after)
169 self.send_have_tx(tx_hashes=list(added))
171 self.send_losing_tx(tx_hashes=list(removed))
173 # cache forgotten txs here for a little while so latency of "losing_tx" packets doesn't cause problems
174 key = max(self.known_txs_cache) + 1 if self.known_txs_cache else 0
175 self.known_txs_cache[key] = dict((h, before[h]) for h in removed)
176 reactor.callLater(20, self.known_txs_cache.pop, key)
177 watch_id = self.node.known_txs_var.transitioned.watch(update_remote_view_of_my_known_txs)
178 self.connection_lost_event.watch(lambda: self.node.known_txs_var.transitioned.unwatch(watch_id))
180 self.send_have_tx(tx_hashes=self.node.known_txs_var.value.keys())
182 def update_remote_view_of_my_mining_txs(before, after):
183 added = set(after) - set(before)
184 removed = set(before) - set(after)
186 self.remote_remembered_txs_size += sum(bitcoin_data.tx_type.packed_size(after[x]) for x in added)
187 assert self.remote_remembered_txs_size <= self.max_remembered_txs_size
188 fragment(self.send_remember_tx, tx_hashes=[x for x in added if x in self.remote_tx_hashes], txs=[after[x] for x in added if x not in self.remote_tx_hashes])
190 self.send_forget_tx(tx_hashes=list(removed))
191 self.remote_remembered_txs_size -= sum(bitcoin_data.tx_type.packed_size(before[x]) for x in removed)
192 watch_id2 = self.node.mining_txs_var.transitioned.watch(update_remote_view_of_my_mining_txs)
193 self.connection_lost_event.watch(lambda: self.node.mining_txs_var.transitioned.unwatch(watch_id2))
195 self.remote_remembered_txs_size += sum(bitcoin_data.tx_type.packed_size(x) for x in self.node.mining_txs_var.value.values())
196 assert self.remote_remembered_txs_size <= self.max_remembered_txs_size
197 fragment(self.send_remember_tx, tx_hashes=[], txs=self.node.mining_txs_var.value.values())
199 message_ping = pack.ComposedType([])
200 def handle_ping(self):
203 message_addrme = pack.ComposedType([
204 ('port', pack.IntType(16)),
206 def handle_addrme(self, port):
207 host = self.transport.getPeer().host
208 #print 'addrme from', host, port
209 if host == '127.0.0.1':
210 if random.random() < .8 and self.node.peers:
211 random.choice(self.node.peers.values()).send_addrme(port=port) # services...
213 self.node.got_addr((self.transport.getPeer().host, port), self.other_services, int(time.time()))
214 if random.random() < .8 and self.node.peers:
215 random.choice(self.node.peers.values()).send_addrs(addrs=[
218 services=self.other_services,
222 timestamp=int(time.time()),
226 message_addrs = pack.ComposedType([
227 ('addrs', pack.ListType(pack.ComposedType([
228 ('timestamp', pack.IntType(64)),
229 ('address', bitcoin_data.address_type),
232 def handle_addrs(self, addrs):
233 for addr_record in addrs:
234 self.node.got_addr((addr_record['address']['address'], addr_record['address']['port']), addr_record['address']['services'], min(int(time.time()), addr_record['timestamp']))
235 if random.random() < .8 and self.node.peers:
236 random.choice(self.node.peers.values()).send_addrs(addrs=[addr_record])
238 message_getaddrs = pack.ComposedType([
239 ('count', pack.IntType(32)),
241 def handle_getaddrs(self, count):
244 self.send_addrs(addrs=[
246 timestamp=int(self.node.addr_store[host, port][2]),
248 services=self.node.addr_store[host, port][0],
253 self.node.get_good_peers(count)
256 message_shares = pack.ComposedType([
257 ('shares', pack.ListType(p2pool_data.share_type)),
259 def handle_shares(self, shares):
260 self.node.handle_shares([p2pool_data.load_share(share, self.node.net, self) for share in shares if share['type'] not in [6, 7]], self)
262 def sendShares(self, shares, tracker, known_txs, include_txs_with=[]):
264 return defer.succeed(None)
266 if self.other_version >= 8:
269 if share.hash in include_txs_with:
270 tx_hashes.update(share.get_other_tx_hashes(tracker))
272 hashes_to_send = [x for x in tx_hashes if x not in self.node.mining_txs_var.value and x in known_txs]
274 new_remote_remembered_txs_size = self.remote_remembered_txs_size + sum(bitcoin_data.tx_type.packed_size(known_txs[x]) for x in hashes_to_send)
275 if new_remote_remembered_txs_size > self.max_remembered_txs_size:
276 raise ValueError('shares have too many txs')
277 self.remote_remembered_txs_size = new_remote_remembered_txs_size
279 fragment(self.send_remember_tx, tx_hashes=[x for x in hashes_to_send if x in self.remote_tx_hashes], txs=[known_txs[x] for x in hashes_to_send if x not in self.remote_tx_hashes])
281 res = fragment(self.send_shares, shares=[share.as_share() for share in shares])
283 if self.other_version >= 8:
284 res = self.send_forget_tx(tx_hashes=hashes_to_send)
286 self.remote_remembered_txs_size -= sum(bitcoin_data.tx_type.packed_size(known_txs[x]) for x in hashes_to_send)
291 message_sharereq = pack.ComposedType([
292 ('id', pack.IntType(256)),
293 ('hashes', pack.ListType(pack.IntType(256))),
294 ('parents', pack.VarIntType()),
295 ('stops', pack.ListType(pack.IntType(256))),
297 def handle_sharereq(self, id, hashes, parents, stops):
298 shares = self.node.handle_get_shares(hashes, parents, stops, self)
300 self.send_sharereply(id=id, result='good', shares=[share.as_share() for share in shares])
301 except p2protocol.TooLong:
302 self.send_sharereply(id=id, result='too long', shares=[])
304 message_sharereply = pack.ComposedType([
305 ('id', pack.IntType(256)),
306 ('result', pack.EnumType(pack.VarIntType(), {0: 'good', 1: 'too long', 2: 'unk2', 3: 'unk3', 4: 'unk4', 5: 'unk5', 6: 'unk6'})),
307 ('shares', pack.ListType(p2pool_data.share_type)),
309 def handle_sharereply(self, id, result, shares):
311 res = [p2pool_data.load_share(share, self.node.net, self) for share in shares if share['type'] not in [6, 7]]
313 res = failure.Failure("sharereply result: " + result)
314 self.get_shares.got_response(id, res)
317 message_bestblock = pack.ComposedType([
318 ('header', bitcoin_data.block_header_type),
320 def handle_bestblock(self, header):
321 self.node.handle_bestblock(header, self)
324 message_have_tx = pack.ComposedType([
325 ('tx_hashes', pack.ListType(pack.IntType(256))),
327 def handle_have_tx(self, tx_hashes):
328 assert self.remote_tx_hashes.isdisjoint(tx_hashes)
329 self.remote_tx_hashes.update(tx_hashes)
330 message_losing_tx = pack.ComposedType([
331 ('tx_hashes', pack.ListType(pack.IntType(256))),
333 def handle_losing_tx(self, tx_hashes):
334 assert self.remote_tx_hashes.issuperset(tx_hashes)
335 self.remote_tx_hashes.difference_update(tx_hashes)
338 message_remember_tx = pack.ComposedType([
339 ('tx_hashes', pack.ListType(pack.IntType(256))),
340 ('txs', pack.ListType(bitcoin_data.tx_type)),
342 def handle_remember_tx(self, tx_hashes, txs):
343 for tx_hash in tx_hashes:
344 if tx_hash in self.remembered_txs:
345 print >>sys.stderr, 'Peer referenced transaction twice, disconnecting'
346 self.transport.loseConnection()
349 if tx_hash in self.node.known_txs_var.value:
350 tx = self.node.known_txs_var.value[tx_hash]
352 for cache in self.known_txs_cache.itervalues():
355 print 'Transaction rescued from peer latency cache!'
358 print >>sys.stderr, 'Peer referenced unknown transaction, disconnecting'
359 self.transport.loseConnection()
362 self.remembered_txs[tx_hash] = tx
363 self.remembered_txs_size += bitcoin_data.tx_type.packed_size(tx)
364 new_known_txs = dict(self.node.known_txs_var.value)
367 tx_hash = bitcoin_data.hash256(bitcoin_data.tx_type.pack(tx))
368 if tx_hash in self.remembered_txs:
369 print >>sys.stderr, 'Peer referenced transaction twice, disconnecting'
370 self.transport.loseConnection()
373 if tx_hash in self.node.known_txs_var.value and not warned:
374 print 'Peer sent entire transaction that was already received'
377 self.remembered_txs[tx_hash] = tx
378 self.remembered_txs_size += bitcoin_data.tx_type.packed_size(tx)
379 new_known_txs[tx_hash] = tx
380 self.node.known_txs_var.set(new_known_txs)
381 if self.remembered_txs_size >= self.max_remembered_txs_size:
382 raise PeerMisbehavingError('too much transaction data stored')
383 message_forget_tx = pack.ComposedType([
384 ('tx_hashes', pack.ListType(pack.IntType(256))),
386 def handle_forget_tx(self, tx_hashes):
387 for tx_hash in tx_hashes:
388 self.remembered_txs_size -= bitcoin_data.tx_type.packed_size(self.remembered_txs[tx_hash])
389 assert self.remembered_txs_size >= 0
390 del self.remembered_txs[tx_hash]
393 def connectionLost(self, reason):
394 self.connection_lost_event.happened()
395 if self.timeout_delayed is not None:
396 self.timeout_delayed.cancel()
398 self.factory.proto_disconnected(self, reason)
401 self.connected2 = False
402 self.factory.proto_lost_connection(self, reason)
404 print "Peer connection lost:", self.addr, reason
405 self.get_shares.respond_all(reason)
407 @defer.inlineCallbacks
409 start = reactor.seconds()
410 yield self.get_shares(hashes=[0], parents=0, stops=[])
411 end = reactor.seconds()
412 defer.returnValue(end - start)
414 class ServerFactory(protocol.ServerFactory):
415 def __init__(self, node, max_conns):
417 self.max_conns = max_conns
422 def buildProtocol(self, addr):
423 if sum(self.conns.itervalues()) >= self.max_conns or self.conns.get(self._host_to_ident(addr.host), 0) >= 3:
425 if addr.host in self.node.bans and self.node.bans[addr.host] > time.time():
427 p = Protocol(self.node, True)
430 print "Got peer connection from:", addr
433 def _host_to_ident(self, host):
434 a, b, c, d = host.split('.')
437 def proto_made_connection(self, proto):
438 ident = self._host_to_ident(proto.transport.getPeer().host)
439 self.conns[ident] = self.conns.get(ident, 0) + 1
440 def proto_lost_connection(self, proto, reason):
441 ident = self._host_to_ident(proto.transport.getPeer().host)
442 self.conns[ident] -= 1
443 if not self.conns[ident]:
444 del self.conns[ident]
446 def proto_connected(self, proto):
447 self.node.got_conn(proto)
448 def proto_disconnected(self, proto, reason):
449 self.node.lost_conn(proto, reason)
452 assert not self.running
455 def attempt_listen():
457 self.listen_port = reactor.listenTCP(self.node.port, self)
458 deferral.retry('Error binding to P2P port:', traceback=False)(attempt_listen)()
464 return self.listen_port.stopListening()
466 class ClientFactory(protocol.ClientFactory):
467 def __init__(self, node, desired_conns, max_attempts):
469 self.desired_conns = desired_conns
470 self.max_attempts = max_attempts
472 self.attempts = set()
476 def _host_to_ident(self, host):
477 a, b, c, d = host.split('.')
480 def buildProtocol(self, addr):
481 p = Protocol(self.node, False)
485 def startedConnecting(self, connector):
486 ident = self._host_to_ident(connector.getDestination().host)
487 if ident in self.attempts:
488 raise AssertionError('already have attempt')
489 self.attempts.add(ident)
491 def clientConnectionFailed(self, connector, reason):
492 self.attempts.remove(self._host_to_ident(connector.getDestination().host))
494 def clientConnectionLost(self, connector, reason):
495 self.attempts.remove(self._host_to_ident(connector.getDestination().host))
497 def proto_made_connection(self, proto):
499 def proto_lost_connection(self, proto, reason):
502 def proto_connected(self, proto):
503 self.conns.add(proto)
504 self.node.got_conn(proto)
505 def proto_disconnected(self, proto, reason):
506 self.conns.remove(proto)
507 self.node.lost_conn(proto, reason)
510 assert not self.running
512 self._stop_thinking = deferral.run_repeatedly(self._think)
516 self._stop_thinking()
520 if len(self.conns) < self.desired_conns and len(self.attempts) < self.max_attempts and self.node.addr_store:
521 (host, port), = self.node.get_good_peers(1)
523 if self._host_to_ident(host) in self.attempts:
525 elif host in self.node.bans and self.node.bans[host] > time.time():
528 #print 'Trying to connect to', host, port
529 reactor.connectTCP(host, port, self, timeout=5)
533 return random.expovariate(1/1)
535 class SingleClientFactory(protocol.ReconnectingClientFactory):
536 def __init__(self, node):
539 def buildProtocol(self, addr):
540 p = Protocol(self.node, incoming=False)
544 def proto_made_connection(self, proto):
546 def proto_lost_connection(self, proto, reason):
549 def proto_connected(self, proto):
551 self.node.got_conn(proto)
552 def proto_disconnected(self, proto, reason):
553 self.node.lost_conn(proto, reason)
556 def __init__(self, best_share_hash_func, port, net, addr_store={}, connect_addrs=set(), desired_outgoing_conns=10, max_outgoing_attempts=30, max_incoming_conns=50, preferred_storage=1000, known_txs_var=variable.Variable({}), mining_txs_var=variable.Variable({})):
557 self.best_share_hash_func = best_share_hash_func
560 self.addr_store = dict(addr_store)
561 self.connect_addrs = connect_addrs
562 self.preferred_storage = preferred_storage
563 self.known_txs_var = known_txs_var
564 self.mining_txs_var = mining_txs_var
566 self.traffic_happened = variable.Event()
567 self.nonce = random.randrange(2**64)
569 self.bans = {} # address -> end_time
570 self.clientfactory = ClientFactory(self, desired_outgoing_conns, max_outgoing_attempts)
571 self.serverfactory = ServerFactory(self, max_incoming_conns)
576 raise ValueError('already running')
578 self.clientfactory.start()
579 self.serverfactory.start()
580 self.singleclientconnectors = [reactor.connectTCP(addr, port, SingleClientFactory(self)) for addr, port in self.connect_addrs]
584 self._stop_thinking = deferral.run_repeatedly(self._think)
588 if len(self.addr_store) < self.preferred_storage and self.peers:
589 random.choice(self.peers.values()).send_getaddrs(count=8)
593 return random.expovariate(1/20)
595 @defer.inlineCallbacks
598 raise ValueError('already stopped')
602 self._stop_thinking()
603 yield self.clientfactory.stop()
604 yield self.serverfactory.stop()
605 for singleclientconnector in self.singleclientconnectors:
606 yield singleclientconnector.factory.stopTrying()
607 yield singleclientconnector.disconnect()
608 del self.singleclientconnectors
610 def got_conn(self, conn):
611 if conn.nonce in self.peers:
612 raise ValueError('already have peer')
613 self.peers[conn.nonce] = conn
615 print '%s connection to peer %s:%i established. p2pool version: %i %r' % ('Incoming' if conn.incoming else 'Outgoing', conn.addr[0], conn.addr[1], conn.other_version, conn.other_sub_version)
617 def lost_conn(self, conn, reason):
618 if conn.nonce not in self.peers:
619 raise ValueError('''don't have peer''')
620 if conn is not self.peers[conn.nonce]:
621 raise ValueError('wrong conn')
622 del self.peers[conn.nonce]
624 print 'Lost peer %s:%i - %s' % (conn.addr[0], conn.addr[1], reason.getErrorMessage())
627 def got_addr(self, (host, port), services, timestamp):
628 if (host, port) in self.addr_store:
629 old_services, old_first_seen, old_last_seen = self.addr_store[host, port]
630 self.addr_store[host, port] = services, old_first_seen, max(old_last_seen, timestamp)
632 self.addr_store[host, port] = services, timestamp, timestamp
634 def handle_shares(self, shares, peer):
635 print 'handle_shares', (shares, peer)
637 def handle_share_hashes(self, hashes, peer):
638 print 'handle_share_hashes', (hashes, peer)
640 def handle_get_shares(self, hashes, parents, stops, peer):
641 print 'handle_get_shares', (hashes, parents, stops, peer)
643 def handle_bestblock(self, header, peer):
644 print 'handle_bestblock', header
646 def get_good_peers(self, max_count):
648 return [x[0] for x in sorted(self.addr_store.iteritems(), key=lambda (k, (services, first_seen, last_seen)):
649 -math.log(max(3600, last_seen - first_seen))/math.log(max(3600, t - last_seen))*random.expovariate(1)