tapyrus 0.2.13 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 82146cdd150374b76b593273e44c31f4f578d38a1b7dcabea0b0d1fd9acbbb5f
-  data.tar.gz: 8895de33dd2b36412f509c4e35465d513d3d6c98a0bcfc0e7db241a77acd8b3b
+  metadata.gz: bfdff40e4807919098065d5d956383663673f20a264d0eaadaa89124467166f8
+  data.tar.gz: 731e768f37f843fc6a03d337e8aea349d57f23449068356348d2bef171d02a2f
 SHA512:
-  metadata.gz: e386ac9d8578846437902e78d79b3d4419c85df861c831c92641da94d2d46a37c4793efaafa8e28a1da4466e5347fbe79f66beb0d925fe2bfc83cca1d1e90c99
-  data.tar.gz: a34fa0709093aafb118356b7736b409c733e1185a22538f7e2ed4392dac0ac661a652a31853f652d988860ee66c8b57124815b0fc28dd795b7bea97ad44182c5
+  metadata.gz: 0360ede886fe0a3512ea68e212270b5d931b8c085ceb04c6790978e325bc98b1d112d74deaa80232c97109c50ad8b1175566cb04ccd5324a218563677d90fbbd
+  data.tar.gz: 3f6f38a994e81c0b1d5157584cf14669ee7f8be612a6e878bf7cc216995ca60255a133b1b318e6210d6328015fdd99434bde021fd124bdc44454da564023ddab

data/.github/workflows/ruby.yml

@@ -18,7 +18,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby-version: ["2.5", "2.6", "2.7", "3.0"]
+        ruby-version: ["2.6", "2.7", "3.0", "3.1"]
 
     steps:
       - run: sudo apt install libleveldb-dev
@@ -26,8 +26,7 @@ jobs:
       - name: Set up Ruby
         # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
         # change this to (see https://github.com/ruby/setup-ruby#versioning):
-        # uses: ruby/setup-ruby@v1
-        uses: ruby/setup-ruby@473e4d8fe5dd94ee328fdfca9f8c9c7afc9dae5e
+        uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby-version }}
           bundler-cache: true # runs 'bundle install' and caches installed gems automatically

data/.ruby-version

@@ -1 +1 @@
-3.0.2
+3.1.2

data/README.md

@@ -1,4 +1,4 @@
-# Tapyrusrb [![Build Status](https://travis-ci.org/chaintope/tapyrusrb.svg?branch=master)](https://travis-ci.org/chaintope/tapyrusrb) [![Gem Version](https://badge.fury.io/rb/tapyrus.svg)](https://badge.fury.io/rb/tapyrus) [![MIT License](http://img.shields.io/badge/license-MIT-blue.svg?style=flat)](LICENSE)
+# Tapyrusrb [![Build Status](https://github.com/chaintope/tapyrusrb/actions/workflows/ruby.yml/badge.svg?branch=master)](https://github.com/chaintope/tapyrusrb/actions/workflows/ruby.yml) [![Gem Version](https://badge.fury.io/rb/tapyrus.svg)](https://badge.fury.io/rb/tapyrus) [![MIT License](http://img.shields.io/badge/license-MIT-blue.svg?style=flat)](LICENSE)
 
 Tapyrusrb is a Ruby implementation of [Tapyrus](https://github.com/chaintope/tapyrus-core) Protocol.
 

data/exe/tapyrus-script-debugger

@@ -0,0 +1,131 @@
+#!/usr/bin/env ruby
+
+require 'tapyrus'
+require 'terminal-table'
+
+class EmptyTxChecker
+  def check_sig(script_sig, pubkey, script_code)
+    warn "Signature verification failed. You need to enter tx and input index."
+    exit
+  end
+  def verify_sig(sig, pubkey, digest, allow_hybrid: false)
+    warn "Signature verification failed. You need to enter tx and input index."
+    exit
+  end
+end
+
+def run_step(interpreter, script, chunk, index, is_redeem_script)
+  if chunk.pushdata?
+    puts "PUSH #{chunk.pushed_data.bth}"
+  else
+    puts "APPLY #{Tapyrus::Opcodes.opcode_to_name(chunk.opcode)}"
+  end
+  result = interpreter.next_step(script, chunk, index, is_redeem_script)
+  if result.is_a?(FalseClass)
+    warn "script failed. Reason: #{interpreter.error}"
+    exit
+  end
+  rows = interpreter.stack.map{|s|[s]}.reverse
+  table = Terminal::Table.new(title: 'Current Stack', rows: rows )
+  puts table
+end
+
+print "Enter scriptPubkey: "
+script_pubkey_hex = gets.chomp
+script_pubkey = Tapyrus::Script.parse_from_payload(script_pubkey_hex.htb)
+puts script_pubkey unless script_pubkey_hex.empty?
+
+print "Enter scriptSig: "
+script_sig_hex = gets.chomp
+script_sig = Tapyrus::Script.parse_from_payload(script_sig_hex.htb)
+puts script_sig unless script_sig_hex.empty?
+
+unless script_sig.push_only?
+  warn "scriptSig has non-push opcode."
+  puts
+end
+
+if script_pubkey_hex.empty? && script_sig.empty?
+  puts "Empty script."
+  exit
+end
+
+print "Enter tx: "
+tx_hex = gets.chomp
+if tx_hex.length == 0
+  tx_checker = EmptyTxChecker.new
+else
+  print "Enter index of the input: "
+  input_index = gets.chomp
+  tx_checker = Tapyrus::TxChecker.new
+  begin
+  tx_checker.tx = Tapyrus::Tx.parse_from_payload(tx_hex.htb)
+  rescue StandardError
+    warn "Invalid tx data."
+    exit
+  end
+  if input_index.empty?
+    warn "Index of input missing."
+    exit
+  end
+  tx_checker.input_index = input_index.to_i
+  if (tx_checker.tx.in.size - 1) < tx_checker.input_index
+    warn "Tx does not have #{tx_checker.input_index}-th input."
+    exit
+  end
+end
+
+interpreter = Tapyrus::ScriptInterpreter.new(checker: tx_checker)
+
+target_script = script_sig
+is_redeem = false
+interpreter.reset_params
+chunks = target_script.chunks.each
+chunk_index = 0
+chunks_size = target_script.chunks.length
+stack_copy = nil
+
+puts "The Script is ready to be executed; you can step execution it by putting the Enter key."
+print "> "
+while cmd = gets.chomp
+  if cmd.length == 0
+    if chunks_size == chunk_index
+      if target_script == script_sig
+        stack_copy = interpreter.stack.dup
+        target_script = script_pubkey
+        interpreter.reset_params
+        chunks = target_script.chunks.each
+        chunk_index = 0
+        chunks_size = target_script.chunks.length
+      elsif target_script == script_pubkey
+        if interpreter.stack.empty? || !interpreter.cast_to_bool(interpreter.stack.last.htb)
+          warn "Script evaluated without error but finished with a false/empty top stack element"
+          exit
+        end
+        if script_pubkey.p2sh?
+          interpreter.stack = stack_copy
+          redeem_script = Tapyrus::Script.parse_from_payload(interpreter.stack.pop.htb)
+          puts "APPLY P2SH: #{redeem_script}"
+          rows = interpreter.stack.map{|s|[s]}.reverse
+          table = Terminal::Table.new(title: 'Current Stack', rows: rows )
+          puts table
+          target_script = redeem_script
+          chunks = target_script.chunks.each
+          chunk_index = 0
+          chunks_size = target_script.chunks.length
+        else
+          puts "Execution finished."
+          exit
+        end
+      else
+        puts "Execution finished."
+        exit
+      end
+    end
+    run_step(interpreter, target_script, chunks.next, chunk_index, is_redeem)
+    chunk_index += 1
+  else
+    puts "Put enter key to step execution or Ctrl+D to exit."
+  end
+  print "> "
+end

data/lib/tapyrus/block_header.rb

@@ -104,7 +104,7 @@ module Tapyrus
       end
     end
 
-    # Check this header contains upgrade aggregated publiec key.
+    # Check this header contains upgrade aggregated public key.
     # @return [Boolean] if contains return true, otherwise false.
     def upgrade_agg_pubkey?
       x_field_type == X_FILED_TYPES[:aggregate_pubkey]

data/lib/tapyrus/chain_params.rb

@@ -54,7 +54,8 @@ module Tapyrus
     end
 
     def self.init(name)
-      i = YAML.load(File.open("#{__dir__}/chainparams/#{name}.yml"))
+      yaml = File.open("#{__dir__}/chainparams/#{name}.yml")
+      i = YAML.respond_to?(:unsafe_load) ? YAML.unsafe_load(yaml) : YAML.load(yaml)
       i.dust_relay_fee ||= Tapyrus::DUST_RELAY_TX_FEE
       i
     end

data/lib/tapyrus/constants.rb

@@ -94,8 +94,6 @@ module Tapyrus
   # 80 bytes of data, +1 for OP_RETURN, +2 for the pushdata opcodes.
   MAX_OP_RETURN_RELAY = 83
 
-  SIG_VERSION = [:base]
-
   # for script error
   SCRIPT_ERR_OK = 0
   SCRIPT_ERR_UNKNOWN_ERROR = 1

data/lib/tapyrus/ext.rb

@@ -1,5 +1,21 @@
 module Tapyrus
   module Ext
     autoload :JsonParser, 'tapyrus/ext/json_parser'
+
+    refine Object do
+      def build_json
+        self.is_a?(Array) ? "[#{self.map { |o| o.to_h.to_json }.join(',')}]" : to_h.to_json
+      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)
+          value.is_a?(Array) ? result.update(key => value.map { |v| v.to_h }) : result.update(key => value)
+        end
+      end
+    end
   end
 end

data/lib/tapyrus/network/message_handler.rb

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

data/lib/tapyrus/rpc/request_handler.rb

@@ -96,7 +96,7 @@ module Tapyrus
           script = Tapyrus::Script.parse_from_payload(hex_script.htb)
           h = script.to_h
           h.delete(:hex)
-          h[:p2sh] = script.to_p2sh.addresses.first unless script.p2sh?
+          h[:p2sh] = script.to_p2sh.to_addr unless script.p2sh?
           h
         rescue Exception
           raise ArgumentError.new('Script decode failed')

data/lib/tapyrus/script/script.rb

@@ -61,7 +61,7 @@ module Tapyrus
     end
 
     # Add color identifier to existing p2pkh or p2sh
-    # @param [ColorIdentifier] color identifier
+    # @param [ColorIdentifier] color_id color identifier
     # @return [Script] CP2PKH or CP2SH script
     # @raise [ArgumentError] if color_id is nil or invalid
     # @raise [RuntimeError] if script is neither p2pkh nor p2sh
@@ -75,7 +75,6 @@ module Tapyrus
     end
 
     # Remove color identifier from cp2pkh or cp2sh
-    # @param [ColorIdentifier] color identifier
     # @return [Script] P2PKH or P2SH script
     # @raise [RuntimeError] if script is neither cp2pkh nor cp2sh
     def remove_color
@@ -118,26 +117,18 @@ module Tapyrus
     # @param [String] addr address.
     # @return [Tapyrus::Script] parsed script.
     def self.parse_from_addr(addr)
-      begin
-        segwit_addr = Bech32::SegwitAddr.new(addr)
-        raise 'Invalid hrp.' unless Tapyrus.chain_params.bech32_hrp == segwit_addr.hrp
-        Tapyrus::Script.parse_from_payload(segwit_addr.to_script_pubkey.htb)
-      rescue Exception => e
-        hex, addr_version = Tapyrus.decode_base58_address(addr)
-        case addr_version
-        when Tapyrus.chain_params.address_version
-          Tapyrus::Script.to_p2pkh(hex)
-        when Tapyrus.chain_params.p2sh_version
-          Tapyrus::Script.to_p2sh(hex)
-        when Tapyrus.chain_params.cp2pkh_version
-          color = Tapyrus::Color::ColorIdentifier.parse_from_payload(hex[0..65].htb)
-          Tapyrus::Script.to_cp2pkh(color, hex[66..-1])
-        when Tapyrus.chain_params.cp2sh_version
-          color = Tapyrus::Color::ColorIdentifier.parse_from_payload(hex[0..65].htb)
-          Tapyrus::Script.to_cp2sh(color, hex[66..-1])
-        else
-          throw e
-        end
+      hex, addr_version = Tapyrus.decode_base58_address(addr)
+      case addr_version
+      when Tapyrus.chain_params.address_version
+        Tapyrus::Script.to_p2pkh(hex)
+      when Tapyrus.chain_params.p2sh_version
+        Tapyrus::Script.to_p2sh(hex)
+      when Tapyrus.chain_params.cp2pkh_version
+        color = Tapyrus::Color::ColorIdentifier.parse_from_payload(hex[0..65].htb)
+        Tapyrus::Script.to_cp2pkh(color, hex[66..-1])
+      when Tapyrus.chain_params.cp2sh_version
+        color = Tapyrus::Color::ColorIdentifier.parse_from_payload(hex[0..65].htb)
+        Tapyrus::Script.to_cp2sh(color, hex[66..-1])
       end
     end
 
@@ -189,6 +180,17 @@ module Tapyrus
       chunks.size == 0
     end
 
+    # Returns the address corresponding to this script. Return nil if there is no corresponding address.
+    # @return [String] address
+    def to_addr
+      return p2pkh_addr if p2pkh?
+      return p2sh_addr if p2sh?
+      return cp2pkh_addr if cp2pkh?
+      return cp2sh_addr if cp2sh?
+      nil
+    end
+
+    # @deprecated use #to_addr method.
     def addresses
       return [p2pkh_addr] if p2pkh?
       return [p2sh_addr] if p2sh?