3 # Electrum - lightweight Bitcoin client
4 # Copyright (C) 2011 thomasv@gitorious
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.
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.
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/>.
34 from util import print_msg, print_error, format_satoshis
37 from transaction import Transaction, is_extended_pubkey
38 from plugins import run_hook
40 from synchronizer import WalletSynchronizer
42 COINBASE_MATURITY = 100
45 # internal ID for imported account
46 IMPORTED_ACCOUNT = '/x'
55 def __init__(self, config):
56 self.lock = threading.Lock()
59 self.file_exists = False
60 self.path = self.init_path(config)
61 print_error( "wallet path", self.path )
66 def init_path(self, config):
67 """Set the path of the wallet."""
69 # command line -w option
70 path = config.get('wallet_path')
75 path = config.get('default_wallet_path')
80 dirpath = os.path.join(config.path, "wallets")
81 if not os.path.exists(dirpath):
84 new_path = os.path.join(config.path, "wallets", "default_wallet")
86 # default path in pre 1.9 versions
87 old_path = os.path.join(config.path, "electrum.dat")
88 if os.path.exists(old_path) and not os.path.exists(new_path):
89 os.rename(old_path, new_path)
95 """Read the contents of the wallet file."""
97 with open(self.path, "r") as f:
102 d = ast.literal_eval( data ) #parse raw data from reading wallet file
104 raise IOError("Cannot read wallet file.")
107 self.file_exists = True
110 def get(self, key, default=None):
111 v = self.data.get(key)
116 def put(self, key, value, save = True):
119 if value is not None:
120 self.data[key] = value
121 elif key in self.data:
128 f = open(self.path,"w")
131 if 'ANDROID_DATA' not in os.environ:
133 os.chmod(self.path,stat.S_IREAD | stat.S_IWRITE)
141 class Abstract_Wallet:
143 def __init__(self, storage):
145 self.storage = storage
146 self.electrum_version = ELECTRUM_VERSION
147 self.gap_limit_for_change = 3 # constant
149 self.seed_version = storage.get('seed_version', NEW_SEED_VERSION)
150 self.gap_limit = storage.get('gap_limit', 5)
151 self.use_change = storage.get('use_change',True)
152 self.use_encryption = storage.get('use_encryption', False)
153 self.seed = storage.get('seed', '') # encrypted
154 self.labels = storage.get('labels', {})
155 self.frozen_addresses = storage.get('frozen_addresses',[])
156 self.addressbook = storage.get('contacts', [])
158 self.history = storage.get('addr_history',{}) # address -> list(txid, height)
160 self.fee = int(storage.get('fee_per_kb', 10000))
162 self.master_public_keys = storage.get('master_public_keys',{})
163 self.master_private_keys = storage.get('master_private_keys', {})
165 self.next_addresses = storage.get('next_addresses',{})
168 # This attribute is set when wallet.start_threads is called.
169 self.synchronizer = None
173 self.transactions = {}
174 tx_list = self.storage.get('transactions',{})
175 for k,v in tx_list.items():
179 print_msg("Warning: Cannot deserialize transactions. skipping")
182 self.add_extra_addresses(tx)
183 self.transactions[k] = tx
185 for h,tx in self.transactions.items():
186 if not self.check_new_tx(h, tx):
187 print_error("removing unreferenced tx", h)
188 self.transactions.pop(h)
192 self.prevout_values = {} # my own transaction outputs
193 self.spent_outputs = []
198 # there is a difference between wallet.up_to_date and interface.is_up_to_date()
199 # interface.is_up_to_date() returns true when all requests have been answered and processed
200 # wallet.up_to_date is true when the wallet is synchronized (stronger requirement)
202 self.up_to_date = False
203 self.lock = threading.Lock()
204 self.transaction_lock = threading.Lock()
205 self.tx_event = threading.Event()
207 for tx_hash, tx in self.transactions.items():
208 self.update_tx_outputs(tx_hash)
211 def add_extra_addresses(self, tx):
213 # find the address corresponding to pay-to-pubkey inputs
214 tx.add_extra_addresses(self.transactions)
215 for o in tx.d.get('outputs'):
216 if o.get('is_pubkey'):
217 for tx2 in self.transactions.values():
218 tx2.add_extra_addresses({h:tx})
221 def get_action(self):
225 def convert_imported_keys(self, password):
226 for k, v in self.imported_keys.items():
227 sec = pw_decode(v, password)
228 pubkey = public_key_from_private_key(sec)
229 address = public_key_to_bc_address(pubkey.decode('hex'))
231 self.import_key(sec, password)
232 self.imported_keys.pop(k)
233 self.storage.put('imported_keys', self.imported_keys)
236 def load_accounts(self):
238 self.imported_keys = self.storage.get('imported_keys',{})
240 d = self.storage.get('accounts', {})
241 for k, v in d.items():
243 v['mpk'] = self.storage.get('master_public_key')
244 self.accounts[k] = OldAccount(v)
245 elif v.get('imported'):
246 self.accounts[k] = ImportedAccount(v)
248 self.accounts[k] = BIP32_Account_2of3(v)
250 self.accounts[k] = BIP32_Account_2of2(v)
252 self.accounts[k] = BIP32_Account(v)
253 elif v.get('pending'):
254 self.accounts[k] = PendingAccount(v)
256 print_error("cannot load account", v)
259 def synchronize(self):
262 def can_create_accounts(self):
265 def set_up_to_date(self,b):
266 with self.lock: self.up_to_date = b
268 def is_up_to_date(self):
269 with self.lock: return self.up_to_date
273 self.up_to_date = False
274 while not self.is_up_to_date():
277 def is_imported(self, addr):
278 account = self.accounts.get(IMPORTED_ACCOUNT)
280 return addr in account.get_addresses(0)
284 def has_imported_keys(self):
285 account = self.accounts.get(IMPORTED_ACCOUNT)
286 return account is not None
288 def import_key(self, sec, password):
290 pubkey = public_key_from_private_key(sec)
291 address = public_key_to_bc_address(pubkey.decode('hex'))
293 raise Exception('Invalid private key')
295 if self.is_mine(address):
296 raise Exception('Address already in wallet')
298 if self.accounts.get(IMPORTED_ACCOUNT) is None:
299 self.accounts[IMPORTED_ACCOUNT] = ImportedAccount({'imported':{}})
300 self.accounts[IMPORTED_ACCOUNT].add(address, pubkey, sec, password)
303 if self.synchronizer:
304 self.synchronizer.subscribe_to_addresses([address])
308 def delete_imported_key(self, addr):
309 account = self.accounts[IMPORTED_ACCOUNT]
311 if not account.get_addresses(0):
312 self.accounts.pop(IMPORTED_ACCOUNT)
316 def set_label(self, name, text = None):
318 old_text = self.labels.get(name)
321 self.labels[name] = text
325 self.labels.pop(name)
329 self.storage.put('labels', self.labels, True)
331 run_hook('set_label', name, text, changed)
337 def addresses(self, include_change = True, _next=True):
339 for a in self.accounts.keys():
340 o += self.get_account_addresses(a, include_change)
343 for addr in self.next_addresses.values():
349 def is_mine(self, address):
350 return address in self.addresses(True)
353 def is_change(self, address):
354 if not self.is_mine(address): return False
355 acct, s = self.get_address_index(address)
356 if s is None: return False
360 def get_address_index(self, address):
362 for account in self.accounts.keys():
363 for for_change in [0,1]:
364 addresses = self.accounts[account].get_addresses(for_change)
365 for addr in addresses:
367 return account, (for_change, addresses.index(addr))
369 for k,v in self.next_addresses.items():
373 raise Exception("Address not found", address)
376 def getpubkeys(self, addr):
377 assert is_valid(addr) and self.is_mine(addr)
378 account, sequence = self.get_address_index(addr)
379 a = self.accounts[account]
380 return a.get_pubkeys( sequence )
383 def get_private_key(self, address, password):
384 if self.is_watching_only():
386 account_id, sequence = self.get_address_index(address)
387 return self.accounts[account_id].get_private_key(sequence, self, password)
390 def get_public_keys(self, address):
391 account_id, sequence = self.get_address_index(address)
392 return self.accounts[account_id].get_pubkeys(sequence)
395 def add_keypairs(self, tx, keypairs, password):
396 # first check the provided password
397 seed = self.get_seed(password)
399 for txin in tx.inputs:
400 x_pubkeys = txin['x_pubkeys']
401 address = txin['address']
403 if self.is_mine(address):
405 private_keys = self.get_private_key(address, password)
406 for sec in private_keys:
407 pubkey = public_key_from_private_key(sec)
408 keypairs[ pubkey ] = sec
412 from account import BIP32_Account, OldAccount
413 for x_pubkey in x_pubkeys:
414 if not is_extended_pubkey(x_pubkey):
417 if x_pubkey[0:2] == 'ff':
418 xpub, sequence = BIP32_Account.parse_xpubkey(x_pubkey)
419 elif x_pubkey[0:2] == 'fe':
420 xpub, sequence = OldAccount.parse_xpubkey(x_pubkey)
422 # look for account that can sign
423 for k, account in self.accounts.items():
424 if xpub in account.get_master_pubkeys():
429 addr = account.get_address(*sequence)
430 assert txin['address'] == addr
431 pk = self.get_private_key(addr, password)
433 pubkey = public_key_from_private_key(sec)
434 keypairs[pubkey] = sec
439 def signrawtransaction(self, tx, private_keys, password):
441 # check that the password is correct
442 seed = self.get_seed(password)
444 # build a list of public/private keys
447 # add private keys from parameter
448 for sec in private_keys:
449 pubkey = public_key_from_private_key(sec)
450 keypairs[ pubkey ] = sec
453 self.add_keypairs(tx, keypairs, password)
455 # sign the transaction
456 self.sign_transaction(tx, keypairs, password)
459 def sign_message(self, address, message, password):
460 keys = self.get_private_key(address, password)
461 assert len(keys) == 1
463 key = regenerate_key(sec)
464 compressed = is_compressed(sec)
465 return key.sign_message(message, compressed, address)
469 def decrypt_message(self, pubkey, message, password):
470 address = public_key_to_bc_address(pubkey.decode('hex'))
471 keys = self.get_private_key(address, password)
473 ec = regenerate_key(secret)
474 decrypted = ec.decrypt_message(message)
480 return self.history.values() != [[]] * len(self.history)
483 def add_contact(self, address, label=None):
484 self.addressbook.append(address)
485 self.storage.put('contacts', self.addressbook, True)
487 self.set_label(address, label)
490 def delete_contact(self, addr):
491 if addr in self.addressbook:
492 self.addressbook.remove(addr)
493 self.storage.put('addressbook', self.addressbook, True)
496 def fill_addressbook(self):
497 for tx_hash, tx in self.transactions.items():
498 is_relevant, is_send, _, _ = self.get_tx_value(tx)
500 for addr, v in tx.outputs:
501 if not self.is_mine(addr) and addr not in self.addressbook:
502 self.addressbook.append(addr)
504 # self.update_tx_labels()
506 def get_num_tx(self, address):
508 for tx in self.transactions.values():
509 if address in map(lambda x:x[0], tx.outputs): n += 1
513 def get_address_flags(self, addr):
514 flags = "C" if self.is_change(addr) else "I" if addr in self.imported_keys.keys() else "-"
515 flags += "F" if addr in self.frozen_addresses else "-"
519 def get_tx_value(self, tx, account=None):
520 domain = self.get_account_addresses(account)
521 return tx.get_value(domain, self.prevout_values)
524 def update_tx_outputs(self, tx_hash):
525 tx = self.transactions.get(tx_hash)
527 for i, (addr, value) in enumerate(tx.outputs):
528 key = tx_hash+ ':%d'%i
529 self.prevout_values[key] = value
531 for item in tx.inputs:
532 if self.is_mine(item.get('address')):
533 key = item['prevout_hash'] + ':%d'%item['prevout_n']
534 self.spent_outputs.append(key)
537 def get_addr_balance(self, address):
538 #assert self.is_mine(address)
539 h = self.history.get(address,[])
540 if h == ['*']: return 0,0
542 received_coins = [] # list of coins received at address
544 for tx_hash, tx_height in h:
545 tx = self.transactions.get(tx_hash)
548 for i, (addr, value) in enumerate(tx.outputs):
550 key = tx_hash + ':%d'%i
551 received_coins.append(key)
553 for tx_hash, tx_height in h:
554 tx = self.transactions.get(tx_hash)
558 for item in tx.inputs:
559 addr = item.get('address')
561 key = item['prevout_hash'] + ':%d'%item['prevout_n']
562 value = self.prevout_values.get( key )
563 if key in received_coins:
566 for i, (addr, value) in enumerate(tx.outputs):
567 key = tx_hash + ':%d'%i
578 def get_account_name(self, k):
579 return self.labels.get(k, self.accounts[k].get_name(k))
582 def get_account_names(self):
584 for k in self.accounts.keys():
585 account_names[k] = self.get_account_name(k)
589 def get_account_addresses(self, a, include_change=True):
591 o = self.addresses(True)
592 elif a in self.accounts:
593 ac = self.accounts[a]
594 o = ac.get_addresses(0)
595 if include_change: o += ac.get_addresses(1)
599 def get_account_balance(self, account):
600 return self.get_balance(self.get_account_addresses(account))
602 def get_frozen_balance(self):
603 return self.get_balance(self.frozen_addresses)
605 def get_balance(self, domain=None):
606 if domain is None: domain = self.addresses(True)
609 c, u = self.get_addr_balance(addr)
615 def get_unspent_coins(self, domain=None):
617 if domain is None: domain = self.addresses(True)
619 h = self.history.get(addr, [])
620 if h == ['*']: continue
621 for tx_hash, tx_height in h:
622 tx = self.transactions.get(tx_hash)
623 if tx is None: raise Exception("Wallet not synchronized")
624 is_coinbase = tx.inputs[0].get('prevout_hash') == '0'*64
625 for o in tx.d.get('outputs'):
627 if output.get('address') != addr: continue
628 key = tx_hash + ":%d" % output.get('prevout_n')
629 if key in self.spent_outputs: continue
630 output['prevout_hash'] = tx_hash
631 output['height'] = tx_height
632 output['coinbase'] = is_coinbase
633 coins.append((tx_height, output))
637 coins = sorted(coins)
638 if coins[-1][0] != 0:
639 while coins[0][0] == 0:
640 coins = coins[1:] + [ coins[0] ]
641 return [x[1] for x in coins]
644 def choose_tx_inputs( self, amount, fixed_fee, num_outputs, domain = None, coins = None ):
645 """ todo: minimize tx size """
647 fee = self.fee if fixed_fee is None else fixed_fee
651 domain = self.addresses(True)
652 for i in self.frozen_addresses:
653 if i in domain: domain.remove(i)
654 coins = self.get_unspent_coins(domain)
659 if item.get('coinbase') and item.get('height') + COINBASE_MATURITY > self.network.get_local_height():
661 addr = item.get('address')
662 v = item.get('value')
665 fee = self.estimated_fee(inputs, num_outputs) if fixed_fee is None else fixed_fee
666 if total >= amount + fee: break
670 return inputs, total, fee
673 def set_fee(self, fee):
676 self.storage.put('fee_per_kb', self.fee, True)
678 def estimated_fee(self, inputs, num_outputs):
679 estimated_size = len(inputs) * 180 + num_outputs * 34 # this assumes non-compressed keys
680 fee = self.fee * int(math.ceil(estimated_size/1000.))
684 def add_tx_change( self, inputs, outputs, amount, fee, total, change_addr=None):
685 "add change to a transaction"
686 change_amount = total - ( amount + fee )
687 if change_amount > DUST_THRESHOLD:
690 # send change to one of the accounts involved in the tx
691 address = inputs[0].get('address')
692 account, _ = self.get_address_index(address)
694 if not self.use_change or account == IMPORTED_ACCOUNT:
695 change_addr = inputs[-1]['address']
697 change_addr = self.accounts[account].get_addresses(1)[-self.gap_limit_for_change]
699 # Insert the change output at a random position in the outputs
700 posn = random.randint(0, len(outputs))
701 outputs[posn:posn] = [( change_addr, change_amount)]
705 def get_history(self, address):
707 return self.history.get(address)
710 def get_status(self, h):
711 if not h: return None
712 if h == ['*']: return '*'
714 for tx_hash, height in h:
715 status += tx_hash + ':%d:' % height
716 return hashlib.sha256( status ).digest().encode('hex')
719 def receive_tx_callback(self, tx_hash, tx, tx_height):
721 with self.transaction_lock:
722 self.add_extra_addresses(tx)
723 if not self.check_new_tx(tx_hash, tx):
724 # may happen due to pruning
725 print_error("received transaction that is no longer referenced in history", tx_hash)
727 self.transactions[tx_hash] = tx
728 self.network.pending_transactions_for_notifications.append(tx)
729 self.save_transactions()
730 if self.verifier and tx_height>0:
731 self.verifier.add(tx_hash, tx_height)
732 self.update_tx_outputs(tx_hash)
735 def save_transactions(self):
737 for k,v in self.transactions.items():
739 self.storage.put('transactions', tx, True)
741 def receive_history_callback(self, addr, hist):
743 if not self.check_new_history(addr, hist):
744 raise Exception("error: received history for %s is not consistent with known transactions"%addr)
747 self.history[addr] = hist
748 self.storage.put('addr_history', self.history, True)
751 for tx_hash, tx_height in hist:
753 # add it in case it was previously unconfirmed
754 if self.verifier: self.verifier.add(tx_hash, tx_height)
757 def get_tx_history(self, account=None):
758 if not self.verifier:
761 with self.transaction_lock:
762 history = self.transactions.items()
763 history.sort(key = lambda x: self.verifier.get_txpos(x[0]))
767 for tx_hash, tx in history:
768 is_relevant, is_mine, v, fee = self.get_tx_value(tx, account)
769 if v is not None: balance += v
771 c, u = self.get_account_balance(account)
774 result.append( ('', 1000, 0, c+u-balance, None, c+u-balance, None ) )
776 balance = c + u - balance
777 for tx_hash, tx in history:
778 is_relevant, is_mine, value, fee = self.get_tx_value(tx, account)
781 if value is not None:
784 conf, timestamp = self.verifier.get_confirmations(tx_hash) if self.verifier else (None, None)
785 result.append( (tx_hash, conf, is_mine, value, fee, balance, timestamp) )
790 def get_label(self, tx_hash):
791 label = self.labels.get(tx_hash)
792 is_default = (label == '') or (label is None)
793 if is_default: label = self.get_default_label(tx_hash)
794 return label, is_default
797 def get_default_label(self, tx_hash):
798 tx = self.transactions.get(tx_hash)
801 is_relevant, is_mine, _, _ = self.get_tx_value(tx)
805 if not self.is_mine(o_addr):
807 default_label = self.labels[o_addr]
809 default_label = '>' + o_addr
812 default_label = '(internal)'
816 if self.is_mine(o_addr) and not self.is_change(o_addr):
821 if self.is_mine(o_addr):
827 dest_label = self.labels.get(o_addr)
829 default_label = self.labels[o_addr]
831 default_label = '<' + o_addr
836 def make_unsigned_transaction(self, outputs, fee=None, change_addr=None, domain=None, coins=None ):
837 for address, x in outputs:
838 assert is_valid(address), "Address " + address + " is invalid!"
839 amount = sum( map(lambda x:x[1], outputs) )
840 inputs, total, fee = self.choose_tx_inputs( amount, fee, len(outputs), domain, coins )
842 raise ValueError("Not enough funds")
844 self.add_input_info(txin)
845 outputs = self.add_tx_change(inputs, outputs, amount, fee, total, change_addr)
846 return Transaction.from_io(inputs, outputs)
849 def mktx(self, outputs, password, fee=None, change_addr=None, domain= None, coins = None ):
850 tx = self.make_unsigned_transaction(outputs, fee, change_addr, domain, coins)
852 self.add_keypairs(tx, keypairs, password)
854 self.sign_transaction(tx, keypairs, password)
858 def add_input_info(self, txin):
859 address = txin['address']
860 account_id, sequence = self.get_address_index(address)
861 account = self.accounts[account_id]
862 redeemScript = account.redeem_script(sequence)
863 txin['x_pubkeys'] = account.get_xpubkeys(sequence)
864 txin['pubkeys'] = account.get_pubkeys(sequence)
866 txin['redeemScript'] = redeemScript
869 txin['redeemPubkey'] = account.get_pubkey(*sequence)
873 def sign_transaction(self, tx, keypairs, password):
875 run_hook('sign_transaction', tx, password)
878 def sendtx(self, tx):
882 return self.receive_tx(h, tx)
884 def send_tx(self, tx):
886 self.tx_event.clear()
887 self.network.send([('blockchain.transaction.broadcast', [str(tx)])], self.on_broadcast)
890 def on_broadcast(self, i, r):
891 self.tx_result = r.get('result')
894 def receive_tx(self, tx_hash, tx):
897 return False, "error: " + out
898 run_hook('receive_tx', tx, self)
902 def update_password(self, old_password, new_password):
903 if new_password == '':
907 decoded = self.get_seed(old_password)
908 self.seed = pw_encode( decoded, new_password)
909 self.storage.put('seed', self.seed, True)
911 imported_account = self.accounts.get(IMPORTED_ACCOUNT)
913 imported_account.update_password(old_password, new_password)
916 for k, v in self.master_private_keys.items():
917 b = pw_decode(v, old_password)
918 c = pw_encode(b, new_password)
919 self.master_private_keys[k] = c
920 self.storage.put('master_private_keys', self.master_private_keys, True)
922 self.use_encryption = (new_password != None)
923 self.storage.put('use_encryption', self.use_encryption,True)
926 def freeze(self,addr):
927 if self.is_mine(addr) and addr not in self.frozen_addresses:
928 self.frozen_addresses.append(addr)
929 self.storage.put('frozen_addresses', self.frozen_addresses, True)
935 def unfreeze(self,addr):
936 if self.is_mine(addr) and addr in self.frozen_addresses:
937 self.frozen_addresses.remove(addr)
938 self.storage.put('frozen_addresses', self.frozen_addresses, True)
944 def set_verifier(self, verifier):
945 self.verifier = verifier
947 # review transactions that are in the history
948 for addr, hist in self.history.items():
949 if hist == ['*']: continue
950 for tx_hash, tx_height in hist:
952 # add it in case it was previously unconfirmed
953 self.verifier.add(tx_hash, tx_height)
955 # if we are on a pruning server, remove unverified transactions
956 vr = self.verifier.transactions.keys() + self.verifier.verified_tx.keys()
957 for tx_hash in self.transactions.keys():
958 if tx_hash not in vr:
959 self.transactions.pop(tx_hash)
962 def check_new_history(self, addr, hist):
964 # check that all tx in hist are relevant
966 for tx_hash, height in hist:
967 tx = self.transactions.get(tx_hash)
969 if not tx.has_address(addr):
972 # check that we are not "orphaning" a transaction
973 old_hist = self.history.get(addr,[])
974 if old_hist == ['*']: return True
976 for tx_hash, height in old_hist:
977 if tx_hash in map(lambda x:x[0], hist): continue
979 for _addr, _hist in self.history.items():
980 if _addr == addr: continue
981 if _hist == ['*']: continue
982 _tx_hist = map(lambda x:x[0], _hist)
983 if tx_hash in _tx_hist:
988 tx = self.transactions.get(tx_hash)
989 # tx might not be there
993 if self.verifier.get_height(tx_hash):
996 print_error("new history is orphaning transaction:", tx_hash)
997 # check that all outputs are not mine, request histories
999 for _addr, _v in tx.outputs:
1000 # assert not self.is_mine(_addr)
1001 ext_requests.append( ('blockchain.address.get_history', [_addr]) )
1003 ext_h = self.network.synchronous_get(ext_requests)
1004 print_error("sync:", ext_requests, ext_h)
1007 if h == ['*']: continue
1009 if item.get('tx_hash') == tx_hash:
1010 height = item.get('height')
1012 print_error("found height for", tx_hash, height)
1013 self.verifier.add(tx_hash, height)
1015 print_error("removing orphaned tx from history", tx_hash)
1016 self.transactions.pop(tx_hash)
1021 def check_new_tx(self, tx_hash, tx):
1022 # 1 check that tx is referenced in addr_history.
1024 for addr, hist in self.history.items():
1025 if hist == ['*']:continue
1026 for txh, height in hist:
1028 addresses.append(addr)
1033 # 2 check that referencing addresses are in the tx
1034 for addr in addresses:
1035 if not tx.has_address(addr):
1041 def start_threads(self, network):
1042 from verifier import TxVerifier
1043 self.network = network
1044 if self.network is not None:
1045 self.verifier = TxVerifier(self.network, self.storage)
1046 self.verifier.start()
1047 self.set_verifier(self.verifier)
1048 self.synchronizer = WalletSynchronizer(self, network)
1049 self.synchronizer.start()
1051 self.verifier = None
1052 self.synchronizer =None
1054 def stop_threads(self):
1056 self.verifier.stop()
1057 self.synchronizer.stop()
1059 def restore(self, cb):
1062 def get_accounts(self):
1063 return self.accounts
1065 def save_accounts(self):
1067 for k, v in self.accounts.items():
1069 self.storage.put('accounts', d, True)
1071 def can_import(self):
1072 return not self.is_watching_only()
1074 def is_used(self, address):
1075 h = self.history.get(address,[])
1076 c, u = self.get_addr_balance(address)
1077 return len(h), len(h) > 0 and c == -u
1080 class Imported_Wallet(Abstract_Wallet):
1082 def __init__(self, storage):
1083 Abstract_Wallet.__init__(self, storage)
1084 a = self.accounts.get(IMPORTED_ACCOUNT)
1086 self.accounts[IMPORTED_ACCOUNT] = ImportedAccount({'imported':{}})
1087 self.storage.put('wallet_type', 'imported', True)
1090 def is_watching_only(self):
1091 acc = self.accounts[IMPORTED_ACCOUNT]
1092 n = acc.keypairs.values()
1093 return n == [(None, None)] * len(n)
1098 def is_deterministic(self):
1101 def check_password(self, password):
1102 self.accounts[IMPORTED_ACCOUNT].get_private_key((0,0), self, password)
1104 def is_used(self, address):
1105 h = self.history.get(address,[])
1106 return len(h), False
1109 class Deterministic_Wallet(Abstract_Wallet):
1111 def __init__(self, storage):
1112 Abstract_Wallet.__init__(self, storage)
1115 return self.seed != ''
1117 def is_deterministic(self):
1120 def is_watching_only(self):
1121 return not self.has_seed()
1123 def add_seed(self, seed, password):
1125 raise Exception("a seed exists")
1127 self.seed_version, self.seed = self.prepare_seed(seed)
1129 self.seed = pw_encode( self.seed, password)
1130 self.use_encryption = True
1132 self.use_encryption = False
1134 self.storage.put('seed', self.seed, True)
1135 self.storage.put('seed_version', self.seed_version, True)
1136 self.storage.put('use_encryption', self.use_encryption,True)
1137 self.create_master_keys(password)
1139 def get_seed(self, password):
1140 return pw_decode(self.seed, password)
1142 def get_mnemonic(self, password):
1143 return self.get_seed(password)
1145 def change_gap_limit(self, value):
1146 if value >= self.gap_limit:
1147 self.gap_limit = value
1148 self.storage.put('gap_limit', self.gap_limit, True)
1149 #self.interface.poke('synchronizer')
1152 elif value >= self.min_acceptable_gap():
1153 for key, account in self.accounts.items():
1154 addresses = account[0]
1155 k = self.num_unused_trailing_addresses(addresses)
1156 n = len(addresses) - k + value
1157 addresses = addresses[0:n]
1158 self.accounts[key][0] = addresses
1160 self.gap_limit = value
1161 self.storage.put('gap_limit', self.gap_limit, True)
1162 self.save_accounts()
1167 def num_unused_trailing_addresses(self, addresses):
1169 for a in addresses[::-1]:
1170 if self.history.get(a):break
1174 def min_acceptable_gap(self):
1175 # fixme: this assumes wallet is synchronized
1179 for account in self.accounts.values():
1180 addresses = account.get_addresses(0)
1181 k = self.num_unused_trailing_addresses(addresses)
1182 for a in addresses[0:-k]:
1183 if self.history.get(a):
1187 if n > nmax: nmax = n
1191 def address_is_old(self, address):
1193 h = self.history.get(address, [])
1196 for tx_hash, tx_height in h:
1200 tx_age = self.network.get_local_height() - tx_height + 1
1206 def synchronize_sequence(self, account, for_change):
1207 limit = self.gap_limit_for_change if for_change else self.gap_limit
1210 addresses = account.get_addresses(for_change)
1211 if len(addresses) < limit:
1212 address = account.create_new_address(for_change)
1213 self.history[address] = []
1214 new_addresses.append( address )
1217 if map( lambda a: self.address_is_old(a), addresses[-limit:] ) == limit*[False]:
1220 address = account.create_new_address(for_change)
1221 self.history[address] = []
1222 new_addresses.append( address )
1224 return new_addresses
1227 def check_pending_accounts(self):
1228 for account_id, addr in self.next_addresses.items():
1229 if self.address_is_old(addr):
1230 print_error( "creating account", account_id )
1231 xpub = self.master_public_keys[account_id]
1232 account = BIP32_Account({'xpub':xpub})
1233 self.add_account(account_id, account)
1234 self.next_addresses.pop(account_id)
1237 def synchronize_account(self, account):
1239 new += self.synchronize_sequence(account, 0)
1240 new += self.synchronize_sequence(account, 1)
1244 def synchronize(self):
1245 self.check_pending_accounts()
1247 for account in self.accounts.values():
1248 if type(account) in [ImportedAccount, PendingAccount]:
1250 new += self.synchronize_account(account)
1252 self.save_accounts()
1253 self.storage.put('addr_history', self.history, True)
1257 def restore(self, callback):
1259 def wait_for_wallet():
1260 self.set_up_to_date(False)
1261 while not self.is_up_to_date():
1262 msg = "%s\n%s %d\n%s %.1f"%(
1263 _("Please wait..."),
1264 _("Addresses generated:"),
1265 len(self.addresses(True)),
1266 _("Kilobytes received:"),
1267 self.network.interface.bytes_received/1024.)
1269 apply(callback, (msg,))
1272 def wait_for_network():
1273 while not self.network.is_connected():
1274 msg = "%s \n" % (_("Connecting..."))
1275 apply(callback, (msg,))
1278 # wait until we are connected, because the user might have selected another server
1285 self.fill_addressbook()
1288 def create_account(self, name, password):
1289 i = self.num_accounts()
1290 account_id = self.account_id(i)
1291 account = self.make_account(account_id, password)
1292 self.add_account(account_id, account)
1294 self.set_label(account_id, name)
1296 # add address of the next account
1297 _, _ = self.next_account_address(password)
1300 def add_account(self, account_id, account):
1301 self.accounts[account_id] = account
1302 self.save_accounts()
1306 def account_is_pending(self, k):
1307 return type(self.accounts.get(k)) == PendingAccount
1309 def delete_pending_account(self, k):
1310 assert self.account_is_pending(k)
1311 self.accounts.pop(k)
1312 self.save_accounts()
1314 def create_pending_account(self, name, password):
1315 account_id, addr = self.next_account_address(password)
1316 self.set_label(account_id, name)
1317 self.accounts[account_id] = PendingAccount({'pending':addr})
1318 self.save_accounts()
1323 class NewWallet(Deterministic_Wallet):
1325 def __init__(self, storage):
1326 Deterministic_Wallet.__init__(self, storage)
1328 def can_create_accounts(self):
1329 return not self.is_watching_only()
1331 def get_master_public_key(self):
1332 return self.master_public_keys["m/"]
1334 def get_master_public_keys(self):
1336 for k, account in self.accounts.items():
1337 name = self.get_account_name(k)
1338 mpk_text = '\n\n'.join( account.get_master_pubkeys() )
1339 out[name] = mpk_text
1342 def get_master_private_key(self, account, password):
1343 k = self.master_private_keys.get(account)
1345 xpriv = pw_decode( k, password)
1348 def check_password(self, password):
1349 xpriv = self.get_master_private_key( "m/", password )
1350 xpub = self.master_public_keys["m/"]
1351 assert deserialize_xkey(xpriv)[3] == deserialize_xkey(xpub)[3]
1353 def create_watching_only_wallet(self, xpub):
1354 self.storage.put('seed_version', self.seed_version, True)
1355 self.add_master_public_key("m/", xpub)
1356 account = BIP32_Account({'xpub':xpub})
1357 self.add_account("m/", account)
1360 def create_accounts(self, password):
1361 seed = pw_decode(self.seed, password)
1362 self.create_account('Main account', password)
1365 def add_master_public_key(self, name, mpk):
1366 self.master_public_keys[name] = mpk
1367 self.storage.put('master_public_keys', self.master_public_keys, True)
1370 def add_master_private_key(self, name, xpriv, password):
1371 self.master_private_keys[name] = pw_encode(xpriv, password)
1372 self.storage.put('master_private_keys', self.master_private_keys, True)
1375 def add_master_keys(self, root, account_id, password):
1376 x = self.master_private_keys.get(root)
1378 master_xpriv = pw_decode(x, password )
1379 xpriv, xpub = bip32_private_derivation(master_xpriv, root, account_id)
1380 self.add_master_public_key(account_id, xpub)
1381 self.add_master_private_key(account_id, xpriv, password)
1383 master_xpub = self.master_public_keys[root]
1384 xpub = bip32_public_derivation(master_xpub, root, account_id)
1385 self.add_master_public_key(account_id, xpub)
1389 def create_master_keys(self, password):
1390 xpriv, xpub = bip32_root(mnemonic_to_seed(self.get_seed(password),'').encode('hex'))
1391 self.add_master_public_key("m/", xpub)
1392 self.add_master_private_key("m/", xpriv, password)
1395 def find_root_by_master_key(self, xpub):
1396 for key, xpub2 in self.master_public_keys.items():
1397 if key == "m/":continue
1402 def num_accounts(self):
1404 for k, v in self.accounts.items():
1405 if type(v) != BIP32_Account:
1411 account_id = self.account_id(i)
1412 if account_id not in keys: break
1417 def next_account_address(self, password):
1418 i = self.num_accounts()
1419 account_id = self.account_id(i)
1421 addr = self.next_addresses.get(account_id)
1423 account = self.make_account(account_id, password)
1424 addr = account.first_address()
1425 self.next_addresses[account_id] = addr
1426 self.storage.put('next_addresses', self.next_addresses)
1428 return account_id, addr
1430 def account_id(self, i):
1433 def make_account(self, account_id, password):
1434 """Creates and saves the master keys, but does not save the account"""
1435 xpub = self.add_master_keys("m/", account_id, password)
1436 account = BIP32_Account({'xpub':xpub})
1440 def make_seed(self):
1441 import mnemonic, ecdsa
1442 entropy = ecdsa.util.randrange( pow(2,160) )
1445 ss = "%040x"%(entropy+nonce)
1446 s = hashlib.sha256(ss.decode('hex')).digest().encode('hex')
1447 # we keep only 13 words, that's approximately 139 bits of entropy
1448 words = mnemonic.mn_encode(s)[0:13]
1449 seed = ' '.join(words)
1450 if is_new_seed(seed):
1451 break # this will remove 8 bits of entropy
1455 def prepare_seed(self, seed):
1457 return NEW_SEED_VERSION, unicodedata.normalize('NFC', unicode(seed.strip()))
1461 class Wallet_2of2(NewWallet):
1463 def __init__(self, storage):
1464 NewWallet.__init__(self, storage)
1465 self.storage.put('wallet_type', '2of2', True)
1467 def can_create_accounts(self):
1470 def can_import(self):
1473 def create_account(self):
1474 xpub1 = self.master_public_keys.get("m/")
1475 xpub2 = self.master_public_keys.get("cold/")
1476 account = BIP32_Account_2of2({'xpub':xpub1, 'xpub2':xpub2})
1477 self.add_account('m/', account)
1479 def get_master_public_keys(self):
1480 xpub1 = self.master_public_keys.get("m/")
1481 xpub2 = self.master_public_keys.get("cold/")
1482 return {'hot':xpub1, 'cold':xpub2}
1484 def get_action(self):
1485 xpub1 = self.master_public_keys.get("m/")
1486 xpub2 = self.master_public_keys.get("cold/")
1488 return 'create_2of2_1'
1490 return 'create_2of2_2'
1494 class Wallet_2of3(Wallet_2of2):
1496 def __init__(self, storage):
1497 Wallet_2of2.__init__(self, storage)
1498 self.storage.put('wallet_type', '2of3', True)
1500 def create_account(self):
1501 xpub1 = self.master_public_keys.get("m/")
1502 xpub2 = self.master_public_keys.get("cold/")
1503 xpub3 = self.master_public_keys.get("remote/")
1504 account = BIP32_Account_2of3({'xpub':xpub1, 'xpub2':xpub2, 'xpub3':xpub3})
1505 self.add_account('m/', account)
1507 def get_master_public_keys(self):
1508 xpub1 = self.master_public_keys.get("m/")
1509 xpub2 = self.master_public_keys.get("cold/")
1510 xpub3 = self.master_public_keys.get("remote/")
1511 return {'hot':xpub1, 'cold':xpub2, 'remote':xpub3}
1513 def get_action(self):
1514 xpub1 = self.master_public_keys.get("m/")
1515 xpub2 = self.master_public_keys.get("cold/")
1516 xpub3 = self.master_public_keys.get("remote/")
1517 # fixme: we use order of creation
1518 if xpub2 and xpub1 is None:
1519 return 'create_2fa_2'
1521 return 'create_2of3_1'
1522 if xpub2 is None or xpub3 is None:
1523 return 'create_2of3_2'
1529 class OldWallet(Deterministic_Wallet):
1531 def make_seed(self):
1533 seed = random_seed(128)
1534 return ' '.join(mnemonic.mn_encode(seed))
1536 def prepare_seed(self, seed):
1538 # see if seed was entered as hex
1543 return OLD_SEED_VERSION, str(seed)
1547 words = seed.split()
1548 seed = mnemonic.mn_decode(words)
1550 raise Exception("Invalid seed")
1552 return OLD_SEED_VERSION, seed
1555 def create_master_keys(self, password):
1556 seed = self.get_seed(password)
1557 mpk = OldAccount.mpk_from_seed(seed)
1558 self.storage.put('master_public_key', mpk, True)
1560 def get_master_public_key(self):
1561 return self.storage.get("master_public_key")
1563 def get_master_public_keys(self):
1564 return {'Main Account':self.get_master_public_key()}
1566 def create_accounts(self, password):
1567 mpk = self.storage.get("master_public_key")
1568 self.create_account(mpk)
1570 def create_account(self, mpk):
1571 self.accounts[0] = OldAccount({'mpk':mpk, 0:[], 1:[]})
1572 self.save_accounts()
1574 def create_watching_only_wallet(self, mpk):
1575 self.seed_version = OLD_SEED_VERSION
1576 self.storage.put('seed_version', self.seed_version, True)
1577 self.storage.put('master_public_key', mpk, True)
1578 self.create_account(mpk)
1580 def get_seed(self, password):
1581 seed = pw_decode(self.seed, password).encode('utf8')
1584 def check_password(self, password):
1585 seed = self.get_seed(password)
1586 self.accounts[0].check_seed(seed)
1588 def get_mnemonic(self, password):
1590 s = self.get_seed(password)
1591 return ' '.join(mnemonic.mn_encode(s))
1593 def check_pending_accounts(self):
1597 # former WalletFactory
1598 class Wallet(object):
1600 def __new__(self, storage):
1601 config = storage.config
1602 if config.get('bitkey', False):
1603 # if user requested support for Bitkey device,
1604 # import Bitkey driver
1605 from wallet_bitkey import WalletBitkey
1606 return WalletBitkey(config)
1608 if storage.get('wallet_type') == '2of2':
1609 return Wallet_2of2(storage)
1611 if storage.get('wallet_type') == '2of3':
1612 return Wallet_2of3(storage)
1614 if storage.get('wallet_type') == 'imported':
1615 return Imported_Wallet(storage)
1618 if not storage.file_exists:
1619 seed_version = NEW_SEED_VERSION if config.get('bip32') is True else OLD_SEED_VERSION
1621 seed_version = storage.get('seed_version')
1622 if not seed_version:
1623 seed_version = OLD_SEED_VERSION if len(storage.get('master_public_key')) == 128 else NEW_SEED_VERSION
1625 if seed_version == OLD_SEED_VERSION:
1626 return OldWallet(storage)
1627 elif seed_version == NEW_SEED_VERSION:
1628 return NewWallet(storage)
1630 msg = "This wallet seed is not supported."
1631 if seed_version in [5]:
1632 msg += "\nTo open this wallet, try 'git checkout seed_v%d'"%seed_version
1639 def is_seed(self, seed):
1642 elif is_old_seed(seed):
1644 elif is_new_seed(seed):
1650 def is_mpk(self, mpk):
1658 return len(mpk) == 128
1661 deserialize_xkey(mpk)
1667 def is_address(self, text):
1670 for x in text.split():
1671 if not bitcoin.is_address(x):
1676 def is_private_key(self, text):
1679 for x in text.split():
1680 if not bitcoin.is_private_key(x):
1685 def from_seed(self, seed, storage):
1686 if is_old_seed(seed):
1688 elif is_new_seed(seed):
1694 def from_address(self, text, storage):
1695 w = Imported_Wallet(storage)
1696 for x in text.split():
1697 w.accounts[IMPORTED_ACCOUNT].add(x, None, None, None)
1702 def from_private_key(self, text, storage):
1703 w = Imported_Wallet(storage)
1704 for x in text.split():
1705 w.import_key(x, None)
1709 def from_mpk(self, mpk, storage):
1718 w = OldWallet(storage)
1720 w.create_watching_only_wallet(mpk)
1722 w = NewWallet(storage)
1723 w.create_watching_only_wallet(mpk)