tapyrus 0.2.7 → 0.2.8

data/lib/tapyrus/rpc/request_handler.rb

@@ -1,9 +1,7 @@
 module Tapyrus
   module RPC
-
     # RPC server's request handler.
     module RequestHandler
-
       # Returns an object containing various state info regarding blockchain processing.
       def getblockchaininfo
         h = {}
@@ -28,19 +26,19 @@ module Tapyrus
         raise ArgumentError.new('Block not found') unless entry
         if verbose
           {
-              hash: block_id,
-              height: entry.height,
-              features: entry.header.features,
-              featuresHex: entry.header.features.to_even_length_hex.ljust(8, '0'),
-              merkleroot: entry.header.merkle_root.rhex,
-              immutablemerkleroot: entry.header.im_merkle_root.rhex,
-              time: entry.header.time,
-              mediantime: node.chain.mtp(block_hash),
-              xfield_type: entry.header.x_field_type,
-              xfield: entry.header.x_field,
-              proof: entry.header.proof,
-              previousblockhash: entry.prev_hash.rhex,
-              nextblockhash: node.chain.next_hash(block_hash).rhex
+            hash: block_id,
+            height: entry.height,
+            features: entry.header.features,
+            featuresHex: entry.header.features.to_even_length_hex.ljust(8, '0'),
+            merkleroot: entry.header.merkle_root.rhex,
+            immutablemerkleroot: entry.header.im_merkle_root.rhex,
+            time: entry.header.time,
+            mediantime: node.chain.mtp(block_hash),
+            xfield_type: entry.header.x_field_type,
+            xfield: entry.header.x_field,
+            proof: entry.header.proof,
+            previousblockhash: entry.prev_hash.rhex,
+            nextblockhash: node.chain.next_hash(block_hash).rhex
           }
         else
           entry.header.to_hex
@@ -49,34 +47,38 @@ module Tapyrus
 
       # Returns connected peer information.
       def getpeerinfo
-        node.pool.peers.map do |peer|
-          local_addr = "#{peer.remote_version.remote_addr.ip}:18333"
-          {
-            id: peer.id,
-            addr: "#{peer.host}:#{peer.port}",
-            addrlocal: local_addr,
-            services: peer.remote_version.services.to_even_length_hex.rjust(16, '0'),
-            relaytxes: peer.remote_version.relay,
-            lastsend: peer.last_send,
-            lastrecv: peer.last_recv,
-            bytessent: peer.bytes_sent,
-            bytesrecv: peer.bytes_recv,
-            conntime: peer.conn_time,
-            pingtime: peer.ping_time,
-            minping: peer.min_ping,
-            version: peer.remote_version.version,
-            subver: peer.remote_version.user_agent,
-            inbound: !peer.outbound?,
-            startingheight: peer.remote_version.start_height,
-            best_hash: peer.best_hash,
-            best_height: peer.best_height
-          }
-        end
+        node
+          .pool
+          .peers
+          .map do |peer|
+            local_addr = "#{peer.remote_version.remote_addr.ip}:18333"
+            {
+              id: peer.id,
+              addr: "#{peer.host}:#{peer.port}",
+              addrlocal: local_addr,
+              services: peer.remote_version.services.to_even_length_hex.rjust(16, '0'),
+              relaytxes: peer.remote_version.relay,
+              lastsend: peer.last_send,
+              lastrecv: peer.last_recv,
+              bytessent: peer.bytes_sent,
+              bytesrecv: peer.bytes_recv,
+              conntime: peer.conn_time,
+              pingtime: peer.ping_time,
+              minping: peer.min_ping,
+              version: peer.remote_version.version,
+              subver: peer.remote_version.user_agent,
+              inbound: !peer.outbound?,
+              startingheight: peer.remote_version.start_height,
+              best_hash: peer.best_hash,
+              best_height: peer.best_height
+            }
+          end
       end
 
       # broadcast transaction
       def sendrawtransaction(hex_tx)
         tx = Tapyrus::Tx.parse_from_payload(hex_tx.htb)
+
         # TODO check wether tx is valid
         node.broadcast(tx)
         tx.txid
@@ -110,7 +112,7 @@ module Tapyrus
       def createwallet(wallet_id = 1, wallet_path_prefix = Tapyrus::Wallet::Base.default_path_prefix)
         wallet = Tapyrus::Wallet::Base.create(wallet_id, wallet_path_prefix)
         node.wallet = wallet unless node.wallet
-        {wallet_id: wallet.wallet_id, mnemonic: wallet.master_key.mnemonic}
+        { wallet_id: wallet.wallet_id, mnemonic: wallet.master_key.mnemonic }
       end
 
       # get wallet list.
@@ -127,9 +129,7 @@ module Tapyrus
       def listaccounts
         return {} unless node.wallet
         accounts = {}
-        node.wallet.accounts.each do |a|
-          accounts[a.name] = node.wallet.get_balance(a)
-        end
+        node.wallet.accounts.each { |a| accounts[a.name] = node.wallet.get_balance(a) }
         accounts
       end
 
@@ -144,8 +144,6 @@ module Tapyrus
       def getnewaddress(account_name)
         node.wallet.generate_new_address(account_name)
       end
-
     end
-
   end
 end

data/lib/tapyrus/rpc/tapyrus_core_client.rb

@@ -3,6 +3,37 @@ require 'json/pure'
 
 module Tapyrus
   module RPC
+    # Throw when happened anything http's error with connect to server.
+    #
+    # Almost case this exception happened from 401 Unauthorized or 500 Internal Server Error.
+    # And also, throw by cause of other http's errors.
+    #
+    # You can pull RPC error message when happened 500 Internal Server Error, like below:
+    #
+    # rescue Tapyrus::RPC::Error => ex
+    #   if ex.message.response_code == 500
+    #     puts ex.message[:rpc_error]
+    #   end
+    # end
+    class Error < StandardError
+      attr_reader :message
+
+      def initialize(response)
+        raise ArgumentError, 'Must set response as cause.' unless response
+
+        # set message from response body or status code.
+        @message = { response_code: response&.code, response_msg: response&.msg }
+        begin
+          @message.merge!({ rpc_error: Tapyrus::RPC.response_body2json(response.body)['error'] })
+        rescue JSON::ParserError => _
+          # if RPC server don't send error message.
+        end
+      end
+
+      def to_s
+        @message.to_s
+      end
+    end
 
     # Client implementation for RPC to Tapyrus Core.
     #
@@ -16,25 +47,21 @@ module Tapyrus
     # client.getblockchaininfo
     #
     class TapyrusCoreClient
-
       attr_reader :config
 
       # @param [Hash] config a configuration required to connect to Bitcoin Core.
       def initialize(config)
         @config = config
 
-        commands = request(:help).split("\n").inject([]) do |memo_ary, line|
-          if !line.empty? && !line.start_with?('==')
-            memo_ary << line.split(' ').first.to_sym
-          end
-          memo_ary
-        end
-        TapyrusCoreClient.class_eval do
-          commands.each do |command|
-            define_method(command) do |*params|
-              request(command, *params)
+        commands =
+          request(:help)
+            .split("\n")
+            .inject([]) do |memo_ary, line|
+              memo_ary << line.split(' ').first.to_sym if !line.empty? && !line.start_with?('==')
+              memo_ary
             end
-          end
+        TapyrusCoreClient.class_eval do
+          commands.each { |command| define_method(command) { |*params| request(command, *params) } }
         end
       end
 
@@ -42,33 +69,34 @@ module Tapyrus
 
       def server_url
         url = "#{config[:schema]}://#{config[:user]}:#{config[:password]}@#{config[:host]}:#{config[:port]}"
-        if !config[:wallet].nil? && !config[:wallet].empty?
-          url += "/wallet/#{config[:wallet]}"
-        end
+        url += "/wallet/#{config[:wallet]}" if !config[:wallet].nil? && !config[:wallet].empty?
         url
       end
 
       def request(command, *params)
-        data = {
-            :method => command,
-            :params => params,
-            :id => 'jsonrpc'
-        }
+        data = { method: command, params: params, id: 'jsonrpc' }
         uri = URI.parse(server_url)
         http = Net::HTTP.new(uri.hostname, uri.port)
-        http.use_ssl = uri.scheme === "https"
+        http.use_ssl = uri.scheme === 'https'
         request = Net::HTTP::Post.new(uri.path.empty? ? '/' : uri.path)
         request.basic_auth(uri.user, uri.password)
         request.content_type = 'application/json'
         request.body = data.to_json
         response = http.request(request)
-        body = response.body
-        response = Tapyrus::Ext::JsonParser.new(body.gsub(/\\u([\da-fA-F]{4})/) { [$1].pack('H*').unpack('n*').pack('U*').encode('ISO-8859-1').force_encoding('UTF-8') }).parse
-        raise response['error'].to_json if response['error']
+        raise Error.new(response) unless response.is_a? Net::HTTPOK
+        response = Tapyrus::RPC.response_body2json(response.body)
         response['result']
       end
+    end
 
+    def response_body2json(body)
+      Tapyrus::Ext::JsonParser.new(
+        body.gsub(/\\u([\da-fA-F]{4})/) do
+          [$1].pack('H*').unpack('n*').pack('U*').encode('ISO-8859-1').force_encoding('UTF-8')
+        end
+      ).parse
     end
 
+    module_function :response_body2json
   end
-end
+end

data/lib/tapyrus/script/color.rb

@@ -24,6 +24,11 @@ module Tapyrus
         new(TokenTypes::NFT, Tapyrus.sha256(out_point.to_payload))
       end
 
+      # Return ColorIdentifier for native token(i.e TPC)
+      def self.default
+        new(TokenTypes::NONE, '0000000000000000000000000000000000000000000000000000000000000000'.htb)
+      end
+
       def to_payload
         [type, payload].pack('Ca*')
       end
@@ -51,6 +56,11 @@ module Tapyrus
         to_payload.eql?(other.to_payload)
       end
 
+      # Return true if the coin is native token(i.e TPC), otherwise false
+      def default?
+        self == ColorIdentifier.default
+      end
+
       private
 
       def initialize(type, payload)

data/lib/tapyrus/script/multisig.rb

@@ -1,11 +1,10 @@
 module Tapyrus
-
   # utility for multisig
   module Multisig
     include Tapyrus::Opcodes
 
     def self.prefix
-      [OP_0].pack("C*")
+      [OP_0].pack('C*')
     end
 
     # generate input script sig spending a multisig output script.
@@ -23,7 +22,7 @@ module Tapyrus
     # multiple parties. Signatures must be in the same order as the
     # pubkeys in the output script being redeemed.
     def self.add_sig_to_multisig_script_sig(sig_to_add, script_sig, hash_type = SIGHASH_TYPE[:all])
-      signature = sig_to_add + [hash_type].pack("C*")
+      signature = sig_to_add + [hash_type].pack('C*')
       offset = script_sig.empty? ? 0 : 1
       script_sig.insert(offset, Tapyrus::Script.pack_pushdata(signature))
     end
@@ -49,17 +48,19 @@ module Tapyrus
       pubkeys = redeem_script.get_multisig_pubkeys
 
       # find the pubkey for each signature by trying to verify it
-      sigs = Hash[script.chunks[1...-1].map.with_index do |sig, idx|
-        sig = sig.pushed_data
-        pubkey = pubkeys.map do |key|
-          Tapyrus::Key.new(pubkey: key.bth).verify(sig, sig_hash) ? key : nil
-        end.compact.first
-        raise "Key for signature ##{idx} not found in redeem script!"  unless pubkey
-        [pubkey, sig]
-      end]
+      sigs =
+        Hash[
+          script.chunks[1...-1].map.with_index do |sig, idx|
+            sig = sig.pushed_data
+            pubkey =
+              pubkeys.map { |key| Tapyrus::Key.new(pubkey: key.bth).verify(sig, sig_hash) ? key : nil }.compact.first
+            raise "Key for signature ##{idx} not found in redeem script!" unless pubkey
+            [pubkey, sig]
+          end
+        ]
 
       prefix + pubkeys.map { |k| sigs[k] ? Tapyrus::Script.pack_pushdata(sigs[k]) : nil }.join +
         Tapyrus::Script.pack_pushdata(script.chunks[-1].pushed_data)
     end
   end
-end
+end

data/lib/tapyrus/script/script.rb

@@ -2,7 +2,6 @@
 # https://github.com/lian/bitcoin-ruby/blob/master/COPYING
 
 module Tapyrus
-
   # tapyrus script
   class Script
     include Tapyrus::HexConverter
@@ -82,14 +81,12 @@ module Tapyrus
     def remove_color
       raise RuntimeError, 'Only cp2pkh and cp2sh can remove color' unless cp2pkh? or cp2sh?
 
-      Tapyrus::Script.new.tap do |s|
-        s.chunks = self.chunks[2..-1]
-      end
+      Tapyrus::Script.new.tap { |s| s.chunks = self.chunks[2..-1] }
     end
 
     def get_multisig_pubkeys
       num = Tapyrus::Opcodes.opcode_to_small_int(chunks[-2].bth.to_i(16))
-      (1..num).map{ |i| chunks[i].pushed_data }
+      (1..num).map { |i| chunks[i].pushed_data }
     end
 
     # generate m of n multisig script
@@ -104,14 +101,16 @@ module Tapyrus
     # generate script from string.
     def self.from_string(string)
       script = new
-      string.split(' ').each do |v|
-        opcode = Opcodes.name_to_opcode(v)
-        if opcode
-          script << (v =~ /^\d/ && Opcodes.small_int_to_opcode(v.ord) ? v.ord : opcode)
-        else
-          script << (v =~ /^[0-9]+$/ ? v.to_i : v)
+      string
+        .split(' ')
+        .each do |v|
+          opcode = Opcodes.name_to_opcode(v)
+          if opcode
+            script << (v =~ /^\d/ && Opcodes.small_int_to_opcode(v.ord) ? v.ord : opcode)
+          else
+            script << (v =~ /^[0-9]+$/ ? v.to_i : v)
+          end
         end
-      end
       script
     end
 
@@ -150,19 +149,20 @@ module Tapyrus
         if opcode.pushdata?
           pushcode = opcode.ord
           packed_size = nil
-          len = case pushcode
-                  when OP_PUSHDATA1
-                    packed_size = buf.read(1)
-                    packed_size.unpack('C').first
-                  when OP_PUSHDATA2
-                    packed_size = buf.read(2)
-                    packed_size.unpack('v').first
-                  when OP_PUSHDATA4
-                    packed_size = buf.read(4)
-                    packed_size.unpack('V').first
-                  else
-                    pushcode if pushcode < OP_PUSHDATA1
-                end
+          len =
+            case pushcode
+            when OP_PUSHDATA1
+              packed_size = buf.read(1)
+              packed_size.unpack('C').first
+            when OP_PUSHDATA2
+              packed_size = buf.read(2)
+              packed_size.unpack('v').first
+            when OP_PUSHDATA4
+              packed_size = buf.read(4)
+              packed_size.unpack('V').first
+            else
+              pushcode if pushcode < OP_PUSHDATA1
+            end
           if len
             s.chunks << [len].pack('C') if buf.eof?
             unless buf.eof?
@@ -194,7 +194,7 @@ module Tapyrus
       return [p2sh_addr] if p2sh?
       return [cp2pkh_addr] if cp2pkh?
       return [cp2sh_addr] if cp2sh?
-      return get_multisig_pubkeys.map{|pubkey| Tapyrus::Key.new(pubkey: pubkey.bth).to_p2pkh} if multisig?
+      return get_multisig_pubkeys.map { |pubkey| Tapyrus::Key.new(pubkey: pubkey.bth).to_p2pkh } if multisig?
       []
     end
 
@@ -206,8 +206,8 @@ module Tapyrus
     # whether this script is a P2PKH format script.
     def p2pkh?
       return false unless chunks.size == 5
-      [OP_DUP, OP_HASH160, OP_EQUALVERIFY, OP_CHECKSIG] ==
-          (chunks[0..1]+ chunks[3..4]).map(&:ord) && chunks[2].bytesize == 21
+      [OP_DUP, OP_HASH160, OP_EQUALVERIFY, OP_CHECKSIG] == (chunks[0..1] + chunks[3..4]).map(&:ord) &&
+        chunks[2].bytesize == 21
     end
 
     def p2sh?
@@ -228,8 +228,7 @@ module Tapyrus
     end
 
     def standard_op_return?
-      op_return? && size <= MAX_OP_RETURN_RELAY &&
-          (chunks.size == 1 || chunks[1].opcode <= OP_16)
+      op_return? && size <= MAX_OP_RETURN_RELAY && (chunks.size == 1 || chunks[1].opcode <= OP_16)
     end
 
     # Return whether this script is a CP2PKH format script or not.
@@ -239,8 +238,8 @@ module Tapyrus
       return false unless chunks[0].bytesize == 34
       return false unless Tapyrus::Color::ColorIdentifier.parse_from_payload(chunks[0].pushed_data)&.valid?
       return false unless chunks[1].ord == OP_COLOR
-      [OP_DUP, OP_HASH160, OP_EQUALVERIFY, OP_CHECKSIG] ==
-          (chunks[2..3]+ chunks[5..6]).map(&:ord) && chunks[4].bytesize == 21
+      [OP_DUP, OP_HASH160, OP_EQUALVERIFY, OP_CHECKSIG] == (chunks[2..3] + chunks[5..6]).map(&:ord) &&
+        chunks[4].bytesize == 21
     end
 
     # Return whether this script is a CP2SH format script or not.
@@ -252,7 +251,7 @@ module Tapyrus
       return false unless chunks[1].ord == OP_COLOR
       OP_HASH160 == chunks[2].ord && OP_EQUAL == chunks[4].ord && chunks[3].bytesize == 21
     end
-  
+
     # Return whether this script represents colored coin.
     # @return [Boolean] true if this script is colored, otherwise false.
     def colored?
@@ -275,24 +274,23 @@ module Tapyrus
 
     # whether data push only script which dose not include other opcode
     def push_only?
-      chunks.each do |c|
-        return false if !c.opcode.nil? && c.opcode > OP_16
-      end
+      chunks.each { |c| return false if !c.opcode.nil? && c.opcode > OP_16 }
       true
     end
 
     # get public keys in the stack.
     # @return[Array[String]] an array of the pubkeys with hex format.
     def get_pubkeys
-      chunks.select{|c|c.pushdata? && [33, 65].include?(c.pushed_data.bytesize) && [2, 3, 4, 6, 7].include?(c.pushed_data[0].bth.to_i(16))}.map{|c|c.pushed_data.bth}
+      chunks.select do |c|
+        c.pushdata? && [33, 65].include?(c.pushed_data.bytesize) &&
+          [2, 3, 4, 6, 7].include?(c.pushed_data[0].bth.to_i(16))
+      end.map { |c| c.pushed_data.bth }
     end
 
     # returns the self payload. ScriptInterpreter does not use this.
     def to_script_code(skip_separator_index = 0)
       payload = to_payload
-      if skip_separator_index > 0
-        payload = subscript_codeseparator(skip_separator_index)
-      end
+      payload = subscript_codeseparator(skip_separator_index) if skip_separator_index > 0
       Tapyrus.pack_var_string(payload)
     end
 
@@ -303,7 +301,7 @@ module Tapyrus
       elsif obj.is_a?(String)
         append_data(obj)
       elsif obj.is_a?(Array)
-        obj.each { |o| self.<< o}
+        obj.each { |o| self.<< o }
         self
       end
     end
@@ -339,18 +337,19 @@ module Tapyrus
 
     # Check the item is in the chunk of the script.
     def include?(item)
-      chunk_item = if item.is_a?(Integer)
-                     item.chr
-                   elsif item.is_a?(String)
-                     data = Encoding::ASCII_8BIT == item.encoding ? item : item.htb
-                     Tapyrus::Script.pack_pushdata(data)
-                   end
+      chunk_item =
+        if item.is_a?(Integer)
+          item.chr
+        elsif item.is_a?(String)
+          data = Encoding::ASCII_8BIT == item.encoding ? item : item.htb
+          Tapyrus::Script.pack_pushdata(data)
+        end
       return false unless chunk_item
       chunks.include?(chunk_item)
     end
 
     def to_s
-      chunks.map { |c|
+      chunks.map do |c|
         case c
         when Integer
           opcode_to_name(c)
@@ -373,7 +372,7 @@ module Tapyrus
             opcode ? opcode : 'OP_UNKNOWN [error]'
           end
         end
-      }.join(' ')
+      end.join(' ')
     end
 
     # generate sha-256 hash for payload
@@ -431,17 +430,18 @@ module Tapyrus
     # binary +data+ convert pushdata which contains data length and append PUSHDATA opcode if necessary.
     def self.pack_pushdata(data)
       size = data.bytesize
-      header = if size < OP_PUSHDATA1
-                 [size].pack('C')
-               elsif size < 0xff
-                 [OP_PUSHDATA1, size].pack('CC')
-               elsif size < 0xffff
-                 [OP_PUSHDATA2, size].pack('Cv')
-               elsif size < 0xffffffff
-                 [OP_PUSHDATA4, size].pack('CV')
-               else
-                 raise ArgumentError, 'data size is too big.'
-               end
+      header =
+        if size < OP_PUSHDATA1
+          [size].pack('C')
+        elsif size < 0xff
+          [OP_PUSHDATA1, size].pack('CC')
+        elsif size < 0xffff
+          [OP_PUSHDATA2, size].pack('Cv')
+        elsif size < 0xffffffff
+          [OP_PUSHDATA4, size].pack('CV')
+        else
+          raise ArgumentError, 'data size is too big.'
+        end
       header + data
     end
 
@@ -465,8 +465,12 @@ module Tapyrus
           if chunk == sub_chunk
             buf << chunk
             i += 1
-            (i = 0; buf.clear) if i == subscript.chunks.size # matched the whole subscript
-          else # matched the part of head
+            (
+              i = 0
+              buf.clear
+            ) if i == subscript.chunks.size # matched the whole subscript
+          else
+            # matched the part of head
             i = 0
             tmp = chunk.dup
             tmp.slice!(sub_chunk)
@@ -488,7 +492,7 @@ module Tapyrus
 
     # remove all occurences of opcode. Typically it's OP_CODESEPARATOR.
     def delete_opcode(opcode)
-      @chunks = chunks.select{|chunk| chunk.ord != opcode}
+      @chunks = chunks.select { |chunk| chunk.ord != opcode }
       self
     end
 
@@ -496,12 +500,10 @@ module Tapyrus
     def subscript_codeseparator(separator_index)
       buf = []
       process_separator_index = 0
-      chunks.each{|chunk|
+      chunks.each do |chunk|
         buf << chunk if process_separator_index == separator_index
-        if chunk.ord == OP_CODESEPARATOR && process_separator_index < separator_index
-          process_separator_index += 1
-        end
-      }
+        process_separator_index += 1 if chunk.ord == OP_CODESEPARATOR && process_separator_index < separator_index
+      end
       buf.join
     end
 
@@ -518,10 +520,10 @@ module Tapyrus
     end
 
     def to_h
-      h = {asm: to_s, hex: to_hex, type: type}
+      h = { asm: to_s, hex: to_hex, type: type }
       addrs = addresses
       unless addrs.empty?
-        h[:req_sigs] = multisig? ? Tapyrus::Opcodes.opcode_to_small_int(chunks[0].bth.to_i(16)) :addrs.size
+        h[:req_sigs] = multisig? ? Tapyrus::Opcodes.opcode_to_small_int(chunks[0].bth.to_i(16)) : addrs.size
         h[:addresses] = addrs
       end
       h
@@ -568,5 +570,4 @@ module Tapyrus
       Tapyrus.encode_base58_address(color_id + hash160, Tapyrus.chain_params.cp2sh_version)
     end
   end
-
 end