tapyrus 0.3.2 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bfdff40e4807919098065d5d956383663673f20a264d0eaadaa89124467166f8
-  data.tar.gz: 731e768f37f843fc6a03d337e8aea349d57f23449068356348d2bef171d02a2f
+  metadata.gz: fe8d938cb082800dbacfbdbebc6ab00d14a40693a92a4df46f967d0535f9e337
+  data.tar.gz: b6a51b4a565435d2a5a4f65d6fbcec3420464d6067742c64d00651919de22d6d
 SHA512:
-  metadata.gz: 0360ede886fe0a3512ea68e212270b5d931b8c085ceb04c6790978e325bc98b1d112d74deaa80232c97109c50ad8b1175566cb04ccd5324a218563677d90fbbd
-  data.tar.gz: 3f6f38a994e81c0b1d5157584cf14669ee7f8be612a6e878bf7cc216995ca60255a133b1b318e6210d6328015fdd99434bde021fd124bdc44454da564023ddab
+  metadata.gz: c2ead3ceffe67d128f94af033ff788fbb15a283416af5ed2afe915ad8af6dc34e36e6e5ad7e21fa94ea2137e8cde1441a3b15228402b46243b582e21ab0dea1d
+  data.tar.gz: 1dbefaca1c96fa263ba870f8f892f33a1161c8d7ba0e2ecedad1aea3af98112cb8836e03f85201a1c2d0febe010b49f73e4497195eca90e157081d4a049f265e

data/exe/tapyrus-script-debugger

@@ -3,32 +3,6 @@
 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
@@ -52,14 +26,13 @@ end
 
 print "Enter tx: "
 tx_hex = gets.chomp
-if tx_hex.length == 0
-  tx_checker = EmptyTxChecker.new
-else
+tx = nil
+input_index = nil
+unless tx_hex.length == 0
   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)
+  tx = Tapyrus::Tx.parse_from_payload(tx_hex.htb)
   rescue StandardError
     warn "Invalid tx data."
     exit
@@ -68,64 +41,31 @@ else
     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
+  input_index = input_index.to_i
 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
+begin
+debugger = Tapyrus::ScriptDebugger.new(script_pubkey: script_pubkey, script_sig: script_sig, tx: tx, index: input_index)
+rescue ArgumentError => e
+  warn e.message
+  exit
+end
 
 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
+    result = debugger.step
+    if result.halt?
+      puts result.message if result.message
+      warn result.error
+      exit
+    elsif result.finished?
+      puts "Execution finished."
+      exit
+    else
+      result.print_result
     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/errors.rb

@@ -10,6 +10,7 @@ module Tapyrus
 
       INVALID_PRIV_KEY = 'Private key is not in range [1..n-1].'
       INVALID_CHECKSUM = 'Invalid checksum.'
+      INVALID_PRIV_LENGTH = 'Private key must be 32 bytes.'
     end
   end
 end

data/lib/tapyrus/ext_key.rb

@@ -25,7 +25,8 @@ module Tapyrus
       l = Tapyrus.hmac_sha512('Tapyrus seed', seed.htb)
       left = l[0..31].bth.to_i(16)
       raise 'invalid key' if left >= CURVE_ORDER || left == 0
-      ext_key.key = Tapyrus::Key.new(priv_key: l[0..31].bth, key_type: Tapyrus::Key::TYPES[:compressed])
+      l_priv = ECDSA::Format::IntegerOctetString.encode(left, 32)
+      ext_key.key = Tapyrus::Key.new(priv_key: l_priv.bth, key_type: Tapyrus::Key::TYPES[:compressed])
       ext_key.chain_code = l[32..-1]
       ext_key
     end
@@ -107,7 +108,8 @@ module Tapyrus
       raise 'invalid key' if left >= CURVE_ORDER
       child_priv = (left + key.priv_key.to_i(16)) % CURVE_ORDER
       raise 'invalid key ' if child_priv >= CURVE_ORDER
-      new_key.key = Tapyrus::Key.new(priv_key: child_priv.to_even_length_hex.rjust(64, '0'), key_type: key_type)
+      child_priv = ECDSA::Format::IntegerOctetString.encode(child_priv, 32)
+      new_key.key = Tapyrus::Key.new(priv_key: child_priv.bth, key_type: key_type)
       new_key.chain_code = l[32..-1]
       new_key.ver = version
       new_key
@@ -275,7 +277,8 @@ module Tapyrus
       l = Tapyrus.hmac_sha512(chain_code, data)
       left = l[0..31].bth.to_i(16)
       raise 'invalid key' if left >= CURVE_ORDER
-      p1 = Tapyrus::Key.new(priv_key: left.to_s(16), key_type: Tapyrus::Key::TYPES[:uncompressed]).to_point
+      l_priv = ECDSA::Format::IntegerOctetString.encode(left, 32)
+      p1 = Tapyrus::Key.new(priv_key: l_priv.bth, key_type: Tapyrus::Key::TYPES[:uncompressed]).to_point
       p2 = Tapyrus::Key.new(pubkey: pubkey, key_type: key_type).to_point
       new_key.pubkey = (p1 + p2).to_hex
       new_key.chain_code = l[32..-1]

data/lib/tapyrus/key.rb

@@ -41,7 +41,11 @@ module Tapyrus
       end
       @secp256k1_module = Tapyrus.secp_impl
       @priv_key = priv_key
-      raise ArgumentError, Errors::Messages::INVALID_PRIV_KEY unless validate_private_key_range(@priv_key) if @priv_key
+
+      if @priv_key
+        raise ArgumentError, Errors::Messages::INVALID_PRIV_KEY unless validate_private_key_range(@priv_key)
+        raise ArgumentError, Errors::Messages::INVALID_PRIV_LENGTH unless @priv_key.htb.bytesize == 32
+      end
       if pubkey
         @pubkey = pubkey
       else

data/lib/tapyrus/script/debugger.rb

@@ -0,0 +1,164 @@
+module Tapyrus
+  class ScriptDebugger
+    attr_reader :script_pubkey
+    attr_reader :script_sig
+    attr_reader :tx_checker
+    attr_reader :interpreter
+
+    attr_accessor :target_script
+    attr_accessor :is_redeem
+    attr_accessor :chunk_index
+    attr_accessor :chunk_size
+    attr_accessor :chunks
+    attr_accessor :stack_copy
+
+    # @param [Tapyrus::Script] script_pubkey
+    # @param [Tapyrus::Script] script_sig
+    # @param [Tapyrus::Tx] tx (optional)
+    # @param [Integer] index (optional) input index
+    # @raise [ArgumentError]
+    def initialize(script_pubkey:, script_sig:, tx: nil, index: nil)
+      @script_pubkey = script_pubkey
+      @script_sig = script_sig
+      if tx
+        raise ArgumentError, 'index should be specified' if index.nil?
+        @tx_checker = Tapyrus::TxChecker.new(tx: tx, input_index: index)
+        if (tx_checker.tx.in.size - 1) < tx_checker.input_index
+          raise ArgumentError, "Tx does not have #{tx_checker.input_index}-th input."
+        end
+      else
+        @tx_checker = EmptyTxChecker.new
+      end
+      @interpreter = Tapyrus::ScriptInterpreter.new(checker: tx_checker)
+      @interpreter.reset_params
+      @chunk_index = 0
+      @target_script = script_sig
+      @chunks = target_script.chunks.each
+      @chunk_size = target_script.chunks.length
+      @stack_copy = nil
+    end
+
+    def step
+      if chunk_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
+          @chunk_size = target_script.chunks.length
+        elsif target_script == script_pubkey
+          if interpreter.stack.empty? || !interpreter.cast_to_bool(interpreter.stack.last.htb)
+            return(
+              StepResult.error(
+                current_stack: interpreter.stack.dup,
+                error: 'Script evaluated without error but finished with a false/empty top stack element'
+              )
+            )
+          end
+          if script_pubkey.p2sh?
+            interpreter.stack = stack_copy
+            redeem_script = Tapyrus::Script.parse_from_payload(interpreter.stack.pop.htb)
+            @target_script = redeem_script
+            @chunks = target_script.chunks.each
+            @chunk_index = 0
+            @chunk_size = target_script.chunks.length
+          else
+            return StepResult.finished(current_stack: interpreter.stack.dup)
+          end
+        else
+          return StepResult.finished(current_stack: interpreter.stack.dup)
+        end
+      end
+      result = step_process(interpreter, target_script, chunks.next, chunk_index, is_redeem)
+      return result if result.is_a?(StepResult)
+      @chunk_index += 1
+      StepResult.success(current_stack: interpreter.stack.dup, message: result)
+    end
+
+    private
+
+    def step_process(interpreter, script, chunk, index, is_redeem_script)
+      message =
+        chunk.pushdata? ? "PUSH #{chunk.pushed_data.bth}" : "APPLY #{Tapyrus::Opcodes.opcode_to_name(chunk.opcode)}"
+      begin
+        result = interpreter.next_step(script, chunk, index, is_redeem_script)
+        if result.is_a?(FalseClass)
+          return(
+            StepResult.error(current_stack: interpreter.stack.dup, error: "script failed. Reason: #{interpreter.error}")
+          )
+        end
+        message
+      rescue TxUnspecifiedError => e
+        return StepResult.error(current_stack: interpreter.stack.dup, error: e.message, message: message)
+      end
+    end
+  end
+
+  class StepResult
+    STATUS_RUNNING = 'running'
+    STATUS_HALT = 'halt'
+    STATUS_FINISHED = 'finished'
+
+    STATUSES = [STATUS_RUNNING, STATUS_HALT, STATUS_FINISHED]
+
+    attr_reader :status
+    attr_reader :current_stack
+    attr_reader :message
+    attr_reader :error
+
+    # @param [String] status
+    # @param [Array] current_stack
+    # @param [String] message
+    # @param [String] error an error message.
+    def initialize(status, current_stack: [], message: nil, error: nil)
+      raise ArgumentError, 'Unsupported status specified.' unless STATUSES.include?(status)
+      @status = status
+      @current_stack = current_stack
+      @error = error
+      @message = message
+    end
+
+    def self.error(current_stack: [], error:, message: nil)
+      StepResult.new(STATUS_HALT, current_stack: current_stack, error: error, message: message)
+    end
+
+    def self.success(current_stack: [], message: nil)
+      StepResult.new(STATUS_RUNNING, current_stack: current_stack, message: message)
+    end
+
+    def self.finished(current_stack: [])
+      StepResult.new(STATUS_FINISHED, current_stack: current_stack)
+    end
+
+    def halt?
+      status == STATUS_HALT
+    end
+
+    def finished?
+      status == STATUS_FINISHED
+    end
+
+    def stack_table
+      rows = current_stack.map { |s| [s] }.reverse
+      Terminal::Table.new(title: 'Current Stack', rows: rows)
+    end
+
+    def print_result
+      puts message if message
+      puts stack_table
+    end
+  end
+
+  class TxUnspecifiedError < StandardError
+  end
+
+  class EmptyTxChecker
+    def check_sig(script_sig, pubkey, script_code)
+      raise TxUnspecifiedError, 'Signature verification failed. You need to enter tx and input index.'
+    end
+    def verify_sig(sig, pubkey, digest, allow_hybrid: false)
+      raise TxUnspecifiedError, 'Signature verification failed. You need to enter tx and input index.'
+    end
+  end
+end

data/lib/tapyrus/version.rb

@@ -1,3 +1,3 @@
 module Tapyrus
-  VERSION = '0.3.2'
+  VERSION = '0.3.3'
 end

data/lib/tapyrus.rb

@@ -24,6 +24,7 @@ module Tapyrus
   autoload :Script, 'tapyrus/script/script'
   autoload :Multisig, 'tapyrus/script/multisig'
   autoload :ScriptInterpreter, 'tapyrus/script/script_interpreter'
+  autoload :ScriptDebugger, 'tapyrus/script/debugger'
   autoload :ScriptError, 'tapyrus/script/script_error'
   autoload :TxChecker, 'tapyrus/script/tx_checker'
   autoload :TxIn, 'tapyrus/tx_in'
@@ -50,6 +51,7 @@ module Tapyrus
   autoload :Errors, 'tapyrus/errors'
   autoload :TxBuilder, 'tapyrus/tx_builder'
   autoload :BIP175, 'tapyrus/bip175'
+  autoload :Contract, 'tapyrus/contract'
 
   require_relative 'tapyrus/constants'
   require_relative 'tapyrus/ext/ecdsa'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tapyrus
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.3.3
 platform: ruby
 authors:
 - azuchi
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-09-06 00:00:00.000000000 Z
+date: 2023-04-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ecdsa
@@ -405,6 +405,7 @@ files:
 - lib/tapyrus/rpc/request_handler.rb
 - lib/tapyrus/rpc/tapyrus_core_client.rb
 - lib/tapyrus/script/color.rb
+- lib/tapyrus/script/debugger.rb
 - lib/tapyrus/script/multisig.rb
 - lib/tapyrus/script/script.rb
 - lib/tapyrus/script/script_error.rb
@@ -441,7 +442,7 @@ homepage: https://github.com/chaintope/tapyrusrb
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -456,8 +457,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.21
-signing_key: 
+rubygems_version: 3.3.7
+signing_key:
 specification_version: 4
 summary: The implementation of Tapyrus Protocol for Ruby.
 test_files: []