p2pool/p2p.py

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