tapyrus 0.3.9 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a2b7edea1facc6228c16aad20bb3e276ed43bb11f97de6bf0c4075cdaa02ccd0
-  data.tar.gz: 95b04f8b54cff7056b054349bc4ed86eed4a580479118fcfcdd872461f1a99d6
+  metadata.gz: 9ceb5c0fcc47319d15e66a21760c345cb1ee029a71f1313046f1676e883972a5
+  data.tar.gz: 13a2463ef2432f904acef3b9880a275d0e174485086a469d9a9177dcebf9f200
 SHA512:
-  metadata.gz: 47a70989491951817c29e1b984f1ff3a873cb94722bbcab149d86c841647c69593ad087d72217742b152eb3cb251c29e8ce43ec8730027b1d3ba7cf3482c4332
-  data.tar.gz: f2703d586a1751da3c7145cbf4d2e14a4bcc498f43911bce9518846a3d299a5d4d1cda0115a6bd6bdf6ac47fe3766ca5110b0366be47b68331a59a2f62470a7a
+  metadata.gz: 8a89f3d1a2bca680384a69dd4793d43a4c102e67ae14e69e4d88205ef46c343e8efe015eaf1b586c17e4b1163814628425282cb3911b506397b28ee49ac66ac7
+  data.tar.gz: d819136137c7571173e98576ce21b5b08b1c5779269baddbdd49bcd4bfcffc51076e5ecee0c27ddfba56c3ca34f8c70e68e1cc3f76165fe4bdea21a6060ad0d3

data/.github/workflows/ruby.yml

@@ -18,11 +18,11 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby-version: ["3.0", "3.1", "3.2", "3.3", "3.4"]
+        ruby-version: ["3.2", "3.3", "3.4", "4.0"]
 
     steps:
       - run: sudo apt install libleveldb-dev
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
       - 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):

data/.ruby-version

@@ -1 +1 @@
-3.4.1
+ruby-4.0.0

data/README.md

@@ -13,8 +13,8 @@ Tapyrusrb supports following feature:
 - 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
+- Schnorr signature
+- Partially Signed Tapyrus Transaction ([TIP-0174](https://github.com/chaintope/tips/blob/master/tip-0174.md))
 
 ## Requirements
 
@@ -80,6 +80,47 @@ Tapyrus.chain_params = :dev
 
 This parameter is described in https://github.com/chaintope/tapyrusrb/blob/master/lib/tapyrus/chainparams/dev.yml.
 
+### PSTT (Partially Signed Tapyrus Transaction)
+
+`Tapyrus::PSTT` implements the format [TIP-0174](https://github.com/chaintope/tips/blob/master/tip-0174.md) defines.
+Its methods follow the roles of the TIP: Creator, Constructor, Updater, Signer, Combiner, Input Finalizer and
+Transaction Extractor.
+
+```ruby
+# Creator
+pstt =
+  Tapyrus::PSTT::Tx.new(
+    inputs: [Tapyrus::PSTT::Input.new(out_point: out_point, utxo: prev_tx)],
+    outputs: [Tapyrus::PSTT::Output.new(amount: 99_000, script_pubkey: script_pubkey)]
+  )
+
+# Signer. The signature hash is computed from the fields of the PSTT.
+pstt.sign(0, key) # ECDSA. Pass algo: :schnorr for a Schnorr signature.
+
+# Input Finalizer and Transaction Extractor
+pstt.finalize!
+tx = pstt.extract_tx
+
+# For text transport
+Tapyrus::PSTT::Tx.from_base64(pstt.to_base64)
+```
+
+A PSTT which other parties will extend is created with `tx_modifiable`, so that a Constructor can add inputs and
+outputs afterwards. This is what a fee provider, which supplies the TPC that pays the fee of a Colored Coin
+transaction, needs:
+
+```ruby
+# The user leaves the inputs modifiable and signs with SIGHASH_ALL | SIGHASH_ANYONECANPAY.
+pstt = Tapyrus::PSTT::Tx.new(tx_modifiable: Tapyrus::PSTT::TxModifiable::INPUTS, inputs: inputs, outputs: outputs)
+pstt.sign(0, key, sighash_type: Tapyrus::SIGHASH_TYPE[:all] | Tapyrus::SIGHASH_TYPE[:anyonecanpay])
+
+# The fee provider verifies the amounts per color, then adds its TPC input and signs with SIGHASH_ALL.
+pstt.input_amounts # => { Tapyrus::Color::ColorIdentifier => amount }
+pstt.fee
+pstt.add_input(Tapyrus::PSTT::Input.new(out_point: fee_out_point, utxo: fee_tx))
+pstt.sign(1, provider_key)
+```
+
 ## Contributing
 
 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.

data/lib/tapyrus/ext_key.rb

@@ -111,14 +111,16 @@ module Tapyrus
       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
+      # A depth 1 key derives its version bytes from the purpose, see #version.
+      new_key.ver = new_key.depth == 1 ? nil : version
       new_key
     end
 
     # get version bytes using serialization format
     def version
+      return ver if ver
       return ExtKey.version_from_purpose(number) if depth == 1
-      ver ? ver : Tapyrus.chain_params.extended_privkey_version
+      Tapyrus.chain_params.extended_privkey_version
     end
 
     # get key type defined by BIP-178 using version.
@@ -282,14 +284,16 @@ module Tapyrus
       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]
-      new_key.ver = version
+      # A depth 1 key derives its version bytes from the purpose, see #version.
+      new_key.ver = new_key.depth == 1 ? nil : version
       new_key
     end
 
     # get version bytes using serialization format
     def version
+      return ver if ver
       return ExtPubkey.version_from_purpose(number) if depth == 1
-      ver ? ver : Tapyrus.chain_params.extended_pubkey_version
+      Tapyrus.chain_params.extended_pubkey_version
     end
 
     # get key type defined by BIP-178 using version.

data/lib/tapyrus/key.rb

@@ -320,7 +320,7 @@ module Tapyrus
       if low_r && !sig_has_low_r?(sig)
         counter = 1
         until sig_has_low_r?(sig)
-          extra_entropy = [counter].pack("I*").bth.ljust(64, "0").htb
+          extra_entropy = [counter].pack("V").bth.ljust(64, "0").htb
           sig = secp256k1_module.sign_data(data, priv_key, extra_entropy, algo: :ecdsa)
           counter += 1
         end

data/lib/tapyrus/key_path.rb

@@ -3,20 +3,24 @@ module Tapyrus
     # key path convert an array of derive number
     # @param [String] path_string
     # @return [Array[Integer]] key path numbers.
+    # @raise [ArgumentError] if the path is not a sequence of decimal indexes, each optionally
+    #   followed by the hardened marker and each below Tapyrus::HARDENED_THRESHOLD.
     def parse_key_path(path_string)
-      path_string
-        .split("/")
-        .map
-        .with_index do |p, index|
-          if index == 0
-            raise ArgumentError.new("#{path_string} is invalid format.") unless p == "m"
-            next
-          end
-          raise ArgumentError.new("#{path_string} is invalid format.") unless p.delete("'") =~ /^[0-9]+$/
-          (p[-1] == "'" ? p.delete("'").to_i + Tapyrus::HARDENED_THRESHOLD : p.to_i)
-        end[
-        1..-1
-      ]
+      elements = path_string.split("/")
+      raise ArgumentError.new("#{path_string} is invalid format.") unless elements.first == "m"
+      elements[1..-1].map do |element|
+        hardened = element.end_with?("'")
+        # The index is validated before it is converted, since String#to_i stops at the first
+        # character which is not a digit and returns what it read so far. An element such as
+        # "1'2" would otherwise be taken for the index 1.
+        digits = hardened ? element[0..-2] : element
+        raise ArgumentError.new("#{path_string} is invalid format.") unless digits =~ /\A[0-9]+\z/
+        index = digits.to_i
+        # An index of Tapyrus::HARDENED_THRESHOLD or above is the hardened child of a smaller
+        # index, so it has no representation of its own in this notation.
+        raise ArgumentError.new("#{path_string} is invalid format.") if index >= Tapyrus::HARDENED_THRESHOLD
+        hardened ? index + Tapyrus::HARDENED_THRESHOLD : index
+      end
     end
 
     # key path numbers convert to path string.

data/lib/tapyrus/message/fee_filter.rb

@@ -13,11 +13,11 @@ module Tapyrus
       end
 
       def self.parse_from_payload(payload)
-        new(payload.unpack("Q").first)
+        new(payload.unpack("Q<").first)
       end
 
       def to_payload
-        [fee_rate].pack("Q")
+        [fee_rate].pack("Q<")
       end
     end
   end

data/lib/tapyrus/message/header_and_short_ids.rb

@@ -15,13 +15,13 @@ module Tapyrus
         @nonce = nonce
         @short_ids = short_ids
         @prefilled_txn = prefilled_txn
-        @siphash_key = Tapyrus.sha256(header.to_payload << [nonce].pack("q*"))[0...16]
+        @siphash_key = Tapyrus.sha256(header.to_payload << [nonce].pack("q<*"))[0...16]
       end
 
       def self.parse_from_payload(payload)
         buf = StringIO.new(payload)
         header = Tapyrus::BlockHeader.parse_from_payload(buf)
-        nonce = buf.read(8).unpack("q*").first
+        nonce = buf.read(8).unpack("q<*").first
         short_ids_len = Tapyrus.unpack_var_int_from_io(buf)
         short_ids = short_ids_len.times.map { buf.read(6).reverse.bth.to_i(16) }
         prefilled_txn_len = Tapyrus.unpack_var_int_from_io(buf)
@@ -31,9 +31,9 @@ module Tapyrus
 
       def to_payload
         p = header.to_payload
-        p << [nonce].pack("q*")
+        p << [nonce].pack("q<*")
         p << Tapyrus.pack_var_int(short_ids.size)
-        p << short_ids.map { |id| sprintf("%12x", id).htb.reverse }.join
+        p << short_ids.map { |id| sprintf("%012x", id).htb.reverse }.join
         p << Tapyrus.pack_var_int(prefilled_txn.size)
         p << prefilled_txn.map(&:to_payload).join
         p

data/lib/tapyrus/message/inventory.rb

@@ -27,7 +27,7 @@ module Tapyrus
       # parse inventory payload
       def self.parse_from_payload(payload)
         raise Error, "invalid inventory size." if payload.bytesize != 36
-        identifier = payload[0..4].unpack("V").first
+        identifier = payload[0..3].unpack("V").first
         hash = payload[4..-1].bth # internal byte order
         new(identifier, hash)
       end

data/lib/tapyrus/message/network_addr.rb

@@ -35,7 +35,7 @@ module Tapyrus
         has_time = buf.size > 26
         addr = new(time: nil)
         addr.time = buf.read(4).unpack("V").first if has_time
-        addr.services = buf.read(8).unpack("Q").first
+        addr.services = buf.read(8).unpack("Q<").first
         addr.ip_addr = IPAddr.new_ntoh(buf.read(16))
         addr.port = buf.read(2).unpack("n").first
         addr
@@ -57,7 +57,7 @@ module Tapyrus
         p = ""
         p << [time].pack("V") unless skip_time
         addr = ip_addr.ipv4? ? ip_addr.ipv4_mapped : ip_addr
-        p << [services].pack("Q") << addr.hton << [port].pack("n")
+        p << [services].pack("Q<") << addr.hton << [port].pack("n")
       end
     end
   end

data/lib/tapyrus/message/ping.rb

@@ -12,11 +12,11 @@ module Tapyrus
       end
 
       def self.parse_from_payload(payload)
-        new(payload.unpack("Q").first)
+        new(payload.unpack("Q<").first)
       end
 
       def to_payload
-        [nonce].pack("Q")
+        [nonce].pack("Q<")
       end
 
       def to_response

data/lib/tapyrus/message/pong.rb

@@ -12,11 +12,11 @@ module Tapyrus
       end
 
       def self.parse_from_payload(payload)
-        new(payload.unpack("Q").first)
+        new(payload.unpack("Q<").first)
       end
 
       def to_payload
-        [nonce].pack("Q")
+        [nonce].pack("Q<")
       end
     end
   end

data/lib/tapyrus/message/send_cmpct.rb

@@ -21,12 +21,12 @@ module Tapyrus
       def self.parse_from_payload(payload)
         buf = StringIO.new(payload)
         mode = buf.read(1).unpack("c").first
-        version = buf.read(8).unpack("Q").first
+        version = buf.read(8).unpack("Q<").first
         new(mode, version)
       end
 
       def to_payload
-        [mode, version].pack("cQ")
+        [mode, version].pack("cQ<")
       end
 
       def high?

data/lib/tapyrus/message/version.rb

@@ -30,7 +30,7 @@ module Tapyrus
       end
 
       def self.parse_from_payload(payload)
-        version, services, timestamp, local_addr, remote_addr, nonce, rest = payload.unpack("VQQa26a26Qa*")
+        version, services, timestamp, local_addr, remote_addr, nonce, rest = payload.unpack("VQ<Q<a26a26Q<a*")
         v = new
         v.version = version
         v.services = services
@@ -48,10 +48,10 @@ module Tapyrus
 
       def to_payload
         [
-          [version, services, timestamp].pack("VQQ"),
+          [version, services, timestamp].pack("VQ<Q<"),
           local_addr.to_payload(true),
           remote_addr.to_payload(true),
-          [nonce].pack("Q"),
+          [nonce].pack("Q<"),
           pack_var_string(user_agent),
           [start_height].pack("V"),
           pack_boolean(relay)

data/lib/tapyrus/mnemonic.rb

@@ -24,7 +24,7 @@ module Tapyrus
       mnemonic =
         words
           .map do |w|
-            index = word_master.index(w.downcase)
+            index = word_master.index(normalize(w).downcase)
             raise IndexError, "word not found in words list." unless index
             index.to_s(2).rjust(11, "0")
           end
@@ -55,8 +55,8 @@ module Tapyrus
     def to_seed(mnemonic, passphrase: "")
       to_entropy(mnemonic)
       OpenSSL::PKCS5.pbkdf2_hmac(
-        mnemonic.join(" ").downcase,
-        "mnemonic" + passphrase,
+        normalize(mnemonic.join(" ")).downcase,
+        "mnemonic" + normalize(passphrase),
         2048,
         64,
         OpenSSL::Digest::SHA512.new
@@ -75,7 +75,12 @@ module Tapyrus
 
     # load word list contents
     def load_words
-      File.readlines("#{WORD_DIR}/#{word_list}.txt").map(&:strip)
+      File.readlines("#{WORD_DIR}/#{word_list}.txt", encoding: Encoding::UTF_8).map { |w| normalize(w.strip) }
+    end
+
+    # BIP-39 requires that mnemonic sentences and passphrases are normalized using NFKD.
+    def normalize(str)
+      str.unicode_normalize(:nfkd)
     end
   end
 end