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 COINBASE_MATURITY = 100
44 EncodeAES = lambda secret, s: base64.b64encode(aes.encryptData(secret,s))
45 DecodeAES = lambda secret, e: aes.decryptData(secret, base64.b64decode(e))
47 def pw_encode(s, password):
49 secret = Hash(password)
50 return EncodeAES(secret, s)
54 def pw_decode(s, password):
55 if password is not None:
56 secret = Hash(password)
58 d = DecodeAES(secret, s)
60 raise Exception('Invalid password')
74 def __init__(self, config):
75 self.lock = threading.Lock()
78 self.file_exists = False
79 self.path = self.init_path(config)
80 print_error( "wallet path", self.path )
85 def init_path(self, config):
86 """Set the path of the wallet."""
88 # command line -w option
89 path = config.get('wallet_path')
94 path = config.get('default_wallet_path')
99 dirpath = os.path.join(config.path, "wallets")
100 if not os.path.exists(dirpath):
103 new_path = os.path.join(config.path, "wallets", "default_wallet")
105 # default path in pre 1.9 versions
106 old_path = os.path.join(config.path, "electrum.dat")
107 if os.path.exists(old_path) and not os.path.exists(new_path):
108 os.rename(old_path, new_path)
113 def read(self, path):
114 """Read the contents of the wallet file."""
116 with open(self.path, "r") as f:
121 d = ast.literal_eval( data ) #parse raw data from reading wallet file
123 raise IOError("Cannot read wallet file.")
126 self.file_exists = True
129 def get(self, key, default=None):
130 v = self.data.get(key)
135 def put(self, key, value, save = True):
138 if value is not None:
139 self.data[key] = value
147 f = open(self.path,"w")
150 if 'ANDROID_DATA' not in os.environ:
152 os.chmod(self.path,stat.S_IREAD | stat.S_IWRITE)
160 def __init__(self, storage):
162 self.storage = storage
163 self.electrum_version = ELECTRUM_VERSION
164 self.gap_limit_for_change = 3 # constant
167 self.seed_version = storage.get('seed_version', NEW_SEED_VERSION)
169 self.gap_limit = storage.get('gap_limit', 5)
170 self.use_change = storage.get('use_change',True)
171 self.use_encryption = storage.get('use_encryption', False)
172 self.seed = storage.get('seed', '') # encrypted
173 self.labels = storage.get('labels', {})
174 self.frozen_addresses = storage.get('frozen_addresses',[])
175 self.addressbook = storage.get('contacts', [])
177 self.imported_keys = storage.get('imported_keys',{})
178 self.history = storage.get('addr_history',{}) # address -> list(txid, height)
180 self.fee = int(storage.get('fee_per_kb',20000))
182 self.master_public_keys = storage.get('master_public_keys',{})
183 self.master_private_keys = storage.get('master_private_keys', {})
185 self.next_addresses = storage.get('next_addresses',{})
188 # This attribute is set when wallet.start_threads is called.
189 self.synchronizer = None
193 self.transactions = {}
194 tx_list = self.storage.get('transactions',{})
195 for k,v in tx_list.items():
199 print_msg("Warning: Cannot deserialize transactions. skipping")
202 self.add_extra_addresses(tx)
203 self.transactions[k] = tx
205 for h,tx in self.transactions.items():
206 if not self.check_new_tx(h, tx):
207 print_error("removing unreferenced tx", h)
208 self.transactions.pop(h)
212 self.prevout_values = {} # my own transaction outputs
213 self.spent_outputs = []
218 # there is a difference between wallet.up_to_date and interface.is_up_to_date()
219 # interface.is_up_to_date() returns true when all requests have been answered and processed
220 # wallet.up_to_date is true when the wallet is synchronized (stronger requirement)
222 self.up_to_date = False
223 self.lock = threading.Lock()
224 self.transaction_lock = threading.Lock()
225 self.tx_event = threading.Event()
227 for tx_hash, tx in self.transactions.items():
228 self.update_tx_outputs(tx_hash)
231 def add_extra_addresses(self, tx):
233 # find the address corresponding to pay-to-pubkey inputs
234 tx.add_extra_addresses(self.transactions)
235 for o in tx.d.get('outputs'):
236 if o.get('is_pubkey'):
237 for tx2 in self.transactions.values():
238 tx2.add_extra_addresses({h:tx})
243 def set_up_to_date(self,b):
244 with self.lock: self.up_to_date = b
247 def is_up_to_date(self):
248 with self.lock: return self.up_to_date
252 self.up_to_date = False
253 while not self.is_up_to_date():
257 def import_key(self, sec, password):
259 seed = self.get_seed(password)
261 address = address_from_private_key(sec)
263 raise Exception('Invalid private key')
265 if self.is_mine(address):
266 raise Exception('Address already in wallet')
268 # store the originally requested keypair into the imported keys table
269 self.imported_keys[address] = pw_encode(sec, password )
270 self.storage.put('imported_keys', self.imported_keys, True)
271 if self.synchronizer:
272 self.synchronizer.subscribe_to_addresses([address])
275 def delete_imported_key(self, addr):
276 if addr in self.imported_keys:
277 self.imported_keys.pop(addr)
278 self.storage.put('imported_keys', self.imported_keys, True)
282 import mnemonic, ecdsa
283 entropy = ecdsa.util.randrange( pow(2,160) )
286 ss = "%040x"%(entropy+nonce)
287 s = hashlib.sha256(ss.decode('hex')).digest().encode('hex')
288 # we keep only 13 words, that's approximately 139 bits of entropy
289 words = mnemonic.mn_encode(s)[0:13]
290 seed = ' '.join(words)
292 break # this will remove 8 bits of entropy
298 def init_seed(self, seed):
299 import mnemonic, unicodedata
302 raise Exception("a seed exists")
304 self.seed_version = NEW_SEED_VERSION
307 self.seed = self.make_seed()
310 self.seed = unicodedata.normalize('NFC', unicode(seed.strip()))
314 def save_seed(self, password):
316 self.seed = pw_encode( self.seed, password)
317 self.use_encryption = True
318 self.storage.put('seed', self.seed, True)
319 self.storage.put('seed_version', self.seed_version, True)
320 self.storage.put('use_encryption', self.use_encryption,True)
321 self.create_accounts(password)
324 def create_watching_only_wallet(self, K0, c0):
326 self.master_public_keys = {
327 "m/0'/": (c0, K0, cK0),
329 self.storage.put('master_public_keys', self.master_public_keys, True)
330 self.storage.put('seed_version', self.seed_version, True)
331 self.create_account('1of1','Main account')
334 def create_accounts(self, password):
335 seed = pw_decode(self.seed, password)
336 # create default account
337 self.create_master_keys('1of1', password)
338 self.create_account('1of1','Main account')
341 def create_master_keys(self, account_type, password):
342 master_k, master_c, master_K, master_cK = bip32_init(self.get_seed(password))
343 if account_type == '1of1':
344 k0, c0, K0, cK0 = bip32_private_derivation(master_k, master_c, "m/", "m/0'/")
345 self.master_public_keys["m/0'/"] = (c0, K0, cK0)
346 self.master_private_keys["m/0'/"] = pw_encode(k0, password)
347 elif account_type == '2of2':
348 k1, c1, K1, cK1 = bip32_private_derivation(master_k, master_c, "m/", "m/1'/")
349 k2, c2, K2, cK2 = bip32_private_derivation(master_k, master_c, "m/", "m/2'/")
350 self.master_public_keys["m/1'/"] = (c1, K1, cK1)
351 self.master_public_keys["m/2'/"] = (c2, K2, cK2)
352 self.master_private_keys["m/1'/"] = pw_encode(k1, password)
353 self.master_private_keys["m/2'/"] = pw_encode(k2, password)
354 elif account_type == '2of3':
355 k3, c3, K3, cK3 = bip32_private_derivation(master_k, master_c, "m/", "m/3'/")
356 k4, c4, K4, cK4 = bip32_private_derivation(master_k, master_c, "m/", "m/4'/")
357 k5, c5, K5, cK5 = bip32_private_derivation(master_k, master_c, "m/", "m/5'/")
358 self.master_public_keys["m/3'/"] = (c3, K3, cK3)
359 self.master_public_keys["m/4'/"] = (c4, K4, cK4)
360 self.master_public_keys["m/5'/"] = (c5, K5, cK5)
361 self.master_private_keys["m/3'/"] = pw_encode(k3, password)
362 self.master_private_keys["m/4'/"] = pw_encode(k4, password)
363 self.master_private_keys["m/5'/"] = pw_encode(k5, password)
365 self.storage.put('master_public_keys', self.master_public_keys, True)
366 self.storage.put('master_private_keys', self.master_private_keys, True)
368 def has_master_public_keys(self, account_type):
369 if account_type == '1of1':
370 return "m/0'/" in self.master_public_keys
371 elif account_type == '2of2':
372 return set(["m/1'/", "m/2'/"]) <= set(self.master_public_keys.keys())
373 elif account_type == '2of3':
374 return set(["m/3'/", "m/4'/", "m/5'/"]) <= set(self.master_public_keys.keys())
376 def find_root_by_master_key(self, c, K):
377 for key, v in self.master_public_keys.items():
378 if key == "m/":continue
380 if (c == cc) and (K == KK):
383 def deseed_root(self, seed, password):
384 # for safety, we ask the user to enter their seed
385 assert seed == self.get_seed(password)
387 self.storage.put('seed', '', True)
390 def deseed_branch(self, k):
391 # check that parent has no seed
392 # assert self.seed == ''
393 self.master_private_keys.pop(k)
394 self.storage.put('master_private_keys', self.master_private_keys, True)
397 def is_watching_only(self):
398 return (self.seed == '') and (self.master_private_keys == {})
402 def account_id(self, account_type, i):
403 if account_type == '1of1':
405 elif account_type == '2of2':
406 return "m/1'/%d & m/2'/%d"%(i,i)
407 elif account_type == '2of3':
408 return "m/3'/%d & m/4'/%d & m/5'/%d"%(i,i,i)
410 raise Exception('unknown account type')
413 def num_accounts(self, account_type):
414 keys = self.accounts.keys()
417 account_id = self.account_id(account_type, i)
418 if account_id not in keys: break
423 def new_account_address(self, account_type = '1of1'):
424 i = self.num_accounts(account_type)
425 k = self.account_id(account_type,i)
427 addr = self.next_addresses.get(k)
429 account_id, account = self.next_account(account_type)
430 addr = account.first_address()
431 self.next_addresses[k] = addr
432 self.storage.put('next_addresses',self.next_addresses)
437 def next_account(self, account_type = '1of1'):
439 i = self.num_accounts(account_type)
440 account_id = self.account_id(account_type,i)
442 if account_type is '1of1':
443 master_c0, master_K0, _ = self.master_public_keys["m/0'/"]
444 c0, K0, cK0 = bip32_public_derivation(master_c0.decode('hex'), master_K0.decode('hex'), "m/0'/", "m/0'/%d"%i)
445 account = BIP32_Account({ 'c':c0, 'K':K0, 'cK':cK0 })
447 elif account_type == '2of2':
448 master_c1, master_K1, _ = self.master_public_keys["m/1'/"]
449 c1, K1, cK1 = bip32_public_derivation(master_c1.decode('hex'), master_K1.decode('hex'), "m/1'/", "m/1'/%d"%i)
450 master_c2, master_K2, _ = self.master_public_keys["m/2'/"]
451 c2, K2, cK2 = bip32_public_derivation(master_c2.decode('hex'), master_K2.decode('hex'), "m/2'/", "m/2'/%d"%i)
452 account = BIP32_Account_2of2({ 'c':c1, 'K':K1, 'cK':cK1, 'c2':c2, 'K2':K2, 'cK2':cK2 })
454 elif account_type == '2of3':
455 master_c3, master_K3, _ = self.master_public_keys["m/3'/"]
456 c3, K3, cK3 = bip32_public_derivation(master_c3.decode('hex'), master_K3.decode('hex'), "m/3'/", "m/3'/%d"%i)
457 master_c4, master_K4, _ = self.master_public_keys["m/4'/"]
458 c4, K4, cK4 = bip32_public_derivation(master_c4.decode('hex'), master_K4.decode('hex'), "m/4'/", "m/4'/%d"%i)
459 master_c5, master_K5, _ = self.master_public_keys["m/5'/"]
460 c5, K5, cK5 = bip32_public_derivation(master_c5.decode('hex'), master_K5.decode('hex'), "m/5'/", "m/5'/%d"%i)
461 account = BIP32_Account_2of3({ 'c':c3, 'K':K3, 'cK':cK3, 'c2':c4, 'K2':K4, 'cK2':cK4, 'c3':c5, 'K3':K5, 'cK3':cK5 })
463 return account_id, account
466 def set_label(self, name, text = None):
468 old_text = self.labels.get(name)
471 self.labels[name] = text
475 self.labels.pop(name)
479 self.storage.put('labels', self.labels, True)
481 run_hook('set_label', name, text, changed)
486 def create_account(self, account_type = '1of1', name = None):
487 k, account = self.next_account(account_type)
488 if k in self.pending_accounts:
489 self.pending_accounts.pop(k)
490 self.storage.put('pending_accounts', self.pending_accounts)
492 self.accounts[k] = account
495 self.set_label(k, name)
498 def save_accounts(self):
500 for k, v in self.accounts.items():
502 self.storage.put('accounts', d, True)
506 def load_accounts(self):
507 d = self.storage.get('accounts', {})
509 for k, v in d.items():
511 v['mpk'] = self.storage.get('master_public_key')
512 self.accounts[k] = OldAccount(v)
514 self.accounts[k] = BIP32_Account_2of2(v)
516 self.accounts[k] = BIP32_Account(v)
518 self.pending_accounts = self.storage.get('pending_accounts',{})
521 def delete_pending_account(self, k):
522 self.pending_accounts.pop(k)
523 self.storage.put('pending_accounts', self.pending_accounts)
525 def account_is_pending(self, k):
526 return k in self.pending_accounts
528 def create_pending_account(self, acct_type, name):
529 k, addr = self.new_account_address(acct_type)
530 self.set_label(k, name)
531 self.pending_accounts[k] = addr
532 self.storage.put('pending_accounts', self.pending_accounts)
534 def get_pending_accounts(self):
535 return self.pending_accounts.items()
538 def addresses(self, include_change = True, _next=True):
539 o = self.get_account_addresses(-1, include_change)
540 for a in self.accounts.keys():
541 o += self.get_account_addresses(a, include_change)
544 for addr in self.next_addresses.values():
550 def is_mine(self, address):
551 return address in self.addresses(True)
554 def is_change(self, address):
555 if not self.is_mine(address): return False
556 if address in self.imported_keys.keys(): return False
557 acct, s = self.get_address_index(address)
558 if s is None: return False
561 def get_master_public_key(self):
562 c, K, cK = self.storage.get("master_public_keys")["m/0'/"]
565 def get_master_private_key(self, account, password):
566 k = self.master_private_keys.get(account)
568 master_k = pw_decode( k, password)
569 master_c, master_K, master_Kc = self.master_public_keys[account]
571 K, Kc = get_pubkeys_from_secret(master_k.decode('hex'))
572 assert K.encode('hex') == master_K
574 raise Exception("Invalid password")
578 def get_address_index(self, address):
579 if address in self.imported_keys.keys():
582 for account in self.accounts.keys():
583 for for_change in [0,1]:
584 addresses = self.accounts[account].get_addresses(for_change)
585 for addr in addresses:
587 return account, (for_change, addresses.index(addr))
589 for k,v in self.next_addresses.items():
593 raise Exception("Address not found", address)
596 def get_roots(self, account):
598 for a in account.split('&'):
600 m = re.match("(m/\d+'/)(\d+)", s)
601 roots.append( m.group(1) )
604 def is_seeded(self, account):
605 if type(account) is int:
606 return self.seed is not None
608 for root in self.get_roots(account):
609 if root not in self.master_private_keys.keys():
613 def rebase_sequence(self, account, sequence):
616 for a in account.split('&'):
618 m = re.match("(m/\d+'/)(\d+)", s)
620 num = int(m.group(2))
621 dd.append( (root, [num,c,i] ) )
625 def get_keyID(self, account, sequence):
628 mpk = self.storage.get('master_public_key')
629 return 'old(%s,%d,%d)'%(mpk,a,b)
631 rs = self.rebase_sequence(account, sequence)
633 for root, public_sequence in rs:
634 c, K, _ = self.master_public_keys[root]
635 s = '/' + '/'.join( map(lambda x:str(x), public_sequence) )
636 dd.append( 'bip32(%s,%s,%s)'%(c,K, s) )
640 def get_seed(self, password):
641 s = pw_decode(self.seed, password)
642 seed = mnemonic_to_seed(s,'').encode('hex')
646 def get_mnemonic(self, password):
647 return pw_decode(self.seed, password)
650 def get_private_key(self, address, password):
651 if self.is_watching_only():
654 # first check the provided password
655 seed = self.get_seed(password)
658 if address in self.imported_keys.keys():
659 out.append( pw_decode( self.imported_keys[address], password ) )
661 account, sequence = self.get_address_index(address)
663 pk = self.accounts[account].get_private_key(seed, sequence)
667 # assert address == self.accounts[account].get_address(*sequence)
668 rs = self.rebase_sequence( account, sequence)
669 for root, public_sequence in rs:
671 if root not in self.master_private_keys.keys(): continue
672 master_k = self.get_master_private_key(root, password)
673 master_c, _, _ = self.master_public_keys[root]
674 pk = bip32_private_key( public_sequence, master_k.decode('hex'), master_c.decode('hex'))
680 def add_keypairs_from_wallet(self, tx, keypairs, password):
681 for txin in tx.inputs:
682 address = txin['address']
683 if not self.is_mine(address):
685 private_keys = self.get_private_key(address, password)
686 for sec in private_keys:
687 pubkey = public_key_from_private_key(sec)
688 keypairs[ pubkey ] = sec
689 if address in self.imported_keys.keys():
690 txin['redeemPubkey'] = pubkey
693 def add_keypairs_from_KeyID(self, tx, keypairs, password):
694 # first check the provided password
695 seed = self.get_seed(password)
697 for txin in tx.inputs:
698 keyid = txin.get('KeyID')
701 for s in keyid.split('&'):
702 m = re.match("bip32\(([0-9a-f]+),([0-9a-f]+),(/\d+/\d+/\d+)", s)
706 sequence = m.group(3)
707 root = self.find_root_by_master_key(c,K)
708 if not root: continue
709 sequence = map(lambda x:int(x), sequence.strip('/').split('/'))
710 root = root + '%d'%sequence[0]
711 sequence = sequence[1:]
712 roots.append((root,sequence))
714 account_id = " & ".join( map(lambda x:x[0], roots) )
715 account = self.accounts.get(account_id)
716 if not account: continue
717 addr = account.get_address(*sequence)
718 txin['address'] = addr # fixme: side effect
719 pk = self.get_private_key(addr, password)
721 pubkey = public_key_from_private_key(sec)
722 keypairs[pubkey] = sec
726 def signrawtransaction(self, tx, input_info, private_keys, password):
728 # check that the password is correct
729 seed = self.get_seed(password)
732 tx.add_input_info(input_info)
734 # add redeem script for coins that are in the wallet
735 # FIXME: add redeemPubkey too!
736 unspent_coins = self.get_unspent_coins()
737 for txin in tx.inputs:
738 for item in unspent_coins:
739 if txin['prevout_hash'] == item['prevout_hash'] and txin['prevout_n'] == item['prevout_n']:
740 print_error( "tx input is in unspent coins" )
741 txin['scriptPubKey'] = item['scriptPubKey']
742 account, sequence = self.get_address_index(item['address'])
744 txin['redeemScript'] = self.accounts[account].redeem_script(sequence)
745 print_error("added redeemScript", txin['redeemScript'])
749 # build a list of public/private keys
752 # add private keys from parameter
753 for sec in private_keys:
754 pubkey = public_key_from_private_key(sec)
755 keypairs[ pubkey ] = sec
757 # add private_keys from KeyID
758 self.add_keypairs_from_KeyID(tx, keypairs, password)
760 # add private keys from wallet
761 self.add_keypairs_from_wallet(tx, keypairs, password)
762 self.sign_transaction(tx, keypairs)
765 def sign_message(self, address, message, password):
766 keys = self.get_private_key(address, password)
767 assert len(keys) == 1
769 key = regenerate_key(sec)
770 compressed = is_compressed(sec)
771 return key.sign_message(message, compressed, address)
774 def change_gap_limit(self, value):
775 if value >= self.gap_limit:
776 self.gap_limit = value
777 self.storage.put('gap_limit', self.gap_limit, True)
778 #self.interface.poke('synchronizer')
781 elif value >= self.min_acceptable_gap():
782 for key, account in self.accounts.items():
783 addresses = account[0]
784 k = self.num_unused_trailing_addresses(addresses)
785 n = len(addresses) - k + value
786 addresses = addresses[0:n]
787 self.accounts[key][0] = addresses
789 self.gap_limit = value
790 self.storage.put('gap_limit', self.gap_limit, True)
796 def num_unused_trailing_addresses(self, addresses):
798 for a in addresses[::-1]:
799 if self.history.get(a):break
803 def min_acceptable_gap(self):
804 # fixme: this assumes wallet is synchronized
808 for account in self.accounts.values():
809 addresses = account.get_addresses(0)
810 k = self.num_unused_trailing_addresses(addresses)
811 for a in addresses[0:-k]:
812 if self.history.get(a):
816 if n > nmax: nmax = n
820 def address_is_old(self, address):
822 h = self.history.get(address, [])
825 for tx_hash, tx_height in h:
829 tx_age = self.verifier.blockchain.height() - tx_height + 1
835 def synchronize_sequence(self, account, for_change):
836 limit = self.gap_limit_for_change if for_change else self.gap_limit
839 addresses = account.get_addresses(for_change)
840 if len(addresses) < limit:
841 address = account.create_new_address(for_change)
842 self.history[address] = []
843 new_addresses.append( address )
846 if map( lambda a: self.address_is_old(a), addresses[-limit:] ) == limit*[False]:
849 address = account.create_new_address(for_change)
850 self.history[address] = []
851 new_addresses.append( address )
857 def create_pending_accounts(self):
858 for account_type in ['1of1','2of2','2of3']:
859 if not self.has_master_public_keys(account_type):
861 k, a = self.new_account_address(account_type)
862 if self.address_is_old(a):
863 print_error( "creating account", a )
864 self.create_account(account_type)
865 self.next_addresses.pop(k)
868 def synchronize_account(self, account):
870 new += self.synchronize_sequence(account, 0)
871 new += self.synchronize_sequence(account, 1)
875 def synchronize(self):
876 if self.master_public_keys:
877 self.create_pending_accounts()
879 for account in self.accounts.values():
880 new += self.synchronize_account(account)
883 self.storage.put('addr_history', self.history, True)
888 return self.history.values() != [[]] * len(self.history)
891 def add_contact(self, address, label=None):
892 self.addressbook.append(address)
893 self.storage.put('contacts', self.addressbook, True)
895 self.set_label(address, label)
898 def delete_contact(self, addr):
899 if addr in self.addressbook:
900 self.addressbook.remove(addr)
901 self.storage.put('addressbook', self.addressbook, True)
904 def fill_addressbook(self):
905 for tx_hash, tx in self.transactions.items():
906 is_relevant, is_send, _, _ = self.get_tx_value(tx)
908 for addr, v in tx.outputs:
909 if not self.is_mine(addr) and addr not in self.addressbook:
910 self.addressbook.append(addr)
912 # self.update_tx_labels()
914 def get_num_tx(self, address):
916 for tx in self.transactions.values():
917 if address in map(lambda x:x[0], tx.outputs): n += 1
921 def get_address_flags(self, addr):
922 flags = "C" if self.is_change(addr) else "I" if addr in self.imported_keys.keys() else "-"
923 flags += "F" if addr in self.frozen_addresses else "-"
927 def get_tx_value(self, tx, account=None):
928 domain = self.get_account_addresses(account)
929 return tx.get_value(domain, self.prevout_values)
932 def update_tx_outputs(self, tx_hash):
933 tx = self.transactions.get(tx_hash)
935 for i, (addr, value) in enumerate(tx.outputs):
936 key = tx_hash+ ':%d'%i
937 self.prevout_values[key] = value
939 for item in tx.inputs:
940 if self.is_mine(item.get('address')):
941 key = item['prevout_hash'] + ':%d'%item['prevout_n']
942 self.spent_outputs.append(key)
945 def get_addr_balance(self, address):
946 assert self.is_mine(address)
947 h = self.history.get(address,[])
948 if h == ['*']: return 0,0
950 received_coins = [] # list of coins received at address
952 for tx_hash, tx_height in h:
953 tx = self.transactions.get(tx_hash)
956 for i, (addr, value) in enumerate(tx.outputs):
958 key = tx_hash + ':%d'%i
959 received_coins.append(key)
961 for tx_hash, tx_height in h:
962 tx = self.transactions.get(tx_hash)
966 for item in tx.inputs:
967 addr = item.get('address')
969 key = item['prevout_hash'] + ':%d'%item['prevout_n']
970 value = self.prevout_values.get( key )
971 if key in received_coins:
974 for i, (addr, value) in enumerate(tx.outputs):
975 key = tx_hash + ':%d'%i
986 def get_account_name(self, k):
987 default = "Unnamed account"
988 m = re.match("m/0'/(\d+)", k)
992 default = "Main account"
994 default = "Account %s"%num
996 m = re.match("m/1'/(\d+) & m/2'/(\d+)", k)
999 default = "2of2 account %s"%num
1000 name = self.labels.get(k, default)
1004 def get_account_names(self):
1006 for k, account in self.accounts.items():
1007 accounts[k] = self.get_account_name(k)
1008 if self.imported_keys:
1009 accounts[-1] = 'Imported keys'
1013 def get_account_addresses(self, a, include_change=True):
1015 o = self.addresses(True)
1017 o = self.imported_keys.keys()
1019 ac = self.accounts[a]
1020 o = ac.get_addresses(0)
1021 if include_change: o += ac.get_addresses(1)
1024 def get_imported_balance(self):
1025 return self.get_balance(self.imported_keys.keys())
1027 def get_account_balance(self, account):
1028 return self.get_balance(self.get_account_addresses(account))
1030 def get_frozen_balance(self):
1031 return self.get_balance(self.frozen_addresses)
1033 def get_balance(self, domain=None):
1034 if domain is None: domain = self.addresses(True)
1037 c, u = self.get_addr_balance(addr)
1043 def get_unspent_coins(self, domain=None):
1045 if domain is None: domain = self.addresses(True)
1047 h = self.history.get(addr, [])
1048 if h == ['*']: continue
1049 for tx_hash, tx_height in h:
1050 tx = self.transactions.get(tx_hash)
1051 if tx is None: raise Exception("Wallet not synchronized")
1052 is_coinbase = tx.inputs[0].get('prevout_hash') == '0'*64
1053 for o in tx.d.get('outputs'):
1055 if output.get('address') != addr: continue
1056 key = tx_hash + ":%d" % output.get('prevout_n')
1057 if key in self.spent_outputs: continue
1058 output['prevout_hash'] = tx_hash
1059 output['height'] = tx_height
1060 output['coinbase'] = is_coinbase
1061 coins.append((tx_height, output))
1065 coins = sorted(coins)
1066 if coins[-1][0] != 0:
1067 while coins[0][0] == 0:
1068 coins = coins[1:] + [ coins[0] ]
1069 return [x[1] for x in coins]
1072 def choose_tx_inputs( self, amount, fixed_fee, domain = None ):
1073 """ todo: minimize tx size """
1075 fee = self.fee if fixed_fee is None else fixed_fee
1077 domain = self.addresses(True)
1079 for i in self.frozen_addresses:
1080 if i in domain: domain.remove(i)
1082 coins = self.get_unspent_coins(domain)
1086 if item.get('coinbase') and item.get('height') + COINBASE_MATURITY > self.network.blockchain.height:
1088 addr = item.get('address')
1089 v = item.get('value')
1092 fee = self.estimated_fee(inputs) if fixed_fee is None else fixed_fee
1093 if total >= amount + fee: break
1097 return inputs, total, fee
1100 def set_fee(self, fee):
1103 self.storage.put('fee_per_kb', self.fee, True)
1105 def estimated_fee(self, inputs):
1106 estimated_size = len(inputs) * 180 + 80 # this assumes non-compressed keys
1107 fee = self.fee * int(math.ceil(estimated_size/1000.))
1111 def add_tx_change( self, inputs, outputs, amount, fee, total, change_addr=None):
1112 "add change to a transaction"
1113 change_amount = total - ( amount + fee )
1114 if change_amount > DUST_THRESHOLD:
1117 # send change to one of the accounts involved in the tx
1118 address = inputs[0].get('address')
1119 account, _ = self.get_address_index(address)
1121 if not self.use_change or account == -1:
1122 change_addr = inputs[-1]['address']
1124 change_addr = self.accounts[account].get_addresses(1)[-self.gap_limit_for_change]
1126 # Insert the change output at a random position in the outputs
1127 posn = random.randint(0, len(outputs))
1128 outputs[posn:posn] = [( change_addr, change_amount)]
1132 def get_history(self, address):
1134 return self.history.get(address)
1137 def get_status(self, h):
1138 if not h: return None
1139 if h == ['*']: return '*'
1141 for tx_hash, height in h:
1142 status += tx_hash + ':%d:' % height
1143 return hashlib.sha256( status ).digest().encode('hex')
1146 def receive_tx_callback(self, tx_hash, tx, tx_height):
1148 with self.transaction_lock:
1149 self.add_extra_addresses(tx)
1150 if not self.check_new_tx(tx_hash, tx):
1151 # may happen due to pruning
1152 print_error("received transaction that is no longer referenced in history", tx_hash)
1154 self.transactions[tx_hash] = tx
1155 self.network.interface.pending_transactions_for_notifications.append(tx)
1156 self.save_transactions()
1157 if self.verifier and tx_height>0:
1158 self.verifier.add(tx_hash, tx_height)
1159 self.update_tx_outputs(tx_hash)
1162 def save_transactions(self):
1164 for k,v in self.transactions.items():
1166 self.storage.put('transactions', tx, True)
1168 def receive_history_callback(self, addr, hist):
1170 if not self.check_new_history(addr, hist):
1171 raise Exception("error: received history for %s is not consistent with known transactions"%addr)
1174 self.history[addr] = hist
1175 self.storage.put('addr_history', self.history, True)
1178 for tx_hash, tx_height in hist:
1180 # add it in case it was previously unconfirmed
1181 if self.verifier: self.verifier.add(tx_hash, tx_height)
1184 def get_tx_history(self, account=None):
1185 if not self.verifier:
1188 with self.transaction_lock:
1189 history = self.transactions.items()
1190 history.sort(key = lambda x: self.verifier.get_txpos(x[0]))
1194 for tx_hash, tx in history:
1195 is_relevant, is_mine, v, fee = self.get_tx_value(tx, account)
1196 if v is not None: balance += v
1198 c, u = self.get_account_balance(account)
1201 result.append( ('', 1000, 0, c+u-balance, None, c+u-balance, None ) )
1203 balance = c + u - balance
1204 for tx_hash, tx in history:
1205 is_relevant, is_mine, value, fee = self.get_tx_value(tx, account)
1208 if value is not None:
1211 conf, timestamp = self.verifier.get_confirmations(tx_hash) if self.verifier else (None, None)
1212 result.append( (tx_hash, conf, is_mine, value, fee, balance, timestamp) )
1217 def get_label(self, tx_hash):
1218 label = self.labels.get(tx_hash)
1219 is_default = (label == '') or (label is None)
1220 if is_default: label = self.get_default_label(tx_hash)
1221 return label, is_default
1224 def get_default_label(self, tx_hash):
1225 tx = self.transactions.get(tx_hash)
1228 is_relevant, is_mine, _, _ = self.get_tx_value(tx)
1230 for o in tx.outputs:
1232 if not self.is_mine(o_addr):
1234 default_label = self.labels[o_addr]
1236 default_label = o_addr
1239 default_label = '(internal)'
1241 for o in tx.outputs:
1243 if self.is_mine(o_addr) and not self.is_change(o_addr):
1246 for o in tx.outputs:
1248 if self.is_mine(o_addr):
1254 dest_label = self.labels.get(o_addr)
1256 default_label = self.labels[o_addr]
1258 default_label = o_addr
1260 return default_label
1263 def make_unsigned_transaction(self, outputs, fee=None, change_addr=None, domain=None ):
1264 for address, x in outputs:
1265 assert is_valid(address)
1266 amount = sum( map(lambda x:x[1], outputs) )
1267 inputs, total, fee = self.choose_tx_inputs( amount, fee, domain )
1269 raise ValueError("Not enough funds")
1270 self.add_input_info(inputs)
1271 outputs = self.add_tx_change(inputs, outputs, amount, fee, total, change_addr)
1272 return Transaction.from_io(inputs, outputs)
1275 def mktx(self, outputs, password, fee=None, change_addr=None, domain= None ):
1276 tx = self.make_unsigned_transaction(outputs, fee, change_addr, domain)
1278 self.add_keypairs_from_wallet(tx, keypairs, password)
1280 self.sign_transaction(tx, keypairs)
1284 def add_input_info(self, inputs):
1286 address = txin['address']
1287 if address in self.imported_keys.keys():
1289 account, sequence = self.get_address_index(address)
1290 txin['KeyID'] = self.get_keyID(account, sequence)
1291 redeemScript = self.accounts[account].redeem_script(sequence)
1293 txin['redeemScript'] = redeemScript
1295 txin['redeemPubkey'] = self.accounts[account].get_pubkey(*sequence)
1298 def sign_transaction(self, tx, keypairs):
1300 run_hook('sign_transaction', tx)
1303 def sendtx(self, tx):
1305 h = self.send_tx(tx)
1306 self.tx_event.wait()
1307 return self.receive_tx(h, tx)
1309 def send_tx(self, tx):
1311 self.tx_event.clear()
1312 self.network.interface.send([('blockchain.transaction.broadcast', [str(tx)])], self.on_broadcast)
1315 def on_broadcast(self, i, r):
1316 self.tx_result = r.get('result')
1319 def receive_tx(self, tx_hash, tx):
1320 out = self.tx_result
1322 return False, "error: " + out
1323 run_hook('receive_tx', tx, self)
1328 def update_password(self, old_password, new_password):
1329 if new_password == '': new_password = None
1330 decoded = self.get_seed(old_password)
1331 self.seed = pw_encode( decoded, new_password)
1332 self.storage.put('seed', self.seed, True)
1333 self.use_encryption = (new_password != None)
1334 self.storage.put('use_encryption', self.use_encryption,True)
1335 for k in self.imported_keys.keys():
1336 a = self.imported_keys[k]
1337 b = pw_decode(a, old_password)
1338 c = pw_encode(b, new_password)
1339 self.imported_keys[k] = c
1340 self.storage.put('imported_keys', self.imported_keys, True)
1342 for k, v in self.master_private_keys.items():
1343 b = pw_decode(v, old_password)
1344 c = pw_encode(b, new_password)
1345 self.master_private_keys[k] = c
1346 self.storage.put('master_private_keys', self.master_private_keys, True)
1349 def freeze(self,addr):
1350 if self.is_mine(addr) and addr not in self.frozen_addresses:
1351 self.frozen_addresses.append(addr)
1352 self.storage.put('frozen_addresses', self.frozen_addresses, True)
1357 def unfreeze(self,addr):
1358 if self.is_mine(addr) and addr in self.frozen_addresses:
1359 self.frozen_addresses.remove(addr)
1360 self.storage.put('frozen_addresses', self.frozen_addresses, True)
1366 def set_verifier(self, verifier):
1367 self.verifier = verifier
1369 # review transactions that are in the history
1370 for addr, hist in self.history.items():
1371 if hist == ['*']: continue
1372 for tx_hash, tx_height in hist:
1374 # add it in case it was previously unconfirmed
1375 self.verifier.add(tx_hash, tx_height)
1378 # if we are on a pruning server, remove unverified transactions
1379 vr = self.verifier.transactions.keys() + self.verifier.verified_tx.keys()
1380 for tx_hash in self.transactions.keys():
1381 if tx_hash not in vr:
1382 self.transactions.pop(tx_hash)
1386 def check_new_history(self, addr, hist):
1388 # check that all tx in hist are relevant
1390 for tx_hash, height in hist:
1391 tx = self.transactions.get(tx_hash)
1393 if not tx.has_address(addr):
1396 # check that we are not "orphaning" a transaction
1397 old_hist = self.history.get(addr,[])
1398 if old_hist == ['*']: return True
1400 for tx_hash, height in old_hist:
1401 if tx_hash in map(lambda x:x[0], hist): continue
1403 for _addr, _hist in self.history.items():
1404 if _addr == addr: continue
1405 if _hist == ['*']: continue
1406 _tx_hist = map(lambda x:x[0], _hist)
1407 if tx_hash in _tx_hist:
1412 tx = self.transactions.get(tx_hash)
1413 # tx might not be there
1417 if self.verifier.get_height(tx_hash):
1420 print_error("new history is orphaning transaction:", tx_hash)
1421 # check that all outputs are not mine, request histories
1423 for _addr, _v in tx.outputs:
1424 # assert not self.is_mine(_addr)
1425 ext_requests.append( ('blockchain.address.get_history', [_addr]) )
1427 ext_h = self.network.synchronous_get(ext_requests)
1428 print_error("sync:", ext_requests, ext_h)
1431 if h == ['*']: continue
1433 if item.get('tx_hash') == tx_hash:
1434 height = item.get('height')
1436 print_error("found height for", tx_hash, height)
1437 self.verifier.add(tx_hash, height)
1439 print_error("removing orphaned tx from history", tx_hash)
1440 self.transactions.pop(tx_hash)
1446 def check_new_tx(self, tx_hash, tx):
1447 # 1 check that tx is referenced in addr_history.
1449 for addr, hist in self.history.items():
1450 if hist == ['*']:continue
1451 for txh, height in hist:
1453 addresses.append(addr)
1458 # 2 check that referencing addresses are in the tx
1459 for addr in addresses:
1460 if not tx.has_address(addr):
1466 def start_threads(self, network):
1467 from verifier import TxVerifier
1468 self.network = network
1469 if self.network is not None:
1470 self.verifier = TxVerifier(self.network, self.storage)
1471 self.verifier.start()
1472 self.set_verifier(self.verifier)
1473 self.synchronizer = WalletSynchronizer(self, network)
1474 self.synchronizer.start()
1476 self.verifier = None
1477 self.synchronizer =None
1479 def stop_threads(self):
1481 self.verifier.stop()
1482 self.synchronizer.stop()
1485 def restore(self, callback):
1487 def wait_for_wallet():
1488 self.set_up_to_date(False)
1489 while not self.is_up_to_date():
1490 msg = "%s\n%s %d\n%s %.1f"%(
1491 _("Please wait..."),
1492 _("Addresses generated:"),
1493 len(self.addresses(True)),
1494 _("Kilobytes received:"),
1495 self.network.interface.bytes_received/1024.)
1497 apply(callback, (msg,))
1500 def wait_for_network():
1501 while not self.network.is_connected():
1502 msg = "%s \n" % (_("Connecting..."))
1503 apply(callback, (msg,))
1506 # wait until we are connected, because the user might have selected another server
1513 self.fill_addressbook()
1518 class WalletSynchronizer(threading.Thread):
1521 def __init__(self, wallet, network):
1522 threading.Thread.__init__(self)
1524 self.wallet = wallet
1525 self.network = network
1526 self.was_updated = True
1527 self.running = False
1528 self.lock = threading.Lock()
1529 self.queue = Queue.Queue()
1532 with self.lock: self.running = False
1534 def is_running(self):
1535 with self.lock: return self.running
1538 def subscribe_to_addresses(self, addresses):
1540 for addr in addresses:
1541 messages.append(('blockchain.address.subscribe', [addr]))
1542 self.network.subscribe( messages, lambda i,r: self.queue.put(r))
1549 while self.is_running():
1551 if not self.network.is_connected():
1552 self.network.wait_until_connected()
1554 self.run_interface()
1557 def run_interface(self):
1559 print_error("synchronizer: connected to", self.network.main_server())
1563 requested_histories = {}
1565 # request any missing transactions
1566 for history in self.wallet.history.values():
1567 if history == ['*']: continue
1568 for tx_hash, tx_height in history:
1569 if self.wallet.transactions.get(tx_hash) is None and (tx_hash, tx_height) not in missing_tx:
1570 missing_tx.append( (tx_hash, tx_height) )
1573 print_error("missing tx", missing_tx)
1576 self.subscribe_to_addresses(self.wallet.addresses(True))
1578 while self.is_running():
1579 # 1. create new addresses
1580 new_addresses = self.wallet.synchronize()
1582 # request missing addresses
1584 self.subscribe_to_addresses(new_addresses)
1586 # request missing transactions
1587 for tx_hash, tx_height in missing_tx:
1588 if (tx_hash, tx_height) not in requested_tx:
1589 self.network.send([ ('blockchain.transaction.get',[tx_hash, tx_height]) ], lambda i,r: self.queue.put(r))
1590 requested_tx.append( (tx_hash, tx_height) )
1593 # detect if situation has changed
1594 if self.network.is_up_to_date() and self.queue.empty():
1595 if not self.wallet.is_up_to_date():
1596 self.wallet.set_up_to_date(True)
1597 self.was_updated = True
1599 if self.wallet.is_up_to_date():
1600 self.wallet.set_up_to_date(False)
1601 self.was_updated = True
1603 if self.was_updated:
1604 self.network.trigger_callback('updated')
1605 self.was_updated = False
1609 r = self.queue.get(block=True, timeout=1)
1614 #if interface != self.network.interface:
1620 # 3. handle response
1621 method = r['method']
1622 params = r['params']
1623 result = r.get('result')
1624 error = r.get('error')
1629 if method == 'blockchain.address.subscribe':
1631 if self.wallet.get_status(self.wallet.get_history(addr)) != result:
1632 if requested_histories.get(addr) is None:
1633 self.network.send([('blockchain.address.get_history', [addr])], lambda i,r:self.queue.put(r))
1634 requested_histories[addr] = result
1636 elif method == 'blockchain.address.get_history':
1638 print_error("receiving history", addr, result)
1640 assert requested_histories.pop(addr) == '*'
1641 self.wallet.receive_history_callback(addr, result)
1644 # check that txids are unique
1647 tx_hash = item['tx_hash']
1648 if tx_hash not in txids:
1649 txids.append(tx_hash)
1650 hist.append( (tx_hash, item['height']) )
1652 if len(hist) != len(result):
1653 raise Exception("error: server sent history with non-unique txid", result)
1655 # check that the status corresponds to what was announced
1656 rs = requested_histories.pop(addr)
1657 if self.wallet.get_status(hist) != rs:
1658 raise Exception("error: status mismatch: %s"%addr)
1660 # store received history
1661 self.wallet.receive_history_callback(addr, hist)
1663 # request transactions that we don't have
1664 for tx_hash, tx_height in hist:
1665 if self.wallet.transactions.get(tx_hash) is None:
1666 if (tx_hash, tx_height) not in requested_tx and (tx_hash, tx_height) not in missing_tx:
1667 missing_tx.append( (tx_hash, tx_height) )
1669 elif method == 'blockchain.transaction.get':
1671 tx_height = params[1]
1672 assert tx_hash == hash_encode(Hash(result.decode('hex')))
1673 tx = Transaction(result)
1674 self.wallet.receive_tx_callback(tx_hash, tx, tx_height)
1675 self.was_updated = True
1676 requested_tx.remove( (tx_hash, tx_height) )
1677 print_error("received tx:", tx_hash, len(tx.raw))
1680 print_error("Error: Unknown message:" + method + ", " + repr(params) + ", " + repr(result) )
1682 if self.was_updated and not requested_tx:
1683 self.network.trigger_callback('updated')
1684 # Updated gets called too many times from other places as well; if we use that signal we get the notification three times
1685 self.network.trigger_callback("new_transaction")
1686 self.was_updated = False
1691 class OldWallet(NewWallet):
1693 def init_seed(self, seed):
1697 raise Exception("a seed exists")
1700 seed = random_seed(128)
1702 self.seed_version = OLD_SEED_VERSION
1704 # see if seed was entered as hex
1709 self.seed = str(seed)
1714 words = seed.split()
1716 mnemonic.mn_decode(words)
1720 self.seed = mnemonic.mn_decode(words)
1723 raise Exception("Invalid seed")
1727 def get_master_public_key(self):
1728 return self.storage.get("master_public_key")
1730 def create_accounts(self, password):
1731 seed = pw_decode(self.seed, password)
1732 mpk = OldAccount.mpk_from_seed(seed)
1733 self.create_account(mpk)
1735 def create_account(self, mpk):
1736 self.storage.put('master_public_key', mpk, True)
1737 self.accounts[0] = OldAccount({'mpk':mpk, 0:[], 1:[]})
1738 self.save_accounts()
1740 def create_watching_only_wallet(self, K0):
1741 self.seed_version = OLD_SEED_VERSION
1742 self.storage.put('seed_version', self.seed_version, True)
1743 self.create_account(K0)
1745 def get_seed(self, password):
1746 seed = pw_decode(self.seed, password)
1747 self.accounts[0].check_seed(seed)
1750 def get_mnemonic(self, password):
1752 s = pw_decode(self.seed, password)
1753 return ' '.join(mnemonic.mn_encode(s))
1756 def add_keypairs_from_KeyID(self, tx, keypairs, password):
1757 # first check the provided password
1758 seed = self.get_seed(password)
1759 for txin in tx.inputs:
1760 keyid = txin.get('KeyID')
1762 m = re.match("old\(([0-9a-f]+),(\d+),(\d+)", keyid)
1765 if mpk != self.storage.get('master_public_key'): continue
1766 for_change = int(m.group(2))
1767 num = int(m.group(3))
1768 account = self.accounts[0]
1769 addr = account.get_address(for_change, num)
1770 txin['address'] = addr # fixme: side effect
1771 pk = account.get_private_key(seed, (for_change, num))
1772 pubkey = public_key_from_private_key(pk)
1773 keypairs[pubkey] = pk
1776 def get_account_name(self, k):
1778 return 'Main account'
1783 # former WalletFactory
1784 class Wallet(object):
1786 def __new__(self, storage):
1787 config = storage.config
1788 if config.get('bitkey', False):
1789 # if user requested support for Bitkey device,
1790 # import Bitkey driver
1791 from wallet_bitkey import WalletBitkey
1792 return WalletBitkey(config)
1794 if not storage.file_exists:
1795 seed_version = NEW_SEED_VERSION if config.get('bip32') is True else OLD_SEED_VERSION
1797 seed_version = storage.get('seed_version')
1799 if seed_version == OLD_SEED_VERSION:
1800 return OldWallet(storage)
1801 elif seed_version == NEW_SEED_VERSION:
1802 return NewWallet(storage)
1804 msg = "This wallet seed is not supported."
1805 if seed_version in [5]:
1806 msg += "\nTo open this wallet, try 'git checkout seed_v%d'"%seed_version
1814 def from_seed(self, seed, storage):
1819 words = seed.strip().split()
1821 mnemonic.mn_decode(words)
1822 uses_electrum_words = True
1824 uses_electrum_words = False
1832 if is_hex or (uses_electrum_words and len(words) != 13):
1833 print "old style wallet", len(words), words
1834 w = OldWallet(storage)
1835 w.init_seed(seed) #hex
1837 #assert is_seed(seed)