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/>.
20 import hashlib, base64, ecdsa, re
21 from util import print_error
24 return s.decode('hex')[::-1].encode('hex')
26 def int_to_hex(i, length=1):
27 s = hex(i)[2:].rstrip('L')
28 s = "0"*(2*length - len(s)) + s
32 # https://en.bitcoin.it/wiki/Protocol_specification#Variable_length_integer
36 return "fd"+int_to_hex(i,2)
38 return "fe"+int_to_hex(i,4)
40 return "ff"+int_to_hex(i,8)
46 return '4c' + int_to_hex(i)
48 return '4d' + int_to_hex(i,2)
50 return '4e' + int_to_hex(i,4)
54 Hash = lambda x: hashlib.sha256(hashlib.sha256(x).digest()).digest()
55 hash_encode = lambda x: x[::-1].encode('hex')
56 hash_decode = lambda x: x.decode('hex')[::-1]
59 # pywallet openssl private key implementation
61 def i2d_ECPrivateKey(pkey, compressed=False):
63 key = '3081d30201010420' + \
64 '%064x' % pkey.secret + \
65 'a081a53081a2020101302c06072a8648ce3d0101022100' + \
67 '3006040100040107042102' + \
73 key = '308201130201010420' + \
74 '%064x' % pkey.secret + \
75 'a081a53081a2020101302c06072a8648ce3d0101022100' + \
77 '3006040100040107044104' + \
84 return key.decode('hex') + i2o_ECPublicKey(pkey.pubkey, compressed)
86 def i2o_ECPublicKey(pubkey, compressed=False):
87 # public keys are 65 bytes long (520 bits)
88 # 0x04 + 32-byte X-coordinate + 32-byte Y-coordinate
89 # 0x00 = point at infinity, 0x02 and 0x03 = compressed, 0x04 = uncompressed
90 # compressed keys: <sign> <x> where <sign> is 0x02 if y is even and 0x03 if y is odd
92 if pubkey.point.y() & 1:
93 key = '03' + '%064x' % pubkey.point.x()
95 key = '02' + '%064x' % pubkey.point.x()
98 '%064x' % pubkey.point.x() + \
99 '%064x' % pubkey.point.y()
101 return key.decode('hex')
103 # end pywallet openssl private key implementation
107 ############ functions from pywallet #####################
109 def hash_160(public_key):
111 md = hashlib.new('ripemd160')
112 md.update(hashlib.sha256(public_key).digest())
116 md = ripemd.new(hashlib.sha256(public_key).digest())
120 def public_key_to_bc_address(public_key):
121 h160 = hash_160(public_key)
122 return hash_160_to_bc_address(h160)
124 def hash_160_to_bc_address(h160, addrtype = 0):
125 vh160 = chr(addrtype) + h160
127 addr = vh160 + h[0:4]
128 return b58encode(addr)
130 def bc_address_to_hash_160(addr):
131 bytes = b58decode(addr, 25)
132 return ord(bytes[0]), bytes[1:21]
134 def encode_point(pubkey, compressed=False):
135 order = generator_secp256k1.order()
136 p = pubkey.pubkey.point
137 x_str = ecdsa.util.number_to_string(p.x(), order)
138 y_str = ecdsa.util.number_to_string(p.y(), order)
140 return chr(2 + (p.y() & 1)) + x_str
142 return chr(4) + pubkey.to_string() #x_str + y_str
144 __b58chars = '123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz'
145 __b58base = len(__b58chars)
148 """ encode v, which is a string of bytes, to base58."""
151 for (i, c) in enumerate(v[::-1]):
152 long_value += (256**i) * ord(c)
155 while long_value >= __b58base:
156 div, mod = divmod(long_value, __b58base)
157 result = __b58chars[mod] + result
159 result = __b58chars[long_value] + result
161 # Bitcoin does a little leading-zero-compression:
162 # leading 0-bytes in the input become leading-1s
165 if c == '\0': nPad += 1
168 return (__b58chars[0]*nPad) + result
170 def b58decode(v, length):
171 """ decode v into a string of len bytes."""
173 for (i, c) in enumerate(v[::-1]):
174 long_value += __b58chars.find(c) * (__b58base**i)
177 while long_value >= 256:
178 div, mod = divmod(long_value, 256)
179 result = chr(mod) + result
181 result = chr(long_value) + result
185 if c == __b58chars[0]: nPad += 1
188 result = chr(0)*nPad + result
189 if length is not None and len(result) != length:
195 def EncodeBase58Check(vchIn):
197 return b58encode(vchIn + hash[0:4])
199 def DecodeBase58Check(psz):
200 vchRet = b58decode(psz, None)
210 def PrivKeyToSecret(privkey):
211 return privkey[9:9+32]
213 def SecretToASecret(secret, compressed=False, addrtype=0):
214 vchIn = chr((addrtype+128)&255) + secret
215 if compressed: vchIn += '\01'
216 return EncodeBase58Check(vchIn)
218 def ASecretToSecret(key, addrtype=0):
219 vch = DecodeBase58Check(key)
220 if vch and vch[0] == chr((addrtype+128)&255):
225 def regenerate_key(sec):
226 b = ASecretToSecret(sec)
230 secret = int('0x' + b.encode('hex'), 16)
231 return EC_KEY(secret)
233 def GetPubKey(pubkey, compressed=False):
234 return i2o_ECPublicKey(pubkey, compressed)
236 def GetPrivKey(pkey, compressed=False):
237 return i2d_ECPrivateKey(pkey, compressed)
240 return ('%064x' % pkey.secret).decode('hex')
242 def is_compressed(sec):
243 b = ASecretToSecret(sec)
247 def address_from_private_key(sec):
248 # rebuild public key from private key, compressed or uncompressed
249 pkey = regenerate_key(sec)
252 # figure out if private key is compressed
253 compressed = is_compressed(sec)
255 # rebuild private and public key from regenerated secret
256 private_key = GetPrivKey(pkey, compressed)
257 public_key = GetPubKey(pkey.pubkey, compressed)
258 address = public_key_to_bc_address(public_key)
263 ADDRESS_RE = re.compile('[1-9A-HJ-NP-Za-km-z]{26,}\\Z')
264 if not ADDRESS_RE.match(addr): return False
266 addrtype, h = bc_address_to_hash_160(addr)
269 return addr == hash_160_to_bc_address(h, addrtype)
272 ########### end pywallet functions #######################
274 # secp256k1, http://www.oid-info.com/get/1.3.132.0.10
275 _p = 0xFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFEFFFFFC2FL
276 _r = 0xFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFEBAAEDCE6AF48A03BBFD25E8CD0364141L
277 _b = 0x0000000000000000000000000000000000000000000000000000000000000007L
278 _a = 0x0000000000000000000000000000000000000000000000000000000000000000L
279 _Gx = 0x79BE667EF9DCBBAC55A06295CE870B07029BFCDB2DCE28D959F2815B16F81798L
280 _Gy = 0x483ada7726a3c4655da4fbfc0e1108a8fd17b448a68554199c47d08ffb10d4b8L
281 curve_secp256k1 = ecdsa.ellipticcurve.CurveFp( _p, _a, _b )
282 generator_secp256k1 = ecdsa.ellipticcurve.Point( curve_secp256k1, _Gx, _Gy, _r )
283 oid_secp256k1 = (1,3,132,0,10)
284 SECP256k1 = ecdsa.curves.Curve("SECP256k1", curve_secp256k1, generator_secp256k1, oid_secp256k1 )
286 from ecdsa.util import string_to_number, number_to_string
288 def msg_magic(message):
289 return "\x18Bitcoin Signed Message:\n" + chr( len(message) ) + message
292 class EC_KEY(object):
293 def __init__( self, secret ):
294 self.pubkey = ecdsa.ecdsa.Public_key( generator_secp256k1, generator_secp256k1 * secret )
295 self.privkey = ecdsa.ecdsa.Private_key( self.pubkey, secret )
298 def sign_message(self, message, compressed, address):
299 private_key = ecdsa.SigningKey.from_secret_exponent( self.secret, curve = SECP256k1 )
300 public_key = private_key.get_verifying_key()
301 signature = private_key.sign_digest( Hash( msg_magic(message) ), sigencode = ecdsa.util.sigencode_string )
302 assert public_key.verify_digest( signature, Hash( msg_magic(message) ), sigdecode = ecdsa.util.sigdecode_string)
304 sig = base64.b64encode( chr(27 + i + (4 if compressed else 0)) + signature )
306 self.verify_message( address, sig, message)
311 raise BaseException("error: cannot sign message")
314 def verify_message(self, address, signature, message):
315 """ See http://www.secg.org/download/aid-780/sec1-v2.pdf for the math """
316 from ecdsa import numbertheory, ellipticcurve, util
318 curve = curve_secp256k1
319 G = generator_secp256k1
321 # extract r,s from signature
322 sig = base64.b64decode(signature)
323 if len(sig) != 65: raise BaseException("Wrong encoding")
324 r,s = util.sigdecode_string(sig[1:], order)
326 if nV < 27 or nV >= 35:
327 raise BaseException("Bad encoding")
336 x = r + (recid/2) * order
338 alpha = ( x * x * x + curve.a() * x + curve.b() ) % curve.p()
339 beta = msqr.modular_sqrt(alpha, curve.p())
340 y = beta if (beta - recid) % 2 == 0 else curve.p() - beta
341 # 1.4 the constructor checks that nR is at infinity
342 R = ellipticcurve.Point(curve, x, y, order)
343 # 1.5 compute e from message:
344 h = Hash( msg_magic(message) )
345 e = string_to_number(h)
347 # 1.6 compute Q = r^-1 (sR - eG)
348 inv_r = numbertheory.inverse_mod(r,order)
349 Q = inv_r * ( s * R + minus_e * G )
350 public_key = ecdsa.VerifyingKey.from_public_point( Q, curve = SECP256k1 )
351 # check that Q is the public key
352 public_key.verify_digest( sig[1:], h, sigdecode = ecdsa.util.sigdecode_string)
353 # check that we get the original signing address
354 addr = public_key_to_bc_address( encode_point(public_key, compressed) )
356 raise BaseException("Bad signature")
359 ###################################### BIP32 ##############################
361 random_seed = lambda n: "%032x"%ecdsa.util.randrange( pow(2,n) )
362 BIP32_PRIME = 0x80000000
364 def bip32_init(seed):
366 seed = seed.decode('hex')
367 I = hmac.new("Bitcoin seed", seed, hashlib.sha512).digest()
369 master_secret = I[0:32]
370 master_chain = I[32:]
372 K, K_compressed = get_pubkeys_from_secret(master_secret)
373 return master_secret, master_chain, K, K_compressed
376 def get_pubkeys_from_secret(secret):
379 private_key = ecdsa.SigningKey.from_string( secret, curve = SECP256k1 )
380 public_key = private_key.get_verifying_key()
381 K = public_key.to_string()
382 K_compressed = GetPubKey(public_key.pubkey,True)
383 return K, K_compressed
390 from ecdsa.util import string_to_number, number_to_string
391 order = generator_secp256k1.order()
392 keypair = EC_KEY(string_to_number(k))
393 K = GetPubKey(keypair.pubkey,True)
396 data = chr(0) + k + rev_hex(int_to_hex(n,4)).decode('hex')
397 I = hmac.new(c, data, hashlib.sha512).digest()
399 I = hmac.new(c, K + rev_hex(int_to_hex(n,4)).decode('hex'), hashlib.sha512).digest()
401 k_n = number_to_string( (string_to_number(I[0:32]) + string_to_number(k)) % order , order )
406 def CKD_prime(K, c, n):
408 from ecdsa.util import string_to_number, number_to_string
409 order = generator_secp256k1.order()
411 if n & BIP32_PRIME: raise
413 K_public_key = ecdsa.VerifyingKey.from_string( K, curve = SECP256k1 )
414 K_compressed = GetPubKey(K_public_key.pubkey,True)
416 I = hmac.new(c, K_compressed + rev_hex(int_to_hex(n,4)).decode('hex'), hashlib.sha512).digest()
419 pubkey_point = string_to_number(I[0:32])*curve.generator + K_public_key.pubkey.point
420 public_key = ecdsa.VerifyingKey.from_public_point( pubkey_point, curve = SECP256k1 )
422 K_n = public_key.to_string()
423 K_n_compressed = GetPubKey(public_key.pubkey,True)
426 return K_n, K_n_compressed, c_n
430 def bip32_private_derivation(k, c, branch, sequence):
431 assert sequence.startswith(branch)
432 sequence = sequence[len(branch):]
433 for n in sequence.split('/'):
435 n = int(n[:-1]) + BIP32_PRIME if n[-1] == "'" else int(n)
437 K, K_compressed = get_pubkeys_from_secret(k)
438 return k.encode('hex'), c.encode('hex'), K.encode('hex'), K_compressed.encode('hex')
441 def bip32_public_derivation(c, K, branch, sequence):
442 assert sequence.startswith(branch)
443 sequence = sequence[len(branch):]
444 for n in sequence.split('/'):
446 K, cK, c = CKD_prime(K, c, n)
448 return c.encode('hex'), K.encode('hex'), cK.encode('hex')
454 ################################## transactions
456 MIN_RELAY_TX_FEE = 10000
460 def __init__(self, raw):
463 self.inputs = self.d['inputs']
464 self.outputs = self.d['outputs']
465 self.outputs = map(lambda x: (x['address'],x['value']), self.outputs)
466 self.input_info = None
467 self.is_complete = True
470 def from_io(klass, inputs, outputs):
471 raw = klass.serialize(inputs, outputs, for_sig = -1) # for_sig=-1 means do not sign
473 self.is_complete = False
475 self.outputs = outputs
477 for i in self.inputs:
478 e = { 'txid':i['tx_hash'], 'vout':i['index'], 'scriptPubKey':i.get('raw_output_script') }
480 self.input_info = extras
487 def multisig_script(klass, public_keys, num=None):
489 if num is None: num = n
490 # supports only "2 of 2", and "2 of 3" transactions
491 assert num <= n and n in [2,3]
500 for k in public_keys:
501 s += var_int(len(k)/2)
511 out = { "address": hash_160_to_bc_address(hash_160(s.decode('hex')), 5), "redeemScript":s }
515 def serialize( klass, inputs, outputs, for_sig = None ):
517 s = int_to_hex(1,4) # version
518 s += var_int( len(inputs) ) # number of inputs
519 for i in range(len(inputs)):
521 s += txin['tx_hash'].decode('hex')[::-1].encode('hex') # prev hash
522 s += int_to_hex(txin['index'],4) # prev index
525 pubkeysig = txin.get('pubkeysig')
527 pubkey, sig = pubkeysig[0]
528 sig = sig + chr(1) # hashtype
529 script = op_push( len(sig))
530 script += sig.encode('hex')
531 script += op_push( len(pubkey))
532 script += pubkey.encode('hex')
534 signatures = txin['signatures']
535 pubkeys = txin['pubkeys']
537 for sig in signatures:
539 script += op_push(len(sig)/2)
542 redeem_script = klass.multisig_script(pubkeys,2).get('redeemScript')
543 script += op_push(len(redeem_script)/2)
544 script += redeem_script
547 if txin.get('redeemScript'):
548 script = txin['redeemScript'] # p2sh uses the inner script
550 script = txin['raw_output_script'] # scriptsig
553 s += var_int( len(script)/2 ) # script length
555 s += "ffffffff" # sequence
557 s += var_int( len(outputs) ) # number of outputs
558 for output in outputs:
559 addr, amount = output
560 s += int_to_hex( amount, 8) # amount
561 addrtype, hash_160 = bc_address_to_hash_160(addr)
563 script = '76a9' # op_dup, op_hash_160
564 script += '14' # push 0x14 bytes
565 script += hash_160.encode('hex')
566 script += '88ac' # op_equalverify, op_checksig
568 script = 'a9' # op_hash_160
569 script += '14' # push 0x14 bytes
570 script += hash_160.encode('hex')
571 script += '87' # op_equal
575 s += var_int( len(script)/2 ) # script length
577 s += int_to_hex(0,4) # lock time
578 if for_sig is not None and for_sig != -1:
579 s += int_to_hex(1, 4) # hash type
584 return self.serialize(self.inputs, self.outputs, for_sig = i)
588 return Hash(self.raw.decode('hex') )[::-1].encode('hex')
590 def sign(self, private_keys):
593 for i in range(len(self.inputs)):
594 txin = self.inputs[i]
595 tx_for_sig = self.serialize( self.inputs, self.outputs, for_sig = i )
597 redeem_script = txin.get('redeemScript')
599 # 1 parse the redeem script
600 num, redeem_pubkeys = deserialize.parse_redeemScript(redeem_script)
601 self.inputs[i]["pubkeys"] = redeem_pubkeys
603 # build list of public/private keys
605 for sec in private_keys.values():
606 compressed = is_compressed(sec)
607 pkey = regenerate_key(sec)
608 pubkey = GetPubKey(pkey.pubkey, compressed)
609 keypairs[ pubkey.encode('hex') ] = sec
611 print "keypairs", keypairs
612 print redeem_script, redeem_pubkeys
614 # list of already existing signatures
615 signatures = txin.get("signatures",[])
616 print_error("signatures",signatures)
618 for pubkey in redeem_pubkeys:
620 # here we have compressed key.. it won't work
621 #public_key = ecdsa.VerifyingKey.from_string(pubkey[2:].decode('hex'), curve = SECP256k1)
622 #for s in signatures:
624 # public_key.verify_digest( s.decode('hex')[:-1], Hash( tx_for_sig.decode('hex') ), sigdecode = ecdsa.util.sigdecode_der)
626 # except ecdsa.keys.BadSignatureError:
630 # check if we have a key corresponding to the redeem script
631 if pubkey in keypairs.keys():
633 sec = keypairs[pubkey]
634 compressed = is_compressed(sec)
635 pkey = regenerate_key(sec)
637 private_key = ecdsa.SigningKey.from_secret_exponent( secexp, curve = SECP256k1 )
638 public_key = private_key.get_verifying_key()
639 sig = private_key.sign_digest( Hash( tx_for_sig.decode('hex') ), sigencode = ecdsa.util.sigencode_der )
640 assert public_key.verify_digest( sig, Hash( tx_for_sig.decode('hex') ), sigdecode = ecdsa.util.sigdecode_der)
641 signatures.append( sig.encode('hex') )
643 # for p2sh, pubkeysig is a tuple (may be incomplete)
644 self.inputs[i]["signatures"] = signatures
645 print_error("signatures",signatures)
646 self.is_complete = len(signatures) == num
649 sec = private_keys[txin['address']]
650 compressed = is_compressed(sec)
651 pkey = regenerate_key(sec)
653 private_key = ecdsa.SigningKey.from_secret_exponent( secexp, curve = SECP256k1 )
654 public_key = private_key.get_verifying_key()
655 pkey = EC_KEY(secexp)
656 pubkey = GetPubKey(pkey.pubkey, compressed)
657 sig = private_key.sign_digest( Hash( tx_for_sig.decode('hex') ), sigencode = ecdsa.util.sigencode_der )
658 assert public_key.verify_digest( sig, Hash( tx_for_sig.decode('hex') ), sigdecode = ecdsa.util.sigdecode_der)
660 self.inputs[i]["pubkeysig"] = [(pubkey, sig)]
661 self.is_complete = True
663 self.raw = self.serialize( self.inputs, self.outputs )
666 def deserialize(self):
668 vds = deserialize.BCDataStream()
669 vds.write(self.raw.decode('hex'))
670 self.d = deserialize.parse_Transaction(vds)
674 def has_address(self, addr):
676 for txin in self.inputs:
677 if addr == txin.get('address'):
680 for txout in self.outputs:
687 def get_value(self, addresses, prevout_values):
688 # return the balance for that tx
693 v_in = v_out = v_out_mine = 0
695 for item in self.inputs:
696 addr = item.get('address')
697 if addr in addresses:
700 key = item['prevout_hash'] + ':%d'%item['prevout_n']
701 value = prevout_values.get( key )
709 if not is_send: is_partial = False
711 for item in self.outputs:
714 if addr in addresses:
719 # some inputs are mine:
722 v = v_out_mine - v_out
728 v = v_out_mine - v_in
731 # some inputs are mine, but not all
735 # all inputs are mine
738 return is_relevant, is_send, v, fee
744 "complete":self.is_complete
746 if not self.is_complete:
748 for i in self.inputs:
749 e = { 'txid':i['tx_hash'], 'vout':i['index'],
750 'scriptPubKey':i.get('raw_output_script'),
751 'KeyID':i.get('KeyID'),
752 'redeemScript':i.get('redeemScript'),
753 'signatures':i.get('signatures'),
754 'pubkeys':i.get('pubkeys'),
757 self.input_info = extras
760 out['input_info'] = json.dumps(self.input_info).replace(' ','')
765 def requires_fee(self, verifier):
766 # see https://en.bitcoin.it/wiki/Transaction_fees
768 size = len(self.raw)/2
772 for o in self.outputs:
777 for i in self.inputs:
778 age = verifier.get_confirmations(i["tx_hash"])[0]
779 sum += i["value"] * age
780 priority = sum / size
781 print_error(priority, threshold)
782 return priority < threshold
787 def test_bip32(seed, sequence):
790 see https://en.bitcoin.it/wiki/BIP_0032_TestVectors
793 master_secret, master_chain, master_public_key, master_public_key_compressed = bip32_init(seed)
795 print "secret key", master_secret.encode('hex')
796 print "chain code", master_chain.encode('hex')
798 key_id = hash_160(master_public_key_compressed)
799 print "keyid", key_id.encode('hex')
801 print "address", hash_160_to_bc_address(key_id)
802 print "secret key", SecretToASecret(master_secret, True)
808 for n in sequence.split('/'):
810 print "Chain [%s]" % '/'.join(s)
812 n = int(n[:-1]) + BIP32_PRIME if n[-1] == "'" else int(n)
813 k0, c0 = CKD(k, c, n)
814 K0, K0_compressed = get_pubkeys_from_secret(k0)
817 print " * (main addr)", hash_160_to_bc_address(hash_160(K0_compressed))
820 print " * (hex)", k0.encode('hex')
821 print " * (wif)", SecretToASecret(k0, True)
824 print " * (hex)", c0.encode('hex')
833 if __name__ == '__main__':
834 test_bip32("000102030405060708090a0b0c0d0e0f", "0'/1/2'/2/1000000000")
835 test_bip32("fffcf9f6f3f0edeae7e4e1dedbd8d5d2cfccc9c6c3c0bdbab7b4b1aeaba8a5a29f9c999693908d8a8784817e7b7875726f6c696663605d5a5754514e4b484542","0/2147483647'/1/2147483646'/2")