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
39 EncodeAES = lambda secret, s: base64.b64encode(aes.encryptData(secret,s))
40 DecodeAES = lambda secret, e: aes.decryptData(secret, base64.b64decode(e))
42 def pw_encode(s, password):
44 secret = Hash(password)
45 return EncodeAES(secret, s)
49 def pw_decode(s, password):
50 if password is not None:
51 secret = Hash(password)
53 d = DecodeAES(secret, s)
55 raise BaseException('Invalid password')
64 from version import ELECTRUM_VERSION, SEED_VERSION
69 def __init__(self, config):
71 self.file_exists = False
72 self.init_path(config)
73 print_error( "wallet path", self.path )
78 def init_path(self, config):
79 """Set the path of the wallet."""
81 path = config.get('wallet_path')
83 path = config.get('default_wallet_path')
88 self.path = os.path.join(config.path, "electrum.dat")
92 """Read the contents of the wallet file."""
94 with open(self.path, "r") as f:
99 d = ast.literal_eval( data ) #parse raw data from reading wallet file
101 raise IOError("Cannot read wallet file.")
104 self.file_exists = True
107 def get(self, key, default=None):
108 return self.data.get(key, default)
110 def put(self, key, value, save = True):
112 if self.data.get(key) is not None:
113 self.data[key] = value
115 # add key to wallet config
116 self.data[key] = value
124 f = open(self.path,"w")
127 if self.get('gui') != 'android':
129 os.chmod(self.path,stat.S_IREAD | stat.S_IWRITE)
134 def __init__(self, storage):
136 self.storage = storage
137 self.electrum_version = ELECTRUM_VERSION
138 self.gap_limit_for_change = 3 # constant
141 self.seed_version = storage.get('seed_version', SEED_VERSION)
143 self.gap_limit = storage.get('gap_limit', 5)
144 self.use_change = storage.get('use_change',True)
145 self.use_encryption = storage.get('use_encryption', False)
146 self.seed = storage.get('seed', '') # encrypted
147 self.labels = storage.get('labels', {})
148 self.frozen_addresses = storage.get('frozen_addresses',[])
149 self.prioritized_addresses = storage.get('prioritized_addresses',[])
150 self.addressbook = storage.get('contacts', [])
152 self.imported_keys = storage.get('imported_keys',{})
153 self.history = storage.get('addr_history',{}) # address -> list(txid, height)
155 self.fee = int(storage.get('fee_per_kb',20000))
157 self.master_public_keys = storage.get('master_public_keys',{})
158 self.master_private_keys = storage.get('master_private_keys', {})
160 self.next_addresses = storage.get('next_addresses',{})
162 if self.seed_version < 4:
163 raise ValueError("This wallet seed is deprecated.")
167 self.transactions = {}
168 tx_list = self.storage.get('transactions',{})
169 for k,v in tx_list.items():
173 print_msg("Warning: Cannot deserialize transactions. skipping")
176 self.add_extra_addresses(tx)
177 self.transactions[k] = tx
179 for h,tx in self.transactions.items():
180 if not self.check_new_tx(h, tx):
181 print_error("removing unreferenced tx", h)
182 self.transactions.pop(h)
186 self.prevout_values = {} # my own transaction outputs
187 self.spent_outputs = []
192 # there is a difference between wallet.up_to_date and interface.is_up_to_date()
193 # interface.is_up_to_date() returns true when all requests have been answered and processed
194 # wallet.up_to_date is true when the wallet is synchronized (stronger requirement)
196 self.up_to_date = False
197 self.lock = threading.Lock()
198 self.transaction_lock = threading.Lock()
199 self.tx_event = threading.Event()
201 for tx_hash, tx in self.transactions.items():
202 self.update_tx_outputs(tx_hash)
205 def add_extra_addresses(self, tx):
207 # find the address corresponding to pay-to-pubkey inputs
208 tx.add_extra_addresses(self.transactions)
209 for o in tx.d.get('outputs'):
210 if o.get('is_pubkey'):
211 for tx2 in self.transactions.values():
212 tx2.add_extra_addresses({h:tx})
217 def set_up_to_date(self,b):
218 with self.lock: self.up_to_date = b
221 def is_up_to_date(self):
222 with self.lock: return self.up_to_date
226 self.up_to_date = False
227 while not self.is_up_to_date():
231 def import_key(self, sec, password):
233 seed = self.decode_seed(password)
235 address = address_from_private_key(sec)
237 raise BaseException('Invalid private key')
239 if self.is_mine(address):
240 raise BaseException('Address already in wallet')
242 # store the originally requested keypair into the imported keys table
243 self.imported_keys[address] = pw_encode(sec, password )
244 self.storage.put('imported_keys', self.imported_keys, True)
245 if self.synchronizer:
246 self.synchronizer.subscribe_to_addresses([address])
249 def delete_imported_key(self, addr):
250 if addr in self.imported_keys:
251 self.imported_keys.pop(addr)
252 self.storage.put('imported_keys', self.imported_keys, True)
255 def init_seed(self, seed):
256 if self.seed: raise BaseException("a seed exists")
258 seed = random_seed(128)
263 self.storage.put('seed', self.seed, True)
264 self.storage.put('seed_version', self.seed_version, True)
266 def create_watching_only_wallet(self, c0, K0):
268 self.master_public_keys = {
269 "m/0'/": (c0, K0, cK0),
271 self.storage.put('master_public_keys', self.master_public_keys, True)
272 self.create_account('1','Main account')
274 def create_accounts(self):
276 master_k, master_c, master_K, master_cK = bip32_init(self.seed)
279 k0, c0, K0, cK0 = bip32_private_derivation(master_k, master_c, "m/", "m/0'/")
281 k1, c1, K1, cK1 = bip32_private_derivation(master_k, master_c, "m/", "m/1'/")
282 k2, c2, K2, cK2 = bip32_private_derivation(master_k, master_c, "m/", "m/2'/")
284 k3, c3, K3, cK3 = bip32_private_derivation(master_k, master_c, "m/", "m/3'/")
285 k4, c4, K4, cK4 = bip32_private_derivation(master_k, master_c, "m/", "m/4'/")
286 k5, c5, K5, cK5 = bip32_private_derivation(master_k, master_c, "m/", "m/5'/")
288 self.master_public_keys = {
289 "m/0'/": (c0, K0, cK0),
290 "m/1'/": (c1, K1, cK1),
291 "m/2'/": (c2, K2, cK2),
292 "m/3'/": (c3, K3, cK3),
293 "m/4'/": (c4, K4, cK4),
294 "m/5'/": (c5, K5, cK5)
297 self.master_private_keys = {
306 self.storage.put('master_public_keys', self.master_public_keys, True)
307 self.storage.put('master_private_keys', self.master_private_keys, True)
309 # create default account
310 self.create_account('1','Main account')
313 def find_root_by_master_key(self, c, K):
314 for key, v in self.master_public_keys.items():
315 if key == "m/":continue
317 if (c == cc) and (K == KK):
320 def deseed_root(self, seed, password):
321 # for safety, we ask the user to enter their seed
322 assert seed == self.decode_seed(password)
324 self.storage.put('seed', '', True)
327 def deseed_branch(self, k):
328 # check that parent has no seed
329 assert self.seed == ''
330 self.master_private_keys.pop(k)
331 self.storage.put('master_private_keys', self.master_private_keys, True)
334 def account_id(self, account_type, i):
335 if account_type == '1':
337 elif account_type == '2of2':
338 return "m/1'/%d & m/2'/%d"%(i,i)
339 elif account_type == '2of3':
340 return "m/3'/%d & m/4'/%d & m/5'/%d"%(i,i,i)
342 raise BaseException('unknown account type')
345 def num_accounts(self, account_type):
346 keys = self.accounts.keys()
349 account_id = self.account_id(account_type, i)
350 if account_id not in keys: break
355 def new_account_address(self, account_type = '1'):
356 i = self.num_accounts(account_type)
357 k = self.account_id(account_type,i)
359 addr = self.next_addresses.get(k)
361 account_id, account = self.next_account(account_type)
362 addr = account.first_address()
363 self.next_addresses[k] = addr
364 self.storage.put('next_addresses',self.next_addresses)
369 def next_account(self, account_type = '1'):
371 i = self.num_accounts(account_type)
372 account_id = self.account_id(account_type,i)
374 if account_type is '1':
375 master_c0, master_K0, _ = self.master_public_keys["m/0'/"]
376 c0, K0, cK0 = bip32_public_derivation(master_c0.decode('hex'), master_K0.decode('hex'), "m/0'/", "m/0'/%d"%i)
377 account = BIP32_Account({ 'c':c0, 'K':K0, 'cK':cK0 })
379 elif account_type == '2of2':
380 master_c1, master_K1, _ = self.master_public_keys["m/1'/"]
381 c1, K1, cK1 = bip32_public_derivation(master_c1.decode('hex'), master_K1.decode('hex'), "m/1'/", "m/1'/%d"%i)
382 master_c2, master_K2, _ = self.master_public_keys["m/2'/"]
383 c2, K2, cK2 = bip32_public_derivation(master_c2.decode('hex'), master_K2.decode('hex'), "m/2'/", "m/2'/%d"%i)
384 account = BIP32_Account_2of2({ 'c':c1, 'K':K1, 'cK':cK1, 'c2':c2, 'K2':K2, 'cK2':cK2 })
386 elif account_type == '2of3':
387 master_c3, master_K3, _ = self.master_public_keys["m/3'/"]
388 c3, K3, cK3 = bip32_public_derivation(master_c3.decode('hex'), master_K3.decode('hex'), "m/3'/", "m/3'/%d"%i)
389 master_c4, master_K4, _ = self.master_public_keys["m/4'/"]
390 c4, K4, cK4 = bip32_public_derivation(master_c4.decode('hex'), master_K4.decode('hex'), "m/4'/", "m/4'/%d"%i)
391 master_c5, master_K5, _ = self.master_public_keys["m/5'/"]
392 c5, K5, cK5 = bip32_public_derivation(master_c5.decode('hex'), master_K5.decode('hex'), "m/5'/", "m/5'/%d"%i)
393 account = BIP32_Account_2of3({ 'c':c3, 'K':K3, 'cK':cK3, 'c2':c4, 'K2':K4, 'cK2':cK4, 'c3':c5, 'K3':K5, 'cK3':cK5 })
395 return account_id, account
398 def set_label(self, key, value):
399 self.labels[key] = value
400 self.storage.put('labels', self.labels, True)
403 def create_account(self, account_type = '1', name = None):
404 account_id, account = self.next_account(account_type)
405 self.accounts[account_id] = account
408 self.set_label(account_id, name)
411 def create_old_account(self):
412 mpk = OldAccount.mpk_from_seed(self.seed)
413 self.storage.put('master_public_key', mpk, True)
414 self.accounts[0] = OldAccount({'mpk':mpk, 0:[], 1:[]})
418 def save_accounts(self):
420 for k, v in self.accounts.items():
422 self.storage.put('accounts', d, True)
426 def load_accounts(self):
427 d = self.storage.get('accounts', {})
429 for k, v in d.items():
431 v['mpk'] = self.storage.get('master_public_key')
432 self.accounts[k] = OldAccount(v)
434 self.accounts[k] = BIP32_Account_2of2(v)
436 self.accounts[k] = BIP32_Account(v)
439 def addresses(self, include_change = True, next=False):
440 o = self.get_account_addresses(-1, include_change)
441 for a in self.accounts.keys():
442 o += self.get_account_addresses(a, include_change)
445 for addr in self.next_addresses.values():
451 def is_mine(self, address):
452 return address in self.addresses(True)
455 def is_change(self, address):
456 if not self.is_mine(address): return False
457 if address in self.imported_keys.keys(): return False
458 acct, s = self.get_address_index(address)
459 if s is None: return False
462 def get_master_public_key(self):
463 if self.seed_version == 4:
464 return self.storage.get("master_public_key")
466 c, K, cK = self.storage.get("master_public_keys")["m/0'/"]
469 def get_master_private_key(self, account, password):
470 master_k = pw_decode( self.master_private_keys[account], password)
471 master_c, master_K, master_Kc = self.master_public_keys[account]
473 K, Kc = get_pubkeys_from_secret(master_k.decode('hex'))
474 assert K.encode('hex') == master_K
476 raise BaseException("Invalid password")
480 def get_address_index(self, address):
481 if address in self.imported_keys.keys():
484 for account in self.accounts.keys():
485 for for_change in [0,1]:
486 addresses = self.accounts[account].get_addresses(for_change)
487 for addr in addresses:
489 return account, (for_change, addresses.index(addr))
491 raise BaseException("Address not found", address)
494 def rebase_sequence(self, account, sequence):
497 for a in account.split('&'):
499 m = re.match("(m/\d+'/)(\d+)", s)
501 num = int(m.group(2))
502 dd.append( (root, [num,c,i] ) )
506 def get_keyID(self, account, sequence):
510 rs = self.rebase_sequence(account, sequence)
512 for root, public_sequence in rs:
513 c, K, _ = self.master_public_keys[root]
514 s = '/' + '/'.join( map(lambda x:str(x), public_sequence) )
515 dd.append( 'bip32(%s,%s,%s)'%(c,K, s) )
519 def get_public_key(self, address):
520 account, sequence = self.get_address_index(address)
521 return self.accounts[account].get_pubkey( *sequence )
524 def decode_seed(self, password):
525 seed = pw_decode(self.seed, password)
526 #todo: #self.sequences[0].check_seed(seed)
530 def get_private_key(self, address, password):
532 if address in self.imported_keys.keys():
533 out.append( pw_decode( self.imported_keys[address], password ) )
535 account, sequence = self.get_address_index(address)
537 seed = self.decode_seed(password)
538 pk = self.accounts[account].get_private_key(seed, sequence)
542 # assert address == self.accounts[account].get_address(*sequence)
543 rs = self.rebase_sequence( account, sequence)
544 for root, public_sequence in rs:
546 if root not in self.master_private_keys.keys(): continue
547 master_k = self.get_master_private_key(root, password)
548 master_c, _, _ = self.master_public_keys[root]
549 pk = bip32_private_key( public_sequence, master_k.decode('hex'), master_c.decode('hex'))
557 def signrawtransaction(self, tx, input_info, private_keys, password):
559 unspent_coins = self.get_unspent_coins()
560 seed = self.decode_seed(password)
562 # build a list of public/private keys
564 for sec in private_keys:
565 pubkey = public_key_from_private_key(sec)
566 keypairs[ pubkey ] = sec
569 for txin in tx.inputs:
570 # convert to own format
571 txin['tx_hash'] = txin['prevout_hash']
572 txin['index'] = txin['prevout_n']
574 for item in input_info:
575 if item.get('txid') == txin['tx_hash'] and item.get('vout') == txin['index']:
576 txin['raw_output_script'] = item['scriptPubKey']
577 txin['redeemScript'] = item.get('redeemScript')
578 txin['KeyID'] = item.get('KeyID')
581 for item in unspent_coins:
582 if txin['tx_hash'] == item['tx_hash'] and txin['index'] == item['index']:
583 print_error( "tx input is in unspent coins" )
584 txin['raw_output_script'] = item['raw_output_script']
585 account, sequence = self.get_address_index(item['address'])
587 txin['redeemScript'] = self.accounts[account].redeem_script(sequence)
590 raise BaseException("Unknown transaction input. Please provide the 'input_info' parameter, or synchronize this wallet")
592 # if available, derive private_keys from KeyID
593 keyid = txin.get('KeyID')
596 for s in keyid.split('&'):
597 m = re.match("bip32\(([0-9a-f]+),([0-9a-f]+),(/\d+/\d+/\d+)", s)
601 sequence = m.group(3)
602 root = self.find_root_by_master_key(c,K)
603 if not root: continue
604 sequence = map(lambda x:int(x), sequence.strip('/').split('/'))
605 root = root + '%d'%sequence[0]
606 sequence = sequence[1:]
607 roots.append((root,sequence))
609 account_id = " & ".join( map(lambda x:x[0], roots) )
610 account = self.accounts.get(account_id)
611 if not account: continue
612 addr = account.get_address(*sequence)
613 txin['address'] = addr
614 pk = self.get_private_key(addr, password)
616 pubkey = public_key_from_private_key(sec)
617 keypairs[pubkey] = sec
619 redeem_script = txin.get("redeemScript")
620 print_error( "p2sh:", "yes" if redeem_script else "no")
622 addr = hash_160_to_bc_address(hash_160(redeem_script.decode('hex')), 5)
625 _, addr = transaction.get_address_from_output_script(txin["raw_output_script"].decode('hex'))
626 txin['address'] = addr
628 # add private keys that are in the wallet
629 pk = self.get_private_key(addr, password)
631 pubkey = public_key_from_private_key(sec)
632 keypairs[pubkey] = sec
633 if not redeem_script:
634 txin['redeemPubkey'] = pubkey
640 def sign_message(self, address, message, password):
641 keys = self.get_private_key(address, password)
642 assert len(keys) == 1
644 key = regenerate_key(sec)
645 compressed = is_compressed(sec)
646 return key.sign_message(message, compressed, address)
648 def verify_message(self, address, signature, message):
650 EC_KEY.verify_message(address, signature, message)
652 except BaseException as e:
653 print_error("Verification error: {0}".format(e))
657 def change_gap_limit(self, value):
658 if value >= self.gap_limit:
659 self.gap_limit = value
660 self.storage.put('gap_limit', self.gap_limit, True)
661 #self.interface.poke('synchronizer')
664 elif value >= self.min_acceptable_gap():
665 for key, account in self.accounts.items():
666 addresses = account[0]
667 k = self.num_unused_trailing_addresses(addresses)
668 n = len(addresses) - k + value
669 addresses = addresses[0:n]
670 self.accounts[key][0] = addresses
672 self.gap_limit = value
673 self.storage.put('gap_limit', self.gap_limit, True)
679 def num_unused_trailing_addresses(self, addresses):
681 for a in addresses[::-1]:
682 if self.history.get(a):break
686 def min_acceptable_gap(self):
687 # fixme: this assumes wallet is synchronized
691 for account in self.accounts.values():
692 addresses = account.get_addresses(0)
693 k = self.num_unused_trailing_addresses(addresses)
694 for a in addresses[0:-k]:
695 if self.history.get(a):
699 if n > nmax: nmax = n
703 def address_is_old(self, address):
705 h = self.history.get(address, [])
708 for tx_hash, tx_height in h:
712 tx_age = self.verifier.blockchain.height - tx_height + 1
718 def synchronize_sequence(self, account, for_change):
719 limit = self.gap_limit_for_change if for_change else self.gap_limit
722 addresses = account.get_addresses(for_change)
723 if len(addresses) < limit:
724 address = account.create_new_address(for_change)
725 self.history[address] = []
726 new_addresses.append( address )
729 if map( lambda a: self.address_is_old(a), addresses[-limit:] ) == limit*[False]:
732 address = account.create_new_address(for_change)
733 self.history[address] = []
734 new_addresses.append( address )
740 def create_pending_accounts(self):
741 for account_type in ['1','2of2','2of3']:
742 a = self.new_account_address(account_type)
743 if self.address_is_old(a):
744 print_error( "creating account", a )
745 self.create_account(account_type)
748 def synchronize_account(self, account):
750 new += self.synchronize_sequence(account, 0)
751 new += self.synchronize_sequence(account, 1)
755 def synchronize(self):
756 if self.master_public_keys:
757 self.create_pending_accounts()
759 for account in self.accounts.values():
760 new += self.synchronize_account(account)
763 self.storage.put('addr_history', self.history, True)
768 return self.history.values() != [[]] * len(self.history)
771 def add_contact(self, address, label=None):
772 self.addressbook.append(address)
773 self.storage.put('contacts', self.addressbook, True)
775 self.set_label(address, label)
778 def delete_contact(self, addr):
779 if addr in self.addressbook:
780 self.addressbook.remove(addr)
781 self.storage.put('addressbook', self.addressbook, True)
784 def fill_addressbook(self):
785 for tx_hash, tx in self.transactions.items():
786 is_relevant, is_send, _, _ = self.get_tx_value(tx)
788 for addr, v in tx.outputs:
789 if not self.is_mine(addr) and addr not in self.addressbook:
790 self.addressbook.append(addr)
792 # self.update_tx_labels()
794 def get_num_tx(self, address):
796 for tx in self.transactions.values():
797 if address in map(lambda x:x[0], tx.outputs): n += 1
801 def get_address_flags(self, addr):
802 flags = "C" if self.is_change(addr) else "I" if addr in self.imported_keys.keys() else "-"
803 flags += "F" if addr in self.frozen_addresses else "P" if addr in self.prioritized_addresses else "-"
807 def get_tx_value(self, tx, account=None):
808 domain = self.get_account_addresses(account)
809 return tx.get_value(domain, self.prevout_values)
812 def update_tx_outputs(self, tx_hash):
813 tx = self.transactions.get(tx_hash)
815 for i, (addr, value) in enumerate(tx.outputs):
816 key = tx_hash+ ':%d'%i
817 self.prevout_values[key] = value
819 for item in tx.inputs:
820 if self.is_mine(item.get('address')):
821 key = item['prevout_hash'] + ':%d'%item['prevout_n']
822 self.spent_outputs.append(key)
825 def get_addr_balance(self, address):
826 assert self.is_mine(address)
827 h = self.history.get(address,[])
828 if h == ['*']: return 0,0
830 received_coins = [] # list of coins received at address
832 for tx_hash, tx_height in h:
833 tx = self.transactions.get(tx_hash)
836 for i, (addr, value) in enumerate(tx.outputs):
838 key = tx_hash + ':%d'%i
839 received_coins.append(key)
841 for tx_hash, tx_height in h:
842 tx = self.transactions.get(tx_hash)
846 for item in tx.inputs:
847 addr = item.get('address')
849 key = item['prevout_hash'] + ':%d'%item['prevout_n']
850 value = self.prevout_values.get( key )
851 if key in received_coins:
854 for i, (addr, value) in enumerate(tx.outputs):
855 key = tx_hash + ':%d'%i
866 def get_account_name(self, k):
868 if self.seed_version == 4:
869 name = 'Main account'
873 name = self.labels.get(k, 'Unnamed account')
876 def get_account_names(self):
878 for k, account in self.accounts.items():
879 accounts[k] = self.get_account_name(k)
880 if self.imported_keys:
881 accounts[-1] = 'Imported keys'
884 def get_account_addresses(self, a, include_change=True):
886 o = self.addresses(True)
888 o = self.imported_keys.keys()
890 ac = self.accounts[a]
891 o = ac.get_addresses(0)
892 if include_change: o += ac.get_addresses(1)
895 def get_imported_balance(self):
897 for addr in self.imported_keys.keys():
898 c, u = self.get_addr_balance(addr)
903 def get_account_balance(self, account):
905 return self.get_balance()
907 return self.get_imported_balance()
910 for addr in self.get_account_addresses(account):
911 c, u = self.get_addr_balance(addr)
916 def get_frozen_balance(self):
918 for addr in self.frozen_addresses:
919 c, u = self.get_addr_balance(addr)
925 def get_balance(self):
927 for a in self.accounts.keys():
928 c, u = self.get_account_balance(a)
931 c, u = self.get_imported_balance()
937 def get_unspent_coins(self, domain=None):
939 if domain is None: domain = self.addresses(True)
941 h = self.history.get(addr, [])
942 if h == ['*']: continue
943 for tx_hash, tx_height in h:
944 tx = self.transactions.get(tx_hash)
945 if tx is None: raise BaseException("Wallet not synchronized")
946 for output in tx.d.get('outputs'):
947 if output.get('address') != addr: continue
948 key = tx_hash + ":%d" % output.get('index')
949 if key in self.spent_outputs: continue
950 output['tx_hash'] = tx_hash
956 def choose_tx_inputs( self, amount, fixed_fee, domain = None ):
957 """ todo: minimize tx size """
959 fee = self.fee if fixed_fee is None else fixed_fee
961 domain.self.addresses()
963 prioritized_coins = []
964 for i in self.frozen_addresses:
965 if i in domain: domain.remove(i)
967 for i in self.prioritized_addresses:
968 if i in domain: domain.remove(i)
970 coins = self.get_unspent_coins(domain)
971 prioritized_coins = self.get_unspent_coins(self.prioritized_addresses)
974 coins = prioritized_coins + coins
977 addr = item.get('address')
978 v = item.get('value')
980 inputs.append( item )
981 fee = self.estimated_fee(inputs) if fixed_fee is None else fixed_fee
982 if total >= amount + fee: break
986 return inputs, total, fee
989 def set_fee(self, fee):
992 self.storage.put('fee_per_kb', self.fee, True)
994 def estimated_fee(self, inputs):
995 estimated_size = len(inputs) * 180 + 80 # this assumes non-compressed keys
996 fee = self.fee * int(round(estimated_size/1024.))
997 if fee == 0: fee = self.fee
1001 def add_tx_change( self, inputs, outputs, amount, fee, total, change_addr=None):
1002 "add change to a transaction"
1003 change_amount = total - ( amount + fee )
1004 if change_amount != 0:
1007 # send change to one of the accounts involved in the tx
1008 address = inputs[0].get('address')
1009 account, _ = self.get_address_index(address)
1011 if not self.use_change or account == -1:
1012 change_addr = inputs[-1]['address']
1014 change_addr = self.accounts[account].get_addresses(1)[-self.gap_limit_for_change]
1016 # Insert the change output at a random position in the outputs
1017 posn = random.randint(0, len(outputs))
1018 outputs[posn:posn] = [( change_addr, change_amount)]
1022 def get_history(self, address):
1024 return self.history.get(address)
1027 def get_status(self, h):
1028 if not h: return None
1029 if h == ['*']: return '*'
1031 for tx_hash, height in h:
1032 status += tx_hash + ':%d:' % height
1033 return hashlib.sha256( status ).digest().encode('hex')
1036 def receive_tx_callback(self, tx_hash, tx, tx_height):
1038 with self.transaction_lock:
1039 self.add_extra_addresses(tx)
1040 if not self.check_new_tx(tx_hash, tx):
1041 # may happen due to pruning
1042 print_error("received transaction that is no longer referenced in history", tx_hash)
1044 self.transactions[tx_hash] = tx
1045 self.network.interface.pending_transactions_for_notifications.append(tx)
1046 self.save_transactions()
1047 if self.verifier and tx_height>0:
1048 self.verifier.add(tx_hash, tx_height)
1049 self.update_tx_outputs(tx_hash)
1052 def save_transactions(self):
1054 for k,v in self.transactions.items():
1056 self.storage.put('transactions', tx, True)
1058 def receive_history_callback(self, addr, hist):
1060 if not self.check_new_history(addr, hist):
1061 raise BaseException("error: received history for %s is not consistent with known transactions"%addr)
1064 self.history[addr] = hist
1065 self.storage.put('addr_history', self.history, True)
1068 for tx_hash, tx_height in hist:
1070 # add it in case it was previously unconfirmed
1071 if self.verifier: self.verifier.add(tx_hash, tx_height)
1074 def get_tx_history(self, account=None):
1075 with self.transaction_lock:
1076 history = self.transactions.items()
1077 history.sort(key = lambda x: self.verifier.get_txpos(x[0]))
1081 for tx_hash, tx in history:
1082 is_relevant, is_mine, v, fee = self.get_tx_value(tx, account)
1083 if v is not None: balance += v
1085 c, u = self.get_account_balance(account)
1088 result.append( ('', 1000, 0, c+u-balance, None, c+u-balance, None ) )
1090 balance = c + u - balance
1091 for tx_hash, tx in history:
1092 is_relevant, is_mine, value, fee = self.get_tx_value(tx, account)
1095 if value is not None:
1098 conf, timestamp = self.verifier.get_confirmations(tx_hash) if self.verifier else (None, None)
1099 result.append( (tx_hash, conf, is_mine, value, fee, balance, timestamp) )
1104 def get_label(self, tx_hash):
1105 label = self.labels.get(tx_hash)
1106 is_default = (label == '') or (label is None)
1107 if is_default: label = self.get_default_label(tx_hash)
1108 return label, is_default
1111 def get_default_label(self, tx_hash):
1112 tx = self.transactions.get(tx_hash)
1115 is_relevant, is_mine, _, _ = self.get_tx_value(tx)
1117 for o in tx.outputs:
1119 if not self.is_mine(o_addr):
1121 default_label = self.labels[o_addr]
1123 default_label = o_addr
1126 default_label = '(internal)'
1128 for o in tx.outputs:
1130 if self.is_mine(o_addr) and not self.is_change(o_addr):
1133 for o in tx.outputs:
1135 if self.is_mine(o_addr):
1141 dest_label = self.labels.get(o_addr)
1143 default_label = self.labels[o_addr]
1145 default_label = o_addr
1147 return default_label
1150 def make_unsigned_transaction(self, outputs, fee=None, change_addr=None, domain=None ):
1151 for address, x in outputs:
1152 assert is_valid(address)
1153 amount = sum( map(lambda x:x[1], outputs) )
1154 inputs, total, fee = self.choose_tx_inputs( amount, fee, domain )
1156 raise ValueError("Not enough funds")
1157 outputs = self.add_tx_change(inputs, outputs, amount, fee, total, change_addr)
1158 return Transaction.from_io(inputs, outputs)
1161 def mktx_from_account(self, outputs, password, fee=None, change_addr=None, account=None):
1163 domain = self.get_account_addresses(account)
1164 self.mktx(outputs, password, fee, change_addr, domain)
1167 def mktx(self, outputs, password, fee=None, change_addr=None, domain= None ):
1168 tx = self.make_unsigned_transaction(outputs, fee, change_addr, domain)
1169 self.sign_transaction(tx, password)
1173 def sign_transaction(self, tx, password):
1175 for i, txin in enumerate(tx.inputs):
1176 address = txin['address']
1177 account, sequence = self.get_address_index(address)
1178 txin['KeyID'] = self.get_keyID(account, sequence)
1179 redeemScript = self.accounts[account].redeem_script(sequence)
1181 txin['redeemScript'] = redeemScript
1183 txin['redeemPubkey'] = self.accounts[account].get_pubkey(*sequence)
1184 private_keys = self.get_private_key(address, password)
1185 for sec in private_keys:
1186 pubkey = public_key_from_private_key(sec)
1187 keypairs[ pubkey ] = sec
1191 def sendtx(self, tx):
1193 h = self.send_tx(tx)
1194 self.tx_event.wait()
1195 return self.receive_tx(h)
1197 def send_tx(self, tx):
1199 self.tx_event.clear()
1200 self.network.interface.send([('blockchain.transaction.broadcast', [str(tx)])], self.on_broadcast)
1203 def on_broadcast(self, i, r):
1204 self.tx_result = r.get('result')
1207 def receive_tx(self,tx_hash):
1208 out = self.tx_result
1210 return False, "error: " + out
1215 def update_password(self, seed, old_password, new_password):
1216 if new_password == '': new_password = None
1217 # this will throw an exception if unicode cannot be converted
1218 self.seed = pw_encode( seed, new_password)
1219 self.storage.put('seed', self.seed, True)
1220 self.use_encryption = (new_password != None)
1221 self.storage.put('use_encryption', self.use_encryption,True)
1222 for k in self.imported_keys.keys():
1223 a = self.imported_keys[k]
1224 b = pw_decode(a, old_password)
1225 c = pw_encode(b, new_password)
1226 self.imported_keys[k] = c
1227 self.storage.put('imported_keys', self.imported_keys, True)
1229 for k, v in self.master_private_keys.items():
1230 b = pw_decode(v, old_password)
1231 c = pw_encode(b, new_password)
1232 self.master_private_keys[k] = c
1233 self.storage.put('master_private_keys', self.master_private_keys, True)
1236 def freeze(self,addr):
1237 if self.is_mine(addr) and addr not in self.frozen_addresses:
1238 self.unprioritize(addr)
1239 self.frozen_addresses.append(addr)
1240 self.storage.put('frozen_addresses', self.frozen_addresses, True)
1245 def unfreeze(self,addr):
1246 if self.is_mine(addr) and addr in self.frozen_addresses:
1247 self.frozen_addresses.remove(addr)
1248 self.storage.put('frozen_addresses', self.frozen_addresses, True)
1253 def prioritize(self,addr):
1254 if self.is_mine(addr) and addr not in self.prioritized_addresses:
1256 self.prioritized_addresses.append(addr)
1257 self.storage.put('prioritized_addresses', self.prioritized_addresses, True)
1262 def unprioritize(self,addr):
1263 if self.is_mine(addr) and addr in self.prioritized_addresses:
1264 self.prioritized_addresses.remove(addr)
1265 self.storage.put('prioritized_addresses', self.prioritized_addresses, True)
1271 def set_verifier(self, verifier):
1272 self.verifier = verifier
1274 # review transactions that are in the history
1275 for addr, hist in self.history.items():
1276 if hist == ['*']: continue
1277 for tx_hash, tx_height in hist:
1279 # add it in case it was previously unconfirmed
1280 self.verifier.add(tx_hash, tx_height)
1283 # if we are on a pruning server, remove unverified transactions
1284 vr = self.verifier.transactions.keys() + self.verifier.verified_tx.keys()
1285 for tx_hash in self.transactions.keys():
1286 if tx_hash not in vr:
1287 self.transactions.pop(tx_hash)
1291 def check_new_history(self, addr, hist):
1293 # check that all tx in hist are relevant
1295 for tx_hash, height in hist:
1296 tx = self.transactions.get(tx_hash)
1298 if not tx.has_address(addr):
1301 # check that we are not "orphaning" a transaction
1302 old_hist = self.history.get(addr,[])
1303 if old_hist == ['*']: return True
1305 for tx_hash, height in old_hist:
1306 if tx_hash in map(lambda x:x[0], hist): continue
1308 for _addr, _hist in self.history.items():
1309 if _addr == addr: continue
1310 if _hist == ['*']: continue
1311 _tx_hist = map(lambda x:x[0], _hist)
1312 if tx_hash in _tx_hist:
1317 tx = self.transactions.get(tx_hash)
1318 # tx might not be there
1322 if self.verifier.get_height(tx_hash):
1325 print_error("new history is orphaning transaction:", tx_hash)
1326 # check that all outputs are not mine, request histories
1328 for _addr, _v in tx.outputs:
1329 # assert not self.is_mine(_addr)
1330 ext_requests.append( ('blockchain.address.get_history', [_addr]) )
1332 ext_h = self.network.interface.synchronous_get(ext_requests)
1333 print_error("sync:", ext_requests, ext_h)
1336 if h == ['*']: continue
1338 if item.get('tx_hash') == tx_hash:
1339 height = item.get('height')
1341 print_error("found height for", tx_hash, height)
1342 self.verifier.add(tx_hash, height)
1344 print_error("removing orphaned tx from history", tx_hash)
1345 self.transactions.pop(tx_hash)
1351 def check_new_tx(self, tx_hash, tx):
1352 # 1 check that tx is referenced in addr_history.
1354 for addr, hist in self.history.items():
1355 if hist == ['*']:continue
1356 for txh, height in hist:
1358 addresses.append(addr)
1363 # 2 check that referencing addresses are in the tx
1364 for addr in addresses:
1365 if not tx.has_address(addr):
1371 def start_threads(self, network):
1372 from verifier import TxVerifier
1373 self.network = network
1374 self.verifier = TxVerifier(self.network, self.storage)
1375 self.verifier.start()
1376 self.set_verifier(self.verifier)
1377 self.synchronizer = WalletSynchronizer(self)
1378 self.synchronizer.start()
1380 def stop_threads(self):
1381 self.verifier.stop()
1382 self.synchronizer.stop()
1388 class WalletSynchronizer(threading.Thread):
1391 def __init__(self, wallet):
1392 threading.Thread.__init__(self)
1394 self.wallet = wallet
1395 wallet.synchronizer = self
1396 self.network = self.wallet.network
1397 #self.wallet.network.register_callback('connected', lambda: self.wallet.set_up_to_date(False))
1398 self.was_updated = True
1399 self.running = False
1400 self.lock = threading.Lock()
1401 self.queue = Queue.Queue()
1404 with self.lock: self.running = False
1406 def is_running(self):
1407 with self.lock: return self.running
1410 def subscribe_to_addresses(self, addresses):
1412 for addr in addresses:
1413 messages.append(('blockchain.address.subscribe', [addr]))
1414 self.network.interface.send( messages, lambda i,r: self.queue.put(r))
1421 while self.is_running():
1422 interface = self.network.interface
1423 if not interface.is_connected:
1424 print_error("synchronizer: waiting for interface")
1425 interface.connect_event.wait()
1427 self.run_interface(interface)
1430 def run_interface(self, interface):
1432 print_error("synchronizer: connected to", interface.server)
1436 requested_histories = {}
1438 # request any missing transactions
1439 for history in self.wallet.history.values():
1440 if history == ['*']: continue
1441 for tx_hash, tx_height in history:
1442 if self.wallet.transactions.get(tx_hash) is None and (tx_hash, tx_height) not in missing_tx:
1443 missing_tx.append( (tx_hash, tx_height) )
1446 print_error("missing tx", missing_tx)
1449 self.subscribe_to_addresses(self.wallet.addresses(True, next=True))
1451 while self.is_running():
1452 # 1. create new addresses
1453 new_addresses = self.wallet.synchronize()
1455 # request missing addresses
1457 self.subscribe_to_addresses(new_addresses)
1459 # request missing transactions
1460 for tx_hash, tx_height in missing_tx:
1461 if (tx_hash, tx_height) not in requested_tx:
1462 interface.send([ ('blockchain.transaction.get',[tx_hash, tx_height]) ], lambda i,r: self.queue.put(r))
1463 requested_tx.append( (tx_hash, tx_height) )
1466 # detect if situation has changed
1467 if interface.is_up_to_date() and self.queue.empty():
1468 if not self.wallet.is_up_to_date():
1469 self.wallet.set_up_to_date(True)
1470 self.was_updated = True
1472 if self.wallet.is_up_to_date():
1473 self.wallet.set_up_to_date(False)
1474 self.was_updated = True
1476 if self.was_updated:
1477 self.wallet.network.trigger_callback('updated')
1478 self.was_updated = False
1482 r = self.queue.get(block=True, timeout=1)
1486 if interface != self.network.interface:
1492 # 3. handle response
1493 method = r['method']
1494 params = r['params']
1495 result = r.get('result')
1496 error = r.get('error')
1501 if method == 'blockchain.address.subscribe':
1503 if self.wallet.get_status(self.wallet.get_history(addr)) != result:
1504 if requested_histories.get(addr) is None:
1505 interface.send([('blockchain.address.get_history', [addr])], lambda i,r:self.queue.put(r))
1506 requested_histories[addr] = result
1508 elif method == 'blockchain.address.get_history':
1510 print_error("receiving history", addr, result)
1512 assert requested_histories.pop(addr) == '*'
1513 self.wallet.receive_history_callback(addr, result)
1516 # check that txids are unique
1519 tx_hash = item['tx_hash']
1520 if tx_hash not in txids:
1521 txids.append(tx_hash)
1522 hist.append( (tx_hash, item['height']) )
1524 if len(hist) != len(result):
1525 raise BaseException("error: server sent history with non-unique txid", result)
1527 # check that the status corresponds to what was announced
1528 rs = requested_histories.pop(addr)
1529 if self.wallet.get_status(hist) != rs:
1530 raise BaseException("error: status mismatch: %s"%addr)
1532 # store received history
1533 self.wallet.receive_history_callback(addr, hist)
1535 # request transactions that we don't have
1536 for tx_hash, tx_height in hist:
1537 if self.wallet.transactions.get(tx_hash) is None:
1538 if (tx_hash, tx_height) not in requested_tx and (tx_hash, tx_height) not in missing_tx:
1539 missing_tx.append( (tx_hash, tx_height) )
1541 elif method == 'blockchain.transaction.get':
1543 tx_height = params[1]
1544 assert tx_hash == hash_encode(Hash(result.decode('hex')))
1545 tx = Transaction(result)
1546 self.wallet.receive_tx_callback(tx_hash, tx, tx_height)
1547 self.was_updated = True
1548 requested_tx.remove( (tx_hash, tx_height) )
1549 print_error("received tx:", tx_hash, len(tx.raw))
1552 print_error("Error: Unknown message:" + method + ", " + repr(params) + ", " + repr(result) )
1554 if self.was_updated and not requested_tx:
1555 self.wallet.network.trigger_callback('updated')
1556 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
1558 self.was_updated = False