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/>.
33 from util import print_msg, print_error, format_satoshis
36 from transaction import Transaction
37 from plugins import run_hook
39 COINBASE_MATURITY = 100
43 EncodeAES = lambda secret, s: base64.b64encode(aes.encryptData(secret,s))
44 DecodeAES = lambda secret, e: aes.decryptData(secret, base64.b64decode(e))
46 def pw_encode(s, password):
48 secret = Hash(password)
49 return EncodeAES(secret, s)
53 def pw_decode(s, password):
54 if password is not None:
55 secret = Hash(password)
57 d = DecodeAES(secret, s)
59 raise Exception('Invalid password')
73 def __init__(self, config):
74 self.lock = threading.Lock()
76 self.file_exists = False
77 self.path = self.init_path(config)
78 print_error( "wallet path", self.path )
83 def init_path(self, config):
84 """Set the path of the wallet."""
86 # command line -w option
87 path = config.get('wallet_path')
92 path = config.get('default_wallet_path')
97 dirpath = os.path.join(config.path, "wallets")
98 if not os.path.exists(dirpath):
101 new_path = os.path.join(config.path, "wallets", "default_wallet")
103 # default path in pre 1.9 versions
104 old_path = os.path.join(config.path, "electrum.dat")
105 if os.path.exists(old_path) and not os.path.exists(new_path):
106 os.rename(old_path, new_path)
111 def read(self, path):
112 """Read the contents of the wallet file."""
114 with open(self.path, "r") as f:
119 d = ast.literal_eval( data ) #parse raw data from reading wallet file
121 raise IOError("Cannot read wallet file.")
124 self.file_exists = True
127 def get(self, key, default=None):
128 v = self.data.get(key)
133 def put(self, key, value, save = True):
136 if value is not None:
137 self.data[key] = value
145 f = open(self.path,"w")
148 if 'ANDROID_DATA' not in os.environ:
150 os.chmod(self.path,stat.S_IREAD | stat.S_IWRITE)
155 def __init__(self, storage):
157 self.storage = storage
158 self.electrum_version = ELECTRUM_VERSION
159 self.gap_limit_for_change = 3 # constant
162 self.seed_version = storage.get('seed_version', SEED_VERSION)
164 self.gap_limit = storage.get('gap_limit', 5)
165 self.use_change = storage.get('use_change',True)
166 self.use_encryption = storage.get('use_encryption', False)
167 self.seed = storage.get('seed', '') # encrypted
168 self.labels = storage.get('labels', {})
169 self.frozen_addresses = storage.get('frozen_addresses',[])
170 self.addressbook = storage.get('contacts', [])
172 self.imported_keys = storage.get('imported_keys',{})
173 self.history = storage.get('addr_history',{}) # address -> list(txid, height)
175 self.fee = int(storage.get('fee_per_kb',20000))
177 self.master_public_keys = storage.get('master_public_keys',{})
178 self.master_private_keys = storage.get('master_private_keys', {})
180 self.next_addresses = storage.get('next_addresses',{})
182 if self.seed_version not in [4, 6]:
183 msg = "This wallet seed is not supported."
184 if self.seed_version in [5]:
185 msg += "\nTo open this wallet, try 'git checkout seed_v%d'"%self.seed_version
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})
244 def set_up_to_date(self,b):
245 with self.lock: self.up_to_date = b
248 def is_up_to_date(self):
249 with self.lock: return self.up_to_date
253 self.up_to_date = False
254 while not self.is_up_to_date():
258 def import_key(self, sec, password):
260 seed = self.get_seed(password)
262 address = address_from_private_key(sec)
264 raise Exception('Invalid private key')
266 if self.is_mine(address):
267 raise Exception('Address already in wallet')
269 # store the originally requested keypair into the imported keys table
270 self.imported_keys[address] = pw_encode(sec, password )
271 self.storage.put('imported_keys', self.imported_keys, True)
272 if self.synchronizer:
273 self.synchronizer.subscribe_to_addresses([address])
276 def delete_imported_key(self, addr):
277 if addr in self.imported_keys:
278 self.imported_keys.pop(addr)
279 self.storage.put('imported_keys', self.imported_keys, True)
283 import mnemonic, ecdsa
284 entropy = ecdsa.util.randrange( pow(2,160) )
287 ss = "%040x"%(entropy+nonce)
288 s = hashlib.sha256(ss.decode('hex')).digest().encode('hex')
289 # we keep only 13 words, that's approximately 139 bits of entropy
290 words = mnemonic.mn_encode(s)[0:13]
291 seed = ' '.join(words)
292 if mnemonic_hash(seed).startswith(SEED_PREFIX):
293 break # this removes 12 bits of entropy
299 def init_seed(self, seed):
303 raise Exception("a seed exists")
306 self.seed = random_seed(128)
307 self.seed_version = 4
311 # self.seed = self.make_seed()
312 # self.seed_version = SEED_VERSION
315 # find out what kind of wallet we are
317 seed.strip().decode('hex')
318 self.seed_version = 4
319 self.seed = str(seed)
325 self.seed_version = 4
326 self.seed = mnemonic.mn_decode(words)
329 # mnemonic.mn_decode(words)
330 # uses_electrum_words = True
332 # uses_electrum_words = False
334 #if uses_electrum_words and len(words) != 13:
335 # self.seed_version = 4
336 # self.seed = mnemonic.mn_decode(words)
338 # assert mnemonic_hash(seed).startswith(SEED_PREFIX)
339 # self.seed_version = SEED_VERSION
343 def save_seed(self, password):
345 self.seed = pw_encode( self.seed, password)
346 self.use_encryption = True
347 self.storage.put('seed', self.seed, True)
348 self.storage.put('seed_version', self.seed_version, True)
349 self.storage.put('use_encryption', self.use_encryption,True)
350 self.create_accounts(password)
353 def create_watching_only_wallet(self, params):
359 self.seed_version = 4
360 self.storage.put('seed_version', self.seed_version, True)
361 self.create_old_account(K0)
365 self.master_public_keys = {
366 "m/0'/": (c0, K0, cK0),
368 self.storage.put('master_public_keys', self.master_public_keys, True)
369 self.storage.put('seed_version', self.seed_version, True)
370 self.create_account('1','Main account')
373 def create_accounts(self, password):
374 seed = pw_decode(self.seed, password)
376 if self.seed_version == 4:
377 mpk = OldAccount.mpk_from_seed(seed)
378 self.create_old_account(mpk)
380 # create default account
381 self.create_master_keys('1', password)
382 self.create_account('1','Main account')
385 def create_master_keys(self, account_type, password):
386 master_k, master_c, master_K, master_cK = bip32_init(self.get_seed(None))
387 if account_type == '1':
388 k0, c0, K0, cK0 = bip32_private_derivation(master_k, master_c, "m/", "m/0'/")
389 self.master_public_keys["m/0'/"] = (c0, K0, cK0)
390 self.master_private_keys["m/0'/"] = pw_encode(k0, password)
391 elif account_type == '2of2':
392 k1, c1, K1, cK1 = bip32_private_derivation(master_k, master_c, "m/", "m/1'/")
393 k2, c2, K2, cK2 = bip32_private_derivation(master_k, master_c, "m/", "m/2'/")
394 self.master_public_keys["m/1'/"] = (c1, K1, cK1)
395 self.master_public_keys["m/2'/"] = (c2, K2, cK2)
396 self.master_private_keys["m/1'/"] = pw_encode(k1, password)
397 self.master_private_keys["m/2'/"] = pw_encode(k2, password)
398 elif account_type == '2of3':
399 k3, c3, K3, cK3 = bip32_private_derivation(master_k, master_c, "m/", "m/3'/")
400 k4, c4, K4, cK4 = bip32_private_derivation(master_k, master_c, "m/", "m/4'/")
401 k5, c5, K5, cK5 = bip32_private_derivation(master_k, master_c, "m/", "m/5'/")
402 self.master_public_keys["m/3'/"] = (c3, K3, cK3)
403 self.master_public_keys["m/4'/"] = (c4, K4, cK4)
404 self.master_public_keys["m/5'/"] = (c5, K5, cK5)
405 self.master_private_keys["m/3'/"] = pw_encode(k3, password)
406 self.master_private_keys["m/4'/"] = pw_encode(k4, password)
407 self.master_private_keys["m/5'/"] = pw_encode(k5, password)
409 self.storage.put('master_public_keys', self.master_public_keys, True)
410 self.storage.put('master_private_keys', self.master_private_keys, True)
412 def has_master_public_keys(self, account_type):
413 if account_type == '1':
414 return "m/0'/" in self.master_public_keys
415 elif account_type == '2of2':
416 return set(["m/1'/", "m/2'/"]) <= set(self.master_public_keys.keys())
417 elif account_type == '2of3':
418 return set(["m/3'/", "m/4'/", "m/5'/"]) <= set(self.master_public_keys.keys())
420 def find_root_by_master_key(self, c, K):
421 for key, v in self.master_public_keys.items():
422 if key == "m/":continue
424 if (c == cc) and (K == KK):
427 def deseed_root(self, seed, password):
428 # for safety, we ask the user to enter their seed
429 assert seed == self.get_seed(password)
431 self.storage.put('seed', '', True)
434 def deseed_branch(self, k):
435 # check that parent has no seed
436 assert self.seed == ''
437 self.master_private_keys.pop(k)
438 self.storage.put('master_private_keys', self.master_private_keys, True)
440 def is_watching_only(self):
441 return (self.seed == '') and (self.master_private_keys == {})
445 def account_id(self, account_type, i):
446 if account_type == '1':
448 elif account_type == '2of2':
449 return "m/1'/%d & m/2'/%d"%(i,i)
450 elif account_type == '2of3':
451 return "m/3'/%d & m/4'/%d & m/5'/%d"%(i,i,i)
453 raise Exception('unknown account type')
456 def num_accounts(self, account_type):
457 keys = self.accounts.keys()
460 account_id = self.account_id(account_type, i)
461 if account_id not in keys: break
466 def new_account_address(self, account_type = '1'):
467 i = self.num_accounts(account_type)
468 k = self.account_id(account_type,i)
470 addr = self.next_addresses.get(k)
472 account_id, account = self.next_account(account_type)
473 addr = account.first_address()
474 self.next_addresses[k] = addr
475 self.storage.put('next_addresses',self.next_addresses)
480 def next_account(self, account_type = '1'):
482 i = self.num_accounts(account_type)
483 account_id = self.account_id(account_type,i)
485 if account_type is '1':
486 master_c0, master_K0, _ = self.master_public_keys["m/0'/"]
487 c0, K0, cK0 = bip32_public_derivation(master_c0.decode('hex'), master_K0.decode('hex'), "m/0'/", "m/0'/%d"%i)
488 account = BIP32_Account({ 'c':c0, 'K':K0, 'cK':cK0 })
490 elif account_type == '2of2':
491 master_c1, master_K1, _ = self.master_public_keys["m/1'/"]
492 c1, K1, cK1 = bip32_public_derivation(master_c1.decode('hex'), master_K1.decode('hex'), "m/1'/", "m/1'/%d"%i)
493 master_c2, master_K2, _ = self.master_public_keys["m/2'/"]
494 c2, K2, cK2 = bip32_public_derivation(master_c2.decode('hex'), master_K2.decode('hex'), "m/2'/", "m/2'/%d"%i)
495 account = BIP32_Account_2of2({ 'c':c1, 'K':K1, 'cK':cK1, 'c2':c2, 'K2':K2, 'cK2':cK2 })
497 elif account_type == '2of3':
498 master_c3, master_K3, _ = self.master_public_keys["m/3'/"]
499 c3, K3, cK3 = bip32_public_derivation(master_c3.decode('hex'), master_K3.decode('hex'), "m/3'/", "m/3'/%d"%i)
500 master_c4, master_K4, _ = self.master_public_keys["m/4'/"]
501 c4, K4, cK4 = bip32_public_derivation(master_c4.decode('hex'), master_K4.decode('hex'), "m/4'/", "m/4'/%d"%i)
502 master_c5, master_K5, _ = self.master_public_keys["m/5'/"]
503 c5, K5, cK5 = bip32_public_derivation(master_c5.decode('hex'), master_K5.decode('hex'), "m/5'/", "m/5'/%d"%i)
504 account = BIP32_Account_2of3({ 'c':c3, 'K':K3, 'cK':cK3, 'c2':c4, 'K2':K4, 'cK2':cK4, 'c3':c5, 'K3':K5, 'cK3':cK5 })
506 return account_id, account
509 def set_label(self, name, text = None):
511 old_text = self.labels.get(name)
514 self.labels[name] = text
518 self.labels.pop(name)
522 self.storage.put('labels', self.labels, True)
524 run_hook('set_label', name, text, changed)
529 def create_account(self, account_type = '1', name = None):
530 k, account = self.next_account(account_type)
531 if k in self.pending_accounts:
532 self.pending_accounts.pop(k)
533 self.storage.put('pending_accounts', self.pending_accounts)
535 self.accounts[k] = account
538 self.set_label(k, name)
541 def create_old_account(self, mpk):
542 self.storage.put('master_public_key', mpk, True)
543 self.accounts[0] = OldAccount({'mpk':mpk, 0:[], 1:[]})
547 def save_accounts(self):
549 for k, v in self.accounts.items():
551 self.storage.put('accounts', d, True)
555 def load_accounts(self):
556 d = self.storage.get('accounts', {})
558 for k, v in d.items():
560 v['mpk'] = self.storage.get('master_public_key')
561 self.accounts[k] = OldAccount(v)
563 self.accounts[k] = BIP32_Account_2of2(v)
565 self.accounts[k] = BIP32_Account(v)
567 self.pending_accounts = self.storage.get('pending_accounts',{})
570 def delete_pending_account(self, k):
571 self.pending_accounts.pop(k)
572 self.storage.put('pending_accounts', self.pending_accounts)
574 def account_is_pending(self, k):
575 return k in self.pending_accounts
577 def create_pending_account(self, acct_type, name):
578 k, addr = self.new_account_address(acct_type)
579 self.set_label(k, name)
580 self.pending_accounts[k] = addr
581 self.storage.put('pending_accounts', self.pending_accounts)
583 def get_pending_accounts(self):
584 return self.pending_accounts.items()
587 def addresses(self, include_change = True, _next=True):
588 o = self.get_account_addresses(-1, include_change)
589 for a in self.accounts.keys():
590 o += self.get_account_addresses(a, include_change)
593 for addr in self.next_addresses.values():
599 def is_mine(self, address):
600 return address in self.addresses(True)
603 def is_change(self, address):
604 if not self.is_mine(address): return False
605 if address in self.imported_keys.keys(): return False
606 acct, s = self.get_address_index(address)
607 if s is None: return False
610 def get_master_public_key(self):
611 if self.seed_version == 4:
612 return self.storage.get("master_public_key")
614 c, K, cK = self.storage.get("master_public_keys")["m/0'/"]
617 def get_master_private_key(self, account, password):
618 master_k = pw_decode( self.master_private_keys[account], password)
619 master_c, master_K, master_Kc = self.master_public_keys[account]
621 K, Kc = get_pubkeys_from_secret(master_k.decode('hex'))
622 assert K.encode('hex') == master_K
624 raise Exception("Invalid password")
628 def get_address_index(self, address):
629 if address in self.imported_keys.keys():
632 for account in self.accounts.keys():
633 for for_change in [0,1]:
634 addresses = self.accounts[account].get_addresses(for_change)
635 for addr in addresses:
637 return account, (for_change, addresses.index(addr))
639 for k,v in self.next_addresses.items():
643 raise Exception("Address not found", address)
646 def get_roots(self, account):
648 for a in account.split('&'):
650 m = re.match("(m/\d+'/)(\d+)", s)
651 roots.append( m.group(1) )
654 def is_seeded(self, account):
655 if type(account) is int:
656 return self.seed is not None
658 for root in self.get_roots(account):
659 if root not in self.master_private_keys.keys():
663 def rebase_sequence(self, account, sequence):
666 for a in account.split('&'):
668 m = re.match("(m/\d+'/)(\d+)", s)
670 num = int(m.group(2))
671 dd.append( (root, [num,c,i] ) )
675 def get_keyID(self, account, sequence):
678 mpk = self.storage.get('master_public_key')
679 return 'old(%s,%d,%d)'%(mpk,a,b)
681 rs = self.rebase_sequence(account, sequence)
683 for root, public_sequence in rs:
684 c, K, _ = self.master_public_keys[root]
685 s = '/' + '/'.join( map(lambda x:str(x), public_sequence) )
686 dd.append( 'bip32(%s,%s,%s)'%(c,K, s) )
691 def get_seed(self, password):
692 s = pw_decode(self.seed, password)
693 if self.seed_version == 4:
695 self.accounts[0].check_seed(seed)
697 seed = mnemonic_hash(s)
701 def get_mnemonic(self, password):
703 s = pw_decode(self.seed, password)
704 if self.seed_version == 4:
705 return ' '.join(mnemonic.mn_encode(s))
711 def get_private_key(self, address, password):
712 if self.is_watching_only():
715 # first check the provided password
716 seed = self.get_seed(password)
719 if address in self.imported_keys.keys():
720 out.append( pw_decode( self.imported_keys[address], password ) )
722 account, sequence = self.get_address_index(address)
724 pk = self.accounts[account].get_private_key(seed, sequence)
728 # assert address == self.accounts[account].get_address(*sequence)
729 rs = self.rebase_sequence( account, sequence)
730 for root, public_sequence in rs:
732 if root not in self.master_private_keys.keys(): continue
733 master_k = self.get_master_private_key(root, password)
734 master_c, _, _ = self.master_public_keys[root]
735 pk = bip32_private_key( public_sequence, master_k.decode('hex'), master_c.decode('hex'))
741 def add_keypairs_from_wallet(self, tx, keypairs, password):
742 for txin in tx.inputs:
743 address = txin['address']
744 if not self.is_mine(address):
746 private_keys = self.get_private_key(address, password)
747 for sec in private_keys:
748 pubkey = public_key_from_private_key(sec)
749 keypairs[ pubkey ] = sec
750 if address in self.imported_keys.keys():
751 txin['redeemPubkey'] = pubkey
754 def add_keypairs_from_KeyID(self, tx, keypairs, password):
755 # first check the provided password
756 seed = self.get_seed(password)
758 for txin in tx.inputs:
759 keyid = txin.get('KeyID')
762 if self.seed_version == 4:
763 m = re.match("old\(([0-9a-f]+),(\d+),(\d+)", keyid)
766 if mpk != self.storage.get('master_public_key'): continue
767 for_change = int(m.group(2))
768 num = int(m.group(3))
769 account = self.accounts[0]
770 addr = account.get_address(for_change, num)
771 txin['address'] = addr # fixme: side effect
772 pk = account.get_private_key(seed, (for_change, num))
773 pubkey = public_key_from_private_key(pk)
774 keypairs[pubkey] = pk
779 for s in keyid.split('&'):
780 m = re.match("bip32\(([0-9a-f]+),([0-9a-f]+),(/\d+/\d+/\d+)", s)
784 sequence = m.group(3)
785 root = self.find_root_by_master_key(c,K)
786 if not root: continue
787 sequence = map(lambda x:int(x), sequence.strip('/').split('/'))
788 root = root + '%d'%sequence[0]
789 sequence = sequence[1:]
790 roots.append((root,sequence))
792 account_id = " & ".join( map(lambda x:x[0], roots) )
793 account = self.accounts.get(account_id)
794 if not account: continue
795 addr = account.get_address(*sequence)
796 txin['address'] = addr # fixme: side effect
797 pk = self.get_private_key(addr, password)
799 pubkey = public_key_from_private_key(sec)
800 keypairs[pubkey] = sec
804 def signrawtransaction(self, tx, input_info, private_keys, password):
806 # check that the password is correct
807 seed = self.get_seed(password)
810 tx.add_input_info(input_info)
812 # add redeem script for coins that are in the wallet
813 # FIXME: add redeemPubkey too!
814 unspent_coins = self.get_unspent_coins()
815 for txin in tx.inputs:
816 for item in unspent_coins:
817 if txin['prevout_hash'] == item['prevout_hash'] and txin['prevout_n'] == item['prevout_n']:
818 print_error( "tx input is in unspent coins" )
819 txin['scriptPubKey'] = item['scriptPubKey']
820 account, sequence = self.get_address_index(item['address'])
822 txin['redeemScript'] = self.accounts[account].redeem_script(sequence)
823 print_error("added redeemScript", txin['redeemScript'])
827 # build a list of public/private keys
830 # add private keys from parameter
831 for sec in private_keys:
832 pubkey = public_key_from_private_key(sec)
833 keypairs[ pubkey ] = sec
835 # add private_keys from KeyID
836 self.add_keypairs_from_KeyID(tx, keypairs, password)
838 # add private keys from wallet
839 self.add_keypairs_from_wallet(tx, keypairs, password)
840 self.sign_transaction(tx, keypairs)
843 def sign_message(self, address, message, password):
844 keys = self.get_private_key(address, password)
845 assert len(keys) == 1
847 key = regenerate_key(sec)
848 compressed = is_compressed(sec)
849 return key.sign_message(message, compressed, address)
852 def change_gap_limit(self, value):
853 if value >= self.gap_limit:
854 self.gap_limit = value
855 self.storage.put('gap_limit', self.gap_limit, True)
856 #self.interface.poke('synchronizer')
859 elif value >= self.min_acceptable_gap():
860 for key, account in self.accounts.items():
861 addresses = account[0]
862 k = self.num_unused_trailing_addresses(addresses)
863 n = len(addresses) - k + value
864 addresses = addresses[0:n]
865 self.accounts[key][0] = addresses
867 self.gap_limit = value
868 self.storage.put('gap_limit', self.gap_limit, True)
874 def num_unused_trailing_addresses(self, addresses):
876 for a in addresses[::-1]:
877 if self.history.get(a):break
881 def min_acceptable_gap(self):
882 # fixme: this assumes wallet is synchronized
886 for account in self.accounts.values():
887 addresses = account.get_addresses(0)
888 k = self.num_unused_trailing_addresses(addresses)
889 for a in addresses[0:-k]:
890 if self.history.get(a):
894 if n > nmax: nmax = n
898 def address_is_old(self, address):
900 h = self.history.get(address, [])
903 for tx_hash, tx_height in h:
907 tx_age = self.verifier.blockchain.height() - tx_height + 1
913 def synchronize_sequence(self, account, for_change):
914 limit = self.gap_limit_for_change if for_change else self.gap_limit
917 addresses = account.get_addresses(for_change)
918 if len(addresses) < limit:
919 address = account.create_new_address(for_change)
920 self.history[address] = []
921 new_addresses.append( address )
924 if map( lambda a: self.address_is_old(a), addresses[-limit:] ) == limit*[False]:
927 address = account.create_new_address(for_change)
928 self.history[address] = []
929 new_addresses.append( address )
935 def create_pending_accounts(self):
936 for account_type in ['1','2of2','2of3']:
937 if not self.has_master_public_keys(account_type):
939 k, a = self.new_account_address(account_type)
940 if self.address_is_old(a):
941 print_error( "creating account", a )
942 self.create_account(account_type)
943 self.next_addresses.pop(k)
946 def synchronize_account(self, account):
948 new += self.synchronize_sequence(account, 0)
949 new += self.synchronize_sequence(account, 1)
953 def synchronize(self):
954 if self.master_public_keys:
955 self.create_pending_accounts()
957 for account in self.accounts.values():
958 new += self.synchronize_account(account)
961 self.storage.put('addr_history', self.history, True)
966 return self.history.values() != [[]] * len(self.history)
969 def add_contact(self, address, label=None):
970 self.addressbook.append(address)
971 self.storage.put('contacts', self.addressbook, True)
973 self.set_label(address, label)
976 def delete_contact(self, addr):
977 if addr in self.addressbook:
978 self.addressbook.remove(addr)
979 self.storage.put('addressbook', self.addressbook, True)
982 def fill_addressbook(self):
983 for tx_hash, tx in self.transactions.items():
984 is_relevant, is_send, _, _ = self.get_tx_value(tx)
986 for addr, v in tx.outputs:
987 if not self.is_mine(addr) and addr not in self.addressbook:
988 self.addressbook.append(addr)
990 # self.update_tx_labels()
992 def get_num_tx(self, address):
994 for tx in self.transactions.values():
995 if address in map(lambda x:x[0], tx.outputs): n += 1
999 def get_address_flags(self, addr):
1000 flags = "C" if self.is_change(addr) else "I" if addr in self.imported_keys.keys() else "-"
1001 flags += "F" if addr in self.frozen_addresses else "-"
1005 def get_tx_value(self, tx, account=None):
1006 domain = self.get_account_addresses(account)
1007 return tx.get_value(domain, self.prevout_values)
1010 def update_tx_outputs(self, tx_hash):
1011 tx = self.transactions.get(tx_hash)
1013 for i, (addr, value) in enumerate(tx.outputs):
1014 key = tx_hash+ ':%d'%i
1015 self.prevout_values[key] = value
1017 for item in tx.inputs:
1018 if self.is_mine(item.get('address')):
1019 key = item['prevout_hash'] + ':%d'%item['prevout_n']
1020 self.spent_outputs.append(key)
1023 def get_addr_balance(self, address):
1024 assert self.is_mine(address)
1025 h = self.history.get(address,[])
1026 if h == ['*']: return 0,0
1028 received_coins = [] # list of coins received at address
1030 for tx_hash, tx_height in h:
1031 tx = self.transactions.get(tx_hash)
1034 for i, (addr, value) in enumerate(tx.outputs):
1036 key = tx_hash + ':%d'%i
1037 received_coins.append(key)
1039 for tx_hash, tx_height in h:
1040 tx = self.transactions.get(tx_hash)
1044 for item in tx.inputs:
1045 addr = item.get('address')
1047 key = item['prevout_hash'] + ':%d'%item['prevout_n']
1048 value = self.prevout_values.get( key )
1049 if key in received_coins:
1052 for i, (addr, value) in enumerate(tx.outputs):
1053 key = tx_hash + ':%d'%i
1064 def get_account_name(self, k):
1066 if self.seed_version == 4:
1067 name = 'Main account'
1069 name = 'Old account'
1071 default = "Unnamed account"
1072 m = re.match("m/0'/(\d+)", k)
1076 default = "Main account"
1078 default = "Account %s"%num
1080 m = re.match("m/1'/(\d+) & m/2'/(\d+)", k)
1083 default = "2of2 account %s"%num
1084 name = self.labels.get(k, default)
1088 def get_account_names(self):
1090 for k, account in self.accounts.items():
1091 accounts[k] = self.get_account_name(k)
1092 if self.imported_keys:
1093 accounts[-1] = 'Imported keys'
1096 def get_account_addresses(self, a, include_change=True):
1098 o = self.addresses(True)
1100 o = self.imported_keys.keys()
1102 ac = self.accounts[a]
1103 o = ac.get_addresses(0)
1104 if include_change: o += ac.get_addresses(1)
1107 def get_imported_balance(self):
1108 return self.get_balance(self.imported_keys.keys())
1110 def get_account_balance(self, account):
1111 return self.get_balance(self.get_account_addresses(account))
1113 def get_frozen_balance(self):
1114 return self.get_balance(self.frozen_addresses)
1116 def get_balance(self, domain=None):
1117 if domain is None: domain = self.addresses(True)
1120 c, u = self.get_addr_balance(addr)
1126 def get_unspent_coins(self, domain=None):
1128 if domain is None: domain = self.addresses(True)
1130 h = self.history.get(addr, [])
1131 if h == ['*']: continue
1132 for tx_hash, tx_height in h:
1133 tx = self.transactions.get(tx_hash)
1134 if tx is None: raise Exception("Wallet not synchronized")
1135 is_coinbase = tx.inputs[0].get('prevout_hash') == '0'*64
1136 for o in tx.d.get('outputs'):
1138 if output.get('address') != addr: continue
1139 key = tx_hash + ":%d" % output.get('prevout_n')
1140 if key in self.spent_outputs: continue
1141 output['prevout_hash'] = tx_hash
1142 output['height'] = tx_height
1143 output['coinbase'] = is_coinbase
1144 coins.append((tx_height, output))
1148 coins = sorted(coins)
1149 if coins[-1][0] != 0:
1150 while coins[0][0] == 0:
1151 coins = coins[1:] + [ coins[0] ]
1152 return [x[1] for x in coins]
1155 def choose_tx_inputs( self, amount, fixed_fee, domain = None ):
1156 """ todo: minimize tx size """
1158 fee = self.fee if fixed_fee is None else fixed_fee
1160 domain = self.addresses(True)
1162 for i in self.frozen_addresses:
1163 if i in domain: domain.remove(i)
1165 coins = self.get_unspent_coins(domain)
1169 if item.get('coinbase') and item.get('height') + COINBASE_MATURITY > self.network.blockchain.height:
1171 addr = item.get('address')
1172 v = item.get('value')
1175 fee = self.estimated_fee(inputs) if fixed_fee is None else fixed_fee
1176 if total >= amount + fee: break
1180 return inputs, total, fee
1183 def set_fee(self, fee):
1186 self.storage.put('fee_per_kb', self.fee, True)
1188 def estimated_fee(self, inputs):
1189 estimated_size = len(inputs) * 180 + 80 # this assumes non-compressed keys
1190 fee = self.fee * int(round(estimated_size/1024.))
1191 if fee == 0: fee = self.fee
1195 def add_tx_change( self, inputs, outputs, amount, fee, total, change_addr=None):
1196 "add change to a transaction"
1197 change_amount = total - ( amount + fee )
1198 if change_amount > DUST_THRESHOLD:
1201 # send change to one of the accounts involved in the tx
1202 address = inputs[0].get('address')
1203 account, _ = self.get_address_index(address)
1205 if not self.use_change or account == -1:
1206 change_addr = inputs[-1]['address']
1208 change_addr = self.accounts[account].get_addresses(1)[-self.gap_limit_for_change]
1210 # Insert the change output at a random position in the outputs
1211 posn = random.randint(0, len(outputs))
1212 outputs[posn:posn] = [( change_addr, change_amount)]
1216 def get_history(self, address):
1218 return self.history.get(address)
1221 def get_status(self, h):
1222 if not h: return None
1223 if h == ['*']: return '*'
1225 for tx_hash, height in h:
1226 status += tx_hash + ':%d:' % height
1227 return hashlib.sha256( status ).digest().encode('hex')
1230 def receive_tx_callback(self, tx_hash, tx, tx_height):
1232 with self.transaction_lock:
1233 self.add_extra_addresses(tx)
1234 if not self.check_new_tx(tx_hash, tx):
1235 # may happen due to pruning
1236 print_error("received transaction that is no longer referenced in history", tx_hash)
1238 self.transactions[tx_hash] = tx
1239 self.network.interface.pending_transactions_for_notifications.append(tx)
1240 self.save_transactions()
1241 if self.verifier and tx_height>0:
1242 self.verifier.add(tx_hash, tx_height)
1243 self.update_tx_outputs(tx_hash)
1246 def save_transactions(self):
1248 for k,v in self.transactions.items():
1250 self.storage.put('transactions', tx, True)
1252 def receive_history_callback(self, addr, hist):
1254 if not self.check_new_history(addr, hist):
1255 raise Exception("error: received history for %s is not consistent with known transactions"%addr)
1258 self.history[addr] = hist
1259 self.storage.put('addr_history', self.history, True)
1262 for tx_hash, tx_height in hist:
1264 # add it in case it was previously unconfirmed
1265 if self.verifier: self.verifier.add(tx_hash, tx_height)
1268 def get_tx_history(self, account=None):
1269 if not self.verifier:
1272 with self.transaction_lock:
1273 history = self.transactions.items()
1274 history.sort(key = lambda x: self.verifier.get_txpos(x[0]))
1278 for tx_hash, tx in history:
1279 is_relevant, is_mine, v, fee = self.get_tx_value(tx, account)
1280 if v is not None: balance += v
1282 c, u = self.get_account_balance(account)
1285 result.append( ('', 1000, 0, c+u-balance, None, c+u-balance, None ) )
1287 balance = c + u - balance
1288 for tx_hash, tx in history:
1289 is_relevant, is_mine, value, fee = self.get_tx_value(tx, account)
1292 if value is not None:
1295 conf, timestamp = self.verifier.get_confirmations(tx_hash) if self.verifier else (None, None)
1296 result.append( (tx_hash, conf, is_mine, value, fee, balance, timestamp) )
1301 def get_label(self, tx_hash):
1302 label = self.labels.get(tx_hash)
1303 is_default = (label == '') or (label is None)
1304 if is_default: label = self.get_default_label(tx_hash)
1305 return label, is_default
1308 def get_default_label(self, tx_hash):
1309 tx = self.transactions.get(tx_hash)
1312 is_relevant, is_mine, _, _ = self.get_tx_value(tx)
1314 for o in tx.outputs:
1316 if not self.is_mine(o_addr):
1318 default_label = self.labels[o_addr]
1320 default_label = o_addr
1323 default_label = '(internal)'
1325 for o in tx.outputs:
1327 if self.is_mine(o_addr) and not self.is_change(o_addr):
1330 for o in tx.outputs:
1332 if self.is_mine(o_addr):
1338 dest_label = self.labels.get(o_addr)
1340 default_label = self.labels[o_addr]
1342 default_label = o_addr
1344 return default_label
1347 def make_unsigned_transaction(self, outputs, fee=None, change_addr=None, domain=None ):
1348 for address, x in outputs:
1349 assert is_valid(address)
1350 amount = sum( map(lambda x:x[1], outputs) )
1351 inputs, total, fee = self.choose_tx_inputs( amount, fee, domain )
1353 raise ValueError("Not enough funds")
1354 self.add_input_info(inputs)
1355 outputs = self.add_tx_change(inputs, outputs, amount, fee, total, change_addr)
1356 return Transaction.from_io(inputs, outputs)
1359 def mktx(self, outputs, password, fee=None, change_addr=None, domain= None ):
1360 tx = self.make_unsigned_transaction(outputs, fee, change_addr, domain)
1362 self.add_keypairs_from_wallet(tx, keypairs, password)
1364 self.sign_transaction(tx, keypairs)
1368 def add_input_info(self, inputs):
1370 address = txin['address']
1371 if address in self.imported_keys.keys():
1373 account, sequence = self.get_address_index(address)
1374 txin['KeyID'] = self.get_keyID(account, sequence)
1375 redeemScript = self.accounts[account].redeem_script(sequence)
1377 txin['redeemScript'] = redeemScript
1379 txin['redeemPubkey'] = self.accounts[account].get_pubkey(*sequence)
1382 def sign_transaction(self, tx, keypairs):
1384 run_hook('sign_transaction', tx)
1387 def sendtx(self, tx):
1389 h = self.send_tx(tx)
1390 self.tx_event.wait()
1391 return self.receive_tx(h, tx)
1393 def send_tx(self, tx):
1395 self.tx_event.clear()
1396 self.network.interface.send([('blockchain.transaction.broadcast', [str(tx)])], self.on_broadcast)
1399 def on_broadcast(self, i, r):
1400 self.tx_result = r.get('result')
1403 def receive_tx(self, tx_hash, tx):
1404 out = self.tx_result
1406 return False, "error: " + out
1407 run_hook('receive_tx', tx, self)
1412 def update_password(self, old_password, new_password):
1413 if new_password == '': new_password = None
1414 decoded = self.get_seed(old_password)
1415 self.seed = pw_encode( decoded, new_password)
1416 self.storage.put('seed', self.seed, True)
1417 self.use_encryption = (new_password != None)
1418 self.storage.put('use_encryption', self.use_encryption,True)
1419 for k in self.imported_keys.keys():
1420 a = self.imported_keys[k]
1421 b = pw_decode(a, old_password)
1422 c = pw_encode(b, new_password)
1423 self.imported_keys[k] = c
1424 self.storage.put('imported_keys', self.imported_keys, True)
1426 for k, v in self.master_private_keys.items():
1427 b = pw_decode(v, old_password)
1428 c = pw_encode(b, new_password)
1429 self.master_private_keys[k] = c
1430 self.storage.put('master_private_keys', self.master_private_keys, True)
1433 def freeze(self,addr):
1434 if self.is_mine(addr) and addr not in self.frozen_addresses:
1435 self.frozen_addresses.append(addr)
1436 self.storage.put('frozen_addresses', self.frozen_addresses, True)
1441 def unfreeze(self,addr):
1442 if self.is_mine(addr) and addr in self.frozen_addresses:
1443 self.frozen_addresses.remove(addr)
1444 self.storage.put('frozen_addresses', self.frozen_addresses, True)
1450 def set_verifier(self, verifier):
1451 self.verifier = verifier
1453 # review transactions that are in the history
1454 for addr, hist in self.history.items():
1455 if hist == ['*']: continue
1456 for tx_hash, tx_height in hist:
1458 # add it in case it was previously unconfirmed
1459 self.verifier.add(tx_hash, tx_height)
1462 # if we are on a pruning server, remove unverified transactions
1463 vr = self.verifier.transactions.keys() + self.verifier.verified_tx.keys()
1464 for tx_hash in self.transactions.keys():
1465 if tx_hash not in vr:
1466 self.transactions.pop(tx_hash)
1470 def check_new_history(self, addr, hist):
1472 # check that all tx in hist are relevant
1474 for tx_hash, height in hist:
1475 tx = self.transactions.get(tx_hash)
1477 if not tx.has_address(addr):
1480 # check that we are not "orphaning" a transaction
1481 old_hist = self.history.get(addr,[])
1482 if old_hist == ['*']: return True
1484 for tx_hash, height in old_hist:
1485 if tx_hash in map(lambda x:x[0], hist): continue
1487 for _addr, _hist in self.history.items():
1488 if _addr == addr: continue
1489 if _hist == ['*']: continue
1490 _tx_hist = map(lambda x:x[0], _hist)
1491 if tx_hash in _tx_hist:
1496 tx = self.transactions.get(tx_hash)
1497 # tx might not be there
1501 if self.verifier.get_height(tx_hash):
1504 print_error("new history is orphaning transaction:", tx_hash)
1505 # check that all outputs are not mine, request histories
1507 for _addr, _v in tx.outputs:
1508 # assert not self.is_mine(_addr)
1509 ext_requests.append( ('blockchain.address.get_history', [_addr]) )
1511 ext_h = self.network.synchronous_get(ext_requests)
1512 print_error("sync:", ext_requests, ext_h)
1515 if h == ['*']: continue
1517 if item.get('tx_hash') == tx_hash:
1518 height = item.get('height')
1520 print_error("found height for", tx_hash, height)
1521 self.verifier.add(tx_hash, height)
1523 print_error("removing orphaned tx from history", tx_hash)
1524 self.transactions.pop(tx_hash)
1530 def check_new_tx(self, tx_hash, tx):
1531 # 1 check that tx is referenced in addr_history.
1533 for addr, hist in self.history.items():
1534 if hist == ['*']:continue
1535 for txh, height in hist:
1537 addresses.append(addr)
1542 # 2 check that referencing addresses are in the tx
1543 for addr in addresses:
1544 if not tx.has_address(addr):
1550 def start_threads(self, network):
1551 from verifier import TxVerifier
1552 self.network = network
1553 if self.network is not None:
1554 self.verifier = TxVerifier(self.network, self.storage)
1555 self.verifier.start()
1556 self.set_verifier(self.verifier)
1557 self.synchronizer = WalletSynchronizer(self, network)
1558 self.synchronizer.start()
1560 self.verifier = None
1561 self.synchronizer =None
1563 def stop_threads(self):
1565 self.verifier.stop()
1566 self.synchronizer.stop()
1569 def restore(self, callback):
1571 def wait_for_wallet():
1572 self.set_up_to_date(False)
1573 while not self.is_up_to_date():
1574 msg = "%s\n%s %d\n%s %.1f"%(
1575 _("Please wait..."),
1576 _("Addresses generated:"),
1577 len(self.addresses(True)),
1578 _("Kilobytes received:"),
1579 self.network.interface.bytes_received/1024.)
1581 apply(callback, (msg,))
1584 def wait_for_network():
1585 while not self.network.is_connected():
1586 msg = "%s \n" % (_("Connecting..."))
1587 apply(callback, (msg,))
1590 # wait until we are connected, because the user might have selected another server
1597 self.fill_addressbook()
1602 class WalletSynchronizer(threading.Thread):
1605 def __init__(self, wallet, network):
1606 threading.Thread.__init__(self)
1608 self.wallet = wallet
1609 self.network = network
1610 self.was_updated = True
1611 self.running = False
1612 self.lock = threading.Lock()
1613 self.queue = Queue.Queue()
1616 with self.lock: self.running = False
1618 def is_running(self):
1619 with self.lock: return self.running
1622 def subscribe_to_addresses(self, addresses):
1624 for addr in addresses:
1625 messages.append(('blockchain.address.subscribe', [addr]))
1626 self.network.subscribe( messages, lambda i,r: self.queue.put(r))
1633 while self.is_running():
1635 if not self.network.is_connected():
1636 self.network.wait_until_connected()
1638 self.run_interface()
1641 def run_interface(self):
1643 print_error("synchronizer: connected to", self.network.main_server())
1647 requested_histories = {}
1649 # request any missing transactions
1650 for history in self.wallet.history.values():
1651 if history == ['*']: continue
1652 for tx_hash, tx_height in history:
1653 if self.wallet.transactions.get(tx_hash) is None and (tx_hash, tx_height) not in missing_tx:
1654 missing_tx.append( (tx_hash, tx_height) )
1657 print_error("missing tx", missing_tx)
1660 self.subscribe_to_addresses(self.wallet.addresses(True))
1662 while self.is_running():
1663 # 1. create new addresses
1664 new_addresses = self.wallet.synchronize()
1666 # request missing addresses
1668 self.subscribe_to_addresses(new_addresses)
1670 # request missing transactions
1671 for tx_hash, tx_height in missing_tx:
1672 if (tx_hash, tx_height) not in requested_tx:
1673 self.network.send([ ('blockchain.transaction.get',[tx_hash, tx_height]) ], lambda i,r: self.queue.put(r))
1674 requested_tx.append( (tx_hash, tx_height) )
1677 # detect if situation has changed
1678 if self.network.is_up_to_date() and self.queue.empty():
1679 if not self.wallet.is_up_to_date():
1680 self.wallet.set_up_to_date(True)
1681 self.was_updated = True
1683 if self.wallet.is_up_to_date():
1684 self.wallet.set_up_to_date(False)
1685 self.was_updated = True
1687 if self.was_updated:
1688 self.network.trigger_callback('updated')
1689 self.was_updated = False
1693 r = self.queue.get(block=True, timeout=1)
1698 #if interface != self.network.interface:
1704 # 3. handle response
1705 method = r['method']
1706 params = r['params']
1707 result = r.get('result')
1708 error = r.get('error')
1713 if method == 'blockchain.address.subscribe':
1715 if self.wallet.get_status(self.wallet.get_history(addr)) != result:
1716 if requested_histories.get(addr) is None:
1717 self.network.send([('blockchain.address.get_history', [addr])], lambda i,r:self.queue.put(r))
1718 requested_histories[addr] = result
1720 elif method == 'blockchain.address.get_history':
1722 print_error("receiving history", addr, result)
1724 assert requested_histories.pop(addr) == '*'
1725 self.wallet.receive_history_callback(addr, result)
1728 # check that txids are unique
1731 tx_hash = item['tx_hash']
1732 if tx_hash not in txids:
1733 txids.append(tx_hash)
1734 hist.append( (tx_hash, item['height']) )
1736 if len(hist) != len(result):
1737 raise Exception("error: server sent history with non-unique txid", result)
1739 # check that the status corresponds to what was announced
1740 rs = requested_histories.pop(addr)
1741 if self.wallet.get_status(hist) != rs:
1742 raise Exception("error: status mismatch: %s"%addr)
1744 # store received history
1745 self.wallet.receive_history_callback(addr, hist)
1747 # request transactions that we don't have
1748 for tx_hash, tx_height in hist:
1749 if self.wallet.transactions.get(tx_hash) is None:
1750 if (tx_hash, tx_height) not in requested_tx and (tx_hash, tx_height) not in missing_tx:
1751 missing_tx.append( (tx_hash, tx_height) )
1753 elif method == 'blockchain.transaction.get':
1755 tx_height = params[1]
1756 assert tx_hash == hash_encode(Hash(result.decode('hex')))
1757 tx = Transaction(result)
1758 self.wallet.receive_tx_callback(tx_hash, tx, tx_height)
1759 self.was_updated = True
1760 requested_tx.remove( (tx_hash, tx_height) )
1761 print_error("received tx:", tx_hash, len(tx.raw))
1764 print_error("Error: Unknown message:" + method + ", " + repr(params) + ", " + repr(result) )
1766 if self.was_updated and not requested_tx:
1767 self.network.trigger_callback('updated')
1768 # Updated gets called too many times from other places as well; if we use that signal we get the notification three times
1769 self.network.trigger_callback("new_transaction")
1770 self.was_updated = False