bitcoinrb 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ffa8f8b7dbf104190628e7ff38dbb950aa14927ab208377c821ad7f5aeaab862
-  data.tar.gz: f24e89dd6de49e066fae37fe5c4118d955f31a9a751af5901d6cde32528aa8fa
+  metadata.gz: b6b5d0d0d17295086ec1cf989eb1df1be2d776bff6c5a38e85c34e21e258f56b
+  data.tar.gz: c93206160d6709f0050cbe8a001df40f712a6e8a779a61117c8c0cc911d4fd2f
 SHA512:
-  metadata.gz: 306f65243198a07403c785b212d5d86f5a6eb27b189aa9454d27d280f4d93500b967e93fb7f995e8c998ce7f8f9ff4ba40a838c7f4f430b8e2fef0c04cb11206
-  data.tar.gz: 9e4d92cc79249f5027f105a8c7f69320f35b06b3bc3e9b5cc0416f74e7698f47910f4b63afba1821ec49e647671b1b67d4955acb80fe587d79bb34d0507ae98e
+  metadata.gz: fa5759ab05a69bfdaadda07d5cbf74c700bba2586f2544eaf823199c357b88405814dcaed7c6466a1a94e50027d5289a51f057d86815699e92862cb447b2478f
+  data.tar.gz: 8629b46d88f6674482bfaff89dffcf28e90edc857649aeaff56d579c12d0e4df99f9cc7cad63a31ecc1742afc64cfa089a7f86754be5614e27c145e0e693e1cb

data/README.md

@@ -15,7 +15,7 @@ Bitcoinrb supports following feature:
 * Key generation and verification for ECDSA, including [BIP-32](https://github.com/bitcoin/bips/blob/master/bip-0032.mediawiki) and [BIP-39](https://github.com/bitcoin/bips/blob/master/bip-0039.mediawiki) supports.
 * ECDSA signature(RFC6979 -Deterministic ECDSA, LOW-S, LOW-R support)
 * Segwit support (parsing segwit payload, Bech32 address, sign for segwit tx, [BIP-141](https://github.com/bitcoin/bips/blob/master/bip-0141.mediawiki), [BIP-143](https://github.com/bitcoin/bips/blob/master/bip-0143.mediawiki), [BIP-144](https://github.com/bitcoin/bips/blob/master/bip-0144.mediawiki))
-* [BIP-173](https://github.com/bitcoin/bips/blob/master/bip-0173.mediawiki) Bech32 address support
+* bech32([BIP-173](https://github.com/bitcoin/bips/blob/master/bip-0173.mediawiki)) and bech32m([BIP-350](https://github.com/bitcoin/bips/blob/master/bip-0350.mediawiki)) address support
 * [BIP-174](https://github.com/bitcoin/bips/blob/master/bip-0174.mediawiki) PSBT(Partially Signed Bitcoin Transaction) support
 * [BIP-85](https://github.com/bitcoin/bips/blob/master/bip-0085.mediawiki) Deterministic Entropy From BIP32 Keychains support by `Bitcoin::BIP85Entropy` class.
 * Schnorr signature([BIP-340](https://github.com/bitcoin/bips/blob/master/bip-0340.mediawiki))  

data/lib/bitcoin/constants.rb

@@ -3,6 +3,15 @@ module Bitcoin
   COIN = 100_000_000
   MAX_MONEY = 21_000_000 * COIN
 
+  # Byte size of the ripemd160 hash
+  RIPEMD160_SIZE = 20
+  # Byte size of the SHA256 hash
+  SHA256_SIZE = 32
+  # Byte size of the HASH160 hash
+  HASH160_SIZE = 20
+  # Byte size of the HASH256 hash
+  HASH256_SIZE = 32
+
   # The maximum allowed size for a serialized block, in bytes (only for buffer size limits)
   MAX_BLOCK_SERIALIZED_SIZE = 4_000_000
   # The maximum allowed weight for a block, see BIP 141 (network rule)
@@ -70,9 +79,9 @@ module Bitcoin
     SCRIPT_VERIFY_DISCOURAGE_UPGRADABLE_WITNESS_PROGRAM,
     SCRIPT_VERIFY_WITNESS_PUBKEYTYPE,
     SCRIPT_VERIFY_CONST_SCRIPTCODE,
-    SCRIPT_VERIFY_TAPROOT |
-    SCRIPT_VERIFY_DISCOURAGE_UPGRADABLE_TAPROOT_VERSION |
-    SCRIPT_VERIFY_DISCOURAGE_OP_SUCCESS |
+    SCRIPT_VERIFY_TAPROOT,
+    SCRIPT_VERIFY_DISCOURAGE_UPGRADABLE_TAPROOT_VERSION,
+    SCRIPT_VERIFY_DISCOURAGE_OP_SUCCESS,
     SCRIPT_VERIFY_DISCOURAGE_UPGRADABLE_PUBKEYTYPE
   ].inject(SCRIPT_VERIFY_NONE){|flags, f| flags |= f}
 

data/lib/bitcoin/ext/object_ext.rb

@@ -0,0 +1,29 @@
+module Bitcoin
+  module Ext
+    module ObjectExt
+      refine Object do
+        def build_json
+          if self.is_a?(Array)
+            "[#{self.map{|o|o.to_h.to_json}.join(',')}]"
+          else
+            to_h.to_json
+          end
+        end
+
+        def to_h
+          return self if self.is_a?(String)
+          instance_variables.inject({}) do |result, var|
+            key = var.to_s
+            key.slice!(0) if key.start_with?('@')
+            value = instance_variable_get(var)
+            if value.is_a?(Array)
+              result.update(key => value.map{|v|v.to_h})
+            else
+              result.update(key => value.class.to_s.start_with?("Bitcoin::") ? value.to_h : value)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/bitcoin/ext.rb

@@ -2,5 +2,6 @@ module Bitcoin
   module Ext
     autoload :JsonParser, 'bitcoin/ext/json_parser'
     autoload :ArrayExt, 'bitcoin/ext/array_ext'
+    autoload :ObjectExt, 'bitcoin/ext/object_ext'
   end
 end

data/lib/bitcoin/network/message_handler.rb

@@ -4,6 +4,8 @@ module Bitcoin
     # P2P message handler used by peer connection class.
     module MessageHandler
 
+      using Bitcoin::Ext::ObjectExt
+
       # handle p2p message.
       def handle(message)
         peer.last_recv = Time.now.to_i

data/lib/bitcoin/psbt/input.rb

@@ -14,6 +14,11 @@ module Bitcoin
       attr_accessor :hd_key_paths
       attr_accessor :partial_sigs
       attr_accessor :sighash_type
+      attr_accessor :ripemd160_preimages
+      attr_accessor :sha256_preimages
+      attr_accessor :hash160_preimages
+      attr_accessor :hash256_preimages
+      attr_accessor :proprietaries
       attr_accessor :unknowns
 
       def initialize(non_witness_utxo: nil, witness_utxo: nil)
@@ -21,6 +26,11 @@ module Bitcoin
         @witness_utxo = witness_utxo
         @partial_sigs = {}
         @hd_key_paths = {}
+        @ripemd160_preimages = {}
+        @sha256_preimages = {}
+        @hash160_preimages = {}
+        @hash256_preimages = {}
+        @proprietaries = []
         @unknowns = {}
       end
 
@@ -59,7 +69,7 @@ module Bitcoin
             input.partial_sigs[pubkey.pubkey] = value
           when PSBT_IN_TYPES[:sighash]
             raise ArgumentError, 'Invalid input sighash type typed key.' unless key_len == 1
-            raise ArgumentError 'Duplicate Key, input sighash type already provided.' if input.sighash_type
+            raise ArgumentError, 'Duplicate Key, input sighash type already provided.' if input.sighash_type
             input.sighash_type = value.unpack1('I')
           when PSBT_IN_TYPES[:redeem_script]
             raise ArgumentError, 'Invalid redeemscript typed key.' unless key_len == 1
@@ -81,6 +91,25 @@ module Bitcoin
             raise ArgumentError, 'Invalid final script witness typed key.' unless key_len == 1
             raise ArgumentError, 'Duplicate Key, input final scriptWitness already provided.' if input.final_script_witness
             input.final_script_witness = Bitcoin::ScriptWitness.parse_from_payload(value)
+          when PSBT_IN_TYPES[:ripemd160]
+            raise ArgumentError, 'Size of key was not the expected size for the type ripemd160 preimage' unless key.bytesize == RIPEMD160_SIZE
+            raise ArgumentError, 'Duplicate Key, input ripemd160 preimage already provided' if input.ripemd160_preimages[key.bth]
+            input.ripemd160_preimages[key.bth] = value.bth
+          when PSBT_IN_TYPES[:sha256]
+            raise ArgumentError, 'Size of key was not the expected size for the type sha256 preimage' unless key.bytesize == SHA256_SIZE
+            raise ArgumentError, 'Duplicate Key, input sha256 preimage already provided' if input.sha256_preimages[key.bth]
+            input.sha256_preimages[key.bth] = value.bth
+          when PSBT_IN_TYPES[:hash160]
+            raise ArgumentError, 'Size of key was not the expected size for the type hash160 preimage' unless key.bytesize == HASH160_SIZE
+            raise ArgumentError, 'Duplicate Key, input hash160 preimage already provided' if input.hash160_preimages[key.bth]
+            input.hash160_preimages[key.bth] = value.bth
+          when PSBT_IN_TYPES[:hash256]
+            raise ArgumentError, 'Size of key was not the expected size for the type hash256 preimage' unless key.bytesize == HASH256_SIZE
+            raise ArgumentError, 'Duplicate Key, input hash256 preimage already provided' if input.hash256_preimages[key.bth]
+            input.hash256_preimages[key.bth] = value.bth
+          when PSBT_IN_TYPES[:proprietary]
+            raise ArgumentError, 'Duplicate Key, key for proprietary value already provided.' if input.proprietaries.any?{|p| p.key == key}
+            input.proprietaries << Proprietary.new(key, value)
           else
             unknown_key = ([key_type].pack('C') + key).bth
             raise ArgumentError, 'Duplicate Key, key for unknown value already provided.' if input.unknowns[unknown_key]
@@ -102,9 +131,14 @@ module Bitcoin
           payload << PSBT.serialize_to_vector(PSBT_IN_TYPES[:redeem_script], value: redeem_script.to_payload) if redeem_script
           payload << PSBT.serialize_to_vector(PSBT_IN_TYPES[:witness_script], value: witness_script.to_payload) if witness_script
           payload << hd_key_paths.values.map(&:to_payload).join
+          payload << ripemd160_preimages.map{|k, v|PSBT.serialize_to_vector(PSBT_IN_TYPES[:ripemd160], key: k.htb, value: v.htb)}.join
+          payload << sha256_preimages.map{|k, v|PSBT.serialize_to_vector(PSBT_IN_TYPES[:sha256], key: k.htb, value: v.htb)}.join
+          payload << hash160_preimages.map{|k, v|PSBT.serialize_to_vector(PSBT_IN_TYPES[:hash160], key: k.htb, value: v.htb)}.join
+          payload << hash256_preimages.map{|k, v|PSBT.serialize_to_vector(PSBT_IN_TYPES[:hash256], key: k.htb, value: v.htb)}.join
         end
         payload << PSBT.serialize_to_vector(PSBT_IN_TYPES[:script_sig], value: final_script_sig.to_payload) if final_script_sig
         payload << PSBT.serialize_to_vector(PSBT_IN_TYPES[:script_witness], value: final_script_witness.to_payload) if final_script_witness
+        payload << proprietaries.map(&:to_payload).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

data/lib/bitcoin/psbt/output.rb

@@ -7,10 +7,12 @@ module Bitcoin
       attr_accessor :redeem_script
       attr_accessor :witness_script
       attr_accessor :hd_key_paths
+      attr_accessor :proprietaries
       attr_accessor :unknowns
 
       def initialize
         @hd_key_paths = {}
+        @proprietaries = []
         @unknowns = {}
       end
 
@@ -41,6 +43,9 @@ module Bitcoin
           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)
           else
             unknown_key = ([key_type].pack('C') + key).bth
             raise ArgumentError, 'Duplicate Key, key for unknown value already provided' if output.unknowns[unknown_key]
@@ -56,6 +61,7 @@ module Bitcoin
         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 << 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

data/lib/bitcoin/psbt/proprietary.rb

@@ -0,0 +1,44 @@
+module Bitcoin
+  module PSBT
+    # Proprietary element of PSBT
+    # https://github.com/bitcoin/bips/blob/master/bip-0174.mediawiki#Proprietary_Use_Type
+    class Proprietary
+      attr_accessor :identifier # binary format
+      attr_accessor :sub_type # integer
+      attr_accessor :value # binary format
+
+      # @param [String] key key with binary format without key type(0xfc).
+      # @param [String] value value with binary format.
+      def initialize(key, value)
+        buf = StringIO.new(key)
+        id_len = Bitcoin.unpack_var_int_from_io(buf)
+        @identifier = buf.read(id_len)
+        @sub_type = Bitcoin.unpack_var_int_from_io(buf)
+        @value = value
+      end
+
+      # Show contents
+      # @return [String]
+      def to_s
+        "identifier: #{identifier&.bth}, sub type: #{sub_type}, value: #{value&.bth}"
+      end
+
+      # Get key data with key type(0xfc).
+      # @return [String] key data with binary format.
+      def key
+        k = [PSBT_GLOBAL_TYPES[:proprietary]].pack('C')
+        k << Bitcoin.pack_var_int(identifier ? identifier.bytesize : 0)
+        k << identifier if identifier
+        k << Bitcoin.pack_var_int(sub_type)
+        k
+      end
+
+      # Convert to payload
+      # @return [String] payload with binary format.
+      def to_payload
+        k = key
+        Bitcoin.pack_var_int(k.bytesize) + k + Bitcoin.pack_var_int(value.bytesize) + value
+      end
+    end
+  end
+end

data/lib/bitcoin/psbt/tx.rb

@@ -32,6 +32,7 @@ module Bitcoin
       attr_accessor :xpubs
       attr_reader :inputs
       attr_reader :outputs
+      attr_accessor :proprietaries
       attr_accessor :unknowns
       attr_accessor :version_number
 
@@ -40,6 +41,7 @@ module Bitcoin
         @xpubs = []
         @inputs = tx ? tx.in.map{Input.new}: []
         @outputs = tx ? tx.out.map{Output.new}: []
+        @proprietaries = []
         @unknowns = {}
       end
 
@@ -66,7 +68,7 @@ module Bitcoin
             found_sep = true
             break
           end
-          key_type = buf.read(1).unpack1('C')
+          key_type = Bitcoin.unpack_var_int_from_io(buf)
           key = buf.read(key_len - 1)
           value = buf.read(Bitcoin.unpack_var_int_from_io(buf))
 
@@ -89,6 +91,9 @@ module Bitcoin
           when PSBT_GLOBAL_TYPES[:ver]
             partial_tx.version_number = value.unpack1('V')
             raise ArgumentError, "An unsupported version was detected." if SUPPORT_VERSION < partial_tx.version_number
+          when PSBT_GLOBAL_TYPES[:proprietary]
+            raise ArgumentError, 'Duplicate Key, key for proprietary value already provided.' if partial_tx.proprietaries.any?{|p| p.key == key}
+            partial_tx.proprietaries << Proprietary.new(key, value)
           else
             raise ArgumentError, 'Duplicate Key, key for unknown value already provided.' if partial_tx.unknowns[key]
             partial_tx.unknowns[([key_type].pack('C') + key).bth] = value
@@ -148,6 +153,7 @@ module Bitcoin
         payload << PSBT.serialize_to_vector(PSBT_GLOBAL_TYPES[:unsigned_tx], value: tx.to_payload)
         payload << xpubs.map(&:to_payload).join
         payload << PSBT.serialize_to_vector(PSBT_GLOBAL_TYPES[:ver], value: [version_number].pack('V')) if version_number
+        payload << proprietaries.map(&:to_payload).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

data/lib/bitcoin/psbt.rb

@@ -9,14 +9,38 @@ module Bitcoin
     autoload :Output, 'bitcoin/psbt/output'
     autoload :KeyOriginInfo, 'bitcoin/psbt/key_origin_info'
     autoload :HDKeyPath, 'bitcoin/psbt/hd_key_path'
+    autoload :Proprietary, 'bitcoin/psbt/proprietary'
 
     # constants for PSBT
     PSBT_MAGIC_BYTES = 0x70736274
-    PSBT_GLOBAL_TYPES = {unsigned_tx: 0x00, xpub: 0x01, ver: 0xfb}
-    PSBT_IN_TYPES = {non_witness_utxo: 0x00, witness_utxo: 0x01, partial_sig: 0x02,
-                     sighash: 0x03, redeem_script: 0x04, witness_script: 0x05,
-                     bip32_derivation: 0x06, script_sig: 0x07, script_witness: 0x08}
-    PSBT_OUT_TYPES = {redeem_script: 0x00, witness_script: 0x01, bip32_derivation: 0x02}
+    PSBT_GLOBAL_TYPES = {
+      unsigned_tx: 0x00,
+      xpub: 0x01,
+      ver: 0xfb,
+      proprietary: 0xfc
+    }
+    PSBT_IN_TYPES = {
+      non_witness_utxo: 0x00,
+      witness_utxo: 0x01,
+      partial_sig: 0x02,
+      sighash: 0x03,
+      redeem_script: 0x04,
+      witness_script: 0x05,
+      bip32_derivation: 0x06,
+      script_sig: 0x07,
+      script_witness: 0x08,
+      ripemd160: 0x0a,
+      sha256: 0x0b,
+      hash160: 0x0c,
+      hash256: 0x0d,
+      proprietary: 0xfc
+    }
+    PSBT_OUT_TYPES = {
+      redeem_script: 0x00,
+      witness_script: 0x01,
+      bip32_derivation: 0x02,
+      proprietary: 0xfc
+    }
     PSBT_SEPARATOR = 0x00
 
     SUPPORT_VERSION = 0

data/lib/bitcoin/script/script.rb

@@ -551,7 +551,7 @@ module Bitcoin
     def p2pkh_addr
       return nil unless p2pkh?
       hash160 = chunks[2].pushed_data.bth
-      return nil unless hash160.htb.bytesize == 20
+      return nil unless hash160.htb.bytesize == RIPEMD160_SIZE
       Bitcoin.encode_base58_address(hash160, Bitcoin.chain_params.address_version)
     end
 
@@ -564,7 +564,7 @@ module Bitcoin
     def p2sh_addr
       return nil unless p2sh?
       hash160 = chunks[1].pushed_data.bth
-      return nil unless hash160.htb.bytesize == 20
+      return nil unless hash160.htb.bytesize == RIPEMD160_SIZE
       Bitcoin.encode_base58_address(hash160, Bitcoin.chain_params.p2sh_version)
     end
 

data/lib/bitcoin/sighash_generator.rb

@@ -71,7 +71,9 @@ module Bitcoin
         amount = [amount].pack('Q')
         nsequence = [tx.inputs[input_index].sequence].pack('V')
         hash_outputs = Bitcoin.double_sha256(tx.outputs.map{|o|o.to_payload}.join)
-
+        if output_script.p2wsh?
+          warn('The output_script must be a witness script, not the P2WSH itself.')
+        end
         script_code = output_script.to_script_code(skip_separator_index)
 
         case (hash_type & 0x1f)

data/lib/bitcoin/version.rb

@@ -1,3 +1,3 @@
 module Bitcoin
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

data/lib/bitcoin.rb

@@ -194,32 +194,6 @@ module Bitcoin
 
   end
 
-  class ::Object
-
-    def build_json
-      if self.is_a?(Array)
-        "[#{self.map{|o|o.to_h.to_json}.join(',')}]"
-      else
-        to_h.to_json
-      end
-    end
-
-    def to_h
-      return self if self.is_a?(String)
-      instance_variables.inject({}) do |result, var|
-        key = var.to_s
-        key.slice!(0) if key.start_with?('@')
-        value = instance_variable_get(var)
-        if value.is_a?(Array)
-          result.update(key => value.map{|v|v.to_h})
-        else
-          result.update(key => value.class.to_s.start_with?("Bitcoin::") ? value.to_h : value)
-        end
-      end
-    end
-
-  end
-
   class ::Integer
     def to_even_length_hex
       hex = to_s(16)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bitcoinrb
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - azuchi
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-11-16 00:00:00.000000000 Z
+date: 2022-05-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ecdsa
@@ -364,6 +364,7 @@ files:
 - lib/bitcoin/ext/array_ext.rb
 - lib/bitcoin/ext/ecdsa.rb
 - lib/bitcoin/ext/json_parser.rb
+- lib/bitcoin/ext/object_ext.rb
 - lib/bitcoin/ext_key.rb
 - lib/bitcoin/gcs_filter.rb
 - lib/bitcoin/key.rb
@@ -450,6 +451,7 @@ files:
 - lib/bitcoin/psbt/input.rb
 - lib/bitcoin/psbt/key_origin_info.rb
 - lib/bitcoin/psbt/output.rb
+- lib/bitcoin/psbt/proprietary.rb
 - lib/bitcoin/psbt/tx.rb
 - lib/bitcoin/rpc.rb
 - lib/bitcoin/rpc/bitcoin_core_client.rb
@@ -514,7 +516,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: The implementation of Bitcoin Protocol for Ruby.