Class: Bitcoin::ExtPubkey

Inherits:
Object
  • Object
show all
Includes:
HexConverter
Defined in:
lib/bitcoin/ext_key.rb

Overview

BIP-32 Extended public key

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from HexConverter

#to_hex

Instance Attribute Details

#chain_code ⇒ Object

Returns the value of attribute chain_code.



211
212
213
 
# File 'lib/bitcoin/ext_key.rb', line 211

def chain_code
  @chain_code
end

#depth ⇒ Object

Returns the value of attribute depth.



209
210
211
 
# File 'lib/bitcoin/ext_key.rb', line 209

def depth
  @depth
end

#number ⇒ Object

Returns the value of attribute number.



210
211
212
 
# File 'lib/bitcoin/ext_key.rb', line 210

def number
  @number
end

#parent_fingerprint ⇒ Object

Returns the value of attribute parent_fingerprint.



213
214
215
 
# File 'lib/bitcoin/ext_key.rb', line 213

def parent_fingerprint
  @parent_fingerprint
end

#pubkey ⇒ Object

hex format



212
213
214
 
# File 'lib/bitcoin/ext_key.rb', line 212

def pubkey
  @pubkey
end

#ver ⇒ Object

Returns the value of attribute ver.



208
209
210
 
# File 'lib/bitcoin/ext_key.rb', line 208

def ver
  @ver
end

Class Method Details

.encode_base58(hex) ⇒ String

Generate Base58 encoded key from BIP32 payload with hex format.

Parameters:

  • hex (String) —

    BIP32 payload with hex format.

Returns:

  • (String) —

    Base58 encoded extended key.



265
266
267
 
# File 'lib/bitcoin/ext_key.rb', line 265

def self.encode_base58(hex)
  Base58.encode(hex + Bitcoin.calc_checksum(hex))
end

.from_base58(address) ⇒ Object

import pub key from Base58 private key address



340
341
342
 
# File 'lib/bitcoin/ext_key.rb', line 340

def self.from_base58(address)
  ExtPubkey.parse_from_payload(ExtPubkey.validate_base58(address))
end

.parse_from_payload(payload) ⇒ Object

Raises:

  • (ArgumentError) 


320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
 
# File 'lib/bitcoin/ext_key.rb', line 320

def self.parse_from_payload(payload)
  buf = StringIO.new(payload)
  ext_pubkey = ExtPubkey.new
  ext_pubkey.ver = buf.read(4).bth # version
  raise ArgumentError, Errors::Messages::INVALID_BIP32_VERSION unless ExtPubkey.support_version?(ext_pubkey.ver)
  ext_pubkey.depth = buf.read(1).unpack1('C')
  ext_pubkey.parent_fingerprint = buf.read(4).bth
  ext_pubkey.number = buf.read(4).unpack1('N')
  if ext_pubkey.depth == 0
    raise ArgumentError, Errors::Messages::INVALID_BIP32_FINGERPRINT unless ext_pubkey.parent_fingerprint == ExtKey::MASTER_FINGERPRINT
    raise ArgumentError, Errors::Messages::INVALID_BIP32_ZERO_INDEX if ext_pubkey.number > 0
  end
  raise ArgumentError, Errors::Messages::INVALID_BIP32_ZERO_DEPTH if ext_pubkey.parent_fingerprint == ExtKey::MASTER_FINGERPRINT && ext_pubkey.depth > 0
  ext_pubkey.chain_code = buf.read(32)
  ext_pubkey.pubkey = Bitcoin::Key.new(pubkey: buf.read(33).bth).pubkey
  ext_pubkey
end

.support_version?(version) ⇒ Boolean

check whether version is supported version bytes.

Returns:

  • (Boolean) 


367
368
369
370
 
# File 'lib/bitcoin/ext_key.rb', line 367

def self.support_version?(version)
  p = Bitcoin.chain_params
  [p.bip49_pubkey_p2wpkh_p2sh_version, p.bip84_pubkey_p2wpkh_version, p.extended_pubkey_version].include?(version)
end

.validate_base58(address) ⇒ String

Validate address checksum and return payload.

Parameters:

  • BIP32 (String) —

    Base58 address

Returns:

  • (String) —

    BIP32 payload with binary format

Raises:

  • (ArgumentError) 


347
348
349
350
351
 
# File 'lib/bitcoin/ext_key.rb', line 347

def self.validate_base58(address)
  raw = Base58.decode(address)
  raise ArgumentError, Errors::Messages::INVALID_CHECKSUM unless Bitcoin.calc_checksum(raw[0...-8]) == raw[-8..-1]
  raw[0...-8].htb
end

.version_from_purpose(purpose) ⇒ Object

get version bytes from purpose' value.



354
355
356
357
358
359
360
361
362
363
364
 
# File 'lib/bitcoin/ext_key.rb', line 354

def self.version_from_purpose(purpose)
  v = purpose - Bitcoin::HARDENED_THRESHOLD
  case v
    when 49
      Bitcoin.chain_params.bip49_pubkey_p2wpkh_p2sh_version
    when 84
      Bitcoin.chain_params.bip84_pubkey_p2wpkh_version
    else
      Bitcoin.chain_params.extended_pubkey_version
  end
end

Instance Method Details

#==(other) ⇒ Object 



316
317
318
 
# File 'lib/bitcoin/ext_key.rb', line 316

def ==(other)
  to_payload == other.to_payload
end

#addr ⇒ Object

get address



230
231
232
233
234
235
236
237
238
239
 
# File 'lib/bitcoin/ext_key.rb', line 230

def addr
  case version
    when Bitcoin.chain_params.bip49_pubkey_p2wpkh_p2sh_version
      key.to_nested_p2wpkh
    when Bitcoin.chain_params.bip84_pubkey_p2wpkh_version
      key.to_p2wpkh
    else
      key.to_p2pkh
  end
end

#derive(number) ⇒ Object

derive child key

Raises:

  • (IndexError) 


275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
 
# File 'lib/bitcoin/ext_key.rb', line 275

def derive(number)
  new_key = ExtPubkey.new
  new_key.depth = depth + 1
  raise IndexError, 'Depth over 255.' if new_key.depth > Bitcoin::ExtKey::MAX_DEPTH
  new_key.number = number
  new_key.parent_fingerprint = fingerprint
  raise 'hardened key is not support' if number > (Bitcoin::HARDENED_THRESHOLD - 1)
  data = pub.htb << [number].pack('N')
  l = Bitcoin.hmac_sha512(chain_code, data)
  left = l[0..31].bth.to_i(16)
  raise 'invalid key' if left >= CURVE_ORDER || left == 0
  l_priv = ECDSA::Format::IntegerOctetString.encode(left, 32)
  p1 = Bitcoin::Key.new(priv_key: l_priv.bth, key_type: Bitcoin::Key::TYPES[:uncompressed]).to_point
  p2 = Bitcoin::Key.new(pubkey: pubkey, key_type: key_type).to_point
  new_key.pubkey = (p1 + p2).to_hex
  new_key.chain_code = l[32..-1]
  # A depth 1 key derives its version bytes from the purpose, see #version.
  new_key.ver = new_key.depth == 1 ? nil : version
  new_key
end

#fingerprint ⇒ Object

get fingerprint



253
254
255
 
# File 'lib/bitcoin/ext_key.rb', line 253

def fingerprint
  identifier.slice(0..7)
end

#hardened? ⇒ Boolean

whether hardened key.

Returns:

  • (Boolean) 


270
271
272
 
# File 'lib/bitcoin/ext_key.rb', line 270

def hardened?
  number >= Bitcoin::HARDENED_THRESHOLD
end

#hash160 ⇒ Object 



225
226
227
 
# File 'lib/bitcoin/ext_key.rb', line 225

def hash160
  Bitcoin.hash160(pub)
end

#identifier ⇒ Object

get key identifier



248
249
250
 
# File 'lib/bitcoin/ext_key.rb', line 248

def identifier
  Bitcoin.hash160(pub)
end

#key ⇒ Bitcoin::Key

get key object

Returns:



243
244
245
 
# File 'lib/bitcoin/ext_key.rb', line 243

def key
  Bitcoin::Key.new(pubkey: pubkey, key_type: key_type)
end

#key_type ⇒ Object

get key type defined by BIP-178 using version.



304
305
306
307
308
309
310
311
312
313
314
 
# File 'lib/bitcoin/ext_key.rb', line 304

def key_type
  v = version
  case v
  when Bitcoin.chain_params.bip49_pubkey_p2wpkh_p2sh_version
    Bitcoin::Key::TYPES[:p2wpkh_p2sh]
  when Bitcoin.chain_params.bip84_pubkey_p2wpkh_version
    Bitcoin::Key::TYPES[:p2wpkh]
  when Bitcoin.chain_params.extended_pubkey_version
    Bitcoin::Key::TYPES[:compressed]
  end
end

#pub ⇒ Object 



221
222
223
 
# File 'lib/bitcoin/ext_key.rb', line 221

def pub
  pubkey
end

#to_base58 ⇒ Object

Base58 encoded extended pubkey



258
259
260
 
# File 'lib/bitcoin/ext_key.rb', line 258

def to_base58
  ExtPubkey.encode_base58(to_hex)
end

#to_payload ⇒ Object

serialize extended pubkey



216
217
218
219
 
# File 'lib/bitcoin/ext_key.rb', line 216

def to_payload
  version.htb << [depth].pack('C') <<
      parent_fingerprint.htb << [number].pack('N') << chain_code << pub.htb
end

#version ⇒ Object

get version bytes using serialization format



297
298
299
300
301
 
# File 'lib/bitcoin/ext_key.rb', line 297

def version
  return ver if ver
  return ExtPubkey.version_from_purpose(number) if depth == 1
  Bitcoin.chain_params.extended_pubkey_version
end