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()
77 self.file_exists = False
78 self.path = self.init_path(config)
79 print_error( "wallet path", self.path )
84 def init_path(self, config):
85 """Set the path of the wallet."""
87 # command line -w option
88 path = config.get('wallet_path')
93 path = config.get('default_wallet_path')
98 dirpath = os.path.join(config.path, "wallets")
99 if not os.path.exists(dirpath):
102 new_path = os.path.join(config.path, "wallets", "default_wallet")
104 # default path in pre 1.9 versions
105 old_path = os.path.join(config.path, "electrum.dat")
106 if os.path.exists(old_path) and not os.path.exists(new_path):
107 os.rename(old_path, new_path)
112 def read(self, path):
113 """Read the contents of the wallet file."""
115 with open(self.path, "r") as f:
120 d = ast.literal_eval( data ) #parse raw data from reading wallet file
122 raise IOError("Cannot read wallet file.")
125 self.file_exists = True
128 def get(self, key, default=None):
129 v = self.data.get(key)
134 def put(self, key, value, save = True):
137 if value is not None:
138 self.data[key] = value
146 f = open(self.path,"w")
149 if 'ANDROID_DATA' not in os.environ:
151 os.chmod(self.path,stat.S_IREAD | stat.S_IWRITE)
156 def __init__(self, storage):
158 self.storage = storage
159 self.electrum_version = ELECTRUM_VERSION
160 self.gap_limit_for_change = 3 # constant
163 self.seed_version = storage.get('seed_version', SEED_VERSION)
165 self.gap_limit = storage.get('gap_limit', 5)
166 self.use_change = storage.get('use_change',True)
167 self.use_encryption = storage.get('use_encryption', False)
168 self.seed = storage.get('seed', '') # encrypted
169 self.labels = storage.get('labels', {})
170 self.frozen_addresses = storage.get('frozen_addresses',[])
171 self.addressbook = storage.get('contacts', [])
173 self.imported_keys = storage.get('imported_keys',{})
174 self.history = storage.get('addr_history',{}) # address -> list(txid, height)
176 self.fee = int(storage.get('fee_per_kb',20000))
178 self.master_public_keys = storage.get('master_public_keys',{})
179 self.master_private_keys = storage.get('master_private_keys', {})
181 self.next_addresses = storage.get('next_addresses',{})
183 if self.seed_version not in [4, 6]:
184 msg = "This wallet seed is not supported."
185 if self.seed_version in [5]:
186 msg += "\nTo open this wallet, try 'git checkout seed_v%d'"%self.seed_version
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})
245 def set_up_to_date(self,b):
246 with self.lock: self.up_to_date = b
249 def is_up_to_date(self):
250 with self.lock: return self.up_to_date
254 self.up_to_date = False
255 while not self.is_up_to_date():
259 def import_key(self, sec, password):
261 seed = self.get_seed(password)
263 address = address_from_private_key(sec)
265 raise Exception('Invalid private key')
267 if self.is_mine(address):
268 raise Exception('Address already in wallet')
270 # store the originally requested keypair into the imported keys table
271 self.imported_keys[address] = pw_encode(sec, password )
272 self.storage.put('imported_keys', self.imported_keys, True)
273 if self.synchronizer:
274 self.synchronizer.subscribe_to_addresses([address])
277 def delete_imported_key(self, addr):
278 if addr in self.imported_keys:
279 self.imported_keys.pop(addr)
280 self.storage.put('imported_keys', self.imported_keys, True)
284 import mnemonic, ecdsa
285 entropy = ecdsa.util.randrange( pow(2,160) )
288 ss = "%040x"%(entropy+nonce)
289 s = hashlib.sha256(ss.decode('hex')).digest().encode('hex')
290 # we keep only 13 words, that's approximately 139 bits of entropy
291 words = mnemonic.mn_encode(s)[0:13]
292 seed = ' '.join(words)
293 if mnemonic_hash(seed).startswith(SEED_PREFIX):
294 break # this removes 12 bits of entropy
300 def init_seed(self, seed):
304 raise Exception("a seed exists")
307 self.seed = random_seed(128)
308 self.seed_version = 4
312 # self.seed = self.make_seed()
313 # self.seed_version = SEED_VERSION
316 # find out what kind of wallet we are
318 seed.strip().decode('hex')
319 self.seed_version = 4
320 self.seed = str(seed)
326 self.seed_version = 4
327 self.seed = mnemonic.mn_decode(words)
330 raise Exception("Invalid seed")
334 def save_seed(self, password):
336 self.seed = pw_encode( self.seed, password)
337 self.use_encryption = True
338 self.storage.put('seed', self.seed, True)
339 self.storage.put('seed_version', self.seed_version, True)
340 self.storage.put('use_encryption', self.use_encryption,True)
341 self.create_accounts(password)
344 def create_watching_only_wallet(self, params):
350 self.seed_version = 4
351 self.storage.put('seed_version', self.seed_version, True)
352 self.create_old_account(K0)
356 self.master_public_keys = {
357 "m/0'/": (c0, K0, cK0),
359 self.storage.put('master_public_keys', self.master_public_keys, True)
360 self.storage.put('seed_version', self.seed_version, True)
361 self.create_account('1','Main account')
364 def create_accounts(self, password):
365 seed = pw_decode(self.seed, password)
367 if self.seed_version == 4:
368 mpk = OldAccount.mpk_from_seed(seed)
369 self.create_old_account(mpk)
371 # create default account
372 self.create_master_keys('1', password)
373 self.create_account('1','Main account')
376 def create_master_keys(self, account_type, password):
377 master_k, master_c, master_K, master_cK = bip32_init(self.get_seed(None))
378 if account_type == '1':
379 k0, c0, K0, cK0 = bip32_private_derivation(master_k, master_c, "m/", "m/0'/")
380 self.master_public_keys["m/0'/"] = (c0, K0, cK0)
381 self.master_private_keys["m/0'/"] = pw_encode(k0, password)
382 elif account_type == '2of2':
383 k1, c1, K1, cK1 = bip32_private_derivation(master_k, master_c, "m/", "m/1'/")
384 k2, c2, K2, cK2 = bip32_private_derivation(master_k, master_c, "m/", "m/2'/")
385 self.master_public_keys["m/1'/"] = (c1, K1, cK1)
386 self.master_public_keys["m/2'/"] = (c2, K2, cK2)
387 self.master_private_keys["m/1'/"] = pw_encode(k1, password)
388 self.master_private_keys["m/2'/"] = pw_encode(k2, password)
389 elif account_type == '2of3':
390 k3, c3, K3, cK3 = bip32_private_derivation(master_k, master_c, "m/", "m/3'/")
391 k4, c4, K4, cK4 = bip32_private_derivation(master_k, master_c, "m/", "m/4'/")
392 k5, c5, K5, cK5 = bip32_private_derivation(master_k, master_c, "m/", "m/5'/")
393 self.master_public_keys["m/3'/"] = (c3, K3, cK3)
394 self.master_public_keys["m/4'/"] = (c4, K4, cK4)
395 self.master_public_keys["m/5'/"] = (c5, K5, cK5)
396 self.master_private_keys["m/3'/"] = pw_encode(k3, password)
397 self.master_private_keys["m/4'/"] = pw_encode(k4, password)
398 self.master_private_keys["m/5'/"] = pw_encode(k5, password)
400 self.storage.put('master_public_keys', self.master_public_keys, True)
401 self.storage.put('master_private_keys', self.master_private_keys, True)
403 def has_master_public_keys(self, account_type):
404 if account_type == '1':
405 return "m/0'/" in self.master_public_keys
406 elif account_type == '2of2':
407 return set(["m/1'/", "m/2'/"]) <= set(self.master_public_keys.keys())
408 elif account_type == '2of3':
409 return set(["m/3'/", "m/4'/", "m/5'/"]) <= set(self.master_public_keys.keys())
411 def find_root_by_master_key(self, c, K):
412 for key, v in self.master_public_keys.items():
413 if key == "m/":continue
415 if (c == cc) and (K == KK):
418 def deseed_root(self, seed, password):
419 # for safety, we ask the user to enter their seed
420 assert seed == self.get_seed(password)
422 self.storage.put('seed', '', True)
425 def deseed_branch(self, k):
426 # check that parent has no seed
427 assert self.seed == ''
428 self.master_private_keys.pop(k)
429 self.storage.put('master_private_keys', self.master_private_keys, True)
431 def is_watching_only(self):
432 return (self.seed == '') and (self.master_private_keys == {})
436 def account_id(self, account_type, i):
437 if account_type == '1':
439 elif account_type == '2of2':
440 return "m/1'/%d & m/2'/%d"%(i,i)
441 elif account_type == '2of3':
442 return "m/3'/%d & m/4'/%d & m/5'/%d"%(i,i,i)
444 raise Exception('unknown account type')
447 def num_accounts(self, account_type):
448 keys = self.accounts.keys()
451 account_id = self.account_id(account_type, i)
452 if account_id not in keys: break
457 def new_account_address(self, account_type = '1'):
458 i = self.num_accounts(account_type)
459 k = self.account_id(account_type,i)
461 addr = self.next_addresses.get(k)
463 account_id, account = self.next_account(account_type)
464 addr = account.first_address()
465 self.next_addresses[k] = addr
466 self.storage.put('next_addresses',self.next_addresses)
471 def next_account(self, account_type = '1'):
473 i = self.num_accounts(account_type)
474 account_id = self.account_id(account_type,i)
476 if account_type is '1':
477 master_c0, master_K0, _ = self.master_public_keys["m/0'/"]
478 c0, K0, cK0 = bip32_public_derivation(master_c0.decode('hex'), master_K0.decode('hex'), "m/0'/", "m/0'/%d"%i)
479 account = BIP32_Account({ 'c':c0, 'K':K0, 'cK':cK0 })
481 elif account_type == '2of2':
482 master_c1, master_K1, _ = self.master_public_keys["m/1'/"]
483 c1, K1, cK1 = bip32_public_derivation(master_c1.decode('hex'), master_K1.decode('hex'), "m/1'/", "m/1'/%d"%i)
484 master_c2, master_K2, _ = self.master_public_keys["m/2'/"]
485 c2, K2, cK2 = bip32_public_derivation(master_c2.decode('hex'), master_K2.decode('hex'), "m/2'/", "m/2'/%d"%i)
486 account = BIP32_Account_2of2({ 'c':c1, 'K':K1, 'cK':cK1, 'c2':c2, 'K2':K2, 'cK2':cK2 })
488 elif account_type == '2of3':
489 master_c3, master_K3, _ = self.master_public_keys["m/3'/"]
490 c3, K3, cK3 = bip32_public_derivation(master_c3.decode('hex'), master_K3.decode('hex'), "m/3'/", "m/3'/%d"%i)
491 master_c4, master_K4, _ = self.master_public_keys["m/4'/"]
492 c4, K4, cK4 = bip32_public_derivation(master_c4.decode('hex'), master_K4.decode('hex'), "m/4'/", "m/4'/%d"%i)
493 master_c5, master_K5, _ = self.master_public_keys["m/5'/"]
494 c5, K5, cK5 = bip32_public_derivation(master_c5.decode('hex'), master_K5.decode('hex'), "m/5'/", "m/5'/%d"%i)
495 account = BIP32_Account_2of3({ 'c':c3, 'K':K3, 'cK':cK3, 'c2':c4, 'K2':K4, 'cK2':cK4, 'c3':c5, 'K3':K5, 'cK3':cK5 })
497 return account_id, account
500 def set_label(self, name, text = None):
502 old_text = self.labels.get(name)
505 self.labels[name] = text
509 self.labels.pop(name)
513 self.storage.put('labels', self.labels, True)
515 run_hook('set_label', name, text, changed)
520 def create_account(self, account_type = '1', name = None):
521 k, account = self.next_account(account_type)
522 if k in self.pending_accounts:
523 self.pending_accounts.pop(k)
524 self.storage.put('pending_accounts', self.pending_accounts)
526 self.accounts[k] = account
529 self.set_label(k, name)
532 def create_old_account(self, mpk):
533 self.storage.put('master_public_key', mpk, True)
534 self.accounts[0] = OldAccount({'mpk':mpk, 0:[], 1:[]})
538 def save_accounts(self):
540 for k, v in self.accounts.items():
542 self.storage.put('accounts', d, True)
546 def load_accounts(self):
547 d = self.storage.get('accounts', {})
549 for k, v in d.items():
551 v['mpk'] = self.storage.get('master_public_key')
552 self.accounts[k] = OldAccount(v)
554 self.accounts[k] = BIP32_Account_2of2(v)
556 self.accounts[k] = BIP32_Account(v)
558 self.pending_accounts = self.storage.get('pending_accounts',{})
561 def delete_pending_account(self, k):
562 self.pending_accounts.pop(k)
563 self.storage.put('pending_accounts', self.pending_accounts)
565 def account_is_pending(self, k):
566 return k in self.pending_accounts
568 def create_pending_account(self, acct_type, name):
569 k, addr = self.new_account_address(acct_type)
570 self.set_label(k, name)
571 self.pending_accounts[k] = addr
572 self.storage.put('pending_accounts', self.pending_accounts)
574 def get_pending_accounts(self):
575 return self.pending_accounts.items()
578 def addresses(self, include_change = True, _next=True):
579 o = self.get_account_addresses(-1, include_change)
580 for a in self.accounts.keys():
581 o += self.get_account_addresses(a, include_change)
584 for addr in self.next_addresses.values():
590 def is_mine(self, address):
591 return address in self.addresses(True)
594 def is_change(self, address):
595 if not self.is_mine(address): return False
596 if address in self.imported_keys.keys(): return False
597 acct, s = self.get_address_index(address)
598 if s is None: return False
601 def get_master_public_key(self):
602 if self.seed_version == 4:
603 return self.storage.get("master_public_key")
605 c, K, cK = self.storage.get("master_public_keys")["m/0'/"]
608 def get_master_private_key(self, account, password):
609 master_k = pw_decode( self.master_private_keys[account], password)
610 master_c, master_K, master_Kc = self.master_public_keys[account]
612 K, Kc = get_pubkeys_from_secret(master_k.decode('hex'))
613 assert K.encode('hex') == master_K
615 raise Exception("Invalid password")
619 def get_address_index(self, address):
620 if address in self.imported_keys.keys():
623 for account in self.accounts.keys():
624 for for_change in [0,1]:
625 addresses = self.accounts[account].get_addresses(for_change)
626 for addr in addresses:
628 return account, (for_change, addresses.index(addr))
630 for k,v in self.next_addresses.items():
634 raise Exception("Address not found", address)
637 def get_roots(self, account):
639 for a in account.split('&'):
641 m = re.match("(m/\d+'/)(\d+)", s)
642 roots.append( m.group(1) )
645 def is_seeded(self, account):
646 if type(account) is int:
647 return self.seed is not None
649 for root in self.get_roots(account):
650 if root not in self.master_private_keys.keys():
654 def rebase_sequence(self, account, sequence):
657 for a in account.split('&'):
659 m = re.match("(m/\d+'/)(\d+)", s)
661 num = int(m.group(2))
662 dd.append( (root, [num,c,i] ) )
666 def get_keyID(self, account, sequence):
669 mpk = self.storage.get('master_public_key')
670 return 'old(%s,%d,%d)'%(mpk,a,b)
672 rs = self.rebase_sequence(account, sequence)
674 for root, public_sequence in rs:
675 c, K, _ = self.master_public_keys[root]
676 s = '/' + '/'.join( map(lambda x:str(x), public_sequence) )
677 dd.append( 'bip32(%s,%s,%s)'%(c,K, s) )
682 def get_seed(self, password):
683 s = pw_decode(self.seed, password)
684 if self.seed_version == 4:
686 self.accounts[0].check_seed(seed)
688 seed = mnemonic_hash(s)
692 def get_mnemonic(self, password):
694 s = pw_decode(self.seed, password)
695 if self.seed_version == 4:
696 return ' '.join(mnemonic.mn_encode(s))
702 def get_private_key(self, address, password):
703 if self.is_watching_only():
706 # first check the provided password
707 seed = self.get_seed(password)
710 if address in self.imported_keys.keys():
711 out.append( pw_decode( self.imported_keys[address], password ) )
713 account, sequence = self.get_address_index(address)
715 pk = self.accounts[account].get_private_key(seed, sequence)
719 # assert address == self.accounts[account].get_address(*sequence)
720 rs = self.rebase_sequence( account, sequence)
721 for root, public_sequence in rs:
723 if root not in self.master_private_keys.keys(): continue
724 master_k = self.get_master_private_key(root, password)
725 master_c, _, _ = self.master_public_keys[root]
726 pk = bip32_private_key( public_sequence, master_k.decode('hex'), master_c.decode('hex'))
732 def add_keypairs_from_wallet(self, tx, keypairs, password):
733 for txin in tx.inputs:
734 address = txin['address']
735 if not self.is_mine(address):
737 private_keys = self.get_private_key(address, password)
738 for sec in private_keys:
739 pubkey = public_key_from_private_key(sec)
740 keypairs[ pubkey ] = sec
741 if address in self.imported_keys.keys():
742 txin['redeemPubkey'] = pubkey
745 def add_keypairs_from_KeyID(self, tx, keypairs, password):
746 # first check the provided password
747 seed = self.get_seed(password)
749 for txin in tx.inputs:
750 keyid = txin.get('KeyID')
753 if self.seed_version == 4:
754 m = re.match("old\(([0-9a-f]+),(\d+),(\d+)", keyid)
757 if mpk != self.storage.get('master_public_key'): continue
758 for_change = int(m.group(2))
759 num = int(m.group(3))
760 account = self.accounts[0]
761 addr = account.get_address(for_change, num)
762 txin['address'] = addr # fixme: side effect
763 pk = account.get_private_key(seed, (for_change, num))
764 pubkey = public_key_from_private_key(pk)
765 keypairs[pubkey] = pk
770 for s in keyid.split('&'):
771 m = re.match("bip32\(([0-9a-f]+),([0-9a-f]+),(/\d+/\d+/\d+)", s)
775 sequence = m.group(3)
776 root = self.find_root_by_master_key(c,K)
777 if not root: continue
778 sequence = map(lambda x:int(x), sequence.strip('/').split('/'))
779 root = root + '%d'%sequence[0]
780 sequence = sequence[1:]
781 roots.append((root,sequence))
783 account_id = " & ".join( map(lambda x:x[0], roots) )
784 account = self.accounts.get(account_id)
785 if not account: continue
786 addr = account.get_address(*sequence)
787 txin['address'] = addr # fixme: side effect
788 pk = self.get_private_key(addr, password)
790 pubkey = public_key_from_private_key(sec)
791 keypairs[pubkey] = sec
795 def signrawtransaction(self, tx, input_info, private_keys, password):
797 # check that the password is correct
798 seed = self.get_seed(password)
801 tx.add_input_info(input_info)
803 # add redeem script for coins that are in the wallet
804 # FIXME: add redeemPubkey too!
805 unspent_coins = self.get_unspent_coins()
806 for txin in tx.inputs:
807 for item in unspent_coins:
808 if txin['prevout_hash'] == item['prevout_hash'] and txin['prevout_n'] == item['prevout_n']:
809 print_error( "tx input is in unspent coins" )
810 txin['scriptPubKey'] = item['scriptPubKey']
811 account, sequence = self.get_address_index(item['address'])
813 txin['redeemScript'] = self.accounts[account].redeem_script(sequence)
814 print_error("added redeemScript", txin['redeemScript'])
818 # build a list of public/private keys
821 # add private keys from parameter
822 for sec in private_keys:
823 pubkey = public_key_from_private_key(sec)
824 keypairs[ pubkey ] = sec
826 # add private_keys from KeyID
827 self.add_keypairs_from_KeyID(tx, keypairs, password)
829 # add private keys from wallet
830 self.add_keypairs_from_wallet(tx, keypairs, password)
831 self.sign_transaction(tx, keypairs)
834 def sign_message(self, address, message, password):
835 keys = self.get_private_key(address, password)
836 assert len(keys) == 1
838 key = regenerate_key(sec)
839 compressed = is_compressed(sec)
840 return key.sign_message(message, compressed, address)
843 def change_gap_limit(self, value):
844 if value >= self.gap_limit:
845 self.gap_limit = value
846 self.storage.put('gap_limit', self.gap_limit, True)
847 #self.interface.poke('synchronizer')
850 elif value >= self.min_acceptable_gap():
851 for key, account in self.accounts.items():
852 addresses = account[0]
853 k = self.num_unused_trailing_addresses(addresses)
854 n = len(addresses) - k + value
855 addresses = addresses[0:n]
856 self.accounts[key][0] = addresses
858 self.gap_limit = value
859 self.storage.put('gap_limit', self.gap_limit, True)
865 def num_unused_trailing_addresses(self, addresses):
867 for a in addresses[::-1]:
868 if self.history.get(a):break
872 def min_acceptable_gap(self):
873 # fixme: this assumes wallet is synchronized
877 for account in self.accounts.values():
878 addresses = account.get_addresses(0)
879 k = self.num_unused_trailing_addresses(addresses)
880 for a in addresses[0:-k]:
881 if self.history.get(a):
885 if n > nmax: nmax = n
889 def address_is_old(self, address):
891 h = self.history.get(address, [])
894 for tx_hash, tx_height in h:
898 tx_age = self.verifier.blockchain.height() - tx_height + 1
904 def synchronize_sequence(self, account, for_change):
905 limit = self.gap_limit_for_change if for_change else self.gap_limit
908 addresses = account.get_addresses(for_change)
909 if len(addresses) < limit:
910 address = account.create_new_address(for_change)
911 self.history[address] = []
912 new_addresses.append( address )
915 if map( lambda a: self.address_is_old(a), addresses[-limit:] ) == limit*[False]:
918 address = account.create_new_address(for_change)
919 self.history[address] = []
920 new_addresses.append( address )
926 def create_pending_accounts(self):
927 for account_type in ['1','2of2','2of3']:
928 if not self.has_master_public_keys(account_type):
930 k, a = self.new_account_address(account_type)
931 if self.address_is_old(a):
932 print_error( "creating account", a )
933 self.create_account(account_type)
934 self.next_addresses.pop(k)
937 def synchronize_account(self, account):
939 new += self.synchronize_sequence(account, 0)
940 new += self.synchronize_sequence(account, 1)
944 def synchronize(self):
945 if self.master_public_keys:
946 self.create_pending_accounts()
948 for account in self.accounts.values():
949 new += self.synchronize_account(account)
952 self.storage.put('addr_history', self.history, True)
957 return self.history.values() != [[]] * len(self.history)
960 def add_contact(self, address, label=None):
961 self.addressbook.append(address)
962 self.storage.put('contacts', self.addressbook, True)
964 self.set_label(address, label)
967 def delete_contact(self, addr):
968 if addr in self.addressbook:
969 self.addressbook.remove(addr)
970 self.storage.put('addressbook', self.addressbook, True)
973 def fill_addressbook(self):
974 for tx_hash, tx in self.transactions.items():
975 is_relevant, is_send, _, _ = self.get_tx_value(tx)
977 for addr, v in tx.outputs:
978 if not self.is_mine(addr) and addr not in self.addressbook:
979 self.addressbook.append(addr)
981 # self.update_tx_labels()
983 def get_num_tx(self, address):
985 for tx in self.transactions.values():
986 if address in map(lambda x:x[0], tx.outputs): n += 1
990 def get_address_flags(self, addr):
991 flags = "C" if self.is_change(addr) else "I" if addr in self.imported_keys.keys() else "-"
992 flags += "F" if addr in self.frozen_addresses else "-"
996 def get_tx_value(self, tx, account=None):
997 domain = self.get_account_addresses(account)
998 return tx.get_value(domain, self.prevout_values)
1001 def update_tx_outputs(self, tx_hash):
1002 tx = self.transactions.get(tx_hash)
1004 for i, (addr, value) in enumerate(tx.outputs):
1005 key = tx_hash+ ':%d'%i
1006 self.prevout_values[key] = value
1008 for item in tx.inputs:
1009 if self.is_mine(item.get('address')):
1010 key = item['prevout_hash'] + ':%d'%item['prevout_n']
1011 self.spent_outputs.append(key)
1014 def get_addr_balance(self, address):
1015 assert self.is_mine(address)
1016 h = self.history.get(address,[])
1017 if h == ['*']: return 0,0
1019 received_coins = [] # list of coins received at address
1021 for tx_hash, tx_height in h:
1022 tx = self.transactions.get(tx_hash)
1025 for i, (addr, value) in enumerate(tx.outputs):
1027 key = tx_hash + ':%d'%i
1028 received_coins.append(key)
1030 for tx_hash, tx_height in h:
1031 tx = self.transactions.get(tx_hash)
1035 for item in tx.inputs:
1036 addr = item.get('address')
1038 key = item['prevout_hash'] + ':%d'%item['prevout_n']
1039 value = self.prevout_values.get( key )
1040 if key in received_coins:
1043 for i, (addr, value) in enumerate(tx.outputs):
1044 key = tx_hash + ':%d'%i
1055 def get_account_name(self, k):
1057 if self.seed_version == 4:
1058 name = 'Main account'
1060 name = 'Old account'
1062 default = "Unnamed account"
1063 m = re.match("m/0'/(\d+)", k)
1067 default = "Main account"
1069 default = "Account %s"%num
1071 m = re.match("m/1'/(\d+) & m/2'/(\d+)", k)
1074 default = "2of2 account %s"%num
1075 name = self.labels.get(k, default)
1079 def get_account_names(self):
1081 for k, account in self.accounts.items():
1082 accounts[k] = self.get_account_name(k)
1083 if self.imported_keys:
1084 accounts[-1] = 'Imported keys'
1087 def get_account_addresses(self, a, include_change=True):
1089 o = self.addresses(True)
1091 o = self.imported_keys.keys()
1093 ac = self.accounts[a]
1094 o = ac.get_addresses(0)
1095 if include_change: o += ac.get_addresses(1)
1098 def get_imported_balance(self):
1099 return self.get_balance(self.imported_keys.keys())
1101 def get_account_balance(self, account):
1102 return self.get_balance(self.get_account_addresses(account))
1104 def get_frozen_balance(self):
1105 return self.get_balance(self.frozen_addresses)
1107 def get_balance(self, domain=None):
1108 if domain is None: domain = self.addresses(True)
1111 c, u = self.get_addr_balance(addr)
1117 def get_unspent_coins(self, domain=None):
1119 if domain is None: domain = self.addresses(True)
1121 h = self.history.get(addr, [])
1122 if h == ['*']: continue
1123 for tx_hash, tx_height in h:
1124 tx = self.transactions.get(tx_hash)
1125 if tx is None: raise Exception("Wallet not synchronized")
1126 is_coinbase = tx.inputs[0].get('prevout_hash') == '0'*64
1127 for o in tx.d.get('outputs'):
1129 if output.get('address') != addr: continue
1130 key = tx_hash + ":%d" % output.get('prevout_n')
1131 if key in self.spent_outputs: continue
1132 output['prevout_hash'] = tx_hash
1133 output['height'] = tx_height
1134 output['coinbase'] = is_coinbase
1135 coins.append((tx_height, output))
1139 coins = sorted(coins)
1140 if coins[-1][0] != 0:
1141 while coins[0][0] == 0:
1142 coins = coins[1:] + [ coins[0] ]
1143 return [x[1] for x in coins]
1146 def choose_tx_inputs( self, amount, fixed_fee, domain = None ):
1147 """ todo: minimize tx size """
1149 fee = self.fee if fixed_fee is None else fixed_fee
1151 domain = self.addresses(True)
1153 for i in self.frozen_addresses:
1154 if i in domain: domain.remove(i)
1156 coins = self.get_unspent_coins(domain)
1160 if item.get('coinbase') and item.get('height') + COINBASE_MATURITY > self.network.blockchain.height:
1162 addr = item.get('address')
1163 v = item.get('value')
1166 fee = self.estimated_fee(inputs) if fixed_fee is None else fixed_fee
1167 if total >= amount + fee: break
1171 return inputs, total, fee
1174 def set_fee(self, fee):
1177 self.storage.put('fee_per_kb', self.fee, True)
1179 def estimated_fee(self, inputs):
1180 estimated_size = len(inputs) * 180 + 80 # this assumes non-compressed keys
1181 fee = self.fee * int(math.ceil(estimated_size/1000.))
1185 def add_tx_change( self, inputs, outputs, amount, fee, total, change_addr=None):
1186 "add change to a transaction"
1187 change_amount = total - ( amount + fee )
1188 if change_amount > DUST_THRESHOLD:
1191 # send change to one of the accounts involved in the tx
1192 address = inputs[0].get('address')
1193 account, _ = self.get_address_index(address)
1195 if not self.use_change or account == -1:
1196 change_addr = inputs[-1]['address']
1198 change_addr = self.accounts[account].get_addresses(1)[-self.gap_limit_for_change]
1200 # Insert the change output at a random position in the outputs
1201 posn = random.randint(0, len(outputs))
1202 outputs[posn:posn] = [( change_addr, change_amount)]
1206 def get_history(self, address):
1208 return self.history.get(address)
1211 def get_status(self, h):
1212 if not h: return None
1213 if h == ['*']: return '*'
1215 for tx_hash, height in h:
1216 status += tx_hash + ':%d:' % height
1217 return hashlib.sha256( status ).digest().encode('hex')
1220 def receive_tx_callback(self, tx_hash, tx, tx_height):
1222 with self.transaction_lock:
1223 self.add_extra_addresses(tx)
1224 if not self.check_new_tx(tx_hash, tx):
1225 # may happen due to pruning
1226 print_error("received transaction that is no longer referenced in history", tx_hash)
1228 self.transactions[tx_hash] = tx
1229 self.network.interface.pending_transactions_for_notifications.append(tx)
1230 self.save_transactions()
1231 if self.verifier and tx_height>0:
1232 self.verifier.add(tx_hash, tx_height)
1233 self.update_tx_outputs(tx_hash)
1236 def save_transactions(self):
1238 for k,v in self.transactions.items():
1240 self.storage.put('transactions', tx, True)
1242 def receive_history_callback(self, addr, hist):
1244 if not self.check_new_history(addr, hist):
1245 raise Exception("error: received history for %s is not consistent with known transactions"%addr)
1248 self.history[addr] = hist
1249 self.storage.put('addr_history', self.history, True)
1252 for tx_hash, tx_height in hist:
1254 # add it in case it was previously unconfirmed
1255 if self.verifier: self.verifier.add(tx_hash, tx_height)
1258 def get_tx_history(self, account=None):
1259 if not self.verifier:
1262 with self.transaction_lock:
1263 history = self.transactions.items()
1264 history.sort(key = lambda x: self.verifier.get_txpos(x[0]))
1268 for tx_hash, tx in history:
1269 is_relevant, is_mine, v, fee = self.get_tx_value(tx, account)
1270 if v is not None: balance += v
1272 c, u = self.get_account_balance(account)
1275 result.append( ('', 1000, 0, c+u-balance, None, c+u-balance, None ) )
1277 balance = c + u - balance
1278 for tx_hash, tx in history:
1279 is_relevant, is_mine, value, fee = self.get_tx_value(tx, account)
1282 if value is not None:
1285 conf, timestamp = self.verifier.get_confirmations(tx_hash) if self.verifier else (None, None)
1286 result.append( (tx_hash, conf, is_mine, value, fee, balance, timestamp) )
1291 def get_label(self, tx_hash):
1292 label = self.labels.get(tx_hash)
1293 is_default = (label == '') or (label is None)
1294 if is_default: label = self.get_default_label(tx_hash)
1295 return label, is_default
1298 def get_default_label(self, tx_hash):
1299 tx = self.transactions.get(tx_hash)
1302 is_relevant, is_mine, _, _ = self.get_tx_value(tx)
1304 for o in tx.outputs:
1306 if not self.is_mine(o_addr):
1308 default_label = self.labels[o_addr]
1310 default_label = o_addr
1313 default_label = '(internal)'
1315 for o in tx.outputs:
1317 if self.is_mine(o_addr) and not self.is_change(o_addr):
1320 for o in tx.outputs:
1322 if self.is_mine(o_addr):
1328 dest_label = self.labels.get(o_addr)
1330 default_label = self.labels[o_addr]
1332 default_label = o_addr
1334 return default_label
1337 def make_unsigned_transaction(self, outputs, fee=None, change_addr=None, domain=None ):
1338 for address, x in outputs:
1339 assert is_valid(address)
1340 amount = sum( map(lambda x:x[1], outputs) )
1341 inputs, total, fee = self.choose_tx_inputs( amount, fee, domain )
1343 raise ValueError("Not enough funds")
1344 self.add_input_info(inputs)
1345 outputs = self.add_tx_change(inputs, outputs, amount, fee, total, change_addr)
1346 return Transaction.from_io(inputs, outputs)
1349 def mktx(self, outputs, password, fee=None, change_addr=None, domain= None ):
1350 tx = self.make_unsigned_transaction(outputs, fee, change_addr, domain)
1352 self.add_keypairs_from_wallet(tx, keypairs, password)
1354 self.sign_transaction(tx, keypairs)
1358 def add_input_info(self, inputs):
1360 address = txin['address']
1361 if address in self.imported_keys.keys():
1363 account, sequence = self.get_address_index(address)
1364 txin['KeyID'] = self.get_keyID(account, sequence)
1365 redeemScript = self.accounts[account].redeem_script(sequence)
1367 txin['redeemScript'] = redeemScript
1369 txin['redeemPubkey'] = self.accounts[account].get_pubkey(*sequence)
1372 def sign_transaction(self, tx, keypairs):
1374 run_hook('sign_transaction', tx)
1377 def sendtx(self, tx):
1379 h = self.send_tx(tx)
1380 self.tx_event.wait()
1381 return self.receive_tx(h, tx)
1383 def send_tx(self, tx):
1385 self.tx_event.clear()
1386 self.network.interface.send([('blockchain.transaction.broadcast', [str(tx)])], self.on_broadcast)
1389 def on_broadcast(self, i, r):
1390 self.tx_result = r.get('result')
1393 def receive_tx(self, tx_hash, tx):
1394 out = self.tx_result
1396 return False, "error: " + out
1397 run_hook('receive_tx', tx, self)
1402 def update_password(self, old_password, new_password):
1403 if new_password == '': new_password = None
1404 decoded = self.get_seed(old_password)
1405 self.seed = pw_encode( decoded, new_password)
1406 self.storage.put('seed', self.seed, True)
1407 self.use_encryption = (new_password != None)
1408 self.storage.put('use_encryption', self.use_encryption,True)
1409 for k in self.imported_keys.keys():
1410 a = self.imported_keys[k]
1411 b = pw_decode(a, old_password)
1412 c = pw_encode(b, new_password)
1413 self.imported_keys[k] = c
1414 self.storage.put('imported_keys', self.imported_keys, True)
1416 for k, v in self.master_private_keys.items():
1417 b = pw_decode(v, old_password)
1418 c = pw_encode(b, new_password)
1419 self.master_private_keys[k] = c
1420 self.storage.put('master_private_keys', self.master_private_keys, True)
1423 def freeze(self,addr):
1424 if self.is_mine(addr) and addr not in self.frozen_addresses:
1425 self.frozen_addresses.append(addr)
1426 self.storage.put('frozen_addresses', self.frozen_addresses, True)
1431 def unfreeze(self,addr):
1432 if self.is_mine(addr) and addr in self.frozen_addresses:
1433 self.frozen_addresses.remove(addr)
1434 self.storage.put('frozen_addresses', self.frozen_addresses, True)
1440 def set_verifier(self, verifier):
1441 self.verifier = verifier
1443 # review transactions that are in the history
1444 for addr, hist in self.history.items():
1445 if hist == ['*']: continue
1446 for tx_hash, tx_height in hist:
1448 # add it in case it was previously unconfirmed
1449 self.verifier.add(tx_hash, tx_height)
1452 # if we are on a pruning server, remove unverified transactions
1453 vr = self.verifier.transactions.keys() + self.verifier.verified_tx.keys()
1454 for tx_hash in self.transactions.keys():
1455 if tx_hash not in vr:
1456 self.transactions.pop(tx_hash)
1460 def check_new_history(self, addr, hist):
1462 # check that all tx in hist are relevant
1464 for tx_hash, height in hist:
1465 tx = self.transactions.get(tx_hash)
1467 if not tx.has_address(addr):
1470 # check that we are not "orphaning" a transaction
1471 old_hist = self.history.get(addr,[])
1472 if old_hist == ['*']: return True
1474 for tx_hash, height in old_hist:
1475 if tx_hash in map(lambda x:x[0], hist): continue
1477 for _addr, _hist in self.history.items():
1478 if _addr == addr: continue
1479 if _hist == ['*']: continue
1480 _tx_hist = map(lambda x:x[0], _hist)
1481 if tx_hash in _tx_hist:
1486 tx = self.transactions.get(tx_hash)
1487 # tx might not be there
1491 if self.verifier.get_height(tx_hash):
1494 print_error("new history is orphaning transaction:", tx_hash)
1495 # check that all outputs are not mine, request histories
1497 for _addr, _v in tx.outputs:
1498 # assert not self.is_mine(_addr)
1499 ext_requests.append( ('blockchain.address.get_history', [_addr]) )
1501 ext_h = self.network.synchronous_get(ext_requests)
1502 print_error("sync:", ext_requests, ext_h)
1505 if h == ['*']: continue
1507 if item.get('tx_hash') == tx_hash:
1508 height = item.get('height')
1510 print_error("found height for", tx_hash, height)
1511 self.verifier.add(tx_hash, height)
1513 print_error("removing orphaned tx from history", tx_hash)
1514 self.transactions.pop(tx_hash)
1520 def check_new_tx(self, tx_hash, tx):
1521 # 1 check that tx is referenced in addr_history.
1523 for addr, hist in self.history.items():
1524 if hist == ['*']:continue
1525 for txh, height in hist:
1527 addresses.append(addr)
1532 # 2 check that referencing addresses are in the tx
1533 for addr in addresses:
1534 if not tx.has_address(addr):
1540 def start_threads(self, network):
1541 from verifier import TxVerifier
1542 self.network = network
1544 self.verifier = TxVerifier(self.network, self.storage)
1545 self.verifier.start()
1546 self.set_verifier(self.verifier)
1547 self.synchronizer = WalletSynchronizer(self, network)
1548 self.synchronizer.start()
1550 self.verifier = None
1551 self.synchronizer =None
1553 def stop_threads(self):
1555 self.verifier.stop()
1556 self.synchronizer.stop()
1559 def restore(self, callback):
1561 def wait_for_wallet():
1562 self.set_up_to_date(False)
1563 while not self.is_up_to_date():
1564 msg = "%s\n%s %d\n%s %.1f"%(
1565 _("Please wait..."),
1566 _("Addresses generated:"),
1567 len(self.addresses(True)),
1568 _("Kilobytes received:"),
1569 self.network.interface.bytes_received/1024.)
1571 apply(callback, (msg,))
1574 def wait_for_network():
1575 while not self.network.is_connected():
1576 msg = "%s \n" % (_("Connecting..."))
1577 apply(callback, (msg,))
1580 # wait until we are connected, because the user might have selected another server
1587 self.fill_addressbook()
1592 class WalletSynchronizer(threading.Thread):
1595 def __init__(self, wallet, network):
1596 threading.Thread.__init__(self)
1598 self.wallet = wallet
1599 self.network = network
1600 self.was_updated = True
1601 self.running = False
1602 self.lock = threading.Lock()
1603 self.queue = Queue.Queue()
1606 with self.lock: self.running = False
1608 def is_running(self):
1609 with self.lock: return self.running
1612 def subscribe_to_addresses(self, addresses):
1614 for addr in addresses:
1615 messages.append(('blockchain.address.subscribe', [addr]))
1616 self.network.subscribe( messages, lambda i,r: self.queue.put(r))
1623 while self.is_running():
1625 if not self.network.is_connected():
1626 self.network.wait_until_connected()
1628 self.run_interface(self.network.interface)
1631 def run_interface(self, interface):
1633 print_error("synchronizer: connected to", interface.server)
1637 requested_histories = {}
1639 # request any missing transactions
1640 for history in self.wallet.history.values():
1641 if history == ['*']: continue
1642 for tx_hash, tx_height in history:
1643 if self.wallet.transactions.get(tx_hash) is None and (tx_hash, tx_height) not in missing_tx:
1644 missing_tx.append( (tx_hash, tx_height) )
1647 print_error("missing tx", missing_tx)
1650 self.subscribe_to_addresses(self.wallet.addresses(True))
1652 while self.is_running():
1653 # 1. create new addresses
1654 new_addresses = self.wallet.synchronize()
1656 # request missing addresses
1658 self.subscribe_to_addresses(new_addresses)
1660 # request missing transactions
1661 for tx_hash, tx_height in missing_tx:
1662 if (tx_hash, tx_height) not in requested_tx:
1663 interface.send([ ('blockchain.transaction.get',[tx_hash, tx_height]) ], lambda i,r: self.queue.put(r))
1664 requested_tx.append( (tx_hash, tx_height) )
1667 # detect if situation has changed
1668 if interface.is_up_to_date() and self.queue.empty():
1669 if not self.wallet.is_up_to_date():
1670 self.wallet.set_up_to_date(True)
1671 self.was_updated = True
1673 if self.wallet.is_up_to_date():
1674 self.wallet.set_up_to_date(False)
1675 self.was_updated = True
1677 if self.was_updated:
1678 self.wallet.network.trigger_callback('updated')
1679 self.was_updated = False
1683 r = self.queue.get(block=True, timeout=1)
1687 if interface != self.network.interface:
1693 # 3. handle response
1694 method = r['method']
1695 params = r['params']
1696 result = r.get('result')
1697 error = r.get('error')
1702 if method == 'blockchain.address.subscribe':
1704 if self.wallet.get_status(self.wallet.get_history(addr)) != result:
1705 if requested_histories.get(addr) is None:
1706 interface.send([('blockchain.address.get_history', [addr])], lambda i,r:self.queue.put(r))
1707 requested_histories[addr] = result
1709 elif method == 'blockchain.address.get_history':
1711 print_error("receiving history", addr, result)
1713 assert requested_histories.pop(addr) == '*'
1714 self.wallet.receive_history_callback(addr, result)
1717 # check that txids are unique
1720 tx_hash = item['tx_hash']
1721 if tx_hash not in txids:
1722 txids.append(tx_hash)
1723 hist.append( (tx_hash, item['height']) )
1725 if len(hist) != len(result):
1726 raise Exception("error: server sent history with non-unique txid", result)
1728 # check that the status corresponds to what was announced
1729 rs = requested_histories.pop(addr)
1730 if self.wallet.get_status(hist) != rs:
1731 raise Exception("error: status mismatch: %s"%addr)
1733 # store received history
1734 self.wallet.receive_history_callback(addr, hist)
1736 # request transactions that we don't have
1737 for tx_hash, tx_height in hist:
1738 if self.wallet.transactions.get(tx_hash) is None:
1739 if (tx_hash, tx_height) not in requested_tx and (tx_hash, tx_height) not in missing_tx:
1740 missing_tx.append( (tx_hash, tx_height) )
1742 elif method == 'blockchain.transaction.get':
1744 tx_height = params[1]
1745 assert tx_hash == hash_encode(Hash(result.decode('hex')))
1746 tx = Transaction(result)
1747 self.wallet.receive_tx_callback(tx_hash, tx, tx_height)
1748 self.was_updated = True
1749 requested_tx.remove( (tx_hash, tx_height) )
1750 print_error("received tx:", tx_hash, len(tx.raw))
1753 print_error("Error: Unknown message:" + method + ", " + repr(params) + ", " + repr(result) )
1755 if self.was_updated and not requested_tx:
1756 self.wallet.network.trigger_callback('updated')
1757 self.wallet.network.trigger_callback("new_transaction") # Updated gets called too many times from other places as well; if we use that signal we get the notification three times
1759 self.was_updated = False