bitcoinrb 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: af836e45167490d93d1d9b5d8f29f4e473a78dc314b98cd789bb47e347a42037
-  data.tar.gz: 020fe745057f3b987c8bd8828be9f7f657d3085a7d8ee37cf0218b0761202325
+  metadata.gz: e8103017ba6b480dc45caea8b9544720003c486167c3e867be738ccdc40faef7
+  data.tar.gz: 3807ee81a2ed26a526c19903c616ebb7af5b2a9c8434a76398e538a02c34e126
 SHA512:
-  metadata.gz: 0db2c744f372a2e71c337cb8970bb8cad81f37aa81824504d5fe6ee46819516ca6869c3cab0af1474aa0906905496af3e8f97eacc6cdaf9b7eced0a6cd247ff2
-  data.tar.gz: dab1256db8085c43ec5ab5d784d465cbdb3d74e663d4f052fd76161decacd9fb5fe22b3c2f99cc20381dda8ea203d63866db45e6e8c8ed6d8b4a2d4c27acfe89
+  metadata.gz: 97a9df2fee4c9d2fb7c84555d82e0f1ef692e0889c964fc7615f328467925a5b099be19801b19321a9b12fc55493663f1813be4074e5fc95add8948cd52ca2e4
+  data.tar.gz: '0370268e40a85bf6face9592b8dc3cf260b6357e796f62c7e6abddaeeef2d3ec561e4336ba859c5f8426dcedd80eba6d9ec632941e284791df9571ff613182e5'

data/.ruby-version

@@ -1 +1 @@
-ruby-3.0.0
+ruby-3.0.2

data/lib/bitcoin/key.rb

@@ -30,7 +30,6 @@ module Bitcoin
     # @param [Boolean] compressed [Deprecated] whether public key is compressed.
     # @return [Bitcoin::Key] a key object.
     def initialize(priv_key: nil, pubkey: nil, key_type: nil, compressed: true, allow_hybrid: false)
-      puts "[Warning] Use key_type parameter instead of compressed. compressed parameter removed in the future." if key_type.nil? && !compressed.nil? && pubkey.nil?
       if key_type
         @key_type = key_type
         compressed = @key_type != TYPES[:uncompressed]
@@ -213,7 +212,6 @@ module Bitcoin
     # get xonly public key (32 bytes).
     # @return [String] xonly public key with hex format
     def xonly_pubkey
-      puts "Derive a public key whose y-coordinate is different from this public key." if compressed? && pubkey[0...2] != '02'
       pubkey[2..65]
     end
 

data/lib/bitcoin/psbt/tx.rb

@@ -162,6 +162,15 @@ module Bitcoin
         Base64.strict_encode64(to_payload)
       end
 
+      # Store the PSBT to a file.
+      # @param [String] path File path to store.
+      def to_file(path)
+        raise ArgumentError, 'The file already exists' if File.exist?(path)
+        File.open(path, 'w') do |f|
+          f.write(to_payload)
+        end
+      end
+
       # update input key-value maps.
       # @param [Bitcoin::Tx] prev_tx previous tx reference by input.
       # @param [Bitcoin::Script] redeem_script redeem script to set input.

data/lib/bitcoin/psbt.rb

@@ -31,6 +31,14 @@ module Bitcoin
       s << Bitcoin.pack_var_int(value.bytesize) << value
       s
     end
+
+    # Load PSBT from file.
+    # @param [String] path File path of PSBT.
+    # @return [Bitcoin::PSBT::Tx] PSBT object.
+    def load_from_file(path)
+      raise ArgumentError, 'File not found' unless File.exist?(path)
+      Bitcoin::PSBT::Tx.parse_from_payload(File.read(path))
+    end
   end
 
 end

data/lib/bitcoin/sighash_generator.rb

@@ -62,6 +62,7 @@ module Bitcoin
 
       def generate(tx, input_index, hash_type, opts)
         amount = opts[:amount]
+        raise ArgumentError, 'segwit sighash requires amount.' unless amount
         output_script = opts[:script_code]
         skip_separator_index = opts[:skip_separator_index]
         hash_prevouts = Bitcoin.double_sha256(tx.inputs.map{|i|i.out_point.to_payload}.join)

data/lib/bitcoin/taproot/leaf_node.rb

@@ -7,7 +7,7 @@ module Bitcoin
       # Initialize
       # @param [Bitcoin::Script] script Locking script
       # @param [Integer] leaf_ver The leaf version of this script.
-      def initialize(script, leaf_ver)
+      def initialize(script, leaf_ver = Bitcoin::TAPROOT_LEAF_TAPSCRIPT)
         raise Taproot::Error, 'script must be Bitcoin::Script object' unless script.is_a?(Bitcoin::Script)
         @script = script
         @leaf_ver = leaf_ver

data/lib/bitcoin/taproot/simple_builder.rb

@@ -1,34 +1,50 @@
 module Bitcoin
   module Taproot
 
-    # Utility class to construct Taproot outputs from internal key and script tree.
+    # Utility class to construct Taproot outputs from internal key and script tree.keyPathSpending
     # SimpleBuilder builds a script tree that places all lock scripts, in the order they are added, as leaf nodes.
     # It is not possible to specify the depth of the locking script or to insert any intermediate nodes.
     class SimpleBuilder
       include Bitcoin::Opcodes
 
       attr_reader :internal_key # String with hex format
-      attr_reader :leaves # Array[LeafNode]
+      attr_reader :branches # List of branch that has two child leaves
 
       # Initialize builder.
       # @param [String] internal_key Internal public key with hex format.
-      # @param [Array[Bitcoin::Script]] scripts Scripts for each lock condition.
-      # @param [Integer] leaf_ver (Optional) The leaf version of tapscript.
-      # @raise [Bitcoin::Taproot::Builder] +internal_pubkey+ dose not xonly public key or script in +scripts+ does not instance of Bitcoin::Script.
+      # @param [Array[Bitcoin::Taproot::LeafNode]] leaves (Optional) Array of leaf nodes for each lock condition.
+      # @raise [Bitcoin::Taproot::Builder] +internal_pubkey+ dose not xonly public key or leaf in +leaves+ does not instance of Bitcoin::Taproot::LeafNode.
       # @return [Bitcoin::Taproot::SimpleBuilder]
-      def initialize(internal_key, *scripts, leaf_ver: Bitcoin::TAPROOT_LEAF_TAPSCRIPT)
+      def initialize(internal_key, leaves = [])
         raise Error, 'Internal public key must be 32 bytes' unless internal_key.htb.bytesize == 32
-        @leaves = scripts.map { |script| LeafNode.new(script, leaf_ver) }
+        raise Error, 'leaf must be Bitcoin::Taproot::LeafNode object' if leaves.find{ |leaf| !leaf.is_a?(Bitcoin::Taproot::LeafNode)}
+
+        @leaves = leaves
+        @branches = leaves.each_slice(2).map.to_a
         @internal_key = internal_key
       end
 
-      # Add lock script to leaf node.
-      # @param [Bitcoin::Script] script lock script.
-      # @param [Integer] leaf_ver (Optional) The leaf version of tapscript.
-      # @raise [Bitcoin::Taproot::Builder] If +script+ does not instance of Bitcoin::Script.
-      # @return [Bitcoin::Taproot::SimpleBuilder] self
-      def <<(script, leaf_ver: Bitcoin::TAPROOT_LEAF_TAPSCRIPT)
-        leaves << LeafNode.new(script, leaf_ver)
+      # Add a leaf node to the end of the current branch.
+      # @param [Bitcoin::Taproot::LeafNode] leaf Leaf node to be added.
+      def add_leaf(leaf)
+        raise Error, 'leaf must be Bitcoin::Taproot::LeafNode object' unless leaf.is_a?(Bitcoin::Taproot::LeafNode)
+
+        if branches.last&.size == 1
+          branches.last << leaf
+        else
+          branches << [leaf]
+        end
+        self
+      end
+
+      # Add a pair of leaf nodes as a branch. If there is only one, add a branch with only one child.
+      # @param [Bitcoin::Taproot::LeafNode] leaf1 Leaf node to be added.
+      # @param [Bitcoin::Taproot::LeafNode] leaf2 Leaf node to be added.
+      def add_branch(leaf1, leaf2 = nil)
+        raise Error, 'leaf1 must be Bitcoin::Taproot::LeafNode object' unless leaf1.is_a?(Bitcoin::Taproot::LeafNode)
+        raise Error, 'leaf2 must be Bitcoin::Taproot::LeafNode object' if leaf2 && !leaf2.is_a?(Bitcoin::Taproot::LeafNode)
+
+        branches << (leaf2.nil? ? [leaf1] : [leaf1, leaf2])
         self
       end
 
@@ -42,8 +58,7 @@ module Bitcoin
       # Compute the tweaked public key.
       # @return [Bitcoin::Key] the tweaked public key
       def tweak_public_key
-        key = Bitcoin::Key.new(priv_key: tweak.bth, key_type: Key::TYPES[:compressed])
-        Bitcoin::Key.from_point(key.to_point + Bitcoin::Key.from_xonly_pubkey(internal_key).to_point)
+        Taproot.tweak_public_key(Bitcoin::Key.from_xonly_pubkey(internal_key), merkle_root)
       end
 
       # Compute the secret key for a tweaked public key.
@@ -51,29 +66,33 @@ module Bitcoin
       # @return [Bitcoin::Key] secret key for a tweaked public key
       def tweak_private_key(key)
         raise Error, 'Requires private key' unless key.priv_key
-        p = key.to_point
-        private_key = p.has_even_y? ? key.priv_key.to_i(16) : ECDSA::Group::Secp256k1.order - key.priv_key.to_i(16)
-        Bitcoin::Key.new(priv_key: ((tweak.bti + private_key) % ECDSA::Group::Secp256k1.order).to_even_length_hex)
+
+        Taproot.tweak_private_key(key, merkle_root)
       end
 
       # Generate control block needed to unlock with script-path.
-      # @param [Bitcoin::Script] script Script to use for unlocking.
-      # @param [Integer] leaf_ver leaf version of script.
+      # @param [Bitcoin::Taproot::LeafNode] leaf Leaf to use for unlocking.
       # @return [String] control block with binary format.
-      def control_block(script, leaf_ver: Bitcoin::TAPROOT_LEAF_TAPSCRIPT)
-        path = inclusion_proof(script, leaf_ver: leaf_ver)
+      def control_block(leaf)
+        path = inclusion_proof(leaf)
         parity = tweak_public_key.to_point.has_even_y? ? 0 : 1
-        [parity + leaf_ver].pack("C") + internal_key.htb + path.join
+        [parity + leaf.leaf_ver].pack("C") + internal_key.htb + path.join
       end
 
-      # Generate inclusion proof for +script+.
-      # @param [Bitcoin::Script] script The script in script tree.
-      # @param [Integer] leaf_ver (Optional) The leaf version of tapscript.
+      # Generate inclusion proof for +leaf+.
+      # @param [Bitcoin::Taproot::LeafNode] leaf The leaf node in script tree.
       # @return [Array[String]] Inclusion proof.
-      def inclusion_proof(script, leaf_ver: Bitcoin::TAPROOT_LEAF_TAPSCRIPT)
-        parents = leaves
-        parent_hash = leaf_hash(script, leaf_ver: leaf_ver)
+      # @raise [Bitcoin::Taproot::Error] If the specified +leaf+ does not exist
+      def inclusion_proof(leaf)
         proofs = []
+        target_branch = branches.find{|b| b.include?(leaf)}
+        raise Error 'Specified leaf does not exist' unless target_branch
+
+        # flatten each branch
+        proofs << hash_value(target_branch.find{|b| b != leaf}) if target_branch.size == 2
+        parent_hash = combine_hash(target_branch)
+        parents = branches.map {|pair| combine_hash(pair)}
+
         until parents.size == 1
           parents = parents.each_slice(2).map do |pair|
             combined = combine_hash(pair)
@@ -92,29 +111,26 @@ module Bitcoin
         proofs
       end
 
-      # Computes leaf hash
-      # @param [Bitcoin::Script] script
-      # @param [Integer] leaf_ver leaf version
-      # @@return [String] leaf hash with binary format.
-      def leaf_hash(script, leaf_ver: Bitcoin::TAPROOT_LEAF_TAPSCRIPT)
-        raise Error, 'script does not exist' unless leaves.find{ |leaf| leaf.script == script}
-        LeafNode.new(script, leaf_ver).leaf_hash
-      end
-
       private
 
       # Compute tweak from script tree.
       # @return [String] tweak with binary format.
       def tweak
-        parents = leaves
+        Taproot.tweak(Bitcoin::Key.from_xonly_pubkey(internal_key), merkle_root)
+      end
+
+      # Calculate merkle root from branches.
+      # @return [String] merkle root with hex format.
+      def merkle_root
+        parents = branches.map {|pair| combine_hash(pair)}
         if parents.empty?
           parents = ['']
+        elsif parents.size == 1
+          parents = [combine_hash(parents)]
         else
           parents = parents.each_slice(2).map { |pair| combine_hash(pair) } until parents.size == 1
         end
-        t = Bitcoin.tagged_hash('TapTweak', internal_key.htb + parents.first)
-        raise Error, 'tweak value exceeds the curve order' if t.bti >= ECDSA::Group::Secp256k1.order
-        t
+        parents.first.bth
       end
 
       def combine_hash(pair)

data/lib/bitcoin/taproot.rb

@@ -5,5 +5,41 @@ module Bitcoin
 
     autoload :LeafNode, 'bitcoin/taproot/leaf_node'
     autoload :SimpleBuilder, 'bitcoin/taproot/simple_builder'
+
+    module_function
+
+    # Calculate tweak value from +internal_pubkey+ and +merkle_root+.
+    # @param [Bitcoin::Key] internal_key Internal key with hex format(x-only public key).
+    # @param [String] merkle_root Merkle root value of script tree with hex format.
+    # @return [String] teak value with binary format.
+    def tweak(internal_key, merkle_root)
+      raise Error, 'internal_key must be Bitcoin::Key object.' unless internal_key.is_a?(Bitcoin::Key)
+
+      merkle_root ||= ''
+      t = Bitcoin.tagged_hash('TapTweak', internal_key.xonly_pubkey.htb + merkle_root.htb)
+      raise Error, 'tweak value exceeds the curve order' if t.bti >= ECDSA::Group::Secp256k1.order
+
+      t
+    end
+
+    # Generate tweak public key form +internal_pubkey+ and +merkle_root+.
+    # @param [Bitcoin::Key] internal_key Internal key with hex format(x-only public key).
+    # @param [String] merkle_root Merkle root value of script tree with hex format.
+    # @return [Bitcoin::Key] Tweaked public key.
+    def tweak_public_key(internal_key, merkle_root)
+      t = tweak(internal_key, merkle_root)
+      key = Bitcoin::Key.new(priv_key: t.bth, key_type: Key::TYPES[:compressed])
+      Bitcoin::Key.from_point(key.to_point + internal_key.to_point)
+    end
+
+    # Generate tweak private key
+    #
+    def tweak_private_key(internal_private_key, merkle_root)
+      p = internal_private_key.to_point
+      private_key = p.has_even_y? ? internal_private_key.priv_key.to_i(16) :
+                      ECDSA::Group::Secp256k1.order - internal_private_key.priv_key.to_i(16)
+      t = tweak(internal_private_key, merkle_root)
+      Bitcoin::Key.new(priv_key: ((t.bti + private_key) % ECDSA::Group::Secp256k1.order).to_even_length_hex)
+    end
   end
 end

data/lib/bitcoin/version.rb

@@ -1,3 +1,3 @@
 module Bitcoin
-  VERSION = "0.8.0"
+  VERSION = "0.9.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bitcoinrb
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0
 platform: ruby
 authors:
 - azuchi
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-06-29 00:00:00.000000000 Z
+date: 2021-11-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ecdsa
@@ -514,7 +514,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.2.22
 signing_key: 
 specification_version: 4
 summary: The implementation of Bitcoin Protocol for Ruby.