sibit 0.30.7 → 0.32.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3c1f18b76d75fe20bb741ac3c033bde8df69a6f54bb31e0b26f03e900d04f635
-  data.tar.gz: ae570fa1bf67e683ac1c3a6f7754c225d6a6eea3e2376d2d2d96fc18a39504bf
+  metadata.gz: ccc8435725361e992237efffbe4f53e4f6698e8217cbac39ce0f08f8b407cb68
+  data.tar.gz: 8a787c829a4539a6b69be2764ef90b09e61b13797375b382e6a4df69826165cf
 SHA512:
-  metadata.gz: 60685974e155e059ccc11607b731b32e27df7cec9b51db25701a174c3dee9ac1a22890e922d9b61727bd886b480f01819848b35869b18f2fc96e9fd045d2074e
-  data.tar.gz: 773589a2fd128215dd2d16ddcd3ad0a89c983367dbd5c224afd90f4f1894cd37d07ee255406ce8372f0ac05327fe7d3efc44e8bf5db1c696c41781d4ea1a53df
+  metadata.gz: 253013c5f6b978ea0db8ea3c2800aad241e2d277fbd743f21130dff952610b37fc27366ec8e67728dba64a97efbe1750c1dd7455faf991e856e8af5d06f52e88
+  data.tar.gz: ce524cedb5ae7420113a0d9f6526792f9c47dee863724e64adf7909b94aca0ede25cee286f203063ff65166e00c58512b6310f6ced1ee52a28bd7516ab563e9c

data/Gemfile.lock

@@ -11,7 +11,7 @@ PATH
       loog (~> 0.6)
       openssl (~> 3.0)
       retriable_proxy (~> 1.0)
-      slop (~> 4.6)
+      thor (~> 1.3)
 
 GEM
   remote: https://rubygems.org/
@@ -63,7 +63,7 @@ GEM
     decoor (0.1.0)
     diff-lcs (1.6.2)
     docile (1.4.1)
-    donce (0.3.0)
+    donce (0.4.0)
       backtrace (~> 0.3)
       os (~> 1.1)
       qbash (~> 0.3)
@@ -75,7 +75,7 @@ GEM
     ffi (1.17.3-arm64-darwin)
     ffi (1.17.3-x86_64-linux-gnu)
     hashdiff (1.2.1)
-    iri (0.11.4)
+    iri (0.11.6)
     json (2.18.0)
     language_server-protocol (3.17.0.5)
     lint_roller (1.1.0)
@@ -106,8 +106,8 @@ GEM
     psych (5.3.1)
       date
       stringio
-    public_suffix (7.0.0)
-    qbash (0.4.8)
+    public_suffix (7.0.2)
+    qbash (0.5.0)
       backtrace (> 0)
       elapsed (> 0)
       loog (> 0)
@@ -163,13 +163,12 @@ GEM
       simplecov (~> 0.19)
     simplecov-html (0.13.2)
     simplecov_json_formatter (0.1.4)
-    slop (4.10.1)
     stringio (3.2.0)
     sys-uname (1.4.1)
       ffi (~> 1.1)
       memoist3 (~> 1.0.0)
     tago (0.6.0)
-    thor (1.4.0)
+    thor (1.5.0)
     tsort (0.2.0)
     unicode-display_width (3.2.0)
       unicode-emoji (~> 4.1)

data/REUSE.toml

@@ -6,6 +6,7 @@ version = 1
 path = [
     ".DS_Store",
     ".gitattributes",
+    ".gitleaksignore",
     ".gitignore",
     ".pdd",
     "**.json",

data/Rakefile

@@ -33,7 +33,7 @@ end
 desc 'Run them via Ruby, one by one'
 task :picks do
   next if OS.windows?
-  %w[test lib].each do |d|
+  %w[lib].each do |d|
     Dir["#{d}/**/*.rb"].each do |f|
       qbash("bundle exec ruby #{Shellwords.escape(f)}", log: $stdout, env: { 'PICKS' => 'yes' })
     end

data/bin/sibit

@@ -10,7 +10,7 @@ require 'backtrace'
 require 'ellipsized'
 require 'loog'
 require 'retriable_proxy'
-require 'slop'
+require 'thor'
 require_relative '../lib/sibit'
 require_relative '../lib/sibit/http'
 require_relative '../lib/sibit/httpproxy'
@@ -24,79 +24,38 @@ require_relative '../lib/sibit/fake'
 require_relative '../lib/sibit/firstof'
 require_relative '../lib/sibit/version'
 
-log = Loog::REGULAR
+VERBOSE = ARGV.include?('--verbose') || ENV.fetch('SIBIT_VERBOSE', nil)
+LOG = VERBOSE ? Loog::VERBOSE : Loog::REGULAR
 
-opts =
-  begin
-    Slop.parse(ARGV, strict: true, help: true) do |o|
-      o.banner = "Usage (#{Sibit::VERSION}): sibit [options] command [args]
-Commands are:
-  price:    Get current price of BTC in USD
-  fees:     Get currently recommended transaction fees
-  latest:   Get hash of the latest block
-  generate: Generate a new private key
-  create:   Create a public Bitcoin address from the key
-  balance:  Check the balance of the Bitcoin address
-  pay:      Send a new Bitcoin transaction
-Options are:"
-      o.string '--proxy', 'HTTPS proxy for all requests, e.g. "localhost:3128"'
-      o.integer(
-        '--attempts',
-        'How many times should we try before failing',
-        default: 1
-      )
-      o.bool '--dry', 'Don\'t send a real payment, run in a read-only mode'
-      o.bool '--help', 'Read this: https://github.com/yegor256/sibit' do
-        log.info(o)
-        exit
-      end
-      o.bool '--verbose', 'Print all possible debug messages'
-      o.array(
-        '--api',
-        'Ordered List of APIs to use, e.g. "eblockchain,btc,bitcoinchain"',
-        default: %w[blockchain btc bitcoinchain blockchair cex]
-      )
-      o.array(
-        '--skip-utxo',
-        'List of UTXTO that must be skipped while paying',
-        default: []
-      )
-    end
-  rescue Slop::Error => e
-    raise e.message
+# 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 :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
 
-raise 'Try --help' if opts.arguments.empty?
-
-begin
-  log = Loog::VERBOSE if opts[:verbose]
-  http = opts[:proxy] ? Sibit::HttpProxy.new(opts[:proxy]) : Sibit::Http.new
-  apis = opts[:api].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
+  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
-  api = Sibit::FirstOf.new(apis, log: log, verbose: true)
-  api = Sibit::Dry.new(api, log: log) if opts[:dry]
-  api = RetriableProxy.for_object(api, on: Sibit::Error) if opts[:attempts] > 1
-  sibit = Sibit.new(log: log, api: api)
-  case opts.arguments[0]
-  when 'price'
-    log.info(sibit.price)
-  when 'fees'
+
+  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
@@ -104,48 +63,103 @@ begin
       "#{m}: #{sat}sat / $#{format('%<usd>.02f', usd: usd)}"
     end.join("\n")
     log.info(text)
-  when 'latest'
-    log.info(sibit.latest)
-  when 'generate'
-    log.info(sibit.generate)
-  when 'create'
-    pvt = opts.arguments[1]
-    raise 'Private key argument is required' if pvt.nil?
-    log.debug("Private key provided: #{pvt.ellipsized(8).inspect}")
-    log.info(sibit.create(pvt))
-  when 'balance'
-    address = opts.arguments[1]
-    raise 'Address argument is required' if address.nil?
-    log.info(sibit.balance(address))
-  when 'pay'
-    amount = opts.arguments[1]
-    raise 'Amount argument is required' if amount.nil?
-    amount = amount.to_i if /^[0-9]+$/.match?(amount)
-    fee = opts.arguments[2]
-    raise 'Miners fee argument is required' if fee.nil?
+  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)
-    sources = opts.arguments[3]
-    raise 'Addresses argument is required' if sources.nil?
-    target = opts.arguments[4]
-    raise 'Target argument is required' if target.nil?
-    change = opts.arguments[5]
-    raise 'Change argument is required' if change.nil?
-    log.info(
-      sibit.pay(
-        amount, fee,
-        sources.split(','),
-        target, change,
-        skip_utxo: opts['skip-utxo']
-      )
-    )
-  else
-    raise "Command #{opts.arguments[0]} is not supported"
+    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
-rescue StandardError => e
-  if opts[:verbose]
-    log.error(Backtrace.new(e))
-  else
-    log.error(e.message)
+
+  private
+
+  def log
+    LOG
+  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
+
+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
-  exit(255)
 end

data/features/cli.feature

@@ -6,7 +6,7 @@ Feature: Command Line Processing
   Scenario: Help can be printed
     When I run bin/sibit with "--help"
     Then Exit code is zero
-    And Stdout contains "--help"
+    And Stdout contains "Commands:"
 
   Scenario: Bitcoin price can be retrieved
     When I run bin/sibit with "price --attempts=4"
@@ -31,3 +31,8 @@ Feature: Command Line Processing
   Scenario: Bitcoin fees can be printed
     When I run bin/sibit with "fees --verbose --api=fake"
     Then Exit code is zero
+
+  Scenario: Pay help shows all options
+    When I run bin/sibit with "pay --help"
+    Then Exit code is zero
+    And Stdout contains "--skip-utxo"

data/features/step_definitions/steps.rb

@@ -5,7 +5,6 @@
 
 require 'nokogiri'
 require 'tmpdir'
-require 'slop'
 require 'English'
 require_relative '../../lib/sibit'
 
@@ -14,10 +13,6 @@ Before do
   @dir = Dir.mktmpdir('test')
   FileUtils.mkdir_p(@dir)
   Dir.chdir(@dir)
-  @opts = Slop.parse ['-v', '-s', @dir] do |o|
-    o.bool '-v', '--verbose'
-    o.string '-s', '--source'
-  end
 end
 
 After do

data/lib/sibit/httpproxy.rb

@@ -19,6 +19,8 @@ class Sibit
       @user, @password, @host, @port = parse(addr)
     end
 
+    attr_reader :host
+
     def client(uri)
       http = Net::HTTP.new(uri.host, uri.port, @host, @port.to_i, @user, @password)
       http.use_ssl = true

data/lib/sibit/version.rb

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

data/sibit.gemspec

@@ -38,5 +38,5 @@ Gem::Specification.new do |s|
   s.add_dependency 'loog', '~> 0.6'
   s.add_dependency 'openssl', '~> 3.0'
   s.add_dependency 'retriable_proxy', '~> 1.0'
-  s.add_dependency 'slop', '~> 4.6'
+  s.add_dependency 'thor', '~> 1.3'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sibit
 version: !ruby/object:Gem::Version
-  version: 0.30.7
+  version: 0.32.0
 platform: ruby
 authors:
 - Yegor Bugayenko
@@ -136,19 +136,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: slop
+  name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.6'
+        version: '1.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.6'
+        version: '1.3'
 description: This is a simple Bitcoin client, to use from command line or from your
   Ruby app. You don't need to run any Bitcoin software, no need to install anything,
   etc. All you need is just a command line and Ruby 2.5+.