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.imported_keys = storage.get('imported_keys',{})
180 self.history = storage.get('addr_history',{}) # address -> list(txid, height)
182 self.fee = int(storage.get('fee_per_kb', 10000))
184 self.master_public_keys = storage.get('master_public_keys',{})
185 self.master_private_keys = storage.get('master_private_keys', {})
187 self.next_addresses = storage.get('next_addresses',{})
190 # This attribute is set when wallet.start_threads is called.
191 self.synchronizer = None
195 self.transactions = {}
196 tx_list = self.storage.get('transactions',{})
197 for k,v in tx_list.items():
201 print_msg("Warning: Cannot deserialize transactions. skipping")
204 self.add_extra_addresses(tx)
205 self.transactions[k] = tx
207 for h,tx in self.transactions.items():
208 if not self.check_new_tx(h, tx):
209 print_error("removing unreferenced tx", h)
210 self.transactions.pop(h)
214 self.prevout_values = {} # my own transaction outputs
215 self.spent_outputs = []
220 # there is a difference between wallet.up_to_date and interface.is_up_to_date()
221 # interface.is_up_to_date() returns true when all requests have been answered and processed
222 # wallet.up_to_date is true when the wallet is synchronized (stronger requirement)
224 self.up_to_date = False
225 self.lock = threading.Lock()
226 self.transaction_lock = threading.Lock()
227 self.tx_event = threading.Event()
229 for tx_hash, tx in self.transactions.items():
230 self.update_tx_outputs(tx_hash)
233 def add_extra_addresses(self, tx):
235 # find the address corresponding to pay-to-pubkey inputs
236 tx.add_extra_addresses(self.transactions)
237 for o in tx.d.get('outputs'):
238 if o.get('is_pubkey'):
239 for tx2 in self.transactions.values():
240 tx2.add_extra_addresses({h:tx})
243 def get_action(self):
246 def load_accounts(self):
249 def synchronize(self):
252 def get_pending_accounts(self):
255 def can_create_accounts(self):
258 def check_password(self, password):
262 def set_up_to_date(self,b):
263 with self.lock: self.up_to_date = b
266 def is_up_to_date(self):
267 with self.lock: return self.up_to_date
271 self.up_to_date = False
272 while not self.is_up_to_date():
276 def import_key(self, sec, password):
277 self.check_password(password)
279 address = address_from_private_key(sec)
281 raise Exception('Invalid private key')
283 if self.is_mine(address):
284 raise Exception('Address already in wallet')
286 # store the originally requested keypair into the imported keys table
287 self.imported_keys[address] = pw_encode(sec, password )
288 self.storage.put('imported_keys', self.imported_keys, True)
289 if self.synchronizer:
290 self.synchronizer.subscribe_to_addresses([address])
294 def delete_imported_key(self, addr):
295 if addr in self.imported_keys:
296 self.imported_keys.pop(addr)
297 self.storage.put('imported_keys', self.imported_keys, True)
301 def set_label(self, name, text = None):
303 old_text = self.labels.get(name)
306 self.labels[name] = text
310 self.labels.pop(name)
314 self.storage.put('labels', self.labels, True)
316 run_hook('set_label', name, text, changed)
322 def addresses(self, include_change = True, _next=True):
323 o = self.get_account_addresses(-1, include_change)
324 for a in self.accounts.keys():
325 o += self.get_account_addresses(a, include_change)
328 for addr in self.next_addresses.values():
334 def is_mine(self, address):
335 return address in self.addresses(True)
338 def is_change(self, address):
339 if not self.is_mine(address): return False
340 if address in self.imported_keys.keys(): return False
341 acct, s = self.get_address_index(address)
342 if s is None: return False
346 def get_address_index(self, address):
347 if address in self.imported_keys.keys():
350 for account in self.accounts.keys():
351 for for_change in [0,1]:
352 addresses = self.accounts[account].get_addresses(for_change)
353 for addr in addresses:
355 return account, (for_change, addresses.index(addr))
357 for k,v in self.next_addresses.items():
361 raise Exception("Address not found", address)
364 def getpubkeys(self, addr):
365 assert is_valid(addr) and self.is_mine(addr)
366 account, sequence = self.get_address_index(addr)
368 a = self.accounts[account]
369 return a.get_pubkeys( sequence )
373 def get_private_key(self, address, password):
374 if self.is_watching_only():
377 # first check the provided password
378 seed = self.get_seed(password)
381 if address in self.imported_keys.keys():
382 out.append( pw_decode( self.imported_keys[address], 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
413 if address in self.imported_keys.keys():
414 txin['redeemPubkey'] = pubkey
417 def add_keypairs_from_KeyID(self, tx, keypairs, password):
418 # first check the provided password
419 seed = self.get_seed(password)
421 for txin in tx.inputs:
422 keyid = txin.get('KeyID')
425 for s in keyid.split('&'):
426 m = re.match("bip32\((.*),(/\d+/\d+)\)", s)
429 sequence = m.group(2)
430 root = self.find_root_by_master_key(xpub)
431 if not root: continue
432 sequence = map(lambda x:int(x), sequence.strip('/').split('/'))
433 root = root + '%d'%sequence[0]
434 sequence = sequence[1:]
435 roots.append((root,sequence))
437 account_id = " & ".join( map(lambda x:x[0], roots) )
438 account = self.accounts.get(account_id)
439 if not account: continue
440 addr = account.get_address(*sequence)
441 txin['address'] = addr # fixme: side effect
442 pk = self.get_private_key(addr, password)
444 pubkey = public_key_from_private_key(sec)
445 keypairs[pubkey] = sec
449 def signrawtransaction(self, tx, input_info, private_keys, password):
451 # check that the password is correct
452 seed = self.get_seed(password)
454 # if input_info is not known, build it using wallet UTXOs
457 unspent_coins = self.get_unspent_coins()
458 for txin in tx.inputs:
459 for item in unspent_coins:
460 if txin['prevout_hash'] == item['prevout_hash'] and txin['prevout_n'] == item['prevout_n']:
461 info = { 'address':item['address'], 'scriptPubKey':item['scriptPubKey'] }
462 self.add_input_info(info)
463 input_info.append(info)
466 print_error( "input not in UTXOs" )
467 input_info.append(None)
469 # add input_info to the transaction
470 print_error("input_info", input_info)
471 tx.add_input_info(input_info)
473 # build a list of public/private keys
476 # add private keys from parameter
477 for sec in private_keys:
478 pubkey = public_key_from_private_key(sec)
479 keypairs[ pubkey ] = sec
481 # add private_keys from KeyID
482 self.add_keypairs_from_KeyID(tx, keypairs, password)
483 # add private keys from wallet
484 self.add_keypairs_from_wallet(tx, keypairs, password)
485 # sign the transaction
486 self.sign_transaction(tx, keypairs, password)
489 def sign_message(self, address, message, password):
490 keys = self.get_private_key(address, password)
491 assert len(keys) == 1
493 key = regenerate_key(sec)
494 compressed = is_compressed(sec)
495 return key.sign_message(message, compressed, address)
499 def decrypt_message(self, pubkey, message, password):
500 address = public_key_to_bc_address(pubkey.decode('hex'))
501 keys = self.get_private_key(address, password)
503 ec = regenerate_key(secret)
504 decrypted = ec.decrypt_message(message)
510 return self.history.values() != [[]] * len(self.history)
513 def add_contact(self, address, label=None):
514 self.addressbook.append(address)
515 self.storage.put('contacts', self.addressbook, True)
517 self.set_label(address, label)
520 def delete_contact(self, addr):
521 if addr in self.addressbook:
522 self.addressbook.remove(addr)
523 self.storage.put('addressbook', self.addressbook, True)
526 def fill_addressbook(self):
527 for tx_hash, tx in self.transactions.items():
528 is_relevant, is_send, _, _ = self.get_tx_value(tx)
530 for addr, v in tx.outputs:
531 if not self.is_mine(addr) and addr not in self.addressbook:
532 self.addressbook.append(addr)
534 # self.update_tx_labels()
536 def get_num_tx(self, address):
538 for tx in self.transactions.values():
539 if address in map(lambda x:x[0], tx.outputs): n += 1
543 def get_address_flags(self, addr):
544 flags = "C" if self.is_change(addr) else "I" if addr in self.imported_keys.keys() else "-"
545 flags += "F" if addr in self.frozen_addresses else "-"
549 def get_tx_value(self, tx, account=None):
550 domain = self.get_account_addresses(account)
551 return tx.get_value(domain, self.prevout_values)
554 def update_tx_outputs(self, tx_hash):
555 tx = self.transactions.get(tx_hash)
557 for i, (addr, value) in enumerate(tx.outputs):
558 key = tx_hash+ ':%d'%i
559 self.prevout_values[key] = value
561 for item in tx.inputs:
562 if self.is_mine(item.get('address')):
563 key = item['prevout_hash'] + ':%d'%item['prevout_n']
564 self.spent_outputs.append(key)
567 def get_addr_balance(self, address):
568 assert self.is_mine(address)
569 h = self.history.get(address,[])
570 if h == ['*']: return 0,0
572 received_coins = [] # list of coins received at address
574 for tx_hash, tx_height in h:
575 tx = self.transactions.get(tx_hash)
578 for i, (addr, value) in enumerate(tx.outputs):
580 key = tx_hash + ':%d'%i
581 received_coins.append(key)
583 for tx_hash, tx_height in h:
584 tx = self.transactions.get(tx_hash)
588 for item in tx.inputs:
589 addr = item.get('address')
591 key = item['prevout_hash'] + ':%d'%item['prevout_n']
592 value = self.prevout_values.get( key )
593 if key in received_coins:
596 for i, (addr, value) in enumerate(tx.outputs):
597 key = tx_hash + ':%d'%i
608 def get_account_name(self, k):
609 default = "Unnamed account"
610 m = re.match("m/0'/(\d+)", k)
614 default = "Main account"
616 default = "Account %s"%num
618 m = re.match("m/1'/(\d+) & m/2'/(\d+)", k)
621 default = "2of2 account %s"%num
622 name = self.labels.get(k, default)
626 def get_account_names(self):
628 for k, account in self.accounts.items():
629 accounts[k] = self.get_account_name(k)
630 if self.imported_keys:
631 accounts[-1] = 'Imported keys'
635 def get_account_addresses(self, a, include_change=True):
637 o = self.addresses(True)
639 o = self.imported_keys.keys()
641 ac = self.accounts[a]
642 o = ac.get_addresses(0)
643 if include_change: o += ac.get_addresses(1)
646 def get_imported_balance(self):
647 return self.get_balance(self.imported_keys.keys())
649 def get_account_balance(self, account):
650 return self.get_balance(self.get_account_addresses(account))
652 def get_frozen_balance(self):
653 return self.get_balance(self.frozen_addresses)
655 def get_balance(self, domain=None):
656 if domain is None: domain = self.addresses(True)
659 c, u = self.get_addr_balance(addr)
665 def get_unspent_coins(self, domain=None):
667 if domain is None: domain = self.addresses(True)
669 h = self.history.get(addr, [])
670 if h == ['*']: continue
671 for tx_hash, tx_height in h:
672 tx = self.transactions.get(tx_hash)
673 if tx is None: raise Exception("Wallet not synchronized")
674 is_coinbase = tx.inputs[0].get('prevout_hash') == '0'*64
675 for o in tx.d.get('outputs'):
677 if output.get('address') != addr: continue
678 key = tx_hash + ":%d" % output.get('prevout_n')
679 if key in self.spent_outputs: continue
680 output['prevout_hash'] = tx_hash
681 output['height'] = tx_height
682 output['coinbase'] = is_coinbase
683 coins.append((tx_height, output))
687 coins = sorted(coins)
688 if coins[-1][0] != 0:
689 while coins[0][0] == 0:
690 coins = coins[1:] + [ coins[0] ]
691 return [x[1] for x in coins]
694 def choose_tx_inputs( self, amount, fixed_fee, num_outputs, domain = None ):
695 """ todo: minimize tx size """
697 fee = self.fee if fixed_fee is None else fixed_fee
699 domain = self.addresses(True)
701 for i in self.frozen_addresses:
702 if i in domain: domain.remove(i)
704 coins = self.get_unspent_coins(domain)
708 if item.get('coinbase') and item.get('height') + COINBASE_MATURITY > self.network.get_local_height():
710 addr = item.get('address')
711 v = item.get('value')
714 fee = self.estimated_fee(inputs, num_outputs) if fixed_fee is None else fixed_fee
715 if total >= amount + fee: break
719 return inputs, total, fee
722 def set_fee(self, fee):
725 self.storage.put('fee_per_kb', self.fee, True)
727 def estimated_fee(self, inputs, num_outputs):
728 estimated_size = len(inputs) * 180 + num_outputs * 34 # this assumes non-compressed keys
729 fee = self.fee * int(math.ceil(estimated_size/1000.))
733 def add_tx_change( self, inputs, outputs, amount, fee, total, change_addr=None):
734 "add change to a transaction"
735 change_amount = total - ( amount + fee )
736 if change_amount > DUST_THRESHOLD:
739 # send change to one of the accounts involved in the tx
740 address = inputs[0].get('address')
741 account, _ = self.get_address_index(address)
743 if not self.use_change or account == -1:
744 change_addr = inputs[-1]['address']
746 change_addr = self.accounts[account].get_addresses(1)[-self.gap_limit_for_change]
748 # Insert the change output at a random position in the outputs
749 posn = random.randint(0, len(outputs))
750 outputs[posn:posn] = [( change_addr, change_amount)]
754 def get_history(self, address):
756 return self.history.get(address)
759 def get_status(self, h):
760 if not h: return None
761 if h == ['*']: return '*'
763 for tx_hash, height in h:
764 status += tx_hash + ':%d:' % height
765 return hashlib.sha256( status ).digest().encode('hex')
768 def receive_tx_callback(self, tx_hash, tx, tx_height):
770 with self.transaction_lock:
771 self.add_extra_addresses(tx)
772 if not self.check_new_tx(tx_hash, tx):
773 # may happen due to pruning
774 print_error("received transaction that is no longer referenced in history", tx_hash)
776 self.transactions[tx_hash] = tx
777 self.network.pending_transactions_for_notifications.append(tx)
778 self.save_transactions()
779 if self.verifier and tx_height>0:
780 self.verifier.add(tx_hash, tx_height)
781 self.update_tx_outputs(tx_hash)
784 def save_transactions(self):
786 for k,v in self.transactions.items():
788 self.storage.put('transactions', tx, True)
790 def receive_history_callback(self, addr, hist):
792 if not self.check_new_history(addr, hist):
793 raise Exception("error: received history for %s is not consistent with known transactions"%addr)
796 self.history[addr] = hist
797 self.storage.put('addr_history', self.history, True)
800 for tx_hash, tx_height in hist:
802 # add it in case it was previously unconfirmed
803 if self.verifier: self.verifier.add(tx_hash, tx_height)
806 def get_tx_history(self, account=None):
807 if not self.verifier:
810 with self.transaction_lock:
811 history = self.transactions.items()
812 history.sort(key = lambda x: self.verifier.get_txpos(x[0]))
816 for tx_hash, tx in history:
817 is_relevant, is_mine, v, fee = self.get_tx_value(tx, account)
818 if v is not None: balance += v
820 c, u = self.get_account_balance(account)
823 result.append( ('', 1000, 0, c+u-balance, None, c+u-balance, None ) )
825 balance = c + u - balance
826 for tx_hash, tx in history:
827 is_relevant, is_mine, value, fee = self.get_tx_value(tx, account)
830 if value is not None:
833 conf, timestamp = self.verifier.get_confirmations(tx_hash) if self.verifier else (None, None)
834 result.append( (tx_hash, conf, is_mine, value, fee, balance, timestamp) )
839 def get_label(self, tx_hash):
840 label = self.labels.get(tx_hash)
841 is_default = (label == '') or (label is None)
842 if is_default: label = self.get_default_label(tx_hash)
843 return label, is_default
846 def get_default_label(self, tx_hash):
847 tx = self.transactions.get(tx_hash)
850 is_relevant, is_mine, _, _ = self.get_tx_value(tx)
854 if not self.is_mine(o_addr):
856 default_label = self.labels[o_addr]
858 default_label = '>' + o_addr
861 default_label = '(internal)'
865 if self.is_mine(o_addr) and not self.is_change(o_addr):
870 if self.is_mine(o_addr):
876 dest_label = self.labels.get(o_addr)
878 default_label = self.labels[o_addr]
880 default_label = '<' + o_addr
885 def make_unsigned_transaction(self, outputs, fee=None, change_addr=None, domain=None ):
886 for address, x in outputs:
887 assert is_valid(address), "Address " + address + " is invalid!"
888 amount = sum( map(lambda x:x[1], outputs) )
889 inputs, total, fee = self.choose_tx_inputs( amount, fee, len(outputs), domain )
891 raise ValueError("Not enough funds")
893 self.add_input_info(txin)
894 outputs = self.add_tx_change(inputs, outputs, amount, fee, total, change_addr)
895 return Transaction.from_io(inputs, outputs)
898 def mktx(self, outputs, password, fee=None, change_addr=None, domain= None ):
899 tx = self.make_unsigned_transaction(outputs, fee, change_addr, domain)
901 self.add_keypairs_from_wallet(tx, keypairs, password)
903 self.sign_transaction(tx, keypairs, password)
907 def add_input_info(self, txin):
908 address = txin['address']
909 if address in self.imported_keys.keys():
911 account_id, sequence = self.get_address_index(address)
912 account = self.accounts[account_id]
913 txin['KeyID'] = account.get_keyID(sequence)
914 redeemScript = account.redeem_script(sequence)
916 txin['redeemScript'] = redeemScript
918 txin['redeemPubkey'] = account.get_pubkey(*sequence)
921 def sign_transaction(self, tx, keypairs, password):
923 run_hook('sign_transaction', tx, password)
926 def sendtx(self, tx):
930 return self.receive_tx(h, tx)
932 def send_tx(self, tx):
934 self.tx_event.clear()
935 self.network.send([('blockchain.transaction.broadcast', [str(tx)])], self.on_broadcast)
938 def on_broadcast(self, i, r):
939 self.tx_result = r.get('result')
942 def receive_tx(self, tx_hash, tx):
945 return False, "error: " + out
946 run_hook('receive_tx', tx, self)
950 def update_password(self, old_password, new_password):
951 if new_password == '': new_password = None
952 decoded = self.get_seed(old_password)
953 self.seed = pw_encode( decoded, new_password)
954 self.storage.put('seed', self.seed, True)
955 self.use_encryption = (new_password != None)
956 self.storage.put('use_encryption', self.use_encryption,True)
957 for k in self.imported_keys.keys():
958 a = self.imported_keys[k]
959 b = pw_decode(a, old_password)
960 c = pw_encode(b, new_password)
961 self.imported_keys[k] = c
962 self.storage.put('imported_keys', self.imported_keys, True)
964 for k, v in self.master_private_keys.items():
965 b = pw_decode(v, old_password)
966 c = pw_encode(b, new_password)
967 self.master_private_keys[k] = c
968 self.storage.put('master_private_keys', self.master_private_keys, True)
971 def freeze(self,addr):
972 if self.is_mine(addr) and addr not in self.frozen_addresses:
973 self.frozen_addresses.append(addr)
974 self.storage.put('frozen_addresses', self.frozen_addresses, True)
980 def unfreeze(self,addr):
981 if self.is_mine(addr) and addr in self.frozen_addresses:
982 self.frozen_addresses.remove(addr)
983 self.storage.put('frozen_addresses', self.frozen_addresses, True)
989 def set_verifier(self, verifier):
990 self.verifier = verifier
992 # review transactions that are in the history
993 for addr, hist in self.history.items():
994 if hist == ['*']: continue
995 for tx_hash, tx_height in hist:
997 # add it in case it was previously unconfirmed
998 self.verifier.add(tx_hash, tx_height)
1000 # if we are on a pruning server, remove unverified transactions
1001 vr = self.verifier.transactions.keys() + self.verifier.verified_tx.keys()
1002 for tx_hash in self.transactions.keys():
1003 if tx_hash not in vr:
1004 self.transactions.pop(tx_hash)
1007 def check_new_history(self, addr, hist):
1009 # check that all tx in hist are relevant
1011 for tx_hash, height in hist:
1012 tx = self.transactions.get(tx_hash)
1014 if not tx.has_address(addr):
1017 # check that we are not "orphaning" a transaction
1018 old_hist = self.history.get(addr,[])
1019 if old_hist == ['*']: return True
1021 for tx_hash, height in old_hist:
1022 if tx_hash in map(lambda x:x[0], hist): continue
1024 for _addr, _hist in self.history.items():
1025 if _addr == addr: continue
1026 if _hist == ['*']: continue
1027 _tx_hist = map(lambda x:x[0], _hist)
1028 if tx_hash in _tx_hist:
1033 tx = self.transactions.get(tx_hash)
1034 # tx might not be there
1038 if self.verifier.get_height(tx_hash):
1041 print_error("new history is orphaning transaction:", tx_hash)
1042 # check that all outputs are not mine, request histories
1044 for _addr, _v in tx.outputs:
1045 # assert not self.is_mine(_addr)
1046 ext_requests.append( ('blockchain.address.get_history', [_addr]) )
1048 ext_h = self.network.synchronous_get(ext_requests)
1049 print_error("sync:", ext_requests, ext_h)
1052 if h == ['*']: continue
1054 if item.get('tx_hash') == tx_hash:
1055 height = item.get('height')
1057 print_error("found height for", tx_hash, height)
1058 self.verifier.add(tx_hash, height)
1060 print_error("removing orphaned tx from history", tx_hash)
1061 self.transactions.pop(tx_hash)
1066 def check_new_tx(self, tx_hash, tx):
1067 # 1 check that tx is referenced in addr_history.
1069 for addr, hist in self.history.items():
1070 if hist == ['*']:continue
1071 for txh, height in hist:
1073 addresses.append(addr)
1078 # 2 check that referencing addresses are in the tx
1079 for addr in addresses:
1080 if not tx.has_address(addr):
1086 def start_threads(self, network):
1087 from verifier import TxVerifier
1088 self.network = network
1089 if self.network is not None:
1090 self.verifier = TxVerifier(self.network, self.storage)
1091 self.verifier.start()
1092 self.set_verifier(self.verifier)
1093 self.synchronizer = WalletSynchronizer(self, network)
1094 self.synchronizer.start()
1096 self.verifier = None
1097 self.synchronizer =None
1099 def stop_threads(self):
1101 self.verifier.stop()
1102 self.synchronizer.stop()
1104 def restore(self, cb):
1109 class Imported_Wallet(Abstract_Wallet):
1111 def __init__(self, storage):
1112 Abstract_Wallet.__init__(self, storage)
1114 def is_watching_only(self):
1115 n = self.imported_keys.values()
1116 return n == [''] * len(n)
1121 def is_deterministic(self):
1126 class Deterministic_Wallet(Abstract_Wallet):
1128 def __init__(self, storage):
1129 Abstract_Wallet.__init__(self, storage)
1132 return self.seed != ''
1134 def is_deterministic(self):
1137 def is_watching_only(self):
1138 return not self.has_seed()
1140 def check_password(self, password):
1141 self.get_seed(password)
1143 def get_seed(self, password):
1144 s = pw_decode(self.seed, password)
1145 seed = mnemonic_to_seed(s,'').encode('hex')
1148 def get_mnemonic(self, password):
1149 return pw_decode(self.seed, password)
1151 def change_gap_limit(self, value):
1152 if value >= self.gap_limit:
1153 self.gap_limit = value
1154 self.storage.put('gap_limit', self.gap_limit, True)
1155 #self.interface.poke('synchronizer')
1158 elif value >= self.min_acceptable_gap():
1159 for key, account in self.accounts.items():
1160 addresses = account[0]
1161 k = self.num_unused_trailing_addresses(addresses)
1162 n = len(addresses) - k + value
1163 addresses = addresses[0:n]
1164 self.accounts[key][0] = addresses
1166 self.gap_limit = value
1167 self.storage.put('gap_limit', self.gap_limit, True)
1168 self.save_accounts()
1173 def num_unused_trailing_addresses(self, addresses):
1175 for a in addresses[::-1]:
1176 if self.history.get(a):break
1180 def min_acceptable_gap(self):
1181 # fixme: this assumes wallet is synchronized
1185 for account in self.accounts.values():
1186 addresses = account.get_addresses(0)
1187 k = self.num_unused_trailing_addresses(addresses)
1188 for a in addresses[0:-k]:
1189 if self.history.get(a):
1193 if n > nmax: nmax = n
1197 def address_is_old(self, address):
1199 h = self.history.get(address, [])
1202 for tx_hash, tx_height in h:
1206 tx_age = self.network.get_local_height() - tx_height + 1
1212 def synchronize_sequence(self, account, for_change):
1213 limit = self.gap_limit_for_change if for_change else self.gap_limit
1216 addresses = account.get_addresses(for_change)
1217 if len(addresses) < limit:
1218 address = account.create_new_address(for_change)
1219 self.history[address] = []
1220 new_addresses.append( address )
1223 if map( lambda a: self.address_is_old(a), addresses[-limit:] ) == limit*[False]:
1226 address = account.create_new_address(for_change)
1227 self.history[address] = []
1228 new_addresses.append( address )
1230 return new_addresses
1233 def check_pending_accounts(self):
1234 for account_id, addr in self.next_addresses.items():
1235 if self.address_is_old(addr):
1236 print_error( "creating account", account_id )
1237 xpub = self.master_public_keys[account_id]
1238 account = BIP32_Account({'xpub':xpub})
1239 self.add_account(account_id, account)
1240 self.next_addresses.pop(account_id)
1243 def synchronize_account(self, account):
1245 new += self.synchronize_sequence(account, 0)
1246 new += self.synchronize_sequence(account, 1)
1250 def synchronize(self):
1251 self.check_pending_accounts()
1253 for account in self.accounts.values():
1254 new += self.synchronize_account(account)
1256 self.save_accounts()
1257 self.storage.put('addr_history', self.history, True)
1261 def restore(self, callback):
1263 def wait_for_wallet():
1264 self.set_up_to_date(False)
1265 while not self.is_up_to_date():
1266 msg = "%s\n%s %d\n%s %.1f"%(
1267 _("Please wait..."),
1268 _("Addresses generated:"),
1269 len(self.addresses(True)),
1270 _("Kilobytes received:"),
1271 self.network.interface.bytes_received/1024.)
1273 apply(callback, (msg,))
1276 def wait_for_network():
1277 while not self.network.is_connected():
1278 msg = "%s \n" % (_("Connecting..."))
1279 apply(callback, (msg,))
1282 # wait until we are connected, because the user might have selected another server
1289 self.fill_addressbook()
1292 def create_account(self, name, password):
1293 i = self.num_accounts()
1294 account_id = self.account_id(i)
1295 account = self.make_account(account_id, password)
1296 self.add_account(account_id, account)
1298 self.set_label(account_id, name)
1300 # add address of the next account
1301 _, _ = self.next_account_address(password)
1304 def add_account(self, account_id, account):
1305 self.accounts[account_id] = account
1306 if account_id in self.pending_accounts:
1307 self.pending_accounts.pop(account_id)
1308 self.storage.put('pending_accounts', self.pending_accounts)
1309 self.save_accounts()
1312 def save_accounts(self):
1314 for k, v in self.accounts.items():
1316 self.storage.put('accounts', d, True)
1320 def load_accounts(self):
1321 d = self.storage.get('accounts', {})
1323 for k, v in d.items():
1325 v['mpk'] = self.storage.get('master_public_key')
1326 self.accounts[k] = OldAccount(v)
1327 elif v.get('xpub3'):
1328 self.accounts[k] = BIP32_Account_2of3(v)
1329 elif v.get('xpub2'):
1330 self.accounts[k] = BIP32_Account_2of2(v)
1332 self.accounts[k] = BIP32_Account(v)
1336 self.pending_accounts = self.storage.get('pending_accounts',{})
1339 def delete_pending_account(self, k):
1340 self.pending_accounts.pop(k)
1341 self.storage.put('pending_accounts', self.pending_accounts)
1343 def account_is_pending(self, k):
1344 return k in self.pending_accounts
1346 def create_pending_account(self, name, password):
1347 account_id, addr = self.next_account_address(password)
1348 self.set_label(account_id, name)
1349 self.pending_accounts[account_id] = addr
1350 self.storage.put('pending_accounts', self.pending_accounts)
1352 def get_pending_accounts(self):
1353 return self.pending_accounts.items()
1357 class NewWallet(Deterministic_Wallet):
1359 def __init__(self, storage):
1360 Deterministic_Wallet.__init__(self, storage)
1362 def can_create_accounts(self):
1363 return not self.is_watching_only()
1365 def get_master_public_key(self):
1366 return self.master_public_keys["m/"]
1368 def get_master_public_keys(self):
1370 for k, account in self.accounts.items():
1371 name = self.get_account_name(k)
1372 mpk_text = '\n\n'.join( account.get_master_pubkeys() )
1373 out[name] = mpk_text
1376 def get_master_private_key(self, account, password):
1377 k = self.master_private_keys.get(account)
1379 xpriv = pw_decode( k, password)
1382 def add_seed(self, seed, password):
1384 raise Exception("a seed exists")
1386 self.seed_version, self.seed = self.prepare_seed(seed)
1388 self.seed = pw_encode( self.seed, password)
1389 self.use_encryption = True
1391 self.use_encryption = False
1393 self.storage.put('seed', self.seed, True)
1394 self.storage.put('seed_version', self.seed_version, True)
1395 self.storage.put('use_encryption', self.use_encryption,True)
1396 self.create_master_keys(password)
1399 def create_watching_only_wallet(self, xpub):
1400 self.storage.put('seed_version', self.seed_version, True)
1401 self.add_master_public_key("m/", xpub)
1402 account = BIP32_Account({'xpub':xpub})
1403 self.add_account("m/", account)
1406 def create_accounts(self, password):
1407 seed = pw_decode(self.seed, password)
1408 self.create_account('Main account', password)
1411 def add_master_public_key(self, name, mpk):
1412 self.master_public_keys[name] = mpk
1413 self.storage.put('master_public_keys', self.master_public_keys, True)
1416 def add_master_private_key(self, name, xpriv, password):
1417 self.master_private_keys[name] = pw_encode(xpriv, password)
1418 self.storage.put('master_private_keys', self.master_private_keys, True)
1421 def add_master_keys(self, root, account_id, password):
1422 x = self.master_private_keys.get(root)
1424 master_xpriv = pw_decode(x, password )
1425 xpriv, xpub = bip32_private_derivation(master_xpriv, root, account_id)
1426 self.add_master_public_key(account_id, xpub)
1427 self.add_master_private_key(account_id, xpriv, password)
1429 master_xpub = self.master_public_keys[root]
1430 xpub = bip32_public_derivation(master_xpub, root, account_id)
1431 self.add_master_public_key(account_id, xpub)
1435 def create_master_keys(self, password):
1436 xpriv, xpub = bip32_root(self.get_seed(password))
1437 self.add_master_public_key("m/", xpub)
1438 self.add_master_private_key("m/", xpriv, password)
1441 def find_root_by_master_key(self, xpub):
1442 for key, xpub2 in self.master_public_keys.items():
1443 if key == "m/":continue
1448 def num_accounts(self):
1449 keys = self.accounts.keys()
1452 account_id = self.account_id(i)
1453 if account_id not in keys: break
1458 def next_account_address(self, password):
1459 i = self.num_accounts()
1460 account_id = self.account_id(i)
1462 addr = self.next_addresses.get(account_id)
1464 account = self.make_account(account_id, password)
1465 addr = account.first_address()
1466 self.next_addresses[account_id] = addr
1467 self.storage.put('next_addresses', self.next_addresses)
1469 return account_id, addr
1471 def account_id(self, i):
1474 def make_account(self, account_id, password):
1475 """Creates and saves the master keys, but does not save the account"""
1476 xpub = self.add_master_keys("m/", account_id, password)
1477 account = BIP32_Account({'xpub':xpub})
1481 def make_seed(self):
1482 import mnemonic, ecdsa
1483 entropy = ecdsa.util.randrange( pow(2,160) )
1486 ss = "%040x"%(entropy+nonce)
1487 s = hashlib.sha256(ss.decode('hex')).digest().encode('hex')
1488 # we keep only 13 words, that's approximately 139 bits of entropy
1489 words = mnemonic.mn_encode(s)[0:13]
1490 seed = ' '.join(words)
1491 if is_new_seed(seed):
1492 break # this will remove 8 bits of entropy
1496 def prepare_seed(self, seed):
1498 return NEW_SEED_VERSION, unicodedata.normalize('NFC', unicode(seed.strip()))
1502 class Wallet_2of2(NewWallet):
1504 def __init__(self, storage):
1505 NewWallet.__init__(self, storage)
1506 self.storage.put('wallet_type', '2of2', True)
1508 def create_account(self):
1509 xpub1 = self.master_public_keys.get("m/")
1510 xpub2 = self.master_public_keys.get("cold/")
1511 account = BIP32_Account_2of2({'xpub':xpub1, 'xpub2':xpub2})
1512 self.add_account('m/', account)
1514 def get_master_public_keys(self):
1515 xpub1 = self.master_public_keys.get("m/")
1516 xpub2 = self.master_public_keys.get("cold/")
1517 return {'hot':xpub1, 'cold':xpub2}
1519 def get_action(self):
1520 xpub1 = self.master_public_keys.get("m/")
1521 xpub2 = self.master_public_keys.get("cold/")
1523 return 'create_2of2_1'
1525 return 'create_2of2_2'
1529 class Wallet_2of3(Wallet_2of2):
1531 def __init__(self, storage):
1532 Wallet_2of2.__init__(self, storage)
1533 self.storage.put('wallet_type', '2of3', True)
1535 def create_account(self):
1536 xpub1 = self.master_public_keys.get("m/")
1537 xpub2 = self.master_public_keys.get("cold/")
1538 xpub3 = self.master_public_keys.get("remote/")
1539 account = BIP32_Account_2of3({'xpub':xpub1, 'xpub2':xpub2, 'xpub3':xpub3})
1540 self.add_account('m/', account)
1542 def get_master_public_keys(self):
1543 xpub1 = self.master_public_keys.get("m/")
1544 xpub2 = self.master_public_keys.get("cold/")
1545 xpub3 = self.master_public_keys.get("remote/")
1546 return {'hot':xpub1, 'cold':xpub2, 'remote':xpub3}
1548 def get_action(self):
1549 xpub1 = self.master_public_keys.get("m/")
1550 xpub2 = self.master_public_keys.get("cold/")
1551 xpub3 = self.master_public_keys.get("remote/")
1553 return 'create_2of3_1'
1555 return 'create_2of3_2'
1557 return 'create_2of3_3'
1563 class OldWallet(Deterministic_Wallet):
1565 def make_seed(self):
1567 seed = random_seed(128)
1568 return ' '.join(mnemonic.mn_encode(seed))
1570 def prepare_seed(self, seed):
1572 # see if seed was entered as hex
1577 return OLD_SEED_VERSION, str(seed)
1581 words = seed.split()
1582 seed = mnemonic.mn_decode(words)
1584 raise Exception("Invalid seed")
1586 return OLD_SEED_VERSION, seed
1589 def create_master_keys(self, password):
1590 seed = pw_decode(self.seed, password)
1591 mpk = OldAccount.mpk_from_seed(seed)
1592 self.storage.put('master_public_key', mpk, True)
1594 def get_master_public_key(self):
1595 return self.storage.get("master_public_key")
1597 def get_master_public_keys(self):
1598 return {'Main Account':self.get_master_public_key()}
1600 def create_accounts(self, password):
1601 mpk = self.storage.get("master_public_key")
1602 self.create_account(mpk)
1604 def create_account(self, mpk):
1605 self.accounts[0] = OldAccount({'mpk':mpk, 0:[], 1:[]})
1606 self.save_accounts()
1608 def create_watching_only_wallet(self, mpk):
1609 self.seed_version = OLD_SEED_VERSION
1610 self.storage.put('seed_version', self.seed_version, True)
1611 self.storage.put('master_public_key', mpk, True)
1612 self.create_account(mpk)
1614 def get_seed(self, password):
1615 seed = pw_decode(self.seed, password)
1616 self.accounts[0].check_seed(seed)
1619 def get_mnemonic(self, password):
1621 s = pw_decode(self.seed, password)
1622 return ' '.join(mnemonic.mn_encode(s))
1625 def add_keypairs_from_KeyID(self, tx, keypairs, password):
1626 # first check the provided password
1627 seed = self.get_seed(password)
1628 for txin in tx.inputs:
1629 keyid = txin.get('KeyID')
1631 m = re.match("old\(([0-9a-f]+),(\d+),(\d+)", keyid)
1634 if mpk != self.storage.get('master_public_key'): continue
1635 for_change = int(m.group(2))
1636 num = int(m.group(3))
1637 account = self.accounts[0]
1638 addr = account.get_address(for_change, num)
1639 txin['address'] = addr # fixme: side effect
1640 pk = account.get_private_key(seed, (for_change, num))
1641 pubkey = public_key_from_private_key(pk)
1642 keypairs[pubkey] = pk
1645 def get_account_name(self, k):
1647 return 'Main account'
1650 def get_private_key(self, address, password):
1651 if self.is_watching_only():
1654 # first check the provided password
1655 seed = self.get_seed(password)
1658 if address in self.imported_keys.keys():
1659 out.append( pw_decode( self.imported_keys[address], password ) )
1661 account_id, sequence = self.get_address_index(address)
1662 pk = self.accounts[0].get_private_key(seed, sequence)
1666 def check_pending_accounts(self):
1670 # former WalletFactory
1671 class Wallet(object):
1673 def __new__(self, storage):
1674 config = storage.config
1675 if config.get('bitkey', False):
1676 # if user requested support for Bitkey device,
1677 # import Bitkey driver
1678 from wallet_bitkey import WalletBitkey
1679 return WalletBitkey(config)
1681 if storage.get('wallet_type') == '2of2':
1682 return Wallet_2of2(storage)
1684 if storage.get('wallet_type') == '2of3':
1685 return Wallet_2of3(storage)
1687 if storage.file_exists and not storage.get('seed'):
1688 # wallet made of imported keys
1689 return Imported_Wallet(storage)
1692 if not storage.file_exists:
1693 seed_version = NEW_SEED_VERSION if config.get('bip32') is True else OLD_SEED_VERSION
1695 seed_version = storage.get('seed_version')
1696 if not seed_version:
1697 seed_version = OLD_SEED_VERSION if len(storage.get('master_public_key')) == 128 else NEW_SEED_VERSION
1699 if seed_version == OLD_SEED_VERSION:
1700 return OldWallet(storage)
1701 elif seed_version == NEW_SEED_VERSION:
1702 return NewWallet(storage)
1704 msg = "This wallet seed is not supported."
1705 if seed_version in [5]:
1706 msg += "\nTo open this wallet, try 'git checkout seed_v%d'"%seed_version
1713 def is_seed(self, seed):
1716 elif is_old_seed(seed):
1718 elif is_new_seed(seed):
1724 def is_mpk(self, mpk):
1732 return len(mpk) == 128
1735 deserialize_xkey(mpk)
1741 def is_address(self, text):
1742 for x in text.split():
1743 if not bitcoin.is_address(x):
1748 def is_private_key(self, text):
1749 for x in text.split():
1750 if not bitcoin.is_private_key(x):
1755 def from_seed(self, seed, storage):
1756 if is_old_seed(seed):
1758 elif is_new_seed(seed):
1764 def from_address(self, text, storage):
1765 w = Imported_Wallet(storage)
1766 for x in text.split():
1767 w.imported_keys[x] = ''
1768 w.storage.put('imported_keys', w.imported_keys, True)
1772 def from_private_key(self, text, storage):
1773 w = Imported_Wallet(storage)
1774 for x in text.split():
1775 w.import_key(x, None)
1779 def from_mpk(self, mpk, storage):
1788 w = OldWallet(storage)
1790 w.create_watching_only_wallet(mpk)
1792 w = NewWallet(storage)
1793 w.create_watching_only_wallet(mpk)