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
46 EncodeAES = lambda secret, s: base64.b64encode(aes.encryptData(secret,s))
47 DecodeAES = lambda secret, e: aes.decryptData(secret, base64.b64decode(e))
49 def pw_encode(s, password):
51 secret = Hash(password)
52 return EncodeAES(secret, s)
56 def pw_decode(s, password):
57 if password is not None:
58 secret = Hash(password)
60 d = DecodeAES(secret, s)
62 raise Exception('Invalid password')
76 def __init__(self, config):
77 self.lock = threading.Lock()
80 self.file_exists = False
81 self.path = self.init_path(config)
82 print_error( "wallet path", self.path )
87 def init_path(self, config):
88 """Set the path of the wallet."""
90 # command line -w option
91 path = config.get('wallet_path')
96 path = config.get('default_wallet_path')
101 dirpath = os.path.join(config.path, "wallets")
102 if not os.path.exists(dirpath):
105 new_path = os.path.join(config.path, "wallets", "default_wallet")
107 # default path in pre 1.9 versions
108 old_path = os.path.join(config.path, "electrum.dat")
109 if os.path.exists(old_path) and not os.path.exists(new_path):
110 os.rename(old_path, new_path)
115 def read(self, path):
116 """Read the contents of the wallet file."""
118 with open(self.path, "r") as f:
123 d = ast.literal_eval( data ) #parse raw data from reading wallet file
125 raise IOError("Cannot read wallet file.")
128 self.file_exists = True
131 def get(self, key, default=None):
132 v = self.data.get(key)
137 def put(self, key, value, save = True):
140 if value is not None:
141 self.data[key] = value
149 f = open(self.path,"w")
152 if 'ANDROID_DATA' not in os.environ:
154 os.chmod(self.path,stat.S_IREAD | stat.S_IWRITE)
162 class Abstract_Wallet:
164 def __init__(self, storage):
166 self.storage = storage
167 self.electrum_version = ELECTRUM_VERSION
168 self.gap_limit_for_change = 3 # constant
170 self.seed_version = storage.get('seed_version', NEW_SEED_VERSION)
171 self.gap_limit = storage.get('gap_limit', 5)
172 self.use_change = storage.get('use_change',True)
173 self.use_encryption = storage.get('use_encryption', False)
174 self.seed = storage.get('seed', '') # encrypted
175 self.labels = storage.get('labels', {})
176 self.frozen_addresses = storage.get('frozen_addresses',[])
177 self.addressbook = storage.get('contacts', [])
179 self.history = storage.get('addr_history',{}) # address -> list(txid, height)
181 self.fee = int(storage.get('fee_per_kb', 10000))
183 self.master_public_keys = storage.get('master_public_keys',{})
184 self.master_private_keys = storage.get('master_private_keys', {})
186 self.next_addresses = storage.get('next_addresses',{})
189 # This attribute is set when wallet.start_threads is called.
190 self.synchronizer = None
194 self.transactions = {}
195 tx_list = self.storage.get('transactions',{})
196 for k,v in tx_list.items():
200 print_msg("Warning: Cannot deserialize transactions. skipping")
203 self.add_extra_addresses(tx)
204 self.transactions[k] = tx
206 for h,tx in self.transactions.items():
207 if not self.check_new_tx(h, tx):
208 print_error("removing unreferenced tx", h)
209 self.transactions.pop(h)
213 self.prevout_values = {} # my own transaction outputs
214 self.spent_outputs = []
219 # there is a difference between wallet.up_to_date and interface.is_up_to_date()
220 # interface.is_up_to_date() returns true when all requests have been answered and processed
221 # wallet.up_to_date is true when the wallet is synchronized (stronger requirement)
223 self.up_to_date = False
224 self.lock = threading.Lock()
225 self.transaction_lock = threading.Lock()
226 self.tx_event = threading.Event()
228 for tx_hash, tx in self.transactions.items():
229 self.update_tx_outputs(tx_hash)
232 def add_extra_addresses(self, tx):
234 # find the address corresponding to pay-to-pubkey inputs
235 tx.add_extra_addresses(self.transactions)
236 for o in tx.d.get('outputs'):
237 if o.get('is_pubkey'):
238 for tx2 in self.transactions.values():
239 tx2.add_extra_addresses({h:tx})
242 def get_action(self):
245 def load_accounts(self):
247 self.imported_keys = self.storage.get('imported_keys',{})
248 if self.imported_keys:
249 self.accounts[-1] = ImportedAccount(self.imported_keys)
251 def synchronize(self):
254 def can_create_accounts(self):
257 def check_password(self, password):
261 def set_up_to_date(self,b):
262 with self.lock: self.up_to_date = b
265 def is_up_to_date(self):
266 with self.lock: return self.up_to_date
270 self.up_to_date = False
271 while not self.is_up_to_date():
275 def import_key(self, sec, password):
276 self.check_password(password)
278 address = address_from_private_key(sec)
280 raise Exception('Invalid private key')
282 if self.is_mine(address):
283 raise Exception('Address already in wallet')
285 # store the originally requested keypair into the imported keys table
286 self.imported_keys[address] = pw_encode(sec, password )
287 self.storage.put('imported_keys', self.imported_keys, True)
288 self.accounts[-1] = ImportedAccount(self.imported_keys)
290 if self.synchronizer:
291 self.synchronizer.subscribe_to_addresses([address])
295 def delete_imported_key(self, addr):
296 if addr in self.imported_keys:
297 self.imported_keys.pop(addr)
298 self.storage.put('imported_keys', self.imported_keys, True)
299 if self.imported_keys:
300 self.accounts[-1] = ImportedAccount(self.imported_keys)
302 self.accounts.pop(-1)
305 def set_label(self, name, text = None):
307 old_text = self.labels.get(name)
310 self.labels[name] = text
314 self.labels.pop(name)
318 self.storage.put('labels', self.labels, True)
320 run_hook('set_label', name, text, changed)
326 def addresses(self, include_change = True, _next=True):
328 for a in self.accounts.keys():
329 o += self.get_account_addresses(a, include_change)
332 for addr in self.next_addresses.values():
338 def is_mine(self, address):
339 return address in self.addresses(True)
342 def is_change(self, address):
343 if not self.is_mine(address): return False
344 acct, s = self.get_address_index(address)
345 if s is None: return False
349 def get_address_index(self, address):
351 for account in self.accounts.keys():
352 for for_change in [0,1]:
353 addresses = self.accounts[account].get_addresses(for_change)
354 for addr in addresses:
356 return account, (for_change, addresses.index(addr))
358 for k,v in self.next_addresses.items():
362 raise Exception("Address not found", address)
365 def getpubkeys(self, addr):
366 assert is_valid(addr) and self.is_mine(addr)
367 account, sequence = self.get_address_index(addr)
369 a = self.accounts[account]
370 return a.get_pubkeys( sequence )
374 def get_private_key(self, address, password):
375 if self.is_watching_only():
379 if address in self.imported_keys.keys():
380 self.check_password(password)
381 out.append( pw_decode( self.imported_keys[address], password ) )
383 seed = self.get_seed(password)
384 account_id, sequence = self.get_address_index(address)
385 account = self.accounts[account_id]
386 xpubs = account.get_master_pubkeys()
387 roots = [k for k, v in self.master_public_keys.iteritems() if v in xpubs]
389 xpriv = self.get_master_private_key(root, password)
392 _, _, _, c, k = deserialize_xkey(xpriv)
393 pk = bip32_private_key( sequence, k, c )
399 def get_public_keys(self, address):
400 account_id, sequence = self.get_address_index(address)
401 return self.accounts[account_id].get_pubkeys(sequence)
404 def add_keypairs_from_wallet(self, tx, keypairs, password):
405 for txin in tx.inputs:
406 address = txin['address']
407 if not self.is_mine(address):
409 private_keys = self.get_private_key(address, password)
410 for sec in private_keys:
411 pubkey = public_key_from_private_key(sec)
412 keypairs[ pubkey ] = sec
414 # this is needed because we don't store imported pubkeys
415 if address in self.imported_keys.keys():
416 txin['redeemPubkey'] = pubkey
419 def add_keypairs_from_KeyID(self, tx, keypairs, password):
420 # first check the provided password
421 seed = self.get_seed(password)
423 for txin in tx.inputs:
424 keyid = txin.get('KeyID')
427 for s in keyid.split('&'):
428 m = re.match("bip32\((.*),(/\d+/\d+)\)", s)
431 sequence = m.group(2)
432 root = self.find_root_by_master_key(xpub)
433 if not root: continue
434 sequence = map(lambda x:int(x), sequence.strip('/').split('/'))
435 root = root + '%d'%sequence[0]
436 sequence = sequence[1:]
437 roots.append((root,sequence))
439 account_id = " & ".join( map(lambda x:x[0], roots) )
440 account = self.accounts.get(account_id)
441 if not account: continue
442 addr = account.get_address(*sequence)
443 txin['address'] = addr # fixme: side effect
444 pk = self.get_private_key(addr, password)
446 pubkey = public_key_from_private_key(sec)
447 keypairs[pubkey] = sec
451 def signrawtransaction(self, tx, input_info, private_keys, password):
453 # check that the password is correct
454 seed = self.get_seed(password)
456 # if input_info is not known, build it using wallet UTXOs
459 unspent_coins = self.get_unspent_coins()
460 for txin in tx.inputs:
461 for item in unspent_coins:
462 if txin['prevout_hash'] == item['prevout_hash'] and txin['prevout_n'] == item['prevout_n']:
463 info = { 'address':item['address'], 'scriptPubKey':item['scriptPubKey'] }
464 self.add_input_info(info)
465 input_info.append(info)
468 print_error( "input not in UTXOs" )
469 input_info.append(None)
471 # add input_info to the transaction
472 print_error("input_info", input_info)
473 tx.add_input_info(input_info)
475 # build a list of public/private keys
478 # add private keys from parameter
479 for sec in private_keys:
480 pubkey = public_key_from_private_key(sec)
481 keypairs[ pubkey ] = sec
483 # add private_keys from KeyID
484 self.add_keypairs_from_KeyID(tx, keypairs, password)
485 # add private keys from wallet
486 self.add_keypairs_from_wallet(tx, keypairs, password)
487 # sign the transaction
488 self.sign_transaction(tx, keypairs, password)
491 def sign_message(self, address, message, password):
492 keys = self.get_private_key(address, password)
493 assert len(keys) == 1
495 key = regenerate_key(sec)
496 compressed = is_compressed(sec)
497 return key.sign_message(message, compressed, address)
501 def decrypt_message(self, pubkey, message, password):
502 address = public_key_to_bc_address(pubkey.decode('hex'))
503 keys = self.get_private_key(address, password)
505 ec = regenerate_key(secret)
506 decrypted = ec.decrypt_message(message)
512 return self.history.values() != [[]] * len(self.history)
515 def add_contact(self, address, label=None):
516 self.addressbook.append(address)
517 self.storage.put('contacts', self.addressbook, True)
519 self.set_label(address, label)
522 def delete_contact(self, addr):
523 if addr in self.addressbook:
524 self.addressbook.remove(addr)
525 self.storage.put('addressbook', self.addressbook, True)
528 def fill_addressbook(self):
529 for tx_hash, tx in self.transactions.items():
530 is_relevant, is_send, _, _ = self.get_tx_value(tx)
532 for addr, v in tx.outputs:
533 if not self.is_mine(addr) and addr not in self.addressbook:
534 self.addressbook.append(addr)
536 # self.update_tx_labels()
538 def get_num_tx(self, address):
540 for tx in self.transactions.values():
541 if address in map(lambda x:x[0], tx.outputs): n += 1
545 def get_address_flags(self, addr):
546 flags = "C" if self.is_change(addr) else "I" if addr in self.imported_keys.keys() else "-"
547 flags += "F" if addr in self.frozen_addresses else "-"
551 def get_tx_value(self, tx, account=None):
552 domain = self.get_account_addresses(account)
553 return tx.get_value(domain, self.prevout_values)
556 def update_tx_outputs(self, tx_hash):
557 tx = self.transactions.get(tx_hash)
559 for i, (addr, value) in enumerate(tx.outputs):
560 key = tx_hash+ ':%d'%i
561 self.prevout_values[key] = value
563 for item in tx.inputs:
564 if self.is_mine(item.get('address')):
565 key = item['prevout_hash'] + ':%d'%item['prevout_n']
566 self.spent_outputs.append(key)
569 def get_addr_balance(self, address):
570 #assert self.is_mine(address)
571 h = self.history.get(address,[])
572 if h == ['*']: return 0,0
574 received_coins = [] # list of coins received at address
576 for tx_hash, tx_height in h:
577 tx = self.transactions.get(tx_hash)
580 for i, (addr, value) in enumerate(tx.outputs):
582 key = tx_hash + ':%d'%i
583 received_coins.append(key)
585 for tx_hash, tx_height in h:
586 tx = self.transactions.get(tx_hash)
590 for item in tx.inputs:
591 addr = item.get('address')
593 key = item['prevout_hash'] + ':%d'%item['prevout_n']
594 value = self.prevout_values.get( key )
595 if key in received_coins:
598 for i, (addr, value) in enumerate(tx.outputs):
599 key = tx_hash + ':%d'%i
610 def get_account_name(self, k):
611 return self.labels.get(k, self.accounts[k].get_name(k))
614 def get_account_names(self):
616 for k in self.accounts.keys():
617 account_names[k] = self.get_account_name(k)
621 def get_account_addresses(self, a, include_change=True):
623 o = self.addresses(True)
624 elif a in self.accounts:
625 ac = self.accounts[a]
626 o = ac.get_addresses(0)
627 if include_change: o += ac.get_addresses(1)
631 def get_account_balance(self, account):
632 return self.get_balance(self.get_account_addresses(account))
634 def get_frozen_balance(self):
635 return self.get_balance(self.frozen_addresses)
637 def get_balance(self, domain=None):
638 if domain is None: domain = self.addresses(True)
641 c, u = self.get_addr_balance(addr)
647 def get_unspent_coins(self, domain=None):
649 if domain is None: domain = self.addresses(True)
651 h = self.history.get(addr, [])
652 if h == ['*']: continue
653 for tx_hash, tx_height in h:
654 tx = self.transactions.get(tx_hash)
655 if tx is None: raise Exception("Wallet not synchronized")
656 is_coinbase = tx.inputs[0].get('prevout_hash') == '0'*64
657 for o in tx.d.get('outputs'):
659 if output.get('address') != addr: continue
660 key = tx_hash + ":%d" % output.get('prevout_n')
661 if key in self.spent_outputs: continue
662 output['prevout_hash'] = tx_hash
663 output['height'] = tx_height
664 output['coinbase'] = is_coinbase
665 coins.append((tx_height, output))
669 coins = sorted(coins)
670 if coins[-1][0] != 0:
671 while coins[0][0] == 0:
672 coins = coins[1:] + [ coins[0] ]
673 return [x[1] for x in coins]
676 def choose_tx_inputs( self, amount, fixed_fee, num_outputs, domain = None ):
677 """ todo: minimize tx size """
679 fee = self.fee if fixed_fee is None else fixed_fee
681 domain = self.addresses(True)
683 for i in self.frozen_addresses:
684 if i in domain: domain.remove(i)
686 coins = self.get_unspent_coins(domain)
690 if item.get('coinbase') and item.get('height') + COINBASE_MATURITY > self.network.get_local_height():
692 addr = item.get('address')
693 v = item.get('value')
696 fee = self.estimated_fee(inputs, num_outputs) if fixed_fee is None else fixed_fee
697 if total >= amount + fee: break
701 return inputs, total, fee
704 def set_fee(self, fee):
707 self.storage.put('fee_per_kb', self.fee, True)
709 def estimated_fee(self, inputs, num_outputs):
710 estimated_size = len(inputs) * 180 + num_outputs * 34 # this assumes non-compressed keys
711 fee = self.fee * int(math.ceil(estimated_size/1000.))
715 def add_tx_change( self, inputs, outputs, amount, fee, total, change_addr=None):
716 "add change to a transaction"
717 change_amount = total - ( amount + fee )
718 if change_amount > DUST_THRESHOLD:
721 # send change to one of the accounts involved in the tx
722 address = inputs[0].get('address')
723 account, _ = self.get_address_index(address)
725 if not self.use_change or account == -1:
726 change_addr = inputs[-1]['address']
728 change_addr = self.accounts[account].get_addresses(1)[-self.gap_limit_for_change]
730 # Insert the change output at a random position in the outputs
731 posn = random.randint(0, len(outputs))
732 outputs[posn:posn] = [( change_addr, change_amount)]
736 def get_history(self, address):
738 return self.history.get(address)
741 def get_status(self, h):
742 if not h: return None
743 if h == ['*']: return '*'
745 for tx_hash, height in h:
746 status += tx_hash + ':%d:' % height
747 return hashlib.sha256( status ).digest().encode('hex')
750 def receive_tx_callback(self, tx_hash, tx, tx_height):
752 with self.transaction_lock:
753 self.add_extra_addresses(tx)
754 if not self.check_new_tx(tx_hash, tx):
755 # may happen due to pruning
756 print_error("received transaction that is no longer referenced in history", tx_hash)
758 self.transactions[tx_hash] = tx
759 self.network.pending_transactions_for_notifications.append(tx)
760 self.save_transactions()
761 if self.verifier and tx_height>0:
762 self.verifier.add(tx_hash, tx_height)
763 self.update_tx_outputs(tx_hash)
766 def save_transactions(self):
768 for k,v in self.transactions.items():
770 self.storage.put('transactions', tx, True)
772 def receive_history_callback(self, addr, hist):
774 if not self.check_new_history(addr, hist):
775 raise Exception("error: received history for %s is not consistent with known transactions"%addr)
778 self.history[addr] = hist
779 self.storage.put('addr_history', self.history, True)
782 for tx_hash, tx_height in hist:
784 # add it in case it was previously unconfirmed
785 if self.verifier: self.verifier.add(tx_hash, tx_height)
788 def get_tx_history(self, account=None):
789 if not self.verifier:
792 with self.transaction_lock:
793 history = self.transactions.items()
794 history.sort(key = lambda x: self.verifier.get_txpos(x[0]))
798 for tx_hash, tx in history:
799 is_relevant, is_mine, v, fee = self.get_tx_value(tx, account)
800 if v is not None: balance += v
802 c, u = self.get_account_balance(account)
805 result.append( ('', 1000, 0, c+u-balance, None, c+u-balance, None ) )
807 balance = c + u - balance
808 for tx_hash, tx in history:
809 is_relevant, is_mine, value, fee = self.get_tx_value(tx, account)
812 if value is not None:
815 conf, timestamp = self.verifier.get_confirmations(tx_hash) if self.verifier else (None, None)
816 result.append( (tx_hash, conf, is_mine, value, fee, balance, timestamp) )
821 def get_label(self, tx_hash):
822 label = self.labels.get(tx_hash)
823 is_default = (label == '') or (label is None)
824 if is_default: label = self.get_default_label(tx_hash)
825 return label, is_default
828 def get_default_label(self, tx_hash):
829 tx = self.transactions.get(tx_hash)
832 is_relevant, is_mine, _, _ = self.get_tx_value(tx)
836 if not self.is_mine(o_addr):
838 default_label = self.labels[o_addr]
840 default_label = '>' + o_addr
843 default_label = '(internal)'
847 if self.is_mine(o_addr) and not self.is_change(o_addr):
852 if self.is_mine(o_addr):
858 dest_label = self.labels.get(o_addr)
860 default_label = self.labels[o_addr]
862 default_label = '<' + o_addr
867 def make_unsigned_transaction(self, outputs, fee=None, change_addr=None, domain=None ):
868 for address, x in outputs:
869 assert is_valid(address), "Address " + address + " is invalid!"
870 amount = sum( map(lambda x:x[1], outputs) )
871 inputs, total, fee = self.choose_tx_inputs( amount, fee, len(outputs), domain )
873 raise ValueError("Not enough funds")
875 self.add_input_info(txin)
876 outputs = self.add_tx_change(inputs, outputs, amount, fee, total, change_addr)
877 return Transaction.from_io(inputs, outputs)
880 def mktx(self, outputs, password, fee=None, change_addr=None, domain= None ):
881 tx = self.make_unsigned_transaction(outputs, fee, change_addr, domain)
883 self.add_keypairs_from_wallet(tx, keypairs, password)
885 self.sign_transaction(tx, keypairs, password)
889 def add_input_info(self, txin):
890 address = txin['address']
891 if address in self.imported_keys.keys():
893 account_id, sequence = self.get_address_index(address)
894 account = self.accounts[account_id]
895 txin['KeyID'] = account.get_keyID(sequence)
896 redeemScript = account.redeem_script(sequence)
898 txin['redeemScript'] = redeemScript
900 txin['redeemPubkey'] = account.get_pubkey(*sequence)
903 def sign_transaction(self, tx, keypairs, password):
905 run_hook('sign_transaction', tx, password)
908 def sendtx(self, tx):
912 return self.receive_tx(h, tx)
914 def send_tx(self, tx):
916 self.tx_event.clear()
917 self.network.send([('blockchain.transaction.broadcast', [str(tx)])], self.on_broadcast)
920 def on_broadcast(self, i, r):
921 self.tx_result = r.get('result')
924 def receive_tx(self, tx_hash, tx):
927 return False, "error: " + out
928 run_hook('receive_tx', tx, self)
932 def update_password(self, old_password, new_password):
933 if new_password == '':
937 decoded = self.get_seed(old_password)
938 self.seed = pw_encode( decoded, new_password)
939 self.storage.put('seed', self.seed, True)
941 for k in self.imported_keys.keys():
942 a = self.imported_keys[k]
943 b = pw_decode(a, old_password)
944 c = pw_encode(b, new_password)
945 self.imported_keys[k] = c
946 self.storage.put('imported_keys', self.imported_keys, True)
948 for k, v in self.master_private_keys.items():
949 b = pw_decode(v, old_password)
950 c = pw_encode(b, new_password)
951 self.master_private_keys[k] = c
952 self.storage.put('master_private_keys', self.master_private_keys, True)
954 self.use_encryption = (new_password != None)
955 self.storage.put('use_encryption', self.use_encryption,True)
958 def freeze(self,addr):
959 if self.is_mine(addr) and addr not in self.frozen_addresses:
960 self.frozen_addresses.append(addr)
961 self.storage.put('frozen_addresses', self.frozen_addresses, True)
967 def unfreeze(self,addr):
968 if self.is_mine(addr) and addr in self.frozen_addresses:
969 self.frozen_addresses.remove(addr)
970 self.storage.put('frozen_addresses', self.frozen_addresses, True)
976 def set_verifier(self, verifier):
977 self.verifier = verifier
979 # review transactions that are in the history
980 for addr, hist in self.history.items():
981 if hist == ['*']: continue
982 for tx_hash, tx_height in hist:
984 # add it in case it was previously unconfirmed
985 self.verifier.add(tx_hash, tx_height)
987 # if we are on a pruning server, remove unverified transactions
988 vr = self.verifier.transactions.keys() + self.verifier.verified_tx.keys()
989 for tx_hash in self.transactions.keys():
990 if tx_hash not in vr:
991 self.transactions.pop(tx_hash)
994 def check_new_history(self, addr, hist):
996 # check that all tx in hist are relevant
998 for tx_hash, height in hist:
999 tx = self.transactions.get(tx_hash)
1001 if not tx.has_address(addr):
1004 # check that we are not "orphaning" a transaction
1005 old_hist = self.history.get(addr,[])
1006 if old_hist == ['*']: return True
1008 for tx_hash, height in old_hist:
1009 if tx_hash in map(lambda x:x[0], hist): continue
1011 for _addr, _hist in self.history.items():
1012 if _addr == addr: continue
1013 if _hist == ['*']: continue
1014 _tx_hist = map(lambda x:x[0], _hist)
1015 if tx_hash in _tx_hist:
1020 tx = self.transactions.get(tx_hash)
1021 # tx might not be there
1025 if self.verifier.get_height(tx_hash):
1028 print_error("new history is orphaning transaction:", tx_hash)
1029 # check that all outputs are not mine, request histories
1031 for _addr, _v in tx.outputs:
1032 # assert not self.is_mine(_addr)
1033 ext_requests.append( ('blockchain.address.get_history', [_addr]) )
1035 ext_h = self.network.synchronous_get(ext_requests)
1036 print_error("sync:", ext_requests, ext_h)
1039 if h == ['*']: continue
1041 if item.get('tx_hash') == tx_hash:
1042 height = item.get('height')
1044 print_error("found height for", tx_hash, height)
1045 self.verifier.add(tx_hash, height)
1047 print_error("removing orphaned tx from history", tx_hash)
1048 self.transactions.pop(tx_hash)
1053 def check_new_tx(self, tx_hash, tx):
1054 # 1 check that tx is referenced in addr_history.
1056 for addr, hist in self.history.items():
1057 if hist == ['*']:continue
1058 for txh, height in hist:
1060 addresses.append(addr)
1065 # 2 check that referencing addresses are in the tx
1066 for addr in addresses:
1067 if not tx.has_address(addr):
1073 def start_threads(self, network):
1074 from verifier import TxVerifier
1075 self.network = network
1076 if self.network is not None:
1077 self.verifier = TxVerifier(self.network, self.storage)
1078 self.verifier.start()
1079 self.set_verifier(self.verifier)
1080 self.synchronizer = WalletSynchronizer(self, network)
1081 self.synchronizer.start()
1083 self.verifier = None
1084 self.synchronizer =None
1086 def stop_threads(self):
1088 self.verifier.stop()
1089 self.synchronizer.stop()
1091 def restore(self, cb):
1094 def get_accounts(self):
1095 return self.accounts
1098 class Imported_Wallet(Abstract_Wallet):
1100 def __init__(self, storage):
1101 Abstract_Wallet.__init__(self, storage)
1103 def is_watching_only(self):
1104 n = self.imported_keys.values()
1105 return n == [''] * len(n)
1110 def is_deterministic(self):
1113 def check_password(self, password):
1114 if self.imported_keys:
1115 k, v = self.imported_keys.items()[0]
1116 sec = pw_decode(v, password)
1117 address = address_from_private_key(sec)
1123 class Deterministic_Wallet(Abstract_Wallet):
1125 def __init__(self, storage):
1126 Abstract_Wallet.__init__(self, storage)
1129 return self.seed != ''
1131 def is_deterministic(self):
1134 def is_watching_only(self):
1135 return not self.has_seed()
1137 def check_password(self, password):
1138 self.get_seed(password)
1140 def add_seed(self, seed, password):
1142 raise Exception("a seed exists")
1144 self.seed_version, self.seed = self.prepare_seed(seed)
1146 self.seed = pw_encode( self.seed, password)
1147 self.use_encryption = True
1149 self.use_encryption = False
1151 self.storage.put('seed', self.seed, True)
1152 self.storage.put('seed_version', self.seed_version, True)
1153 self.storage.put('use_encryption', self.use_encryption,True)
1154 self.create_master_keys(password)
1156 def get_seed(self, password):
1157 s = pw_decode(self.seed, password)
1158 seed = mnemonic_to_seed(s,'').encode('hex')
1161 def get_mnemonic(self, password):
1162 return pw_decode(self.seed, password)
1164 def change_gap_limit(self, value):
1165 if value >= self.gap_limit:
1166 self.gap_limit = value
1167 self.storage.put('gap_limit', self.gap_limit, True)
1168 #self.interface.poke('synchronizer')
1171 elif value >= self.min_acceptable_gap():
1172 for key, account in self.accounts.items():
1173 addresses = account[0]
1174 k = self.num_unused_trailing_addresses(addresses)
1175 n = len(addresses) - k + value
1176 addresses = addresses[0:n]
1177 self.accounts[key][0] = addresses
1179 self.gap_limit = value
1180 self.storage.put('gap_limit', self.gap_limit, True)
1181 self.save_accounts()
1186 def num_unused_trailing_addresses(self, addresses):
1188 for a in addresses[::-1]:
1189 if self.history.get(a):break
1193 def min_acceptable_gap(self):
1194 # fixme: this assumes wallet is synchronized
1198 for account in self.accounts.values():
1199 addresses = account.get_addresses(0)
1200 k = self.num_unused_trailing_addresses(addresses)
1201 for a in addresses[0:-k]:
1202 if self.history.get(a):
1206 if n > nmax: nmax = n
1210 def address_is_old(self, address):
1212 h = self.history.get(address, [])
1215 for tx_hash, tx_height in h:
1219 tx_age = self.network.get_local_height() - tx_height + 1
1225 def synchronize_sequence(self, account, for_change):
1226 limit = self.gap_limit_for_change if for_change else self.gap_limit
1229 addresses = account.get_addresses(for_change)
1230 if len(addresses) < limit:
1231 address = account.create_new_address(for_change)
1232 self.history[address] = []
1233 new_addresses.append( address )
1236 if map( lambda a: self.address_is_old(a), addresses[-limit:] ) == limit*[False]:
1239 address = account.create_new_address(for_change)
1240 self.history[address] = []
1241 new_addresses.append( address )
1243 return new_addresses
1246 def check_pending_accounts(self):
1247 for account_id, addr in self.next_addresses.items():
1248 if self.address_is_old(addr):
1249 print_error( "creating account", account_id )
1250 xpub = self.master_public_keys[account_id]
1251 account = BIP32_Account({'xpub':xpub})
1252 self.add_account(account_id, account)
1253 self.next_addresses.pop(account_id)
1256 def synchronize_account(self, account):
1258 new += self.synchronize_sequence(account, 0)
1259 new += self.synchronize_sequence(account, 1)
1263 def synchronize(self):
1264 self.check_pending_accounts()
1266 for account in self.accounts.values():
1267 if type(account) in [ImportedAccount, PendingAccount]:
1269 new += self.synchronize_account(account)
1271 self.save_accounts()
1272 self.storage.put('addr_history', self.history, True)
1276 def restore(self, callback):
1278 def wait_for_wallet():
1279 self.set_up_to_date(False)
1280 while not self.is_up_to_date():
1281 msg = "%s\n%s %d\n%s %.1f"%(
1282 _("Please wait..."),
1283 _("Addresses generated:"),
1284 len(self.addresses(True)),
1285 _("Kilobytes received:"),
1286 self.network.interface.bytes_received/1024.)
1288 apply(callback, (msg,))
1291 def wait_for_network():
1292 while not self.network.is_connected():
1293 msg = "%s \n" % (_("Connecting..."))
1294 apply(callback, (msg,))
1297 # wait until we are connected, because the user might have selected another server
1304 self.fill_addressbook()
1307 def create_account(self, name, password):
1308 i = self.num_accounts()
1309 account_id = self.account_id(i)
1310 account = self.make_account(account_id, password)
1311 self.add_account(account_id, account)
1313 self.set_label(account_id, name)
1315 # add address of the next account
1316 _, _ = self.next_account_address(password)
1319 def add_account(self, account_id, account):
1320 self.accounts[account_id] = account
1321 self.save_accounts()
1324 def save_accounts(self):
1326 for k, v in self.accounts.items():
1328 self.storage.put('accounts', d, True)
1332 def load_accounts(self):
1333 Abstract_Wallet.load_accounts(self)
1334 d = self.storage.get('accounts', {})
1335 for k, v in d.items():
1337 v['mpk'] = self.storage.get('master_public_key')
1338 self.accounts[k] = OldAccount(v)
1339 elif v.get('xpub3'):
1340 self.accounts[k] = BIP32_Account_2of3(v)
1341 elif v.get('xpub2'):
1342 self.accounts[k] = BIP32_Account_2of2(v)
1344 self.accounts[k] = BIP32_Account(v)
1345 elif v.get('pending'):
1346 self.accounts[k] = PendingAccount(v)
1348 print_error("cannot load account", v)
1351 def account_is_pending(self, k):
1352 return type(self.accounts.get(k)) == PendingAccount
1354 def delete_pending_account(self, k):
1355 assert self.account_is_pending(k)
1356 self.accounts.pop(k)
1357 self.save_accounts()
1359 def create_pending_account(self, name, password):
1360 account_id, addr = self.next_account_address(password)
1361 self.set_label(account_id, name)
1362 self.accounts[account_id] = PendingAccount({'pending':addr})
1363 self.save_accounts()
1368 class NewWallet(Deterministic_Wallet):
1370 def __init__(self, storage):
1371 Deterministic_Wallet.__init__(self, storage)
1373 def can_create_accounts(self):
1374 return not self.is_watching_only()
1376 def get_master_public_key(self):
1377 return self.master_public_keys["m/"]
1379 def get_master_public_keys(self):
1381 for k, account in self.accounts.items():
1382 name = self.get_account_name(k)
1383 mpk_text = '\n\n'.join( account.get_master_pubkeys() )
1384 out[name] = mpk_text
1387 def get_master_private_key(self, account, password):
1388 k = self.master_private_keys.get(account)
1390 xpriv = pw_decode( k, password)
1394 def create_watching_only_wallet(self, xpub):
1395 self.storage.put('seed_version', self.seed_version, True)
1396 self.add_master_public_key("m/", xpub)
1397 account = BIP32_Account({'xpub':xpub})
1398 self.add_account("m/", account)
1401 def create_accounts(self, password):
1402 seed = pw_decode(self.seed, password)
1403 self.create_account('Main account', password)
1406 def add_master_public_key(self, name, mpk):
1407 self.master_public_keys[name] = mpk
1408 self.storage.put('master_public_keys', self.master_public_keys, True)
1411 def add_master_private_key(self, name, xpriv, password):
1412 self.master_private_keys[name] = pw_encode(xpriv, password)
1413 self.storage.put('master_private_keys', self.master_private_keys, True)
1416 def add_master_keys(self, root, account_id, password):
1417 x = self.master_private_keys.get(root)
1419 master_xpriv = pw_decode(x, password )
1420 xpriv, xpub = bip32_private_derivation(master_xpriv, root, account_id)
1421 self.add_master_public_key(account_id, xpub)
1422 self.add_master_private_key(account_id, xpriv, password)
1424 master_xpub = self.master_public_keys[root]
1425 xpub = bip32_public_derivation(master_xpub, root, account_id)
1426 self.add_master_public_key(account_id, xpub)
1430 def create_master_keys(self, password):
1431 xpriv, xpub = bip32_root(self.get_seed(password))
1432 self.add_master_public_key("m/", xpub)
1433 self.add_master_private_key("m/", xpriv, password)
1436 def find_root_by_master_key(self, xpub):
1437 for key, xpub2 in self.master_public_keys.items():
1438 if key == "m/":continue
1443 def num_accounts(self):
1444 keys = self.accounts.keys()
1447 account_id = self.account_id(i)
1448 if account_id not in keys: break
1453 def next_account_address(self, password):
1454 i = self.num_accounts()
1455 account_id = self.account_id(i)
1457 addr = self.next_addresses.get(account_id)
1459 account = self.make_account(account_id, password)
1460 addr = account.first_address()
1461 self.next_addresses[account_id] = addr
1462 self.storage.put('next_addresses', self.next_addresses)
1464 return account_id, addr
1466 def account_id(self, i):
1469 def make_account(self, account_id, password):
1470 """Creates and saves the master keys, but does not save the account"""
1471 xpub = self.add_master_keys("m/", account_id, password)
1472 account = BIP32_Account({'xpub':xpub})
1476 def make_seed(self):
1477 import mnemonic, ecdsa
1478 entropy = ecdsa.util.randrange( pow(2,160) )
1481 ss = "%040x"%(entropy+nonce)
1482 s = hashlib.sha256(ss.decode('hex')).digest().encode('hex')
1483 # we keep only 13 words, that's approximately 139 bits of entropy
1484 words = mnemonic.mn_encode(s)[0:13]
1485 seed = ' '.join(words)
1486 if is_new_seed(seed):
1487 break # this will remove 8 bits of entropy
1491 def prepare_seed(self, seed):
1493 return NEW_SEED_VERSION, unicodedata.normalize('NFC', unicode(seed.strip()))
1497 class Wallet_2of2(NewWallet):
1499 def __init__(self, storage):
1500 NewWallet.__init__(self, storage)
1501 self.storage.put('wallet_type', '2of2', True)
1503 def create_account(self):
1504 xpub1 = self.master_public_keys.get("m/")
1505 xpub2 = self.master_public_keys.get("cold/")
1506 account = BIP32_Account_2of2({'xpub':xpub1, 'xpub2':xpub2})
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 return {'hot':xpub1, 'cold':xpub2}
1514 def get_action(self):
1515 xpub1 = self.master_public_keys.get("m/")
1516 xpub2 = self.master_public_keys.get("cold/")
1518 return 'create_2of2_1'
1520 return 'create_2of2_2'
1524 class Wallet_2of3(Wallet_2of2):
1526 def __init__(self, storage):
1527 Wallet_2of2.__init__(self, storage)
1528 self.storage.put('wallet_type', '2of3', True)
1530 def create_account(self):
1531 xpub1 = self.master_public_keys.get("m/")
1532 xpub2 = self.master_public_keys.get("cold/")
1533 xpub3 = self.master_public_keys.get("remote/")
1534 account = BIP32_Account_2of3({'xpub':xpub1, 'xpub2':xpub2, 'xpub3':xpub3})
1535 self.add_account('m/', account)
1537 def get_master_public_keys(self):
1538 xpub1 = self.master_public_keys.get("m/")
1539 xpub2 = self.master_public_keys.get("cold/")
1540 xpub3 = self.master_public_keys.get("remote/")
1541 return {'hot':xpub1, 'cold':xpub2, 'remote':xpub3}
1543 def get_action(self):
1544 xpub1 = self.master_public_keys.get("m/")
1545 xpub2 = self.master_public_keys.get("cold/")
1546 xpub3 = self.master_public_keys.get("remote/")
1548 return 'create_2of3_1'
1550 return 'create_2of3_2'
1552 return 'create_2of3_3'
1558 class OldWallet(Deterministic_Wallet):
1560 def make_seed(self):
1562 seed = random_seed(128)
1563 return ' '.join(mnemonic.mn_encode(seed))
1565 def prepare_seed(self, seed):
1567 # see if seed was entered as hex
1572 return OLD_SEED_VERSION, str(seed)
1576 words = seed.split()
1577 seed = mnemonic.mn_decode(words)
1579 raise Exception("Invalid seed")
1581 return OLD_SEED_VERSION, seed
1584 def create_master_keys(self, password):
1585 seed = pw_decode(self.seed, password)
1586 mpk = OldAccount.mpk_from_seed(seed)
1587 self.storage.put('master_public_key', mpk, True)
1589 def get_master_public_key(self):
1590 return self.storage.get("master_public_key")
1592 def get_master_public_keys(self):
1593 return {'Main Account':self.get_master_public_key()}
1595 def create_accounts(self, password):
1596 mpk = self.storage.get("master_public_key")
1597 self.create_account(mpk)
1599 def create_account(self, mpk):
1600 self.accounts[0] = OldAccount({'mpk':mpk, 0:[], 1:[]})
1601 self.save_accounts()
1603 def create_watching_only_wallet(self, mpk):
1604 self.seed_version = OLD_SEED_VERSION
1605 self.storage.put('seed_version', self.seed_version, True)
1606 self.storage.put('master_public_key', mpk, True)
1607 self.create_account(mpk)
1609 def get_seed(self, password):
1610 seed = pw_decode(self.seed, password)
1611 self.accounts[0].check_seed(seed)
1614 def get_mnemonic(self, password):
1616 s = pw_decode(self.seed, password)
1617 return ' '.join(mnemonic.mn_encode(s))
1620 def add_keypairs_from_KeyID(self, tx, keypairs, password):
1621 # first check the provided password
1622 seed = self.get_seed(password)
1623 for txin in tx.inputs:
1624 keyid = txin.get('KeyID')
1626 m = re.match("old\(([0-9a-f]+),(\d+),(\d+)", keyid)
1629 if mpk != self.storage.get('master_public_key'): continue
1630 for_change = int(m.group(2))
1631 num = int(m.group(3))
1632 account = self.accounts[0]
1633 addr = account.get_address(for_change, num)
1634 txin['address'] = addr # fixme: side effect
1635 pk = account.get_private_key(seed, (for_change, num))
1636 pubkey = public_key_from_private_key(pk)
1637 keypairs[pubkey] = pk
1641 def get_private_key(self, address, password):
1642 if self.is_watching_only():
1646 if address in self.imported_keys.keys():
1647 self.check_password(password)
1648 out.append( pw_decode( self.imported_keys[address], password ) )
1650 seed = self.get_seed(password)
1651 account_id, sequence = self.get_address_index(address)
1652 pk = self.accounts[0].get_private_key(seed, sequence)
1656 def check_pending_accounts(self):
1660 # former WalletFactory
1661 class Wallet(object):
1663 def __new__(self, storage):
1664 config = storage.config
1665 if config.get('bitkey', False):
1666 # if user requested support for Bitkey device,
1667 # import Bitkey driver
1668 from wallet_bitkey import WalletBitkey
1669 return WalletBitkey(config)
1671 if storage.get('wallet_type') == '2of2':
1672 return Wallet_2of2(storage)
1674 if storage.get('wallet_type') == '2of3':
1675 return Wallet_2of3(storage)
1677 if storage.file_exists and not storage.get('seed'):
1678 # wallet made of imported keys
1679 return Imported_Wallet(storage)
1682 if not storage.file_exists:
1683 seed_version = NEW_SEED_VERSION if config.get('bip32') is True else OLD_SEED_VERSION
1685 seed_version = storage.get('seed_version')
1686 if not seed_version:
1687 seed_version = OLD_SEED_VERSION if len(storage.get('master_public_key')) == 128 else NEW_SEED_VERSION
1689 if seed_version == OLD_SEED_VERSION:
1690 return OldWallet(storage)
1691 elif seed_version == NEW_SEED_VERSION:
1692 return NewWallet(storage)
1694 msg = "This wallet seed is not supported."
1695 if seed_version in [5]:
1696 msg += "\nTo open this wallet, try 'git checkout seed_v%d'"%seed_version
1703 def is_seed(self, seed):
1706 elif is_old_seed(seed):
1708 elif is_new_seed(seed):
1714 def is_mpk(self, mpk):
1722 return len(mpk) == 128
1725 deserialize_xkey(mpk)
1731 def is_address(self, text):
1732 for x in text.split():
1733 if not bitcoin.is_address(x):
1738 def is_private_key(self, text):
1739 for x in text.split():
1740 if not bitcoin.is_private_key(x):
1745 def from_seed(self, seed, storage):
1746 if is_old_seed(seed):
1748 elif is_new_seed(seed):
1754 def from_address(self, text, storage):
1755 w = Imported_Wallet(storage)
1756 for x in text.split():
1757 w.imported_keys[x] = ''
1758 w.storage.put('imported_keys', w.imported_keys, True)
1762 def from_private_key(self, text, storage):
1763 w = Imported_Wallet(storage)
1764 for x in text.split():
1765 w.import_key(x, None)
1769 def from_mpk(self, mpk, storage):
1778 w = OldWallet(storage)
1780 w.create_watching_only_wallet(mpk)
1782 w = NewWallet(storage)
1783 w.create_watching_only_wallet(mpk)