lib/wallet.py

   1 #!/usr/bin/env python
   2 #
   3 # Electrum - lightweight Bitcoin client
   4 # Copyright (C) 2011 thomasv@gitorious
   5 #
   6 # This program is free software: you can redistribute it and/or modify
   7 # it under the terms of the GNU General Public License as published by
   8 # the Free Software Foundation, either version 3 of the License, or
   9 # (at your option) any later version.
  10 #
  11 # This program is distributed in the hope that it will be useful,
  12 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  14 # GNU General Public License for more details.
  15 #
  16 # You should have received a copy of the GNU General Public License
  17 # along with this program. If not, see <http://www.gnu.org/licenses/>.
  18
  19 import sys
  20 import os
  21 import hashlib
  22 import ast
  23 import threading
  24 import random
  25 import time
  26 import math
  27
  28 from util import print_msg, print_error
  29
  30 from bitcoin import *
  31 from account import *
  32 from version import *
  33
  34 from transaction import Transaction
  35 from plugins import run_hook
  36 import bitcoin
  37 from synchronizer import WalletSynchronizer
  38
  39 COINBASE_MATURITY = 100
  40 DUST_THRESHOLD = 5430
  41
  42 # internal ID for imported account
  43 IMPORTED_ACCOUNT = '/x'
  44
  45
  46 class WalletStorage(object):
  47
  48     def __init__(self, config):
  49         self.lock = threading.RLock()
  50         self.config = config
  51         self.data = {}
  52         self.file_exists = False
  53         self.path = self.init_path(config)
  54         print_error( "wallet path", self.path )
  55         if self.path:
  56             self.read(self.path)
  57
  58     def init_path(self, config):
  59         """Set the path of the wallet."""
  60
  61         # command line -w option
  62         path = config.get('wallet_path')
  63         if path:
  64             return path
  65
  66         # path in config file
  67         path = config.get('default_wallet_path')
  68         if path:
  69             return path
  70
  71         # default path
  72         dirpath = os.path.join(config.path, "wallets")
  73         if not os.path.exists(dirpath):
  74             os.mkdir(dirpath)
  75
  76         new_path = os.path.join(config.path, "wallets", "default_wallet")
  77
  78         # default path in pre 1.9 versions
  79         old_path = os.path.join(config.path, "electrum.dat")
  80         if os.path.exists(old_path) and not os.path.exists(new_path):
  81             os.rename(old_path, new_path)
  82
  83         return new_path
  84
  85     def read(self, path):
  86         """Read the contents of the wallet file."""
  87         try:
  88             with open(self.path, "r") as f:
  89                 data = f.read()
  90         except IOError:
  91             return
  92         try:
  93             d = ast.literal_eval( data )  #parse raw data from reading wallet file
  94         except Exception:
  95             raise IOError("Cannot read wallet file.")
  96
  97         self.data = d
  98         self.file_exists = True
  99
 100     def get(self, key, default=None):
 101
 102         with self.lock:
 103             v = self.data.get(key)
 104             if v is None:
 105                 v = default
 106             return v
 107
 108     def put(self, key, value, save = True):
 109
 110         with self.lock:
 111             if value is not None:
 112                 self.data[key] = value
 113             elif key in self.data:
 114                 self.data.pop(key)
 115             if save:
 116                 self.write()
 117
 118     def write(self):
 119         s = repr(self.data)
 120         f = open(self.path,"w")
 121         f.write( s )
 122         f.close()
 123         if 'ANDROID_DATA' not in os.environ:
 124             import stat
 125             os.chmod(self.path,stat.S_IREAD | stat.S_IWRITE)
 126
 127
 128 class Abstract_Wallet(object):
 129     """
 130     Wallet classes are created to handle various address generation methods.
 131     Completion states (watching-only, single account, no seed, etc) are handled inside classes.
 132     """
 133     def __init__(self, storage):
 134         self.storage = storage
 135         self.electrum_version = ELECTRUM_VERSION
 136         self.gap_limit_for_change = 3 # constant
 137         # saved fields
 138         self.seed_version          = storage.get('seed_version', NEW_SEED_VERSION)
 139         self.gap_limit             = storage.get('gap_limit', 5)
 140         self.use_change            = storage.get('use_change',True)
 141         self.use_encryption        = storage.get('use_encryption', False)
 142         self.seed                  = storage.get('seed', '')               # encrypted
 143         self.labels                = storage.get('labels', {})
 144         self.frozen_addresses      = storage.get('frozen_addresses',[])
 145         self.addressbook           = storage.get('contacts', [])
 146
 147         self.history               = storage.get('addr_history',{})        # address -> list(txid, height)
 148
 149         self.fee                   = int(storage.get('fee_per_kb', 10000))
 150
 151         self.next_addresses = storage.get('next_addresses',{})
 152
 153         # This attribute is set when wallet.start_threads is called.
 154         self.synchronizer = None
 155
 156         # imported_keys is deprecated. The GUI should call convert_imported_keys
 157         self.imported_keys = self.storage.get('imported_keys',{})
 158
 159         self.load_accounts()
 160
 161         self.load_transactions()
 162
 163         # not saved
 164         self.prevout_values = {}     # my own transaction outputs
 165         self.spent_outputs = []
 166         # spv
 167         self.verifier = None
 168         # there is a difference between wallet.up_to_date and interface.is_up_to_date()
 169         # interface.is_up_to_date() returns true when all requests have been answered and processed
 170         # wallet.up_to_date is true when the wallet is synchronized (stronger requirement)
 171         self.up_to_date = False
 172         self.lock = threading.Lock()
 173         self.transaction_lock = threading.Lock()
 174         self.tx_event = threading.Event()
 175         for tx_hash, tx in self.transactions.items():
 176             self.update_tx_outputs(tx_hash)
 177
 178     def load_transactions(self):
 179         self.transactions = {}
 180         tx_list = self.storage.get('transactions',{})
 181         for k, raw in tx_list.items():
 182             try:
 183                 tx = Transaction.deserialize(raw)
 184             except Exception:
 185                 print_msg("Warning: Cannot deserialize transactions. skipping")
 186                 continue
 187             self.add_pubkey_addresses(tx)
 188             self.transactions[k] = tx
 189         for h,tx in self.transactions.items():
 190             if not self.check_new_tx(h, tx):
 191                 print_error("removing unreferenced tx", h)
 192                 self.transactions.pop(h)
 193
 194     def add_pubkey_addresses(self, tx):
 195         # find the address corresponding to pay-to-pubkey inputs
 196         h = tx.hash()
 197
 198         # inputs
 199         tx.add_pubkey_addresses(self.transactions)
 200
 201         # outputs of tx: inputs of tx2
 202         for type, x, v in tx.outputs:
 203             if type == 'pubkey':
 204                 for tx2 in self.transactions.values():
 205                     tx2.add_pubkey_addresses({h:tx})
 206
 207     def get_action(self):
 208         pass
 209
 210     def convert_imported_keys(self, password):
 211         for k, v in self.imported_keys.items():
 212             sec = pw_decode(v, password)
 213             pubkey = public_key_from_private_key(sec)
 214             address = public_key_to_bc_address(pubkey.decode('hex'))
 215             assert address == k
 216             self.import_key(sec, password)
 217             self.imported_keys.pop(k)
 218         self.storage.put('imported_keys', self.imported_keys)
 219
 220     def load_accounts(self):
 221         self.accounts = {}
 222
 223         d = self.storage.get('accounts', {})
 224         for k, v in d.items():
 225             if k == 0:
 226                 v['mpk'] = self.storage.get('master_public_key')
 227                 self.accounts[k] = OldAccount(v)
 228             elif v.get('imported'):
 229                 self.accounts[k] = ImportedAccount(v)
 230             elif v.get('xpub3'):
 231                 self.accounts[k] = BIP32_Account_2of3(v)
 232             elif v.get('xpub2'):
 233                 self.accounts[k] = BIP32_Account_2of2(v)
 234             elif v.get('xpub'):
 235                 self.accounts[k] = BIP32_Account(v)
 236             elif v.get('pending'):
 237                 self.accounts[k] = PendingAccount(v)
 238             else:
 239                 print_error("cannot load account", v)
 240
 241     def synchronize(self):
 242         pass
 243
 244     def can_create_accounts(self):
 245         return False
 246
 247     def set_up_to_date(self,b):
 248         with self.lock: self.up_to_date = b
 249
 250     def is_up_to_date(self):
 251         with self.lock: return self.up_to_date
 252
 253     def update(self):
 254         self.up_to_date = False
 255         while not self.is_up_to_date():
 256             time.sleep(0.1)
 257
 258     def is_imported(self, addr):
 259         account = self.accounts.get(IMPORTED_ACCOUNT)
 260         if account:
 261             return addr in account.get_addresses(0)
 262         else:
 263             return False
 264
 265     def has_imported_keys(self):
 266         account = self.accounts.get(IMPORTED_ACCOUNT)
 267         return account is not None
 268
 269     def import_key(self, sec, password):
 270         try:
 271             pubkey = public_key_from_private_key(sec)
 272             address = public_key_to_bc_address(pubkey.decode('hex'))
 273         except Exception:
 274             raise Exception('Invalid private key')
 275
 276         if self.is_mine(address):
 277             raise Exception('Address already in wallet')
 278
 279         if self.accounts.get(IMPORTED_ACCOUNT) is None:
 280             self.accounts[IMPORTED_ACCOUNT] = ImportedAccount({'imported':{}})
 281         self.accounts[IMPORTED_ACCOUNT].add(address, pubkey, sec, password)
 282         self.save_accounts()
 283
 284         if self.synchronizer:
 285             self.synchronizer.subscribe_to_addresses([address])
 286         return address
 287
 288     def delete_imported_key(self, addr):
 289         account = self.accounts[IMPORTED_ACCOUNT]
 290         account.remove(addr)
 291         if not account.get_addresses(0):
 292             self.accounts.pop(IMPORTED_ACCOUNT)
 293         self.save_accounts()
 294
 295     def set_label(self, name, text = None):
 296         changed = False
 297         old_text = self.labels.get(name)
 298         if text:
 299             if old_text != text:
 300                 self.labels[name] = text
 301                 changed = True
 302         else:
 303             if old_text:
 304                 self.labels.pop(name)
 305                 changed = True
 306
 307         if changed:
 308             self.storage.put('labels', self.labels, True)
 309
 310         run_hook('set_label', name, text, changed)
 311         return changed
 312
 313     def addresses(self, include_change = True, _next=True):
 314         o = []
 315         for a in self.accounts.keys():
 316             o += self.get_account_addresses(a, include_change)
 317
 318         if _next:
 319             for addr in self.next_addresses.values():
 320                 if addr not in o:
 321                     o += [addr]
 322         return o
 323
 324     def is_mine(self, address):
 325         return address in self.addresses(True)
 326
 327     def is_change(self, address):
 328         if not self.is_mine(address): return False
 329         acct, s = self.get_address_index(address)
 330         if s is None: return False
 331         return s[0] == 1
 332
 333     def get_address_index(self, address):
 334         for account in self.accounts.keys():
 335             for for_change in [0,1]:
 336                 addresses = self.accounts[account].get_addresses(for_change)
 337                 for addr in addresses:
 338                     if address == addr:
 339                         return account, (for_change, addresses.index(addr))
 340
 341         for k,v in self.next_addresses.items():
 342             if v == address:
 343                 return k, (0,0)
 344
 345         raise Exception("Address not found", address)
 346
 347     def get_private_key(self, address, password):
 348         if self.is_watching_only():
 349             return []
 350         account_id, sequence = self.get_address_index(address)
 351         return self.accounts[account_id].get_private_key(sequence, self, password)
 352
 353     def get_public_keys(self, address):
 354         account_id, sequence = self.get_address_index(address)
 355         return self.accounts[account_id].get_pubkeys(*sequence)
 356
 357     def add_keypairs(self, tx, keypairs, password):
 358         # first check the provided password. This will raise if invalid.
 359         self.check_password(password)
 360
 361         addr_list, xpub_list = tx.inputs_to_sign()
 362         for addr in addr_list:
 363             if self.is_mine(addr):
 364                 private_keys = self.get_private_key(addr, password)
 365                 for sec in private_keys:
 366                     pubkey = public_key_from_private_key(sec)
 367                     keypairs[ pubkey ] = sec
 368
 369         for xpub, sequence in xpub_list:
 370             # look for account that can sign
 371             for k, account in self.accounts.items():
 372                 if xpub in account.get_master_pubkeys():
 373                     break
 374             else:
 375                 continue
 376             pk = account.get_private_key(sequence, self, password)
 377             for sec in pk:
 378                 pubkey = public_key_from_private_key(sec)
 379                 keypairs[pubkey] = sec
 380
 381     def signrawtransaction(self, tx, private_keys, password):
 382         # check that the password is correct. This will raise if it's not.
 383         self.check_password(password)
 384         # build a list of public/private keys
 385         keypairs = {}
 386         # add private keys from parameter
 387         for sec in private_keys:
 388             pubkey = public_key_from_private_key(sec)
 389             keypairs[ pubkey ] = sec
 390         # add private_keys
 391         self.add_keypairs(tx, keypairs, password)
 392         # sign the transaction
 393         self.sign_transaction(tx, keypairs, password)
 394
 395     def sign_message(self, address, message, password):
 396         keys = self.get_private_key(address, password)
 397         assert len(keys) == 1
 398         sec = keys[0]
 399         key = regenerate_key(sec)
 400         compressed = is_compressed(sec)
 401         return key.sign_message(message, compressed, address)
 402
 403     def decrypt_message(self, pubkey, message, password):
 404         address = public_key_to_bc_address(pubkey.decode('hex'))
 405         keys = self.get_private_key(address, password)
 406         secret = keys[0]
 407         ec = regenerate_key(secret)
 408         decrypted = ec.decrypt_message(message)
 409         return decrypted
 410
 411     def is_found(self):
 412         return self.history.values() != [[]] * len(self.history)
 413
 414     def add_contact(self, address, label=None):
 415         self.addressbook.append(address)
 416         self.storage.put('contacts', self.addressbook, True)
 417         if label:
 418             self.set_label(address, label)
 419
 420     def delete_contact(self, addr):
 421         if addr in self.addressbook:
 422             self.addressbook.remove(addr)
 423             self.storage.put('addressbook', self.addressbook, True)
 424
 425     def fill_addressbook(self):
 426         for tx_hash, tx in self.transactions.items():
 427             is_relevant, is_send, _, _ = self.get_tx_value(tx)
 428             if is_send:
 429                 for addr in tx.get_output_addresses():
 430                     if not self.is_mine(addr) and addr not in self.addressbook:
 431                         self.addressbook.append(addr)
 432         # redo labels
 433         # self.update_tx_labels()
 434
 435     def get_num_tx(self, address):
 436         n = 0
 437         for tx in self.transactions.values():
 438             if address in tx.get_output_addresses(): n += 1
 439         return n
 440
 441     def get_tx_value(self, tx, account=None):
 442         domain = self.get_account_addresses(account)
 443         return tx.get_value(domain, self.prevout_values)
 444
 445     def update_tx_outputs(self, tx_hash):
 446         tx = self.transactions.get(tx_hash)
 447
 448         for i, (addr, value) in enumerate(tx.get_outputs()):
 449             key = tx_hash+ ':%d'%i
 450             self.prevout_values[key] = value
 451
 452         for item in tx.inputs:
 453             if self.is_mine(item.get('address')):
 454                 key = item['prevout_hash'] + ':%d'%item['prevout_n']
 455                 self.spent_outputs.append(key)
 456
 457     def get_addr_balance(self, address):
 458         #assert self.is_mine(address)
 459         h = self.history.get(address,[])
 460         if h == ['*']: return 0,0
 461         c = u = 0
 462         received_coins = []   # list of coins received at address
 463
 464         for tx_hash, tx_height in h:
 465             tx = self.transactions.get(tx_hash)
 466             if not tx: continue
 467
 468             for i, (addr, value) in enumerate(tx.get_outputs()):
 469                 if addr == address:
 470                     key = tx_hash + ':%d'%i
 471                     received_coins.append(key)
 472
 473         for tx_hash, tx_height in h:
 474             tx = self.transactions.get(tx_hash)
 475             if not tx: continue
 476             v = 0
 477
 478             for item in tx.inputs:
 479                 addr = item.get('address')
 480                 if addr == address:
 481                     key = item['prevout_hash']  + ':%d'%item['prevout_n']
 482                     value = self.prevout_values.get( key )
 483                     if key in received_coins:
 484                         v -= value
 485
 486             for i, (addr, value) in enumerate(tx.get_outputs()):
 487                 key = tx_hash + ':%d'%i
 488                 if addr == address:
 489                     v += value
 490
 491             if tx_height:
 492                 c += v
 493             else:
 494                 u += v
 495         return c, u
 496
 497     def get_account_name(self, k):
 498         return self.labels.get(k, self.accounts[k].get_name(k))
 499
 500     def get_account_names(self):
 501         account_names = {}
 502         for k in self.accounts.keys():
 503             account_names[k] = self.get_account_name(k)
 504         return account_names
 505
 506     def get_account_addresses(self, a, include_change=True):
 507         if a is None:
 508             o = self.addresses(include_change)
 509         elif a in self.accounts:
 510             ac = self.accounts[a]
 511             o = ac.get_addresses(0)
 512             if include_change: o += ac.get_addresses(1)
 513         return o
 514
 515     def get_account_balance(self, account):
 516         return self.get_balance(self.get_account_addresses(account))
 517
 518     def get_frozen_balance(self):
 519         return self.get_balance(self.frozen_addresses)
 520
 521     def get_balance(self, domain=None):
 522         if domain is None: domain = self.addresses(True)
 523         cc = uu = 0
 524         for addr in domain:
 525             c, u = self.get_addr_balance(addr)
 526             cc += c
 527             uu += u
 528         return cc, uu
 529
 530     def get_unspent_coins(self, domain=None):
 531         coins = []
 532         if domain is None: domain = self.addresses(True)
 533         for addr in domain:
 534             h = self.history.get(addr, [])
 535             if h == ['*']: continue
 536             for tx_hash, tx_height in h:
 537                 tx = self.transactions.get(tx_hash)
 538                 if tx is None: raise Exception("Wallet not synchronized")
 539                 is_coinbase = tx.inputs[0].get('prevout_hash') == '0'*64
 540                 for i, (address, value) in enumerate(tx.get_outputs()):
 541                     output = {'address':address, 'value':value, 'prevout_n':i}
 542                     if address != addr: continue
 543                     key = tx_hash + ":%d"%i
 544                     if key in self.spent_outputs: continue
 545                     output['prevout_hash'] = tx_hash
 546                     output['height'] = tx_height
 547                     output['coinbase'] = is_coinbase
 548                     coins.append((tx_height, output))
 549
 550         # sort by age
 551         if coins:
 552             coins = sorted(coins)
 553             if coins[-1][0] != 0:
 554                 while coins[0][0] == 0:
 555                     coins = coins[1:] + [ coins[0] ]
 556         return [x[1] for x in coins]
 557
 558     def choose_tx_inputs( self, amount, fixed_fee, num_outputs, domain = None, coins = None ):
 559         """ todo: minimize tx size """
 560         total = 0
 561         fee = self.fee if fixed_fee is None else fixed_fee
 562
 563         if not coins:
 564             if domain is None:
 565                 domain = self.addresses(True)
 566             for i in self.frozen_addresses:
 567                 if i in domain: domain.remove(i)
 568             coins = self.get_unspent_coins(domain)
 569
 570         inputs = []
 571
 572         for item in coins:
 573             if item.get('coinbase') and item.get('height') + COINBASE_MATURITY > self.network.get_local_height():
 574                 continue
 575             v = item.get('value')
 576             total += v
 577             inputs.append(item)
 578             fee = self.estimated_fee(inputs, num_outputs) if fixed_fee is None else fixed_fee
 579             if total >= amount + fee: break
 580         else:
 581             inputs = []
 582
 583         return inputs, total, fee
 584
 585     def set_fee(self, fee):
 586         if self.fee != fee:
 587             self.fee = fee
 588             self.storage.put('fee_per_kb', self.fee, True)
 589
 590     def estimated_fee(self, inputs, num_outputs):
 591         estimated_size =  len(inputs) * 180 + num_outputs * 34    # this assumes non-compressed keys
 592         fee = self.fee * int(math.ceil(estimated_size/1000.))
 593         return fee
 594
 595     def add_tx_change( self, inputs, outputs, amount, fee, total, change_addr=None):
 596         "add change to a transaction"
 597         change_amount = total - ( amount + fee )
 598         if change_amount > DUST_THRESHOLD:
 599             if not change_addr:
 600
 601                 # send change to one of the accounts involved in the tx
 602                 address = inputs[0].get('address')
 603                 account, _ = self.get_address_index(address)
 604
 605                 if not self.use_change or account == IMPORTED_ACCOUNT:
 606                     change_addr = inputs[-1]['address']
 607                 else:
 608                     change_addr = self.accounts[account].get_addresses(1)[-self.gap_limit_for_change]
 609
 610             # Insert the change output at a random position in the outputs
 611             posn = random.randint(0, len(outputs))
 612             outputs[posn:posn] = [( 'address', change_addr,  change_amount)]
 613         return outputs
 614
 615     def get_history(self, address):
 616         with self.lock:
 617             return self.history.get(address)
 618
 619     def get_status(self, h):
 620         if not h: return None
 621         if h == ['*']: return '*'
 622         status = ''
 623         for tx_hash, height in h:
 624             status += tx_hash + ':%d:' % height
 625         return hashlib.sha256( status ).digest().encode('hex')
 626
 627     def receive_tx_callback(self, tx_hash, tx, tx_height):
 628
 629         with self.transaction_lock:
 630             self.add_pubkey_addresses(tx)
 631             if not self.check_new_tx(tx_hash, tx):
 632                 # may happen due to pruning
 633                 print_error("received transaction that is no longer referenced in history", tx_hash)
 634                 return
 635             self.transactions[tx_hash] = tx
 636             self.network.pending_transactions_for_notifications.append(tx)
 637             self.save_transactions()
 638             if self.verifier and tx_height>0:
 639                 self.verifier.add(tx_hash, tx_height)
 640             self.update_tx_outputs(tx_hash)
 641
 642     def save_transactions(self):
 643         tx = {}
 644         for k,v in self.transactions.items():
 645             tx[k] = str(v)
 646         self.storage.put('transactions', tx, True)
 647
 648     def receive_history_callback(self, addr, hist):
 649
 650         if not self.check_new_history(addr, hist):
 651             raise Exception("error: received history for %s is not consistent with known transactions"%addr)
 652
 653         with self.lock:
 654             self.history[addr] = hist
 655             self.storage.put('addr_history', self.history, True)
 656
 657         if hist != ['*']:
 658             for tx_hash, tx_height in hist:
 659                 if tx_height>0:
 660                     # add it in case it was previously unconfirmed
 661                     if self.verifier: self.verifier.add(tx_hash, tx_height)
 662
 663     def get_tx_history(self, account=None):
 664         if not self.verifier:
 665             return []
 666
 667         with self.transaction_lock:
 668             history = self.transactions.items()
 669             history.sort(key = lambda x: self.verifier.get_txpos(x[0]))
 670             result = []
 671
 672             balance = 0
 673             for tx_hash, tx in history:
 674                 is_relevant, is_mine, v, fee = self.get_tx_value(tx, account)
 675                 if v is not None: balance += v
 676
 677             c, u = self.get_account_balance(account)
 678
 679             if balance != c+u:
 680                 result.append( ('', 1000, 0, c+u-balance, None, c+u-balance, None ) )
 681
 682             balance = c + u - balance
 683             for tx_hash, tx in history:
 684                 is_relevant, is_mine, value, fee = self.get_tx_value(tx, account)
 685                 if not is_relevant:
 686                     continue
 687                 if value is not None:
 688                     balance += value
 689
 690                 conf, timestamp = self.verifier.get_confirmations(tx_hash) if self.verifier else (None, None)
 691                 result.append( (tx_hash, conf, is_mine, value, fee, balance, timestamp) )
 692
 693         return result
 694
 695     def get_label(self, tx_hash):
 696         label = self.labels.get(tx_hash)
 697         is_default = (label == '') or (label is None)
 698         if is_default: label = self.get_default_label(tx_hash)
 699         return label, is_default
 700
 701     def get_default_label(self, tx_hash):
 702         tx = self.transactions.get(tx_hash)
 703         default_label = ''
 704         if tx:
 705             is_relevant, is_mine, _, _ = self.get_tx_value(tx)
 706             if is_mine:
 707                 for o_addr in tx.get_output_addresses():
 708                     if not self.is_mine(o_addr):
 709                         try:
 710                             default_label = self.labels[o_addr]
 711                         except KeyError:
 712                             default_label = '>' + o_addr
 713                         break
 714                 else:
 715                     default_label = '(internal)'
 716             else:
 717                 for o_addr in tx.get_output_addresses():
 718                     if self.is_mine(o_addr) and not self.is_change(o_addr):
 719                         break
 720                 else:
 721                     for o_addr in tx.get_output_addresses():
 722                         if self.is_mine(o_addr):
 723                             break
 724                     else:
 725                         o_addr = None
 726
 727                 if o_addr:
 728                     try:
 729                         default_label = self.labels[o_addr]
 730                     except KeyError:
 731                         default_label = '<' + o_addr
 732
 733         return default_label
 734
 735     def make_unsigned_transaction(self, outputs, fee=None, change_addr=None, domain=None, coins=None ):
 736         for type, address, x in outputs:
 737             if type == 'op_return':
 738                 continue
 739             if type == 'address':
 740                 assert is_address(address), "Address " + address + " is invalid!"
 741         amount = sum( map(lambda x:x[2], outputs) )
 742         inputs, total, fee = self.choose_tx_inputs( amount, fee, len(outputs), domain, coins )
 743         if not inputs:
 744             raise ValueError("Not enough funds")
 745         for txin in inputs:
 746             self.add_input_info(txin)
 747         outputs = self.add_tx_change(inputs, outputs, amount, fee, total, change_addr)
 748         return Transaction(inputs, outputs)
 749
 750     def mktx(self, outputs, password, fee=None, change_addr=None, domain= None, coins = None ):
 751         tx = self.make_unsigned_transaction(outputs, fee, change_addr, domain, coins)
 752         keypairs = {}
 753         self.add_keypairs(tx, keypairs, password)
 754         if keypairs:
 755             self.sign_transaction(tx, keypairs, password)
 756         return tx
 757
 758     def add_input_info(self, txin):
 759         address = txin['address']
 760         account_id, sequence = self.get_address_index(address)
 761         account = self.accounts[account_id]
 762         redeemScript = account.redeem_script(*sequence)
 763         pubkeys = account.get_pubkeys(*sequence)
 764         x_pubkeys = account.get_xpubkeys(*sequence)
 765         # sort pubkeys and x_pubkeys, using the order of pubkeys
 766         pubkeys, x_pubkeys = zip( *sorted(zip(pubkeys, x_pubkeys)))
 767         txin['pubkeys'] = list(pubkeys)
 768         txin['x_pubkeys'] = list(x_pubkeys)
 769         txin['signatures'] = [None] * len(pubkeys)
 770
 771         if redeemScript:
 772             txin['redeemScript'] = redeemScript
 773             txin['num_sig'] = 2
 774         else:
 775             txin['redeemPubkey'] = account.get_pubkey(*sequence)
 776             txin['num_sig'] = 1
 777
 778     def sign_transaction(self, tx, keypairs, password):
 779         tx.sign(keypairs)
 780         run_hook('sign_transaction', tx, password)
 781
 782     def sendtx(self, tx):
 783         # synchronous
 784         h = self.send_tx(tx)
 785         self.tx_event.wait()
 786         return self.receive_tx(h, tx)
 787
 788     def send_tx(self, tx):
 789         # asynchronous
 790         self.tx_event.clear()
 791         self.network.send([('blockchain.transaction.broadcast', [str(tx)])], self.on_broadcast)
 792         return tx.hash()
 793
 794     def on_broadcast(self, i, r):
 795         self.tx_result = r.get('result')
 796         self.tx_event.set()
 797
 798     def receive_tx(self, tx_hash, tx):
 799         out = self.tx_result
 800         if out != tx_hash:
 801             return False, "error: " + out
 802         run_hook('receive_tx', tx, self)
 803         return True, out
 804
 805     def update_password(self, old_password, new_password):
 806         if new_password == '':
 807             new_password = None
 808
 809         if self.has_seed():
 810             decoded = self.get_seed(old_password)
 811             self.seed = pw_encode( decoded, new_password)
 812             self.storage.put('seed', self.seed, True)
 813
 814         imported_account = self.accounts.get(IMPORTED_ACCOUNT)
 815         if imported_account:
 816             imported_account.update_password(old_password, new_password)
 817             self.save_accounts()
 818
 819         if hasattr(self, 'master_private_keys'):
 820             for k, v in self.master_private_keys.items():
 821                 b = pw_decode(v, old_password)
 822                 c = pw_encode(b, new_password)
 823                 self.master_private_keys[k] = c
 824             self.storage.put('master_private_keys', self.master_private_keys, True)
 825
 826         self.use_encryption = (new_password != None)
 827         self.storage.put('use_encryption', self.use_encryption,True)
 828
 829     def freeze(self,addr):
 830         if self.is_mine(addr) and addr not in self.frozen_addresses:
 831             self.frozen_addresses.append(addr)
 832             self.storage.put('frozen_addresses', self.frozen_addresses, True)
 833             return True
 834         else:
 835             return False
 836
 837     def unfreeze(self,addr):
 838         if self.is_mine(addr) and addr in self.frozen_addresses:
 839             self.frozen_addresses.remove(addr)
 840             self.storage.put('frozen_addresses', self.frozen_addresses, True)
 841             return True
 842         else:
 843             return False
 844
 845     def set_verifier(self, verifier):
 846         self.verifier = verifier
 847
 848         # review transactions that are in the history
 849         for addr, hist in self.history.items():
 850             if hist == ['*']: continue
 851             for tx_hash, tx_height in hist:
 852                 if tx_height>0:
 853                     # add it in case it was previously unconfirmed
 854                     self.verifier.add(tx_hash, tx_height)
 855
 856         # if we are on a pruning server, remove unverified transactions
 857         vr = self.verifier.transactions.keys() + self.verifier.verified_tx.keys()
 858         for tx_hash in self.transactions.keys():
 859             if tx_hash not in vr:
 860                 self.transactions.pop(tx_hash)
 861
 862     def check_new_history(self, addr, hist):
 863         # check that all tx in hist are relevant
 864         if hist != ['*']:
 865             for tx_hash, height in hist:
 866                 tx = self.transactions.get(tx_hash)
 867                 if not tx: continue
 868                 if not tx.has_address(addr):
 869                     return False
 870
 871         # check that we are not "orphaning" a transaction
 872         old_hist = self.history.get(addr,[])
 873         if old_hist == ['*']: return True
 874
 875         for tx_hash, height in old_hist:
 876             if tx_hash in map(lambda x:x[0], hist): continue
 877             found = False
 878             for _addr, _hist in self.history.items():
 879                 if _addr == addr: continue
 880                 if _hist == ['*']: continue
 881                 _tx_hist = map(lambda x:x[0], _hist)
 882                 if tx_hash in _tx_hist:
 883                     found = True
 884                     break
 885
 886             if not found:
 887                 tx = self.transactions.get(tx_hash)
 888                 # tx might not be there
 889                 if not tx: continue
 890
 891                 # already verified?
 892                 if self.verifier.get_height(tx_hash):
 893                     continue
 894                 # unconfirmed tx
 895                 print_error("new history is orphaning transaction:", tx_hash)
 896                 # check that all outputs are not mine, request histories
 897                 ext_requests = []
 898                 for _addr in tx.get_output_addresses():
 899                     # assert not self.is_mine(_addr)
 900                     ext_requests.append( ('blockchain.address.get_history', [_addr]) )
 901
 902                 ext_h = self.network.synchronous_get(ext_requests)
 903                 print_error("sync:", ext_requests, ext_h)
 904                 height = None
 905                 for h in ext_h:
 906                     if h == ['*']: continue
 907                     for item in h:
 908                         if item.get('tx_hash') == tx_hash:
 909                             height = item.get('height')
 910                 if height:
 911                     print_error("found height for", tx_hash, height)
 912                     self.verifier.add(tx_hash, height)
 913                 else:
 914                     print_error("removing orphaned tx from history", tx_hash)
 915                     self.transactions.pop(tx_hash)
 916
 917         return True
 918
 919     def check_new_tx(self, tx_hash, tx):
 920         # 1 check that tx is referenced in addr_history.
 921         addresses = []
 922         for addr, hist in self.history.items():
 923             if hist == ['*']:continue
 924             for txh, height in hist:
 925                 if txh == tx_hash:
 926                     addresses.append(addr)
 927
 928         if not addresses:
 929             return False
 930
 931         # 2 check that referencing addresses are in the tx
 932         for addr in addresses:
 933             if not tx.has_address(addr):
 934                 return False
 935
 936         return True
 937
 938     def start_threads(self, network):
 939         from verifier import TxVerifier
 940         self.network = network
 941         if self.network is not None:
 942             self.verifier = TxVerifier(self.network, self.storage)
 943             self.verifier.start()
 944             self.set_verifier(self.verifier)
 945             self.synchronizer = WalletSynchronizer(self, network)
 946             self.synchronizer.start()
 947         else:
 948             self.verifier = None
 949             self.synchronizer =None
 950
 951     def stop_threads(self):
 952         if self.network:
 953             self.verifier.stop()
 954             self.synchronizer.stop()
 955
 956     def restore(self, cb):
 957         pass
 958
 959     def get_accounts(self):
 960         return self.accounts
 961
 962     def save_accounts(self):
 963         d = {}
 964         for k, v in self.accounts.items():
 965             d[k] = v.dump()
 966         self.storage.put('accounts', d, True)
 967
 968     def can_import(self):
 969         return not self.is_watching_only()
 970
 971     def is_used(self, address):
 972         h = self.history.get(address,[])
 973         c, u = self.get_addr_balance(address)
 974         return len(h), len(h) > 0 and c == -u
 975
 976     def address_is_old(self, address, age_limit=2):
 977         age = -1
 978         h = self.history.get(address, [])
 979         if h == ['*']:
 980             return True
 981         for tx_hash, tx_height in h:
 982             if tx_height == 0:
 983                 tx_age = 0
 984             else:
 985                 tx_age = self.network.get_local_height() - tx_height + 1
 986             if tx_age > age:
 987                 age = tx_age
 988         return age > age_limit
 989
 990
 991 class Imported_Wallet(Abstract_Wallet):
 992
 993     def __init__(self, storage):
 994         Abstract_Wallet.__init__(self, storage)
 995         a = self.accounts.get(IMPORTED_ACCOUNT)
 996         if not a:
 997             self.accounts[IMPORTED_ACCOUNT] = ImportedAccount({'imported':{}})
 998         self.storage.put('wallet_type', 'imported', True)
 999
1000     def is_watching_only(self):
1001         acc = self.accounts[IMPORTED_ACCOUNT]
1002         n = acc.keypairs.values()
1003         return n == [(None, None)] * len(n)
1004
1005     def has_seed(self):
1006         return False
1007
1008     def is_deterministic(self):
1009         return False
1010
1011     def check_password(self, password):
1012         self.accounts[IMPORTED_ACCOUNT].get_private_key((0,0), self, password)
1013
1014     def is_used(self, address):
1015         h = self.history.get(address,[])
1016         return len(h), False
1017
1018     def get_master_public_keys(self):
1019         return {}
1020
1021     def is_beyond_limit(self, address, account, is_change):
1022         return False
1023
1024
1025 class Deterministic_Wallet(Abstract_Wallet):
1026
1027     def __init__(self, storage):
1028         Abstract_Wallet.__init__(self, storage)
1029
1030     def has_seed(self):
1031         return self.seed != ''
1032
1033     def is_deterministic(self):
1034         return True
1035
1036     def is_watching_only(self):
1037         return not self.has_seed()
1038
1039     def add_seed(self, seed, password):
1040         if self.seed:
1041             raise Exception("a seed exists")
1042
1043         self.seed_version, self.seed = self.prepare_seed(seed)
1044         if password:
1045             self.seed = pw_encode( self.seed, password)
1046             self.use_encryption = True
1047         else:
1048             self.use_encryption = False
1049
1050         self.storage.put('seed', self.seed, True)
1051         self.storage.put('seed_version', self.seed_version, True)
1052         self.storage.put('use_encryption', self.use_encryption,True)
1053         self.create_master_keys(password)
1054
1055     def get_seed(self, password):
1056         return pw_decode(self.seed, password)
1057
1058     def get_mnemonic(self, password):
1059         return self.get_seed(password)
1060
1061     def change_gap_limit(self, value):
1062         if value >= self.gap_limit:
1063             self.gap_limit = value
1064             self.storage.put('gap_limit', self.gap_limit, True)
1065             #self.interface.poke('synchronizer')
1066             return True
1067
1068         elif value >= self.min_acceptable_gap():
1069             for key, account in self.accounts.items():
1070                 addresses = account[0]
1071                 k = self.num_unused_trailing_addresses(addresses)
1072                 n = len(addresses) - k + value
1073                 addresses = addresses[0:n]
1074                 self.accounts[key][0] = addresses
1075
1076             self.gap_limit = value
1077             self.storage.put('gap_limit', self.gap_limit, True)
1078             self.save_accounts()
1079             return True
1080         else:
1081             return False
1082
1083     def num_unused_trailing_addresses(self, addresses):
1084         k = 0
1085         for a in addresses[::-1]:
1086             if self.history.get(a):break
1087             k = k + 1
1088         return k
1089
1090     def min_acceptable_gap(self):
1091         # fixme: this assumes wallet is synchronized
1092         n = 0
1093         nmax = 0
1094
1095         for account in self.accounts.values():
1096             addresses = account.get_addresses(0)
1097             k = self.num_unused_trailing_addresses(addresses)
1098             for a in addresses[0:-k]:
1099                 if self.history.get(a):
1100                     n = 0
1101                 else:
1102                     n += 1
1103                     if n > nmax: nmax = n
1104         return nmax + 1
1105
1106     def create_new_address(self, account=None, for_change=0):
1107         if account is None:
1108             account = self.default_account()
1109         address = account.create_new_address(for_change)
1110         self.history[address] = []
1111         if self.synchronizer:
1112             self.synchronizer.add(address)
1113         self.save_accounts()
1114         return address
1115
1116     def synchronize_sequence(self, account, for_change):
1117         limit = self.gap_limit_for_change if for_change else self.gap_limit
1118         while True:
1119             addresses = account.get_addresses(for_change)
1120             if len(addresses) < limit:
1121                 self.create_new_address(account, for_change)
1122                 continue
1123             if map( lambda a: self.address_is_old(a), addresses[-limit:] ) == limit*[False]:
1124                 break
1125             else:
1126                 self.create_new_address(account, for_change)
1127
1128     def check_pending_accounts(self):
1129         for account_id, addr in self.next_addresses.items():
1130             if self.address_is_old(addr):
1131                 print_error( "creating account", account_id )
1132                 xpub = self.master_public_keys[account_id]
1133                 account = BIP32_Account({'xpub':xpub})
1134                 self.add_account(account_id, account)
1135                 self.next_addresses.pop(account_id)
1136
1137     def synchronize_account(self, account):
1138         self.synchronize_sequence(account, 0)
1139         self.synchronize_sequence(account, 1)
1140
1141     def synchronize(self):
1142         self.check_pending_accounts()
1143         for account in self.accounts.values():
1144             if type(account) in [ImportedAccount, PendingAccount]:
1145                 continue
1146             self.synchronize_account(account)
1147
1148     def restore(self, callback):
1149         from i18n import _
1150         def wait_for_wallet():
1151             self.set_up_to_date(False)
1152             while not self.is_up_to_date():
1153                 msg = "%s\n%s %d\n%s %.1f"%(
1154                     _("Please wait..."),
1155                     _("Addresses generated:"),
1156                     len(self.addresses(True)),
1157                     _("Kilobytes received:"),
1158                     self.network.interface.bytes_received/1024.)
1159
1160                 apply(callback, (msg,))
1161                 time.sleep(0.1)
1162
1163         def wait_for_network():
1164             while not self.network.is_connected():
1165                 msg = "%s \n" % (_("Connecting..."))
1166                 apply(callback, (msg,))
1167                 time.sleep(0.1)
1168
1169         # wait until we are connected, because the user might have selected another server
1170         if self.network:
1171             wait_for_network()
1172             wait_for_wallet()
1173         else:
1174             self.synchronize()
1175         self.fill_addressbook()
1176
1177     def create_account(self, name, password):
1178         i = self.num_accounts()
1179         account_id = self.account_id(i)
1180         account = self.make_account(account_id, password)
1181         self.add_account(account_id, account)
1182         if name:
1183             self.set_label(account_id, name)
1184
1185         # add address of the next account
1186         _, _ = self.next_account_address(password)
1187
1188
1189     def add_account(self, account_id, account):
1190         self.accounts[account_id] = account
1191         self.save_accounts()
1192
1193     def account_is_pending(self, k):
1194         return type(self.accounts.get(k)) == PendingAccount
1195
1196     def delete_pending_account(self, k):
1197         assert self.account_is_pending(k)
1198         self.accounts.pop(k)
1199         self.save_accounts()
1200
1201     def create_pending_account(self, name, password):
1202         account_id, addr = self.next_account_address(password)
1203         self.set_label(account_id, name)
1204         self.accounts[account_id] = PendingAccount({'pending':addr})
1205         self.save_accounts()
1206
1207     def is_beyond_limit(self, address, account, is_change):
1208         if type(account) == ImportedAccount:
1209             return False
1210         addr_list = account.get_addresses(is_change)
1211         i = addr_list.index(address)
1212         prev_addresses = addr_list[:max(0, i)]
1213         limit = self.gap_limit_for_change if is_change else self.gap_limit
1214         if len(prev_addresses) < limit:
1215             return False
1216         prev_addresses = prev_addresses[max(0, i - limit):]
1217         for addr in prev_addresses:
1218             if self.history.get(addr):
1219                 return False
1220         return True
1221
1222     def get_action(self):
1223         if not self.get_master_public_key():
1224             return 'create_seed'
1225         if not self.accounts:
1226             return 'create_accounts'
1227
1228
1229 class NewWallet(Deterministic_Wallet):
1230
1231     def __init__(self, storage):
1232         Deterministic_Wallet.__init__(self, storage)
1233         self.master_public_keys  = storage.get('master_public_keys', {})
1234         self.master_private_keys = storage.get('master_private_keys', {})
1235
1236     def default_account(self):
1237         return self.accounts["m/0'"]
1238
1239     def is_watching_only(self):
1240         return not bool(self.master_private_keys)
1241
1242     def can_create_accounts(self):
1243         return 'm/' in self.master_private_keys.keys()
1244
1245     def get_master_public_key(self):
1246         """xpub of the main account"""
1247         return self.master_public_keys.get("m/0'")
1248
1249     def get_master_public_keys(self):
1250         out = {}
1251         for k, account in self.accounts.items():
1252             name = self.get_account_name(k)
1253             mpk_text = '\n\n'.join( account.get_master_pubkeys() )
1254             out[name] = mpk_text
1255         return out
1256
1257     def get_master_private_key(self, account, password):
1258         k = self.master_private_keys.get(account)
1259         if not k: return
1260         xpriv = pw_decode( k, password)
1261         return xpriv
1262
1263     def check_password(self, password):
1264         xpriv = self.get_master_private_key( "m/", password )
1265         xpub = self.master_public_keys["m/"]
1266         assert deserialize_xkey(xpriv)[3] == deserialize_xkey(xpub)[3]
1267
1268     def create_xprv_wallet(self, xprv, password):
1269         xpub = bitcoin.xpub_from_xprv(xprv)
1270         account = BIP32_Account({'xpub':xpub})
1271         account_id = 'm/' + bitcoin.get_xkey_name(xpub)
1272         self.storage.put('seed_version', self.seed_version, True)
1273         self.add_master_private_key(account_id, xprv, password)
1274         self.add_master_public_key(account_id, xpub)
1275         self.add_account(account_id, account)
1276
1277     def create_watching_only_wallet(self, xpub):
1278         account = BIP32_Account({'xpub':xpub})
1279         account_id = 'm/' + bitcoin.get_xkey_name(xpub)
1280         self.storage.put('seed_version', self.seed_version, True)
1281         self.add_master_public_key(account_id, xpub)
1282         self.add_account(account_id, account)
1283
1284     def create_accounts(self, password):
1285         # First check the password is valid (this raises if it isn't).
1286         if not self.is_watching_only():
1287             self.check_password(password)
1288         self.create_account('Main account', password)
1289
1290     def add_master_public_key(self, name, xpub):
1291         self.master_public_keys[name] = xpub
1292         self.storage.put('master_public_keys', self.master_public_keys, True)
1293
1294     def add_master_private_key(self, name, xpriv, password):
1295         self.master_private_keys[name] = pw_encode(xpriv, password)
1296         self.storage.put('master_private_keys', self.master_private_keys, True)
1297
1298     def add_master_keys(self, root, account_id, password):
1299         x = self.master_private_keys.get(root)
1300         if x:
1301             master_xpriv = pw_decode(x, password )
1302             xpriv, xpub = bip32_private_derivation(master_xpriv, root, account_id)
1303             self.add_master_public_key(account_id, xpub)
1304             self.add_master_private_key(account_id, xpriv, password)
1305         else:
1306             master_xpub = self.master_public_keys[root]
1307             xpub = bip32_public_derivation(master_xpub, root, account_id)
1308             self.add_master_public_key(account_id, xpub)
1309         return xpub
1310
1311     def create_master_keys(self, password):
1312         xpriv, xpub = bip32_root(mnemonic_to_seed(self.get_seed(password),'').encode('hex'))
1313         self.add_master_public_key("m/", xpub)
1314         self.add_master_private_key("m/", xpriv, password)
1315
1316     def can_sign(self, tx):
1317         if self.is_watching_only():
1318             return False
1319         if tx.is_complete():
1320             return False
1321         addr_list, xpub_list = tx.inputs_to_sign()
1322         for addr in addr_list:
1323             if self.is_mine(addr):
1324                 return True
1325         mpk = [ self.master_public_keys[k] for k in self.master_private_keys.keys() ]
1326         for xpub, sequence in xpub_list:
1327             if xpub in mpk:
1328                 return True
1329         return False
1330
1331     def num_accounts(self):
1332         keys = []
1333         for k, v in self.accounts.items():
1334             if type(v) != BIP32_Account:
1335                 continue
1336             keys.append(k)
1337
1338         i = 0
1339         while True:
1340             account_id = self.account_id(i)
1341             if account_id not in keys: break
1342             i += 1
1343         return i
1344
1345     def next_account_address(self, password):
1346         i = self.num_accounts()
1347         account_id = self.account_id(i)
1348
1349         addr = self.next_addresses.get(account_id)
1350         if not addr:
1351             account = self.make_account(account_id, password)
1352             addr = account.first_address()
1353             self.next_addresses[account_id] = addr
1354             self.storage.put('next_addresses', self.next_addresses)
1355
1356         return account_id, addr
1357
1358     def account_id(self, i):
1359         return "m/%d'"%i
1360
1361     def make_account(self, account_id, password):
1362         """Creates and saves the master keys, but does not save the account"""
1363         xpub = self.add_master_keys("m/", account_id, password)
1364         account = BIP32_Account({'xpub':xpub})
1365         return account
1366
1367     def make_seed(self):
1368         import mnemonic, ecdsa
1369         entropy = ecdsa.util.randrange( pow(2,160) )
1370         nonce = 0
1371         while True:
1372             ss = "%040x"%(entropy+nonce)
1373             s = hashlib.sha256(ss.decode('hex')).digest().encode('hex')
1374             # we keep only 13 words, that's approximately 139 bits of entropy
1375             words = mnemonic.mn_encode(s)[0:13]
1376             seed = ' '.join(words)
1377             if is_new_seed(seed):
1378                 break  # this will remove 8 bits of entropy
1379             nonce += 1
1380         return seed
1381
1382     def prepare_seed(self, seed):
1383         import unicodedata
1384         return NEW_SEED_VERSION, unicodedata.normalize('NFC', unicode(seed.strip()))
1385
1386
1387 class Wallet_2of2(NewWallet):
1388     """ This class is used for multisignature addresses"""
1389
1390     def __init__(self, storage):
1391         NewWallet.__init__(self, storage)
1392         self.storage.put('wallet_type', '2of2', True)
1393
1394     def default_account(self):
1395         return self.accounts['m/']
1396
1397     def can_create_accounts(self):
1398         return False
1399
1400     def can_import(self):
1401         return False
1402
1403     def create_account(self, name, password):
1404         xpub1 = self.master_public_keys.get("m/")
1405         xpub2 = self.master_public_keys.get("cold/")
1406         account = BIP32_Account_2of2({'xpub':xpub1, 'xpub2':xpub2})
1407         self.add_account('m/', account)
1408
1409     def get_master_public_keys(self):
1410         xpub1 = self.master_public_keys.get("m/")
1411         xpub2 = self.master_public_keys.get("cold/")
1412         return {'hot':xpub1, 'cold':xpub2}
1413
1414     def get_action(self):
1415         xpub1 = self.master_public_keys.get("m/")
1416         xpub2 = self.master_public_keys.get("cold/")
1417         if xpub1 is None:
1418             return 'create_seed'
1419         if xpub2 is None:
1420             return 'add_cosigner'
1421         if not self.accounts:
1422             return 'create_accounts'
1423
1424
1425 class Wallet_2of3(Wallet_2of2):
1426     """ This class is used for multisignature addresses"""
1427
1428     def __init__(self, storage):
1429         Wallet_2of2.__init__(self, storage)
1430         self.storage.put('wallet_type', '2of3', True)
1431
1432     def create_account(self, name, password):
1433         xpub1 = self.master_public_keys.get("m/")
1434         xpub2 = self.master_public_keys.get("cold/")
1435         xpub3 = self.master_public_keys.get("remote/")
1436         account = BIP32_Account_2of3({'xpub':xpub1, 'xpub2':xpub2, 'xpub3':xpub3})
1437         self.add_account('m/', account)
1438
1439     def get_master_public_keys(self):
1440         xpub1 = self.master_public_keys.get("m/")
1441         xpub2 = self.master_public_keys.get("cold/")
1442         xpub3 = self.master_public_keys.get("remote/")
1443         return {'hot':xpub1, 'cold':xpub2, 'remote':xpub3}
1444
1445     def get_action(self):
1446         xpub1 = self.master_public_keys.get("m/")
1447         xpub2 = self.master_public_keys.get("cold/")
1448         xpub3 = self.master_public_keys.get("remote/")
1449         if xpub1 is None:
1450             return 'create_seed'
1451         if xpub2 is None or xpub3 is None:
1452             return 'add_two_cosigners'
1453         if not self.accounts:
1454             return 'create_accounts'
1455
1456
1457 class OldWallet(Deterministic_Wallet):
1458
1459     def default_account(self):
1460         return self.accounts[0]
1461
1462     def make_seed(self):
1463         import mnemonic
1464         seed = random_seed(128)
1465         return ' '.join(mnemonic.mn_encode(seed))
1466
1467     def prepare_seed(self, seed):
1468         import mnemonic
1469         # see if seed was entered as hex
1470         seed = seed.strip()
1471         try:
1472             assert seed
1473             seed.decode('hex')
1474             return OLD_SEED_VERSION, str(seed)
1475         except Exception:
1476             pass
1477
1478         words = seed.split()
1479         seed = mnemonic.mn_decode(words)
1480         if not seed:
1481             raise Exception("Invalid seed")
1482
1483         return OLD_SEED_VERSION, seed
1484
1485     def create_master_keys(self, password):
1486         seed = self.get_seed(password)
1487         mpk = OldAccount.mpk_from_seed(seed)
1488         self.storage.put('master_public_key', mpk, True)
1489
1490     def get_master_public_key(self):
1491         return self.storage.get("master_public_key")
1492
1493     def get_master_public_keys(self):
1494         return {'Main Account':self.get_master_public_key()}
1495
1496     def create_accounts(self, password):
1497         mpk = self.storage.get("master_public_key")
1498         self.create_account(mpk)
1499
1500     def create_account(self, mpk):
1501         self.accounts[0] = OldAccount({'mpk':mpk, 0:[], 1:[]})
1502         self.save_accounts()
1503
1504     def create_watching_only_wallet(self, mpk):
1505         self.seed_version = OLD_SEED_VERSION
1506         self.storage.put('seed_version', self.seed_version, True)
1507         self.storage.put('master_public_key', mpk, True)
1508         self.create_account(mpk)
1509
1510     def get_seed(self, password):
1511         seed = pw_decode(self.seed, password).encode('utf8')
1512         return seed
1513
1514     def check_password(self, password):
1515         seed = self.get_seed(password)
1516         self.accounts[0].check_seed(seed)
1517
1518     def get_mnemonic(self, password):
1519         import mnemonic
1520         s = self.get_seed(password)
1521         return ' '.join(mnemonic.mn_encode(s))
1522
1523     def check_pending_accounts(self):
1524         pass
1525
1526     def can_sign(self, tx):
1527         if self.is_watching_only():
1528             return False
1529         if tx.is_complete():
1530             return False
1531         addr_list, xpub_list = tx.inputs_to_sign()
1532         for addr in addr_list:
1533             if self.is_mine(addr):
1534                 return True
1535         for xpub, sequence in xpub_list:
1536             if xpub == self.master_public_key:
1537                 return True
1538         return False
1539
1540 # former WalletFactory
1541 class Wallet(object):
1542     """The main wallet "entry point".
1543     This class is actually a factory that will return a wallet of the correct
1544     type when passed a WalletStorage instance."""
1545
1546     def __new__(self, storage):
1547         config = storage.config
1548
1549         self.wallet_types = [
1550             ('standard', ("Standard wallet"),          NewWallet if config.get('bip32') else OldWallet),
1551             ('imported', ("Imported wallet"),          Imported_Wallet),
1552             ('2of2',     ("Multisig wallet (2 of 2)"), Wallet_2of2),
1553             ('2of3',     ("Multisig wallet (2 of 3)"), Wallet_2of3)
1554         ]
1555         run_hook('add_wallet_types', self.wallet_types)
1556
1557         for t, l, WalletClass in self.wallet_types:
1558             if t == storage.get('wallet_type'):
1559                 return WalletClass(storage)
1560
1561         if not storage.file_exists:
1562             seed_version = NEW_SEED_VERSION if config.get('bip32') is True else OLD_SEED_VERSION
1563         else:
1564             seed_version = storage.get('seed_version')
1565             if not seed_version:
1566                 seed_version = OLD_SEED_VERSION if len(storage.get('master_public_key')) == 128 else NEW_SEED_VERSION
1567
1568         if seed_version == OLD_SEED_VERSION:
1569             return OldWallet(storage)
1570         elif seed_version == NEW_SEED_VERSION:
1571             return NewWallet(storage)
1572         else:
1573             msg = "This wallet seed is not supported."
1574             if seed_version in [5]:
1575                 msg += "\nTo open this wallet, try 'git checkout seed_v%d'"%seed_version
1576             print msg
1577             sys.exit(1)
1578
1579     @classmethod
1580     def is_seed(self, seed):
1581         if not seed:
1582             return False
1583         elif is_old_seed(seed):
1584             return True
1585         elif is_new_seed(seed):
1586             return True
1587         else:
1588             return False
1589
1590     @classmethod
1591     def is_old_mpk(self, mpk):
1592         try:
1593             int(mpk, 16)
1594             assert len(mpk) == 128
1595             return True
1596         except:
1597             return False
1598
1599     @classmethod
1600     def is_xpub(self, text):
1601         try:
1602             assert text[0:4] == 'xpub'
1603             deserialize_xkey(text)
1604             return True
1605         except:
1606             return False
1607
1608     @classmethod
1609     def is_xprv(self, text):
1610         try:
1611             assert text[0:4] == 'xprv'
1612             deserialize_xkey(text)
1613             return True
1614         except:
1615             return False
1616
1617     @classmethod
1618     def is_address(self, text):
1619         if not text:
1620             return False
1621         for x in text.split():
1622             if not bitcoin.is_address(x):
1623                 return False
1624         return True
1625
1626     @classmethod
1627     def is_private_key(self, text):
1628         if not text:
1629             return False
1630         for x in text.split():
1631             if not bitcoin.is_private_key(x):
1632                 return False
1633         return True
1634
1635     @classmethod
1636     def from_seed(self, seed, storage):
1637         if is_old_seed(seed):
1638             klass = OldWallet
1639         elif is_new_seed(seed):
1640             klass = NewWallet
1641         w = klass(storage)
1642         return w
1643
1644     @classmethod
1645     def from_address(self, text, storage):
1646         w = Imported_Wallet(storage)
1647         for x in text.split():
1648             w.accounts[IMPORTED_ACCOUNT].add(x, None, None, None)
1649         w.save_accounts()
1650         return w
1651
1652     @classmethod
1653     def from_private_key(self, text, storage):
1654         w = Imported_Wallet(storage)
1655         for x in text.split():
1656             w.import_key(x, None)
1657         return w
1658
1659     @classmethod
1660     def from_old_mpk(self, mpk, storage):
1661         w = OldWallet(storage)
1662         w.seed = ''
1663         w.create_watching_only_wallet(mpk)
1664         return w
1665
1666     @classmethod
1667     def from_xpub(self, xpub, storage):
1668         w = NewWallet(storage)
1669         w.create_watching_only_wallet(xpub)
1670         return w
1671
1672     @classmethod
1673     def from_xprv(self, xprv, password, storage):
1674         w = NewWallet(storage)
1675         w.create_xprv_wallet(xprv, password)
1676         return w