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():
378 if address in self.imported_keys.keys():
379 self.check_password(password)
380 out.append( pw_decode( self.imported_keys[address], password ) )
382 seed = self.get_seed(password)
383 account_id, sequence = self.get_address_index(address)
384 account = self.accounts[account_id]
385 xpubs = account.get_master_pubkeys()
386 roots = [k for k, v in self.master_public_keys.iteritems() if v in xpubs]
388 xpriv = self.get_master_private_key(root, password)
391 _, _, _, c, k = deserialize_xkey(xpriv)
392 pk = bip32_private_key( sequence, k, c )
398 def get_public_keys(self, address):
399 account_id, sequence = self.get_address_index(address)
400 return self.accounts[account_id].get_pubkeys(sequence)
403 def add_keypairs_from_wallet(self, tx, keypairs, password):
404 for txin in tx.inputs:
405 address = txin['address']
406 if not self.is_mine(address):
408 private_keys = self.get_private_key(address, password)
409 for sec in private_keys:
410 pubkey = public_key_from_private_key(sec)
411 keypairs[ pubkey ] = sec
412 if address in self.imported_keys.keys():
413 txin['redeemPubkey'] = pubkey
416 def add_keypairs_from_KeyID(self, tx, keypairs, password):
417 # first check the provided password
418 seed = self.get_seed(password)
420 for txin in tx.inputs:
421 keyid = txin.get('KeyID')
424 for s in keyid.split('&'):
425 m = re.match("bip32\((.*),(/\d+/\d+)\)", s)
428 sequence = m.group(2)
429 root = self.find_root_by_master_key(xpub)
430 if not root: continue
431 sequence = map(lambda x:int(x), sequence.strip('/').split('/'))
432 root = root + '%d'%sequence[0]
433 sequence = sequence[1:]
434 roots.append((root,sequence))
436 account_id = " & ".join( map(lambda x:x[0], roots) )
437 account = self.accounts.get(account_id)
438 if not account: continue
439 addr = account.get_address(*sequence)
440 txin['address'] = addr # fixme: side effect
441 pk = self.get_private_key(addr, password)
443 pubkey = public_key_from_private_key(sec)
444 keypairs[pubkey] = sec
448 def signrawtransaction(self, tx, input_info, private_keys, password):
450 # check that the password is correct
451 seed = self.get_seed(password)
453 # if input_info is not known, build it using wallet UTXOs
456 unspent_coins = self.get_unspent_coins()
457 for txin in tx.inputs:
458 for item in unspent_coins:
459 if txin['prevout_hash'] == item['prevout_hash'] and txin['prevout_n'] == item['prevout_n']:
460 info = { 'address':item['address'], 'scriptPubKey':item['scriptPubKey'] }
461 self.add_input_info(info)
462 input_info.append(info)
465 print_error( "input not in UTXOs" )
466 input_info.append(None)
468 # add input_info to the transaction
469 print_error("input_info", input_info)
470 tx.add_input_info(input_info)
472 # build a list of public/private keys
475 # add private keys from parameter
476 for sec in private_keys:
477 pubkey = public_key_from_private_key(sec)
478 keypairs[ pubkey ] = sec
480 # add private_keys from KeyID
481 self.add_keypairs_from_KeyID(tx, keypairs, password)
482 # add private keys from wallet
483 self.add_keypairs_from_wallet(tx, keypairs, password)
484 # sign the transaction
485 self.sign_transaction(tx, keypairs, password)
488 def sign_message(self, address, message, password):
489 keys = self.get_private_key(address, password)
490 assert len(keys) == 1
492 key = regenerate_key(sec)
493 compressed = is_compressed(sec)
494 return key.sign_message(message, compressed, address)
498 def decrypt_message(self, pubkey, message, password):
499 address = public_key_to_bc_address(pubkey.decode('hex'))
500 keys = self.get_private_key(address, password)
502 ec = regenerate_key(secret)
503 decrypted = ec.decrypt_message(message)
509 return self.history.values() != [[]] * len(self.history)
512 def add_contact(self, address, label=None):
513 self.addressbook.append(address)
514 self.storage.put('contacts', self.addressbook, True)
516 self.set_label(address, label)
519 def delete_contact(self, addr):
520 if addr in self.addressbook:
521 self.addressbook.remove(addr)
522 self.storage.put('addressbook', self.addressbook, True)
525 def fill_addressbook(self):
526 for tx_hash, tx in self.transactions.items():
527 is_relevant, is_send, _, _ = self.get_tx_value(tx)
529 for addr, v in tx.outputs:
530 if not self.is_mine(addr) and addr not in self.addressbook:
531 self.addressbook.append(addr)
533 # self.update_tx_labels()
535 def get_num_tx(self, address):
537 for tx in self.transactions.values():
538 if address in map(lambda x:x[0], tx.outputs): n += 1
542 def get_address_flags(self, addr):
543 flags = "C" if self.is_change(addr) else "I" if addr in self.imported_keys.keys() else "-"
544 flags += "F" if addr in self.frozen_addresses else "-"
548 def get_tx_value(self, tx, account=None):
549 domain = self.get_account_addresses(account)
550 return tx.get_value(domain, self.prevout_values)
553 def update_tx_outputs(self, tx_hash):
554 tx = self.transactions.get(tx_hash)
556 for i, (addr, value) in enumerate(tx.outputs):
557 key = tx_hash+ ':%d'%i
558 self.prevout_values[key] = value
560 for item in tx.inputs:
561 if self.is_mine(item.get('address')):
562 key = item['prevout_hash'] + ':%d'%item['prevout_n']
563 self.spent_outputs.append(key)
566 def get_addr_balance(self, address):
567 assert self.is_mine(address)
568 h = self.history.get(address,[])
569 if h == ['*']: return 0,0
571 received_coins = [] # list of coins received at address
573 for tx_hash, tx_height in h:
574 tx = self.transactions.get(tx_hash)
577 for i, (addr, value) in enumerate(tx.outputs):
579 key = tx_hash + ':%d'%i
580 received_coins.append(key)
582 for tx_hash, tx_height in h:
583 tx = self.transactions.get(tx_hash)
587 for item in tx.inputs:
588 addr = item.get('address')
590 key = item['prevout_hash'] + ':%d'%item['prevout_n']
591 value = self.prevout_values.get( key )
592 if key in received_coins:
595 for i, (addr, value) in enumerate(tx.outputs):
596 key = tx_hash + ':%d'%i
607 def get_account_name(self, k):
608 default = "Unnamed account"
609 m = re.match("m/0'/(\d+)", k)
613 default = "Main account"
615 default = "Account %s"%num
617 m = re.match("m/1'/(\d+) & m/2'/(\d+)", k)
620 default = "2of2 account %s"%num
621 name = self.labels.get(k, default)
625 def get_account_names(self):
627 for k, account in self.accounts.items():
628 accounts[k] = self.get_account_name(k)
629 if self.imported_keys:
630 accounts[-1] = 'Imported keys'
634 def get_account_addresses(self, a, include_change=True):
636 o = self.addresses(True)
638 o = self.imported_keys.keys()
640 ac = self.accounts[a]
641 o = ac.get_addresses(0)
642 if include_change: o += ac.get_addresses(1)
645 def get_imported_balance(self):
646 return self.get_balance(self.imported_keys.keys())
648 def get_account_balance(self, account):
649 return self.get_balance(self.get_account_addresses(account))
651 def get_frozen_balance(self):
652 return self.get_balance(self.frozen_addresses)
654 def get_balance(self, domain=None):
655 if domain is None: domain = self.addresses(True)
658 c, u = self.get_addr_balance(addr)
664 def get_unspent_coins(self, domain=None):
666 if domain is None: domain = self.addresses(True)
668 h = self.history.get(addr, [])
669 if h == ['*']: continue
670 for tx_hash, tx_height in h:
671 tx = self.transactions.get(tx_hash)
672 if tx is None: raise Exception("Wallet not synchronized")
673 is_coinbase = tx.inputs[0].get('prevout_hash') == '0'*64
674 for o in tx.d.get('outputs'):
676 if output.get('address') != addr: continue
677 key = tx_hash + ":%d" % output.get('prevout_n')
678 if key in self.spent_outputs: continue
679 output['prevout_hash'] = tx_hash
680 output['height'] = tx_height
681 output['coinbase'] = is_coinbase
682 coins.append((tx_height, output))
686 coins = sorted(coins)
687 if coins[-1][0] != 0:
688 while coins[0][0] == 0:
689 coins = coins[1:] + [ coins[0] ]
690 return [x[1] for x in coins]
693 def choose_tx_inputs( self, amount, fixed_fee, num_outputs, domain = None ):
694 """ todo: minimize tx size """
696 fee = self.fee if fixed_fee is None else fixed_fee
698 domain = self.addresses(True)
700 for i in self.frozen_addresses:
701 if i in domain: domain.remove(i)
703 coins = self.get_unspent_coins(domain)
707 if item.get('coinbase') and item.get('height') + COINBASE_MATURITY > self.network.get_local_height():
709 addr = item.get('address')
710 v = item.get('value')
713 fee = self.estimated_fee(inputs, num_outputs) if fixed_fee is None else fixed_fee
714 if total >= amount + fee: break
718 return inputs, total, fee
721 def set_fee(self, fee):
724 self.storage.put('fee_per_kb', self.fee, True)
726 def estimated_fee(self, inputs, num_outputs):
727 estimated_size = len(inputs) * 180 + num_outputs * 34 # this assumes non-compressed keys
728 fee = self.fee * int(math.ceil(estimated_size/1000.))
732 def add_tx_change( self, inputs, outputs, amount, fee, total, change_addr=None):
733 "add change to a transaction"
734 change_amount = total - ( amount + fee )
735 if change_amount > DUST_THRESHOLD:
738 # send change to one of the accounts involved in the tx
739 address = inputs[0].get('address')
740 account, _ = self.get_address_index(address)
742 if not self.use_change or account == -1:
743 change_addr = inputs[-1]['address']
745 change_addr = self.accounts[account].get_addresses(1)[-self.gap_limit_for_change]
747 # Insert the change output at a random position in the outputs
748 posn = random.randint(0, len(outputs))
749 outputs[posn:posn] = [( change_addr, change_amount)]
753 def get_history(self, address):
755 return self.history.get(address)
758 def get_status(self, h):
759 if not h: return None
760 if h == ['*']: return '*'
762 for tx_hash, height in h:
763 status += tx_hash + ':%d:' % height
764 return hashlib.sha256( status ).digest().encode('hex')
767 def receive_tx_callback(self, tx_hash, tx, tx_height):
769 with self.transaction_lock:
770 self.add_extra_addresses(tx)
771 if not self.check_new_tx(tx_hash, tx):
772 # may happen due to pruning
773 print_error("received transaction that is no longer referenced in history", tx_hash)
775 self.transactions[tx_hash] = tx
776 self.network.pending_transactions_for_notifications.append(tx)
777 self.save_transactions()
778 if self.verifier and tx_height>0:
779 self.verifier.add(tx_hash, tx_height)
780 self.update_tx_outputs(tx_hash)
783 def save_transactions(self):
785 for k,v in self.transactions.items():
787 self.storage.put('transactions', tx, True)
789 def receive_history_callback(self, addr, hist):
791 if not self.check_new_history(addr, hist):
792 raise Exception("error: received history for %s is not consistent with known transactions"%addr)
795 self.history[addr] = hist
796 self.storage.put('addr_history', self.history, True)
799 for tx_hash, tx_height in hist:
801 # add it in case it was previously unconfirmed
802 if self.verifier: self.verifier.add(tx_hash, tx_height)
805 def get_tx_history(self, account=None):
806 if not self.verifier:
809 with self.transaction_lock:
810 history = self.transactions.items()
811 history.sort(key = lambda x: self.verifier.get_txpos(x[0]))
815 for tx_hash, tx in history:
816 is_relevant, is_mine, v, fee = self.get_tx_value(tx, account)
817 if v is not None: balance += v
819 c, u = self.get_account_balance(account)
822 result.append( ('', 1000, 0, c+u-balance, None, c+u-balance, None ) )
824 balance = c + u - balance
825 for tx_hash, tx in history:
826 is_relevant, is_mine, value, fee = self.get_tx_value(tx, account)
829 if value is not None:
832 conf, timestamp = self.verifier.get_confirmations(tx_hash) if self.verifier else (None, None)
833 result.append( (tx_hash, conf, is_mine, value, fee, balance, timestamp) )
838 def get_label(self, tx_hash):
839 label = self.labels.get(tx_hash)
840 is_default = (label == '') or (label is None)
841 if is_default: label = self.get_default_label(tx_hash)
842 return label, is_default
845 def get_default_label(self, tx_hash):
846 tx = self.transactions.get(tx_hash)
849 is_relevant, is_mine, _, _ = self.get_tx_value(tx)
853 if not self.is_mine(o_addr):
855 default_label = self.labels[o_addr]
857 default_label = '>' + o_addr
860 default_label = '(internal)'
864 if self.is_mine(o_addr) and not self.is_change(o_addr):
869 if self.is_mine(o_addr):
875 dest_label = self.labels.get(o_addr)
877 default_label = self.labels[o_addr]
879 default_label = '<' + o_addr
884 def make_unsigned_transaction(self, outputs, fee=None, change_addr=None, domain=None ):
885 for address, x in outputs:
886 assert is_valid(address), "Address " + address + " is invalid!"
887 amount = sum( map(lambda x:x[1], outputs) )
888 inputs, total, fee = self.choose_tx_inputs( amount, fee, len(outputs), domain )
890 raise ValueError("Not enough funds")
892 self.add_input_info(txin)
893 outputs = self.add_tx_change(inputs, outputs, amount, fee, total, change_addr)
894 return Transaction.from_io(inputs, outputs)
897 def mktx(self, outputs, password, fee=None, change_addr=None, domain= None ):
898 tx = self.make_unsigned_transaction(outputs, fee, change_addr, domain)
900 self.add_keypairs_from_wallet(tx, keypairs, password)
902 self.sign_transaction(tx, keypairs, password)
906 def add_input_info(self, txin):
907 address = txin['address']
908 if address in self.imported_keys.keys():
910 account_id, sequence = self.get_address_index(address)
911 account = self.accounts[account_id]
912 txin['KeyID'] = account.get_keyID(sequence)
913 redeemScript = account.redeem_script(sequence)
915 txin['redeemScript'] = redeemScript
917 txin['redeemPubkey'] = account.get_pubkey(*sequence)
920 def sign_transaction(self, tx, keypairs, password):
922 run_hook('sign_transaction', tx, password)
925 def sendtx(self, tx):
929 return self.receive_tx(h, tx)
931 def send_tx(self, tx):
933 self.tx_event.clear()
934 self.network.send([('blockchain.transaction.broadcast', [str(tx)])], self.on_broadcast)
937 def on_broadcast(self, i, r):
938 self.tx_result = r.get('result')
941 def receive_tx(self, tx_hash, tx):
944 return False, "error: " + out
945 run_hook('receive_tx', tx, self)
949 def update_password(self, old_password, new_password):
950 if new_password == '':
954 decoded = self.get_seed(old_password)
955 self.seed = pw_encode( decoded, new_password)
956 self.storage.put('seed', self.seed, True)
958 for k in self.imported_keys.keys():
959 a = self.imported_keys[k]
960 b = pw_decode(a, old_password)
961 c = pw_encode(b, new_password)
962 self.imported_keys[k] = c
963 self.storage.put('imported_keys', self.imported_keys, True)
965 for k, v in self.master_private_keys.items():
966 b = pw_decode(v, old_password)
967 c = pw_encode(b, new_password)
968 self.master_private_keys[k] = c
969 self.storage.put('master_private_keys', self.master_private_keys, True)
971 self.use_encryption = (new_password != None)
972 self.storage.put('use_encryption', self.use_encryption,True)
975 def freeze(self,addr):
976 if self.is_mine(addr) and addr not in self.frozen_addresses:
977 self.frozen_addresses.append(addr)
978 self.storage.put('frozen_addresses', self.frozen_addresses, True)
984 def unfreeze(self,addr):
985 if self.is_mine(addr) and addr in self.frozen_addresses:
986 self.frozen_addresses.remove(addr)
987 self.storage.put('frozen_addresses', self.frozen_addresses, True)
993 def set_verifier(self, verifier):
994 self.verifier = verifier
996 # review transactions that are in the history
997 for addr, hist in self.history.items():
998 if hist == ['*']: continue
999 for tx_hash, tx_height in hist:
1001 # add it in case it was previously unconfirmed
1002 self.verifier.add(tx_hash, tx_height)
1004 # if we are on a pruning server, remove unverified transactions
1005 vr = self.verifier.transactions.keys() + self.verifier.verified_tx.keys()
1006 for tx_hash in self.transactions.keys():
1007 if tx_hash not in vr:
1008 self.transactions.pop(tx_hash)
1011 def check_new_history(self, addr, hist):
1013 # check that all tx in hist are relevant
1015 for tx_hash, height in hist:
1016 tx = self.transactions.get(tx_hash)
1018 if not tx.has_address(addr):
1021 # check that we are not "orphaning" a transaction
1022 old_hist = self.history.get(addr,[])
1023 if old_hist == ['*']: return True
1025 for tx_hash, height in old_hist:
1026 if tx_hash in map(lambda x:x[0], hist): continue
1028 for _addr, _hist in self.history.items():
1029 if _addr == addr: continue
1030 if _hist == ['*']: continue
1031 _tx_hist = map(lambda x:x[0], _hist)
1032 if tx_hash in _tx_hist:
1037 tx = self.transactions.get(tx_hash)
1038 # tx might not be there
1042 if self.verifier.get_height(tx_hash):
1045 print_error("new history is orphaning transaction:", tx_hash)
1046 # check that all outputs are not mine, request histories
1048 for _addr, _v in tx.outputs:
1049 # assert not self.is_mine(_addr)
1050 ext_requests.append( ('blockchain.address.get_history', [_addr]) )
1052 ext_h = self.network.synchronous_get(ext_requests)
1053 print_error("sync:", ext_requests, ext_h)
1056 if h == ['*']: continue
1058 if item.get('tx_hash') == tx_hash:
1059 height = item.get('height')
1061 print_error("found height for", tx_hash, height)
1062 self.verifier.add(tx_hash, height)
1064 print_error("removing orphaned tx from history", tx_hash)
1065 self.transactions.pop(tx_hash)
1070 def check_new_tx(self, tx_hash, tx):
1071 # 1 check that tx is referenced in addr_history.
1073 for addr, hist in self.history.items():
1074 if hist == ['*']:continue
1075 for txh, height in hist:
1077 addresses.append(addr)
1082 # 2 check that referencing addresses are in the tx
1083 for addr in addresses:
1084 if not tx.has_address(addr):
1090 def start_threads(self, network):
1091 from verifier import TxVerifier
1092 self.network = network
1093 if self.network is not None:
1094 self.verifier = TxVerifier(self.network, self.storage)
1095 self.verifier.start()
1096 self.set_verifier(self.verifier)
1097 self.synchronizer = WalletSynchronizer(self, network)
1098 self.synchronizer.start()
1100 self.verifier = None
1101 self.synchronizer =None
1103 def stop_threads(self):
1105 self.verifier.stop()
1106 self.synchronizer.stop()
1108 def restore(self, cb):
1113 class Imported_Wallet(Abstract_Wallet):
1115 def __init__(self, storage):
1116 Abstract_Wallet.__init__(self, storage)
1118 def is_watching_only(self):
1119 n = self.imported_keys.values()
1120 return n == [''] * len(n)
1125 def is_deterministic(self):
1128 def check_password(self, password):
1129 if self.imported_keys:
1130 k, v = self.imported_keys.items()[0]
1131 sec = pw_decode(v, password)
1132 address = address_from_private_key(sec)
1136 class Deterministic_Wallet(Abstract_Wallet):
1138 def __init__(self, storage):
1139 Abstract_Wallet.__init__(self, storage)
1142 return self.seed != ''
1144 def is_deterministic(self):
1147 def is_watching_only(self):
1148 return not self.has_seed()
1150 def check_password(self, password):
1151 self.get_seed(password)
1153 def get_seed(self, password):
1154 s = pw_decode(self.seed, password)
1155 seed = mnemonic_to_seed(s,'').encode('hex')
1158 def get_mnemonic(self, password):
1159 return pw_decode(self.seed, password)
1161 def change_gap_limit(self, value):
1162 if value >= self.gap_limit:
1163 self.gap_limit = value
1164 self.storage.put('gap_limit', self.gap_limit, True)
1165 #self.interface.poke('synchronizer')
1168 elif value >= self.min_acceptable_gap():
1169 for key, account in self.accounts.items():
1170 addresses = account[0]
1171 k = self.num_unused_trailing_addresses(addresses)
1172 n = len(addresses) - k + value
1173 addresses = addresses[0:n]
1174 self.accounts[key][0] = addresses
1176 self.gap_limit = value
1177 self.storage.put('gap_limit', self.gap_limit, True)
1178 self.save_accounts()
1183 def num_unused_trailing_addresses(self, addresses):
1185 for a in addresses[::-1]:
1186 if self.history.get(a):break
1190 def min_acceptable_gap(self):
1191 # fixme: this assumes wallet is synchronized
1195 for account in self.accounts.values():
1196 addresses = account.get_addresses(0)
1197 k = self.num_unused_trailing_addresses(addresses)
1198 for a in addresses[0:-k]:
1199 if self.history.get(a):
1203 if n > nmax: nmax = n
1207 def address_is_old(self, address):
1209 h = self.history.get(address, [])
1212 for tx_hash, tx_height in h:
1216 tx_age = self.network.get_local_height() - tx_height + 1
1222 def synchronize_sequence(self, account, for_change):
1223 limit = self.gap_limit_for_change if for_change else self.gap_limit
1226 addresses = account.get_addresses(for_change)
1227 if len(addresses) < limit:
1228 address = account.create_new_address(for_change)
1229 self.history[address] = []
1230 new_addresses.append( address )
1233 if map( lambda a: self.address_is_old(a), addresses[-limit:] ) == limit*[False]:
1236 address = account.create_new_address(for_change)
1237 self.history[address] = []
1238 new_addresses.append( address )
1240 return new_addresses
1243 def check_pending_accounts(self):
1244 for account_id, addr in self.next_addresses.items():
1245 if self.address_is_old(addr):
1246 print_error( "creating account", account_id )
1247 xpub = self.master_public_keys[account_id]
1248 account = BIP32_Account({'xpub':xpub})
1249 self.add_account(account_id, account)
1250 self.next_addresses.pop(account_id)
1253 def synchronize_account(self, account):
1255 new += self.synchronize_sequence(account, 0)
1256 new += self.synchronize_sequence(account, 1)
1260 def synchronize(self):
1261 self.check_pending_accounts()
1263 for account in self.accounts.values():
1264 new += self.synchronize_account(account)
1266 self.save_accounts()
1267 self.storage.put('addr_history', self.history, True)
1271 def restore(self, callback):
1273 def wait_for_wallet():
1274 self.set_up_to_date(False)
1275 while not self.is_up_to_date():
1276 msg = "%s\n%s %d\n%s %.1f"%(
1277 _("Please wait..."),
1278 _("Addresses generated:"),
1279 len(self.addresses(True)),
1280 _("Kilobytes received:"),
1281 self.network.interface.bytes_received/1024.)
1283 apply(callback, (msg,))
1286 def wait_for_network():
1287 while not self.network.is_connected():
1288 msg = "%s \n" % (_("Connecting..."))
1289 apply(callback, (msg,))
1292 # wait until we are connected, because the user might have selected another server
1299 self.fill_addressbook()
1302 def create_account(self, name, password):
1303 i = self.num_accounts()
1304 account_id = self.account_id(i)
1305 account = self.make_account(account_id, password)
1306 self.add_account(account_id, account)
1308 self.set_label(account_id, name)
1310 # add address of the next account
1311 _, _ = self.next_account_address(password)
1314 def add_account(self, account_id, account):
1315 self.accounts[account_id] = account
1316 if account_id in self.pending_accounts:
1317 self.pending_accounts.pop(account_id)
1318 self.storage.put('pending_accounts', self.pending_accounts)
1319 self.save_accounts()
1322 def save_accounts(self):
1324 for k, v in self.accounts.items():
1326 self.storage.put('accounts', d, True)
1330 def load_accounts(self):
1331 d = self.storage.get('accounts', {})
1333 for k, v in d.items():
1335 v['mpk'] = self.storage.get('master_public_key')
1336 self.accounts[k] = OldAccount(v)
1337 elif v.get('xpub3'):
1338 self.accounts[k] = BIP32_Account_2of3(v)
1339 elif v.get('xpub2'):
1340 self.accounts[k] = BIP32_Account_2of2(v)
1342 self.accounts[k] = BIP32_Account(v)
1346 self.pending_accounts = self.storage.get('pending_accounts',{})
1349 def delete_pending_account(self, k):
1350 self.pending_accounts.pop(k)
1351 self.storage.put('pending_accounts', self.pending_accounts)
1353 def account_is_pending(self, k):
1354 return k in self.pending_accounts
1356 def create_pending_account(self, name, password):
1357 account_id, addr = self.next_account_address(password)
1358 self.set_label(account_id, name)
1359 self.pending_accounts[account_id] = addr
1360 self.storage.put('pending_accounts', self.pending_accounts)
1362 def get_pending_accounts(self):
1363 return self.pending_accounts.items()
1367 class NewWallet(Deterministic_Wallet):
1369 def __init__(self, storage):
1370 Deterministic_Wallet.__init__(self, storage)
1372 def can_create_accounts(self):
1373 return not self.is_watching_only()
1375 def get_master_public_key(self):
1376 return self.master_public_keys["m/"]
1378 def get_master_public_keys(self):
1380 for k, account in self.accounts.items():
1381 name = self.get_account_name(k)
1382 mpk_text = '\n\n'.join( account.get_master_pubkeys() )
1383 out[name] = mpk_text
1386 def get_master_private_key(self, account, password):
1387 k = self.master_private_keys.get(account)
1389 xpriv = pw_decode( k, password)
1392 def add_seed(self, seed, password):
1394 raise Exception("a seed exists")
1396 self.seed_version, self.seed = self.prepare_seed(seed)
1398 self.seed = pw_encode( self.seed, password)
1399 self.use_encryption = True
1401 self.use_encryption = False
1403 self.storage.put('seed', self.seed, True)
1404 self.storage.put('seed_version', self.seed_version, True)
1405 self.storage.put('use_encryption', self.use_encryption,True)
1406 self.create_master_keys(password)
1409 def create_watching_only_wallet(self, xpub):
1410 self.storage.put('seed_version', self.seed_version, True)
1411 self.add_master_public_key("m/", xpub)
1412 account = BIP32_Account({'xpub':xpub})
1413 self.add_account("m/", account)
1416 def create_accounts(self, password):
1417 seed = pw_decode(self.seed, password)
1418 self.create_account('Main account', password)
1421 def add_master_public_key(self, name, mpk):
1422 self.master_public_keys[name] = mpk
1423 self.storage.put('master_public_keys', self.master_public_keys, True)
1426 def add_master_private_key(self, name, xpriv, password):
1427 self.master_private_keys[name] = pw_encode(xpriv, password)
1428 self.storage.put('master_private_keys', self.master_private_keys, True)
1431 def add_master_keys(self, root, account_id, password):
1432 x = self.master_private_keys.get(root)
1434 master_xpriv = pw_decode(x, password )
1435 xpriv, xpub = bip32_private_derivation(master_xpriv, root, account_id)
1436 self.add_master_public_key(account_id, xpub)
1437 self.add_master_private_key(account_id, xpriv, password)
1439 master_xpub = self.master_public_keys[root]
1440 xpub = bip32_public_derivation(master_xpub, root, account_id)
1441 self.add_master_public_key(account_id, xpub)
1445 def create_master_keys(self, password):
1446 xpriv, xpub = bip32_root(self.get_seed(password))
1447 self.add_master_public_key("m/", xpub)
1448 self.add_master_private_key("m/", xpriv, password)
1451 def find_root_by_master_key(self, xpub):
1452 for key, xpub2 in self.master_public_keys.items():
1453 if key == "m/":continue
1458 def num_accounts(self):
1459 keys = self.accounts.keys()
1462 account_id = self.account_id(i)
1463 if account_id not in keys: break
1468 def next_account_address(self, password):
1469 i = self.num_accounts()
1470 account_id = self.account_id(i)
1472 addr = self.next_addresses.get(account_id)
1474 account = self.make_account(account_id, password)
1475 addr = account.first_address()
1476 self.next_addresses[account_id] = addr
1477 self.storage.put('next_addresses', self.next_addresses)
1479 return account_id, addr
1481 def account_id(self, i):
1484 def make_account(self, account_id, password):
1485 """Creates and saves the master keys, but does not save the account"""
1486 xpub = self.add_master_keys("m/", account_id, password)
1487 account = BIP32_Account({'xpub':xpub})
1491 def make_seed(self):
1492 import mnemonic, ecdsa
1493 entropy = ecdsa.util.randrange( pow(2,160) )
1496 ss = "%040x"%(entropy+nonce)
1497 s = hashlib.sha256(ss.decode('hex')).digest().encode('hex')
1498 # we keep only 13 words, that's approximately 139 bits of entropy
1499 words = mnemonic.mn_encode(s)[0:13]
1500 seed = ' '.join(words)
1501 if is_new_seed(seed):
1502 break # this will remove 8 bits of entropy
1506 def prepare_seed(self, seed):
1508 return NEW_SEED_VERSION, unicodedata.normalize('NFC', unicode(seed.strip()))
1512 class Wallet_2of2(NewWallet):
1514 def __init__(self, storage):
1515 NewWallet.__init__(self, storage)
1516 self.storage.put('wallet_type', '2of2', True)
1518 def create_account(self):
1519 xpub1 = self.master_public_keys.get("m/")
1520 xpub2 = self.master_public_keys.get("cold/")
1521 account = BIP32_Account_2of2({'xpub':xpub1, 'xpub2':xpub2})
1522 self.add_account('m/', account)
1524 def get_master_public_keys(self):
1525 xpub1 = self.master_public_keys.get("m/")
1526 xpub2 = self.master_public_keys.get("cold/")
1527 return {'hot':xpub1, 'cold':xpub2}
1529 def get_action(self):
1530 xpub1 = self.master_public_keys.get("m/")
1531 xpub2 = self.master_public_keys.get("cold/")
1533 return 'create_2of2_1'
1535 return 'create_2of2_2'
1539 class Wallet_2of3(Wallet_2of2):
1541 def __init__(self, storage):
1542 Wallet_2of2.__init__(self, storage)
1543 self.storage.put('wallet_type', '2of3', True)
1545 def create_account(self):
1546 xpub1 = self.master_public_keys.get("m/")
1547 xpub2 = self.master_public_keys.get("cold/")
1548 xpub3 = self.master_public_keys.get("remote/")
1549 account = BIP32_Account_2of3({'xpub':xpub1, 'xpub2':xpub2, 'xpub3':xpub3})
1550 self.add_account('m/', account)
1552 def get_master_public_keys(self):
1553 xpub1 = self.master_public_keys.get("m/")
1554 xpub2 = self.master_public_keys.get("cold/")
1555 xpub3 = self.master_public_keys.get("remote/")
1556 return {'hot':xpub1, 'cold':xpub2, 'remote':xpub3}
1558 def get_action(self):
1559 xpub1 = self.master_public_keys.get("m/")
1560 xpub2 = self.master_public_keys.get("cold/")
1561 xpub3 = self.master_public_keys.get("remote/")
1563 return 'create_2of3_1'
1565 return 'create_2of3_2'
1567 return 'create_2of3_3'
1573 class OldWallet(Deterministic_Wallet):
1575 def make_seed(self):
1577 seed = random_seed(128)
1578 return ' '.join(mnemonic.mn_encode(seed))
1580 def prepare_seed(self, seed):
1582 # see if seed was entered as hex
1587 return OLD_SEED_VERSION, str(seed)
1591 words = seed.split()
1592 seed = mnemonic.mn_decode(words)
1594 raise Exception("Invalid seed")
1596 return OLD_SEED_VERSION, seed
1599 def create_master_keys(self, password):
1600 seed = pw_decode(self.seed, password)
1601 mpk = OldAccount.mpk_from_seed(seed)
1602 self.storage.put('master_public_key', mpk, True)
1604 def get_master_public_key(self):
1605 return self.storage.get("master_public_key")
1607 def get_master_public_keys(self):
1608 return {'Main Account':self.get_master_public_key()}
1610 def create_accounts(self, password):
1611 mpk = self.storage.get("master_public_key")
1612 self.create_account(mpk)
1614 def create_account(self, mpk):
1615 self.accounts[0] = OldAccount({'mpk':mpk, 0:[], 1:[]})
1616 self.save_accounts()
1618 def create_watching_only_wallet(self, mpk):
1619 self.seed_version = OLD_SEED_VERSION
1620 self.storage.put('seed_version', self.seed_version, True)
1621 self.storage.put('master_public_key', mpk, True)
1622 self.create_account(mpk)
1624 def get_seed(self, password):
1625 seed = pw_decode(self.seed, password)
1626 self.accounts[0].check_seed(seed)
1629 def get_mnemonic(self, password):
1631 s = pw_decode(self.seed, password)
1632 return ' '.join(mnemonic.mn_encode(s))
1635 def add_keypairs_from_KeyID(self, tx, keypairs, password):
1636 # first check the provided password
1637 seed = self.get_seed(password)
1638 for txin in tx.inputs:
1639 keyid = txin.get('KeyID')
1641 m = re.match("old\(([0-9a-f]+),(\d+),(\d+)", keyid)
1644 if mpk != self.storage.get('master_public_key'): continue
1645 for_change = int(m.group(2))
1646 num = int(m.group(3))
1647 account = self.accounts[0]
1648 addr = account.get_address(for_change, num)
1649 txin['address'] = addr # fixme: side effect
1650 pk = account.get_private_key(seed, (for_change, num))
1651 pubkey = public_key_from_private_key(pk)
1652 keypairs[pubkey] = pk
1655 def get_account_name(self, k):
1657 return 'Main account'
1660 def get_private_key(self, address, password):
1661 if self.is_watching_only():
1665 if address in self.imported_keys.keys():
1666 self.check_password()
1667 out.append( pw_decode( self.imported_keys[address], password ) )
1669 seed = self.get_seed(password)
1670 account_id, sequence = self.get_address_index(address)
1671 pk = self.accounts[0].get_private_key(seed, sequence)
1675 def check_pending_accounts(self):
1679 # former WalletFactory
1680 class Wallet(object):
1682 def __new__(self, storage):
1683 config = storage.config
1684 if config.get('bitkey', False):
1685 # if user requested support for Bitkey device,
1686 # import Bitkey driver
1687 from wallet_bitkey import WalletBitkey
1688 return WalletBitkey(config)
1690 if storage.get('wallet_type') == '2of2':
1691 return Wallet_2of2(storage)
1693 if storage.get('wallet_type') == '2of3':
1694 return Wallet_2of3(storage)
1696 if storage.file_exists and not storage.get('seed'):
1697 # wallet made of imported keys
1698 return Imported_Wallet(storage)
1701 if not storage.file_exists:
1702 seed_version = NEW_SEED_VERSION if config.get('bip32') is True else OLD_SEED_VERSION
1704 seed_version = storage.get('seed_version')
1705 if not seed_version:
1706 seed_version = OLD_SEED_VERSION if len(storage.get('master_public_key')) == 128 else NEW_SEED_VERSION
1708 if seed_version == OLD_SEED_VERSION:
1709 return OldWallet(storage)
1710 elif seed_version == NEW_SEED_VERSION:
1711 return NewWallet(storage)
1713 msg = "This wallet seed is not supported."
1714 if seed_version in [5]:
1715 msg += "\nTo open this wallet, try 'git checkout seed_v%d'"%seed_version
1722 def is_seed(self, seed):
1725 elif is_old_seed(seed):
1727 elif is_new_seed(seed):
1733 def is_mpk(self, mpk):
1741 return len(mpk) == 128
1744 deserialize_xkey(mpk)
1750 def is_address(self, text):
1751 for x in text.split():
1752 if not bitcoin.is_address(x):
1757 def is_private_key(self, text):
1758 for x in text.split():
1759 if not bitcoin.is_private_key(x):
1764 def from_seed(self, seed, storage):
1765 if is_old_seed(seed):
1767 elif is_new_seed(seed):
1773 def from_address(self, text, storage):
1774 w = Imported_Wallet(storage)
1775 for x in text.split():
1776 w.imported_keys[x] = ''
1777 w.storage.put('imported_keys', w.imported_keys, True)
1781 def from_private_key(self, text, storage):
1782 w = Imported_Wallet(storage)
1783 for x in text.split():
1784 w.import_key(x, None)
1788 def from_mpk(self, mpk, storage):
1797 w = OldWallet(storage)
1799 w.create_watching_only_wallet(mpk)
1801 w = NewWallet(storage)
1802 w.create_watching_only_wallet(mpk)