tapyrus 0.2.1 → 0.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0742065204db9e10454dbdc9afc4401be70659e9998376d944b4e0f61a75cf27
-  data.tar.gz: 578bd756abb67374d62951526638c9328c3f9e70f9925cd7e3f16f079093843b
+  metadata.gz: ba1dec1b7532b15985c9233604dc63ad38b4a11e61d4bbc63d54cebdb291b3d6
+  data.tar.gz: 3b7cb3c9e41df3693ac45b22084108b1ec682fd753a10ff95cf0d50133bff959
 SHA512:
-  metadata.gz: 584cf7b8ce40aeb94ecce56c393ab52805b5af76bf91439f5f1b39cf28ce15a723bc2b37862773e5c1cd994cb6d72f270b4f77c828708384e9fe70990efbd19c
-  data.tar.gz: cdc17bfad7962a3900ad567c07d0d53550f0db4eacf8b10c80e76017206aeed702c336fee9a7283502ae3ebdcf68de6da45e90a22ea0044e22e80839fa6cd43d
+  metadata.gz: f82c7815830b1eb9aba88b0247acf36cb64f9ab47802e6b05c6dc4e167503baf85fa1696bfc59fe79cd78c8866b0638b2022cb52b3c924e2db34f09c06d01370
+  data.tar.gz: 8cdeec0c475d32f905b245f3b2a8ef9551d4ee55a1e21abe9a5b1f38b1dfe6fb317cfa85387899b5d0d5667bf19278654fee800b0b90234fa1407cd9f1703f8b

data/.travis.yml

@@ -1,8 +1,10 @@
 language: ruby
 rvm:
-  - 2.4.6
-  - 2.5.5
-  - 2.6.3
+  - 2.4.10
+  - 2.5.8
+  - 2.6.6
+  - 2.7.2
+  - 3.0.0
 addons:
   apt:
     packages:

data/README.md

@@ -12,7 +12,7 @@ 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 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.
+* 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

data/lib/schnorr.rb

@@ -76,7 +76,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= ECDSA::Format::PointOctetString.encode(p, compression:true)
+    p_str= p.to_hex.htb
     (ECDSA.normalize_digest(Digest::SHA256.digest(r_x + p_str + message), GROUP.bit_length)) % GROUP.order
   end
 

data/lib/tapyrus.rb

@@ -48,8 +48,10 @@ module Tapyrus
   autoload :KeyPath, 'tapyrus/key_path'
   autoload :SLIP39, 'tapyrus/slip39'
   autoload :Color, 'tapyrus/script/color'
+  autoload :Errors, 'tapyrus/errors'
 
   require_relative 'tapyrus/constants'
+  require_relative 'tapyrus/ext/ecdsa'
 
   extend Util
 
@@ -207,11 +209,4 @@ module Tapyrus
     end
   end
 
-  class ::ECDSA::Signature
-    # convert signature to der string.
-    def to_der
-      ECDSA::Format::SignatureDerString.encode(self)
-    end
-  end
-
 end

data/lib/tapyrus/block.rb

@@ -1,5 +1,6 @@
 module Tapyrus
   class Block
+    include Tapyrus::Util
 
     attr_accessor :header
     attr_accessor :transactions
@@ -32,14 +33,9 @@ module Tapyrus
     end
 
     # return this block height. block height is included in coinbase.
-    # if block version under 1, height does not include in coinbase, so return nil.
+    # @return [Integer] block height.
     def height
-      return nil if header.features < 2
-      coinbase_tx = transactions[0]
-      return nil unless coinbase_tx.coinbase_tx?
-      buf = StringIO.new(coinbase_tx.inputs[0].script_sig.to_payload)
-      len = Tapyrus.unpack_var_int_from_io(buf)
-      buf.read(len).reverse.bth.to_i(16)
+      transactions.first.in.first.out_point.index
     end
 
   end

data/lib/tapyrus/block_header.rb

@@ -3,61 +3,69 @@ module Tapyrus
   # Block Header
   class BlockHeader
     include Tapyrus::HexConverter
+    extend Tapyrus::Util
+    include Tapyrus::Util
+
+    X_FILED_TYPES = {none: 0, aggregate_pubkey: 1}
 
     attr_accessor :features
     attr_accessor :prev_hash
     attr_accessor :merkle_root
-    attr_accessor :time # unix timestamp
-    attr_accessor :bits
-    attr_accessor :nonce
+    attr_accessor :im_merkle_root # merkel root of immulable merkle tree which consist of immutable txid.
+    attr_accessor :time           # unix timestamp
+    attr_accessor :x_field_type
+    attr_accessor :x_field
+    attr_accessor :proof
 
-    def initialize(features, prev_hash, merkle_root, time, bits, nonce)
+    def initialize(features, prev_hash, merkle_root, im_merkle_root, time, x_field_type, x_field, proof = nil)
       @features = features
       @prev_hash = prev_hash
       @merkle_root = merkle_root
+      @im_merkle_root = im_merkle_root
       @time = time
-      @bits = bits
-      @nonce = nonce
+      @x_field_type = x_field_type
+      @x_field = x_field
+      @proof = proof
     end
 
     def self.parse_from_payload(payload)
-      features, prev_hash, merkle_root, time, bits, nonce = payload.unpack('Va32a32VVV')
-      new(features, prev_hash.bth, merkle_root.bth, time, bits, nonce)
-    end
-
-    def to_payload
-      [features, prev_hash.htb, merkle_root.htb, time, bits, nonce].pack('Va32a32VVV')
+      buf = payload.is_a?(String) ? StringIO.new(payload) : payload
+      features, prev_hash, merkle_root, im_merkle_root, time, x_filed_type = buf.read(105).unpack('Va32a32a32Vc')
+      x_field = buf.read(unpack_var_int_from_io(buf)) unless x_filed_type == X_FILED_TYPES[:none]
+      proof = buf.read(unpack_var_int_from_io(buf))
+      new(features, prev_hash.bth, merkle_root.bth, im_merkle_root.bth, time, x_filed_type, x_field ? x_field.bth : x_field, proof.bth)
     end
 
-    # compute difficulty target from bits.
-    def difficulty_target
-      exponent = ((bits >> 24) & 0xff)
-      mantissa = bits & 0x7fffff
-      mantissa *= -1 if (bits & 0x800000) > 0
-      (mantissa * 2 ** (8 * (exponent - 3)))
+    def to_payload(skip_proof = false)
+      payload = [features, prev_hash.htb, merkle_root.htb, im_merkle_root.htb, time, x_field_type].pack('Va32a32a32Vc')
+      payload << pack_var_string(x_field.htb) unless x_field_type == X_FILED_TYPES[:none]
+      payload << pack_var_string(proof.htb) if proof && !skip_proof
+      payload
     end
 
-    def hash
-      calc_hash.to_i(16)
+    # Calculate hash using sign which does not contains proof.
+    # @return [String] hash of block without proof.
+    def hash_for_sign
+      Tapyrus.double_sha256(to_payload(true)).bth
     end
 
+    # Calculate block hash
+    # @return [String] hash of block with hex format.
     def block_hash
-      calc_hash
+      Tapyrus.double_sha256(to_payload).bth
     end
 
     # block hash(big endian)
+    # @return [String] block id which is reversed version of block hash.
     def block_id
       block_hash.rhex
     end
 
     # evaluate block header
-    def valid?
-      valid_pow? && valid_timestamp?
-    end
-
-    # evaluate valid proof of work.
-    def valid_pow?
-      block_id.hex < difficulty_target
+    # @param [String] agg_pubkey aggregated public key for signers with hex format.
+    # @return [Boolean] result.
+    def valid?(agg_pubkey)
+      valid_timestamp? && valid_proof?(agg_pubkey) && valid_x_field?
     end
 
     # evaluate valid timestamp.
@@ -66,22 +74,42 @@ module Tapyrus
       time <= Time.now.to_i + Tapyrus::MAX_FUTURE_BLOCK_TIME
     end
 
-    # compute chain work of this block.
-    # @return [Integer] a chain work.
-    def work
-      target = difficulty_target
-      return 0 if target < 1
-      115792089237316195423570985008687907853269984665640564039457584007913129639936.div(target + 1) # 115792089237316195423570985008687907853269984665640564039457584007913129639936 is 2**256
+    # Check whether proof is valid.
+    # @param [String] agg_pubkey aggregated public key for signers with hex format.
+    # @return [Boolean] Return true if proof is valid, otherwise return false.
+    def valid_proof?(agg_pubkey)
+      pubkey = Tapyrus::Key.new(pubkey: agg_pubkey)
+      msg = hash_for_sign.htb
+      pubkey.verify(proof.htb, msg, algo: :schnorr)
+    end
+
+    # Check whether x_field is valid.
+    # @return [Boolean] if valid return true, otherwise false
+    def valid_x_field?
+      case x_field_type
+      when X_FILED_TYPES[:none] then
+        x_field.nil?
+      when X_FILED_TYPES[:aggregate_pubkey] then
+        Tapyrus::Key.new(pubkey: x_field).fully_valid_pubkey?
+      else
+        false
+      end
+    end
+
+    # Check this header contains upgrade aggregated publiec key.
+    # @return [Boolean] if contains return true, otherwise false.
+    def upgrade_agg_pubkey?
+      x_field_type == X_FILED_TYPES[:aggregate_pubkey]
     end
 
     def ==(other)
       other && other.to_payload == to_payload
     end
 
-    private
-
-    def calc_hash
-      Tapyrus.double_sha256(to_payload).bth
+    # get bytesize.
+    # @return [Integer] bytesize.
+    def size
+      to_payload.bytesize
     end
 
   end

data/lib/tapyrus/chain_params.rb

@@ -33,12 +33,10 @@ module Tapyrus
     attr_reader :bip34_height
     attr_reader :proof_of_work_limit
     attr_reader :dns_seeds
-    attr_reader :genesis
     attr_reader :bip44_coin_type
 
     attr_accessor :dust_relay_fee
 
-
     # production genesis
     def self.prod
       init('prod')
@@ -57,14 +55,6 @@ module Tapyrus
       network == 'dev'
     end
 
-    def genesis_block
-      header = Tapyrus::BlockHeader.new(
-          genesis['version'], genesis['prev_hash'].rhex, genesis['merkle_root'].rhex,
-          genesis['time'], genesis['bits'], genesis['nonce'])
-      Tapyrus::Block.new(header)
-    end
-
-
     def self.init(name)
       i = YAML.load(File.open("#{__dir__}/chainparams/#{name}.yml"))
       i.dust_relay_fee ||= Tapyrus::DUST_RELAY_TX_FEE

data/lib/tapyrus/chainparams/dev.yml

@@ -25,15 +25,5 @@ retarget_time: 1209600 # 2 weeks
 target_spacing: 600 # block interval
 max_money: 21000000
 bip34_height: 227931
-genesis_hash: "000000000933ea01ad0ee984209779baaec3ced90fa3f408719526f8d77f4943"
-proof_of_work_limit: 0x1d00ffff
 dns_seeds:
-genesis:
-  hash: "000000000933ea01ad0ee984209779baaec3ced90fa3f408719526f8d77f4943"
-  merkle_root: "4a5e1e4baab89f3a32518a88c31bc87f618f76673e2cc77ab2127b7afdeda33b"
-  time: 1296688602
-  nonce: 414098458
-  bits: 0x1d00ffff
-  version: 1
-  prev_hash: "0000000000000000000000000000000000000000000000000000000000000000"
 bip44_coin_type: 1

data/lib/tapyrus/chainparams/prod.yml

@@ -25,14 +25,5 @@ retarget_time: 1209600 # 2 weeks
 target_spacing: 600 # block interval
 max_money: 21000000
 bip34_height: 227931
-proof_of_work_limit: 0x1d00ffff
 dns_seeds:
-genesis:
-  hash: "000000000019d6689c085ae165831e934ff763ae46a2a6c172b3f1b60a8ce26f"
-  merkle_root: "4a5e1e4baab89f3a32518a88c31bc87f618f76673e2cc77ab2127b7afdeda33b"
-  time: 1231006505
-  nonce: 2083236893
-  bits: 0x1d00ffff
-  version: 1
-  prev_hash: "0000000000000000000000000000000000000000000000000000000000000000"
 bip44_coin_type: 0

data/lib/tapyrus/errors.rb

@@ -0,0 +1,17 @@
+module Tapyrus
+  module Errors
+    module Messages
+
+      INVALID_PUBLIC_KEY = 'Invalid public key.'
+      INVALID_BIP32_PRIV_PREFIX = 'Invalid BIP32 private key prefix. prefix must be 0x00.'
+      INVALID_BIP32_FINGERPRINT = 'Invalid parent fingerprint.'
+      INVALID_BIP32_ZERO_INDEX = 'Invalid index. Depth 0 must have 0 index.'
+      INVALID_BIP32_ZERO_DEPTH = 'Invalid depth. Master key must have 0 depth.'
+      INVALID_BIP32_VERSION = 'An unsupported version byte was specified.'
+
+      INVALID_PRIV_KEY = 'Private key is not in range [1..n-1].'
+      INVALID_CHECKSUM = 'Invalid checksum.'
+
+    end
+  end
+end

data/lib/tapyrus/ext/ecdsa.rb

@@ -0,0 +1,39 @@
+class ::ECDSA::Signature
+  # convert signature to der string.
+  def to_der
+    ECDSA::Format::SignatureDerString.encode(self)
+  end
+end
+
+class ::ECDSA::Point
+  def to_hex(compression = true)
+    ECDSA::Format::PointOctetString.encode(self, compression: compression).bth
+  end
+end
+
+module ::ECDSA::Format::PointOctetString
+
+  def self.decode(string, group, allow_hybrid: false)
+    string = string.dup.force_encoding('BINARY')
+
+    raise ECDSA::Format::DecodeError, 'Point octet string is empty.' if string.empty?
+
+    case string[0].ord
+    when 0
+      check_length string, 1
+      return group.infinity
+    when 2
+      decode_compressed string, group, 0
+    when 3
+      decode_compressed string, group, 1
+    when 4
+      decode_uncompressed string, group
+    when 6..7
+      raise ECDSA::Format::DecodeError, 'Unrecognized start byte for point octet string: 0x%x' % string[0].ord unless allow_hybrid
+      decode_uncompressed string, group if allow_hybrid
+    else
+      raise ECDSA::Format::DecodeError, 'Unrecognized start byte for point octet string: 0x%x' % string[0].ord
+    end
+  end
+
+end

data/lib/tapyrus/ext_key.rb

@@ -7,6 +7,9 @@ module Tapyrus
   class ExtKey
     include Tapyrus::HexConverter
 
+    MAX_DEPTH = 255
+    MASTER_FINGERPRINT = '00000000'
+
     attr_accessor :ver
     attr_accessor :depth
     attr_accessor :number
@@ -20,7 +23,7 @@ module Tapyrus
       ext_key = ExtKey.new
       ext_key.depth = ext_key.number = 0
       ext_key.parent_fingerprint = '00000000'
-      l = Tapyrus.hmac_sha512('Bitcoin seed', seed.htb)
+      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])
@@ -48,9 +51,7 @@ module Tapyrus
 
     # Base58 encoded extended private key
     def to_base58
-      h = to_hex
-      hex = h + Tapyrus.calc_checksum(h)
-      Base58.encode(hex)
+      ExtPubkey.encode_base58(to_hex)
     end
 
     # get private key(hex)
@@ -141,19 +142,24 @@ module Tapyrus
       buf = StringIO.new(payload)
       ext_key = ExtKey.new
       ext_key.ver = buf.read(4).bth # version
-      raise 'An unsupported version byte was specified.' unless ExtKey.support_version?(ext_key.ver)
+      raise ArgumentError, Errors::Messages::INVALID_BIP32_VERSION unless ExtKey.support_version?(ext_key.ver)
       ext_key.depth = buf.read(1).unpack('C').first
       ext_key.parent_fingerprint = buf.read(4).bth
       ext_key.number = buf.read(4).unpack('N').first
+      if ext_key.depth == 0
+        raise ArgumentError, Errors::Messages::INVALID_BIP32_FINGERPRINT unless ext_key.parent_fingerprint == ExtKey::MASTER_FINGERPRINT
+        raise ArgumentError, Errors::Messages::INVALID_BIP32_ZERO_INDEX if ext_key.number > 0
+      end
+      raise ArgumentError, Errors::Messages:: INVALID_BIP32_ZERO_DEPTH if ext_key.parent_fingerprint == ExtKey::MASTER_FINGERPRINT && ext_key.depth > 0
       ext_key.chain_code = buf.read(32)
-      buf.read(1) # 0x00
+      raise ArgumentError, Errors::Messages::INVALID_BIP32_PRIV_PREFIX unless buf.read(1).bth == '00' # 0x00
       ext_key.key = Tapyrus::Key.new(priv_key: buf.read(32).bth, key_type: Tapyrus::Key::TYPES[:compressed])
       ext_key
     end
 
     # import private key from Base58 private key address
     def self.from_base58(address)
-      ExtKey.parse_from_payload(Base58.decode(address).htb)
+      ExtKey.parse_from_payload(ExtPubkey.validate_checksum(address))
     end
 
     # get version bytes from purpose' value.
@@ -237,9 +243,14 @@ module Tapyrus
 
     # Base58 encoded extended pubkey
     def to_base58
-      h = to_hex
-      hex = h + Tapyrus.calc_checksum(h)
-      Base58.encode(hex)
+      ExtPubkey.encode_base58(to_hex)
+    end
+
+    # Generate Base58 encoded key from BIP32 payload with hex format.
+    # @param [String] hex BIP32 payload with hex format.
+    # @return [String] Base58 encoded extended key.
+    def self.encode_base58(hex)
+      Base58.encode(hex + Tapyrus.calc_checksum(hex))
     end
 
     # whether hardened key.
@@ -260,7 +271,7 @@ module Tapyrus
       raise 'invalid key' if left >= CURVE_ORDER
       p1 = Tapyrus::Secp256k1::GROUP.generator.multiply_by_scalar(left)
       p2 = Tapyrus::Key.new(pubkey: pubkey, key_type: key_type).to_point
-      new_key.pubkey = ECDSA::Format::PointOctetString.encode(p1 + p2, compression: true).bth
+      new_key.pubkey = (p1 + p2).to_hex
       new_key.chain_code = l[32..-1]
       new_key.ver = version
       new_key
@@ -293,19 +304,32 @@ module Tapyrus
       buf = StringIO.new(payload)
       ext_pubkey = ExtPubkey.new
       ext_pubkey.ver = buf.read(4).bth # version
-      raise 'An unsupported version byte was specified.' unless ExtPubkey.support_version?(ext_pubkey.ver)
+      raise ArgumentError, Errors::Messages::INVALID_BIP32_VERSION unless ExtPubkey.support_version?(ext_pubkey.ver)
       ext_pubkey.depth = buf.read(1).unpack('C').first
       ext_pubkey.parent_fingerprint = buf.read(4).bth
       ext_pubkey.number = buf.read(4).unpack('N').first
+      if ext_pubkey.depth == 0
+        raise ArgumentError, Errors::Messages::INVALID_BIP32_FINGERPRINT unless ext_pubkey.parent_fingerprint == ExtKey::MASTER_FINGERPRINT
+        raise ArgumentError, Errors::Messages::INVALID_BIP32_ZERO_INDEX if ext_pubkey.number > 0
+      end
+      raise ArgumentError, Errors::Messages::INVALID_BIP32_ZERO_DEPTH if ext_pubkey.parent_fingerprint == ExtKey::MASTER_FINGERPRINT && ext_pubkey.depth > 0
       ext_pubkey.chain_code = buf.read(32)
-      ext_pubkey.pubkey = buf.read(33).bth
+      ext_pubkey.pubkey = Tapyrus::Key.new(pubkey: buf.read(33).bth).pubkey
       ext_pubkey
     end
 
-
     # import pub key from Base58 private key address
     def self.from_base58(address)
-      ExtPubkey.parse_from_payload(Base58.decode(address).htb)
+      ExtPubkey.parse_from_payload(ExtPubkey.validate_checksum(address))
+    end
+
+    # Validate address checksum and return payload.
+    # @param [String] BIP32 Base58 address
+    # @return [String] BIP32 payload with binary format
+    def self.validate_checksum(base58)
+      raw = Base58.decode(base58)
+      raise ArgumentError, Errors::Messages::INVALID_CHECKSUM unless Tapyrus.calc_checksum(raw[0...-8]) == raw[-8..-1]
+      raw[0...-8].htb
     end
 
     # get version bytes from purpose' value.