server.py

   1 #!/usr/bin/env python
   2 # Copyright(C) 2011 thomasv@gitorious
   3
   4 # This program is free software: you can redistribute it and/or modify
   5 # it under the terms of the GNU Affero General Public License as
   6 # published by the Free Software Foundation, either version 3 of the
   7 # License, or (at your option) any later version.
   8 #
   9 # This program is distributed in the hope that it will be useful, but
  10 # WITHOUT ANY WARRANTY; without even the implied warranty of
  11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12 # Affero General Public License for more details.
  13 #
  14 # You should have received a copy of the GNU Affero General Public
  15 # License along with this program.  If not, see
  16 # <http://www.gnu.org/licenses/agpl.html>.
  17
  18 """
  19 Todo:
  20    * server should check and return bitcoind status..
  21    * improve txpoint sorting
  22    * command to check cache
  23
  24  mempool transactions do not need to be added to the database; it slows it down
  25 """
  26
  27
  28 import time, socket, operator, thread, ast, sys,re
  29 import psycopg2, binascii
  30 import bitcoinrpc
  31
  32 from Abe.abe import hash_to_address, decode_check_address
  33 from Abe.DataStore import DataStore as Datastore_class
  34 from Abe import DataStore, readconf, BCDataStream,  deserialize, util, base58
  35
  36 import ConfigParser
  37
  38 config = ConfigParser.ConfigParser()
  39 # set some defaults, which will be overwritten by the config file
  40 config.add_section('server')
  41 config.set('server','banner', 'Welcome to Electrum!')
  42 config.set('server', 'host', 'localhost')
  43 config.set('server', 'port', 50000)
  44 config.set('server', 'password', '')
  45 config.set('server', 'irc', 'yes')
  46 config.set('server', 'cache', 'no')
  47 config.set('server', 'ircname', 'Electrum server')
  48 config.add_section('database')
  49 config.set('database', 'type', 'psycopg2')
  50 config.set('database', 'database', 'abe')
  51
  52 try:
  53     f = open('/etc/electrum.conf','r')
  54     config.readfp(f)
  55     f.close()
  56 except:
  57     print "Could not read electrum.conf. I will use the default values."
  58
  59 stopping = False
  60 block_number = -1
  61 sessions = {}
  62 dblock = thread.allocate_lock()
  63 peer_list = {}
  64
  65 wallets = {} # for ultra-light clients such as bccapi
  66
  67 class MyStore(Datastore_class):
  68
  69     def import_tx(self, tx, is_coinbase):
  70         tx_id = super(MyStore, self).import_tx(tx, is_coinbase)
  71         if config.get('server', 'cache') == 'yes': self.update_tx_cache(tx_id)
  72
  73     def update_tx_cache(self, txid):
  74         inrows = self.get_tx_inputs(txid, False)
  75         for row in inrows:
  76             _hash = store.binout(row[6])
  77             address = hash_to_address(chr(0), _hash)
  78             if self.tx_cache.has_key(address):
  79                 print "cache: invalidating", address
  80                 self.tx_cache.pop(address)
  81         outrows = self.get_tx_outputs(txid, False)
  82         for row in outrows:
  83             _hash = store.binout(row[6])
  84             address = hash_to_address(chr(0), _hash)
  85             if self.tx_cache.has_key(address):
  86                 print "cache: invalidating", address
  87                 self.tx_cache.pop(address)
  88
  89     def safe_sql(self,sql, params=(), lock=True):
  90         try:
  91             if lock: dblock.acquire()
  92             ret = self.selectall(sql,params)
  93             if lock: dblock.release()
  94             return ret
  95         except:
  96             print "sql error", sql
  97             return []
  98
  99     def get_tx_outputs(self, tx_id, lock=True):
 100         return self.safe_sql("""SELECT
 101                 txout.txout_pos,
 102                 txout.txout_scriptPubKey,
 103                 txout.txout_value,
 104                 nexttx.tx_hash,
 105                 nexttx.tx_id,
 106                 txin.txin_pos,
 107                 pubkey.pubkey_hash
 108               FROM txout
 109               LEFT JOIN txin ON (txin.txout_id = txout.txout_id)
 110               LEFT JOIN pubkey ON (pubkey.pubkey_id = txout.pubkey_id)
 111               LEFT JOIN tx nexttx ON (txin.tx_id = nexttx.tx_id)
 112              WHERE txout.tx_id = %d
 113              ORDER BY txout.txout_pos
 114         """%(tx_id), (), lock)
 115
 116     def get_tx_inputs(self, tx_id, lock=True):
 117         return self.safe_sql(""" SELECT
 118                 txin.txin_pos,
 119                 txin.txin_scriptSig,
 120                 txout.txout_value,
 121                 COALESCE(prevtx.tx_hash, u.txout_tx_hash),
 122                 prevtx.tx_id,
 123                 COALESCE(txout.txout_pos, u.txout_pos),
 124                 pubkey.pubkey_hash
 125               FROM txin
 126               LEFT JOIN txout ON (txout.txout_id = txin.txout_id)
 127               LEFT JOIN pubkey ON (pubkey.pubkey_id = txout.pubkey_id)
 128               LEFT JOIN tx prevtx ON (txout.tx_id = prevtx.tx_id)
 129               LEFT JOIN unlinked_txin u ON (u.txin_id = txin.txin_id)
 130              WHERE txin.tx_id = %d
 131              ORDER BY txin.txin_pos
 132              """%(tx_id,), (), lock)
 133
 134     def get_address_out_rows(self, dbhash):
 135         return self.safe_sql(""" SELECT
 136                 b.block_nTime,
 137                 cc.chain_id,
 138                 b.block_height,
 139                 1,
 140                 b.block_hash,
 141                 tx.tx_hash,
 142                 tx.tx_id,
 143                 txin.txin_pos,
 144                 -prevout.txout_value
 145               FROM chain_candidate cc
 146               JOIN block b ON (b.block_id = cc.block_id)
 147               JOIN block_tx ON (block_tx.block_id = b.block_id)
 148               JOIN tx ON (tx.tx_id = block_tx.tx_id)
 149               JOIN txin ON (txin.tx_id = tx.tx_id)
 150               JOIN txout prevout ON (txin.txout_id = prevout.txout_id)
 151               JOIN pubkey ON (pubkey.pubkey_id = prevout.pubkey_id)
 152              WHERE pubkey.pubkey_hash = ?
 153                AND cc.in_longest = 1""", (dbhash,))
 154
 155     def get_address_out_rows_memorypool(self, dbhash):
 156         return self.safe_sql(""" SELECT
 157                 1,
 158                 tx.tx_hash,
 159                 tx.tx_id,
 160                 txin.txin_pos,
 161                 -prevout.txout_value
 162               FROM tx
 163               JOIN txin ON (txin.tx_id = tx.tx_id)
 164               JOIN txout prevout ON (txin.txout_id = prevout.txout_id)
 165               JOIN pubkey ON (pubkey.pubkey_id = prevout.pubkey_id)
 166              WHERE pubkey.pubkey_hash = ? """, (dbhash,))
 167
 168     def get_address_in_rows(self, dbhash):
 169         return self.safe_sql(""" SELECT
 170                 b.block_nTime,
 171                 cc.chain_id,
 172                 b.block_height,
 173                 0,
 174                 b.block_hash,
 175                 tx.tx_hash,
 176                 tx.tx_id,
 177                 txout.txout_pos,
 178                 txout.txout_value
 179               FROM chain_candidate cc
 180               JOIN block b ON (b.block_id = cc.block_id)
 181               JOIN block_tx ON (block_tx.block_id = b.block_id)
 182               JOIN tx ON (tx.tx_id = block_tx.tx_id)
 183               JOIN txout ON (txout.tx_id = tx.tx_id)
 184               JOIN pubkey ON (pubkey.pubkey_id = txout.pubkey_id)
 185              WHERE pubkey.pubkey_hash = ?
 186                AND cc.in_longest = 1""", (dbhash,))
 187
 188     def get_address_in_rows_memorypool(self, dbhash):
 189         return self.safe_sql( """ SELECT
 190                 0,
 191                 tx.tx_hash,
 192                 tx.tx_id,
 193                 txout.txout_pos,
 194                 txout.txout_value
 195               FROM tx
 196               JOIN txout ON (txout.tx_id = tx.tx_id)
 197               JOIN pubkey ON (pubkey.pubkey_id = txout.pubkey_id)
 198              WHERE pubkey.pubkey_hash = ? """, (dbhash,))
 199
 200     def get_history(self, addr):
 201
 202         if config.get('server','cache') == 'yes':
 203             cached_version = self.tx_cache.get( addr )
 204             if cached_version is not None:
 205                 return cached_version
 206
 207         version, binaddr = decode_check_address(addr)
 208         if binaddr is None:
 209             return None
 210
 211         dbhash = self.binin(binaddr)
 212         rows = []
 213         rows += self.get_address_out_rows( dbhash )
 214         rows += self.get_address_in_rows( dbhash )
 215
 216         txpoints = []
 217         known_tx = []
 218
 219         for row in rows:
 220             try:
 221                 nTime, chain_id, height, is_in, blk_hash, tx_hash, tx_id, pos, value = row
 222             except:
 223                 print "cannot unpack row", row
 224                 break
 225             tx_hash = self.hashout_hex(tx_hash)
 226             txpoint = {
 227                     "nTime":    int(nTime),
 228                     #"chain_id": int(chain_id),
 229                     "height":   int(height),
 230                     "is_in":    int(is_in),
 231                     "blk_hash": self.hashout_hex(blk_hash),
 232                     "tx_hash":  tx_hash,
 233                     "tx_id":    int(tx_id),
 234                     "pos":      int(pos),
 235                     "value":    int(value),
 236                     }
 237
 238             txpoints.append(txpoint)
 239             known_tx.append(self.hashout_hex(tx_hash))
 240
 241
 242         # todo: sort them really...
 243         txpoints = sorted(txpoints, key=operator.itemgetter("nTime"))
 244
 245         # read memory pool
 246         rows = []
 247         rows += self.get_address_in_rows_memorypool( dbhash )
 248         rows += self.get_address_out_rows_memorypool( dbhash )
 249         address_has_mempool = False
 250
 251         for row in rows:
 252             is_in, tx_hash, tx_id, pos, value = row
 253             tx_hash = self.hashout_hex(tx_hash)
 254             if tx_hash in known_tx:
 255                 continue
 256
 257             # this means that pending transactions were added to the db, even if they are not returned by getmemorypool
 258             address_has_mempool = True
 259
 260             # this means pending transactions are returned by getmemorypool
 261             if tx_hash not in self.mempool_keys:
 262                 continue
 263
 264             #print "mempool", tx_hash
 265             txpoint = {
 266                     "nTime":    0,
 267                     #"chain_id": 1,
 268                     "height":   0,
 269                     "is_in":    int(is_in),
 270                     "blk_hash": 'mempool',
 271                     "tx_hash":  tx_hash,
 272                     "tx_id":    int(tx_id),
 273                     "pos":      int(pos),
 274                     "value":    int(value),
 275                     }
 276             txpoints.append(txpoint)
 277
 278
 279         for txpoint in txpoints:
 280             tx_id = txpoint['tx_id']
 281
 282             txinputs = []
 283             inrows = self.get_tx_inputs(tx_id)
 284             for row in inrows:
 285                 _hash = self.binout(row[6])
 286                 address = hash_to_address(chr(0), _hash)
 287                 txinputs.append(address)
 288             txpoint['inputs'] = txinputs
 289             txoutputs = []
 290             outrows = self.get_tx_outputs(tx_id)
 291             for row in outrows:
 292                 _hash = self.binout(row[6])
 293                 address = hash_to_address(chr(0), _hash)
 294                 txoutputs.append(address)
 295             txpoint['outputs'] = txoutputs
 296
 297             # for all unspent inputs, I want their scriptpubkey. (actually I could deduce it from the address)
 298             if not txpoint['is_in']:
 299                 # detect if already redeemed...
 300                 for row in outrows:
 301                     if row[6] == dbhash: break
 302                 else:
 303                     raise
 304                 #row = self.get_tx_output(tx_id,dbhash)
 305                 # pos, script, value, o_hash, o_id, o_pos, binaddr = row
 306                 # if not redeemed, we add the script
 307                 if row:
 308                     if not row[4]: txpoint['raw_scriptPubKey'] = row[1]
 309
 310         # cache result
 311         if config.get('server','cache') == 'yes' and not address_has_mempool:
 312             self.tx_cache[addr] = txpoints
 313
 314         return txpoints
 315
 316
 317
 318 def send_tx(tx):
 319     import bitcoinrpc
 320     conn = bitcoinrpc.connect_to_local()
 321     try:
 322         v = conn.importtransaction(tx)
 323     except:
 324         v = "error: transaction rejected by memorypool"
 325     return v
 326
 327
 328 def listen_thread(store):
 329     s = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
 330     s.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
 331     s.bind((config.get('server','host'), config.getint('server','port')))
 332     s.listen(1)
 333     while not stopping:
 334         conn, addr = s.accept()
 335         thread.start_new_thread(client_thread, (addr, conn,))
 336
 337 def random_string(N):
 338     import random, string
 339     return ''.join(random.choice(string.ascii_uppercase + string.digits) for x in range(N))
 340
 341 def client_thread(ipaddr,conn):
 342     #print "client thread", ipaddr
 343     try:
 344         ipaddr = ipaddr[0]
 345         msg = ''
 346         while 1:
 347             d = conn.recv(1024)
 348             msg += d
 349             if not d:
 350                 break
 351             if '#' in msg:
 352                 msg = msg.split('#', 1)[0]
 353                 break
 354         try:
 355             cmd, data = ast.literal_eval(msg)
 356         except:
 357             print "syntax error", repr(msg), ipaddr
 358             conn.close()
 359             return
 360
 361         if cmd=='b':
 362             out = "%d"%block_number
 363
 364         elif cmd in ['session','new_session']:
 365             session_id = random_string(10)
 366             try:
 367                 if cmd == 'session':
 368                     addresses = ast.literal_eval(data)
 369                     version = "old"
 370                 else:
 371                     version, addresses = ast.literal_eval(data)
 372                     if version[0]=="0": version = "v" + version
 373             except:
 374                 print "error", data
 375                 conn.close()
 376                 return
 377
 378             print time.strftime("[%d/%m/%Y-%H:%M:%S]"), "new session", ipaddr, addresses[0] if addresses else addresses, len(addresses), version
 379
 380             sessions[session_id] = { 'addresses':{}, 'version':version, 'ip':ipaddr }
 381             for a in addresses:
 382                 sessions[session_id]['addresses'][a] = ''
 383             out = repr( (session_id, config.get('server','banner').replace('\\n','\n') ) )
 384             sessions[session_id]['last_time'] = time.time()
 385
 386         elif cmd=='update_session':
 387             try:
 388                 session_id, addresses = ast.literal_eval(data)
 389             except:
 390                 print "error"
 391                 conn.close()
 392                 return
 393
 394             print time.strftime("[%d/%m/%Y-%H:%M:%S]"), "update session", ipaddr, addresses[0] if addresses else addresses, len(addresses)
 395
 396             sessions[session_id]['addresses'] = {}
 397             for a in addresses:
 398                 sessions[session_id]['addresses'][a] = ''
 399             out = 'ok'
 400             sessions[session_id]['last_time'] = time.time()
 401
 402         elif cmd == 'bccapi_login':
 403             import electrum
 404             print "data",data
 405             v, k = ast.literal_eval(data)
 406             master_public_key = k.decode('hex') # todo: sanitize. no need to decode twice...
 407             print master_public_key
 408             wallet_id = random_string(10)
 409             w = electrum.Wallet()
 410             w.master_public_key = master_public_key.decode('hex')
 411             w.synchronize()
 412             wallets[wallet_id] = w
 413             out = wallet_id
 414             print "wallets", wallets
 415
 416         elif cmd == 'bccapi_getAccountInfo':
 417             import electrum
 418             v, wallet_id = ast.literal_eval(data)
 419             w = wallets.get(wallet_id)
 420             if w is not None:
 421                 num = len(w.addresses)
 422                 c, u = w.get_balance()
 423                 out = electrum.int_to_hex(num,4) + electrum.int_to_hex(c,8) + electrum.int_to_hex( c+u, 8 )
 424                 out = out.decode('hex')
 425             else:
 426                 print "error",data
 427                 out = "error"
 428
 429         elif cmd=='poll':
 430             session_id = data
 431             session = sessions.get(session_id)
 432             if session is None:
 433                 print time.asctime(), "session not found", session_id, ipaddr
 434                 out = repr( (-1, {}))
 435             else:
 436                 t1 = time.time()
 437                 addresses = session['addresses']
 438                 session['last_time'] = time.time()
 439                 ret = {}
 440                 k = 0
 441                 for addr in addresses:
 442                     if store.tx_cache.get( addr ) is not None: k += 1
 443
 444                     # get addtess status, i.e. the last block for that address.
 445                     tx_points = store.get_history(addr)
 446                     if not tx_points:
 447                         status = None
 448                     else:
 449                         lastpoint = tx_points[-1]
 450                         status = lastpoint['blk_hash']
 451                         # this is a temporary hack; move it up once old clients have disappeared
 452                         if status == 'mempool' and session['version'] != "old":
 453                             status = status + ':%d'% len(tx_points)
 454
 455                     last_status = addresses.get( addr )
 456                     if last_status != status:
 457                         addresses[addr] = status
 458                         ret[addr] = status
 459                 if ret:
 460                     sessions[session_id]['addresses'] = addresses
 461                 out = repr( (block_number, ret ) )
 462                 t2 = time.time() - t1
 463                 if t2 > 10:
 464                     print "high load:", session_id, "%d/%d"%(k,len(addresses)), t2
 465
 466         elif cmd == 'h':
 467             # history
 468             address = data
 469             out = repr( store.get_history( address ) )
 470
 471         elif cmd == 'load':
 472             if config.get('server','password') == data:
 473                 out = repr( len(sessions) )
 474             else:
 475                 out = 'wrong password'
 476
 477         elif cmd =='tx':
 478             out = send_tx(data)
 479             print "sent tx:", out
 480
 481         elif cmd =='clear_cache':
 482             if config.get('server','password') == data:
 483                 store.tx_cache = {}
 484                 out = 'ok'
 485             else:
 486                 out = 'wrong password'
 487
 488         elif cmd =='get_cache':
 489             try:
 490                 pw, addr = data
 491             except:
 492                 addr = None
 493             if addr:
 494                 if config.get('server','password') == pw:
 495                     out = store.tx_cache.get(addr)
 496                     out = repr(out)
 497                 else:
 498                     out = 'wrong password'
 499             else:
 500                 out = "error: "+ repr(data)
 501
 502         elif cmd == 'stop':
 503             global stopping
 504             if config.get('server','password') == data:
 505                 stopping = True
 506                 out = 'ok'
 507             else:
 508                 out = 'wrong password'
 509
 510         elif cmd == 'peers':
 511             out = repr(peer_list.values())
 512
 513         else:
 514             out = None
 515
 516         if out:
 517             #print ipaddr, cmd, len(out)
 518             try:
 519                 conn.send(out)
 520             except:
 521                 print "error, could not send"
 522
 523     finally:
 524         conn.close()
 525
 526
 527
 528
 529
 530
 531 def memorypool_update(store):
 532     ds = BCDataStream.BCDataStream()
 533     store.mempool_keys = []
 534     conn = bitcoinrpc.connect_to_local()
 535     try:
 536         v = conn.getmemorypool()
 537     except:
 538         print "cannot contact bitcoin daemon"
 539         return
 540     v = v['transactions']
 541     for hextx in v:
 542         ds.clear()
 543         ds.write(hextx.decode('hex'))
 544         tx = deserialize.parse_Transaction(ds)
 545         tx['hash'] = util.double_sha256(tx['tx'])
 546         tx_hash = tx['hash'][::-1].encode('hex')
 547         store.mempool_keys.append(tx_hash)
 548         if store.tx_find_id_and_value(tx):
 549             pass
 550         else:
 551             store.import_tx(tx, False)
 552
 553     store.commit()
 554
 555
 556
 557 def clean_session_thread():
 558     while not stopping:
 559         time.sleep(30)
 560         t = time.time()
 561         for k,s in sessions.items():
 562             t0 = s['last_time']
 563             if t - t0 > 5*60:
 564                 print time.strftime("[%d/%m/%Y-%H:%M:%S]"), "end session", s['ip']
 565                 sessions.pop(k)
 566
 567
 568 def irc_thread():
 569     global peer_list
 570     NICK = 'E_'+random_string(10)
 571     while not stopping:
 572         try:
 573             s = socket.socket()
 574             s.connect(('irc.freenode.net', 6667))
 575             s.send('USER electrum 0 * :'+config.get('server','host')+' '+config.get('server','ircname')+'\n')
 576             s.send('NICK '+NICK+'\n')
 577             s.send('JOIN #electrum\n')
 578             sf = s.makefile('r', 0)
 579             t = 0
 580             while not stopping:
 581                 line = sf.readline()
 582                 line = line.rstrip('\r\n')
 583                 line = line.split()
 584                 if line[0]=='PING':
 585                     s.send('PONG '+line[1]+'\n')
 586                 elif '353' in line: # answer to /names
 587                     k = line.index('353')
 588                     for item in line[k+1:]:
 589                         if item[0:2] == 'E_':
 590                             s.send('WHO %s\n'%item)
 591                 elif '352' in line: # answer to /who
 592                     # warning: this is a horrible hack which apparently works
 593                     k = line.index('352')
 594                     ip = line[k+4]
 595                     ip = socket.gethostbyname(ip)
 596                     name = line[k+6]
 597                     host = line[k+9]
 598                     peer_list[name] = (ip,host)
 599                 if time.time() - t > 5*60:
 600                     s.send('NAMES #electrum\n')
 601                     t = time.time()
 602                     peer_list = {}
 603         except:
 604             traceback.print_exc(file=sys.stdout)
 605         finally:
 606             sf.close()
 607             s.close()
 608
 609
 610 import traceback
 611
 612
 613 if __name__ == '__main__':
 614
 615     if len(sys.argv)>1:
 616         cmd = sys.argv[1]
 617         pw = config.get('server','password')
 618         if cmd == 'load':
 619             request = "('load','%s')#"%pw
 620         elif cmd == 'peers':
 621             request = "('peers','')#"
 622         elif cmd == 'stop':
 623             request = "('stop','%s')#"%pw
 624         elif cmd == 'clear_cache':
 625             request = "('clear_cache','%s')#"%pw
 626         elif cmd == 'get_cache':
 627             request = "('get_cache',('%s','%s'))#"%(pw,sys.argv[2])
 628         elif cmd == 'h':
 629             request = "('h','%s')#"%sys.argv[2]
 630         elif cmd == 'b':
 631             request = "('b','')#"
 632
 633         s = socket.socket( socket.AF_INET, socket.SOCK_STREAM)
 634         s.connect((config.get('server','host'), config.getint('server','port')))
 635         s.send( request )
 636         out = ''
 637         while 1:
 638             msg = s.recv(1024)
 639             if msg: out += msg
 640             else: break
 641         s.close()
 642         print out
 643         sys.exit(0)
 644
 645
 646     print "starting Electrum server"
 647     print "cache:", config.get('server', 'cache')
 648
 649     conf = DataStore.CONFIG_DEFAULTS
 650     args, argv = readconf.parse_argv( [], conf)
 651     args.dbtype= config.get('database','type')
 652     if args.dbtype == 'sqlite3':
 653         args.connect_args = { 'database' : config.get('database','database') }
 654     elif args.dbtype == 'MySQLdb':
 655         args.connect_args = { 'db' : config.get('database','database'), 'user' : config.get('database','username'), 'passwd' : config.get('database','password') }
 656     elif args.dbtype == 'psycopg2':
 657         args.connect_args = { 'database' : config.get('database','database') }
 658     store = MyStore(args)
 659     store.tx_cache = {}
 660     store.mempool_keys = {}
 661
 662     thread.start_new_thread(listen_thread, (store,))
 663     thread.start_new_thread(clean_session_thread, ())
 664     if (config.get('server','irc') == 'yes' ):
 665         thread.start_new_thread(irc_thread, ())
 666
 667     while not stopping:
 668         try:
 669             dblock.acquire()
 670             store.catch_up()
 671             memorypool_update(store)
 672             block_number = store.get_block_number(1)
 673             dblock.release()
 674         except:
 675             traceback.print_exc(file=sys.stdout)
 676         time.sleep(10)
 677
 678     print "server stopped"
 679