sibit 0.32.6 → 0.32.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9fd0f078031f164079de39c2fd14dcd8ac8675861ff74bec96fac105525110cd
-  data.tar.gz: 7f77f659da2b18be975c7587915f5aa875a21e55237d06582cdac36c8ccda6f8
+  metadata.gz: 8dbaecce413d6a977eee8d4d440a066a666f2054ad7d2b4cec0b21c6da4efe8e
+  data.tar.gz: 39431e80439522e9d000404ee29856f558ba3b4406976e9345e550f4efbf3974
 SHA512:
-  metadata.gz: 072721e3965d7e0719332cdf970f32be79d2b266c5807bad9c56d00a8e2fbd5ba4ca7817c876d093e57873dd6393486e9c3d2052147315dd64ff0b1a565c7f6f
-  data.tar.gz: bd3727fef02c55442ed256fa836baf422fe9352f58eff4b755f2f87da45a7bf0fd3ba424d54e29da3c9a9f1d8fcd4e6cc913dd4f557de52374ee9ffa29842256
+  metadata.gz: dc62197de1ada4a3e155148fa09926ffd02861178f1049203b1212a363b60d01d11fe3881f3e61d86a57b666464084d511aec4b4664e8fd038904468b9fb315f
+  data.tar.gz: f1ec0c729a1ccca0b2b9728ea23348db8cb5e5d80b22ec06dc33a682fb04a76c47cd0b487d578d8b19d2e62dfb7ac3c4f638aac03a9f8fa7a4c791f882e10259

data/Gemfile.lock

@@ -102,7 +102,7 @@ GEM
     parser (3.3.10.0)
       ast (~> 2.4.1)
       racc
-    prism (1.7.0)
+    prism (1.8.0)
     psych (5.3.1)
       date
       stringio
@@ -115,7 +115,7 @@ GEM
     racc (1.8.1)
     rainbow (3.1.1)
     rake (13.3.1)
-    rdoc (7.0.3)
+    rdoc (7.1.0)
       erb
       psych (>= 4.0.0)
       tsort

data/features/cli.feature

@@ -33,7 +33,7 @@ Feature: Command Line Processing
     Then Exit code is zero
 
   Scenario: Bitcoin balance can be checked
-    When I run bin/sibit with "balance 1MZT1fa6y8H9UmbZV6HqKF4UY41o9MGT5f --verbose --api=blockchain,btc"
+    When I run bin/sibit with "balance 1MZT1fa6y8H9UmbZV6HqKF4UY41o9MGT5f --verbose"
     Then Exit code is zero
 
   Scenario: Bitcoin fees can be printed

data/features/dry.feature

@@ -3,22 +3,6 @@
 Feature: Command Line Processing
   As a holder of BTC I want to use sibit in dry mode
 
-  Scenario: Bitcoin price can be retrieved
-    When I run bin/sibit with "price --dry --attempts=4"
-    Then Exit code is zero
-
-  Scenario: Bitcoin latest block hash can be retrieved
-    When I run bin/sibit with "latest --dry --api=blockchain"
-    Then Exit code is zero
-
-  Scenario: Bitcoin balance can be checked
-    When I run bin/sibit with "balance --dry 1MZT1fa6y8H9UmbZV6HqKF4UY41o9MGT5f --verbose --api=blockchain,btc"
-    Then Exit code is zero
-
-  Scenario: Bitcoin fees can be printed
-    When I run bin/sibit with "fees --dry --verbose --api=fake"
-    Then Exit code is zero
-
   Scenario: Bitcoin payment can be sent
     When I run bin/sibit with "pay --dry --verbose --api=fake --proxy=localhost:3128 999999 XL- 46feba063e9b59a8ae0dba68abd39a3cb8f52089e776576d6eb1bb5bfec123d1 1MZT1fa6y8H9UmbZV6HqKF4UY41o9MGT5f 1Fsyq5YGe8zbSjLS8YsDnZWM8U6AYMR6ZD"
     Then Exit code is not zero

data/features/fake.feature

@@ -0,0 +1,25 @@
+# SPDX-FileCopyrightText: Copyright (c) 2019-2026 Yegor Bugayenko
+# SPDX-License-Identifier: MIT
+Feature: Command Line Processing
+  As a holder of BTC I want to use sibit with fake provider
+
+  Scenario: Bitcoin price can be retrieved
+    When I run bin/sibit with "price --attempts=4 --api=fake"
+    Then Exit code is zero
+
+  Scenario: Bitcoin latest block hash can be retrieved
+    When I run bin/sibit with "latest --api=fake"
+    Then Exit code is zero
+
+  Scenario: Bitcoin balance can be checked
+    When I run bin/sibit with "balance 1MZT1fa6y8H9UmbZV6HqKF4UY41o9MGT5f --verbose --api=fake"
+    Then Exit code is zero
+
+  Scenario: Bitcoin fees can be printed
+    When I run bin/sibit with "fees --verbose --api=fake"
+    Then Exit code is zero
+
+  Scenario: Bitcoin payment can be sent
+    When I run bin/sibit with "pay --verbose --api=fake --proxy=localhost:3128 999999 XL- 46feba063e9b59a8ae0dba68abd39a3cb8f52089e776576d6eb1bb5bfec123d1 1MZT1fa6y8H9UmbZV6HqKF4UY41o9MGT5f 1Fsyq5YGe8zbSjLS8YsDnZWM8U6AYMR6ZD"
+    Then Exit code is not zero
+    Then Stdout contains "UTXO arrived to 1JvCsJtLmCxEk7ddZFnVkGXpr9uhxZPmJi is incorrect"

data/lib/sibit/key.rb

@@ -7,6 +7,7 @@ require 'digest'
 require 'openssl'
 require_relative 'base58'
 require_relative 'bech32'
+require_relative 'error'
 
 # Sibit main class.
 class Sibit
@@ -61,24 +62,36 @@ class Sibit
     def bech32
       hrp = { mainnet: 'bc', testnet: 'tb', regtest: 'bcrt' }[@network]
       hex = pub
-      raise 'Invalid public key: not on curve' unless @key.public_key.on_curve?
-      raise 'Invalid public key format' unless hex.match?(/\A0[23][0-9a-f]{64}\z/)
-      Bech32.encode(hrp, 0, hash160(hex))
+      raise Error, 'Invalid public key: not on curve' unless @key.public_key.on_curve?
+      raise Error, 'Invalid public key format' unless hex.match?(/\A0[23][0-9a-f]{64}\z/)
+      addr = Bech32.encode(hrp, 0, hash160(hex))
+      expected = /\A#{hrp}1q[a-z0-9]{38,58}\z/
+      raise Error, "Invalid bech32 address: #{addr}" unless addr.match?(expected)
+      addr
     end
 
     def base58
       hex = pub
-      raise 'Invalid public key: not on curve' unless @key.public_key.on_curve?
-      raise 'Invalid public key format' unless hex.match?(/\A0[23][0-9a-f]{64}\z/)
+      raise Error, 'Invalid public key: not on curve' unless @key.public_key.on_curve?
+      raise Error, 'Invalid public key format' unless hex.match?(/\A0[23][0-9a-f]{64}\z/)
       hash = hash160(hex)
       prefix = @network == :mainnet ? '00' : '6f'
       versioned = "#{prefix}#{hash}"
       checksum = Base58.new(versioned).check
-      Base58.new(versioned + checksum).encode
+      addr = Base58.new(versioned + checksum).encode
+      mainnet = /\A1[1-9A-HJ-NP-Za-km-z]{25,34}\z/
+      testnet = /\A[mn][1-9A-HJ-NP-Za-km-z]{25,34}\z/
+      unless addr.match?(@network == :mainnet ? mainnet : testnet)
+        raise Error,
+              "Invalid base58 address: #{addr}"
+      end
+      addr
     end
 
     def sign(data)
-      @key.dsa_sign_asn1(data)
+      sig = @key.dsa_sign_asn1(data)
+      raise Error, 'Signature verification failed' unless verify(data, sig)
+      sig
     end
 
     def verify(data, sig)
@@ -91,7 +104,7 @@ class Sibit
 
     def build(privkey)
       value = privkey.to_i(16)
-      raise 'private key is not on curve' unless value.between?(MIN_PRIV, MAX_PRIV)
+      raise Error, 'Private key is not on curve' unless value.between?(MIN_PRIV, MAX_PRIV)
       group = OpenSSL::PKey::EC::Group.new('secp256k1')
       bn = OpenSSL::BN.new(privkey, 16)
       pubkey = group.generator.mul(bn)
@@ -114,10 +127,15 @@ class Sibit
     def decode(key)
       if key.length == 64 && key.match?(/\A[0-9a-f]+\z/i)
         @network = @override || :mainnet
-        return key
+        return key.downcase
       end
       raw = Base58.new(key).decode
+      payload = raw[0..-9]
+      checksum = raw[-8..]
+      expected = Base58.new(payload).check
+      raise Error, 'Invalid WIF checksum' unless checksum == expected
       version = raw[0, 2]
+      raise Error, "Invalid WIF version: #{version}" unless %w[80 ef].include?(version)
       detected = version == '80' ? :mainnet : :testnet
       @network = @override || detected
       body = raw[2..-9]

data/lib/sibit/version.rb

@@ -9,5 +9,5 @@
 # License:: MIT
 class Sibit
   # Current version of the library.
-  VERSION = '0.32.6' unless defined?(VERSION)
+  VERSION = '0.32.8' unless defined?(VERSION)
 end

data/lib/sibit.rb

@@ -53,13 +53,13 @@ class Sibit
   # Generates new Bitcoin private key and returns in Hash160 format.
   def generate
     key = Key.generate.priv
-    @log.debug("Bitcoin private key generated: #{key[0..8]}...")
+    @log.debug("Bitcoin private key generated: #{key.ellipsized(8)}...")
     key
   end
 
   # Creates Bitcoin address using the private key in Hash160 format.
   def create(pvt)
-    raise Error, 'Invalid private key (must be 64 chars)' unless /^[0-9a-f]{64}$/.match?(pvt)
+    raise Error, 'Invalid private key (must be 64 hex chars)' unless /^[0-9a-f]{64}$/.match?(pvt)
     Key.new(pvt).bech32
   end
 
@@ -105,8 +105,21 @@ class Sibit
   # +change+: the address where the change has to be sent to
   # +network+: optional network override (:mainnet, :testnet, :regtest)
   def pay(amount, fee, sources, target, change, skip_utxo: [], network: nil, base58: false)
+    unless amount.is_a?(Integer) || amount.is_a?(String)
+      raise Error, "The amount #{amount.inspect} must be Integer or String"
+    end
+    raise Error, 'The amount must be positive' if amount.is_a?(Integer) && amount.negative?
+    raise Error, 'The sources must be an Array' unless sources.is_a?(Array)
+    raise Error, 'The target must be a String' unless target.is_a?(String)
+    raise Error, 'The change must be a String' unless change.is_a?(String)
     p = price('USD')
-    keys = sources.map { |k| Key.new(k, network: network) }
+    keys = sources.map do |k|
+      raise Error, 'Each source private key must be a String' unless k.is_a?(String)
+      hex = /^[0-9a-f]{64}$/i.match?(k)
+      wif = /^[5KLc][1-9A-HJ-NP-Za-km-z]{50,51}$/.match?(k)
+      raise Error, "Invalid private key format: #{k.inspect.ellipsized(8)}" unless hex || wif
+      Key.new(k, network: network)
+    end
     network = keys.first&.network || :mainnet
     sources = keys.to_h do |k|
       pub =
@@ -168,19 +181,28 @@ class Sibit
       change_address: change
     )
     left = unspent - tx.outputs.sum(&:value)
-    @log.debug("A new Bitcoin transaction #{tx.hash} prepared:
-  #{tx.in.count} input#{'s' if tx.in.count > 1}:
-    #{tx.inputs.map { |i| " in: #{i.prev_out.unpack1('H*')}:#{i.prev_out_index}" }.join("\n    ")}
-  #{tx.out.count} output#{'s' if tx.out.count > 1}:
-    #{tx.outputs.map { |o| "out: #{o.script_hex} / #{num(o.value, p)}" }.join("\n    ")}
-  Min fee: #{num(MIN_SATOSHI_PER_BYTE, p)} /byte
-  Fee requested: #{num(f, p)} as \"#{fee}\"
-  Fee actually paid: #{num(left, p)}
-  Tx size: #{size} bytes
-  Unspent: #{num(unspent, p)}
-  Amount: #{num(satoshi, p)}
-  Target address: #{target}
-  Change address is #{change}")
+    has_change = tx.out.count > 1
+    @log.debug(
+      [
+        "A new Bitcoin transaction #{tx.hash} prepared:",
+        "#{tx.in.count} input#{'s' if tx.in.count > 1}:",
+        tx.inputs.map do |i|
+          "  in: #{i.prev_out.unpack1('H*')}:#{i.prev_out_index}"
+        end,
+        "#{tx.out.count} output#{'s' if tx.out.count > 1}:",
+        tx.outputs.map do |o|
+          "  out: #{o.script_hex} / #{num(o.value, p)}"
+        end,
+        "Min fee: #{num(MIN_SATOSHI_PER_BYTE, p)} /byte",
+        "Fee requested: #{num(f, p)} as \"#{fee}\"",
+        "Fee actually paid: #{num(left, p)}",
+        "Tx size: #{size} bytes",
+        "Unspent: #{num(unspent, p)}",
+        "Amount: #{num(satoshi, p)}",
+        "Target address: #{target}",
+        ("Change address: #{change}" if has_change)
+      ].flatten.compact.join("\n")
+    )
     @api.push(tx.to_payload.bth)
     tx.hash
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sibit
 version: !ruby/object:Gem::Version
-  version: 0.32.6
+  version: 0.32.8
 platform: ruby
 authors:
 - Yegor Bugayenko
@@ -171,6 +171,7 @@ files:
 - cucumber.yml
 - features/cli.feature
 - features/dry.feature
+- features/fake.feature
 - features/gem_package.feature
 - features/step_definitions/steps.rb
 - features/support/env.rb