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
40 EncodeAES = lambda secret, s: base64.b64encode(aes.encryptData(secret,s))
41 DecodeAES = lambda secret, e: aes.decryptData(secret, base64.b64decode(e))
43 def pw_encode(s, password):
45 secret = Hash(password)
46 return EncodeAES(secret, s)
50 def pw_decode(s, password):
51 if password is not None:
52 secret = Hash(password)
54 d = DecodeAES(secret, s)
56 raise BaseException('Invalid password')
65 from version import ELECTRUM_VERSION, SEED_VERSION
70 def __init__(self, config):
72 self.file_exists = False
73 self.init_path(config)
74 print_error( "wallet path", self.path )
79 def init_path(self, config):
80 """Set the path of the wallet."""
82 path = config.get('wallet_path')
84 path = config.get('default_wallet_path')
89 self.path = os.path.join(config.path, "electrum.dat")
93 """Read the contents of the wallet file."""
95 with open(self.path, "r") as f:
100 d = ast.literal_eval( data ) #parse raw data from reading wallet file
102 raise IOError("Cannot read wallet file.")
105 self.file_exists = True
108 def get(self, key, default=None):
109 return self.data.get(key, default)
111 def put(self, key, value, save = True):
113 if self.data.get(key) is not None:
114 self.data[key] = value
116 # add key to wallet config
117 self.data[key] = value
125 f = open(self.path,"w")
128 if self.get('gui') != 'android':
130 os.chmod(self.path,stat.S_IREAD | stat.S_IWRITE)
135 def __init__(self, storage):
137 self.storage = storage
138 self.electrum_version = ELECTRUM_VERSION
139 self.gap_limit_for_change = 3 # constant
142 self.seed_version = storage.get('seed_version', SEED_VERSION)
144 self.gap_limit = storage.get('gap_limit', 5)
145 self.use_change = storage.get('use_change',True)
146 self.use_encryption = storage.get('use_encryption', False)
147 self.seed = storage.get('seed', '') # encrypted
148 self.labels = storage.get('labels', {})
149 self.frozen_addresses = storage.get('frozen_addresses',[])
150 self.prioritized_addresses = storage.get('prioritized_addresses',[])
151 self.addressbook = storage.get('contacts', [])
153 self.imported_keys = storage.get('imported_keys',{})
154 self.history = storage.get('addr_history',{}) # address -> list(txid, height)
156 self.fee = int(storage.get('fee_per_kb',20000))
158 self.master_public_keys = storage.get('master_public_keys',{})
159 self.master_private_keys = storage.get('master_private_keys', {})
161 self.next_addresses = storage.get('next_addresses',{})
163 if self.seed_version < 4:
164 raise ValueError("This wallet seed is deprecated.")
168 self.transactions = {}
169 tx_list = self.storage.get('transactions',{})
170 for k,v in tx_list.items():
174 print_msg("Warning: Cannot deserialize transactions. skipping")
177 self.add_extra_addresses(tx)
178 self.transactions[k] = tx
180 for h,tx in self.transactions.items():
181 if not self.check_new_tx(h, tx):
182 print_error("removing unreferenced tx", h)
183 self.transactions.pop(h)
187 self.prevout_values = {} # my own transaction outputs
188 self.spent_outputs = []
193 # there is a difference between wallet.up_to_date and interface.is_up_to_date()
194 # interface.is_up_to_date() returns true when all requests have been answered and processed
195 # wallet.up_to_date is true when the wallet is synchronized (stronger requirement)
197 self.up_to_date = False
198 self.lock = threading.Lock()
199 self.transaction_lock = threading.Lock()
200 self.tx_event = threading.Event()
202 for tx_hash, tx in self.transactions.items():
203 self.update_tx_outputs(tx_hash)
206 def add_extra_addresses(self, tx):
208 # find the address corresponding to pay-to-pubkey inputs
209 tx.add_extra_addresses(self.transactions)
210 for o in tx.d.get('outputs'):
211 if o.get('is_pubkey'):
212 for tx2 in self.transactions.values():
213 tx2.add_extra_addresses({h:tx})
218 def set_up_to_date(self,b):
219 with self.lock: self.up_to_date = b
222 def is_up_to_date(self):
223 with self.lock: return self.up_to_date
227 self.up_to_date = False
228 while not self.is_up_to_date():
232 def import_key(self, sec, password):
234 seed = self.decode_seed(password)
236 address = address_from_private_key(sec)
238 raise BaseException('Invalid private key')
240 if self.is_mine(address):
241 raise BaseException('Address already in wallet')
243 # store the originally requested keypair into the imported keys table
244 self.imported_keys[address] = pw_encode(sec, password )
245 self.storage.put('imported_keys', self.imported_keys, True)
246 if self.synchronizer:
247 self.synchronizer.subscribe_to_addresses([address])
250 def delete_imported_key(self, addr):
251 if addr in self.imported_keys:
252 self.imported_keys.pop(addr)
253 self.storage.put('imported_keys', self.imported_keys, True)
256 def init_seed(self, seed):
257 if self.seed: raise BaseException("a seed exists")
259 seed = random_seed(128)
264 self.storage.put('seed', self.seed, True)
265 self.storage.put('seed_version', self.seed_version, True)
267 def create_watching_only_wallet(self, c0, K0):
269 self.master_public_keys = {
270 "m/0'/": (c0, K0, cK0),
272 self.storage.put('master_public_keys', self.master_public_keys, True)
273 self.create_account('1','Main account')
275 def create_accounts(self):
277 master_k, master_c, master_K, master_cK = bip32_init(self.seed)
280 k0, c0, K0, cK0 = bip32_private_derivation(master_k, master_c, "m/", "m/0'/")
282 k1, c1, K1, cK1 = bip32_private_derivation(master_k, master_c, "m/", "m/1'/")
283 k2, c2, K2, cK2 = bip32_private_derivation(master_k, master_c, "m/", "m/2'/")
285 k3, c3, K3, cK3 = bip32_private_derivation(master_k, master_c, "m/", "m/3'/")
286 k4, c4, K4, cK4 = bip32_private_derivation(master_k, master_c, "m/", "m/4'/")
287 k5, c5, K5, cK5 = bip32_private_derivation(master_k, master_c, "m/", "m/5'/")
289 self.master_public_keys = {
290 "m/0'/": (c0, K0, cK0),
291 "m/1'/": (c1, K1, cK1),
292 "m/2'/": (c2, K2, cK2),
293 "m/3'/": (c3, K3, cK3),
294 "m/4'/": (c4, K4, cK4),
295 "m/5'/": (c5, K5, cK5)
298 self.master_private_keys = {
307 self.storage.put('master_public_keys', self.master_public_keys, True)
308 self.storage.put('master_private_keys', self.master_private_keys, True)
310 # create default account
311 self.create_account('1','Main account')
314 def find_root_by_master_key(self, c, K):
315 for key, v in self.master_public_keys.items():
316 if key == "m/":continue
318 if (c == cc) and (K == KK):
321 def deseed_root(self, seed, password):
322 # for safety, we ask the user to enter their seed
323 assert seed == self.decode_seed(password)
325 self.storage.put('seed', '', True)
328 def deseed_branch(self, k):
329 # check that parent has no seed
330 assert self.seed == ''
331 self.master_private_keys.pop(k)
332 self.storage.put('master_private_keys', self.master_private_keys, True)
335 def account_id(self, account_type, i):
336 if account_type == '1':
338 elif account_type == '2of2':
339 return "m/1'/%d & m/2'/%d"%(i,i)
340 elif account_type == '2of3':
341 return "m/3'/%d & m/4'/%d & m/5'/%d"%(i,i,i)
343 raise BaseException('unknown account type')
346 def num_accounts(self, account_type):
347 keys = self.accounts.keys()
350 account_id = self.account_id(account_type, i)
351 if account_id not in keys: break
356 def new_account_address(self, account_type = '1'):
357 i = self.num_accounts(account_type)
358 k = self.account_id(account_type,i)
360 addr = self.next_addresses.get(k)
362 account_id, account = self.next_account(account_type)
363 addr = account.first_address()
364 self.next_addresses[k] = addr
365 self.storage.put('next_addresses',self.next_addresses)
370 def next_account(self, account_type = '1'):
372 i = self.num_accounts(account_type)
373 account_id = self.account_id(account_type,i)
375 if account_type is '1':
376 master_c0, master_K0, _ = self.master_public_keys["m/0'/"]
377 c0, K0, cK0 = bip32_public_derivation(master_c0.decode('hex'), master_K0.decode('hex'), "m/0'/", "m/0'/%d"%i)
378 account = BIP32_Account({ 'c':c0, 'K':K0, 'cK':cK0 })
380 elif account_type == '2of2':
381 master_c1, master_K1, _ = self.master_public_keys["m/1'/"]
382 c1, K1, cK1 = bip32_public_derivation(master_c1.decode('hex'), master_K1.decode('hex'), "m/1'/", "m/1'/%d"%i)
383 master_c2, master_K2, _ = self.master_public_keys["m/2'/"]
384 c2, K2, cK2 = bip32_public_derivation(master_c2.decode('hex'), master_K2.decode('hex'), "m/2'/", "m/2'/%d"%i)
385 account = BIP32_Account_2of2({ 'c':c1, 'K':K1, 'cK':cK1, 'c2':c2, 'K2':K2, 'cK2':cK2 })
387 elif account_type == '2of3':
388 master_c3, master_K3, _ = self.master_public_keys["m/3'/"]
389 c3, K3, cK3 = bip32_public_derivation(master_c3.decode('hex'), master_K3.decode('hex'), "m/3'/", "m/3'/%d"%i)
390 master_c4, master_K4, _ = self.master_public_keys["m/4'/"]
391 c4, K4, cK4 = bip32_public_derivation(master_c4.decode('hex'), master_K4.decode('hex'), "m/4'/", "m/4'/%d"%i)
392 master_c5, master_K5, _ = self.master_public_keys["m/5'/"]
393 c5, K5, cK5 = bip32_public_derivation(master_c5.decode('hex'), master_K5.decode('hex'), "m/5'/", "m/5'/%d"%i)
394 account = BIP32_Account_2of3({ 'c':c3, 'K':K3, 'cK':cK3, 'c2':c4, 'K2':K4, 'cK2':cK4, 'c3':c5, 'K3':K5, 'cK3':cK5 })
396 return account_id, account
399 def set_label(self, name, text = None):
401 old_text = self.labels.get(name)
404 self.labels[name] = text
408 self.labels.pop(name)
412 self.storage.put('labels', self.labels, True)
414 run_hook('set_label', name, text, changed)
419 def create_account(self, account_type = '1', name = None):
420 account_id, account = self.next_account(account_type)
421 self.accounts[account_id] = account
424 self.set_label(account_id, name)
427 def create_old_account(self):
428 mpk = OldAccount.mpk_from_seed(self.seed)
429 self.storage.put('master_public_key', mpk, True)
430 self.accounts[0] = OldAccount({'mpk':mpk, 0:[], 1:[]})
434 def save_accounts(self):
436 for k, v in self.accounts.items():
438 self.storage.put('accounts', d, True)
442 def load_accounts(self):
443 d = self.storage.get('accounts', {})
445 for k, v in d.items():
447 v['mpk'] = self.storage.get('master_public_key')
448 self.accounts[k] = OldAccount(v)
450 self.accounts[k] = BIP32_Account_2of2(v)
452 self.accounts[k] = BIP32_Account(v)
455 def addresses(self, include_change = True, next=False):
456 o = self.get_account_addresses(-1, include_change)
457 for a in self.accounts.keys():
458 o += self.get_account_addresses(a, include_change)
461 for addr in self.next_addresses.values():
467 def is_mine(self, address):
468 return address in self.addresses(True)
471 def is_change(self, address):
472 if not self.is_mine(address): return False
473 if address in self.imported_keys.keys(): return False
474 acct, s = self.get_address_index(address)
475 if s is None: return False
478 def get_master_public_key(self):
479 if self.seed_version == 4:
480 return self.storage.get("master_public_key")
482 c, K, cK = self.storage.get("master_public_keys")["m/0'/"]
485 def get_master_private_key(self, account, password):
486 master_k = pw_decode( self.master_private_keys[account], password)
487 master_c, master_K, master_Kc = self.master_public_keys[account]
489 K, Kc = get_pubkeys_from_secret(master_k.decode('hex'))
490 assert K.encode('hex') == master_K
492 raise BaseException("Invalid password")
496 def get_address_index(self, address):
497 if address in self.imported_keys.keys():
500 for account in self.accounts.keys():
501 for for_change in [0,1]:
502 addresses = self.accounts[account].get_addresses(for_change)
503 for addr in addresses:
505 return account, (for_change, addresses.index(addr))
507 raise BaseException("Address not found", address)
510 def get_roots(self, account):
512 for a in account.split('&'):
514 m = re.match("(m/\d+'/)(\d+)", s)
515 roots.append( m.group(1) )
518 def is_seeded(self, account):
519 if type(account) is int:
520 return self.seed is not None
522 for root in self.get_roots(account):
523 if root not in self.master_private_keys.keys():
527 def rebase_sequence(self, account, sequence):
530 for a in account.split('&'):
532 m = re.match("(m/\d+'/)(\d+)", s)
534 num = int(m.group(2))
535 dd.append( (root, [num,c,i] ) )
539 def get_keyID(self, account, sequence):
543 rs = self.rebase_sequence(account, sequence)
545 for root, public_sequence in rs:
546 c, K, _ = self.master_public_keys[root]
547 s = '/' + '/'.join( map(lambda x:str(x), public_sequence) )
548 dd.append( 'bip32(%s,%s,%s)'%(c,K, s) )
552 def get_public_key(self, address):
553 account, sequence = self.get_address_index(address)
554 return self.accounts[account].get_pubkey( *sequence )
557 def decode_seed(self, password):
558 seed = pw_decode(self.seed, password)
559 #todo: #self.sequences[0].check_seed(seed)
563 def get_private_key(self, address, password):
565 if address in self.imported_keys.keys():
566 out.append( pw_decode( self.imported_keys[address], password ) )
568 account, sequence = self.get_address_index(address)
570 seed = self.decode_seed(password)
571 pk = self.accounts[account].get_private_key(seed, sequence)
575 # assert address == self.accounts[account].get_address(*sequence)
576 rs = self.rebase_sequence( account, sequence)
577 for root, public_sequence in rs:
579 if root not in self.master_private_keys.keys(): continue
580 master_k = self.get_master_private_key(root, password)
581 master_c, _, _ = self.master_public_keys[root]
582 pk = bip32_private_key( public_sequence, master_k.decode('hex'), master_c.decode('hex'))
588 def add_keypairs_from_wallet(self, tx, keypairs, password):
589 for txin in tx.inputs:
590 address = txin['address']
591 private_keys = self.get_private_key(address, password)
592 for sec in private_keys:
593 pubkey = public_key_from_private_key(sec)
594 keypairs[ pubkey ] = sec
597 def add_keypairs_from_KeyID(self, tx, keypairs, password):
598 for txin in tx.inputs:
599 keyid = txin.get('KeyID')
602 for s in keyid.split('&'):
603 m = re.match("bip32\(([0-9a-f]+),([0-9a-f]+),(/\d+/\d+/\d+)", s)
607 sequence = m.group(3)
608 root = self.find_root_by_master_key(c,K)
609 if not root: continue
610 sequence = map(lambda x:int(x), sequence.strip('/').split('/'))
611 root = root + '%d'%sequence[0]
612 sequence = sequence[1:]
613 roots.append((root,sequence))
615 account_id = " & ".join( map(lambda x:x[0], roots) )
616 account = self.accounts.get(account_id)
617 if not account: continue
618 addr = account.get_address(*sequence)
619 txin['address'] = addr # fixme: side effect
620 pk = self.get_private_key(addr, password)
622 pubkey = public_key_from_private_key(sec)
623 keypairs[pubkey] = sec
627 def signrawtransaction(self, tx, input_info, private_keys, password):
629 # check that the password is correct
630 seed = self.decode_seed(password)
633 tx.add_input_info(input_info)
635 # add redeem script for coins that are in the wallet
636 # FIXME: add redeemPubkey too!
637 unspent_coins = self.get_unspent_coins()
638 for txin in tx.inputs:
639 for item in unspent_coins:
640 if txin['prevout_hash'] == item['prevout_hash'] and txin['prevout_n'] == item['prevout_n']:
641 print_error( "tx input is in unspent coins" )
642 txin['scriptPubKey'] = item['scriptPubKey']
643 account, sequence = self.get_address_index(item['address'])
645 txin['redeemScript'] = self.accounts[account].redeem_script(sequence)
646 print_error("added redeemScript", txin['redeemScript'])
650 # build a list of public/private keys
653 # add private keys from parameter
654 for sec in private_keys:
655 pubkey = public_key_from_private_key(sec)
656 keypairs[ pubkey ] = sec
658 # add private_keys from KeyID
659 self.add_keypairs_from_KeyID(tx, keypairs, password)
661 # add private keys from wallet
662 self.add_keypairs_from_wallet(tx, keypairs, password)
663 self.sign_transaction(tx, keypairs)
666 def sign_message(self, address, message, password):
667 keys = self.get_private_key(address, password)
668 assert len(keys) == 1
670 key = regenerate_key(sec)
671 compressed = is_compressed(sec)
672 return key.sign_message(message, compressed, address)
674 def verify_message(self, address, signature, message):
676 EC_KEY.verify_message(address, signature, message)
678 except BaseException as e:
679 print_error("Verification error: {0}".format(e))
683 def change_gap_limit(self, value):
684 if value >= self.gap_limit:
685 self.gap_limit = value
686 self.storage.put('gap_limit', self.gap_limit, True)
687 #self.interface.poke('synchronizer')
690 elif value >= self.min_acceptable_gap():
691 for key, account in self.accounts.items():
692 addresses = account[0]
693 k = self.num_unused_trailing_addresses(addresses)
694 n = len(addresses) - k + value
695 addresses = addresses[0:n]
696 self.accounts[key][0] = addresses
698 self.gap_limit = value
699 self.storage.put('gap_limit', self.gap_limit, True)
705 def num_unused_trailing_addresses(self, addresses):
707 for a in addresses[::-1]:
708 if self.history.get(a):break
712 def min_acceptable_gap(self):
713 # fixme: this assumes wallet is synchronized
717 for account in self.accounts.values():
718 addresses = account.get_addresses(0)
719 k = self.num_unused_trailing_addresses(addresses)
720 for a in addresses[0:-k]:
721 if self.history.get(a):
725 if n > nmax: nmax = n
729 def address_is_old(self, address):
731 h = self.history.get(address, [])
734 for tx_hash, tx_height in h:
738 tx_age = self.verifier.blockchain.height - tx_height + 1
744 def synchronize_sequence(self, account, for_change):
745 limit = self.gap_limit_for_change if for_change else self.gap_limit
748 addresses = account.get_addresses(for_change)
749 if len(addresses) < limit:
750 address = account.create_new_address(for_change)
751 self.history[address] = []
752 new_addresses.append( address )
755 if map( lambda a: self.address_is_old(a), addresses[-limit:] ) == limit*[False]:
758 address = account.create_new_address(for_change)
759 self.history[address] = []
760 new_addresses.append( address )
766 def create_pending_accounts(self):
767 for account_type in ['1','2of2','2of3']:
768 a = self.new_account_address(account_type)
769 if self.address_is_old(a):
770 print_error( "creating account", a )
771 self.create_account(account_type)
774 def synchronize_account(self, account):
776 new += self.synchronize_sequence(account, 0)
777 new += self.synchronize_sequence(account, 1)
781 def synchronize(self):
782 if self.master_public_keys:
783 self.create_pending_accounts()
785 for account in self.accounts.values():
786 new += self.synchronize_account(account)
789 self.storage.put('addr_history', self.history, True)
794 return self.history.values() != [[]] * len(self.history)
797 def add_contact(self, address, label=None):
798 self.addressbook.append(address)
799 self.storage.put('contacts', self.addressbook, True)
801 self.set_label(address, label)
804 def delete_contact(self, addr):
805 if addr in self.addressbook:
806 self.addressbook.remove(addr)
807 self.storage.put('addressbook', self.addressbook, True)
810 def fill_addressbook(self):
811 for tx_hash, tx in self.transactions.items():
812 is_relevant, is_send, _, _ = self.get_tx_value(tx)
814 for addr, v in tx.outputs:
815 if not self.is_mine(addr) and addr not in self.addressbook:
816 self.addressbook.append(addr)
818 # self.update_tx_labels()
820 def get_num_tx(self, address):
822 for tx in self.transactions.values():
823 if address in map(lambda x:x[0], tx.outputs): n += 1
827 def get_address_flags(self, addr):
828 flags = "C" if self.is_change(addr) else "I" if addr in self.imported_keys.keys() else "-"
829 flags += "F" if addr in self.frozen_addresses else "P" if addr in self.prioritized_addresses else "-"
833 def get_tx_value(self, tx, account=None):
834 domain = self.get_account_addresses(account)
835 return tx.get_value(domain, self.prevout_values)
838 def update_tx_outputs(self, tx_hash):
839 tx = self.transactions.get(tx_hash)
841 for i, (addr, value) in enumerate(tx.outputs):
842 key = tx_hash+ ':%d'%i
843 self.prevout_values[key] = value
845 for item in tx.inputs:
846 if self.is_mine(item.get('address')):
847 key = item['prevout_hash'] + ':%d'%item['prevout_n']
848 self.spent_outputs.append(key)
851 def get_addr_balance(self, address):
852 assert self.is_mine(address)
853 h = self.history.get(address,[])
854 if h == ['*']: return 0,0
856 received_coins = [] # list of coins received at address
858 for tx_hash, tx_height in h:
859 tx = self.transactions.get(tx_hash)
862 for i, (addr, value) in enumerate(tx.outputs):
864 key = tx_hash + ':%d'%i
865 received_coins.append(key)
867 for tx_hash, tx_height in h:
868 tx = self.transactions.get(tx_hash)
872 for item in tx.inputs:
873 addr = item.get('address')
875 key = item['prevout_hash'] + ':%d'%item['prevout_n']
876 value = self.prevout_values.get( key )
877 if key in received_coins:
880 for i, (addr, value) in enumerate(tx.outputs):
881 key = tx_hash + ':%d'%i
892 def get_account_name(self, k):
894 if self.seed_version == 4:
895 name = 'Main account'
899 name = self.labels.get(k, 'Unnamed account')
902 def get_account_names(self):
904 for k, account in self.accounts.items():
905 accounts[k] = self.get_account_name(k)
906 if self.imported_keys:
907 accounts[-1] = 'Imported keys'
910 def get_account_addresses(self, a, include_change=True):
912 o = self.addresses(True)
914 o = self.imported_keys.keys()
916 ac = self.accounts[a]
917 o = ac.get_addresses(0)
918 if include_change: o += ac.get_addresses(1)
921 def get_imported_balance(self):
923 for addr in self.imported_keys.keys():
924 c, u = self.get_addr_balance(addr)
929 def get_account_balance(self, account):
931 return self.get_balance()
933 return self.get_imported_balance()
936 for addr in self.get_account_addresses(account):
937 c, u = self.get_addr_balance(addr)
942 def get_frozen_balance(self):
944 for addr in self.frozen_addresses:
945 c, u = self.get_addr_balance(addr)
951 def get_balance(self):
953 for a in self.accounts.keys():
954 c, u = self.get_account_balance(a)
957 c, u = self.get_imported_balance()
963 def get_unspent_coins(self, domain=None):
965 if domain is None: domain = self.addresses(True)
967 h = self.history.get(addr, [])
968 if h == ['*']: continue
969 for tx_hash, tx_height in h:
970 tx = self.transactions.get(tx_hash)
971 if tx is None: raise BaseException("Wallet not synchronized")
972 for output in tx.d.get('outputs'):
973 if output.get('address') != addr: continue
974 key = tx_hash + ":%d" % output.get('prevout_n')
975 if key in self.spent_outputs: continue
976 output['prevout_hash'] = tx_hash
977 output['height'] = tx_height
978 coins.append((tx_height, output))
982 coins = sorted(coins)
983 if coins[-1][0] != 0:
984 while coins[0][0] == 0:
985 coins = coins[1:] + [ coins[0] ]
986 return [x[1] for x in coins]
990 def choose_tx_inputs( self, amount, fixed_fee, domain = None ):
991 """ todo: minimize tx size """
993 fee = self.fee if fixed_fee is None else fixed_fee
995 domain = self.addresses()
997 for i in self.frozen_addresses:
998 if i in domain: domain.remove(i)
1001 for i in self.prioritized_addresses:
1004 prioritized.append(i)
1006 coins = self.get_unspent_coins(domain)
1007 prioritized_coins = self.get_unspent_coins(prioritized)
1010 coins = prioritized_coins + coins
1013 addr = item.get('address')
1014 v = item.get('value')
1017 fee = self.estimated_fee(inputs) if fixed_fee is None else fixed_fee
1018 if total >= amount + fee: break
1022 return inputs, total, fee
1025 def set_fee(self, fee):
1028 self.storage.put('fee_per_kb', self.fee, True)
1030 def estimated_fee(self, inputs):
1031 estimated_size = len(inputs) * 180 + 80 # this assumes non-compressed keys
1032 fee = self.fee * int(round(estimated_size/1024.))
1033 if fee == 0: fee = self.fee
1037 def add_tx_change( self, inputs, outputs, amount, fee, total, change_addr=None):
1038 "add change to a transaction"
1039 change_amount = total - ( amount + fee )
1040 if change_amount != 0:
1043 # send change to one of the accounts involved in the tx
1044 address = inputs[0].get('address')
1045 account, _ = self.get_address_index(address)
1047 if not self.use_change or account == -1:
1048 change_addr = inputs[-1]['address']
1050 change_addr = self.accounts[account].get_addresses(1)[-self.gap_limit_for_change]
1052 # Insert the change output at a random position in the outputs
1053 posn = random.randint(0, len(outputs))
1054 outputs[posn:posn] = [( change_addr, change_amount)]
1058 def get_history(self, address):
1060 return self.history.get(address)
1063 def get_status(self, h):
1064 if not h: return None
1065 if h == ['*']: return '*'
1067 for tx_hash, height in h:
1068 status += tx_hash + ':%d:' % height
1069 return hashlib.sha256( status ).digest().encode('hex')
1072 def receive_tx_callback(self, tx_hash, tx, tx_height):
1074 with self.transaction_lock:
1075 self.add_extra_addresses(tx)
1076 if not self.check_new_tx(tx_hash, tx):
1077 # may happen due to pruning
1078 print_error("received transaction that is no longer referenced in history", tx_hash)
1080 self.transactions[tx_hash] = tx
1081 self.network.interface.pending_transactions_for_notifications.append(tx)
1082 self.save_transactions()
1083 if self.verifier and tx_height>0:
1084 self.verifier.add(tx_hash, tx_height)
1085 self.update_tx_outputs(tx_hash)
1088 def save_transactions(self):
1090 for k,v in self.transactions.items():
1092 self.storage.put('transactions', tx, True)
1094 def receive_history_callback(self, addr, hist):
1096 if not self.check_new_history(addr, hist):
1097 raise BaseException("error: received history for %s is not consistent with known transactions"%addr)
1100 self.history[addr] = hist
1101 self.storage.put('addr_history', self.history, True)
1104 for tx_hash, tx_height in hist:
1106 # add it in case it was previously unconfirmed
1107 if self.verifier: self.verifier.add(tx_hash, tx_height)
1110 def get_tx_history(self, account=None):
1111 with self.transaction_lock:
1112 history = self.transactions.items()
1113 history.sort(key = lambda x: self.verifier.get_txpos(x[0]))
1117 for tx_hash, tx in history:
1118 is_relevant, is_mine, v, fee = self.get_tx_value(tx, account)
1119 if v is not None: balance += v
1121 c, u = self.get_account_balance(account)
1124 result.append( ('', 1000, 0, c+u-balance, None, c+u-balance, None ) )
1126 balance = c + u - balance
1127 for tx_hash, tx in history:
1128 is_relevant, is_mine, value, fee = self.get_tx_value(tx, account)
1131 if value is not None:
1134 conf, timestamp = self.verifier.get_confirmations(tx_hash) if self.verifier else (None, None)
1135 result.append( (tx_hash, conf, is_mine, value, fee, balance, timestamp) )
1140 def get_label(self, tx_hash):
1141 label = self.labels.get(tx_hash)
1142 is_default = (label == '') or (label is None)
1143 if is_default: label = self.get_default_label(tx_hash)
1144 return label, is_default
1147 def get_default_label(self, tx_hash):
1148 tx = self.transactions.get(tx_hash)
1151 is_relevant, is_mine, _, _ = self.get_tx_value(tx)
1153 for o in tx.outputs:
1155 if not self.is_mine(o_addr):
1157 default_label = self.labels[o_addr]
1159 default_label = o_addr
1162 default_label = '(internal)'
1164 for o in tx.outputs:
1166 if self.is_mine(o_addr) and not self.is_change(o_addr):
1169 for o in tx.outputs:
1171 if self.is_mine(o_addr):
1177 dest_label = self.labels.get(o_addr)
1179 default_label = self.labels[o_addr]
1181 default_label = o_addr
1183 return default_label
1186 def make_unsigned_transaction(self, outputs, fee=None, change_addr=None, domain=None ):
1187 for address, x in outputs:
1188 assert is_valid(address)
1189 amount = sum( map(lambda x:x[1], outputs) )
1190 inputs, total, fee = self.choose_tx_inputs( amount, fee, domain )
1192 raise ValueError("Not enough funds")
1193 self.add_input_info(inputs)
1194 outputs = self.add_tx_change(inputs, outputs, amount, fee, total, change_addr)
1195 return Transaction.from_io(inputs, outputs)
1198 def mktx_from_account(self, outputs, password, fee=None, change_addr=None, account=None):
1199 domain = self.get_account_addresses(account) if account else None
1200 return self.mktx(outputs, password, fee, change_addr, domain)
1203 def mktx(self, outputs, password, fee=None, change_addr=None, domain= None ):
1204 tx = self.make_unsigned_transaction(outputs, fee, change_addr, domain)
1206 self.add_keypairs_from_wallet(tx, keypairs, password)
1207 self.sign_transaction(tx, keypairs)
1211 def add_input_info(self, inputs):
1213 address = txin['address']
1214 account, sequence = self.get_address_index(address)
1215 txin['KeyID'] = self.get_keyID(account, sequence)
1216 redeemScript = self.accounts[account].redeem_script(sequence)
1218 txin['redeemScript'] = redeemScript
1220 txin['redeemPubkey'] = self.accounts[account].get_pubkey(*sequence)
1223 def sign_transaction(self, tx, keypairs):
1225 run_hook('sign_transaction', tx)
1228 def sendtx(self, tx):
1230 h = self.send_tx(tx)
1231 self.tx_event.wait()
1232 return self.receive_tx(h)
1234 def send_tx(self, tx):
1236 self.tx_event.clear()
1237 self.network.interface.send([('blockchain.transaction.broadcast', [str(tx)])], self.on_broadcast)
1240 def on_broadcast(self, i, r):
1241 self.tx_result = r.get('result')
1244 def receive_tx(self,tx_hash):
1245 out = self.tx_result
1247 return False, "error: " + out
1252 def update_password(self, seed, old_password, new_password):
1253 if new_password == '': new_password = None
1254 # this will throw an exception if unicode cannot be converted
1255 self.seed = pw_encode( seed, new_password)
1256 self.storage.put('seed', self.seed, True)
1257 self.use_encryption = (new_password != None)
1258 self.storage.put('use_encryption', self.use_encryption,True)
1259 for k in self.imported_keys.keys():
1260 a = self.imported_keys[k]
1261 b = pw_decode(a, old_password)
1262 c = pw_encode(b, new_password)
1263 self.imported_keys[k] = c
1264 self.storage.put('imported_keys', self.imported_keys, True)
1266 for k, v in self.master_private_keys.items():
1267 b = pw_decode(v, old_password)
1268 c = pw_encode(b, new_password)
1269 self.master_private_keys[k] = c
1270 self.storage.put('master_private_keys', self.master_private_keys, True)
1273 def freeze(self,addr):
1274 if self.is_mine(addr) and addr not in self.frozen_addresses:
1275 self.unprioritize(addr)
1276 self.frozen_addresses.append(addr)
1277 self.storage.put('frozen_addresses', self.frozen_addresses, True)
1282 def unfreeze(self,addr):
1283 if self.is_mine(addr) and addr in self.frozen_addresses:
1284 self.frozen_addresses.remove(addr)
1285 self.storage.put('frozen_addresses', self.frozen_addresses, True)
1290 def prioritize(self,addr):
1291 if self.is_mine(addr) and addr not in self.prioritized_addresses:
1293 self.prioritized_addresses.append(addr)
1294 self.storage.put('prioritized_addresses', self.prioritized_addresses, True)
1299 def unprioritize(self,addr):
1300 if self.is_mine(addr) and addr in self.prioritized_addresses:
1301 self.prioritized_addresses.remove(addr)
1302 self.storage.put('prioritized_addresses', self.prioritized_addresses, True)
1308 def set_verifier(self, verifier):
1309 self.verifier = verifier
1311 # review transactions that are in the history
1312 for addr, hist in self.history.items():
1313 if hist == ['*']: continue
1314 for tx_hash, tx_height in hist:
1316 # add it in case it was previously unconfirmed
1317 self.verifier.add(tx_hash, tx_height)
1320 # if we are on a pruning server, remove unverified transactions
1321 vr = self.verifier.transactions.keys() + self.verifier.verified_tx.keys()
1322 for tx_hash in self.transactions.keys():
1323 if tx_hash not in vr:
1324 self.transactions.pop(tx_hash)
1328 def check_new_history(self, addr, hist):
1330 # check that all tx in hist are relevant
1332 for tx_hash, height in hist:
1333 tx = self.transactions.get(tx_hash)
1335 if not tx.has_address(addr):
1338 # check that we are not "orphaning" a transaction
1339 old_hist = self.history.get(addr,[])
1340 if old_hist == ['*']: return True
1342 for tx_hash, height in old_hist:
1343 if tx_hash in map(lambda x:x[0], hist): continue
1345 for _addr, _hist in self.history.items():
1346 if _addr == addr: continue
1347 if _hist == ['*']: continue
1348 _tx_hist = map(lambda x:x[0], _hist)
1349 if tx_hash in _tx_hist:
1354 tx = self.transactions.get(tx_hash)
1355 # tx might not be there
1359 if self.verifier.get_height(tx_hash):
1362 print_error("new history is orphaning transaction:", tx_hash)
1363 # check that all outputs are not mine, request histories
1365 for _addr, _v in tx.outputs:
1366 # assert not self.is_mine(_addr)
1367 ext_requests.append( ('blockchain.address.get_history', [_addr]) )
1369 ext_h = self.network.interface.synchronous_get(ext_requests)
1370 print_error("sync:", ext_requests, ext_h)
1373 if h == ['*']: continue
1375 if item.get('tx_hash') == tx_hash:
1376 height = item.get('height')
1378 print_error("found height for", tx_hash, height)
1379 self.verifier.add(tx_hash, height)
1381 print_error("removing orphaned tx from history", tx_hash)
1382 self.transactions.pop(tx_hash)
1388 def check_new_tx(self, tx_hash, tx):
1389 # 1 check that tx is referenced in addr_history.
1391 for addr, hist in self.history.items():
1392 if hist == ['*']:continue
1393 for txh, height in hist:
1395 addresses.append(addr)
1400 # 2 check that referencing addresses are in the tx
1401 for addr in addresses:
1402 if not tx.has_address(addr):
1408 def start_threads(self, network):
1409 from verifier import TxVerifier
1410 self.network = network
1411 self.verifier = TxVerifier(self.network, self.storage)
1412 self.verifier.start()
1413 self.set_verifier(self.verifier)
1414 self.synchronizer = WalletSynchronizer(self)
1415 self.synchronizer.start()
1417 def stop_threads(self):
1418 self.verifier.stop()
1419 self.synchronizer.stop()
1423 def restore(self, callback):
1425 def wait_for_wallet():
1426 self.set_up_to_date(False)
1427 while not self.is_up_to_date():
1428 msg = "%s\n%s %d\n%s %.1f"%(
1429 _("Please wait..."),
1430 _("Addresses generated:"),
1431 len(self.addresses(True)),_("Kilobytes received:"),
1432 self.network.interface.bytes_received/1024.)
1434 apply(callback, (msg,))
1437 def wait_for_network():
1438 while not self.network.interface.is_connected:
1439 msg = "%s \n" % (_("Connecting..."))
1440 apply(callback, (msg,))
1443 # wait until we are connected, because the user might have selected another server
1446 # try to restore old account
1447 self.create_old_account()
1451 self.seed_version = 4
1452 self.storage.put('seed_version', wallet.seed_version, True)
1454 self.accounts.pop(0)
1455 self.create_accounts()
1461 class WalletSynchronizer(threading.Thread):
1464 def __init__(self, wallet):
1465 threading.Thread.__init__(self)
1467 self.wallet = wallet
1468 wallet.synchronizer = self
1469 self.network = self.wallet.network
1470 #self.wallet.network.register_callback('connected', lambda: self.wallet.set_up_to_date(False))
1471 self.was_updated = True
1472 self.running = False
1473 self.lock = threading.Lock()
1474 self.queue = Queue.Queue()
1477 with self.lock: self.running = False
1479 def is_running(self):
1480 with self.lock: return self.running
1483 def subscribe_to_addresses(self, addresses):
1485 for addr in addresses:
1486 messages.append(('blockchain.address.subscribe', [addr]))
1487 self.network.interface.send( messages, lambda i,r: self.queue.put(r))
1494 while self.is_running():
1495 interface = self.network.interface
1496 if not interface.is_connected:
1497 print_error("synchronizer: waiting for interface")
1498 interface.connect_event.wait()
1500 self.run_interface(interface)
1503 def run_interface(self, interface):
1505 print_error("synchronizer: connected to", interface.server)
1509 requested_histories = {}
1511 # request any missing transactions
1512 for history in self.wallet.history.values():
1513 if history == ['*']: continue
1514 for tx_hash, tx_height in history:
1515 if self.wallet.transactions.get(tx_hash) is None and (tx_hash, tx_height) not in missing_tx:
1516 missing_tx.append( (tx_hash, tx_height) )
1519 print_error("missing tx", missing_tx)
1522 self.subscribe_to_addresses(self.wallet.addresses(True, next=True))
1524 while self.is_running():
1525 # 1. create new addresses
1526 new_addresses = self.wallet.synchronize()
1528 # request missing addresses
1530 self.subscribe_to_addresses(new_addresses)
1532 # request missing transactions
1533 for tx_hash, tx_height in missing_tx:
1534 if (tx_hash, tx_height) not in requested_tx:
1535 interface.send([ ('blockchain.transaction.get',[tx_hash, tx_height]) ], lambda i,r: self.queue.put(r))
1536 requested_tx.append( (tx_hash, tx_height) )
1539 # detect if situation has changed
1540 if interface.is_up_to_date() and self.queue.empty():
1541 if not self.wallet.is_up_to_date():
1542 self.wallet.set_up_to_date(True)
1543 self.was_updated = True
1545 if self.wallet.is_up_to_date():
1546 self.wallet.set_up_to_date(False)
1547 self.was_updated = True
1549 if self.was_updated:
1550 self.wallet.network.trigger_callback('updated')
1551 self.was_updated = False
1555 r = self.queue.get(block=True, timeout=1)
1559 if interface != self.network.interface:
1565 # 3. handle response
1566 method = r['method']
1567 params = r['params']
1568 result = r.get('result')
1569 error = r.get('error')
1574 if method == 'blockchain.address.subscribe':
1576 if self.wallet.get_status(self.wallet.get_history(addr)) != result:
1577 if requested_histories.get(addr) is None:
1578 interface.send([('blockchain.address.get_history', [addr])], lambda i,r:self.queue.put(r))
1579 requested_histories[addr] = result
1581 elif method == 'blockchain.address.get_history':
1583 print_error("receiving history", addr, result)
1585 assert requested_histories.pop(addr) == '*'
1586 self.wallet.receive_history_callback(addr, result)
1589 # check that txids are unique
1592 tx_hash = item['tx_hash']
1593 if tx_hash not in txids:
1594 txids.append(tx_hash)
1595 hist.append( (tx_hash, item['height']) )
1597 if len(hist) != len(result):
1598 raise BaseException("error: server sent history with non-unique txid", result)
1600 # check that the status corresponds to what was announced
1601 rs = requested_histories.pop(addr)
1602 if self.wallet.get_status(hist) != rs:
1603 raise BaseException("error: status mismatch: %s"%addr)
1605 # store received history
1606 self.wallet.receive_history_callback(addr, hist)
1608 # request transactions that we don't have
1609 for tx_hash, tx_height in hist:
1610 if self.wallet.transactions.get(tx_hash) is None:
1611 if (tx_hash, tx_height) not in requested_tx and (tx_hash, tx_height) not in missing_tx:
1612 missing_tx.append( (tx_hash, tx_height) )
1614 elif method == 'blockchain.transaction.get':
1616 tx_height = params[1]
1617 assert tx_hash == hash_encode(Hash(result.decode('hex')))
1618 tx = Transaction(result)
1619 self.wallet.receive_tx_callback(tx_hash, tx, tx_height)
1620 self.was_updated = True
1621 requested_tx.remove( (tx_hash, tx_height) )
1622 print_error("received tx:", tx_hash, len(tx.raw))
1625 print_error("Error: Unknown message:" + method + ", " + repr(params) + ", " + repr(result) )
1627 if self.was_updated and not requested_tx:
1628 self.wallet.network.trigger_callback('updated')
1629 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
1631 self.was_updated = False