tapyrus 0.2.4 → 0.2.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6e7f821324dfe56eb103457c17b585792e2cc250c3738f59f1665aa4a831a917
-  data.tar.gz: 1faa2850c7dfe07d9be35c75e3c9500e10ef39725db64fc01d88de5548894068
+  metadata.gz: 44f097dd931371e9cce458e44ff030d9ebedcd9372632339d274457bb3839a4c
+  data.tar.gz: c72dddb87aacb3f649cc4a542b0988eb54347da6203e0bcc2d430065fc3398b8
 SHA512:
-  metadata.gz: 3299a042ff5f3fa919d4732c1c7c9288cef3bdb213267171d7fa733b53929479b83abb333be1820304fbb593cda742fd8240d8589424536a044901e92cf96823
-  data.tar.gz: c579e85d346cb81290e5854c303147f32dbe1df3049f4190f05af1fded387aaf7cf7cc4170761fa9eaf409c174b7b37f9f3031193c442567bc95e5d8b1b02e2f
+  metadata.gz: cc7fae61da930e3af35d17039dcd9bda45b6a9317d132dc5096e585ed3b00309a7fc4a3f3552928a57b5b46289bf3fe5be28000cffe666f0d0990480e88b31f3
+  data.tar.gz: b7d9c26524bda4fe26f4522b51b3328145a6e590a0099f2f72b0d9cbfb43c9a4e9b7ee4eb23907d8d8c8cf3daa239b0b7ad76caee82b5b00edffef63cb69d178

data/.github/workflows/ruby.yml

@@ -0,0 +1,37 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Ruby
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+    branches: [master]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ["2.5", "2.6", "2.7", "3.0"]
+
+    steps:
+      - run: sudo apt install libleveldb-dev
+      - uses: actions/checkout@v2
+      - 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
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+      - name: Run prettier
+        run: bundle exec rbprettier --check .
+      - name: Run tests
+        run: bundle exec rake

data/.prettierignore

@@ -0,0 +1,3 @@
+/vendor/
+/tmp/
+/spec/fixtures/**/*.json

data/.prettierrc.yaml

@@ -0,0 +1,3 @@
+printWidth: 120
+trailingComma: "none"
+rubyArrayLiteral: false

data/CODE_OF_CONDUCT.md

@@ -12,13 +12,13 @@ body size, race, ethnicity, age, religion, or nationality.
 
 Examples of unacceptable behavior by participants include:
 
-* The use of sexualized language or imagery
-* Personal attacks
-* Trolling or insulting/derogatory comments
-* Public or private harassment
-* Publishing other's private information, such as physical or electronic
+- The use of sexualized language or imagery
+- Personal attacks
+- Trolling or insulting/derogatory comments
+- Public or private harassment
+- Publishing other's private information, such as physical or electronic
   addresses, without explicit permission
-* Other unethical or unprofessional conduct
+- Other unethical or unprofessional conduct
 
 Project maintainers have the right and responsibility to remove, edit, or
 reject comments, commits, code, wiki edits, issues, and other contributions
@@ -46,4 +46,4 @@ version 1.3.0, available at
 [http://contributor-covenant.org/version/1/3/0/][version]
 
 [homepage]: http://contributor-covenant.org
-[version]: http://contributor-covenant.org/version/1/3/0/
+[version]: http://contributor-covenant.org/version/1/3/0/

data/README.md

@@ -1,21 +1,20 @@
 # 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 is a Ruby implementation of [Tapyrus](https://github.com/chaintope/tapyrus-core) Protocol.
 
-NOTE: Tapyrusrb work in progress, and there is a possibility of incompatible change. 
+NOTE: Tapyrusrb work in progress, and there is a possibility of incompatible change.
 
 ## Features
 
 Tapyrusrb supports following feature:
 
-* Tapyrus script interpreter
-* De/serialization of Tapyrus protocol network messages
-* De/serialization of blocks and transactions
-* Key generation and verification for Schnorr and 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)
-* [WIP] SPV node
-* [WIP] 0ff-chain protocol
+- Tapyrus script interpreter
+- De/serialization of Tapyrus protocol network messages
+- De/serialization of blocks and transactions
+- Key generation and verification for Schnorr and 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)
+- [WIP] SPV node
+- [WIP] 0ff-chain protocol
 
 ## Requirements
 
@@ -25,13 +24,13 @@ If you use node features, please install level DB as follows.
 
 #### install LevelDB
 
-* for Ubuntu
+- for Ubuntu
 
-    $ sudo apt-get install libleveldb-dev
+  $ sudo apt-get install libleveldb-dev
 
-+ for Mac
+* for Mac
 
-    $ brew install leveldb
+  $ brew install leveldb
 
 and put `leveldb-native` in your Gemfile and run bundle install.
 
@@ -65,7 +64,7 @@ And then add to your .rb file:
 
 The parameters of the blockchain are managed by `Tapyrus::ChainParams`. Switch chain parameters as follows:
 
-* prod
+- prod
 
 ```ruby
 Tapyrus.chain_params = :prod
@@ -73,7 +72,7 @@ Tapyrus.chain_params = :prod
 
 This parameter is described in https://github.com/chaintope/tapyrusrb/blob/master/lib/tapyrus/chainparams/prod.yml.
 
-* dev
+- dev
 
 ```ruby
 Tapyrus.chain_params = :dev
@@ -85,8 +84,6 @@ This parameter is described in https://github.com/chaintope/tapyrusrb/blob/maste
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/tapyrusrb. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
-
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-

data/Rakefile

@@ -1,6 +1,6 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/lib/openassets.rb

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

data/lib/openassets/marker_output.rb

@@ -1,7 +1,5 @@
 module OpenAssets
-
   module MarkerOutput
-
     # whether this output is marker output for open assets.
     def open_assets_marker?
       return false unless script_pubkey.op_return?
@@ -14,7 +12,5 @@ module OpenAssets
       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,13 +1,11 @@
 # frozen_string_literal: true
 
 module OpenAssets
-
   MARKER = "\x4f\x41"
   VERSION = "\x01\x00"
 
   # the open assets payload
   class Payload
-
     attr_accessor :quantities
     attr_accessor :metadata
 
@@ -26,14 +24,12 @@ module OpenAssets
       count = Tapyrus.unpack_var_int_from_io(buf)
       return nil unless count
       quantities = []
-      count.times do
-        quantities << LEB128.decode_unsigned(buf, buf.pos)
-      end
+      count.times { quantities << LEB128.decode_unsigned(buf, buf.pos) }
       metadata_length = Tapyrus.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
+    rescue StandardError
       # 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
@@ -44,11 +40,9 @@ module OpenAssets
       payload = String.new
       payload << MARKER
       payload << VERSION
-      payload << Tapyrus.pack_var_int(quantities.size) << quantities.map{|q| LEB128.encode_unsigned(q).read }.join
-      payload << Tapyrus.pack_var_int(metadata.length) << metadata.bytes.map{|b| sprintf("%02x", b)}.join.htb
+      payload << Tapyrus.pack_var_int(quantities.size) << quantities.map { |q| LEB128.encode_unsigned(q).read }.join
+      payload << Tapyrus.pack_var_int(metadata.length) << metadata.bytes.map { |b| sprintf('%02x', b) }.join.htb
       payload
     end
-
   end
-
 end

data/lib/schnorr.rb

@@ -1,5 +1,6 @@
 module Schnorr
   autoload :Signature, 'schnorr/signature'
+  autoload :SignToContract, 'schnorr/sign_to_contract'
 
   module_function
 
@@ -16,12 +17,7 @@ module Schnorr
     raise 'private_key is zero or over the curve order.' if private_key == 0 || private_key >= GROUP.order
 
     p = GROUP.new_point(private_key)
-    secret = ECDSA::Format::IntegerOctetString.encode(private_key, GROUP.byte_length)
-    secret = secret + message + ALGO16
-    nonce = Tapyrus::Secp256k1::RFC6979.generate_rfc6979_nonce(secret, '')
-
-    k0 = nonce % GROUP.order
-    raise 'Creation of signature failed. k is zero' if k0.zero?
+    k0 = deterministic_nonce(message, private_key)
 
     r = GROUP.new_point(k0)
     k = ECDSA::PrimeField.jacobi(r.y, GROUP.field.prime) == 1 ? k0 : GROUP.order - k0
@@ -31,6 +27,16 @@ module Schnorr
     Schnorr::Signature.new(r.x, (k + e * private_key) % GROUP.order)
   end
 
+  def deterministic_nonce(message, private_key)
+    secret = ECDSA::Format::IntegerOctetString.encode(private_key, GROUP.byte_length)
+    secret = secret + message + ALGO16
+    nonce = Tapyrus::Secp256k1::RFC6979.generate_rfc6979_nonce(secret, '')
+
+    k0 = nonce % GROUP.order
+    raise 'Creation of signature failed. k is zero' if k0.zero?
+    k0
+  end
+
   # Verifies the given {Signature} and returns true if it is valid.
   # @param message (String) A message to be signed with binary format.
   # @param public_key (String) The public key with binary format.
@@ -76,8 +82,7 @@ module Schnorr
   # @return (Integer) digest e.
   def create_challenge(x, p, message)
     r_x = ECDSA::Format::IntegerOctetString.encode(x, GROUP.byte_length)
-    p_str= p.to_hex.htb
+    p_str = p.to_hex.htb
     (ECDSA.normalize_digest(Digest::SHA256.digest(r_x + p_str + message), GROUP.bit_length)) % GROUP.order
   end
-
-end
+end

data/lib/schnorr/sign_to_contract.rb

@@ -0,0 +1,51 @@
+module Schnorr
+  module SignToContract
+    module_function
+
+    GROUP = ECDSA::Group::Secp256k1
+
+    # Generate schnorr signature for sign-to-signature.
+    # @param message [String] A message to be signed with binary format.
+    # @param private_key [Integer] The private key.
+    # @param contract [String] A contract information with 32-bytes binary format.
+    # @return [(Schnorr::Signature, ECDSA::Point)] signature and point to prove the commitment to contract.
+    def sign(message, private_key, contract)
+      raise 'The message must be a 32-byte array.' unless message.bytesize == 32
+      raise 'private_key is zero or over the curve order.' if private_key == 0 || private_key >= GROUP.order
+      raise 'The contract must be a 32-byte binary string.' unless contract.bytesize == 32
+
+      p = GROUP.new_point(private_key)
+      k0 = Schnorr.deterministic_nonce(message, private_key)
+
+      k1, r = tweak(k0, contract)
+
+      q = GROUP.new_point(k1)
+      k = ECDSA::PrimeField.jacobi(q.y, GROUP.field.prime) == 1 ? k1 : GROUP.order - k1
+
+      e = Schnorr.create_challenge(q.x, p, message)
+
+      [Schnorr::Signature.new(q.x, (k + e * private_key) % GROUP.order), r]
+    end
+
+    def tweak(k, contract)
+      r = GROUP.new_point(k)
+      rx = ECDSA::Format::IntegerOctetString.encode(r.x, GROUP.byte_length)
+      h = Tapyrus.sha256(rx + contract)
+      k1 = (k + h.bth.to_i(16)) % GROUP.order
+      raise 'Creation of signature failed. k + h(R || c) is zero' if k1.zero?
+      [k1, r]
+    end
+
+    # Validate contract
+    # @param r [ECDSA::Point] point to prove the commitment.
+    # @param signature [Schnorr::Signature] signature.
+    # @param contract [String]  A contract information with 32-bytes binary format.
+    # @return true if commitment for contract is valid, otherwise false
+    def valid_contract?(r, signature, contract)
+      rx = ECDSA::Format::IntegerOctetString.encode(r.x, GROUP.byte_length)
+      commitment = Tapyrus.sha256(rx + contract).bth.to_i(16) % GROUP.order
+      point = r + GROUP.generator.multiply_by_scalar(commitment)
+      signature.r == point.x
+    end
+  end
+end

data/lib/schnorr/signature.rb

@@ -1,11 +1,10 @@
 module Schnorr
-
-  class InvalidSignatureError < StandardError; end
+  class InvalidSignatureError < StandardError
+  end
 
   # Instances of this class represents Schnorr signatures,
   # which are simply a pair of integers named `r` and `s`.
   class Signature
-
     attr_reader :r
     attr_reader :s
 
@@ -32,7 +31,5 @@ module Schnorr
     def encode
       ECDSA::Format::IntegerOctetString.encode(r, 32) + ECDSA::Format::IntegerOctetString.encode(s, 32)
     end
-
   end
-
-end
+end

data/lib/tapyrus.rb

@@ -13,7 +13,6 @@ require_relative 'openassets'
 require_relative 'schnorr'
 
 module Tapyrus
-
   autoload :Ext, 'tapyrus/ext'
   autoload :Util, 'tapyrus/util'
   autoload :ChainParams, 'tapyrus/chain_params'
@@ -49,6 +48,8 @@ module Tapyrus
   autoload :SLIP39, 'tapyrus/slip39'
   autoload :Color, 'tapyrus/script/color'
   autoload :Errors, 'tapyrus/errors'
+  autoload :TxBuilder, 'tapyrus/tx_builder'
+  autoload :BIP175, 'tapyrus/bip175'
 
   require_relative 'tapyrus/constants'
   require_relative 'tapyrus/ext/ecdsa'
@@ -59,7 +60,7 @@ module Tapyrus
 
   # set tapyrus network chain params
   def self.chain_params=(name)
-    raise "chain params for #{name} is not defined." unless %i(prod dev).include?(name.to_sym)
+    raise "chain params for #{name} is not defined." unless %i[prod dev].include?(name.to_sym)
     @current_chain = nil
     @chain_param = name.to_sym
   end
@@ -118,14 +119,7 @@ module Tapyrus
 
     # get opcode
     def opcode
-      case encoding
-      when Encoding::ASCII_8BIT
-        each_byte.next
-      when Encoding::US_ASCII
-        ord
-      else
-        to_i
-      end
+      force_encoding(Encoding::ASCII_8BIT).ord
     end
 
     def opcode?
@@ -160,17 +154,11 @@ module Tapyrus
     def valid_hex?
       !self[/\H/]
     end
-
   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
+      self.is_a?(Array) ? "[#{self.map { |o| o.to_h.to_json }.join(',')}]" : to_h.to_json
     end
 
     def to_h
@@ -179,14 +167,9 @@ module Tapyrus
         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)
-        end
+        value.is_a?(Array) ? result.update(key => value.map { |v| v.to_h }) : result.update(key => value)
       end
     end
-
   end
 
   class ::Integer
@@ -200,13 +183,8 @@ module Tapyrus
     end
 
     # convert bit string
-    def to_bits(length = nil )
-      if length
-        to_s(2).rjust(length, '0')
-      else
-        to_s(2)
-      end
+    def to_bits(length = nil)
+      length ? to_s(2).rjust(length, '0') : to_s(2)
     end
   end
-
 end