Class: Bitcoin::PSBT::Output

Inherits:
Object
  • Object
show all
Defined in:
lib/bitcoin/psbt/output.rb

Overview

Class for PSBTs which contains per output information

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Output

Returns a new instance of Output.



16
17
18
19
20
21
 
# File 'lib/bitcoin/psbt/output.rb', line 16

def initialize
  @hd_key_paths = {}
  @proprietaries = []
  @tap_bip32_derivations = {}
  @unknowns = {}
end

Instance Attribute Details

#hd_key_paths ⇒ Object

Returns the value of attribute hd_key_paths.



9
10
11
 
# File 'lib/bitcoin/psbt/output.rb', line 9

def hd_key_paths
  @hd_key_paths
end

#proprietaries ⇒ Object

Returns the value of attribute proprietaries.



10
11
12
 
# File 'lib/bitcoin/psbt/output.rb', line 10

def proprietaries
  @proprietaries
end

#redeem_script ⇒ Object

Returns the value of attribute redeem_script.



7
8
9
 
# File 'lib/bitcoin/psbt/output.rb', line 7

def redeem_script
  @redeem_script
end

#tap_bip32_derivations ⇒ Object

Returns the value of attribute tap_bip32_derivations.



13
14
15
 
# File 'lib/bitcoin/psbt/output.rb', line 13

def tap_bip32_derivations
  @tap_bip32_derivations
end

#tap_internal_key ⇒ Object

Returns the value of attribute tap_internal_key.



11
12
13
 
# File 'lib/bitcoin/psbt/output.rb', line 11

def tap_internal_key
  @tap_internal_key
end

#tap_tree ⇒ Object

Returns the value of attribute tap_tree.



12
13
14
 
# File 'lib/bitcoin/psbt/output.rb', line 12

def tap_tree
  @tap_tree
end

#unknowns ⇒ Object

Returns the value of attribute unknowns.



14
15
16
 
# File 'lib/bitcoin/psbt/output.rb', line 14

def unknowns
  @unknowns
end

#witness_script ⇒ Object

Returns the value of attribute witness_script.



8
9
10
 
# File 'lib/bitcoin/psbt/output.rb', line 8

def witness_script
  @witness_script
end

Class Method Details

.parse_from_buf(buf) ⇒ Bitcoin::PSBTOutput

parse PSBT output data form buffer.

Parameters:

  • buf (StringIO) —

    psbt buffer.

Returns:

  • (Bitcoin::PSBTOutput) —

    psbt output.

Raises:

  • (ArgumentError) 


26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/bitcoin/psbt/output.rb', line 26

def self.parse_from_buf(buf)
  output = self.new
  found_sep = false
  until buf.eof?
    key_len = Bitcoin.unpack_var_int_from_io(buf)
    if key_len == 0
      found_sep = true
      break
    end
    key_type = buf.read(1).unpack1('C')
    key = buf.read(key_len - 1)
    value = buf.read(Bitcoin.unpack_var_int_from_io(buf))
    case key_type
    when PSBT_OUT_TYPES[:redeem_script]
      raise ArgumentError, 'Invalid output redeemScript typed key.' unless key_len == 1
      raise ArgumentError, 'Duplicate Key, output redeemScript already provided' if output.redeem_script
      output.redeem_script = value
    when PSBT_OUT_TYPES[:witness_script]
      raise ArgumentError, 'Invalid output witnessScript typed key.' unless key_len == 1
      raise ArgumentError, 'Duplicate Key, output witnessScript already provided' if output.witness_script
      output.witness_script = value
    when PSBT_OUT_TYPES[:bip32_derivation]
      raise ArgumentError, 'Duplicate Key, pubkey derivation path already provided' if output.hd_key_paths[key.bth]
      output.hd_key_paths[key.bth] = Bitcoin::PSBT::HDKeyPath.new(key, Bitcoin::PSBT::KeyOriginInfo.parse_from_payload(value))
    when PSBT_OUT_TYPES[:proprietary]
      raise ArgumentError, 'Duplicate Key, key for proprietary value already provided.' if output.proprietaries.any?{|p| p.key == key}
      output.proprietaries << Proprietary.new(key, value)
    when PSBT_OUT_TYPES[:tap_internal_key]
      raise ArgumentError, 'Invalid output tap internal key typed key.' unless key_len == 1
      raise ArgumentError, 'Invalid x-only public key size for the type tap internal key' unless value.bytesize == X_ONLY_PUBKEY_SIZE
      output.tap_internal_key = value.bth
    when PSBT_OUT_TYPES[:tap_tree]
      raise ArgumentError, 'Invalid output tap tree typed key.' unless key_len == 1
      output.tap_tree = value.bth # TODO implement builder.
    when PSBT_OUT_TYPES[:tap_bip32_derivation]
      raise ArgumentError, 'Duplicate Key, key for tap bip32 derivation value already provided.' if output.tap_bip32_derivations[key.bth]
      raise ArgumentError, 'Size of key was not the expected size for the type tap bip32 derivation' unless key.bytesize == X_ONLY_PUBKEY_SIZE
      output.tap_bip32_derivations[key.bth] = value.bth
    else
      unknown_key = ([key_type].pack('C') + key).bth
      raise ArgumentError, 'Duplicate Key, key for unknown value already provided' if output.unknowns[unknown_key]
      output.unknowns[unknown_key] = value
    end
  end
  raise ArgumentError, 'Separator is missing at the end of an output map.' unless found_sep
  output
end

Instance Method Details

#merge(psbo) ⇒ Bitcoin::PSBT::Output

merge two PSBT outputs to create one PSBT.

Parameters:

  • psbo (Bitcoin::PSBT::Output) —

    PSBT output to be combined which must have same property in PSBT Output.

Returns:

Raises:

  • (ArgumentError) 


91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/bitcoin/psbt/output.rb', line 91

def merge(psbo)
  raise ArgumentError, 'The argument psbt must be an instance of Bitcoin::PSBT::Output.' unless psbo.is_a?(Bitcoin::PSBT::Output)
  raise ArgumentError, 'The Partially Signed Output\'s redeem_script are different.' unless redeem_script == psbo.redeem_script
  raise ArgumentError, 'The Partially Signed Output\'s witness_script are different.' unless witness_script == psbo.witness_script
  combined = Bitcoin::PSBT::Output.new
  combined.redeem_script = redeem_script
  combined.witness_script = witness_script
  combined.unknowns = Hash[unknowns.merge(psbo.unknowns).sort]
  combined.hd_key_paths = hd_key_paths.merge(psbo.hd_key_paths)
  combined
end

#to_h ⇒ Object 



103
104
105
106
107
108
109
110
111
112
113
114
 
# File 'lib/bitcoin/psbt/output.rb', line 103

def to_h
  h = {}
  h[:redeem_script] = redeem_script.bth if redeem_script
  h[:witness_script] = witness_script.bth if witness_script
  h[:bip32_derivs] = hd_key_paths.values.map(&:to_h) unless hd_key_paths.empty?
  h[:proprietary] = proprietaries.map(&:to_h) unless proprietaries.empty?
  h[:tap_internal_key] = tap_internal_key if tap_internal_key
  h[:tap_tree] = tap_tree if tap_tree
  h[:tap_bip32_derivs] = tap_bip32_derivations.map{|k, v| {"#{k}": v}} unless tap_bip32_derivations.empty?
  h[:unknown] = unknowns.map {|k, v| {"#{k}": v.bth}} unless unknowns.empty?
  h
end

#to_payload ⇒ Object 



74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/bitcoin/psbt/output.rb', line 74

def to_payload
  payload = ''
  payload << PSBT.serialize_to_vector(PSBT_OUT_TYPES[:redeem_script], value: redeem_script) if redeem_script
  payload << PSBT.serialize_to_vector(PSBT_OUT_TYPES[:witness_script], value: witness_script) if witness_script
  payload << hd_key_paths.values.map{|v|v.to_payload(PSBT_OUT_TYPES[:bip32_derivation])}.join
  payload << proprietaries.map(&:to_payload).join
  payload << PSBT.serialize_to_vector(PSBT_OUT_TYPES[:tap_internal_key], value: tap_internal_key.htb) if tap_internal_key
  payload << PSBT.serialize_to_vector(PSBT_OUT_TYPES[:tap_tree], value: tap_tree.htb) if tap_tree
  payload << tap_bip32_derivations.map{|k, v|PSBT.serialize_to_vector(PSBT_OUT_TYPES[:tap_bip32_derivation], key: k.htb, value: v.htb)}.join
  payload << unknowns.map {|k,v|Bitcoin.pack_var_int(k.htb.bytesize) << k.htb << Bitcoin.pack_var_int(v.bytesize) << v}.join
  payload << PSBT_SEPARATOR.itb
  payload
end