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