bitcoinrb 1.9.1 → 1.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d9782b433e66eedcc496ac7f8eeeb7000e800065e43ee8f17dd410f639cc2f60
-  data.tar.gz: c9cdbb34ab9d1a49c46dc7b5e6deb05a007c05f980a2e43c5166e7bee1c732e9
+  metadata.gz: a617f4bbc9d3523c7de3740050880c5bdaeafb8513eaa04686e39ea70f25673a
+  data.tar.gz: 1ddcfa267f592c563bf8db07774ff1805dea53d382f9a330e9b1d4f76c5d9eaa
 SHA512:
-  metadata.gz: '0629c12f169b5f513f66df7a5861297e78d173fe64ba8af4ee0b6944e961706078dd999f4d162e6e476c0be570c3229586b13056b321ce66cb7f5007ea4bbf0d'
-  data.tar.gz: ef78ccff084babb49747ff0f7a3bf32536a3a8cdb180cf85cca4c166ead597e9aa774790df506043970f152c7797baacfb40dc413a0358f77e9aac72404968d4
+  metadata.gz: f984c05b61a1f67cd5374b559730c7f7cae9f2bf1024d00e352bb98237d3258bef72cbf0660c579a0e900e0c3c5bc0d298299cbe7c347e2c8d48009fcc076a91
+  data.tar.gz: 19195672bcd808e9554558f83d8e7e13513d814e511892d01ddf8c1084cc4e853e8386825c50fea89a44317d36715148848402324070ee56dbd69d13a11fa20f

data/README.md

@@ -19,7 +19,7 @@ Bitcoinrb supports following feature:
 * [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))
 * Taproot consensus([BIP-341](https://github.com/bitcoin/bips/blob/master/bip-0341.mediawiki) and [BIP-342](https://github.com/bitcoin/bips/blob/master/bip-0342.mediawiki))
-* [Output script descriptor](https://github.com/chaintope/bitcoinrb/wiki/Output-Script-Descriptor) ([BIP-380](https://github.com/bitcoin/bips/blob/master/bip-0380.mediawiki), [BIP-381](https://github.com/bitcoin/bips/blob/master/bip-0381.mediawiki), [BIP-382](https://github.com/bitcoin/bips/blob/master/bip-0382.mediawiki), [BIP-383](https://github.com/bitcoin/bips/blob/master/bip-0383.mediawiki), [BIP-384](https://github.com/bitcoin/bips/blob/master/bip-0384.mediawiki), [BIP-385](https://github.com/bitcoin/bips/blob/master/bip-0385.mediawiki), [BIP-386](https://github.com/bitcoin/bips/blob/master/bip-0386.mediawiki), [BIP-387](https://github.com/bitcoin/bips/blob/master/bip-0387.mediawiki))
+* [Output script descriptor](https://github.com/chaintope/bitcoinrb/wiki/Output-Script-Descriptor) ([BIP-380](https://github.com/bitcoin/bips/blob/master/bip-0380.mediawiki), [BIP-381](https://github.com/bitcoin/bips/blob/master/bip-0381.mediawiki), [BIP-382](https://github.com/bitcoin/bips/blob/master/bip-0382.mediawiki), [BIP-383](https://github.com/bitcoin/bips/blob/master/bip-0383.mediawiki), [BIP-384](https://github.com/bitcoin/bips/blob/master/bip-0384.mediawiki), [BIP-385](https://github.com/bitcoin/bips/blob/master/bip-0385.mediawiki), [BIP-386](https://github.com/bitcoin/bips/blob/master/bip-0386.mediawiki), [BIP-387](https://github.com/bitcoin/bips/blob/master/bip-0387.mediawiki), [BIP-390](https://github.com/bitcoin/bips/blob/master/bip-0390.mediawiki))
 
 ## Requirements
 

data/bitcoinrb.gemspec

@@ -26,7 +26,6 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'bech32', '>= 1.5.0'
   spec.add_runtime_dependency 'daemon-spawn'
   spec.add_runtime_dependency 'thor'
-  spec.add_runtime_dependency 'leb128', '~> 1.0.0'
   spec.add_runtime_dependency 'eventmachine_httpserver'
   spec.add_runtime_dependency 'iniparse'
   spec.add_runtime_dependency 'siphash'

data/lib/bitcoin/bip321_uri.rb

@@ -0,0 +1,172 @@
+require 'uri'
+require 'cgi'
+
+module Bitcoin
+  # BIP-321 URI
+  # @see https://github.com/bitcoin/bips/blob/master/bip-0321.mediawiki
+  class BIP321URI
+
+    attr_reader :addr
+    attr_reader :amount
+    attr_reader :label
+    attr_reader :message
+    attr_reader :pop # proof of payment
+    attr_reader :lightning # BOLT11 invoice
+    attr_reader :lno # BOLT12 offer
+    attr_reader :pay # BIP-351 private address
+    attr_reader :sp # BIP-352 silent payment address
+    attr_reader :req_pop
+    attr_reader :query_addrs
+
+    attr_reader :other_params
+
+    # Constructor
+    # @param [String] address
+    # @param [BigDecimal, Integer] amount
+    # @param [String] label
+    # @param [String] message
+    # @param [Hash] other_params
+    # @param [String] pop
+    # @param [String] lightning BOLT11 invoice.
+    # @param [String] lno BOLT12 offer.
+    # @param [String] pay BIP-351 private address.
+    # @param [String] sp BIP-352 silent payment address.
+    # @param [Boolean] req_pop whether pop is required or not.
+    # @param [Array] query_addrs A list of addresses to be placed as query parameters.
+    def initialize(address: nil, amount: nil, label: nil, message: nil, other_params: {},
+                   pop:nil, lightning: nil, lno: nil, pay:nil, sp: nil, req_pop: false, query_addrs: [])
+      if address
+        Bitcoin::Script.parse_from_addr(address)
+        @addr = address
+      end
+      if amount
+        amount = BigDecimal(amount) if amount.is_a?(Integer)
+        raise ArgumentError, "amount must be BigDecimal or integer." unless amount.is_a?(BigDecimal)
+        @amount = amount
+      end
+      raise ArgumentError, "label must be string." if label && !label.is_a?(String)
+      @label = label
+
+      raise ArgumentError, "message must be string." if message && !message.is_a?(String)
+      @message = message
+
+      raise ArgumentError, "pop must be string." if pop && !pop.is_a?(String)
+      @pop = pop
+
+      raise ArgumentError, "lightning must be string." if lightning && !lightning.is_a?(String)
+      @lightning = lightning
+
+      raise ArgumentError, "lno must be string." if lno && !lno.is_a?(String)
+      @lno = lno
+
+      raise ArgumentError, "pay must be string." if pay && !pay.is_a?(String)
+      @pay = pay
+
+      if sp
+        raise ArgumentError, "sp must be string." unless sp.is_a?(String)
+        begin
+          Bech32::SilentPaymentAddr.parse(sp)
+          @sp = sp
+        rescue ArgumentError
+          raise ArgumentError, "Invalid sp address specified."
+        end
+      end
+
+      raise ArgumentError, 'pop is required, if req_pop is true.' if req_pop && pop.nil?
+      @req_pop = req_pop
+
+      @query_addrs = query_addrs.map do |addr|
+        Bitcoin::Script.parse_from_addr(addr)
+        addr
+      end
+
+      raise ArgumentError, "other_params must be Hash." unless other_params.is_a?(Hash)
+      other_params.keys.each do |key|
+        raise ArgumentError, 'An unsupported reqparam is included.' if key.start_with?('req-')
+      end
+      @other_params = other_params
+    end
+
+    # Parse BIP-321 URI string.
+    # @param [String] BIP-321 URI.
+    # @return [Bitcoin::BIP321URI]
+    # @raise [ArgumentError]
+    def self.parse(uri)
+      raise ArgumentError, "uri must be string." unless uri.is_a?(String)
+      raise ArgumentError, "Invalid uri scheme." unless uri.downcase.start_with?('bitcoin:')
+      uri = uri[8..-1]
+      addr, params = uri.split('?', 2)
+      req_pop = false
+      query_addrs = []
+      params = if params
+                 decoded = URI.decode_www_form(params)
+                 decoded = decoded.map do |k, v|
+                   if k == 'req-pop'
+                     req_pop = true
+                     k = 'pop'
+                   end
+                   if %w[bc tb].include?(k.downcase)
+                     raise ArgumentError, "#{k} not allowed in current network." unless Bitcoin.chain_params.bech32_hrp == k.downcase
+                     query_addrs << v
+                     nil
+                   else
+                     [k, v]
+                   end
+                 end.compact
+                 keys = decoded.map(&:first)
+                 duplicate_key = keys.detect { |key| keys.count(key) > 1 }
+                 raise ArgumentError, "#{duplicate_key} must not appear twice." if duplicate_key
+                 decoded.to_h.except('')
+               else
+                 {}
+               end
+      addr = nil if addr.empty?
+      amount = params['amount'] ? BigDecimal(params['amount']) : nil
+      excluded_keys = %w[amount label message pop lightning lno pay sp]
+      others = params.except(*excluded_keys)
+      BIP321URI.new(address: addr, amount: amount, label: params['label'], message: params['message'],
+                    pop: params['pop'], lightning: params['lightning'], lno: params['lno'],
+                    pay: params['pay'], sp: params['sp'], other_params: others, req_pop: req_pop, query_addrs: query_addrs)
+    end
+
+    # Get all addresses contained in the URI body and query parameters
+    # @return [Array] An array of address.
+    def addresses
+      addrs = []
+      addrs << @addr if @addr
+      addrs + @query_addrs
+    end
+
+    # Payment amount (satoshi unit)
+    # @return [Integer, nil]
+    def satoshi
+      amount.nil? ? nil : (amount * 100_000_000).to_i
+    end
+
+    def to_s
+      uri = 'bitcoin:'
+      uri << addr if addr
+      base_params = {}
+      base_params['amount'] = amount.to_s('f').sub(/\.0+$/, '') if amount
+      base_params['label'] = label if label
+      base_params['message'] = message if message
+      pop_label = req_pop ? 'req-pop' : 'pop'
+      base_params[pop_label] = pop if pop
+      base_params['lightning'] = lightning if lightning
+      base_params['lno'] = lno if lno
+      base_params['sp'] = sp if sp
+      base_params['pay'] = pay if pay
+
+      all_params = base_params.merge other_params
+      params = all_params.map do |k, v|
+        "#{k}=#{CGI.escape(v).gsub('+', '%20')}"
+      end.join('&')
+      uri << "?#{params}" unless params.empty?
+      unless query_addrs.empty?
+        uri << '?' unless uri.include?('?')
+        uri << query_addrs.map {|addr| "#{Bitcoin.chain_params.bech32_hrp}=#{addr}"}.join('&')
+      end
+      uri
+    end
+  end
+end

data/lib/bitcoin/constants.rb

@@ -205,6 +205,7 @@ module Bitcoin
   SCRIPT_ERR_TAPSCRIPT_VALIDATION_WEIGHT = 94
   SCRIPT_ERR_TAPSCRIPT_CHECKMULTISIG = 95
   SCRIPT_ERR_TAPSCRIPT_MINIMALIF = 96
+  SCRIPT_ERR_TAPSCRIPT_EMPTY_PUBKEY = 97
 
   ERRCODES_MAP = Hash[*constants.grep(/^SCRIPT_ERR_/).map { |c| [const_get(c), c.to_s] }.flatten]
   NAME_MAP = Hash[*constants.grep(/^SCRIPT_ERR_/).map { |c| [c.to_s, const_get(c)] }.flatten]

data/lib/bitcoin/script/script.rb

@@ -8,6 +8,8 @@ module Bitcoin
     include Bitcoin::Opcodes
     include Bitcoin::HexConverter
 
+    P2A_PROGRAM = '4e73'.htb
+
     attr_accessor :chunks
 
     def initialize
@@ -37,6 +39,12 @@ module Bitcoin
       new << OP_1 << xonly_pubkey
     end
 
+    # Generate P2TR script
+    # @return [Bitcoin::Script]
+    def self.to_p2a
+      new << OP_1 << P2A_PROGRAM
+    end
+
     # generate m of n multisig p2sh script
     # @param [String] m the number of signatures required for multisig
     # @param [Array] pubkeys array of public keys that compose multisig
@@ -198,7 +206,7 @@ module Bitcoin
 
     # check whether standard script.
     def standard?
-      p2pkh? | p2sh? | p2wpkh? | p2wsh? | p2tr? | multisig? | standard_op_return?
+      p2pkh? | p2sh? | p2wpkh? | p2wsh? | p2tr? | multisig? | standard_op_return? || p2a?
     end
 
     # Check whether this script is a P2PKH format script.
@@ -230,6 +238,13 @@ module Bitcoin
       chunks[0].ord == WITNESS_VERSION_V1 && chunks[1].bytesize == 33
     end
 
+    # Check whether this script is a Pay to Anchor format script.
+    # @return [Boolean] if P2A return true, otherwise false
+    def p2a?
+      return false unless chunks.size == 2
+      chunks[0].ord == WITNESS_VERSION_V1 && chunks[1].pushed_data == P2A_PROGRAM
+    end
+
     # Check whether this script is a P2SH format script.
     # @return [Boolean] if P2SH return true, otherwise false
     def p2sh?
@@ -560,6 +575,7 @@ module Bitcoin
       return 'witness_v0_keyhash' if p2wpkh?
       return 'witness_v0_scripthash' if p2wsh?
       return 'witness_v1_taproot' if p2tr?
+      return 'anchor' if p2a?
       'nonstandard'
     end
 

data/lib/bitcoin/script/script_error.rb

@@ -114,6 +114,8 @@ module Bitcoin
         'OP_CHECKMULTISIG(VERIFY) is not available in tapscript'
       when SCRIPT_ERR_TAPSCRIPT_MINIMALIF
         'OP_IF/NOTIF argument must be minimal in tapscript'
+      when SCRIPT_ERR_TAPSCRIPT_EMPTY_PUBKEY
+        'Empty public key in tapscript'
       when SCRIPT_ERR_OP_CODESEPARATOR
         'Using OP_CODESEPARATOR in non-witness script'
       when SCRIPT_ERR_SIG_FINDANDDELETE

data/lib/bitcoin/script/script_interpreter.rb

@@ -167,6 +167,8 @@ module Bitcoin
           end
           return true unless need_evaluate
         end
+      elsif version == 1 && program == Script::P2A_PROGRAM
+        return true
       elsif flag?(SCRIPT_VERIFY_DISCOURAGE_UPGRADABLE_WITNESS_PROGRAM)
         return set_error(SCRIPT_ERR_DISCOURAGE_UPGRADABLE_WITNESS_PROGRAM)
       else
@@ -565,7 +567,6 @@ module Bitcoin
           return set_error(SCRIPT_ERR_STACK_SIZE) if stack.size + alt_stack.size > MAX_STACK_SIZE
         end
       rescue Exception => e
-        puts e
         return set_error(SCRIPT_ERR_UNKNOWN_ERROR, e.message)
       end
 
@@ -741,7 +742,7 @@ module Bitcoin
 
       pubkey_size = pubkey.htb.bytesize
       if pubkey_size == 0
-        return set_error(SCRIPT_ERR_PUBKEYTYPE)
+        return set_error(SCRIPT_ERR_TAPSCRIPT_EMPTY_PUBKEY)
       elsif pubkey_size == X_ONLY_PUBKEY_SIZE
         if success
           result = checker.check_schnorr_sig(sig, pubkey, :tapscript, opts)

data/lib/bitcoin/tx.rb

@@ -234,6 +234,7 @@ module Bitcoin
     def verify_input_sig(input_index, script_pubkey, amount: nil, flags: STANDARD_SCRIPT_VERIFY_FLAGS, prevouts: [])
       script_sig = inputs[input_index].script_sig
       has_witness = inputs[input_index].has_witness?
+      has_witness = true if script_pubkey.witness_program?
 
       if script_pubkey.p2sh?
         flags << SCRIPT_VERIFY_P2SH

data/lib/bitcoin/tx_out.rb

@@ -6,8 +6,6 @@ module Bitcoin
   # transaction output
   class TxOut
 
-    include OpenAssets::MarkerOutput
-
     attr_accessor :value
     attr_accessor :script_pubkey
 

data/lib/bitcoin/version.rb

@@ -1,3 +1,3 @@
 module Bitcoin
-  VERSION = "1.9.1"
+  VERSION = "1.11.0"
 end

data/lib/bitcoin.rb

@@ -11,7 +11,6 @@ require 'base64'
 require 'observer'
 require 'tmpdir'
 require 'merkle'
-require_relative 'openassets'
 
 module Bitcoin
 
@@ -64,6 +63,8 @@ module Bitcoin
   autoload :Taproot, 'bitcoin/taproot'
   autoload :SilentPayment, 'bitcoin/silent_payment'
   autoload :BIP324, 'bitcoin/bip324'
+  autoload :BIP321URI, 'bitcoin/bip321_uri'
+  autoload :BIP353, 'bitcoin/bip353'
 
   require_relative 'bitcoin/constants'
   require_relative 'bitcoin/ext/ecdsa'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bitcoinrb
 version: !ruby/object:Gem::Version
-  version: 1.9.1
+  version: 1.11.0
 platform: ruby
 authors:
 - azuchi
@@ -93,20 +93,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: leb128
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.0.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: eventmachine_httpserver
   requirement: !ruby/object:Gem::Requirement
@@ -275,6 +261,7 @@ files:
 - exe/bitcoinrbd
 - lib/bitcoin.rb
 - lib/bitcoin/base58.rb
+- lib/bitcoin/bip321_uri.rb
 - lib/bitcoin/bip324.rb
 - lib/bitcoin/bip324/cipher.rb
 - lib/bitcoin/bip324/ell_swift_pubkey.rb
@@ -442,10 +429,6 @@ files:
 - lib/bitcoin/wallet/db.rb
 - lib/bitcoin/wallet/master_key.rb
 - lib/bitcoin/wallet/utxo.rb
-- lib/openassets.rb
-- lib/openassets/marker_output.rb
-- lib/openassets/payload.rb
-- lib/openassets/util.rb
 homepage: https://github.com/chaintope/bitcoinrb
 licenses:
 - MIT

data/lib/openassets/marker_output.rb

@@ -1,20 +0,0 @@
-module OpenAssets
-
-  module MarkerOutput
-
-    # whether this output is marker output for open assets.
-    def open_assets_marker?
-      return false unless script_pubkey.op_return?
-      !oa_payload.nil?
-    end
-
-    # get open asset payload.
-    # @return [OpenAssets::Payload] open asset payload.
-    def oa_payload
-      return nil unless script_pubkey.op_return?
-      Payload.parse_from_payload(script_pubkey.op_return_data)
-    end
-
-  end
-
-end

data/lib/openassets/payload.rb

@@ -1,54 +0,0 @@
-# frozen_string_literal: true
-
-module OpenAssets
-
-  MARKER = "\x4f\x41"
-  VERSION = "\x01\x00"
-
-  # the open assets payload
-  class Payload
-
-    attr_accessor :quantities
-    attr_accessor :metadata
-
-    def initialize(quantities = [], metadata = '')
-      @quantities = quantities
-      @metadata = metadata
-    end
-
-    # parse open assets payload
-    # @return [Payload] a open assets payload object, if payload is invalid, return nil.
-    def self.parse_from_payload(payload)
-      buf = StringIO.new(payload)
-      marker = buf.read(2)
-      version = buf.read(2)
-      return nil if marker != MARKER || version != VERSION
-      count = Bitcoin.unpack_var_int_from_io(buf)
-      return nil unless count
-      quantities = []
-      count.times do
-        quantities << LEB128.decode_unsigned(buf, buf.pos)
-      end
-      metadata_length = Bitcoin.unpack_var_int_from_io(buf)
-      return nil if metadata_length.nil? || buf.length < metadata_length + buf.pos
-      metadata = buf.read(metadata_length).each_byte.map(&:chr).join
-      new(quantities, metadata)
-    rescue
-      # LEB128#decode_unsigned raise 'undefined method `unpack' for nil:NilClass'
-      # for invalid format such as "018f8f" (the most significant bit of the last byte should be 0)
-      nil
-    end
-
-    # generate binary payload
-    def to_payload
-      payload = String.new
-      payload << MARKER
-      payload << VERSION
-      payload << Bitcoin.pack_var_int(quantities.size) << quantities.map{|q| LEB128.encode_unsigned(q).read }.join
-      payload << Bitcoin.pack_var_int(metadata.length) << metadata.bytes.map{|b| sprintf("%02x", b)}.join.htb
-      payload
-    end
-
-  end
-
-end

data/lib/openassets/util.rb

@@ -1,28 +0,0 @@
-# frozen_string_literal: true
-
-module OpenAssets
-  module Util
-    class << self
-      OA_VERSION_BYTE = '17' # 0x23
-      OA_VERSION_BYTE_TESTNET = '73' # 0x115
-
-      def script_to_asset_id(script)
-        hash_to_asset_id(Bitcoin.hash160(script))
-      end
-
-      private
-
-      def hash_to_asset_id(hash)
-        hash = oa_version_byte + hash
-        Bitcoin::Base58.encode(hash + Bitcoin.calc_checksum(hash))
-      end
-
-      def oa_version_byte
-        case Bitcoin.chain_params.network
-        when 'mainnet' then OA_VERSION_BYTE
-        when 'testnet', 'regtest' then OA_VERSION_BYTE_TESTNET
-        end
-      end
-    end
-  end
-end

data/lib/openassets.rb

@@ -1,9 +0,0 @@
-require 'leb128'
-
-module OpenAssets
-
-  autoload :MarkerOutput, 'openassets/marker_output'
-  autoload :Payload, 'openassets/payload'
-  autoload :Util, 'openassets/util'
-
-end