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
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
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):
224 def load_accounts(self):
226 self.imported_keys = self.storage.get('imported_keys',{})
227 if self.imported_keys:
228 print_error("cannot load imported keys")
230 d = self.storage.get('accounts', {})
231 for k, v in d.items():
233 v['mpk'] = self.storage.get('master_public_key')
234 self.accounts[k] = OldAccount(v)
235 elif v.get('imported'):
236 self.accounts[k] = ImportedAccount(v)
238 self.accounts[k] = BIP32_Account_2of3(v)
240 self.accounts[k] = BIP32_Account_2of2(v)
242 self.accounts[k] = BIP32_Account(v)
243 elif v.get('pending'):
244 self.accounts[k] = PendingAccount(v)
246 print_error("cannot load account", v)
249 def synchronize(self):
252 def can_create_accounts(self):
255 def set_up_to_date(self,b):
256 with self.lock: self.up_to_date = b
258 def is_up_to_date(self):
259 with self.lock: return self.up_to_date
263 self.up_to_date = False
264 while not self.is_up_to_date():
267 def is_imported(self, addr):
268 account = self.accounts.get(IMPORTED_ACCOUNT)
270 return addr in account.get_addresses(0)
274 def import_key(self, sec, password):
276 pubkey = public_key_from_private_key(sec)
277 address = public_key_to_bc_address(pubkey.decode('hex'))
279 raise Exception('Invalid private key')
281 if self.is_mine(address):
282 raise Exception('Address already in wallet')
284 if self.accounts.get(IMPORTED_ACCOUNT) is None:
285 self.accounts[IMPORTED_ACCOUNT] = ImportedAccount({'imported':{}})
286 self.accounts[IMPORTED_ACCOUNT].add(address, pubkey, sec, password)
289 if self.synchronizer:
290 self.synchronizer.subscribe_to_addresses([address])
294 def delete_imported_key(self, addr):
295 account = self.accounts[IMPORTED_ACCOUNT]
297 if not account.get_addresses(0):
298 self.accounts.pop(IMPORTED_ACCOUNT)
302 def set_label(self, name, text = None):
304 old_text = self.labels.get(name)
307 self.labels[name] = text
311 self.labels.pop(name)
315 self.storage.put('labels', self.labels, True)
317 run_hook('set_label', name, text, changed)
323 def addresses(self, include_change = True, _next=True):
325 for a in self.accounts.keys():
326 o += self.get_account_addresses(a, include_change)
329 for addr in self.next_addresses.values():
335 def is_mine(self, address):
336 return address in self.addresses(True)
339 def is_change(self, address):
340 if not self.is_mine(address): return False
341 acct, s = self.get_address_index(address)
342 if s is None: return False
346 def get_address_index(self, address):
348 for account in self.accounts.keys():
349 for for_change in [0,1]:
350 addresses = self.accounts[account].get_addresses(for_change)
351 for addr in addresses:
353 return account, (for_change, addresses.index(addr))
355 for k,v in self.next_addresses.items():
359 raise Exception("Address not found", address)
362 def getpubkeys(self, addr):
363 assert is_valid(addr) and self.is_mine(addr)
364 account, sequence = self.get_address_index(addr)
365 a = self.accounts[account]
366 return a.get_pubkeys( sequence )
369 def get_private_key(self, address, password):
370 if self.is_watching_only():
372 account_id, sequence = self.get_address_index(address)
373 return self.accounts[account_id].get_private_key(sequence, self, password)
376 def get_public_keys(self, address):
377 account_id, sequence = self.get_address_index(address)
378 return self.accounts[account_id].get_pubkeys(sequence)
381 def add_keypairs_from_wallet(self, tx, keypairs, password):
382 for txin in tx.inputs:
383 address = txin['address']
384 if not self.is_mine(address):
386 private_keys = self.get_private_key(address, password)
387 for sec in private_keys:
388 pubkey = public_key_from_private_key(sec)
389 keypairs[ pubkey ] = sec
393 def add_keypairs_from_KeyID(self, tx, keypairs, password):
394 # first check the provided password
395 seed = self.get_seed(password)
397 for txin in tx.inputs:
398 keyid = txin.get('KeyID')
401 for s in keyid.split('&'):
402 m = re.match("bip32\((.*),(/\d+/\d+)\)", s)
405 sequence = m.group(2)
406 root = self.find_root_by_master_key(xpub)
407 if not root: continue
408 sequence = map(lambda x:int(x), sequence.strip('/').split('/'))
409 root = root + '%d'%sequence[0]
410 sequence = sequence[1:]
411 roots.append((root,sequence))
413 account_id = " & ".join( map(lambda x:x[0], roots) )
414 account = self.accounts.get(account_id)
415 if not account: continue
416 addr = account.get_address(*sequence)
417 txin['address'] = addr # fixme: side effect
418 pk = self.get_private_key(addr, password)
420 pubkey = public_key_from_private_key(sec)
421 keypairs[pubkey] = sec
425 def signrawtransaction(self, tx, input_info, private_keys, password):
427 # check that the password is correct
428 seed = self.get_seed(password)
430 # if input_info is not known, build it using wallet UTXOs
433 unspent_coins = self.get_unspent_coins()
434 for txin in tx.inputs:
435 for item in unspent_coins:
436 if txin['prevout_hash'] == item['prevout_hash'] and txin['prevout_n'] == item['prevout_n']:
437 info = { 'address':item['address'], 'scriptPubKey':item['scriptPubKey'] }
438 self.add_input_info(info)
439 input_info.append(info)
442 print_error( "input not in UTXOs" )
443 input_info.append(None)
445 # add input_info to the transaction
446 print_error("input_info", input_info)
447 tx.add_input_info(input_info)
449 # build a list of public/private keys
452 # add private keys from parameter
453 for sec in private_keys:
454 pubkey = public_key_from_private_key(sec)
455 keypairs[ pubkey ] = sec
457 # add private_keys from KeyID
458 self.add_keypairs_from_KeyID(tx, keypairs, password)
459 # add private keys from wallet
460 self.add_keypairs_from_wallet(tx, keypairs, password)
461 # sign the transaction
462 self.sign_transaction(tx, keypairs, password)
465 def sign_message(self, address, message, password):
466 keys = self.get_private_key(address, password)
467 assert len(keys) == 1
469 key = regenerate_key(sec)
470 compressed = is_compressed(sec)
471 return key.sign_message(message, compressed, address)
475 def decrypt_message(self, pubkey, message, password):
476 address = public_key_to_bc_address(pubkey.decode('hex'))
477 keys = self.get_private_key(address, password)
479 ec = regenerate_key(secret)
480 decrypted = ec.decrypt_message(message)
486 return self.history.values() != [[]] * len(self.history)
489 def add_contact(self, address, label=None):
490 self.addressbook.append(address)
491 self.storage.put('contacts', self.addressbook, True)
493 self.set_label(address, label)
496 def delete_contact(self, addr):
497 if addr in self.addressbook:
498 self.addressbook.remove(addr)
499 self.storage.put('addressbook', self.addressbook, True)
502 def fill_addressbook(self):
503 for tx_hash, tx in self.transactions.items():
504 is_relevant, is_send, _, _ = self.get_tx_value(tx)
506 for addr, v in tx.outputs:
507 if not self.is_mine(addr) and addr not in self.addressbook:
508 self.addressbook.append(addr)
510 # self.update_tx_labels()
512 def get_num_tx(self, address):
514 for tx in self.transactions.values():
515 if address in map(lambda x:x[0], tx.outputs): n += 1
519 def get_address_flags(self, addr):
520 flags = "C" if self.is_change(addr) else "I" if addr in self.imported_keys.keys() else "-"
521 flags += "F" if addr in self.frozen_addresses else "-"
525 def get_tx_value(self, tx, account=None):
526 domain = self.get_account_addresses(account)
527 return tx.get_value(domain, self.prevout_values)
530 def update_tx_outputs(self, tx_hash):
531 tx = self.transactions.get(tx_hash)
533 for i, (addr, value) in enumerate(tx.outputs):
534 key = tx_hash+ ':%d'%i
535 self.prevout_values[key] = value
537 for item in tx.inputs:
538 if self.is_mine(item.get('address')):
539 key = item['prevout_hash'] + ':%d'%item['prevout_n']
540 self.spent_outputs.append(key)
543 def get_addr_balance(self, address):
544 #assert self.is_mine(address)
545 h = self.history.get(address,[])
546 if h == ['*']: return 0,0
548 received_coins = [] # list of coins received at address
550 for tx_hash, tx_height in h:
551 tx = self.transactions.get(tx_hash)
554 for i, (addr, value) in enumerate(tx.outputs):
556 key = tx_hash + ':%d'%i
557 received_coins.append(key)
559 for tx_hash, tx_height in h:
560 tx = self.transactions.get(tx_hash)
564 for item in tx.inputs:
565 addr = item.get('address')
567 key = item['prevout_hash'] + ':%d'%item['prevout_n']
568 value = self.prevout_values.get( key )
569 if key in received_coins:
572 for i, (addr, value) in enumerate(tx.outputs):
573 key = tx_hash + ':%d'%i
584 def get_account_name(self, k):
585 return self.labels.get(k, self.accounts[k].get_name(k))
588 def get_account_names(self):
590 for k in self.accounts.keys():
591 account_names[k] = self.get_account_name(k)
595 def get_account_addresses(self, a, include_change=True):
597 o = self.addresses(True)
598 elif a in self.accounts:
599 ac = self.accounts[a]
600 o = ac.get_addresses(0)
601 if include_change: o += ac.get_addresses(1)
605 def get_account_balance(self, account):
606 return self.get_balance(self.get_account_addresses(account))
608 def get_frozen_balance(self):
609 return self.get_balance(self.frozen_addresses)
611 def get_balance(self, domain=None):
612 if domain is None: domain = self.addresses(True)
615 c, u = self.get_addr_balance(addr)
621 def get_unspent_coins(self, domain=None):
623 if domain is None: domain = self.addresses(True)
625 h = self.history.get(addr, [])
626 if h == ['*']: continue
627 for tx_hash, tx_height in h:
628 tx = self.transactions.get(tx_hash)
629 if tx is None: raise Exception("Wallet not synchronized")
630 is_coinbase = tx.inputs[0].get('prevout_hash') == '0'*64
631 for o in tx.d.get('outputs'):
633 if output.get('address') != addr: continue
634 key = tx_hash + ":%d" % output.get('prevout_n')
635 if key in self.spent_outputs: continue
636 output['prevout_hash'] = tx_hash
637 output['height'] = tx_height
638 output['coinbase'] = is_coinbase
639 coins.append((tx_height, output))
643 coins = sorted(coins)
644 if coins[-1][0] != 0:
645 while coins[0][0] == 0:
646 coins = coins[1:] + [ coins[0] ]
647 return [x[1] for x in coins]
650 def choose_tx_inputs( self, amount, fixed_fee, num_outputs, domain = None ):
651 """ todo: minimize tx size """
653 fee = self.fee if fixed_fee is None else fixed_fee
655 domain = self.addresses(True)
657 for i in self.frozen_addresses:
658 if i in domain: domain.remove(i)
660 coins = self.get_unspent_coins(domain)
664 if item.get('coinbase') and item.get('height') + COINBASE_MATURITY > self.network.get_local_height():
666 addr = item.get('address')
667 v = item.get('value')
670 fee = self.estimated_fee(inputs, num_outputs) if fixed_fee is None else fixed_fee
671 if total >= amount + fee: break
675 return inputs, total, fee
678 def set_fee(self, fee):
681 self.storage.put('fee_per_kb', self.fee, True)
683 def estimated_fee(self, inputs, num_outputs):
684 estimated_size = len(inputs) * 180 + num_outputs * 34 # this assumes non-compressed keys
685 fee = self.fee * int(math.ceil(estimated_size/1000.))
689 def add_tx_change( self, inputs, outputs, amount, fee, total, change_addr=None):
690 "add change to a transaction"
691 change_amount = total - ( amount + fee )
692 if change_amount > DUST_THRESHOLD:
695 # send change to one of the accounts involved in the tx
696 address = inputs[0].get('address')
697 account, _ = self.get_address_index(address)
699 if not self.use_change or account == IMPORTED_ACCOUNT:
700 change_addr = inputs[-1]['address']
702 change_addr = self.accounts[account].get_addresses(1)[-self.gap_limit_for_change]
704 # Insert the change output at a random position in the outputs
705 posn = random.randint(0, len(outputs))
706 outputs[posn:posn] = [( change_addr, change_amount)]
710 def get_history(self, address):
712 return self.history.get(address)
715 def get_status(self, h):
716 if not h: return None
717 if h == ['*']: return '*'
719 for tx_hash, height in h:
720 status += tx_hash + ':%d:' % height
721 return hashlib.sha256( status ).digest().encode('hex')
724 def receive_tx_callback(self, tx_hash, tx, tx_height):
726 with self.transaction_lock:
727 self.add_extra_addresses(tx)
728 if not self.check_new_tx(tx_hash, tx):
729 # may happen due to pruning
730 print_error("received transaction that is no longer referenced in history", tx_hash)
732 self.transactions[tx_hash] = tx
733 self.network.pending_transactions_for_notifications.append(tx)
734 self.save_transactions()
735 if self.verifier and tx_height>0:
736 self.verifier.add(tx_hash, tx_height)
737 self.update_tx_outputs(tx_hash)
740 def save_transactions(self):
742 for k,v in self.transactions.items():
744 self.storage.put('transactions', tx, True)
746 def receive_history_callback(self, addr, hist):
748 if not self.check_new_history(addr, hist):
749 raise Exception("error: received history for %s is not consistent with known transactions"%addr)
752 self.history[addr] = hist
753 self.storage.put('addr_history', self.history, True)
756 for tx_hash, tx_height in hist:
758 # add it in case it was previously unconfirmed
759 if self.verifier: self.verifier.add(tx_hash, tx_height)
762 def get_tx_history(self, account=None):
763 if not self.verifier:
766 with self.transaction_lock:
767 history = self.transactions.items()
768 history.sort(key = lambda x: self.verifier.get_txpos(x[0]))
772 for tx_hash, tx in history:
773 is_relevant, is_mine, v, fee = self.get_tx_value(tx, account)
774 if v is not None: balance += v
776 c, u = self.get_account_balance(account)
779 result.append( ('', 1000, 0, c+u-balance, None, c+u-balance, None ) )
781 balance = c + u - balance
782 for tx_hash, tx in history:
783 is_relevant, is_mine, value, fee = self.get_tx_value(tx, account)
786 if value is not None:
789 conf, timestamp = self.verifier.get_confirmations(tx_hash) if self.verifier else (None, None)
790 result.append( (tx_hash, conf, is_mine, value, fee, balance, timestamp) )
795 def get_label(self, tx_hash):
796 label = self.labels.get(tx_hash)
797 is_default = (label == '') or (label is None)
798 if is_default: label = self.get_default_label(tx_hash)
799 return label, is_default
802 def get_default_label(self, tx_hash):
803 tx = self.transactions.get(tx_hash)
806 is_relevant, is_mine, _, _ = self.get_tx_value(tx)
810 if not self.is_mine(o_addr):
812 default_label = self.labels[o_addr]
814 default_label = '>' + o_addr
817 default_label = '(internal)'
821 if self.is_mine(o_addr) and not self.is_change(o_addr):
826 if self.is_mine(o_addr):
832 dest_label = self.labels.get(o_addr)
834 default_label = self.labels[o_addr]
836 default_label = '<' + o_addr
841 def make_unsigned_transaction(self, outputs, fee=None, change_addr=None, domain=None ):
842 for address, x in outputs:
843 assert is_valid(address), "Address " + address + " is invalid!"
844 amount = sum( map(lambda x:x[1], outputs) )
845 inputs, total, fee = self.choose_tx_inputs( amount, fee, len(outputs), domain )
847 raise ValueError("Not enough funds")
849 self.add_input_info(txin)
850 outputs = self.add_tx_change(inputs, outputs, amount, fee, total, change_addr)
851 return Transaction.from_io(inputs, outputs)
854 def mktx(self, outputs, password, fee=None, change_addr=None, domain= None ):
855 tx = self.make_unsigned_transaction(outputs, fee, change_addr, domain)
857 self.add_keypairs_from_wallet(tx, keypairs, password)
859 self.sign_transaction(tx, keypairs, password)
863 def add_input_info(self, txin):
864 address = txin['address']
865 account_id, sequence = self.get_address_index(address)
866 account = self.accounts[account_id]
867 txin['KeyID'] = account.get_keyID(sequence)
868 redeemScript = account.redeem_script(sequence)
870 txin['redeemScript'] = redeemScript
872 txin['redeemPubkey'] = account.get_pubkey(*sequence)
875 def sign_transaction(self, tx, keypairs, password):
877 run_hook('sign_transaction', tx, password)
880 def sendtx(self, tx):
884 return self.receive_tx(h, tx)
886 def send_tx(self, tx):
888 self.tx_event.clear()
889 self.network.send([('blockchain.transaction.broadcast', [str(tx)])], self.on_broadcast)
892 def on_broadcast(self, i, r):
893 self.tx_result = r.get('result')
896 def receive_tx(self, tx_hash, tx):
899 return False, "error: " + out
900 run_hook('receive_tx', tx, self)
904 def update_password(self, old_password, new_password):
905 if new_password == '':
909 decoded = self.get_seed(old_password)
910 self.seed = pw_encode( decoded, new_password)
911 self.storage.put('seed', self.seed, True)
913 imported_account = self.accounts.get(IMPORTED_ACCOUNT)
915 imported_account.update_password(old_password, new_password)
918 for k, v in self.master_private_keys.items():
919 b = pw_decode(v, old_password)
920 c = pw_encode(b, new_password)
921 self.master_private_keys[k] = c
922 self.storage.put('master_private_keys', self.master_private_keys, True)
924 self.use_encryption = (new_password != None)
925 self.storage.put('use_encryption', self.use_encryption,True)
928 def freeze(self,addr):
929 if self.is_mine(addr) and addr not in self.frozen_addresses:
930 self.frozen_addresses.append(addr)
931 self.storage.put('frozen_addresses', self.frozen_addresses, True)
937 def unfreeze(self,addr):
938 if self.is_mine(addr) and addr in self.frozen_addresses:
939 self.frozen_addresses.remove(addr)
940 self.storage.put('frozen_addresses', self.frozen_addresses, True)
946 def set_verifier(self, verifier):
947 self.verifier = verifier
949 # review transactions that are in the history
950 for addr, hist in self.history.items():
951 if hist == ['*']: continue
952 for tx_hash, tx_height in hist:
954 # add it in case it was previously unconfirmed
955 self.verifier.add(tx_hash, tx_height)
957 # if we are on a pruning server, remove unverified transactions
958 vr = self.verifier.transactions.keys() + self.verifier.verified_tx.keys()
959 for tx_hash in self.transactions.keys():
960 if tx_hash not in vr:
961 self.transactions.pop(tx_hash)
964 def check_new_history(self, addr, hist):
966 # check that all tx in hist are relevant
968 for tx_hash, height in hist:
969 tx = self.transactions.get(tx_hash)
971 if not tx.has_address(addr):
974 # check that we are not "orphaning" a transaction
975 old_hist = self.history.get(addr,[])
976 if old_hist == ['*']: return True
978 for tx_hash, height in old_hist:
979 if tx_hash in map(lambda x:x[0], hist): continue
981 for _addr, _hist in self.history.items():
982 if _addr == addr: continue
983 if _hist == ['*']: continue
984 _tx_hist = map(lambda x:x[0], _hist)
985 if tx_hash in _tx_hist:
990 tx = self.transactions.get(tx_hash)
991 # tx might not be there
995 if self.verifier.get_height(tx_hash):
998 print_error("new history is orphaning transaction:", tx_hash)
999 # check that all outputs are not mine, request histories
1001 for _addr, _v in tx.outputs:
1002 # assert not self.is_mine(_addr)
1003 ext_requests.append( ('blockchain.address.get_history', [_addr]) )
1005 ext_h = self.network.synchronous_get(ext_requests)
1006 print_error("sync:", ext_requests, ext_h)
1009 if h == ['*']: continue
1011 if item.get('tx_hash') == tx_hash:
1012 height = item.get('height')
1014 print_error("found height for", tx_hash, height)
1015 self.verifier.add(tx_hash, height)
1017 print_error("removing orphaned tx from history", tx_hash)
1018 self.transactions.pop(tx_hash)
1023 def check_new_tx(self, tx_hash, tx):
1024 # 1 check that tx is referenced in addr_history.
1026 for addr, hist in self.history.items():
1027 if hist == ['*']:continue
1028 for txh, height in hist:
1030 addresses.append(addr)
1035 # 2 check that referencing addresses are in the tx
1036 for addr in addresses:
1037 if not tx.has_address(addr):
1043 def start_threads(self, network):
1044 from verifier import TxVerifier
1045 self.network = network
1046 if self.network is not None:
1047 self.verifier = TxVerifier(self.network, self.storage)
1048 self.verifier.start()
1049 self.set_verifier(self.verifier)
1050 self.synchronizer = WalletSynchronizer(self, network)
1051 self.synchronizer.start()
1053 self.verifier = None
1054 self.synchronizer =None
1056 def stop_threads(self):
1058 self.verifier.stop()
1059 self.synchronizer.stop()
1061 def restore(self, cb):
1064 def get_accounts(self):
1065 return self.accounts
1067 def save_accounts(self):
1069 for k, v in self.accounts.items():
1071 self.storage.put('accounts', d, True)
1073 def can_import(self):
1074 return not self.is_watching_only()
1076 def is_used(self, address):
1077 h = self.history.get(address,[])
1078 c, u = self.get_addr_balance(address)
1079 return len(h), len(h) > 0 and c == -u
1082 class Imported_Wallet(Abstract_Wallet):
1084 def __init__(self, storage):
1085 Abstract_Wallet.__init__(self, storage)
1086 a = self.accounts.get(IMPORTED_ACCOUNT)
1088 self.accounts[IMPORTED_ACCOUNT] = ImportedAccount({'imported':{}})
1089 self.storage.put('wallet_type', 'imported', True)
1092 def is_watching_only(self):
1093 acc = self.accounts[IMPORTED_ACCOUNT]
1094 n = acc.keypairs.values()
1095 return n == [(None, None)] * len(n)
1100 def is_deterministic(self):
1103 def check_password(self, password):
1104 self.accounts[IMPORTED_ACCOUNT].get_private_key((0,0), self, password)
1106 def is_used(self, address):
1107 h = self.history.get(address,[])
1108 return len(h), False
1111 class Deterministic_Wallet(Abstract_Wallet):
1113 def __init__(self, storage):
1114 Abstract_Wallet.__init__(self, storage)
1117 return self.seed != ''
1119 def is_deterministic(self):
1122 def is_watching_only(self):
1123 return not self.has_seed()
1125 def add_seed(self, seed, password):
1127 raise Exception("a seed exists")
1129 self.seed_version, self.seed = self.prepare_seed(seed)
1131 self.seed = pw_encode( self.seed, password)
1132 self.use_encryption = True
1134 self.use_encryption = False
1136 self.storage.put('seed', self.seed, True)
1137 self.storage.put('seed_version', self.seed_version, True)
1138 self.storage.put('use_encryption', self.use_encryption,True)
1139 self.create_master_keys(password)
1141 def get_seed(self, password):
1142 return pw_decode(self.seed, password)
1144 def get_mnemonic(self, password):
1145 return self.get_seed(password)
1147 def change_gap_limit(self, value):
1148 if value >= self.gap_limit:
1149 self.gap_limit = value
1150 self.storage.put('gap_limit', self.gap_limit, True)
1151 #self.interface.poke('synchronizer')
1154 elif value >= self.min_acceptable_gap():
1155 for key, account in self.accounts.items():
1156 addresses = account[0]
1157 k = self.num_unused_trailing_addresses(addresses)
1158 n = len(addresses) - k + value
1159 addresses = addresses[0:n]
1160 self.accounts[key][0] = addresses
1162 self.gap_limit = value
1163 self.storage.put('gap_limit', self.gap_limit, True)
1164 self.save_accounts()
1169 def num_unused_trailing_addresses(self, addresses):
1171 for a in addresses[::-1]:
1172 if self.history.get(a):break
1176 def min_acceptable_gap(self):
1177 # fixme: this assumes wallet is synchronized
1181 for account in self.accounts.values():
1182 addresses = account.get_addresses(0)
1183 k = self.num_unused_trailing_addresses(addresses)
1184 for a in addresses[0:-k]:
1185 if self.history.get(a):
1189 if n > nmax: nmax = n
1193 def address_is_old(self, address):
1195 h = self.history.get(address, [])
1198 for tx_hash, tx_height in h:
1202 tx_age = self.network.get_local_height() - tx_height + 1
1208 def synchronize_sequence(self, account, for_change):
1209 limit = self.gap_limit_for_change if for_change else self.gap_limit
1212 addresses = account.get_addresses(for_change)
1213 if len(addresses) < limit:
1214 address = account.create_new_address(for_change)
1215 self.history[address] = []
1216 new_addresses.append( address )
1219 if map( lambda a: self.address_is_old(a), addresses[-limit:] ) == limit*[False]:
1222 address = account.create_new_address(for_change)
1223 self.history[address] = []
1224 new_addresses.append( address )
1226 return new_addresses
1229 def check_pending_accounts(self):
1230 for account_id, addr in self.next_addresses.items():
1231 if self.address_is_old(addr):
1232 print_error( "creating account", account_id )
1233 xpub = self.master_public_keys[account_id]
1234 account = BIP32_Account({'xpub':xpub})
1235 self.add_account(account_id, account)
1236 self.next_addresses.pop(account_id)
1239 def synchronize_account(self, account):
1241 new += self.synchronize_sequence(account, 0)
1242 new += self.synchronize_sequence(account, 1)
1246 def synchronize(self):
1247 self.check_pending_accounts()
1249 for account in self.accounts.values():
1250 if type(account) in [ImportedAccount, PendingAccount]:
1252 new += self.synchronize_account(account)
1254 self.save_accounts()
1255 self.storage.put('addr_history', self.history, True)
1259 def restore(self, callback):
1261 def wait_for_wallet():
1262 self.set_up_to_date(False)
1263 while not self.is_up_to_date():
1264 msg = "%s\n%s %d\n%s %.1f"%(
1265 _("Please wait..."),
1266 _("Addresses generated:"),
1267 len(self.addresses(True)),
1268 _("Kilobytes received:"),
1269 self.network.interface.bytes_received/1024.)
1271 apply(callback, (msg,))
1274 def wait_for_network():
1275 while not self.network.is_connected():
1276 msg = "%s \n" % (_("Connecting..."))
1277 apply(callback, (msg,))
1280 # wait until we are connected, because the user might have selected another server
1287 self.fill_addressbook()
1290 def create_account(self, name, password):
1291 i = self.num_accounts()
1292 account_id = self.account_id(i)
1293 account = self.make_account(account_id, password)
1294 self.add_account(account_id, account)
1296 self.set_label(account_id, name)
1298 # add address of the next account
1299 _, _ = self.next_account_address(password)
1302 def add_account(self, account_id, account):
1303 self.accounts[account_id] = account
1304 self.save_accounts()
1308 def account_is_pending(self, k):
1309 return type(self.accounts.get(k)) == PendingAccount
1311 def delete_pending_account(self, k):
1312 assert self.account_is_pending(k)
1313 self.accounts.pop(k)
1314 self.save_accounts()
1316 def create_pending_account(self, name, password):
1317 account_id, addr = self.next_account_address(password)
1318 self.set_label(account_id, name)
1319 self.accounts[account_id] = PendingAccount({'pending':addr})
1320 self.save_accounts()
1325 class NewWallet(Deterministic_Wallet):
1327 def __init__(self, storage):
1328 Deterministic_Wallet.__init__(self, storage)
1330 def can_create_accounts(self):
1331 return not self.is_watching_only()
1333 def get_master_public_key(self):
1334 return self.master_public_keys["m/"]
1336 def get_master_public_keys(self):
1338 for k, account in self.accounts.items():
1339 name = self.get_account_name(k)
1340 mpk_text = '\n\n'.join( account.get_master_pubkeys() )
1341 out[name] = mpk_text
1344 def get_master_private_key(self, account, password):
1345 k = self.master_private_keys.get(account)
1347 xpriv = pw_decode( k, password)
1350 def check_password(self, password):
1351 xpriv = self.get_master_private_key( "m/", password )
1352 xpub = self.master_public_keys["m/"]
1353 assert deserialize_xkey(xpriv)[3] == deserialize_xkey(xpub)[3]
1355 def create_watching_only_wallet(self, xpub):
1356 self.storage.put('seed_version', self.seed_version, True)
1357 self.add_master_public_key("m/", xpub)
1358 account = BIP32_Account({'xpub':xpub})
1359 self.add_account("m/", account)
1362 def create_accounts(self, password):
1363 seed = pw_decode(self.seed, password)
1364 self.create_account('Main account', password)
1367 def add_master_public_key(self, name, mpk):
1368 self.master_public_keys[name] = mpk
1369 self.storage.put('master_public_keys', self.master_public_keys, True)
1372 def add_master_private_key(self, name, xpriv, password):
1373 self.master_private_keys[name] = pw_encode(xpriv, password)
1374 self.storage.put('master_private_keys', self.master_private_keys, True)
1377 def add_master_keys(self, root, account_id, password):
1378 x = self.master_private_keys.get(root)
1380 master_xpriv = pw_decode(x, password )
1381 xpriv, xpub = bip32_private_derivation(master_xpriv, root, account_id)
1382 self.add_master_public_key(account_id, xpub)
1383 self.add_master_private_key(account_id, xpriv, password)
1385 master_xpub = self.master_public_keys[root]
1386 xpub = bip32_public_derivation(master_xpub, root, account_id)
1387 self.add_master_public_key(account_id, xpub)
1391 def create_master_keys(self, password):
1392 xpriv, xpub = bip32_root(mnemonic_to_seed(self.get_seed(password),'').encode('hex'))
1393 self.add_master_public_key("m/", xpub)
1394 self.add_master_private_key("m/", xpriv, password)
1397 def find_root_by_master_key(self, xpub):
1398 for key, xpub2 in self.master_public_keys.items():
1399 if key == "m/":continue
1404 def num_accounts(self):
1406 for k, v in self.accounts.items():
1407 if type(v) != BIP32_Account:
1413 account_id = self.account_id(i)
1414 if account_id not in keys: break
1419 def next_account_address(self, password):
1420 i = self.num_accounts()
1421 account_id = self.account_id(i)
1423 addr = self.next_addresses.get(account_id)
1425 account = self.make_account(account_id, password)
1426 addr = account.first_address()
1427 self.next_addresses[account_id] = addr
1428 self.storage.put('next_addresses', self.next_addresses)
1430 return account_id, addr
1432 def account_id(self, i):
1435 def make_account(self, account_id, password):
1436 """Creates and saves the master keys, but does not save the account"""
1437 xpub = self.add_master_keys("m/", account_id, password)
1438 account = BIP32_Account({'xpub':xpub})
1442 def make_seed(self):
1443 import mnemonic, ecdsa
1444 entropy = ecdsa.util.randrange( pow(2,160) )
1447 ss = "%040x"%(entropy+nonce)
1448 s = hashlib.sha256(ss.decode('hex')).digest().encode('hex')
1449 # we keep only 13 words, that's approximately 139 bits of entropy
1450 words = mnemonic.mn_encode(s)[0:13]
1451 seed = ' '.join(words)
1452 if is_new_seed(seed):
1453 break # this will remove 8 bits of entropy
1457 def prepare_seed(self, seed):
1459 return NEW_SEED_VERSION, unicodedata.normalize('NFC', unicode(seed.strip()))
1463 class Wallet_2of2(NewWallet):
1465 def __init__(self, storage):
1466 NewWallet.__init__(self, storage)
1467 self.storage.put('wallet_type', '2of2', True)
1469 def can_create_accounts(self):
1472 def can_import(self):
1475 def create_account(self):
1476 xpub1 = self.master_public_keys.get("m/")
1477 xpub2 = self.master_public_keys.get("cold/")
1478 account = BIP32_Account_2of2({'xpub':xpub1, 'xpub2':xpub2})
1479 self.add_account('m/', account)
1481 def get_master_public_keys(self):
1482 xpub1 = self.master_public_keys.get("m/")
1483 xpub2 = self.master_public_keys.get("cold/")
1484 return {'hot':xpub1, 'cold':xpub2}
1486 def get_action(self):
1487 xpub1 = self.master_public_keys.get("m/")
1488 xpub2 = self.master_public_keys.get("cold/")
1490 return 'create_2of2_1'
1492 return 'create_2of2_2'
1496 class Wallet_2of3(Wallet_2of2):
1498 def __init__(self, storage):
1499 Wallet_2of2.__init__(self, storage)
1500 self.storage.put('wallet_type', '2of3', True)
1502 def create_account(self):
1503 xpub1 = self.master_public_keys.get("m/")
1504 xpub2 = self.master_public_keys.get("cold/")
1505 xpub3 = self.master_public_keys.get("remote/")
1506 account = BIP32_Account_2of3({'xpub':xpub1, 'xpub2':xpub2, 'xpub3':xpub3})
1507 self.add_account('m/', account)
1509 def get_master_public_keys(self):
1510 xpub1 = self.master_public_keys.get("m/")
1511 xpub2 = self.master_public_keys.get("cold/")
1512 xpub3 = self.master_public_keys.get("remote/")
1513 return {'hot':xpub1, 'cold':xpub2, 'remote':xpub3}
1515 def get_action(self):
1516 xpub1 = self.master_public_keys.get("m/")
1517 xpub2 = self.master_public_keys.get("cold/")
1518 xpub3 = self.master_public_keys.get("remote/")
1519 # fixme: we use order of creation
1520 if xpub2 and xpub1 is None:
1521 return 'create_2fa_2'
1523 return 'create_2of3_1'
1524 if xpub2 is None or xpub3 is None:
1525 return 'create_2of3_2'
1531 class OldWallet(Deterministic_Wallet):
1533 def make_seed(self):
1535 seed = random_seed(128)
1536 return ' '.join(mnemonic.mn_encode(seed))
1538 def prepare_seed(self, seed):
1540 # see if seed was entered as hex
1545 return OLD_SEED_VERSION, str(seed)
1549 words = seed.split()
1550 seed = mnemonic.mn_decode(words)
1552 raise Exception("Invalid seed")
1554 return OLD_SEED_VERSION, seed
1557 def create_master_keys(self, password):
1558 seed = self.get_seed(password)
1559 mpk = OldAccount.mpk_from_seed(seed)
1560 self.storage.put('master_public_key', mpk, True)
1562 def get_master_public_key(self):
1563 return self.storage.get("master_public_key")
1565 def get_master_public_keys(self):
1566 return {'Main Account':self.get_master_public_key()}
1568 def create_accounts(self, password):
1569 mpk = self.storage.get("master_public_key")
1570 self.create_account(mpk)
1572 def create_account(self, mpk):
1573 self.accounts[0] = OldAccount({'mpk':mpk, 0:[], 1:[]})
1574 self.save_accounts()
1576 def create_watching_only_wallet(self, mpk):
1577 self.seed_version = OLD_SEED_VERSION
1578 self.storage.put('seed_version', self.seed_version, True)
1579 self.storage.put('master_public_key', mpk, True)
1580 self.create_account(mpk)
1582 def get_seed(self, password):
1583 seed = pw_decode(self.seed, password).encode('utf8')
1586 def check_password(self, password):
1587 seed = pw_decode(self.seed, password)
1588 self.accounts[0].check_seed(seed)
1590 def get_mnemonic(self, password):
1592 s = self.get_seed(password)
1593 return ' '.join(mnemonic.mn_encode(s))
1596 def add_keypairs_from_KeyID(self, tx, keypairs, password):
1597 # first check the provided password
1598 for txin in tx.inputs:
1599 keyid = txin.get('KeyID')
1601 m = re.match("old\(([0-9a-f]+),(\d+),(\d+)", keyid)
1604 if mpk != self.storage.get('master_public_key'): continue
1605 for_change = int(m.group(2))
1606 num = int(m.group(3))
1607 account = self.accounts[0]
1608 addr = account.get_address(for_change, num)
1609 txin['address'] = addr # fixme: side effect
1610 pk = account.get_private_key((for_change, num), self, password)
1612 pubkey = public_key_from_private_key(sec)
1613 keypairs[pubkey] = sec
1617 def check_pending_accounts(self):
1621 # former WalletFactory
1622 class Wallet(object):
1624 def __new__(self, storage):
1625 config = storage.config
1626 if config.get('bitkey', False):
1627 # if user requested support for Bitkey device,
1628 # import Bitkey driver
1629 from wallet_bitkey import WalletBitkey
1630 return WalletBitkey(config)
1632 if storage.get('wallet_type') == '2of2':
1633 return Wallet_2of2(storage)
1635 if storage.get('wallet_type') == '2of3':
1636 return Wallet_2of3(storage)
1638 if storage.get('wallet_type') == 'imported':
1639 return Imported_Wallet(storage)
1642 if not storage.file_exists:
1643 seed_version = NEW_SEED_VERSION if config.get('bip32') is True else OLD_SEED_VERSION
1645 seed_version = storage.get('seed_version')
1646 if not seed_version:
1647 seed_version = OLD_SEED_VERSION if len(storage.get('master_public_key')) == 128 else NEW_SEED_VERSION
1649 if seed_version == OLD_SEED_VERSION:
1650 return OldWallet(storage)
1651 elif seed_version == NEW_SEED_VERSION:
1652 return NewWallet(storage)
1654 msg = "This wallet seed is not supported."
1655 if seed_version in [5]:
1656 msg += "\nTo open this wallet, try 'git checkout seed_v%d'"%seed_version
1663 def is_seed(self, seed):
1666 elif is_old_seed(seed):
1668 elif is_new_seed(seed):
1674 def is_mpk(self, mpk):
1682 return len(mpk) == 128
1685 deserialize_xkey(mpk)
1691 def is_address(self, text):
1694 for x in text.split():
1695 if not bitcoin.is_address(x):
1700 def is_private_key(self, text):
1703 for x in text.split():
1704 if not bitcoin.is_private_key(x):
1709 def from_seed(self, seed, storage):
1710 if is_old_seed(seed):
1712 elif is_new_seed(seed):
1718 def from_address(self, text, storage):
1719 w = Imported_Wallet(storage)
1720 for x in text.split():
1721 w.accounts[IMPORTED_ACCOUNT].add(x, None, None, None)
1726 def from_private_key(self, text, storage):
1727 w = Imported_Wallet(storage)
1728 for x in text.split():
1729 w.import_key(x, None)
1733 def from_mpk(self, mpk, storage):
1742 w = OldWallet(storage)
1744 w.create_watching_only_wallet(mpk)
1746 w = NewWallet(storage)
1747 w.create_watching_only_wallet(mpk)