class Tapyrus::ExtKey

BIP32 Extended private key

Constants

MASTER_FINGERPRINT
MAX_DEPTH

Attributes

chain_code[RW]
depth[RW]
key[RW]
number[RW]
parent_fingerprint[RW]
ver[RW]

Public Class Methods

from_base58(address) click to toggle source

import private key from Base58 private key address

# File lib/tapyrus/ext_key.rb, line 163
def self.from_base58(address)
  ExtKey.parse_from_payload(ExtPubkey.validate_checksum(address))
end
generate_master(seed) click to toggle source

generate master key from seed. @params [String] seed a seed data with hex format.

# File lib/tapyrus/ext_key.rb, line 21
def self.generate_master(seed)
  ext_key = ExtKey.new
  ext_key.depth = ext_key.number = 0
  ext_key.parent_fingerprint = '00000000'
  l = Tapyrus.hmac_sha512('Tapyrus seed', seed.htb)
  left = l[0..31].bth.to_i(16)
  raise 'invalid key' if left >= CURVE_ORDER || left == 0
  ext_key.key = Tapyrus::Key.new(priv_key: l[0..31].bth, key_type: Tapyrus::Key::TYPES[:compressed])
  ext_key.chain_code = l[32..-1]
  ext_key
end
parse_from_payload(payload) click to toggle source
# File lib/tapyrus/ext_key.rb, line 139
def self.parse_from_payload(payload)
  buf = StringIO.new(payload)
  ext_key = ExtKey.new
  ext_key.ver = buf.read(4).bth # version
  raise ArgumentError, Errors::Messages::INVALID_BIP32_VERSION unless ExtKey.support_version?(ext_key.ver)
  ext_key.depth = buf.read(1).unpack('C').first
  ext_key.parent_fingerprint = buf.read(4).bth
  ext_key.number = buf.read(4).unpack('N').first
  if ext_key.depth == 0
    unless ext_key.parent_fingerprint == ExtKey::MASTER_FINGERPRINT
      raise ArgumentError, Errors::Messages::INVALID_BIP32_FINGERPRINT
    end
    raise ArgumentError, Errors::Messages::INVALID_BIP32_ZERO_INDEX if ext_key.number > 0
  end
  if ext_key.parent_fingerprint == ExtKey::MASTER_FINGERPRINT && ext_key.depth > 0
    raise ArgumentError, Errors::Messages::INVALID_BIP32_ZERO_DEPTH
  end
  ext_key.chain_code = buf.read(32)
  raise ArgumentError, Errors::Messages::INVALID_BIP32_PRIV_PREFIX unless buf.read(1).bth == '00' # 0x00
  ext_key.key = Tapyrus::Key.new(priv_key: buf.read(32).bth, key_type: Tapyrus::Key::TYPES[:compressed])
  ext_key
end
support_version?(version) click to toggle source

check whether version is supported version bytes.

# File lib/tapyrus/ext_key.rb, line 181
def self.support_version?(version)
  p = Tapyrus.chain_params
  [p.bip49_privkey_p2wpkh_p2sh_version, p.bip84_privkey_p2wpkh_version, p.extended_privkey_version].include?(
    version
  )
end
version_from_purpose(purpose) click to toggle source

get version bytes from purpose' value.

# File lib/tapyrus/ext_key.rb, line 168
def self.version_from_purpose(purpose)
  v = purpose - Tapyrus::HARDENED_THRESHOLD
  case v
  when 49
    Tapyrus.chain_params.bip49_privkey_p2wpkh_p2sh_version
  when 84
    Tapyrus.chain_params.bip84_privkey_p2wpkh_version
  else
    Tapyrus.chain_params.extended_privkey_version
  end
end

Public Instance Methods

==(other) click to toggle source
# File lib/tapyrus/ext_key.rb, line 135
def ==(other)
  to_payload == other.to_payload
end
addr() click to toggle source

get address

# File lib/tapyrus/ext_key.rb, line 71
def addr
  ext_pubkey.addr
end
derive(number, harden = false) click to toggle source

derive new key @param [Integer] number a child index @param [Boolean] harden whether hardened key or not. If true, 2^31 is added to number. @return [Tapyrus::ExtKey] derived new key.

# File lib/tapyrus/ext_key.rb, line 94
def derive(number, harden = false)
  number += Tapyrus::HARDENED_THRESHOLD if harden
  new_key = ExtKey.new
  new_key.depth = depth + 1
  new_key.number = number
  new_key.parent_fingerprint = fingerprint
  if number > (Tapyrus::HARDENED_THRESHOLD - 1)
    data = [0x00].pack('C') << key.priv_key.htb << [number].pack('N')
  else
    data = key.pubkey.htb << [number].pack('N')
  end
  l = Tapyrus.hmac_sha512(chain_code, data)
  left = l[0..31].bth.to_i(16)
  raise 'invalid key' if left >= CURVE_ORDER
  child_priv = (left + key.priv_key.to_i(16)) % CURVE_ORDER
  raise 'invalid key ' if child_priv >= CURVE_ORDER
  new_key.key = Tapyrus::Key.new(priv_key: child_priv.to_even_length_hex.rjust(64, '0'), key_type: key_type)
  new_key.chain_code = l[32..-1]
  new_key.ver = version
  new_key
end
ext_pubkey() click to toggle source

get ExtPubkey from priv_key

# File lib/tapyrus/ext_key.rb, line 34
def ext_pubkey
  k = ExtPubkey.new
  k.depth = depth
  k.number = number
  k.parent_fingerprint = parent_fingerprint
  k.chain_code = chain_code
  k.pubkey = key.pubkey
  k.ver = priv_ver_to_pub_ver
  k
end
fingerprint() click to toggle source

get fingerprint

# File lib/tapyrus/ext_key.rb, line 81
def fingerprint
  identifier.slice(0..7)
end
hardened?() click to toggle source

whether hardened key.

# File lib/tapyrus/ext_key.rb, line 86
def hardened?
  number >= Tapyrus::HARDENED_THRESHOLD
end
hash160() click to toggle source
# File lib/tapyrus/ext_key.rb, line 66
def hash160
  Tapyrus.hash160(pub)
end
identifier() click to toggle source

get key identifier

# File lib/tapyrus/ext_key.rb, line 76
def identifier
  Tapyrus.hash160(key.pubkey)
end
key_type() click to toggle source

get key type defined by BIP-178 using version.

# File lib/tapyrus/ext_key.rb, line 123
def key_type
  v = version
  case v
  when Tapyrus.chain_params.bip49_privkey_p2wpkh_p2sh_version
    Tapyrus::Key::TYPES[:p2wpkh_p2sh]
  when Tapyrus.chain_params.bip84_privkey_p2wpkh_version
    Tapyrus::Key::TYPES[:p2wpkh]
  when Tapyrus.chain_params.extended_privkey_version
    Tapyrus::Key::TYPES[:compressed]
  end
end
master?() click to toggle source
# File lib/tapyrus/ext_key.rb, line 200
def master?
  depth == 0 && number == 0 && parent_fingerprint == '00000000'
end
priv() click to toggle source

get private key(hex)

# File lib/tapyrus/ext_key.rb, line 57
def priv
  key.priv_key
end
priv_ver_to_pub_ver() click to toggle source

convert privkey version to pubkey version

# File lib/tapyrus/ext_key.rb, line 189
def priv_ver_to_pub_ver
  case version
  when Tapyrus.chain_params.bip49_privkey_p2wpkh_p2sh_version
    Tapyrus.chain_params.bip49_pubkey_p2wpkh_p2sh_version
  when Tapyrus.chain_params.bip84_privkey_p2wpkh_version
    Tapyrus.chain_params.bip84_pubkey_p2wpkh_version
  else
    Tapyrus.chain_params.extended_pubkey_version
  end
end
pub() click to toggle source

get public key(hex)

# File lib/tapyrus/ext_key.rb, line 62
def pub
  key.pubkey
end
to_base58() click to toggle source

Base58 encoded extended private key

# File lib/tapyrus/ext_key.rb, line 52
def to_base58
  ExtPubkey.encode_base58(to_hex)
end
to_payload() click to toggle source

serialize extended private key

# File lib/tapyrus/ext_key.rb, line 46
def to_payload
  version.htb << [depth].pack('C') << parent_fingerprint.htb << [number].pack('N') << chain_code <<
    [0x00].pack('C') << key.priv_key.htb
end
version() click to toggle source

get version bytes using serialization format

# File lib/tapyrus/ext_key.rb, line 117
def version
  return ExtKey.version_from_purpose(number) if depth == 1
  ver ? ver : Tapyrus.chain_params.extended_privkey_version
end