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