sibit 0.14.2 → 0.14.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 80dd8e6fa8034a499c63c15f1333cf366800c85da969af2891b392cc7a09c6ac
-  data.tar.gz: f8126179a4de258e575daf7dc04e9e21cd5bd31c214699573366b7ede67eacca
+  metadata.gz: e3746b345c4e7b36083c7a2377e4a5449532116978e38f964ac558046670fb5d
+  data.tar.gz: 480071555f2cc5e4b15a81274b526fb74a75c223d7b98a98226a134dd87e0e03
 SHA512:
-  metadata.gz: 8ba3f4cd38f43af06f5399caf63be7e48cbcfa63192ceec6c42d892d92800863773e482cbc3a431ba4843042db85b970950d65bbc4c299cf0ec18fc81f2456ab
-  data.tar.gz: b6a759fc3c29c1ca6d6cfad246501ca36abfc81f7ef4caebdcf0e77ed462e0a97328e61d3dfac23d47f56b7a5d6fc8e1ecc44e0cf3267eb86d5512c379fb03ee
+  metadata.gz: '097f3d44a66b8ef449e26429ec068bc8395258d80a2e0d5f520f9af24f5e0323d1f83f2f41e691d9daee570fb9527288c4b721ffdfa43762eafd1ef8c62d8095'
+  data.tar.gz: 8e9d7c89c01e6d537d159e16af0facdffbee6ea1ed4c16104a1c1fd33e4342b0a0a44bc7b3b5b2b5b45e11fa0fd222b4ac8e54aa4de6a75e416e4837540bc796

data/bin/sibit

@@ -31,6 +31,7 @@ require_relative '../lib/sibit/version'
 require_relative '../lib/sibit/blockchain'
 require_relative '../lib/sibit/btc'
 require_relative '../lib/sibit/bitcoinchain'
+require_relative '../lib/sibit/earn'
 
 begin
   begin
@@ -57,7 +58,11 @@ Options are:"
         exit
       end
       o.bool '--verbose', 'Print all possible debug messages'
-      o.array '--api', 'Ordered List of APIs to use, e.g. "blockchain,btc"', default: ['blockchain']
+      o.array(
+        '--api',
+        'Ordered List of APIs to use, e.g. "earn,blockchain,btc,bitcoinchain"',
+        default: %w[earn blockchain btc bitcoinchain]
+      )
     end
   rescue Slop::Error => ex
     raise ex.message
@@ -73,6 +78,8 @@ Options are:"
       api = Sibit::Btc.new(http: http, log: log, dry: opts[:dry])
     elsif a == 'bitcoinchain'
       api = Sibit::Bitcoinchain.new(http: http, log: log, dry: opts[:dry])
+    elsif a == 'earn'
+      api = Sibit::Earn.new(http: http, log: log, dry: opts[:dry])
     else
       raise Sibit::Error, "Unknown API \"#{a}\""
     end

data/lib/sibit/bitcoinchain.rb

@@ -60,11 +60,6 @@ class Sibit
       raise Sibit::Error, 'Not implemented yet'
     end
 
-    # Sends a payment and returns the transaction hash.
-    def pay(_amount, _fee, _sources, _target, _change)
-      raise Sibit::Error, 'Not implemented yet'
-    end
-
     # Gets the hash of the latest block.
     def latest
       Sibit::Json.new(http: @http, log: @log).get(
@@ -72,6 +67,16 @@ class Sibit
       )['hash']
     end
 
+    # Fetch all unspent outputs per address.
+    def utxos(_sources)
+      raise Sibit::Error, 'Not implemented yet'
+    end
+
+    # Push this transaction (in hex format) to the network.
+    def push(_hex)
+      raise Sibit::Error, 'Not implemented yet'
+    end
+
     # This method should fetch a Blockchain block and return as a hash. Raises
     # an exception if the block is not found.
     def block(hash)

data/lib/sibit/blockchain.rb

@@ -67,85 +67,33 @@ class Sibit
       json['final_balance']
     end
 
-    # Get recommended fees, in satoshi per byte. The method returns
-    # a hash: { S: 12, M: 45, L: 100, XL: 200 }
+    # Get recommended fees.
     def fees
-      json = Sibit::Json.new(http: @http, log: @log).get(
-        URI('https://bitcoinfees.earn.com/api/v1/fees/recommended')
-      )
-      @log.info("Current recommended Bitcoin fees: \
-  #{json['hourFee']}/#{json['halfHourFee']}/#{json['fastestFee']} sat/byte")
-      {
-        S: json['hourFee'] / 3,
-        M: json['hourFee'],
-        L: json['halfHourFee'],
-        XL: json['fastestFee']
-      }
+      raise Sibit::Error, 'fees() not implemented yet'
     end
 
-    # Sends a payment and returns the transaction hash.
-    def pay(amount, fee, sources, target, change)
-      p = price('USD')
-      satoshi = satoshi(amount)
-      f = mfee(fee, size_of(amount, sources))
-      satoshi += f if f.negative?
-      raise Error, "The fee #{f.abs} covers the entire amount" if satoshi.zero?
-      raise Error, "The fee #{f.abs} is bigger than the amount #{satoshi}" if satoshi.negative?
-      builder = Bitcoin::Builder::TxBuilder.new
-      unspent = 0
-      size = 100
-      utxos = Sibit::Json.new(http: @http, log: @log).get(
+    # Fetch all unspent outputs per address.
+    def utxos(sources)
+      Sibit::Json.new(http: @http, log: @log).get(
         URI("https://blockchain.info/unspent?active=#{sources.keys.join('|')}&limit=1000")
-      )['unspent_outputs']
-      @log.info("#{utxos.count} UTXOs found, these will be used \
-  (value/confirmations at tx_hash):")
-      utxos.each do |utxo|
-        unspent += utxo['value']
-        builder.input do |i|
-          i.prev_out(utxo['tx_hash_big_endian'])
-          i.prev_out_index(utxo['tx_output_n'])
-          i.prev_out_script = [utxo['script']].pack('H*')
-          address = Bitcoin::Script.new([utxo['script']].pack('H*')).get_address
-          i.signature_key(key(sources[address]))
-        end
-        size += 180
-        @log.info(
-          "  #{num(utxo['value'], p)}/#{utxo['confirmations']} at #{utxo['tx_hash_big_endian']}"
-        )
-        break if unspent > satoshi
+      )['unspent_outputs'].map do |u|
+        {
+          value: u['value'],
+          hash: u['tx_hash_big_endian'],
+          index: u['tx_output_n'],
+          confirmations: u['confirmations'],
+          script: [u['script']].pack('H*')
+        }
       end
-      if unspent < satoshi
-        raise Error, "Not enough funds to send #{num(satoshi, p)}, only #{num(unspent, p)} left"
-      end
-      builder.output(satoshi, target)
-      f = mfee(fee, size)
-      tx = builder.tx(
-        input_value: unspent,
-        leave_fee: true,
-        extra_fee: [f, Bitcoin.network[:min_tx_fee]].max,
-        change_address: change
+    end
+
+    # Push this transaction (in hex format) to the network.
+    def push(hex)
+      return if @dry
+      Sibit::Json.new(http: @http, log: @log).post(
+        URI('https://blockchain.info/pushtx'),
+        hex
       )
-      left = unspent - tx.outputs.map(&:value).inject(&:+)
-      @log.info("A new Bitcoin transaction #{tx.hash} prepared:
-    #{tx.in.count} input#{tx.in.count > 1 ? 's' : ''}:
-      #{tx.inputs.map { |i| " in: #{i.prev_out.bth}:#{i.prev_out_index}" }.join("\n    ")}
-    #{tx.out.count} output#{tx.out.count > 1 ? 's' : ''}:
-      #{tx.outputs.map { |o| "out: #{o.script.bth} / #{num(o.value, p)}" }.join("\n    ")}
-    Min tx fee: #{num(Bitcoin.network[:min_tx_fee], p)}
-    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}")
-      unless @dry
-        Sibit::Json.new(http: @http, log: @log).post(
-          URI('https://blockchain.info/pushtx'),
-          tx.to_payload.bth
-        )
-      end
-      tx.hash
     end
 
     # Gets the hash of the latest block.
@@ -157,74 +105,7 @@ class Sibit
 
     # This method should fetch a Blockchain block and return as a hash.
     def block(_hash)
-      raise Sibit::Error, 'Not implemented yet'
-    end
-
-    private
-
-    def num(satoshi, usd)
-      format(
-        '%<satoshi>ss/$%<dollars>0.2f',
-        satoshi: satoshi.to_s.gsub(/\d(?=(...)+$)/, '\0,'),
-        dollars: satoshi * usd / 100_000_000
-      )
-    end
-
-    # Convert text to amount.
-    def satoshi(amount)
-      return amount if amount.is_a?(Integer)
-      raise Error, 'Amount should either be a String or Integer' unless amount.is_a?(String)
-      return (amount.gsub(/BTC$/, '').to_f * 100_000_000).to_i if amount.end_with?('BTC')
-      raise Error, "Can't understand the amount #{amount.inspect}"
-    end
-
-    # Calculates a fee in satoshi for the transaction of the specified size.
-    # The +fee+ argument could be a number in satoshi, in which case it will
-    # be returned as is, or a string like "XL" or "S", in which case the
-    # fee will be calculated using the +size+ argument (which is the size
-    # of the transaction in bytes).
-    def mfee(fee, size)
-      return fee.to_i if fee.is_a?(Integer)
-      raise Error, 'Fee should either be a String or Integer' unless fee.is_a?(String)
-      mul = 1
-      if fee.start_with?('+', '-')
-        mul = -1 if fee.start_with?('-')
-        fee = fee[1..-1]
-      end
-      sat = fees[fee.to_sym]
-      raise Error, "Can't understand the fee: #{fee.inspect}" if sat.nil?
-      mul * sat * size
-    end
-
-    # Make key from private key string in Hash160.
-    def key(hash160)
-      key = Bitcoin::Key.new
-      key.priv = hash160
-      key
-    end
-
-    # Calculate an approximate size of the transaction.
-    def size_of(amount, sources)
-      satoshi = satoshi(amount)
-      builder = Bitcoin::Builder::TxBuilder.new
-      unspent = 0
-      size = 100
-      utxos = Sibit::Json.new(http: @http, log: @log).get(
-        URI("https://blockchain.info/unspent?active=#{sources.keys.join('|')}&limit=1000")
-      )['unspent_outputs']
-      utxos.each do |utxo|
-        unspent += utxo['value']
-        builder.input do |i|
-          i.prev_out(utxo['tx_hash_big_endian'])
-          i.prev_out_index(utxo['tx_output_n'])
-          i.prev_out_script = [utxo['script']].pack('H*')
-          address = Bitcoin::Script.new([utxo['script']].pack('H*')).get_address
-          i.signature_key(key(sources[address]))
-        end
-        size += 180
-        break if unspent > satoshi
-      end
-      size
+      raise Sibit::Error, 'block() not implemented yet'
     end
   end
 end

data/lib/sibit/btc.rb

@@ -68,11 +68,6 @@ class Sibit
       raise Sibit::Error, 'Not implemented yet'
     end
 
-    # Sends a payment and returns the transaction hash.
-    def pay(_amount, _fee, _sources, _target, _change)
-      raise Sibit::Error, 'Not implemented yet'
-    end
-
     # Gets the hash of the latest block.
     def latest
       uri = URI('https://chain.api.btc.com/v3/block/latest')
@@ -82,6 +77,16 @@ class Sibit
       hash
     end
 
+    # Fetch all unspent outputs per address.
+    def utxos(_sources)
+      raise Sibit::Error, 'Not implemented yet'
+    end
+
+    # Push this transaction (in hex format) to the network.
+    def push(_hex)
+      raise Sibit::Error, 'Not implemented yet'
+    end
+
     # This method should fetch a Blockchain block and return as a hash.
     def block(hash)
       head = Sibit::Json.new(http: @http, log: @log).get(

data/lib/sibit/earn.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2019-2020 Yegor Bugayenko
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the 'Software'), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+require 'json'
+require 'uri'
+require_relative 'version'
+require_relative 'error'
+require_relative 'http'
+require_relative 'json'
+
+# Earn.com API.
+#
+# Author:: Yegor Bugayenko (yegor256@gmail.com)
+# Copyright:: Copyright (c) 2019-2020 Yegor Bugayenko
+# License:: MIT
+class Sibit
+  # Blockchain.info API.
+  class Earn
+    # Constructor.
+    def initialize(log: Sibit::Log.new, http: Sibit::Http.new, dry: false)
+      @http = http
+      @log = log
+      @dry = dry
+    end
+
+    # Current price of BTC in USD (float returned).
+    def price(_currency)
+      raise Sibit::Error, 'price() doesn\'t work here'
+    end
+
+    # Gets the balance of the address, in satoshi.
+    def balance(_address)
+      raise Sibit::Error, 'balance() doesn\'t work here'
+    end
+
+    # Get recommended fees, in satoshi per byte. The method returns
+    # a hash: { S: 12, M: 45, L: 100, XL: 200 }
+    def fees
+      json = Sibit::Json.new(http: @http, log: @log).get(
+        URI('https://bitcoinfees.earn.com/api/v1/fees/recommended')
+      )
+      @log.info("Current recommended Bitcoin fees: \
+  #{json['hourFee']}/#{json['halfHourFee']}/#{json['fastestFee']} sat/byte")
+      {
+        S: json['hourFee'] / 3,
+        M: json['hourFee'],
+        L: json['halfHourFee'],
+        XL: json['fastestFee']
+      }
+    end
+
+    # Fetch all unspent outputs per address.
+    def utxos(_sources)
+      raise Sibit::Error, 'Not implemented yet'
+    end
+
+    # Push this transaction (in hex format) to the network.
+    def push(_hex)
+      raise Sibit::Error, 'Not implemented yet'
+    end
+
+    # Gets the hash of the latest block.
+    def latest
+      raise Sibit::Error, 'latest() doesn\'t work here'
+    end
+
+    # This method should fetch a Blockchain block and return as a hash.
+    def block(_hash)
+      raise Sibit::Error, 'block() doesn\'t work here'
+    end
+  end
+end

data/lib/sibit/fake.rb

@@ -42,8 +42,12 @@ class Sibit
       100_000_000
     end
 
-    def pay(_amount, _fee, _sources, _target, _change)
-      '9dfe55a30b5ee732005158c589179a398117117a68d21531fb6c78b85b544c54'
+    def utxos(_sources)
+      []
+    end
+
+    def push(hex)
+      # Nothing to do here
     end
 
     def latest

data/lib/sibit/version.rb

@@ -26,5 +26,5 @@
 # License:: MIT
 class Sibit
   # Current version of the library.
-  VERSION = '0.14.2'
+  VERSION = '0.14.3'
 end

data/lib/sibit.rb

@@ -105,9 +105,61 @@ class Sibit
   # +target+: the target address to send to
   # +change+: the address where the change has to be sent to
   def pay(amount, fee, sources, target, change)
+    p = price('USD')
+    satoshi = satoshi(amount)
+    builder = Bitcoin::Builder::TxBuilder.new
+    unspent = 0
+    size = 100
+    utxos = first_one { |api| api.utxos(sources) }
+    @log.info("#{utxos.count} UTXOs found, these will be used \
+(value/confirmations at tx_hash):")
+    utxos.each do |utxo|
+      unspent += utxo[:value]
+      builder.input do |i|
+        i.prev_out(utxo[:hash])
+        i.prev_out_index(utxo[:index])
+        i.prev_out_script = utxo[:script]
+        address = Bitcoin::Script.new(utxo[:script]).get_address
+        i.signature_key(key(sources[address]))
+      end
+      size += 180
+      @log.info(
+        "  #{num(utxo[:value], p)}/#{utxo[:confirmations]} at #{utxo[:hash]}"
+      )
+      break if unspent > satoshi
+    end
+    if unspent < satoshi
+      raise Error, "Not enough funds to send #{num(satoshi, p)}, only #{num(unspent, p)} left"
+    end
+    builder.output(satoshi, target)
+    f = mfee(fee, size)
+    satoshi += f if f.negative?
+    raise Error, "The fee #{f.abs} covers the entire amount" if satoshi.zero?
+    raise Error, "The fee #{f.abs} is bigger than the amount #{satoshi}" if satoshi.negative?
+    tx = builder.tx(
+      input_value: unspent,
+      leave_fee: true,
+      extra_fee: [f, Bitcoin.network[:min_tx_fee]].max,
+      change_address: change
+    )
+    left = unspent - tx.outputs.map(&:value).inject(&:+)
+    @log.info("A new Bitcoin transaction #{tx.hash} prepared:
+  #{tx.in.count} input#{tx.in.count > 1 ? 's' : ''}:
+    #{tx.inputs.map { |i| " in: #{i.prev_out.bth}:#{i.prev_out_index}" }.join("\n    ")}
+  #{tx.out.count} output#{tx.out.count > 1 ? 's' : ''}:
+    #{tx.outputs.map { |o| "out: #{o.script.bth} / #{num(o.value, p)}" }.join("\n    ")}
+  Min tx fee: #{num(Bitcoin.network[:min_tx_fee], p)}
+  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}")
     first_one do |api|
-      api.pay(amount, fee, sources, target, change)
+      api.push(tx.to_payload.bth)
     end
+    tx.hash
   end
 
   # Gets the hash of the latest block.
@@ -186,7 +238,51 @@ class Sibit
         @log.info("The API #{api.class.name} failed: #{e.message}")
       end
     end
-    raise Sibit::Error, 'No APIs managed to succeed' unless done
+    unless done
+      raise Sibit::Error, "No APIs out of #{@api.length} managed to succeed: \
+#{@api.map { |a| a.class.name }.join(', ')}"
+    end
     result
   end
+
+  def num(satoshi, usd)
+    format(
+      '%<satoshi>ss/$%<dollars>0.2f',
+      satoshi: satoshi.to_s.gsub(/\d(?=(...)+$)/, '\0,'),
+      dollars: satoshi * usd / 100_000_000
+    )
+  end
+
+  # Convert text to amount.
+  def satoshi(amount)
+    return amount if amount.is_a?(Integer)
+    raise Error, 'Amount should either be a String or Integer' unless amount.is_a?(String)
+    return (amount.gsub(/BTC$/, '').to_f * 100_000_000).to_i if amount.end_with?('BTC')
+    raise Error, "Can't understand the amount #{amount.inspect}"
+  end
+
+  # Calculates a fee in satoshi for the transaction of the specified size.
+  # The +fee+ argument could be a number in satoshi, in which case it will
+  # be returned as is, or a string like "XL" or "S", in which case the
+  # fee will be calculated using the +size+ argument (which is the size
+  # of the transaction in bytes).
+  def mfee(fee, size)
+    return fee.to_i if fee.is_a?(Integer)
+    raise Error, 'Fee should either be a String or Integer' unless fee.is_a?(String)
+    mul = 1
+    if fee.start_with?('+', '-')
+      mul = -1 if fee.start_with?('-')
+      fee = fee[1..-1]
+    end
+    sat = fees[fee.to_sym]
+    raise Error, "Can't understand the fee: #{fee.inspect}" if sat.nil?
+    mul * sat * size
+  end
+
+  # Make key from private key string in Hash160.
+  def key(hash160)
+    key = Bitcoin::Key.new
+    key.priv = hash160
+    key
+  end
 end

data/test/test_fake.rb

@@ -35,10 +35,7 @@ class TestFake < Minitest::Test
     assert_equal(4_000, sibit.price)
     assert_equal(12, sibit.fees[:S])
     assert_equal(100_000_000, sibit.balance(''))
-    assert_equal(
-      '9dfe55a30b5ee732005158c589179a398117117a68d21531fb6c78b85b544c54',
-      sibit.pay(0, 'M', {}, '', '')
-    )
+    assert_equal([], sibit.utxos(nil))
     assert_equal('00000000000000000008df8a6e1b61d1136803ac9791b8725235c9f780b4ed71', sibit.latest)
   end
 

data/test/test_sibit.rb

@@ -24,6 +24,9 @@ require 'minitest/autorun'
 require 'webmock/minitest'
 require 'json'
 require_relative '../lib/sibit'
+require_relative '../lib/sibit/earn'
+require_relative '../lib/sibit/fake'
+require_relative '../lib/sibit/blockchain'
 
 # Sibit.
 # Author:: Yegor Bugayenko (yegor256@gmail.com)
@@ -34,7 +37,7 @@ class TestSibit < Minitest::Test
     stub_request(
       :get, 'https://bitcoinfees.earn.com/api/v1/fees/recommended'
     ).to_return(body: '{"fastestFee":300,"halfHourFee":200,"hourFee":180}')
-    sibit = Sibit.new
+    sibit = Sibit.new(api: Sibit::Earn.new)
     fees = sibit.fees
     assert_equal(60, fees[:S])
     assert_equal(180, fees[:M])
@@ -124,7 +127,7 @@ class TestSibit < Minitest::Test
       'https://blockchain.info/unspent?active=1JvCsJtLmCxEk7ddZFnVkGXpr9uhxZPmJi&limit=1000'
     ).to_return(body: JSON.pretty_generate(json))
     stub_request(:post, 'https://blockchain.info/pushtx').to_return(status: 200)
-    sibit = Sibit.new
+    sibit = Sibit.new(api: [Sibit::Earn.new, Sibit::Blockchain.new])
     target = sibit.create(sibit.generate)
     change = sibit.create(sibit.generate)
     tx = sibit.pay(

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sibit
 version: !ruby/object:Gem::Version
-  version: 0.14.2
+  version: 0.14.3
 platform: ruby
 authors:
 - Yegor Bugayenko
@@ -284,6 +284,7 @@ files:
 - lib/sibit/bitcoinchain.rb
 - lib/sibit/blockchain.rb
 - lib/sibit/btc.rb
+- lib/sibit/earn.rb
 - lib/sibit/error.rb
 - lib/sibit/fake.rb
 - lib/sibit/http.rb