sibit 0.32.1 → 0.32.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c756b3d04936258f2bfa46b7a385fbb3f5f9ca696728dc2895504b1f5691e65c
-  data.tar.gz: 3d88e0ab75c369c989dfaf360a4b332ac0d5e7479f8e9657734d710e58b712ee
+  metadata.gz: 196fa93e65ec890ca33a83d3d56358f311d57933e20432e61b5e3df32ae8515d
+  data.tar.gz: 0d02c5a2f773d84dbd13c614c6e52533e88a88dff5c07e4ff304650311ce5a22
 SHA512:
-  metadata.gz: 4c385350b69515c9a92a32901afd99685dca40cfc38f85be613e7527421b29481a838eceb6cc21ec1bdce70deee2b8d295806118c8039f7bb78a3fd80547ac70
-  data.tar.gz: acba7a669a53cbb92918751723e9d09a690b1f4e927f275d97633d9e538317bd4c00a355326ee0aa0fbd11a873a41fdf721570f32d73d56ef40fdc489d132b10
+  metadata.gz: b62032df000f92c6e58147224c5055c3db2ac1798308022899b0e5a5706b691deb9b948733514bcbbac80e70b2ea9f31e085a1da9557a37fd60076240face315
+  data.tar.gz: 21601d77cf209b9980caef8567321f018efe4442eec5caa96f2e791865519c7499d3f7c64111c01823e90ffeb2ed808608fc7e3387c3fda47d3056612a13449c

data/bin/sibit

@@ -7,11 +7,9 @@
 $stdout.sync = true
 
 require 'backtrace'
-require 'ellipsized'
 require 'loog'
-require 'retriable_proxy'
-require 'thor'
 require_relative '../lib/sibit'
+require_relative '../lib/sibit/bin'
 require_relative '../lib/sibit/http'
 require_relative '../lib/sibit/httpproxy'
 require_relative '../lib/sibit/bitcoinchain'
@@ -24,140 +22,16 @@ require_relative '../lib/sibit/fake'
 require_relative '../lib/sibit/firstof'
 require_relative '../lib/sibit/version'
 
-VERBOSE = !ARGV.include?('--quiet') &&
-          (ARGV.include?('--verbose') || ENV.fetch('SIBIT_VERBOSE', nil))
-LOG = VERBOSE ? Loog::VERBOSE : Loog::REGULAR
-
-# Command-line interface for Sibit.
-# Provides commands to interact with the Bitcoin network.
-class Bin < Thor
-  class_option :proxy, type: :string, desc: 'HTTPS proxy for all requests, e.g. "localhost:3128"'
-  class_option :attempts, type: :numeric, default: 1,
-                          desc: 'How many times should we try before failing'
-  class_option :dry, type: :boolean, default: false,
-                     desc: "Don't send a real payment, run in a read-only mode"
-  class_option :verbose, type: :boolean, default: false, desc: 'Print all possible debug messages'
-  class_option :quiet, type: :boolean, default: false, desc: 'Print only informative messages'
-  class_option :api, type: :array, default: %w[blockchain btc bitcoinchain blockchair cex],
-                     desc: 'Ordered List of APIs to use, e.g. "blockchain,btc,bitcoinchain"'
-
-  def self.exit_on_failure?
-    true
-  end
-
-  def self.handle_argument_error(command, error, args, _arity)
-    raise error unless args.include?('--help') || args.include?('-h')
-    new.help(command.name)
-  end
-
-  desc 'price', 'Get current price of BTC in USD'
-  def price
-    LOG.info(client.price)
-  end
-
-  desc 'fees', 'Get currently recommended transaction fees'
-  def fees
-    sibit = client
-    fees = sibit.fees
-    text = %i[S M L XL].map do |m|
-      sat = fees[m] * 250
-      usd = sat * sibit.price / 100_000_000
-      "#{m}: #{sat}sat / $#{format('%<usd>.02f', usd: usd)}"
-    end.join("\n")
-    LOG.info(text)
-  end
-
-  desc 'latest', 'Get hash of the latest block'
-  def latest
-    LOG.info(client.latest)
-  end
-
-  desc 'generate', 'Generate a new private key'
-  def generate
-    LOG.info(client.generate)
-  end
-
-  desc 'create KEY', 'Create a public Bitcoin address from the private key'
-  def create(key)
-    LOG.debug("Private key provided: #{key.ellipsized(8).inspect}")
-    LOG.info(client.create(key))
-  end
-
-  desc 'balance ADDRESS', 'Check the balance of the Bitcoin address'
-  def balance(address)
-    LOG.info(client.balance(address))
-  end
-
-  desc 'pay AMOUNT FEE SOURCES TARGET CHANGE',
-       'Send a new Bitcoin transaction (AMOUNT can be "MAX" to use full balance)'
-  option :skip_utxo, type: :array, default: [],
-                     desc: 'List of UTXO that must be skipped while paying'
-  option :yes, type: :boolean, default: false,
-               desc: 'Skip confirmation prompt and send the payment immediately'
-  def pay(amount, fee, sources, target, change)
-    keys = sources.split(',')
-    if amount.upcase == 'MAX'
-      addrs = keys.map { |k| Sibit::Key.new(k).bech32 }
-      amount = addrs.sum { |a| client.balance(a) }
-    end
-    amount = amount.to_i if amount.is_a?(String) && /^[0-9]+$/.match?(amount)
-    fee = fee.to_i if /^[0-9]+$/.match?(fee)
-    args = [amount, fee, keys, target, change]
-    kwargs = { skip_utxo: options[:skip_utxo] }
-    unless options[:yes] || options[:dry]
-      client(dry: true).pay(*args, **kwargs)
-      print 'Do you confirm this payment? (yes/no): '
-      answer = $stdin.gets&.strip&.downcase
-      raise Sibit::Error, 'Payment cancelled by user' unless answer == 'yes'
-    end
-    LOG.info(client.pay(*args, **kwargs))
-  end
-
-  desc 'version', 'Print program version'
-  def version
-    LOG.info(Sibit::VERSION)
-  end
-
-  private
-
-  def client(dry: false)
-    proxy = options[:proxy] || ENV.fetch('SIBIT_PROXY', nil)
-    http = proxy ? Sibit::HttpProxy.new(proxy) : Sibit::Http.new
-    LOG.debug("Using proxy at #{http.host}") if proxy
-    apis = options[:api].flat_map { |a| a.split(',') }.map(&:downcase).map do |a|
-      case a
-      when 'blockchain'
-        Sibit::Blockchain.new(http: http, log: LOG)
-      when 'btc'
-        Sibit::Btc.new(http: http, log: LOG)
-      when 'bitcoinchain'
-        Sibit::Bitcoinchain.new(http: http, log: LOG)
-      when 'blockchair'
-        Sibit::Blockchair.new(http: http, log: LOG)
-      when 'cex'
-        Sibit::Cex.new(http: http, log: LOG)
-      when 'fake'
-        Sibit::Fake.new
-      else
-        raise Sibit::Error, "Unknown API \"#{a}\""
-      end
-    end
-    api = Sibit::FirstOf.new(apis, log: LOG, verbose: true)
-    api = Sibit::Dry.new(api, log: LOG) if options[:dry] || dry
-    api = RetriableProxy.for_object(api, on: Sibit::Error) if options[:attempts] > 1
-    Sibit.new(log: LOG, api: api)
-  end
-end
-
-if __FILE__ == $PROGRAM_NAME
-  begin
-    Bin.start(ARGV)
-  rescue StandardError => e
-    if VERBOSE
-      LOG.error(Backtrace.new(e))
-    else
-      LOG.error(e.message)
-    end
-    exit(255)
-  end
+begin
+  Sibit::Bin.start(ARGV)
+rescue StandardError => e
+  verbose = !ARGV.include?('--quiet') &&
+            (ARGV.include?('--verbose') || ENV.fetch('SIBIT_VERBOSE', nil))
+  log = verbose ? Loog::VERBOSE : Loog::REGULAR
+  if verbose
+    log.error(Backtrace.new(e))
+  else
+    log.error(e.message)
+  end
+  exit(255)
 end

data/lib/sibit/bin.rb

@@ -0,0 +1,154 @@
+# frozen_string_literal: true
+
+# SPDX-FileCopyrightText: Copyright (c) 2019-2026 Yegor Bugayenko
+# SPDX-License-Identifier: MIT
+
+require 'ellipsized'
+require 'retriable_proxy'
+require 'thor'
+
+# Sibit main class.
+# Author:: Yegor Bugayenko (yegor256@gmail.com)
+# Copyright:: Copyright (c) 2019-2026 Yegor Bugayenko
+# License:: MIT
+class Sibit
+  # Command-line interface for Sibit.
+  #
+  # Provides commands to interact with the Bitcoin network.
+  #
+  # Example:
+  #   Sibit::Bin.start(['price'])
+  #   Sibit::Bin.start(['balance', '1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa'])
+  class Bin < Thor
+    class_option :proxy, type: :string, desc: 'HTTPS proxy for all requests, e.g. "localhost:3128"'
+    class_option :attempts, type: :numeric, default: 1,
+      desc: 'How many times should we try before failing'
+    class_option :dry, type: :boolean, default: false,
+      desc: "Don't send a real payment, run in a read-only mode"
+    class_option :verbose, type: :boolean, default: false, desc: 'Print all possible debug messages'
+    class_option :quiet, type: :boolean, default: false, desc: 'Print only informative messages'
+    class_option :api, type: :array, default: %w[blockchain btc bitcoinchain blockchair cex],
+      desc: 'Ordered List of APIs to use, e.g. "blockchain,btc,bitcoinchain"'
+
+    def self.exit_on_failure?
+      true
+    end
+
+    def self.handle_argument_error(command, error, args, _arity)
+      raise error unless args.include?('--help') || args.include?('-h')
+      new.help(command.name)
+    end
+
+    desc 'price', 'Get current price of BTC in USD'
+    def price
+      log.info(client.price)
+    end
+
+    desc 'fees', 'Get currently recommended transaction fees'
+    def fees
+      sibit = client
+      fees = sibit.fees
+      text = %i[S M L XL].map do |m|
+        sat = fees[m] * 250
+        usd = sat * sibit.price / 100_000_000
+        "#{m}: #{sat}sat / $#{format('%<usd>.02f', usd: usd)}"
+      end.join("\n")
+      log.info(text)
+    end
+
+    desc 'latest', 'Get hash of the latest block'
+    def latest
+      log.info(client.latest)
+    end
+
+    desc 'generate', 'Generate a new private key'
+    def generate
+      log.info(client.generate)
+    end
+
+    desc 'create KEY', 'Create a public Bitcoin address from the private key'
+    def create(key)
+      log.debug("Private key provided: #{key.ellipsized(8).inspect}")
+      log.info(client.create(key))
+    end
+
+    desc 'balance ADDRESS', 'Check the balance of the Bitcoin address'
+    def balance(address)
+      log.info(client.balance(address))
+    end
+
+    desc \
+      'pay AMOUNT FEE SOURCES TARGET CHANGE',
+      'Send a new Bitcoin transaction (AMOUNT can be "MAX" to use full balance)'
+    option :skip_utxo, type: :array, default: [],
+      desc: 'List of UTXO that must be skipped while paying'
+    option :base58, type: :boolean, default: false,
+      desc: 'Convert private addresses to public in base58'
+    option :yes, type: :boolean, default: false,
+      desc: 'Skip confirmation prompt and send the payment immediately'
+    def pay(amount, fee, sources, target, change)
+      keys = sources.split(',')
+      if amount.upcase == 'MAX'
+        addrs = keys.map do |k|
+          kk = Sibit::Key.new(k)
+          options[:base58] ? kk.base58 : kk.bech32
+        end
+        amount = addrs.sum { |a| client.balance(a) }
+      end
+      amount = amount.to_i if amount.is_a?(String) && /^[0-9]+$/.match?(amount)
+      fee = fee.to_i if /^[0-9]+$/.match?(fee)
+      args = [amount, fee, keys, target, change]
+      kwargs = { skip_utxo: options[:skip_utxo], base58: options[:base58] }
+      unless options[:yes] || options[:dry]
+        client(dry: true).pay(*args, **kwargs)
+        print 'Do you confirm this payment? (yes/no): '
+        answer = $stdin.gets&.strip&.downcase
+        raise Sibit::Error, 'Payment cancelled by user' unless answer == 'yes'
+      end
+      log.info(client.pay(*args, **kwargs))
+    end
+
+    desc 'version', 'Print program version'
+    def version
+      log.info(Sibit::VERSION)
+    end
+
+    private
+
+    def log
+      @log ||= begin
+        verbose = !ARGV.include?('--quiet') &&
+                  (ARGV.include?('--verbose') || ENV.fetch('SIBIT_VERBOSE', nil))
+        verbose ? Loog::VERBOSE : Loog::REGULAR
+      end
+    end
+
+    def client(dry: false)
+      proxy = options[:proxy] || ENV.fetch('SIBIT_PROXY', nil)
+      http = proxy ? Sibit::HttpProxy.new(proxy) : Sibit::Http.new
+      log.debug("Using proxy at #{http.host}") if proxy
+      apis = options[:api].flat_map { |a| a.split(',') }.map(&:downcase).map do |a|
+        case a
+        when 'blockchain'
+          Sibit::Blockchain.new(http: http, log: log)
+        when 'btc'
+          Sibit::Btc.new(http: http, log: log)
+        when 'bitcoinchain'
+          Sibit::Bitcoinchain.new(http: http, log: log)
+        when 'blockchair'
+          Sibit::Blockchair.new(http: http, log: log)
+        when 'cex'
+          Sibit::Cex.new(http: http, log: log)
+        when 'fake'
+          Sibit::Fake.new
+        else
+          raise Sibit::Error, "Unknown API \"#{a}\""
+        end
+      end
+      api = Sibit::FirstOf.new(apis, log: log, verbose: true)
+      api = Sibit::Dry.new(api, log: log) if options[:dry] || dry
+      api = RetriableProxy.for_object(api, on: Sibit::Error) if options[:attempts] > 1
+      Sibit.new(log: log, api: api)
+    end
+  end
+end

data/lib/sibit/version.rb

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

data/lib/sibit.rb

@@ -103,18 +103,26 @@ class Sibit
   # +target+: the target address to send to
   # +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)
+  def pay(amount, fee, sources, target, change, skip_utxo: [], network: nil, base58: false)
     p = price('USD')
     keys = sources.map { |k| Key.new(k, network: network) }
     network = keys.first&.network || :mainnet
-    sources = keys.to_h { |k| [k.bech32, k.priv] }
+    sources = keys.to_h do |k|
+      pub =
+        if base58
+          k.base58
+        else
+          k.bech32
+        end
+      @log.debug("Private key #{k.priv.ellipsized(8).inspect} is public as #{pub}:")
+      [pub, k.priv]
+    end
     satoshi = satoshi(amount)
     builder = TxBuilder.new
     unspent = 0
     size = 100
     utxos = @api.utxos(sources.keys)
-    @log.debug("#{utxos.count} UTXOs found, these will be used \
-(value/confirmations at tx_hash):")
+    @log.debug("#{utxos.count} UTXOs found, these will be used (value/confirmations at tx_hash):")
     utxos.each do |utxo|
       if skip_utxo.include?(utxo[:hash])
         @log.debug("UTXO skipped: #{utxo[:hash]}")
@@ -224,8 +232,10 @@ class Sibit
         checked += 1
       end
       count += 1
-      @log.debug("We checked #{checked} txns and #{checked_outputs} outputs \
-in block #{block} (by #{json[:provider]})")
+      @log.debug(
+        "Checked #{checked} txns and #{checked_outputs} outputs " \
+        "in block #{block} (by #{json[:provider]})"
+      )
       block = json[:next]
       begin
         if block.nil?

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sibit
 version: !ruby/object:Gem::Version
-  version: 0.32.1
+  version: 0.32.3
 platform: ruby
 authors:
 - Yegor Bugayenko
@@ -178,6 +178,7 @@ files:
 - lib/sibit/base58.rb
 - lib/sibit/bech32.rb
 - lib/sibit/bestof.rb
+- lib/sibit/bin.rb
 - lib/sibit/bitcoinchain.rb
 - lib/sibit/blockchain.rb
 - lib/sibit/blockchair.rb