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 = False
  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_setmode(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_setmode = bitcoin_data.ComposedType([
 120         ('mode', bitcoin_data.StructType('<I')),
 121     ])
 122     def handle_setmode(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_getshares = bitcoin_data.ComposedType([
 181         ('hashes', bitcoin_data.ListType(bitcoin_data.HashType())),
 182         ('parents', bitcoin_data.VarIntType()),
 183         ('stops', bitcoin_data.ListType(bitcoin_data.HashType())),
 184     ])
 185     def handle_getshares(self, hashes, parents, stops):
 186         self.node.handle_get_shares(hashes, parents, stops, self)
 187
 188     message_share0s = bitcoin_data.ComposedType([
 189         ('hashes', bitcoin_data.ListType(bitcoin_data.HashType())),
 190     ])
 191     def handle_share0s(self, hashes):
 192         self.node.handle_share_hashes(hashes, self)
 193
 194     message_share1as = bitcoin_data.ComposedType([
 195         ('share1as', bitcoin_data.ListType(p2pool_data.share1a_type)),
 196     ])
 197     def handle_share1as(self, share1as):
 198         shares = []
 199         for share1a in share1as:
 200             hash_ = bitcoin_data.block_header_type.hash256(share1a['header'])
 201             if hash_ <= share1a['header']['target']:
 202                 print 'Dropping peer %s:%i due to invalid share' % (self.transport.getPeer().host, self.transport.getPeer().port)
 203                 self.transport.loseConnection()
 204                 return
 205             share = p2pool_data.Share.from_share1a(share1a)
 206             share.peer = self # XXX
 207             share.highest_block_on_arrival = self.node.current_work.value['previous_block'] # XXX
 208             shares.append(share)
 209         self.node.handle_shares(shares, self)
 210
 211     message_share1bs = bitcoin_data.ComposedType([
 212         ('share1bs', bitcoin_data.ListType(p2pool_data.share1b_type)),
 213     ])
 214     def handle_share1bs(self, share1bs):
 215         shares = []
 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             share.highest_block_on_arrival = self.node.current_work.value['previous_block'] # XXX
 225             shares.append(share)
 226         self.node.handle_shares(shares, self)
 227
 228     def send_shares(self, shares, full=False):
 229         share1bs = []
 230         share0s = []
 231         share1as = []
 232         # XXX doesn't need to send full block when it's not urgent
 233         # eg. when getting history
 234         for share in shares:
 235             if share.bitcoin_hash <= share.header['target']:
 236                 share1bs.append(share.as_share1b())
 237             else:
 238                 if self.mode == 0 and not full:
 239                     share0s.append(share.hash)
 240                 elif self.mode == 1 or full:
 241                     share1as.append(share.as_share1a())
 242                 else:
 243                     raise ValueError(self.mode)
 244         if share1bs: self.send_share1bs(share1bs=share1bs)
 245         if share0s: self.send_share0s(hashes=share0s)
 246         if share1as: self.send_share1as(share1as=share1as)
 247
 248     def connectionLost(self, reason):
 249         if self.node_var_watch is not None:
 250             self.node.mode_var.changed.unwatch(self.node_var_watch)
 251
 252         if self.connected2:
 253             self.node.lost_conn(self)
 254
 255 class ServerFactory(protocol.ServerFactory):
 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 class ClientFactory(protocol.ClientFactory):
 265     def __init__(self, node):
 266         self.node = node
 267
 268     def buildProtocol(self, addr):
 269         p = Protocol(self.node)
 270         p.factory = self
 271         return p
 272
 273     def startedConnecting(self, connector):
 274         self.node.attempt_started(connector)
 275
 276     def clientConnectionFailed(self, connector, reason):
 277         self.node.attempt_failed(connector)
 278
 279     def clientConnectionLost(self, connector, reason):
 280         self.node.attempt_ended(connector)
 281
 282 addrdb_key = bitcoin_data.ComposedType([
 283     ('address', bitcoin_data.IPV6AddressType()),
 284     ('port', bitcoin_data.StructType('>H')),
 285 ])
 286 addrdb_value = bitcoin_data.ComposedType([
 287     ('services', bitcoin_data.StructType('<Q')),
 288     ('first_seen', bitcoin_data.StructType('<Q')),
 289     ('last_seen', bitcoin_data.StructType('<Q')),
 290 ])
 291
 292 class AddrStore(dicts.DictWrapper):
 293     def encode_key(self, (address, port)):
 294         return addrdb_key.pack(dict(address=address, port=port))
 295     def decode_key(self, encoded_key):
 296         k = addrdb_key.unpack(encoded_key)
 297         return k['address'], k['port']
 298
 299     def encode_value(self, (services, first_seen, last_seen)):
 300         return addrdb_value.pack(dict(services=services, first_seen=first_seen, last_seen=last_seen))
 301     def decode_value(self, encoded_value):
 302         v = addrdb_value.unpack(encoded_value)
 303         return v['services'], v['first_seen'], v['last_seen']
 304
 305 class Node(object):
 306     def __init__(self, current_work, port, net, addr_store=None, preferred_addrs=[], mode=0, desired_peers=10, max_attempts=100):
 307         if addr_store is None:
 308             addr_store = {}
 309
 310         self.port = port
 311         self.net = net
 312         self.addr_store = AddrStore(addr_store)
 313         self.preferred_addrs = preferred_addrs
 314         self.mode_var = variable.Variable(mode)
 315         self.desired_peers = desired_peers
 316         self.max_attempts = max_attempts
 317         self.current_work = current_work
 318
 319         self.nonce = random.randrange(2**64)
 320         self.attempts = {}
 321         self.peers = {}
 322         self.running = False
 323
 324     def start(self):
 325         if self.running:
 326             raise ValueError('already running')
 327
 328         self.running = True
 329
 330         self.listen_port = reactor.listenTCP(self.port, ServerFactory(self))
 331
 332         self._think()
 333         self._think2()
 334
 335     @defer.inlineCallbacks
 336     def _think(self):
 337         while self.running:
 338             try:
 339                 if len(self.peers) < self.desired_peers and len(self.attempts) < self.max_attempts and (len(self.preferred_addrs) or len(self.addr_store)):
 340                     if (random.randrange(2) and len(self.preferred_addrs)) or not len(self.addr_store):
 341                         host, port = random.choice(self.preferred_addrs)
 342                     else:
 343                         host, port = random.choice(self.addr_store.keys())
 344
 345                     if (host, port) not in self.attempts:
 346                         #print 'Trying to connect to', host, port
 347                         reactor.connectTCP(host, port, ClientFactory(self), timeout=10)
 348             except:
 349                 log.err()
 350
 351             yield deferral.sleep(random.expovariate(1/5))
 352
 353     @defer.inlineCallbacks
 354     def _think2(self):
 355         while self.running:
 356             try:
 357                 if len(self.addr_store) < self.preferred_addrs and self.peers:
 358                     random.choice(self.peers.values()).send_getaddrs(count=8)
 359             except:
 360                 log.err()
 361
 362             yield deferral.sleep(random.expovariate(1/20))
 363
 364     def stop(self):
 365         if not self.running:
 366             raise ValueError('already stopped')
 367
 368         self.running = False
 369
 370         self.listen_port.stopListening()
 371
 372
 373     def attempt_started(self, connector):
 374         host, port = connector.getDestination().host, connector.getDestination().port
 375         if (host, port) in self.attempts:
 376             raise ValueError('already have attempt')
 377         self.attempts[host, port] = connector
 378
 379     def attempt_failed(self, connector):
 380         self.attempt_ended(connector)
 381
 382     def attempt_ended(self, connector):
 383         host, port = connector.getDestination().host, connector.getDestination().port
 384         if (host, port) not in self.attempts:
 385             raise ValueError('''don't have attempt''')
 386         if connector is not self.attempts[host, port]:
 387             raise ValueError('wrong connector')
 388         del self.attempts[host, port]
 389
 390
 391     def got_conn(self, conn):
 392         if conn.nonce in self.peers:
 393             raise ValueError('already have peer')
 394         self.peers[conn.nonce] = conn
 395
 396         print 'Connected to peer %s:%i' % (conn.transport.getPeer().host, conn.transport.getPeer().port)
 397
 398     def lost_conn(self, conn):
 399         if conn.nonce not in self.peers:
 400             raise ValueError('''don't have peer''')
 401         if conn is not self.peers[conn.nonce]:
 402             raise ValueError('wrong conn')
 403         del self.peers[conn.nonce]
 404
 405         print 'Lost peer %s:%i' % (conn.transport.getPeer().host, conn.transport.getPeer().port)
 406
 407
 408     def got_addr(self, (host, port), services, timestamp):
 409         if (host, port) in self.addr_store:
 410             old_services, old_first_seen, old_last_seen = self.addr_store[host, port]
 411             self.addr_store[host, port] = services, old_first_seen, max(old_last_seen, timestamp)
 412         else:
 413             self.addr_store[host, port] = services, timestamp, timestamp
 414
 415     def handle_shares(self, shares, peer):
 416         print 'handle_shares', (shares, peer)
 417
 418     def handle_share_hashes(self, hashes, peer):
 419         print 'handle_share_hashes', (hashes, peer)
 420
 421     def handle_get_shares(self, hashes, parents, stops, peer):
 422         print 'handle_get_shares', (hashes, parents, stops, peer)
 423
 424 if __name__ == '__main__':
 425     p = random.randrange(2**15, 2**16)
 426     for i in xrange(5):
 427         p2 = random.randrange(2**15, 2**16)
 428         print p, p2
 429         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())))})
 430         n.start()
 431         p = p2
 432
 433     reactor.run()