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 self.node.bans[self.transport.getPeer().host] = time.time() + 60*60
103 self.timeout_delayed = None
104 print 'Connection timed out, disconnecting from %s:%i' % self.addr
105 self.transport.loseConnection()
107 message_version = pack.ComposedType([
108 ('version', pack.IntType(32)),
109 ('services', pack.IntType(64)),
110 ('addr_to', bitcoin_data.address_type),
111 ('addr_from', bitcoin_data.address_type),
112 ('nonce', pack.IntType(64)),
113 ('sub_version', pack.VarStrType()),
114 ('mode', pack.IntType(32)), # always 1 for legacy compatibility
115 ('best_share_hash', pack.PossiblyNoneType(0, pack.IntType(256))),
117 def handle_version(self, version, services, addr_to, addr_from, nonce, sub_version, mode, best_share_hash):
118 if self.other_version is not None:
119 raise PeerMisbehavingError('more than one version message')
121 raise PeerMisbehavingError('peer too old')
123 self.other_version = version
124 self.other_sub_version = sub_version[:512]
125 self.other_services = services
127 if nonce == self.node.nonce:
128 raise PeerMisbehavingError('was connected to self')
129 if nonce in self.node.peers:
131 print 'Detected duplicate connection, disconnecting from %s:%i' % self.addr
132 self.transport.loseConnection()
136 self.connected2 = True
138 self.timeout_delayed.cancel()
139 self.timeout_delayed = reactor.callLater(100, self._timeout)
141 old_dataReceived = self.dataReceived
142 def new_dataReceived(data):
143 if self.timeout_delayed is not None:
144 self.timeout_delayed.reset(100)
145 old_dataReceived(data)
146 self.dataReceived = new_dataReceived
148 self.factory.proto_connected(self)
150 self._stop_thread = deferral.run_repeatedly(lambda: [
152 random.expovariate(1/100)][-1])
154 self._stop_thread2 = deferral.run_repeatedly(lambda: [
155 self.send_addrme(port=self.node.port),
156 random.expovariate(1/(100*len(self.node.peers) + 1))][-1])
158 if best_share_hash is not None:
159 self.node.handle_share_hashes([best_share_hash], self)
161 if self.other_version < 8:
164 def update_remote_view_of_my_known_txs(before, after):
165 added = set(after) - set(before)
166 removed = set(before) - set(after)
168 self.send_have_tx(tx_hashes=list(added))
170 self.send_losing_tx(tx_hashes=list(removed))
172 # cache forgotten txs here for a little while so latency of "losing_tx" packets doesn't cause problems
173 key = max(self.known_txs_cache) + 1 if self.known_txs_cache else 0
174 self.known_txs_cache[key] = dict((h, before[h]) for h in removed)
175 reactor.callLater(20, self.known_txs_cache.pop, key)
176 watch_id = self.node.known_txs_var.transitioned.watch(update_remote_view_of_my_known_txs)
177 self.connection_lost_event.watch(lambda: self.node.known_txs_var.transitioned.unwatch(watch_id))
179 self.send_have_tx(tx_hashes=self.node.known_txs_var.value.keys())
181 def update_remote_view_of_my_mining_txs(before, after):
182 added = set(after) - set(before)
183 removed = set(before) - set(after)
185 self.remote_remembered_txs_size += sum(bitcoin_data.tx_type.packed_size(after[x]) for x in added)
186 assert self.remote_remembered_txs_size <= self.max_remembered_txs_size
187 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])
189 self.send_forget_tx(tx_hashes=list(removed))
190 self.remote_remembered_txs_size -= sum(bitcoin_data.tx_type.packed_size(before[x]) for x in removed)
191 watch_id2 = self.node.mining_txs_var.transitioned.watch(update_remote_view_of_my_mining_txs)
192 self.connection_lost_event.watch(lambda: self.node.mining_txs_var.transitioned.unwatch(watch_id2))
194 self.remote_remembered_txs_size += sum(bitcoin_data.tx_type.packed_size(x) for x in self.node.mining_txs_var.value.values())
195 assert self.remote_remembered_txs_size <= self.max_remembered_txs_size
196 fragment(self.send_remember_tx, tx_hashes=[], txs=self.node.mining_txs_var.value.values())
198 message_ping = pack.ComposedType([])
199 def handle_ping(self):
202 message_addrme = pack.ComposedType([
203 ('port', pack.IntType(16)),
205 def handle_addrme(self, port):
206 host = self.transport.getPeer().host
207 #print 'addrme from', host, port
208 if host == '127.0.0.1':
209 if random.random() < .8 and self.node.peers:
210 random.choice(self.node.peers.values()).send_addrme(port=port) # services...
212 self.node.got_addr((self.transport.getPeer().host, port), self.other_services, int(time.time()))
213 if random.random() < .8 and self.node.peers:
214 random.choice(self.node.peers.values()).send_addrs(addrs=[
217 services=self.other_services,
221 timestamp=int(time.time()),
225 message_addrs = pack.ComposedType([
226 ('addrs', pack.ListType(pack.ComposedType([
227 ('timestamp', pack.IntType(64)),
228 ('address', bitcoin_data.address_type),
231 def handle_addrs(self, addrs):
232 for addr_record in addrs:
233 self.node.got_addr((addr_record['address']['address'], addr_record['address']['port']), addr_record['address']['services'], min(int(time.time()), addr_record['timestamp']))
234 if random.random() < .8 and self.node.peers:
235 random.choice(self.node.peers.values()).send_addrs(addrs=[addr_record])
237 message_getaddrs = pack.ComposedType([
238 ('count', pack.IntType(32)),
240 def handle_getaddrs(self, count):
243 self.send_addrs(addrs=[
245 timestamp=int(self.node.addr_store[host, port][2]),
247 services=self.node.addr_store[host, port][0],
252 self.node.get_good_peers(count)
255 message_shares = pack.ComposedType([
256 ('shares', pack.ListType(p2pool_data.share_type)),
258 def handle_shares(self, shares):
259 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)
261 def sendShares(self, shares, tracker, known_txs, include_txs_with=[]):
263 return defer.succeed(None)
265 if self.other_version >= 8:
268 if share.hash in include_txs_with:
269 tx_hashes.update(share.get_other_tx_hashes(tracker))
271 hashes_to_send = [x for x in tx_hashes if x not in self.node.mining_txs_var.value and x in known_txs]
273 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)
274 if new_remote_remembered_txs_size > self.max_remembered_txs_size:
275 raise ValueError('shares have too many txs')
276 self.remote_remembered_txs_size = new_remote_remembered_txs_size
278 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])
280 res = fragment(self.send_shares, shares=[share.as_share() for share in shares])
282 if self.other_version >= 8:
283 res = self.send_forget_tx(tx_hashes=hashes_to_send)
285 self.remote_remembered_txs_size -= sum(bitcoin_data.tx_type.packed_size(known_txs[x]) for x in hashes_to_send)
290 message_sharereq = pack.ComposedType([
291 ('id', pack.IntType(256)),
292 ('hashes', pack.ListType(pack.IntType(256))),
293 ('parents', pack.VarIntType()),
294 ('stops', pack.ListType(pack.IntType(256))),
296 def handle_sharereq(self, id, hashes, parents, stops):
297 shares = self.node.handle_get_shares(hashes, parents, stops, self)
299 self.send_sharereply(id=id, result='good', shares=[share.as_share() for share in shares])
300 except p2protocol.TooLong:
301 self.send_sharereply(id=id, result='too long', shares=[])
303 message_sharereply = pack.ComposedType([
304 ('id', pack.IntType(256)),
305 ('result', pack.EnumType(pack.VarIntType(), {0: 'good', 1: 'too long', 2: 'unk2', 3: 'unk3', 4: 'unk4', 5: 'unk5', 6: 'unk6'})),
306 ('shares', pack.ListType(p2pool_data.share_type)),
308 def handle_sharereply(self, id, result, shares):
310 res = [p2pool_data.load_share(share, self.node.net, self) for share in shares if share['type'] not in [6, 7]]
312 res = failure.Failure("sharereply result: " + result)
313 self.get_shares.got_response(id, res)
316 message_bestblock = pack.ComposedType([
317 ('header', bitcoin_data.block_header_type),
319 def handle_bestblock(self, header):
320 self.node.handle_bestblock(header, self)
323 message_have_tx = pack.ComposedType([
324 ('tx_hashes', pack.ListType(pack.IntType(256))),
326 def handle_have_tx(self, tx_hashes):
327 assert self.remote_tx_hashes.isdisjoint(tx_hashes)
328 self.remote_tx_hashes.update(tx_hashes)
329 message_losing_tx = pack.ComposedType([
330 ('tx_hashes', pack.ListType(pack.IntType(256))),
332 def handle_losing_tx(self, tx_hashes):
333 assert self.remote_tx_hashes.issuperset(tx_hashes)
334 self.remote_tx_hashes.difference_update(tx_hashes)
337 message_remember_tx = pack.ComposedType([
338 ('tx_hashes', pack.ListType(pack.IntType(256))),
339 ('txs', pack.ListType(bitcoin_data.tx_type)),
341 def handle_remember_tx(self, tx_hashes, txs):
342 for tx_hash in tx_hashes:
343 if tx_hash in self.remembered_txs:
344 print >>sys.stderr, 'Peer referenced transaction twice, disconnecting'
345 self.transport.loseConnection()
348 if tx_hash in self.node.known_txs_var.value:
349 tx = self.node.known_txs_var.value[tx_hash]
351 for cache in self.known_txs_cache.itervalues():
354 print 'Transaction rescued from peer latency cache!'
357 print >>sys.stderr, 'Peer referenced unknown transaction, disconnecting'
358 self.transport.loseConnection()
361 self.remembered_txs[tx_hash] = tx
362 self.remembered_txs_size += bitcoin_data.tx_type.packed_size(tx)
363 new_known_txs = dict(self.node.known_txs_var.value)
366 tx_hash = bitcoin_data.hash256(bitcoin_data.tx_type.pack(tx))
367 if tx_hash in self.remembered_txs:
368 print >>sys.stderr, 'Peer referenced transaction twice, disconnecting'
369 self.transport.loseConnection()
372 if tx_hash in self.node.known_txs_var.value and not warned:
373 print 'Peer sent entire transaction that was already received'
376 self.remembered_txs[tx_hash] = tx
377 self.remembered_txs_size += bitcoin_data.tx_type.packed_size(tx)
378 new_known_txs[tx_hash] = tx
379 self.node.known_txs_var.set(new_known_txs)
380 if self.remembered_txs_size >= self.max_remembered_txs_size:
381 raise PeerMisbehavingError('too much transaction data stored')
382 message_forget_tx = pack.ComposedType([
383 ('tx_hashes', pack.ListType(pack.IntType(256))),
385 def handle_forget_tx(self, tx_hashes):
386 for tx_hash in tx_hashes:
387 self.remembered_txs_size -= bitcoin_data.tx_type.packed_size(self.remembered_txs[tx_hash])
388 assert self.remembered_txs_size >= 0
389 del self.remembered_txs[tx_hash]
392 def connectionLost(self, reason):
393 self.connection_lost_event.happened()
394 if self.timeout_delayed is not None:
395 self.timeout_delayed.cancel()
397 self.factory.proto_disconnected(self, reason)
400 self.connected2 = False
401 self.factory.proto_lost_connection(self, reason)
403 print "Peer connection lost:", self.addr, reason
404 self.get_shares.respond_all(reason)
406 @defer.inlineCallbacks
408 start = reactor.seconds()
409 yield self.get_shares(hashes=[0], parents=0, stops=[])
410 end = reactor.seconds()
411 defer.returnValue(end - start)
413 class ServerFactory(protocol.ServerFactory):
414 def __init__(self, node, max_conns):
416 self.max_conns = max_conns
421 def buildProtocol(self, addr):
422 if sum(self.conns.itervalues()) >= self.max_conns or self.conns.get(self._host_to_ident(addr.host), 0) >= 3:
424 if addr.host in self.node.bans and self.node.bans[addr.host] > time.time():
426 p = Protocol(self.node, True)
429 print "Got peer connection from:", addr
432 def _host_to_ident(self, host):
433 a, b, c, d = host.split('.')
436 def proto_made_connection(self, proto):
437 ident = self._host_to_ident(proto.transport.getPeer().host)
438 self.conns[ident] = self.conns.get(ident, 0) + 1
439 def proto_lost_connection(self, proto, reason):
440 ident = self._host_to_ident(proto.transport.getPeer().host)
441 self.conns[ident] -= 1
442 if not self.conns[ident]:
443 del self.conns[ident]
445 def proto_connected(self, proto):
446 self.node.got_conn(proto)
447 def proto_disconnected(self, proto, reason):
448 self.node.lost_conn(proto, reason)
451 assert not self.running
454 def attempt_listen():
456 self.listen_port = reactor.listenTCP(self.node.port, self)
457 deferral.retry('Error binding to P2P port:', traceback=False)(attempt_listen)()
463 return self.listen_port.stopListening()
465 class ClientFactory(protocol.ClientFactory):
466 def __init__(self, node, desired_conns, max_attempts):
468 self.desired_conns = desired_conns
469 self.max_attempts = max_attempts
471 self.attempts = set()
475 def _host_to_ident(self, host):
476 a, b, c, d = host.split('.')
479 def buildProtocol(self, addr):
480 p = Protocol(self.node, False)
484 def startedConnecting(self, connector):
485 ident = self._host_to_ident(connector.getDestination().host)
486 if ident in self.attempts:
487 raise AssertionError('already have attempt')
488 self.attempts.add(ident)
490 def clientConnectionFailed(self, connector, reason):
491 self.attempts.remove(self._host_to_ident(connector.getDestination().host))
493 def clientConnectionLost(self, connector, reason):
494 self.attempts.remove(self._host_to_ident(connector.getDestination().host))
496 def proto_made_connection(self, proto):
498 def proto_lost_connection(self, proto, reason):
501 def proto_connected(self, proto):
502 self.conns.add(proto)
503 self.node.got_conn(proto)
504 def proto_disconnected(self, proto, reason):
505 self.conns.remove(proto)
506 self.node.lost_conn(proto, reason)
509 assert not self.running
511 self._stop_thinking = deferral.run_repeatedly(self._think)
515 self._stop_thinking()
519 if len(self.conns) < self.desired_conns and len(self.attempts) < self.max_attempts and self.node.addr_store:
520 (host, port), = self.node.get_good_peers(1)
522 if self._host_to_ident(host) in self.attempts:
524 elif host in self.node.bans and self.node.bans[host] > time.time():
527 #print 'Trying to connect to', host, port
528 reactor.connectTCP(host, port, self, timeout=5)
532 return random.expovariate(1/1)
534 class SingleClientFactory(protocol.ReconnectingClientFactory):
535 def __init__(self, node):
538 def buildProtocol(self, addr):
539 p = Protocol(self.node, incoming=False)
543 def proto_made_connection(self, proto):
545 def proto_lost_connection(self, proto, reason):
548 def proto_connected(self, proto):
550 self.node.got_conn(proto)
551 def proto_disconnected(self, proto, reason):
552 self.node.lost_conn(proto, reason)
555 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({})):
556 self.best_share_hash_func = best_share_hash_func
559 self.addr_store = dict(addr_store)
560 self.connect_addrs = connect_addrs
561 self.preferred_storage = preferred_storage
562 self.known_txs_var = known_txs_var
563 self.mining_txs_var = mining_txs_var
565 self.traffic_happened = variable.Event()
566 self.nonce = random.randrange(2**64)
568 self.bans = {} # address -> end_time
569 self.clientfactory = ClientFactory(self, desired_outgoing_conns, max_outgoing_attempts)
570 self.serverfactory = ServerFactory(self, max_incoming_conns)
575 raise ValueError('already running')
577 self.clientfactory.start()
578 self.serverfactory.start()
579 self.singleclientconnectors = [reactor.connectTCP(addr, port, SingleClientFactory(self)) for addr, port in self.connect_addrs]
583 self._stop_thinking = deferral.run_repeatedly(self._think)
587 if len(self.addr_store) < self.preferred_storage and self.peers:
588 random.choice(self.peers.values()).send_getaddrs(count=8)
592 return random.expovariate(1/20)
594 @defer.inlineCallbacks
597 raise ValueError('already stopped')
601 self._stop_thinking()
602 yield self.clientfactory.stop()
603 yield self.serverfactory.stop()
604 for singleclientconnector in self.singleclientconnectors:
605 yield singleclientconnector.factory.stopTrying()
606 yield singleclientconnector.disconnect()
607 del self.singleclientconnectors
609 def got_conn(self, conn):
610 if conn.nonce in self.peers:
611 raise ValueError('already have peer')
612 self.peers[conn.nonce] = conn
614 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)
616 def lost_conn(self, conn, reason):
617 if conn.nonce not in self.peers:
618 raise ValueError('''don't have peer''')
619 if conn is not self.peers[conn.nonce]:
620 raise ValueError('wrong conn')
621 del self.peers[conn.nonce]
623 print 'Lost peer %s:%i - %s' % (conn.addr[0], conn.addr[1], reason.getErrorMessage())
626 def got_addr(self, (host, port), services, timestamp):
627 if (host, port) in self.addr_store:
628 old_services, old_first_seen, old_last_seen = self.addr_store[host, port]
629 self.addr_store[host, port] = services, old_first_seen, max(old_last_seen, timestamp)
631 self.addr_store[host, port] = services, timestamp, timestamp
633 def handle_shares(self, shares, peer):
634 print 'handle_shares', (shares, peer)
636 def handle_share_hashes(self, hashes, peer):
637 print 'handle_share_hashes', (hashes, peer)
639 def handle_get_shares(self, hashes, parents, stops, peer):
640 print 'handle_get_shares', (hashes, parents, stops, peer)
642 def handle_bestblock(self, header, peer):
643 print 'handle_bestblock', header
645 def get_good_peers(self, max_count):
647 return [x[0] for x in sorted(self.addr_store.iteritems(), key=lambda (k, (services, first_seen, last_seen)):
648 -math.log(max(3600, last_seen - first_seen))/math.log(max(3600, t - last_seen))*random.expovariate(1)