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'
49 def __init__(self, config):
50 self.lock = threading.Lock()
53 self.file_exists = False
54 self.path = self.init_path(config)
55 print_error( "wallet path", self.path )
60 def init_path(self, config):
61 """Set the path of the wallet."""
63 # command line -w option
64 path = config.get('wallet_path')
69 path = config.get('default_wallet_path')
74 dirpath = os.path.join(config.path, "wallets")
75 if not os.path.exists(dirpath):
78 new_path = os.path.join(config.path, "wallets", "default_wallet")
80 # default path in pre 1.9 versions
81 old_path = os.path.join(config.path, "electrum.dat")
82 if os.path.exists(old_path) and not os.path.exists(new_path):
83 os.rename(old_path, new_path)
89 """Read the contents of the wallet file."""
91 with open(self.path, "r") as f:
96 d = ast.literal_eval( data ) #parse raw data from reading wallet file
98 raise IOError("Cannot read wallet file.")
101 self.file_exists = True
104 def get(self, key, default=None):
105 v = self.data.get(key)
110 def put(self, key, value, save = True):
113 if value is not None:
114 self.data[key] = value
115 elif key in self.data:
122 f = open(self.path,"w")
125 if 'ANDROID_DATA' not in os.environ:
127 os.chmod(self.path,stat.S_IREAD | stat.S_IWRITE)
130 class Abstract_Wallet:
132 Wallet classes are created to handle various address generation methods.
133 Completion states (watching-only, single account, no seed, etc) are handled inside classes.
136 def __init__(self, storage):
137 self.storage = storage
138 self.electrum_version = ELECTRUM_VERSION
139 self.gap_limit_for_change = 3 # constant
141 self.seed_version = storage.get('seed_version', NEW_SEED_VERSION)
142 self.gap_limit = storage.get('gap_limit', 5)
143 self.use_change = storage.get('use_change',True)
144 self.use_encryption = storage.get('use_encryption', False)
145 self.seed = storage.get('seed', '') # encrypted
146 self.labels = storage.get('labels', {})
147 self.frozen_addresses = storage.get('frozen_addresses',[])
148 self.addressbook = storage.get('contacts', [])
150 self.history = storage.get('addr_history',{}) # address -> list(txid, height)
152 self.fee = int(storage.get('fee_per_kb', 10000))
154 self.master_public_keys = storage.get('master_public_keys',{})
155 self.master_private_keys = storage.get('master_private_keys', {})
157 self.next_addresses = storage.get('next_addresses',{})
160 # This attribute is set when wallet.start_threads is called.
161 self.synchronizer = None
165 self.transactions = {}
166 tx_list = self.storage.get('transactions',{})
167 for k,v in tx_list.items():
171 print_msg("Warning: Cannot deserialize transactions. skipping")
174 self.add_extra_addresses(tx)
175 self.transactions[k] = tx
177 for h,tx in self.transactions.items():
178 if not self.check_new_tx(h, tx):
179 print_error("removing unreferenced tx", h)
180 self.transactions.pop(h)
184 self.prevout_values = {} # my own transaction outputs
185 self.spent_outputs = []
190 # there is a difference between wallet.up_to_date and interface.is_up_to_date()
191 # interface.is_up_to_date() returns true when all requests have been answered and processed
192 # wallet.up_to_date is true when the wallet is synchronized (stronger requirement)
194 self.up_to_date = False
195 self.lock = threading.Lock()
196 self.transaction_lock = threading.Lock()
197 self.tx_event = threading.Event()
198 for tx_hash, tx in self.transactions.items():
199 self.update_tx_outputs(tx_hash)
201 def add_extra_addresses(self, tx):
203 # find the address corresponding to pay-to-pubkey inputs
204 tx.add_extra_addresses(self.transactions)
205 for o in tx.d.get('outputs'):
206 if o.get('is_pubkey'):
207 for tx2 in self.transactions.values():
208 tx2.add_extra_addresses({h:tx})
210 def get_action(self):
213 def convert_imported_keys(self, password):
214 for k, v in self.imported_keys.items():
215 sec = pw_decode(v, password)
216 pubkey = public_key_from_private_key(sec)
217 address = public_key_to_bc_address(pubkey.decode('hex'))
219 self.import_key(sec, password)
220 self.imported_keys.pop(k)
221 self.storage.put('imported_keys', self.imported_keys)
223 def load_accounts(self):
225 self.imported_keys = self.storage.get('imported_keys',{})
227 d = self.storage.get('accounts', {})
228 for k, v in d.items():
230 v['mpk'] = self.storage.get('master_public_key')
231 self.accounts[k] = OldAccount(v)
232 elif v.get('imported'):
233 self.accounts[k] = ImportedAccount(v)
235 self.accounts[k] = BIP32_Account_2of3(v)
237 self.accounts[k] = BIP32_Account_2of2(v)
239 self.accounts[k] = BIP32_Account(v)
240 elif v.get('pending'):
241 self.accounts[k] = PendingAccount(v)
243 print_error("cannot load account", v)
245 def synchronize(self):
248 def can_create_accounts(self):
251 def set_up_to_date(self,b):
252 with self.lock: self.up_to_date = b
254 def is_up_to_date(self):
255 with self.lock: return self.up_to_date
258 self.up_to_date = False
259 while not self.is_up_to_date():
262 def is_imported(self, addr):
263 account = self.accounts.get(IMPORTED_ACCOUNT)
265 return addr in account.get_addresses(0)
269 def has_imported_keys(self):
270 account = self.accounts.get(IMPORTED_ACCOUNT)
271 return account is not None
273 def import_key(self, sec, password):
275 pubkey = public_key_from_private_key(sec)
276 address = public_key_to_bc_address(pubkey.decode('hex'))
278 raise Exception('Invalid private key')
280 if self.is_mine(address):
281 raise Exception('Address already in wallet')
283 if self.accounts.get(IMPORTED_ACCOUNT) is None:
284 self.accounts[IMPORTED_ACCOUNT] = ImportedAccount({'imported':{}})
285 self.accounts[IMPORTED_ACCOUNT].add(address, pubkey, sec, password)
288 if self.synchronizer:
289 self.synchronizer.subscribe_to_addresses([address])
292 def delete_imported_key(self, addr):
293 account = self.accounts[IMPORTED_ACCOUNT]
295 if not account.get_addresses(0):
296 self.accounts.pop(IMPORTED_ACCOUNT)
299 def set_label(self, name, text = None):
301 old_text = self.labels.get(name)
304 self.labels[name] = text
308 self.labels.pop(name)
312 self.storage.put('labels', self.labels, True)
314 run_hook('set_label', name, text, changed)
317 def addresses(self, include_change = True, _next=True):
319 for a in self.accounts.keys():
320 o += self.get_account_addresses(a, include_change)
323 for addr in self.next_addresses.values():
328 def is_mine(self, address):
329 return address in self.addresses(True)
331 def is_change(self, address):
332 if not self.is_mine(address): return False
333 acct, s = self.get_address_index(address)
334 if s is None: return False
337 def get_address_index(self, address):
339 for account in self.accounts.keys():
340 for for_change in [0,1]:
341 addresses = self.accounts[account].get_addresses(for_change)
342 for addr in addresses:
344 return account, (for_change, addresses.index(addr))
346 for k,v in self.next_addresses.items():
350 raise Exception("Address not found", address)
352 def getpubkeys(self, addr):
353 assert is_valid(addr) and self.is_mine(addr)
354 account, sequence = self.get_address_index(addr)
355 a = self.accounts[account]
356 return a.get_pubkeys( sequence )
358 def get_private_key(self, address, password):
359 if self.is_watching_only():
361 account_id, sequence = self.get_address_index(address)
362 return self.accounts[account_id].get_private_key(sequence, self, password)
364 def get_public_keys(self, address):
365 account_id, sequence = self.get_address_index(address)
366 return self.accounts[account_id].get_pubkeys(sequence)
368 def can_sign(self, tx):
370 if self.is_watching_only():
376 addr_list, xpub_list = tx.inputs_to_sign()
377 for addr in addr_list:
378 if self.is_mine(addr):
381 mpk = [ self.master_public_keys[k] for k in self.master_private_keys.keys() ]
382 for xpub, sequence in xpub_list:
388 def add_keypairs(self, tx, keypairs, password):
389 # first check the provided password. This will raise if invalid.
390 self.check_password(password)
392 addr_list, xpub_list = tx.inputs_to_sign()
393 for addr in addr_list:
394 if self.is_mine(addr):
395 private_keys = self.get_private_key(addr, password)
396 for sec in private_keys:
397 pubkey = public_key_from_private_key(sec)
398 keypairs[ pubkey ] = sec
400 for xpub, sequence in xpub_list:
401 # look for account that can sign
402 for k, account in self.accounts.items():
403 if xpub in account.get_master_pubkeys():
408 addr = account.get_address(*sequence)
409 pk = self.get_private_key(addr, password)
411 pubkey = public_key_from_private_key(sec)
412 keypairs[pubkey] = sec
414 def signrawtransaction(self, tx, private_keys, password):
415 # check that the password is correct. This will raise if it's not.
416 self.get_seed(password)
418 # build a list of public/private keys
421 # add private keys from parameter
422 for sec in private_keys:
423 pubkey = public_key_from_private_key(sec)
424 keypairs[ pubkey ] = sec
427 self.add_keypairs(tx, keypairs, password)
429 # sign the transaction
430 self.sign_transaction(tx, keypairs, password)
432 def sign_message(self, address, message, password):
433 keys = self.get_private_key(address, password)
434 assert len(keys) == 1
436 key = regenerate_key(sec)
437 compressed = is_compressed(sec)
438 return key.sign_message(message, compressed, address)
440 def decrypt_message(self, pubkey, message, password):
441 address = public_key_to_bc_address(pubkey.decode('hex'))
442 keys = self.get_private_key(address, password)
444 ec = regenerate_key(secret)
445 decrypted = ec.decrypt_message(message)
449 return self.history.values() != [[]] * len(self.history)
451 def add_contact(self, address, label=None):
452 self.addressbook.append(address)
453 self.storage.put('contacts', self.addressbook, True)
455 self.set_label(address, label)
457 def delete_contact(self, addr):
458 if addr in self.addressbook:
459 self.addressbook.remove(addr)
460 self.storage.put('addressbook', self.addressbook, True)
462 def fill_addressbook(self):
463 for tx_hash, tx in self.transactions.items():
464 is_relevant, is_send, _, _ = self.get_tx_value(tx)
466 for addr, v in tx.outputs:
467 if not self.is_mine(addr) and addr not in self.addressbook:
468 self.addressbook.append(addr)
470 # self.update_tx_labels()
472 def get_num_tx(self, address):
474 for tx in self.transactions.values():
475 if address in map(lambda x:x[0], tx.outputs): n += 1
478 def get_address_flags(self, addr):
479 flags = "C" if self.is_change(addr) else "I" if addr in self.imported_keys.keys() else "-"
480 flags += "F" if addr in self.frozen_addresses else "-"
483 def get_tx_value(self, tx, account=None):
484 domain = self.get_account_addresses(account)
485 return tx.get_value(domain, self.prevout_values)
487 def update_tx_outputs(self, tx_hash):
488 tx = self.transactions.get(tx_hash)
490 for i, (addr, value) in enumerate(tx.outputs):
491 key = tx_hash+ ':%d'%i
492 self.prevout_values[key] = value
494 for item in tx.inputs:
495 if self.is_mine(item.get('address')):
496 key = item['prevout_hash'] + ':%d'%item['prevout_n']
497 self.spent_outputs.append(key)
499 def get_addr_balance(self, address):
500 #assert self.is_mine(address)
501 h = self.history.get(address,[])
502 if h == ['*']: return 0,0
504 received_coins = [] # list of coins received at address
506 for tx_hash, tx_height in h:
507 tx = self.transactions.get(tx_hash)
510 for i, (addr, value) in enumerate(tx.outputs):
512 key = tx_hash + ':%d'%i
513 received_coins.append(key)
515 for tx_hash, tx_height in h:
516 tx = self.transactions.get(tx_hash)
520 for item in tx.inputs:
521 addr = item.get('address')
523 key = item['prevout_hash'] + ':%d'%item['prevout_n']
524 value = self.prevout_values.get( key )
525 if key in received_coins:
528 for i, (addr, value) in enumerate(tx.outputs):
529 key = tx_hash + ':%d'%i
539 def get_account_name(self, k):
540 return self.labels.get(k, self.accounts[k].get_name(k))
542 def get_account_names(self):
544 for k in self.accounts.keys():
545 account_names[k] = self.get_account_name(k)
548 def get_account_addresses(self, a, include_change=True):
550 o = self.addresses(True)
551 elif a in self.accounts:
552 ac = self.accounts[a]
553 o = ac.get_addresses(0)
554 if include_change: o += ac.get_addresses(1)
557 def get_account_balance(self, account):
558 return self.get_balance(self.get_account_addresses(account))
560 def get_frozen_balance(self):
561 return self.get_balance(self.frozen_addresses)
563 def get_balance(self, domain=None):
564 if domain is None: domain = self.addresses(True)
567 c, u = self.get_addr_balance(addr)
572 def get_unspent_coins(self, domain=None):
574 if domain is None: domain = self.addresses(True)
576 h = self.history.get(addr, [])
577 if h == ['*']: continue
578 for tx_hash, tx_height in h:
579 tx = self.transactions.get(tx_hash)
580 if tx is None: raise Exception("Wallet not synchronized")
581 is_coinbase = tx.inputs[0].get('prevout_hash') == '0'*64
582 for o in tx.d.get('outputs'):
584 if output.get('address') != addr: continue
585 key = tx_hash + ":%d" % output.get('prevout_n')
586 if key in self.spent_outputs: continue
587 output['prevout_hash'] = tx_hash
588 output['height'] = tx_height
589 output['coinbase'] = is_coinbase
590 coins.append((tx_height, output))
594 coins = sorted(coins)
595 if coins[-1][0] != 0:
596 while coins[0][0] == 0:
597 coins = coins[1:] + [ coins[0] ]
598 return [x[1] for x in coins]
600 def choose_tx_inputs( self, amount, fixed_fee, num_outputs, domain = None, coins = None ):
601 """ todo: minimize tx size """
603 fee = self.fee if fixed_fee is None else fixed_fee
607 domain = self.addresses(True)
608 for i in self.frozen_addresses:
609 if i in domain: domain.remove(i)
610 coins = self.get_unspent_coins(domain)
615 if item.get('coinbase') and item.get('height') + COINBASE_MATURITY > self.network.get_local_height():
617 v = item.get('value')
620 fee = self.estimated_fee(inputs, num_outputs) if fixed_fee is None else fixed_fee
621 if total >= amount + fee: break
625 return inputs, total, fee
627 def set_fee(self, fee):
630 self.storage.put('fee_per_kb', self.fee, True)
632 def estimated_fee(self, inputs, num_outputs):
633 estimated_size = len(inputs) * 180 + num_outputs * 34 # this assumes non-compressed keys
634 fee = self.fee * int(math.ceil(estimated_size/1000.))
637 def add_tx_change( self, inputs, outputs, amount, fee, total, change_addr=None):
638 "add change to a transaction"
639 change_amount = total - ( amount + fee )
640 if change_amount > DUST_THRESHOLD:
643 # send change to one of the accounts involved in the tx
644 address = inputs[0].get('address')
645 account, _ = self.get_address_index(address)
647 if not self.use_change or account == IMPORTED_ACCOUNT:
648 change_addr = inputs[-1]['address']
650 change_addr = self.accounts[account].get_addresses(1)[-self.gap_limit_for_change]
652 # Insert the change output at a random position in the outputs
653 posn = random.randint(0, len(outputs))
654 outputs[posn:posn] = [( change_addr, change_amount)]
657 def get_history(self, address):
659 return self.history.get(address)
661 def get_status(self, h):
662 if not h: return None
663 if h == ['*']: return '*'
665 for tx_hash, height in h:
666 status += tx_hash + ':%d:' % height
667 return hashlib.sha256( status ).digest().encode('hex')
669 def receive_tx_callback(self, tx_hash, tx, tx_height):
671 with self.transaction_lock:
672 self.add_extra_addresses(tx)
673 if not self.check_new_tx(tx_hash, tx):
674 # may happen due to pruning
675 print_error("received transaction that is no longer referenced in history", tx_hash)
677 self.transactions[tx_hash] = tx
678 self.network.pending_transactions_for_notifications.append(tx)
679 self.save_transactions()
680 if self.verifier and tx_height>0:
681 self.verifier.add(tx_hash, tx_height)
682 self.update_tx_outputs(tx_hash)
684 def save_transactions(self):
686 for k,v in self.transactions.items():
688 self.storage.put('transactions', tx, True)
690 def receive_history_callback(self, addr, hist):
692 if not self.check_new_history(addr, hist):
693 raise Exception("error: received history for %s is not consistent with known transactions"%addr)
696 self.history[addr] = hist
697 self.storage.put('addr_history', self.history, True)
700 for tx_hash, tx_height in hist:
702 # add it in case it was previously unconfirmed
703 if self.verifier: self.verifier.add(tx_hash, tx_height)
705 def get_tx_history(self, account=None):
706 if not self.verifier:
709 with self.transaction_lock:
710 history = self.transactions.items()
711 history.sort(key = lambda x: self.verifier.get_txpos(x[0]))
715 for tx_hash, tx in history:
716 is_relevant, is_mine, v, fee = self.get_tx_value(tx, account)
717 if v is not None: balance += v
719 c, u = self.get_account_balance(account)
722 result.append( ('', 1000, 0, c+u-balance, None, c+u-balance, None ) )
724 balance = c + u - balance
725 for tx_hash, tx in history:
726 is_relevant, is_mine, value, fee = self.get_tx_value(tx, account)
729 if value is not None:
732 conf, timestamp = self.verifier.get_confirmations(tx_hash) if self.verifier else (None, None)
733 result.append( (tx_hash, conf, is_mine, value, fee, balance, timestamp) )
737 def get_label(self, tx_hash):
738 label = self.labels.get(tx_hash)
739 is_default = (label == '') or (label is None)
740 if is_default: label = self.get_default_label(tx_hash)
741 return label, is_default
743 def get_default_label(self, tx_hash):
744 tx = self.transactions.get(tx_hash)
747 is_relevant, is_mine, _, _ = self.get_tx_value(tx)
751 if not self.is_mine(o_addr):
753 default_label = self.labels[o_addr]
755 default_label = '>' + o_addr
758 default_label = '(internal)'
762 if self.is_mine(o_addr) and not self.is_change(o_addr):
767 if self.is_mine(o_addr):
774 default_label = self.labels[o_addr]
776 default_label = '<' + o_addr
780 def make_unsigned_transaction(self, outputs, fee=None, change_addr=None, domain=None, coins=None ):
781 for address, x in outputs:
782 assert is_valid(address), "Address " + address + " is invalid!"
783 amount = sum( map(lambda x:x[1], outputs) )
784 inputs, total, fee = self.choose_tx_inputs( amount, fee, len(outputs), domain, coins )
786 raise ValueError("Not enough funds")
788 self.add_input_info(txin)
789 outputs = self.add_tx_change(inputs, outputs, amount, fee, total, change_addr)
790 return Transaction.from_io(inputs, outputs)
792 def mktx(self, outputs, password, fee=None, change_addr=None, domain= None, coins = None ):
793 tx = self.make_unsigned_transaction(outputs, fee, change_addr, domain, coins)
795 self.add_keypairs(tx, keypairs, password)
797 self.sign_transaction(tx, keypairs, password)
800 def add_input_info(self, txin):
801 address = txin['address']
802 account_id, sequence = self.get_address_index(address)
803 account = self.accounts[account_id]
804 redeemScript = account.redeem_script(sequence)
805 txin['x_pubkeys'] = account.get_xpubkeys(sequence)
806 txin['pubkeys'] = pubkeys = account.get_pubkeys(sequence)
807 txin['signatures'] = [None] * len(pubkeys)
810 txin['redeemScript'] = redeemScript
813 txin['redeemPubkey'] = account.get_pubkey(*sequence)
816 def sign_transaction(self, tx, keypairs, password):
818 run_hook('sign_transaction', tx, password)
820 def sendtx(self, tx):
824 return self.receive_tx(h, tx)
826 def send_tx(self, tx):
828 self.tx_event.clear()
829 self.network.send([('blockchain.transaction.broadcast', [str(tx)])], self.on_broadcast)
832 def on_broadcast(self, i, r):
833 self.tx_result = r.get('result')
836 def receive_tx(self, tx_hash, tx):
839 return False, "error: " + out
840 run_hook('receive_tx', tx, self)
843 def update_password(self, old_password, new_password):
844 if new_password == '':
848 decoded = self.get_seed(old_password)
849 self.seed = pw_encode( decoded, new_password)
850 self.storage.put('seed', self.seed, True)
852 imported_account = self.accounts.get(IMPORTED_ACCOUNT)
854 imported_account.update_password(old_password, new_password)
857 for k, v in self.master_private_keys.items():
858 b = pw_decode(v, old_password)
859 c = pw_encode(b, new_password)
860 self.master_private_keys[k] = c
861 self.storage.put('master_private_keys', self.master_private_keys, True)
863 self.use_encryption = (new_password != None)
864 self.storage.put('use_encryption', self.use_encryption,True)
866 def freeze(self,addr):
867 if self.is_mine(addr) and addr not in self.frozen_addresses:
868 self.frozen_addresses.append(addr)
869 self.storage.put('frozen_addresses', self.frozen_addresses, True)
874 def unfreeze(self,addr):
875 if self.is_mine(addr) and addr in self.frozen_addresses:
876 self.frozen_addresses.remove(addr)
877 self.storage.put('frozen_addresses', self.frozen_addresses, True)
882 def set_verifier(self, verifier):
883 self.verifier = verifier
885 # review transactions that are in the history
886 for addr, hist in self.history.items():
887 if hist == ['*']: continue
888 for tx_hash, tx_height in hist:
890 # add it in case it was previously unconfirmed
891 self.verifier.add(tx_hash, tx_height)
893 # if we are on a pruning server, remove unverified transactions
894 vr = self.verifier.transactions.keys() + self.verifier.verified_tx.keys()
895 for tx_hash in self.transactions.keys():
896 if tx_hash not in vr:
897 self.transactions.pop(tx_hash)
899 def check_new_history(self, addr, hist):
900 # check that all tx in hist are relevant
902 for tx_hash, height in hist:
903 tx = self.transactions.get(tx_hash)
905 if not tx.has_address(addr):
908 # check that we are not "orphaning" a transaction
909 old_hist = self.history.get(addr,[])
910 if old_hist == ['*']: return True
912 for tx_hash, height in old_hist:
913 if tx_hash in map(lambda x:x[0], hist): continue
915 for _addr, _hist in self.history.items():
916 if _addr == addr: continue
917 if _hist == ['*']: continue
918 _tx_hist = map(lambda x:x[0], _hist)
919 if tx_hash in _tx_hist:
924 tx = self.transactions.get(tx_hash)
925 # tx might not be there
929 if self.verifier.get_height(tx_hash):
932 print_error("new history is orphaning transaction:", tx_hash)
933 # check that all outputs are not mine, request histories
935 for _addr, _v in tx.outputs:
936 # assert not self.is_mine(_addr)
937 ext_requests.append( ('blockchain.address.get_history', [_addr]) )
939 ext_h = self.network.synchronous_get(ext_requests)
940 print_error("sync:", ext_requests, ext_h)
943 if h == ['*']: continue
945 if item.get('tx_hash') == tx_hash:
946 height = item.get('height')
948 print_error("found height for", tx_hash, height)
949 self.verifier.add(tx_hash, height)
951 print_error("removing orphaned tx from history", tx_hash)
952 self.transactions.pop(tx_hash)
956 def check_new_tx(self, tx_hash, tx):
957 # 1 check that tx is referenced in addr_history.
959 for addr, hist in self.history.items():
960 if hist == ['*']:continue
961 for txh, height in hist:
963 addresses.append(addr)
968 # 2 check that referencing addresses are in the tx
969 for addr in addresses:
970 if not tx.has_address(addr):
975 def start_threads(self, network):
976 from verifier import TxVerifier
977 self.network = network
978 if self.network is not None:
979 self.verifier = TxVerifier(self.network, self.storage)
980 self.verifier.start()
981 self.set_verifier(self.verifier)
982 self.synchronizer = WalletSynchronizer(self, network)
983 self.synchronizer.start()
986 self.synchronizer =None
988 def stop_threads(self):
991 self.synchronizer.stop()
993 def restore(self, cb):
996 def get_accounts(self):
999 def save_accounts(self):
1001 for k, v in self.accounts.items():
1003 self.storage.put('accounts', d, True)
1005 def can_import(self):
1006 return not self.is_watching_only()
1008 def is_used(self, address):
1009 h = self.history.get(address,[])
1010 c, u = self.get_addr_balance(address)
1011 return len(h), len(h) > 0 and c == -u
1013 def address_is_old(self, address, age_limit=2):
1015 h = self.history.get(address, [])
1018 for tx_hash, tx_height in h:
1022 tx_age = self.network.get_local_height() - tx_height + 1
1025 return age > age_limit
1028 class Imported_Wallet(Abstract_Wallet):
1030 def __init__(self, storage):
1031 Abstract_Wallet.__init__(self, storage)
1032 a = self.accounts.get(IMPORTED_ACCOUNT)
1034 self.accounts[IMPORTED_ACCOUNT] = ImportedAccount({'imported':{}})
1035 self.storage.put('wallet_type', 'imported', True)
1037 def is_watching_only(self):
1038 acc = self.accounts[IMPORTED_ACCOUNT]
1039 n = acc.keypairs.values()
1040 return n == [(None, None)] * len(n)
1045 def is_deterministic(self):
1048 def check_password(self, password):
1049 self.accounts[IMPORTED_ACCOUNT].get_private_key((0,0), self, password)
1051 def is_used(self, address):
1052 h = self.history.get(address,[])
1053 return len(h), False
1055 def get_master_public_keys(self):
1058 def is_beyond_limit(self, address, account, is_change):
1061 class Deterministic_Wallet(Abstract_Wallet):
1063 def __init__(self, storage):
1064 Abstract_Wallet.__init__(self, storage)
1067 return self.seed != ''
1069 def is_deterministic(self):
1072 def is_watching_only(self):
1073 return not self.has_seed()
1075 def add_seed(self, seed, password):
1077 raise Exception("a seed exists")
1079 self.seed_version, self.seed = self.prepare_seed(seed)
1081 self.seed = pw_encode( self.seed, password)
1082 self.use_encryption = True
1084 self.use_encryption = False
1086 self.storage.put('seed', self.seed, True)
1087 self.storage.put('seed_version', self.seed_version, True)
1088 self.storage.put('use_encryption', self.use_encryption,True)
1089 self.create_master_keys(password)
1091 def get_seed(self, password):
1092 return pw_decode(self.seed, password)
1094 def get_mnemonic(self, password):
1095 return self.get_seed(password)
1097 def change_gap_limit(self, value):
1098 if value >= self.gap_limit:
1099 self.gap_limit = value
1100 self.storage.put('gap_limit', self.gap_limit, True)
1101 #self.interface.poke('synchronizer')
1104 elif value >= self.min_acceptable_gap():
1105 for key, account in self.accounts.items():
1106 addresses = account[0]
1107 k = self.num_unused_trailing_addresses(addresses)
1108 n = len(addresses) - k + value
1109 addresses = addresses[0:n]
1110 self.accounts[key][0] = addresses
1112 self.gap_limit = value
1113 self.storage.put('gap_limit', self.gap_limit, True)
1114 self.save_accounts()
1119 def num_unused_trailing_addresses(self, addresses):
1121 for a in addresses[::-1]:
1122 if self.history.get(a):break
1126 def min_acceptable_gap(self):
1127 # fixme: this assumes wallet is synchronized
1131 for account in self.accounts.values():
1132 addresses = account.get_addresses(0)
1133 k = self.num_unused_trailing_addresses(addresses)
1134 for a in addresses[0:-k]:
1135 if self.history.get(a):
1139 if n > nmax: nmax = n
1142 def synchronize_sequence(self, account, for_change):
1143 limit = self.gap_limit_for_change if for_change else self.gap_limit
1146 addresses = account.get_addresses(for_change)
1147 if len(addresses) < limit:
1148 address = account.create_new_address(for_change)
1149 self.history[address] = []
1150 new_addresses.append( address )
1153 if map( lambda a: self.address_is_old(a), addresses[-limit:] ) == limit*[False]:
1156 address = account.create_new_address(for_change)
1157 self.history[address] = []
1158 new_addresses.append( address )
1160 return new_addresses
1162 def check_pending_accounts(self):
1163 for account_id, addr in self.next_addresses.items():
1164 if self.address_is_old(addr):
1165 print_error( "creating account", account_id )
1166 xpub = self.master_public_keys[account_id]
1167 account = BIP32_Account({'xpub':xpub})
1168 self.add_account(account_id, account)
1169 self.next_addresses.pop(account_id)
1171 def synchronize_account(self, account):
1173 new += self.synchronize_sequence(account, 0)
1174 new += self.synchronize_sequence(account, 1)
1177 def synchronize(self):
1178 self.check_pending_accounts()
1180 for account in self.accounts.values():
1181 if type(account) in [ImportedAccount, PendingAccount]:
1183 new += self.synchronize_account(account)
1185 self.save_accounts()
1186 self.storage.put('addr_history', self.history, True)
1189 def restore(self, callback):
1191 def wait_for_wallet():
1192 self.set_up_to_date(False)
1193 while not self.is_up_to_date():
1194 msg = "%s\n%s %d\n%s %.1f"%(
1195 _("Please wait..."),
1196 _("Addresses generated:"),
1197 len(self.addresses(True)),
1198 _("Kilobytes received:"),
1199 self.network.interface.bytes_received/1024.)
1201 apply(callback, (msg,))
1204 def wait_for_network():
1205 while not self.network.is_connected():
1206 msg = "%s \n" % (_("Connecting..."))
1207 apply(callback, (msg,))
1210 # wait until we are connected, because the user might have selected another server
1216 self.fill_addressbook()
1218 def create_account(self, name, password):
1219 i = self.num_accounts()
1220 account_id = self.account_id(i)
1221 account = self.make_account(account_id, password)
1222 self.add_account(account_id, account)
1224 self.set_label(account_id, name)
1226 # add address of the next account
1227 _, _ = self.next_account_address(password)
1230 def add_account(self, account_id, account):
1231 self.accounts[account_id] = account
1232 self.save_accounts()
1234 def account_is_pending(self, k):
1235 return type(self.accounts.get(k)) == PendingAccount
1237 def delete_pending_account(self, k):
1238 assert self.account_is_pending(k)
1239 self.accounts.pop(k)
1240 self.save_accounts()
1242 def create_pending_account(self, name, password):
1243 account_id, addr = self.next_account_address(password)
1244 self.set_label(account_id, name)
1245 self.accounts[account_id] = PendingAccount({'pending':addr})
1246 self.save_accounts()
1248 def is_beyond_limit(self, address, account, is_change):
1249 if type(account) == ImportedAccount:
1251 addr_list = account.get_addresses(is_change)
1252 i = addr_list.index(address)
1253 prev_addresses = addr_list[:max(0, i)]
1254 limit = self.gap_limit_for_change if is_change else self.gap_limit
1255 if len(prev_addresses) < limit:
1257 prev_addresses = prev_addresses[max(0, i - limit):]
1258 for addr in prev_addresses:
1259 if self.address_is_old(addr):
1264 class NewWallet(Deterministic_Wallet):
1266 def __init__(self, storage):
1267 Deterministic_Wallet.__init__(self, storage)
1269 def can_create_accounts(self):
1270 return not self.is_watching_only()
1272 def get_master_public_key(self):
1273 return self.master_public_keys["m/"]
1275 def get_master_public_keys(self):
1277 for k, account in self.accounts.items():
1278 name = self.get_account_name(k)
1279 mpk_text = '\n\n'.join( account.get_master_pubkeys() )
1280 out[name] = mpk_text
1283 def get_master_private_key(self, account, password):
1284 k = self.master_private_keys.get(account)
1286 xpriv = pw_decode( k, password)
1289 def check_password(self, password):
1290 xpriv = self.get_master_private_key( "m/", password )
1291 xpub = self.master_public_keys["m/"]
1292 assert deserialize_xkey(xpriv)[3] == deserialize_xkey(xpub)[3]
1294 def create_watching_only_wallet(self, xpub):
1295 self.storage.put('seed_version', self.seed_version, True)
1296 self.add_master_public_key("m/", xpub)
1297 account = BIP32_Account({'xpub':xpub})
1298 self.add_account("m/", account)
1300 def create_accounts(self, password):
1301 # First check the password is valid (this raises if it isn't).
1302 self.check_password(password)
1303 self.create_account('Main account', password)
1305 def add_master_public_key(self, name, mpk):
1306 self.master_public_keys[name] = mpk
1307 self.storage.put('master_public_keys', self.master_public_keys, True)
1309 def add_master_private_key(self, name, xpriv, password):
1310 self.master_private_keys[name] = pw_encode(xpriv, password)
1311 self.storage.put('master_private_keys', self.master_private_keys, True)
1313 def add_master_keys(self, root, account_id, password):
1314 x = self.master_private_keys.get(root)
1316 master_xpriv = pw_decode(x, password )
1317 xpriv, xpub = bip32_private_derivation(master_xpriv, root, account_id)
1318 self.add_master_public_key(account_id, xpub)
1319 self.add_master_private_key(account_id, xpriv, password)
1321 master_xpub = self.master_public_keys[root]
1322 xpub = bip32_public_derivation(master_xpub, root, account_id)
1323 self.add_master_public_key(account_id, xpub)
1326 def create_master_keys(self, password):
1327 xpriv, xpub = bip32_root(mnemonic_to_seed(self.get_seed(password),'').encode('hex'))
1328 self.add_master_public_key("m/", xpub)
1329 self.add_master_private_key("m/", xpriv, password)
1331 def find_root_by_master_key(self, xpub):
1332 for key, xpub2 in self.master_public_keys.items():
1333 if key == "m/":continue
1337 def num_accounts(self):
1339 for k, v in self.accounts.items():
1340 if type(v) != BIP32_Account:
1346 account_id = self.account_id(i)
1347 if account_id not in keys: break
1351 def next_account_address(self, password):
1352 i = self.num_accounts()
1353 account_id = self.account_id(i)
1355 addr = self.next_addresses.get(account_id)
1357 account = self.make_account(account_id, password)
1358 addr = account.first_address()
1359 self.next_addresses[account_id] = addr
1360 self.storage.put('next_addresses', self.next_addresses)
1362 return account_id, addr
1364 def account_id(self, i):
1367 def make_account(self, account_id, password):
1368 """Creates and saves the master keys, but does not save the account"""
1369 xpub = self.add_master_keys("m/", account_id, password)
1370 account = BIP32_Account({'xpub':xpub})
1373 def make_seed(self):
1374 import mnemonic, ecdsa
1375 entropy = ecdsa.util.randrange( pow(2,160) )
1378 ss = "%040x"%(entropy+nonce)
1379 s = hashlib.sha256(ss.decode('hex')).digest().encode('hex')
1380 # we keep only 13 words, that's approximately 139 bits of entropy
1381 words = mnemonic.mn_encode(s)[0:13]
1382 seed = ' '.join(words)
1383 if is_new_seed(seed):
1384 break # this will remove 8 bits of entropy
1388 def prepare_seed(self, seed):
1390 return NEW_SEED_VERSION, unicodedata.normalize('NFC', unicode(seed.strip()))
1393 class Wallet_2of2(NewWallet):
1394 """ This class is used for multisignature addresses"""
1396 def __init__(self, storage):
1397 NewWallet.__init__(self, storage)
1398 self.storage.put('wallet_type', '2of2', True)
1400 def can_create_accounts(self):
1403 def can_import(self):
1406 def create_account(self):
1407 xpub1 = self.master_public_keys.get("m/")
1408 xpub2 = self.master_public_keys.get("cold/")
1409 account = BIP32_Account_2of2({'xpub':xpub1, 'xpub2':xpub2})
1410 self.add_account('m/', account)
1412 def get_master_public_keys(self):
1413 xpub1 = self.master_public_keys.get("m/")
1414 xpub2 = self.master_public_keys.get("cold/")
1415 return {'hot':xpub1, 'cold':xpub2}
1417 def get_action(self):
1418 xpub1 = self.master_public_keys.get("m/")
1419 xpub2 = self.master_public_keys.get("cold/")
1421 return 'create_2of2_1'
1423 return 'create_2of2_2'
1426 class Wallet_2of3(Wallet_2of2):
1427 """ This class is used for multisignature addresses"""
1429 def __init__(self, storage):
1430 Wallet_2of2.__init__(self, storage)
1431 self.storage.put('wallet_type', '2of3', True)
1433 def create_account(self):
1434 xpub1 = self.master_public_keys.get("m/")
1435 xpub2 = self.master_public_keys.get("cold/")
1436 xpub3 = self.master_public_keys.get("remote/")
1437 account = BIP32_Account_2of3({'xpub':xpub1, 'xpub2':xpub2, 'xpub3':xpub3})
1438 self.add_account('m/', account)
1440 def get_master_public_keys(self):
1441 xpub1 = self.master_public_keys.get("m/")
1442 xpub2 = self.master_public_keys.get("cold/")
1443 xpub3 = self.master_public_keys.get("remote/")
1444 return {'hot':xpub1, 'cold':xpub2, 'remote':xpub3}
1446 def get_action(self):
1447 xpub1 = self.master_public_keys.get("m/")
1448 xpub2 = self.master_public_keys.get("cold/")
1449 xpub3 = self.master_public_keys.get("remote/")
1450 # fixme: we use order of creation
1451 if xpub2 and xpub1 is None:
1452 return 'create_2fa_2'
1454 return 'create_2of3_1'
1455 if xpub2 is None or xpub3 is None:
1456 return 'create_2of3_2'
1459 class OldWallet(Deterministic_Wallet):
1461 def make_seed(self):
1463 seed = random_seed(128)
1464 return ' '.join(mnemonic.mn_encode(seed))
1466 def prepare_seed(self, seed):
1468 # see if seed was entered as hex
1473 return OLD_SEED_VERSION, str(seed)
1477 words = seed.split()
1478 seed = mnemonic.mn_decode(words)
1480 raise Exception("Invalid seed")
1482 return OLD_SEED_VERSION, seed
1484 def create_master_keys(self, password):
1485 seed = self.get_seed(password)
1486 mpk = OldAccount.mpk_from_seed(seed)
1487 self.storage.put('master_public_key', mpk, True)
1489 def get_master_public_key(self):
1490 return self.storage.get("master_public_key")
1492 def get_master_public_keys(self):
1493 return {'Main Account':self.get_master_public_key()}
1495 def create_accounts(self, password):
1496 mpk = self.storage.get("master_public_key")
1497 self.create_account(mpk)
1499 def create_account(self, mpk):
1500 self.accounts[0] = OldAccount({'mpk':mpk, 0:[], 1:[]})
1501 self.save_accounts()
1503 def create_watching_only_wallet(self, mpk):
1504 self.seed_version = OLD_SEED_VERSION
1505 self.storage.put('seed_version', self.seed_version, True)
1506 self.storage.put('master_public_key', mpk, True)
1507 self.create_account(mpk)
1509 def get_seed(self, password):
1510 seed = pw_decode(self.seed, password).encode('utf8')
1513 def check_password(self, password):
1514 seed = self.get_seed(password)
1515 self.accounts[0].check_seed(seed)
1517 def get_mnemonic(self, password):
1519 s = self.get_seed(password)
1520 return ' '.join(mnemonic.mn_encode(s))
1522 def check_pending_accounts(self):
1526 # former WalletFactory
1527 class Wallet(object):
1528 """The main wallet "entry point".
1529 This class is actually a factory that will return a wallet of the correct
1530 type when passed a WalletStorage instance."""
1532 def __new__(self, storage):
1533 config = storage.config
1534 if config.get('bitkey', False):
1535 # if user requested support for Bitkey device,
1536 # import Bitkey driver
1537 from wallet_bitkey import WalletBitkey
1538 return WalletBitkey(config)
1540 if storage.get('wallet_type') == '2of2':
1541 return Wallet_2of2(storage)
1543 if storage.get('wallet_type') == '2of3':
1544 return Wallet_2of3(storage)
1546 if storage.get('wallet_type') == 'imported':
1547 return Imported_Wallet(storage)
1549 if not storage.file_exists:
1550 seed_version = NEW_SEED_VERSION if config.get('bip32') is True else OLD_SEED_VERSION
1552 seed_version = storage.get('seed_version')
1553 if not seed_version:
1554 seed_version = OLD_SEED_VERSION if len(storage.get('master_public_key')) == 128 else NEW_SEED_VERSION
1556 if seed_version == OLD_SEED_VERSION:
1557 return OldWallet(storage)
1558 elif seed_version == NEW_SEED_VERSION:
1559 return NewWallet(storage)
1561 msg = "This wallet seed is not supported."
1562 if seed_version in [5]:
1563 msg += "\nTo open this wallet, try 'git checkout seed_v%d'"%seed_version
1568 def is_seed(self, seed):
1571 elif is_old_seed(seed):
1573 elif is_new_seed(seed):
1579 def is_mpk(self, mpk):
1587 return len(mpk) == 128
1590 deserialize_xkey(mpk)
1596 def is_address(self, text):
1599 for x in text.split():
1600 if not bitcoin.is_address(x):
1605 def is_private_key(self, text):
1608 for x in text.split():
1609 if not bitcoin.is_private_key(x):
1614 def from_seed(self, seed, storage):
1615 if is_old_seed(seed):
1617 elif is_new_seed(seed):
1623 def from_address(self, text, storage):
1624 w = Imported_Wallet(storage)
1625 for x in text.split():
1626 w.accounts[IMPORTED_ACCOUNT].add(x, None, None, None)
1631 def from_private_key(self, text, storage):
1632 w = Imported_Wallet(storage)
1633 for x in text.split():
1634 w.import_key(x, None)
1638 def from_mpk(self, mpk, storage):
1646 w = OldWallet(storage)
1648 w.create_watching_only_wallet(mpk)
1650 w = NewWallet(storage)
1651 w.create_watching_only_wallet(mpk)