sibit 0.33.0 → 0.34.1

data/lib/sibit/bestof.rb

@@ -66,11 +66,26 @@ class Sibit::BestOf
     best_of('latest', &:latest)
   end
 
-  # Push this transaction (in hex format) to the network.
+  # Push this transaction (in hex format) to the network. This one does
+  # not vote: pushing is a side effect, so it hands the transaction to
+  # each API in turn and stops at the first that accepts it.
   def push(hex)
-    best_of('push') do |api|
-      api.push(hex)
+    return @list.push(hex) unless @list.is_a?(Array)
+    errors = []
+    @list.each do |api|
+      return api.push(hex)
+    rescue Sibit::NotSupportedError
+      nil
+    rescue Sibit::Error => e
+      errors << e
+      @log.debug("The API #{api.class.name} failed at push(): #{e.message}") if @verbose
     end
+    errors.each { |e| @log.debug(Backtrace.new(e).to_s) }
+    raise(
+      Sibit::Error,
+      "No APIs out of #{@list.length} managed to succeed at push(): " \
+      "#{@list.map { |a| a.class.name }.join(', ')}"
+    )
   end
 
   # This method should fetch a block and return as a hash.
@@ -83,22 +98,37 @@ class Sibit::BestOf
   private
 
   def best_of(method)
-    return yield @list unless @list.is_a?(Array)
-    results = []
+    return yield(@list) unless @list.is_a?(Array)
+    votes = []
     errors = []
     @list.each do |api|
-      results << yield(api)
+      votes << [api.class.name, yield(api)]
     rescue Sibit::NotSupportedError
-      # Just ignore it
+      nil
     rescue Sibit::Error => e
       errors << e
       @log.debug("The API #{api.class.name} failed at #{method}(): #{e.message}") if @verbose
     end
-    if results.empty?
+    if votes.empty?
       errors.each { |e| @log.debug(Backtrace.new(e).to_s) }
-      raise Sibit::Error, "No APIs out of #{@list.length} managed to succeed at #{method}(): \
-#{@list.map { |a| a.class.name }.join(', ')}"
+      raise(
+        Sibit::Error,
+        "No APIs out of #{@list.length} managed to succeed at #{method}(): " \
+        "#{@list.map { |a| a.class.name }.join(', ')}"
+      )
+    end
+    majority(method, votes)
+  end
+
+  def majority(method, votes)
+    winner = votes.group_by { |v| v[1].to_s }.values.max_by(&:size)
+    if winner.size <= votes.size / 2
+      raise(
+        Sibit::Error,
+        "No strict majority among #{votes.size} answers at #{method}(): " \
+        "#{votes.map { |name, answer| "#{name}=#{answer}" }.join(', ')}"
+      )
     end
-    results.group_by(&:to_s).values.max_by(&:size)[0]
+    winner[0][1]
   end
 end

data/lib/sibit/bin.rb

@@ -22,16 +22,13 @@ class Sibit
   class Bin < Thor
     stop_on_unknown_option!
 
-    class_option :proxy, type: :string,
-      desc: 'HTTPS proxy for all requests, e.g. "localhost:3128"'
+    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 :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"'
     class_option :base58, type: :boolean, default: false,
@@ -45,10 +42,10 @@ class Sibit
       return new.help(command.name) if args.include?('--help') || args.include?('-h')
       unknown = args.find { |a| a.start_with?('-') }
       if unknown
-        warn "Unknown option: #{unknown}"
-        exit 1
+        warn("Unknown option: #{unknown}")
+        exit(1)
       end
-      raise error
+      raise(error)
     end
 
     desc 'price', 'Get current price of BTC in USD'
@@ -60,12 +57,12 @@ class Sibit
     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)
+      log.info(
+        %i[S M L XL].map do |m|
+          sat = fees[m] * 250
+          "#{m}: #{sat}sat / $#{format('%<usd>.02f', usd: (sat * sibit.price / 100_000_000))}"
+        end.join("\n")
+      )
     end
 
     desc 'latest', 'Get hash of the latest block'
@@ -86,8 +83,10 @@ class Sibit
     end
 
     desc 'balance ADDRESS', 'Check the balance of the Bitcoin address'
+    option :trust, type: :numeric, default: 0,
+      desc: 'Minimum number of confirmations required for a UTXO to count toward the balance'
     def balance(address)
-      log.info(client.balance(address))
+      log.info(client.balance(address, trust: options[:trust]))
     end
 
     desc \
@@ -97,26 +96,34 @@ class Sibit
       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'
-    option :price, type: :numeric,
-      desc: 'BTC price in USD (skips API price fetch if provided)'
+    option :price, type: :numeric, desc: 'BTC price in USD (skips API price fetch if provided)'
+    option :trust, type: :numeric, default: 0,
+      desc: 'Minimum number of confirmations required on a UTXO before it can be spent'
     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) }
+      sweep = amount.upcase == 'MAX'
+      if sweep
+        addrs =
+          keys.map do |k|
+            kk = Sibit::Key.new(k)
+            options[:base58] ? kk.base58 : kk.bech32
+          end
+        amount = addrs.sum { |a| client.balance(a, trust: options[:trust]) }
       end
-      amount = amount.to_i if amount.is_a?(String) && /^[0-9]+$/.match?(amount)
-      fee = fee.to_i if /^[0-9]+$/.match?(fee)
+      amount = Integer(amount, 10) if amount.is_a?(String) && /^[0-9]+$/.match?(amount)
+      fee = Integer(fee, 10) if /^[0-9]+$/.match?(fee)
+      amount -= fee if sweep && fee.is_a?(Integer)
       args = [amount, fee, keys, target, change]
-      kwargs = { skip_utxo: options[:skip_utxo], base58: options[:base58], price: options[:price] }
+      kwargs = {
+        skip_utxo: options[:skip_utxo], base58: options[:base58],
+        price: options[:price], trust: options[:trust]
+      }
       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'
+        print('Do you confirm this payment? (yes/no): ')
+        unless $stdin.gets&.strip&.downcase == 'yes'
+          raise(Sibit::Error, 'Payment cancelled by user')
+        end
       end
       log.info(client.pay(*args, **kwargs))
     end
@@ -129,36 +136,43 @@ class Sibit
     private
 
     def log
-      @log ||= begin
-        verbose = !options[:quiet] &&
-                  (options[:verbose] || ENV.fetch('SIBIT_VERBOSE', nil))
-        verbose ? Loog::VERBOSE : Loog::REGULAR
-      end
+      return @log if @log
+      @log =
+        if !options[:quiet] && (options[:verbose] || ENV.fetch('SIBIT_VERBOSE', nil))
+          Loog::VERBOSE
+        else
+          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::FirstOf.new(
+        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(key: ENV.fetch('SIBIT_BLOCKCHAIR_KEY', nil), http: http, log: log)
+          when 'cex'
+            Sibit::Cex.new(http: http, log: log)
+          when 'cryptoapis'
+            Sibit::Cryptoapis.new(ENV.fetch('SIBIT_CRYPTOAPIS_KEY', nil), http: http, log: log)
+          when 'sochain'
+            Sibit::Sochain.new(http: http, log: log)
+          when 'fake'
+            Sibit::Fake.new
+          else
+            raise(Sibit::Error, "Unknown API \"#{a}\"")
+          end
+        end, 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)

data/lib/sibit/bitcoinchain.rb

@@ -7,6 +7,7 @@ require 'iri'
 require 'json'
 require 'loog'
 require 'uri'
+require_relative 'coins'
 require_relative 'error'
 require_relative 'http'
 require_relative 'json'
@@ -26,12 +27,12 @@ class Sibit::Bitcoinchain
 
   # Current price of BTC in USD (float returned).
   def price(_currency = 'USD')
-    raise Sibit::NotSupportedError, 'Bitcoinchain API doesn\'t provide BTC price'
+    raise(Sibit::NotSupportedError, 'Bitcoinchain API doesn\'t provide BTC price')
   end
 
   # The height of the block.
   def height(_hash)
-    raise Sibit::NotSupportedError, 'Bitcoinchain API doesn\'t provide height()'
+    raise(Sibit::NotSupportedError, 'Bitcoinchain API doesn\'t provide height()')
   end
 
   # Get hash of the block after this one.
@@ -39,7 +40,7 @@ class Sibit::Bitcoinchain
     block = Sibit::Json.new(http: @http, log: @log).get(
       Iri.new('https://api-r.bitcoinchain.com/v1/block').append(hash)
     )[0]
-    raise Sibit::Error, "Block #{hash} not found" if block.nil?
+    raise(Sibit::Error, "Block #{hash} not found") if block.nil?
     nxt = block['next_block']
     nxt = nil if nxt == '0000000000000000000000000000000000000000000000000000000000000000'
     @log.debug("The block #{hash} is the latest, there is no next block") if nxt.nil?
@@ -58,15 +59,14 @@ class Sibit::Bitcoinchain
       @log.debug("The balance of #{address} is not visible")
       return 0
     end
-    b *= 100_000_000
-    b = b.to_i
+    b = Sibit::Coins.new(b).satoshi
     @log.debug("The balance of #{address} is #{b} satoshi (#{json['transactions']} txns)")
     b
   end
 
   # Get recommended fees, in satoshi per byte.
   def fees
-    raise Sibit::NotSupportedError, 'Not implemented yet'
+    raise(Sibit::NotSupportedError, 'Not implemented yet')
   end
 
   # Gets the hash of the latest block.
@@ -80,12 +80,12 @@ class Sibit::Bitcoinchain
 
   # Fetch all unspent outputs per address.
   def utxos(_sources)
-    raise Sibit::NotSupportedError, 'Not implemented yet'
+    raise(Sibit::NotSupportedError, 'Not implemented yet')
   end
 
   # Push this transaction (in hex format) to the network.
   def push(_hex)
-    raise Sibit::NotSupportedError, 'Not implemented yet'
+    raise(Sibit::NotSupportedError, 'Not implemented yet')
   end
 
   # This method should fetch a Blockchain block and return as a hash. Raises
@@ -94,7 +94,7 @@ class Sibit::Bitcoinchain
     head = Sibit::Json.new(http: @http, log: @log).get(
       Iri.new('https://api-r.bitcoinchain.com/v1/block').append(hash)
     )[0]
-    raise Sibit::Error, "The block #{hash} is not found" if head.nil?
+    raise(Sibit::Error, "The block #{hash} is not found") if head.nil?
     txs = Sibit::Json.new(http: @http, log: @log).get(
       Iri.new('https://api-r.bitcoinchain.com/v1/block/txs').append(hash)
     )
@@ -112,7 +112,7 @@ class Sibit::Bitcoinchain
           outputs: t['outputs'].map do |o|
             {
               address: o['receiver'],
-              value: o['value'] * 100_000_000
+              value: Sibit::Coins.new(o['value']).satoshi
             }
           end
         }

data/lib/sibit/blockchain.rb

@@ -3,6 +3,7 @@
 # SPDX-FileCopyrightText: Copyright (c) 2019-2026 Yegor Bugayenko
 # SPDX-License-Identifier: MIT
 
+require 'cgi'
 require 'iri'
 require 'json'
 require 'loog'
@@ -32,7 +33,7 @@ class Sibit::Blockchain
     h = Sibit::Json.new(http: @http, log: @log).get(
       Iri.new('https://blockchain.info/ticker')
     )[currency]
-    raise Error, "Unrecognized currency #{currency}" if h.nil?
+    raise(Sibit::Error, "Unrecognized currency #{currency}") if h.nil?
     price = h['15m']
     @log.debug("The price of BTC is #{price} USD")
     price
@@ -40,25 +41,15 @@ class Sibit::Blockchain
 
   # Get hash of the block after this one.
   def next_of(_hash)
-    raise Sibit::NotSupportedError, 'next_of() in Blockchain API is broken, always returns NULL'
-    # json = Sibit::Json.new(http: @http, log: @log).get(
-    #   Iri.new('https://blockchain.info/rawblock').append(hash)
-    # )
-    # nxt = json['next_block'][0]
-    # if nxt.nil?
-    #   @log.debug("There is no block after #{hash}")
-    # else
-    #   @log.debug("The next block of #{hash} is #{nxt}")
-    # end
-    # nxt
+    raise(Sibit::NotSupportedError, 'next_of() in Blockchain API is broken, always returns NULL')
   end
 
   # The height of the block.
   def height(hash)
-    json = Sibit::Json.new(http: @http, log: @log).get(
+    h = Sibit::Json.new(http: @http, log: @log).get(
       Iri.new('https://blockchain.info/rawblock').append(hash)
-    )
-    h = json['height']
+    )['height']
+    raise(Sibit::Error, "The block #{hash} found but the height is absent") if h.nil?
     @log.debug("The height of #{hash} is #{h}")
     h
   end
@@ -66,10 +57,10 @@ class Sibit::Blockchain
   # Gets the balance of the address, in satoshi.
   def balance(address)
     json = Sibit::Json.new(http: @http, log: @log).get(
-      Iri.new('https://blockchain.info/rawaddr').append(address).add(limit: 0),
-      accept: [200, 500]
+      Iri.new('https://blockchain.info/rawaddr').append(address).add(limit: 0)
     )
     b = json['final_balance']
+    raise(Sibit::Error, "The balance of #{address} is absent") unless b.is_a?(Integer)
     @log.debug("The balance of #{address} is #{b} satoshi (#{json['n_tx']} txns)")
     b
   end
@@ -86,7 +77,7 @@ class Sibit::Blockchain
       ].join
     )
     {
-      S: json['regular'] / 3,
+      S: (json['regular'] / 3.0).ceil,
       M: json['regular'],
       L: json['priority'],
       XL: json['limits']['max']
@@ -112,8 +103,7 @@ class Sibit::Blockchain
   # Push this transaction (in hex format) to the network.
   def push(hex)
     Sibit::Json.new(http: @http, log: @log).post(
-      Iri.new('https://blockchain.info/pushtx'),
-      hex
+      Iri.new('https://blockchain.info/pushtx'), "tx=#{CGI.escape(hex)}"
     )
   end
 

data/lib/sibit/blockchair.rb

@@ -3,7 +3,6 @@
 # SPDX-FileCopyrightText: Copyright (c) 2019-2026 Yegor Bugayenko
 # SPDX-License-Identifier: MIT
 
-require 'cgi'
 require 'iri'
 require 'json'
 require 'loog'
@@ -28,67 +27,58 @@ class Sibit::Blockchair
 
   # Current price of BTC in USD (float returned).
   def price(_currency = 'USD')
-    raise Sibit::NotSupportedError, 'Blockchair doesn\'t provide BTC price'
+    raise(Sibit::NotSupportedError, 'Blockchair doesn\'t provide BTC price')
   end
 
   # The height of the block.
   def height(_hash)
-    raise Sibit::NotSupportedError, 'Blockchair API doesn\'t provide height()'
+    raise(Sibit::NotSupportedError, 'Blockchair API doesn\'t provide height()')
   end
 
   # Get hash of the block after this one.
   def next_of(_hash)
-    # They don't provide next block hash
-    raise Sibit::NotSupportedError, 'Blockchair API doesn\'t provide next_of()'
+    raise(Sibit::NotSupportedError, 'Blockchair API doesn\'t provide next_of()')
   end
 
   # Gets the balance of the address, in satoshi.
   def balance(address)
-    json = Sibit::Json.new(http: @http, log: @log).get(
-      Iri.new('https://api.blockchair.com/bitcoin/dashboards/address').append(address).fragment(the_key)
-    )['data'][address]
+    uri = Iri.new('https://api.blockchair.com/bitcoin/dashboards/address').append(address)
+    uri = uri.add(key: @key) unless @key.nil?
+    json = Sibit::Json.new(http: @http, log: @log).get(uri)['data'][address]
     if json.nil?
       @log.debug("Address #{address} not found")
       return 0
     end
-    a = json['address']
-    b = a['balance']
+    b = json['address']['balance']
     @log.debug("The balance of #{address} is #{b} satoshi")
     b
   end
 
   # Get recommended fees, in satoshi per byte.
   def fees
-    raise Sibit::NotSupportedError, 'Blockchair doesn\'t implement fees()'
+    raise(Sibit::NotSupportedError, 'Blockchair doesn\'t implement fees()')
   end
 
   # Gets the hash of the latest block.
   def latest
-    raise Sibit::NotSupportedError, 'Blockchair doesn\'t implement latest()'
+    raise(Sibit::NotSupportedError, 'Blockchair doesn\'t implement latest()')
   end
 
   # Fetch all unspent outputs per address.
   def utxos(_sources)
-    raise Sibit::NotSupportedError, 'Blockchair doesn\'t implement utxos()'
+    raise(Sibit::NotSupportedError, 'Blockchair doesn\'t implement utxos()')
   end
 
   # Push this transaction (in hex format) to the network.
   def push(hex)
-    Sibit::Json.new(http: @http, log: @log).post(
-      Iri.new('https://api.blockchair.com/bitcoin/push/transaction').fragment(the_key),
-      "data=#{hex}"
-    )
+    uri = Iri.new('https://api.blockchair.com/bitcoin/push/transaction')
+    uri = uri.add(key: @key) unless @key.nil?
+    Sibit::Json.new(http: @http, log: @log).post(uri, "data=#{hex}")
     @log.debug("Transaction (#{hex.length} in hex) has been pushed to Blockchair")
   end
 
   # This method should fetch a Blockchain block and return as a hash.
   def block(_hash)
-    raise Sibit::NotSupportedError, 'Blockchair doesn\'t implement block()'
-  end
-
-  private
-
-  def the_key
-    @key.nil? ? '' : "key=#{CGI.escape(@key)}"
+    raise(Sibit::NotSupportedError, 'Blockchair doesn\'t implement block()')
   end
 end