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/>.
28 from util import print_msg, print_error
34 from transaction import Transaction
35 from plugins import run_hook
37 from synchronizer import WalletSynchronizer
39 COINBASE_MATURITY = 100
42 # internal ID for imported account
43 IMPORTED_ACCOUNT = '/x'
46 class WalletStorage(object):
48 def __init__(self, config):
49 self.lock = threading.RLock()
52 self.file_exists = False
53 self.path = self.init_path(config)
54 print_error( "wallet path", self.path )
58 def init_path(self, config):
59 """Set the path of the wallet."""
61 # command line -w option
62 path = config.get('wallet_path')
67 path = config.get('default_wallet_path')
72 dirpath = os.path.join(config.path, "wallets")
73 if not os.path.exists(dirpath):
76 new_path = os.path.join(config.path, "wallets", "default_wallet")
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)
86 """Read the contents of the wallet file."""
88 with open(self.path, "r") as f:
93 d = ast.literal_eval( data ) #parse raw data from reading wallet file
95 raise IOError("Cannot read wallet file.")
98 self.file_exists = True
100 def get(self, key, default=None):
103 v = self.data.get(key)
108 def put(self, key, value, save = True):
111 if value is not None:
112 self.data[key] = value
113 elif key in self.data:
120 f = open(self.path,"w")
123 if 'ANDROID_DATA' not in os.environ:
125 os.chmod(self.path,stat.S_IREAD | stat.S_IWRITE)
128 class Abstract_Wallet(object):
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.
133 def __init__(self, storage):
134 self.storage = storage
135 self.electrum_version = ELECTRUM_VERSION
136 self.gap_limit_for_change = 3 # constant
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', [])
147 self.history = storage.get('addr_history',{}) # address -> list(txid, height)
149 self.fee = int(storage.get('fee_per_kb', 10000))
151 self.next_addresses = storage.get('next_addresses',{})
153 # This attribute is set when wallet.start_threads is called.
154 self.synchronizer = None
156 # imported_keys is deprecated. The GUI should call convert_imported_keys
157 self.imported_keys = self.storage.get('imported_keys',{})
161 self.transactions = {}
162 tx_list = self.storage.get('transactions',{})
163 for k, raw in tx_list.items():
165 tx = Transaction.deserialize(raw)
167 print_msg("Warning: Cannot deserialize transactions. skipping")
170 self.add_pubkey_addresses(tx)
171 self.transactions[k] = tx
173 for h,tx in self.transactions.items():
174 if not self.check_new_tx(h, tx):
175 print_error("removing unreferenced tx", h)
176 self.transactions.pop(h)
179 self.prevout_values = {} # my own transaction outputs
180 self.spent_outputs = []
185 # there is a difference between wallet.up_to_date and interface.is_up_to_date()
186 # interface.is_up_to_date() returns true when all requests have been answered and processed
187 # wallet.up_to_date is true when the wallet is synchronized (stronger requirement)
189 self.up_to_date = False
190 self.lock = threading.Lock()
191 self.transaction_lock = threading.Lock()
192 self.tx_event = threading.Event()
193 for tx_hash, tx in self.transactions.items():
194 self.update_tx_outputs(tx_hash)
196 def add_pubkey_addresses(self, tx):
197 # find the address corresponding to pay-to-pubkey inputs
201 tx.add_pubkey_addresses(self.transactions)
203 # outputs of tx: inputs of tx2
204 for type, x, v in tx.outputs:
206 for tx2 in self.transactions.values():
207 tx2.add_pubkey_addresses({h:tx})
209 def get_action(self):
212 def convert_imported_keys(self, password):
213 for k, v in self.imported_keys.items():
214 sec = pw_decode(v, password)
215 pubkey = public_key_from_private_key(sec)
216 address = public_key_to_bc_address(pubkey.decode('hex'))
218 self.import_key(sec, password)
219 self.imported_keys.pop(k)
220 self.storage.put('imported_keys', self.imported_keys)
222 def load_accounts(self):
225 d = self.storage.get('accounts', {})
226 for k, v in d.items():
228 v['mpk'] = self.storage.get('master_public_key')
229 self.accounts[k] = OldAccount(v)
230 elif v.get('imported'):
231 self.accounts[k] = ImportedAccount(v)
233 self.accounts[k] = BIP32_Account_2of3(v)
235 self.accounts[k] = BIP32_Account_2of2(v)
237 self.accounts[k] = BIP32_Account(v)
238 elif v.get('pending'):
239 self.accounts[k] = PendingAccount(v)
241 print_error("cannot load account", v)
243 def synchronize(self):
246 def can_create_accounts(self):
249 def set_up_to_date(self,b):
250 with self.lock: self.up_to_date = b
252 def is_up_to_date(self):
253 with self.lock: return self.up_to_date
256 self.up_to_date = False
257 while not self.is_up_to_date():
260 def is_imported(self, addr):
261 account = self.accounts.get(IMPORTED_ACCOUNT)
263 return addr in account.get_addresses(0)
267 def has_imported_keys(self):
268 account = self.accounts.get(IMPORTED_ACCOUNT)
269 return account is not None
271 def import_key(self, sec, password):
273 pubkey = public_key_from_private_key(sec)
274 address = public_key_to_bc_address(pubkey.decode('hex'))
276 raise Exception('Invalid private key')
278 if self.is_mine(address):
279 raise Exception('Address already in wallet')
281 if self.accounts.get(IMPORTED_ACCOUNT) is None:
282 self.accounts[IMPORTED_ACCOUNT] = ImportedAccount({'imported':{}})
283 self.accounts[IMPORTED_ACCOUNT].add(address, pubkey, sec, password)
286 if self.synchronizer:
287 self.synchronizer.subscribe_to_addresses([address])
290 def delete_imported_key(self, addr):
291 account = self.accounts[IMPORTED_ACCOUNT]
293 if not account.get_addresses(0):
294 self.accounts.pop(IMPORTED_ACCOUNT)
297 def set_label(self, name, text = None):
299 old_text = self.labels.get(name)
302 self.labels[name] = text
306 self.labels.pop(name)
310 self.storage.put('labels', self.labels, True)
312 run_hook('set_label', name, text, changed)
315 def addresses(self, include_change = True, _next=True):
317 for a in self.accounts.keys():
318 o += self.get_account_addresses(a, include_change)
321 for addr in self.next_addresses.values():
326 def is_mine(self, address):
327 return address in self.addresses(True)
329 def is_change(self, address):
330 if not self.is_mine(address): return False
331 acct, s = self.get_address_index(address)
332 if s is None: return False
335 def get_address_index(self, address):
336 for account in self.accounts.keys():
337 for for_change in [0,1]:
338 addresses = self.accounts[account].get_addresses(for_change)
339 for addr in addresses:
341 return account, (for_change, addresses.index(addr))
343 for k,v in self.next_addresses.items():
347 raise Exception("Address not found", address)
349 def get_private_key(self, address, password):
350 if self.is_watching_only():
352 account_id, sequence = self.get_address_index(address)
353 return self.accounts[account_id].get_private_key(sequence, self, password)
355 def get_public_keys(self, address):
356 account_id, sequence = self.get_address_index(address)
357 return self.accounts[account_id].get_pubkeys(sequence)
359 def add_keypairs(self, tx, keypairs, password):
360 # first check the provided password. This will raise if invalid.
361 self.check_password(password)
363 addr_list, xpub_list = tx.inputs_to_sign()
364 for addr in addr_list:
365 if self.is_mine(addr):
366 private_keys = self.get_private_key(addr, password)
367 for sec in private_keys:
368 pubkey = public_key_from_private_key(sec)
369 keypairs[ pubkey ] = sec
371 for xpub, sequence in xpub_list:
372 # look for account that can sign
373 for k, account in self.accounts.items():
374 if xpub in account.get_master_pubkeys():
378 pk = account.get_private_key(sequence, self, password)
380 pubkey = public_key_from_private_key(sec)
381 keypairs[pubkey] = sec
383 def signrawtransaction(self, tx, private_keys, password):
384 # check that the password is correct. This will raise if it's not.
385 self.get_seed(password)
387 # build a list of public/private keys
390 # add private keys from parameter
391 for sec in private_keys:
392 pubkey = public_key_from_private_key(sec)
393 keypairs[ pubkey ] = sec
396 self.add_keypairs(tx, keypairs, password)
398 # sign the transaction
399 self.sign_transaction(tx, keypairs, password)
401 def sign_message(self, address, message, password):
402 keys = self.get_private_key(address, password)
403 assert len(keys) == 1
405 key = regenerate_key(sec)
406 compressed = is_compressed(sec)
407 return key.sign_message(message, compressed, address)
409 def decrypt_message(self, pubkey, message, password):
410 address = public_key_to_bc_address(pubkey.decode('hex'))
411 keys = self.get_private_key(address, password)
413 ec = regenerate_key(secret)
414 decrypted = ec.decrypt_message(message)
418 return self.history.values() != [[]] * len(self.history)
420 def add_contact(self, address, label=None):
421 self.addressbook.append(address)
422 self.storage.put('contacts', self.addressbook, True)
424 self.set_label(address, label)
426 def delete_contact(self, addr):
427 if addr in self.addressbook:
428 self.addressbook.remove(addr)
429 self.storage.put('addressbook', self.addressbook, True)
431 def fill_addressbook(self):
432 for tx_hash, tx in self.transactions.items():
433 is_relevant, is_send, _, _ = self.get_tx_value(tx)
435 for addr in tx.get_output_addresses():
436 if not self.is_mine(addr) and addr not in self.addressbook:
437 self.addressbook.append(addr)
439 # self.update_tx_labels()
441 def get_num_tx(self, address):
443 for tx in self.transactions.values():
444 if address in tx.get_output_addresses(): n += 1
447 def get_address_flags(self, addr):
448 flags = "C" if self.is_change(addr) else "I" if addr in self.imported_keys.keys() else "-"
449 flags += "F" if addr in self.frozen_addresses else "-"
452 def get_tx_value(self, tx, account=None):
453 domain = self.get_account_addresses(account)
454 return tx.get_value(domain, self.prevout_values)
456 def update_tx_outputs(self, tx_hash):
457 tx = self.transactions.get(tx_hash)
459 for i, (addr, value) in enumerate(tx.get_outputs()):
460 key = tx_hash+ ':%d'%i
461 self.prevout_values[key] = value
463 for item in tx.inputs:
464 if self.is_mine(item.get('address')):
465 key = item['prevout_hash'] + ':%d'%item['prevout_n']
466 self.spent_outputs.append(key)
468 def get_addr_balance(self, address):
469 #assert self.is_mine(address)
470 h = self.history.get(address,[])
471 if h == ['*']: return 0,0
473 received_coins = [] # list of coins received at address
475 for tx_hash, tx_height in h:
476 tx = self.transactions.get(tx_hash)
479 for i, (addr, value) in enumerate(tx.get_outputs()):
481 key = tx_hash + ':%d'%i
482 received_coins.append(key)
484 for tx_hash, tx_height in h:
485 tx = self.transactions.get(tx_hash)
489 for item in tx.inputs:
490 addr = item.get('address')
492 key = item['prevout_hash'] + ':%d'%item['prevout_n']
493 value = self.prevout_values.get( key )
494 if key in received_coins:
497 for i, (addr, value) in enumerate(tx.get_outputs()):
498 key = tx_hash + ':%d'%i
508 def get_account_name(self, k):
509 return self.labels.get(k, self.accounts[k].get_name(k))
511 def get_account_names(self):
513 for k in self.accounts.keys():
514 account_names[k] = self.get_account_name(k)
517 def get_account_addresses(self, a, include_change=True):
519 o = self.addresses(include_change)
520 elif a in self.accounts:
521 ac = self.accounts[a]
522 o = ac.get_addresses(0)
523 if include_change: o += ac.get_addresses(1)
526 def get_account_balance(self, account):
527 return self.get_balance(self.get_account_addresses(account))
529 def get_frozen_balance(self):
530 return self.get_balance(self.frozen_addresses)
532 def get_balance(self, domain=None):
533 if domain is None: domain = self.addresses(True)
536 c, u = self.get_addr_balance(addr)
541 def get_unspent_coins(self, domain=None):
543 if domain is None: domain = self.addresses(True)
545 h = self.history.get(addr, [])
546 if h == ['*']: continue
547 for tx_hash, tx_height in h:
548 tx = self.transactions.get(tx_hash)
549 if tx is None: raise Exception("Wallet not synchronized")
550 is_coinbase = tx.inputs[0].get('prevout_hash') == '0'*64
551 for i, (address, value) in enumerate(tx.get_outputs()):
552 output = {'address':address, 'value':value, 'prevout_n':i}
553 if address != addr: continue
554 key = tx_hash + ":%d"%i
555 if key in self.spent_outputs: continue
556 output['prevout_hash'] = tx_hash
557 output['height'] = tx_height
558 output['coinbase'] = is_coinbase
559 coins.append((tx_height, output))
563 coins = sorted(coins)
564 if coins[-1][0] != 0:
565 while coins[0][0] == 0:
566 coins = coins[1:] + [ coins[0] ]
567 return [x[1] for x in coins]
569 def choose_tx_inputs( self, amount, fixed_fee, num_outputs, domain = None, coins = None ):
570 """ todo: minimize tx size """
572 fee = self.fee if fixed_fee is None else fixed_fee
576 domain = self.addresses(True)
577 for i in self.frozen_addresses:
578 if i in domain: domain.remove(i)
579 coins = self.get_unspent_coins(domain)
584 if item.get('coinbase') and item.get('height') + COINBASE_MATURITY > self.network.get_local_height():
586 v = item.get('value')
589 fee = self.estimated_fee(inputs, num_outputs) if fixed_fee is None else fixed_fee
590 if total >= amount + fee: break
594 return inputs, total, fee
596 def set_fee(self, fee):
599 self.storage.put('fee_per_kb', self.fee, True)
601 def estimated_fee(self, inputs, num_outputs):
602 estimated_size = len(inputs) * 180 + num_outputs * 34 # this assumes non-compressed keys
603 fee = self.fee * int(math.ceil(estimated_size/1000.))
606 def add_tx_change( self, inputs, outputs, amount, fee, total, change_addr=None):
607 "add change to a transaction"
608 change_amount = total - ( amount + fee )
609 if change_amount > DUST_THRESHOLD:
612 # send change to one of the accounts involved in the tx
613 address = inputs[0].get('address')
614 account, _ = self.get_address_index(address)
616 if not self.use_change or account == IMPORTED_ACCOUNT:
617 change_addr = inputs[-1]['address']
619 change_addr = self.accounts[account].get_addresses(1)[-self.gap_limit_for_change]
621 # Insert the change output at a random position in the outputs
622 posn = random.randint(0, len(outputs))
623 outputs[posn:posn] = [( 'address', change_addr, change_amount)]
626 def get_history(self, address):
628 return self.history.get(address)
630 def get_status(self, h):
631 if not h: return None
632 if h == ['*']: return '*'
634 for tx_hash, height in h:
635 status += tx_hash + ':%d:' % height
636 return hashlib.sha256( status ).digest().encode('hex')
638 def receive_tx_callback(self, tx_hash, tx, tx_height):
640 with self.transaction_lock:
641 self.add_pubkey_addresses(tx)
642 if not self.check_new_tx(tx_hash, tx):
643 # may happen due to pruning
644 print_error("received transaction that is no longer referenced in history", tx_hash)
646 self.transactions[tx_hash] = tx
647 self.network.pending_transactions_for_notifications.append(tx)
648 self.save_transactions()
649 if self.verifier and tx_height>0:
650 self.verifier.add(tx_hash, tx_height)
651 self.update_tx_outputs(tx_hash)
653 def save_transactions(self):
655 for k,v in self.transactions.items():
657 self.storage.put('transactions', tx, True)
659 def receive_history_callback(self, addr, hist):
661 if not self.check_new_history(addr, hist):
662 raise Exception("error: received history for %s is not consistent with known transactions"%addr)
665 self.history[addr] = hist
666 self.storage.put('addr_history', self.history, True)
669 for tx_hash, tx_height in hist:
671 # add it in case it was previously unconfirmed
672 if self.verifier: self.verifier.add(tx_hash, tx_height)
674 def get_tx_history(self, account=None):
675 if not self.verifier:
678 with self.transaction_lock:
679 history = self.transactions.items()
680 history.sort(key = lambda x: self.verifier.get_txpos(x[0]))
684 for tx_hash, tx in history:
685 is_relevant, is_mine, v, fee = self.get_tx_value(tx, account)
686 if v is not None: balance += v
688 c, u = self.get_account_balance(account)
691 result.append( ('', 1000, 0, c+u-balance, None, c+u-balance, None ) )
693 balance = c + u - balance
694 for tx_hash, tx in history:
695 is_relevant, is_mine, value, fee = self.get_tx_value(tx, account)
698 if value is not None:
701 conf, timestamp = self.verifier.get_confirmations(tx_hash) if self.verifier else (None, None)
702 result.append( (tx_hash, conf, is_mine, value, fee, balance, timestamp) )
706 def get_label(self, tx_hash):
707 label = self.labels.get(tx_hash)
708 is_default = (label == '') or (label is None)
709 if is_default: label = self.get_default_label(tx_hash)
710 return label, is_default
712 def get_default_label(self, tx_hash):
713 tx = self.transactions.get(tx_hash)
716 is_relevant, is_mine, _, _ = self.get_tx_value(tx)
718 for o_addr in tx.get_output_addresses():
719 if not self.is_mine(o_addr):
721 default_label = self.labels[o_addr]
723 default_label = '>' + o_addr
726 default_label = '(internal)'
728 for o_addr in tx.get_output_addresses():
729 if self.is_mine(o_addr) and not self.is_change(o_addr):
732 for o_addr in tx.get_output_addresses():
733 if self.is_mine(o_addr):
740 default_label = self.labels[o_addr]
742 default_label = '<' + o_addr
746 def make_unsigned_transaction(self, outputs, fee=None, change_addr=None, domain=None, coins=None ):
747 for type, address, x in outputs:
748 if type == 'op_return':
750 if type == 'address':
751 assert is_address(address), "Address " + address + " is invalid!"
752 amount = sum( map(lambda x:x[2], outputs) )
753 inputs, total, fee = self.choose_tx_inputs( amount, fee, len(outputs), domain, coins )
755 raise ValueError("Not enough funds")
757 self.add_input_info(txin)
758 outputs = self.add_tx_change(inputs, outputs, amount, fee, total, change_addr)
759 return Transaction(inputs, outputs)
761 def mktx(self, outputs, password, fee=None, change_addr=None, domain= None, coins = None ):
762 tx = self.make_unsigned_transaction(outputs, fee, change_addr, domain, coins)
764 self.add_keypairs(tx, keypairs, password)
766 self.sign_transaction(tx, keypairs, password)
769 def add_input_info(self, txin):
770 address = txin['address']
771 account_id, sequence = self.get_address_index(address)
772 account = self.accounts[account_id]
773 redeemScript = account.redeem_script(*sequence)
774 pubkeys = account.get_pubkeys(*sequence)
775 x_pubkeys = account.get_xpubkeys(*sequence)
776 # sort pubkeys and x_pubkeys, using the order of pubkeys
777 pubkeys, x_pubkeys = zip( *sorted(zip(pubkeys, x_pubkeys)))
778 txin['pubkeys'] = list(pubkeys)
779 txin['x_pubkeys'] = list(x_pubkeys)
780 txin['signatures'] = [None] * len(pubkeys)
783 txin['redeemScript'] = redeemScript
786 txin['redeemPubkey'] = account.get_pubkey(*sequence)
789 def sign_transaction(self, tx, keypairs, password):
791 run_hook('sign_transaction', tx, password)
793 def sendtx(self, tx):
797 return self.receive_tx(h, tx)
799 def send_tx(self, tx):
801 self.tx_event.clear()
802 self.network.send([('blockchain.transaction.broadcast', [str(tx)])], self.on_broadcast)
805 def on_broadcast(self, i, r):
806 self.tx_result = r.get('result')
809 def receive_tx(self, tx_hash, tx):
812 return False, "error: " + out
813 run_hook('receive_tx', tx, self)
816 def update_password(self, old_password, new_password):
817 if new_password == '':
821 decoded = self.get_seed(old_password)
822 self.seed = pw_encode( decoded, new_password)
823 self.storage.put('seed', self.seed, True)
825 imported_account = self.accounts.get(IMPORTED_ACCOUNT)
827 imported_account.update_password(old_password, new_password)
830 for k, v in self.master_private_keys.items():
831 b = pw_decode(v, old_password)
832 c = pw_encode(b, new_password)
833 self.master_private_keys[k] = c
834 self.storage.put('master_private_keys', self.master_private_keys, True)
836 self.use_encryption = (new_password != None)
837 self.storage.put('use_encryption', self.use_encryption,True)
839 def freeze(self,addr):
840 if self.is_mine(addr) and addr not in self.frozen_addresses:
841 self.frozen_addresses.append(addr)
842 self.storage.put('frozen_addresses', self.frozen_addresses, True)
847 def unfreeze(self,addr):
848 if self.is_mine(addr) and addr in self.frozen_addresses:
849 self.frozen_addresses.remove(addr)
850 self.storage.put('frozen_addresses', self.frozen_addresses, True)
855 def set_verifier(self, verifier):
856 self.verifier = verifier
858 # review transactions that are in the history
859 for addr, hist in self.history.items():
860 if hist == ['*']: continue
861 for tx_hash, tx_height in hist:
863 # add it in case it was previously unconfirmed
864 self.verifier.add(tx_hash, tx_height)
866 # if we are on a pruning server, remove unverified transactions
867 vr = self.verifier.transactions.keys() + self.verifier.verified_tx.keys()
868 for tx_hash in self.transactions.keys():
869 if tx_hash not in vr:
870 self.transactions.pop(tx_hash)
872 def check_new_history(self, addr, hist):
873 # check that all tx in hist are relevant
875 for tx_hash, height in hist:
876 tx = self.transactions.get(tx_hash)
878 if not tx.has_address(addr):
881 # check that we are not "orphaning" a transaction
882 old_hist = self.history.get(addr,[])
883 if old_hist == ['*']: return True
885 for tx_hash, height in old_hist:
886 if tx_hash in map(lambda x:x[0], hist): continue
888 for _addr, _hist in self.history.items():
889 if _addr == addr: continue
890 if _hist == ['*']: continue
891 _tx_hist = map(lambda x:x[0], _hist)
892 if tx_hash in _tx_hist:
897 tx = self.transactions.get(tx_hash)
898 # tx might not be there
902 if self.verifier.get_height(tx_hash):
905 print_error("new history is orphaning transaction:", tx_hash)
906 # check that all outputs are not mine, request histories
908 for _addr in tx.get_output_addresses():
909 # assert not self.is_mine(_addr)
910 ext_requests.append( ('blockchain.address.get_history', [_addr]) )
912 ext_h = self.network.synchronous_get(ext_requests)
913 print_error("sync:", ext_requests, ext_h)
916 if h == ['*']: continue
918 if item.get('tx_hash') == tx_hash:
919 height = item.get('height')
921 print_error("found height for", tx_hash, height)
922 self.verifier.add(tx_hash, height)
924 print_error("removing orphaned tx from history", tx_hash)
925 self.transactions.pop(tx_hash)
929 def check_new_tx(self, tx_hash, tx):
930 # 1 check that tx is referenced in addr_history.
932 for addr, hist in self.history.items():
933 if hist == ['*']:continue
934 for txh, height in hist:
936 addresses.append(addr)
941 # 2 check that referencing addresses are in the tx
942 for addr in addresses:
943 if not tx.has_address(addr):
948 def start_threads(self, network):
949 from verifier import TxVerifier
950 self.network = network
951 if self.network is not None:
952 self.verifier = TxVerifier(self.network, self.storage)
953 self.verifier.start()
954 self.set_verifier(self.verifier)
955 self.synchronizer = WalletSynchronizer(self, network)
956 self.synchronizer.start()
959 self.synchronizer =None
961 def stop_threads(self):
964 self.synchronizer.stop()
966 def restore(self, cb):
969 def get_accounts(self):
972 def save_accounts(self):
974 for k, v in self.accounts.items():
976 self.storage.put('accounts', d, True)
978 def can_import(self):
979 return not self.is_watching_only()
981 def is_used(self, address):
982 h = self.history.get(address,[])
983 c, u = self.get_addr_balance(address)
984 return len(h), len(h) > 0 and c == -u
986 def address_is_old(self, address, age_limit=2):
988 h = self.history.get(address, [])
991 for tx_hash, tx_height in h:
995 tx_age = self.network.get_local_height() - tx_height + 1
998 return age > age_limit
1001 class Imported_Wallet(Abstract_Wallet):
1003 def __init__(self, storage):
1004 Abstract_Wallet.__init__(self, storage)
1005 a = self.accounts.get(IMPORTED_ACCOUNT)
1007 self.accounts[IMPORTED_ACCOUNT] = ImportedAccount({'imported':{}})
1008 self.storage.put('wallet_type', 'imported', True)
1010 def is_watching_only(self):
1011 acc = self.accounts[IMPORTED_ACCOUNT]
1012 n = acc.keypairs.values()
1013 return n == [(None, None)] * len(n)
1018 def is_deterministic(self):
1021 def check_password(self, password):
1022 self.accounts[IMPORTED_ACCOUNT].get_private_key((0,0), self, password)
1024 def is_used(self, address):
1025 h = self.history.get(address,[])
1026 return len(h), False
1028 def get_master_public_keys(self):
1031 def is_beyond_limit(self, address, account, is_change):
1035 class Deterministic_Wallet(Abstract_Wallet):
1037 def __init__(self, storage):
1038 Abstract_Wallet.__init__(self, storage)
1041 return self.seed != ''
1043 def is_deterministic(self):
1046 def is_watching_only(self):
1047 return not self.has_seed()
1049 def add_seed(self, seed, password):
1051 raise Exception("a seed exists")
1053 self.seed_version, self.seed = self.prepare_seed(seed)
1055 self.seed = pw_encode( self.seed, password)
1056 self.use_encryption = True
1058 self.use_encryption = False
1060 self.storage.put('seed', self.seed, True)
1061 self.storage.put('seed_version', self.seed_version, True)
1062 self.storage.put('use_encryption', self.use_encryption,True)
1063 self.create_master_keys(password)
1065 def get_seed(self, password):
1066 return pw_decode(self.seed, password)
1068 def get_mnemonic(self, password):
1069 return self.get_seed(password)
1071 def change_gap_limit(self, value):
1072 if value >= self.gap_limit:
1073 self.gap_limit = value
1074 self.storage.put('gap_limit', self.gap_limit, True)
1075 #self.interface.poke('synchronizer')
1078 elif value >= self.min_acceptable_gap():
1079 for key, account in self.accounts.items():
1080 addresses = account[0]
1081 k = self.num_unused_trailing_addresses(addresses)
1082 n = len(addresses) - k + value
1083 addresses = addresses[0:n]
1084 self.accounts[key][0] = addresses
1086 self.gap_limit = value
1087 self.storage.put('gap_limit', self.gap_limit, True)
1088 self.save_accounts()
1093 def num_unused_trailing_addresses(self, addresses):
1095 for a in addresses[::-1]:
1096 if self.history.get(a):break
1100 def min_acceptable_gap(self):
1101 # fixme: this assumes wallet is synchronized
1105 for account in self.accounts.values():
1106 addresses = account.get_addresses(0)
1107 k = self.num_unused_trailing_addresses(addresses)
1108 for a in addresses[0:-k]:
1109 if self.history.get(a):
1113 if n > nmax: nmax = n
1116 def create_new_address(self, account=None, for_change=0):
1118 account = self.default_account()
1119 address = account.create_new_address(for_change)
1120 self.history[address] = []
1121 if self.synchronizer:
1122 self.synchronizer.add(address)
1123 self.save_accounts()
1126 def synchronize_sequence(self, account, for_change):
1127 limit = self.gap_limit_for_change if for_change else self.gap_limit
1129 addresses = account.get_addresses(for_change)
1130 if len(addresses) < limit:
1131 self.create_new_address(account, for_change)
1133 if map( lambda a: self.address_is_old(a), addresses[-limit:] ) == limit*[False]:
1136 self.create_new_address(account, for_change)
1138 def check_pending_accounts(self):
1139 for account_id, addr in self.next_addresses.items():
1140 if self.address_is_old(addr):
1141 print_error( "creating account", account_id )
1142 xpub = self.master_public_keys[account_id]
1143 account = BIP32_Account({'xpub':xpub})
1144 self.add_account(account_id, account)
1145 self.next_addresses.pop(account_id)
1147 def synchronize_account(self, account):
1148 self.synchronize_sequence(account, 0)
1149 self.synchronize_sequence(account, 1)
1151 def synchronize(self):
1152 self.check_pending_accounts()
1153 for account in self.accounts.values():
1154 if type(account) in [ImportedAccount, PendingAccount]:
1156 self.synchronize_account(account)
1158 def restore(self, callback):
1160 def wait_for_wallet():
1161 self.set_up_to_date(False)
1162 while not self.is_up_to_date():
1163 msg = "%s\n%s %d\n%s %.1f"%(
1164 _("Please wait..."),
1165 _("Addresses generated:"),
1166 len(self.addresses(True)),
1167 _("Kilobytes received:"),
1168 self.network.interface.bytes_received/1024.)
1170 apply(callback, (msg,))
1173 def wait_for_network():
1174 while not self.network.is_connected():
1175 msg = "%s \n" % (_("Connecting..."))
1176 apply(callback, (msg,))
1179 # wait until we are connected, because the user might have selected another server
1185 self.fill_addressbook()
1187 def create_account(self, name, password):
1188 i = self.num_accounts()
1189 account_id = self.account_id(i)
1190 account = self.make_account(account_id, password)
1191 self.add_account(account_id, account)
1193 self.set_label(account_id, name)
1195 # add address of the next account
1196 _, _ = self.next_account_address(password)
1199 def add_account(self, account_id, account):
1200 self.accounts[account_id] = account
1201 self.save_accounts()
1203 def account_is_pending(self, k):
1204 return type(self.accounts.get(k)) == PendingAccount
1206 def delete_pending_account(self, k):
1207 assert self.account_is_pending(k)
1208 self.accounts.pop(k)
1209 self.save_accounts()
1211 def create_pending_account(self, name, password):
1212 account_id, addr = self.next_account_address(password)
1213 self.set_label(account_id, name)
1214 self.accounts[account_id] = PendingAccount({'pending':addr})
1215 self.save_accounts()
1217 def is_beyond_limit(self, address, account, is_change):
1218 if type(account) == ImportedAccount:
1220 addr_list = account.get_addresses(is_change)
1221 i = addr_list.index(address)
1222 prev_addresses = addr_list[:max(0, i)]
1223 limit = self.gap_limit_for_change if is_change else self.gap_limit
1224 if len(prev_addresses) < limit:
1226 prev_addresses = prev_addresses[max(0, i - limit):]
1227 for addr in prev_addresses:
1228 if self.history.get(addr):
1232 def get_action(self):
1233 if not self.get_master_public_key():
1234 return 'create_seed'
1235 if not self.accounts:
1236 return 'create_accounts'
1239 class NewWallet(Deterministic_Wallet):
1241 def __init__(self, storage):
1242 Deterministic_Wallet.__init__(self, storage)
1243 self.master_public_keys = storage.get('master_public_keys', {})
1244 self.master_private_keys = storage.get('master_private_keys', {})
1246 def default_account(self):
1247 return self.accounts["m/0'"]
1249 def is_watching_only(self):
1250 return not bool(self.master_private_keys)
1252 def can_create_accounts(self):
1253 return 'm/' in self.master_private_keys.keys()
1255 def get_master_public_key(self):
1256 """xpub of the main account"""
1257 return self.master_public_keys.get("m/0'")
1259 def get_master_public_keys(self):
1261 for k, account in self.accounts.items():
1262 name = self.get_account_name(k)
1263 mpk_text = '\n\n'.join( account.get_master_pubkeys() )
1264 out[name] = mpk_text
1267 def get_master_private_key(self, account, password):
1268 k = self.master_private_keys.get(account)
1270 xpriv = pw_decode( k, password)
1273 def check_password(self, password):
1274 xpriv = self.get_master_private_key( "m/", password )
1275 xpub = self.master_public_keys["m/"]
1276 assert deserialize_xkey(xpriv)[3] == deserialize_xkey(xpub)[3]
1278 def create_xprv_wallet(self, xprv, password):
1279 xpub = bitcoin.xpub_from_xprv(xprv)
1280 account = BIP32_Account({'xpub':xpub})
1281 account_id = 'm/' + bitcoin.get_xkey_name(xpub)
1282 self.storage.put('seed_version', self.seed_version, True)
1283 self.add_master_private_key(account_id, xprv, password)
1284 self.add_master_public_key(account_id, xpub)
1285 self.add_account(account_id, account)
1287 def create_watching_only_wallet(self, xpub):
1288 account = BIP32_Account({'xpub':xpub})
1289 account_id = 'm/' + bitcoin.get_xkey_name(xpub)
1290 self.storage.put('seed_version', self.seed_version, True)
1291 self.add_master_public_key(account_id, xpub)
1292 self.add_account(account_id, account)
1294 def create_accounts(self, password):
1295 # First check the password is valid (this raises if it isn't).
1296 if not self.is_watching_only():
1297 self.check_password(password)
1298 self.create_account('Main account', password)
1300 def add_master_public_key(self, name, xpub):
1301 self.master_public_keys[name] = xpub
1302 self.storage.put('master_public_keys', self.master_public_keys, True)
1304 def add_master_private_key(self, name, xpriv, password):
1305 self.master_private_keys[name] = pw_encode(xpriv, password)
1306 self.storage.put('master_private_keys', self.master_private_keys, True)
1308 def add_master_keys(self, root, account_id, password):
1309 x = self.master_private_keys.get(root)
1311 master_xpriv = pw_decode(x, password )
1312 xpriv, xpub = bip32_private_derivation(master_xpriv, root, account_id)
1313 self.add_master_public_key(account_id, xpub)
1314 self.add_master_private_key(account_id, xpriv, password)
1316 master_xpub = self.master_public_keys[root]
1317 xpub = bip32_public_derivation(master_xpub, root, account_id)
1318 self.add_master_public_key(account_id, xpub)
1321 def create_master_keys(self, password):
1322 xpriv, xpub = bip32_root(mnemonic_to_seed(self.get_seed(password),'').encode('hex'))
1323 self.add_master_public_key("m/", xpub)
1324 self.add_master_private_key("m/", xpriv, password)
1326 def can_sign(self, tx):
1327 if self.is_watching_only():
1329 if tx.is_complete():
1331 addr_list, xpub_list = tx.inputs_to_sign()
1332 for addr in addr_list:
1333 if self.is_mine(addr):
1335 mpk = [ self.master_public_keys[k] for k in self.master_private_keys.keys() ]
1336 for xpub, sequence in xpub_list:
1341 def find_root_by_master_key(self, xpub):
1342 for key, xpub2 in self.master_public_keys.items():
1343 if key == "m/":continue
1347 def num_accounts(self):
1349 for k, v in self.accounts.items():
1350 if type(v) != BIP32_Account:
1356 account_id = self.account_id(i)
1357 if account_id not in keys: break
1361 def next_account_address(self, password):
1362 i = self.num_accounts()
1363 account_id = self.account_id(i)
1365 addr = self.next_addresses.get(account_id)
1367 account = self.make_account(account_id, password)
1368 addr = account.first_address()
1369 self.next_addresses[account_id] = addr
1370 self.storage.put('next_addresses', self.next_addresses)
1372 return account_id, addr
1374 def account_id(self, i):
1377 def make_account(self, account_id, password):
1378 """Creates and saves the master keys, but does not save the account"""
1379 xpub = self.add_master_keys("m/", account_id, password)
1380 account = BIP32_Account({'xpub':xpub})
1383 def make_seed(self):
1384 import mnemonic, ecdsa
1385 entropy = ecdsa.util.randrange( pow(2,160) )
1388 ss = "%040x"%(entropy+nonce)
1389 s = hashlib.sha256(ss.decode('hex')).digest().encode('hex')
1390 # we keep only 13 words, that's approximately 139 bits of entropy
1391 words = mnemonic.mn_encode(s)[0:13]
1392 seed = ' '.join(words)
1393 if is_new_seed(seed):
1394 break # this will remove 8 bits of entropy
1398 def prepare_seed(self, seed):
1400 return NEW_SEED_VERSION, unicodedata.normalize('NFC', unicode(seed.strip()))
1403 class Wallet_2of2(NewWallet):
1404 """ This class is used for multisignature addresses"""
1406 def __init__(self, storage):
1407 NewWallet.__init__(self, storage)
1408 self.storage.put('wallet_type', '2of2', True)
1410 def default_account(self):
1411 return self.accounts['m/']
1413 def can_create_accounts(self):
1416 def can_import(self):
1419 def create_account(self, name, password):
1420 xpub1 = self.master_public_keys.get("m/")
1421 xpub2 = self.master_public_keys.get("cold/")
1422 account = BIP32_Account_2of2({'xpub':xpub1, 'xpub2':xpub2})
1423 self.add_account('m/', account)
1425 def get_master_public_keys(self):
1426 xpub1 = self.master_public_keys.get("m/")
1427 xpub2 = self.master_public_keys.get("cold/")
1428 return {'hot':xpub1, 'cold':xpub2}
1430 def get_action(self):
1431 xpub1 = self.master_public_keys.get("m/")
1432 xpub2 = self.master_public_keys.get("cold/")
1434 return 'create_seed'
1436 return 'add_cosigner'
1437 if not self.accounts:
1438 return 'create_accounts'
1441 class Wallet_2of3(Wallet_2of2):
1442 """ This class is used for multisignature addresses"""
1444 def __init__(self, storage):
1445 Wallet_2of2.__init__(self, storage)
1446 self.storage.put('wallet_type', '2of3', True)
1448 def create_account(self, name, password):
1449 xpub1 = self.master_public_keys.get("m/")
1450 xpub2 = self.master_public_keys.get("cold/")
1451 xpub3 = self.master_public_keys.get("remote/")
1452 account = BIP32_Account_2of3({'xpub':xpub1, 'xpub2':xpub2, 'xpub3':xpub3})
1453 self.add_account('m/', account)
1455 def get_master_public_keys(self):
1456 xpub1 = self.master_public_keys.get("m/")
1457 xpub2 = self.master_public_keys.get("cold/")
1458 xpub3 = self.master_public_keys.get("remote/")
1459 return {'hot':xpub1, 'cold':xpub2, 'remote':xpub3}
1461 def get_action(self):
1462 xpub1 = self.master_public_keys.get("m/")
1463 xpub2 = self.master_public_keys.get("cold/")
1464 xpub3 = self.master_public_keys.get("remote/")
1466 return 'create_seed'
1467 if xpub2 is None or xpub3 is None:
1468 return 'add_two_cosigners'
1469 if not self.accounts:
1470 return 'create_accounts'
1473 class OldWallet(Deterministic_Wallet):
1475 def default_account(self):
1476 return self.accounts[0]
1478 def make_seed(self):
1480 seed = random_seed(128)
1481 return ' '.join(mnemonic.mn_encode(seed))
1483 def prepare_seed(self, seed):
1485 # see if seed was entered as hex
1490 return OLD_SEED_VERSION, str(seed)
1494 words = seed.split()
1495 seed = mnemonic.mn_decode(words)
1497 raise Exception("Invalid seed")
1499 return OLD_SEED_VERSION, seed
1501 def create_master_keys(self, password):
1502 seed = self.get_seed(password)
1503 mpk = OldAccount.mpk_from_seed(seed)
1504 self.storage.put('master_public_key', mpk, True)
1506 def get_master_public_key(self):
1507 return self.storage.get("master_public_key")
1509 def get_master_public_keys(self):
1510 return {'Main Account':self.get_master_public_key()}
1512 def create_accounts(self, password):
1513 mpk = self.storage.get("master_public_key")
1514 self.create_account(mpk)
1516 def create_account(self, mpk):
1517 self.accounts[0] = OldAccount({'mpk':mpk, 0:[], 1:[]})
1518 self.save_accounts()
1520 def create_watching_only_wallet(self, mpk):
1521 self.seed_version = OLD_SEED_VERSION
1522 self.storage.put('seed_version', self.seed_version, True)
1523 self.storage.put('master_public_key', mpk, True)
1524 self.create_account(mpk)
1526 def get_seed(self, password):
1527 seed = pw_decode(self.seed, password).encode('utf8')
1530 def check_password(self, password):
1531 seed = self.get_seed(password)
1532 self.accounts[0].check_seed(seed)
1534 def get_mnemonic(self, password):
1536 s = self.get_seed(password)
1537 return ' '.join(mnemonic.mn_encode(s))
1539 def check_pending_accounts(self):
1542 def can_sign(self, tx):
1543 if self.is_watching_only():
1545 if tx.is_complete():
1547 addr_list, xpub_list = tx.inputs_to_sign()
1548 for addr in addr_list:
1549 if self.is_mine(addr):
1551 for xpub, sequence in xpub_list:
1552 if xpub == self.master_public_key:
1556 # former WalletFactory
1557 class Wallet(object):
1558 """The main wallet "entry point".
1559 This class is actually a factory that will return a wallet of the correct
1560 type when passed a WalletStorage instance."""
1562 def __new__(self, storage):
1563 config = storage.config
1565 self.wallet_types = [
1566 ('standard', ("Standard wallet"), NewWallet if config.get('bip32') else OldWallet),
1567 ('imported', ("Imported wallet"), Imported_Wallet),
1568 ('2of2', ("Multisig wallet (2 of 2)"), Wallet_2of2),
1569 ('2of3', ("Multisig wallet (2 of 3)"), Wallet_2of3)
1571 run_hook('add_wallet_types', self.wallet_types)
1573 for t, l, WalletClass in self.wallet_types:
1574 if t == storage.get('wallet_type'):
1575 return WalletClass(storage)
1577 if not storage.file_exists:
1578 seed_version = NEW_SEED_VERSION if config.get('bip32') is True else OLD_SEED_VERSION
1580 seed_version = storage.get('seed_version')
1581 if not seed_version:
1582 seed_version = OLD_SEED_VERSION if len(storage.get('master_public_key')) == 128 else NEW_SEED_VERSION
1584 if seed_version == OLD_SEED_VERSION:
1585 return OldWallet(storage)
1586 elif seed_version == NEW_SEED_VERSION:
1587 return NewWallet(storage)
1589 msg = "This wallet seed is not supported."
1590 if seed_version in [5]:
1591 msg += "\nTo open this wallet, try 'git checkout seed_v%d'"%seed_version
1596 def is_seed(self, seed):
1599 elif is_old_seed(seed):
1601 elif is_new_seed(seed):
1607 def is_old_mpk(self, mpk):
1610 assert len(mpk) == 128
1616 def is_xpub(self, text):
1618 assert text[0:4] == 'xpub'
1619 deserialize_xkey(text)
1625 def is_xprv(self, text):
1627 assert text[0:4] == 'xprv'
1628 deserialize_xkey(text)
1634 def is_address(self, text):
1637 for x in text.split():
1638 if not bitcoin.is_address(x):
1643 def is_private_key(self, text):
1646 for x in text.split():
1647 if not bitcoin.is_private_key(x):
1652 def from_seed(self, seed, storage):
1653 if is_old_seed(seed):
1655 elif is_new_seed(seed):
1661 def from_address(self, text, storage):
1662 w = Imported_Wallet(storage)
1663 for x in text.split():
1664 w.accounts[IMPORTED_ACCOUNT].add(x, None, None, None)
1669 def from_private_key(self, text, storage):
1670 w = Imported_Wallet(storage)
1671 for x in text.split():
1672 w.import_key(x, None)
1676 def from_old_mpk(self, mpk, storage):
1677 w = OldWallet(storage)
1679 w.create_watching_only_wallet(mpk)
1683 def from_xpub(self, xpub, storage):
1684 w = NewWallet(storage)
1685 w.create_watching_only_wallet(xpub)
1689 def from_xprv(self, xprv, password, storage):
1690 w = NewWallet(storage)
1691 w.create_xprv_wallet(xprv, password)