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