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