sibit 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 85eea5a6116c95e319c46e4bb3bcaa9a5578d0d0e96395e4a9395cc4b7546e7b
-  data.tar.gz: 0de27c41f5e7ea62ef116f06504839e3bfa45da2cc01ac9c87352853e95fb41a
+  metadata.gz: a297184fe1eeb6405104af89ad5eb25288fc99e1fc0635596f0ed61649f3c248
+  data.tar.gz: b386b08577c46b662de0b78737e364411cea207f203b6c78196caa545407bf0b
 SHA512:
-  metadata.gz: e656fa1439cc031cf41c69e8ec14fcb929a92bbb839657ee78ef2d52f0b715f9dd4939ee4a0567b21aaa7c8dd6da5d91c0bd2fd148847de37db8e79689b873d9
-  data.tar.gz: d0cdb4e5c6a3b4bf1cfa5c08aba92d77cc1920aaf45033ca6845d57e7b2c26782b9a0587794db11a7bf615cce51328bcb2327d29b20765c844346d59d63ebd15
+  metadata.gz: 0b088ebce459844e583f03a160490cec3a56299bf021c0e953597e6323f2d84377a47ca1f069810bc7db04d54bc4761929b706cc10f32a0c349753ecd826eb17
+  data.tar.gz: 8de79264a592d6bdf387223a4443d7950441a06c553b926640ac4f9c91f9fc61df0f97ed14d878a76de2be02e0eccbf238dcb7f139f26ed4467b1fc545f1e176

data/.rubocop.yml

@@ -5,6 +5,8 @@ AllCops:
   DisplayCopNames: true
   TargetRubyVersion: 2.3
 
+Metrics/LineLength:
+  Max: 100
 Layout/EndOfLine:
   EnforcedStyle: lf
 Metrics/CyclomaticComplexity:
@@ -13,6 +15,10 @@ Metrics/MethodLength:
   Enabled: false
 Layout/MultilineMethodCallIndentation:
   Enabled: false
+Metrics/ParameterLists:
+  Max: 6
+Metrics/ClassLength:
+  Max: 120
 Metrics/AbcSize:
   Enabled: false
 Metrics/BlockLength:

data/README.md

@@ -16,20 +16,18 @@ this [short video](https://www.youtube.com/watch?v=IV9pRBq5A4g).
 This is a simple Bitcoin client, to use from the command line
 or from your Ruby app. You don't need to run any Bitcoin software,
 no need to install anything, and so on. All you need is just a command line
-and [Ruby](https://www.ruby-lang.org/en/) 2.3+.
+and [Ruby](https://www.ruby-lang.org/en/) 2.3+. The purpose of this
+client is to simplify most typical operations with Bitcoin. If you need
+something more complex, I would recommend using
+[bitcoin-ruby](https://github.com/lian/bitcoin-ruby) for Ruby and
+[Electrum](https://electrum.org/) as a GUI client.
 
-This is Ruby gem, install it first:
+This is a Ruby gem, install it first:
 
 ```bash
 $ gem install sibit
 ```
 
-Run it and read its output:
-
-```bash
-$ sibit --help
-```
-
 Then, you generate a [private key](https://en.bitcoin.it/wiki/Private_key):
 
 ```bash
@@ -56,8 +54,8 @@ $ sibit balance 1CC3X2gu58d6wXUWMffpuzN9JAfTUWu4Kj
 To send a payment from a few addresses to a new address:
 
 ```
-$ sibit pay KEY AMOUNT FEE FROM1,FROM2,... TO
-1CC3X2gu58d6wXUWjslPuzN9JAfTUWu4Kg
+$ sibit pay KEY AMOUNT FEE SOURCE1,SOURCE2,... TARGET CHANGE
+e87f138c9ebf5986151667719825c28458a28cc66f69fed4f1032a93b399fdf8
 ```
 
 Here,
@@ -65,9 +63,12 @@ Here,
 `AMOUNT` is the amount of [satoshi](https://en.bitcoin.it/wiki/Satoshi_%28unit%29) you are sending,
 `FEE` is the [miner fee](https://en.bitcoin.it/wiki/Miner_fees) you are ready to spend to make this transaction delivered
 (you can say `S`, `M`, `L`, or `XL` if you want it to be calculated automatically),
-`FROM1,FROM2,...` is a comma-separated list of addresses you are sending your coins from,
-`TO` is the address you are sending to.
-The address returned will contain the residual coins after the transaction is made.
+`SOURCE1,SOURCE2,...` is a comma-separated list of addresses you are sending your coins from,
+`TARGET` is the address you are sending to,
+`CHANGE` is the address where the change will be sent to.
+The transaction hash will be returned.
+Not all [UTXOs](https://en.wikipedia.org/wiki/Unspent_transaction_output)
+will be used, but only the necessary amount of them.
 
 All operations are performed through the
 [Blockchain API](https://www.blockchain.com/api/blockchain_api).
@@ -84,7 +85,9 @@ sibit = Sibit.new
 pkey = sibit.generate
 address = sibit.create(pkey)
 balance = sibit.balance(address)
-out = sibit.pay(pkey, 10_000_000, 'XL', address, target)
+target = sibit.create(pkey) # where to send coins to
+change = sibit.create(pkey) # where the change will sent to
+tx = sibit.pay(pkey, 10_000_000, 'XL', [address], target, change)
 ```
 
 Should work.

data/bin/sibit

@@ -24,11 +24,18 @@ STDOUT.sync = true
 require 'slop'
 require 'backtrace'
 require_relative '../lib/sibit'
+require_relative '../lib/sibit/version'
 
 begin
   begin
     opts = Slop.parse(ARGV, strict: true, help: true) do |o|
-      o.banner = "Usage (#{Sibit::VERSION}): sibit [options]"
+      o.banner = "Usage (#{Sibit::VERSION}): sibit [options] command [args]
+Commands are:
+    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.bool '--help', 'Read this: https://github.com/yegor256/sibit' do
         puts o
         exit
@@ -37,6 +44,7 @@ begin
   rescue Slop::Error => ex
     raise "#{ex.message}"
   end
+  raise 'Try --help' if opts.arguments.empty?
   sibit = Sibit.new
   case opts.arguments[0]
   when 'generate'
@@ -60,7 +68,9 @@ begin
     raise 'Addresses argument is required' if sources.nil?
     target = opts.arguments[5]
     raise 'Target argument is required' if target.nil?
-    puts sibit.pay(pvt, amount, fee, sources.split(','), target)
+    change = opts.arguments[6]
+    raise 'Change argument is required' if change.nil?
+    puts sibit.pay(pvt, amount, fee, sources.split(','), target, change)
   else
     raise "Command #{opts.arguments[0]} is not supported"
   end

data/features/step_definitions/steps.rb

@@ -56,9 +56,7 @@ When(%r{^I run bin/sibit with "([^"]*)"$}) do |arg|
 end
 
 Then(/^Stdout contains "([^"]*)"$/) do |txt|
-  unless @stdout.include?(txt)
-    raise "STDOUT doesn't contain '#{txt}':\n#{@stdout}"
-  end
+  raise "STDOUT doesn't contain '#{txt}':\n#{@stdout}" unless @stdout.include?(txt)
 end
 
 Then(/^Stdout is empty$/) do

data/lib/sibit/version.rb

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

data/lib/sibit.rb

@@ -25,38 +25,142 @@ require 'typhoeus'
 require 'json'
 
 # Sibit main class.
+#
+# It works through the Blockchain API at the moment:
+# https://www.blockchain.com/api/blockchain_api
+#
 # Author:: Yegor Bugayenko (yegor256@gmail.com)
 # Copyright:: Copyright (c) 2019 Yegor Bugayenko
 # License:: MIT
 class Sibit
-  # Generate new Bitcon private key.
+  # Constructor.
+  def initialize(log: STDOUT)
+    @log = log
+  end
+
+  # Generate new Bitcon private key and returns in Hash160 format.
   def generate
-    key = Bitcoin::Key.generate
-    key.priv
+    Bitcoin::Key.generate.priv
   end
 
-  # Create Bitcon address using the private key.
+  # Create Bitcon address using the private key in Hash160 format.
   def create(pvt)
-    key = Bitcoin::Key.new
-    key.priv = pvt
-    key.addr
+    key(pvt).addr
   end
 
   # Get the balance of the address, in satoshi.
   def balance(address)
-    request = Typhoeus::Request.new(
-      "https://blockchain.info/rawaddr/#{address}",
-      method: :get,
-      headers: {}
+    get_json("https://blockchain.info/rawaddr/#{address}")['final_balance']
+  end
+
+  # Send a payment and return the transaction hash.
+  #
+  # +pvt+: the private key as a Hash160 string
+  # +amount+: the amount either in satoshis or ending with 'BTC', like '0.7BTC'
+  # +fee+: the miners fee in satoshis (as integer) or S/M/X/XL as a string
+  # +sources+: the array of bitcoin addresses where the coins are now
+  # +target+: the target address to send to
+  # +change+: the address where the change has to be sent to
+  def pay(pvt, amount, fee, sources, target, change)
+    satoshi = satoshi(amount)
+    builder = Bitcoin::Builder::TxBuilder.new
+    unspent = 0
+    size = 100
+    utxos(sources).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*')
+        i.signature_key(key(pvt))
+      end
+      size += 180
+      break if unspent > satoshi
+    end
+    raise "Not enough funds to send #{amount}, only #{unspent} left" if unspent < satoshi
+    builder.output(satoshi, target)
+    tx = builder.tx(
+      input_value: unspent,
+      leave_fee: mfee(fee, size),
+      change_address: change
     )
+    post_tx(tx.to_payload.bth)
+    tx.hash
+  end
+
+  private
+
+  # Retrieve all unspent outputs of the given list of
+  # addresses.
+  def utxos(sources)
+    offset = 0
+    txns = []
+    loop do
+      uri = [
+        'https://blockchain.info/unspent?',
+        "active=#{sources.join('|')}",
+        offset.positive? ? "&offset=#{offset}" : ''
+      ].join
+      list = get_json(uri)['unspent_outputs']
+      txns += list
+      break if list.empty?
+      offset += list.count
+    end
+    txns
+  end
+
+  # Convert text to amount.
+  def satoshi(amount)
+    return (amount.gsub(/BTC$/, '').to_f * 100_000_000).to_i if amount.end_with?('BTC')
+    amount.to_i
+  end
+
+  def mfee(fee, size)
+    return fee.to_i if fee.is_a?(Integer) || /^[0-9]+$/.match?(fee)
+    case fee
+    when 'S'
+      return 10 * size
+    when 'M'
+      return 50 * size
+    when 'L'
+      return 100 * size
+    when 'XL'
+      return 250 * size
+    else
+      raise "Can't understand the fee: #{fee.inspect}"
+    end
+  end
+
+  # Make key from private key string in Hash160.
+  def key(hash160)
+    key = Bitcoin::Key.new
+    key.priv = hash160
+    key
+  end
+
+  def post_tx(body)
+    uri = 'https://blockchain.info/pushtx'
+    request = Typhoeus::Request.new(uri, method: :post, body: { tx: body })
+    request.run
+    response = request.response
+    raise "Invalid response at #{uri}: #{response.code}" unless response.code == 200
+    debug("POST #{uri}: #{response.code}")
+  end
+
+  def get_json(uri)
+    request = Typhoeus::Request.new(uri, method: :get, headers: {})
     request.run
     response = request.response
-    json = JSON.parse(response.body)
-    json['final_balance']
+    raise "Invalid response at #{uri}: #{response.code}" unless response.code == 200
+    debug("GET #{uri}: #{response.code}")
+    JSON.parse(response.body)
   end
 
-  # Send a payment.
-  def pay(_pvt, _amount, _fee, _sources, _target)
-    raise 'Not implemented yet'
+  def debug(msg)
+    if @log.respond_to?(:debug)
+      @log.debug(msg)
+    elsif @log.respond_to?(:puts)
+      @log.puts(msg)
+    end
   end
 end

data/sibit.gemspec

@@ -55,10 +55,12 @@ and Ruby 2.3+.'
   s.add_runtime_dependency 'typhoeus', '1.3.1'
   s.add_development_dependency 'codecov', '0.1.10'
   s.add_development_dependency 'cucumber', '1.3.17'
+  s.add_development_dependency 'debase', '0.2.2'
   s.add_development_dependency 'minitest', '5.5.0'
   s.add_development_dependency 'rake', '12.0.0'
-  # s.add_development_dependency 'rdoc', '4.2.0'
   s.add_development_dependency 'rspec-rails', '3.1.0'
   s.add_development_dependency 'rubocop', '0.61.0'
   s.add_development_dependency 'rubocop-rspec', '1.31.0'
+  s.add_development_dependency 'ruby-debug-ide', '0.6.1'
+  s.add_development_dependency 'webmock', '3.4.2'
 end

data/test/test_sibit.rb

@@ -21,6 +21,8 @@
 # SOFTWARE.
 
 require 'minitest/autorun'
+require 'webmock/minitest'
+require 'json'
 require_relative '../lib/sibit'
 
 # Sibit.
@@ -38,14 +40,55 @@ class TestSibit < Minitest::Test
   def test_create_address
     sibit = Sibit.new
     pkey = sibit.generate
+    puts "key: #{pkey}"
     address = sibit.create(pkey)
+    puts "address: #{address}"
     assert(!address.nil?)
     assert(/^1[0-9a-zA-Z]+$/.match?(address))
   end
 
   def test_gets_balance
+    stub_request(
+      :get,
+      'https://blockchain.info/rawaddr/1MZT1fa6y8H9UmbZV6HqKF4UY41o9MGT5f'
+    ).to_return(status: 200, body: '{"final_balance": 100}')
     sibit = Sibit.new
     balance = sibit.balance('1MZT1fa6y8H9UmbZV6HqKF4UY41o9MGT5f')
     assert(balance.is_a?(Integer))
+    assert_equal(100, balance)
+  end
+
+  def test_sends_payment
+    json = {
+      unspent_outputs: [
+        {
+          tx_hash: 'fc8fb1a526aef220b54a66bbb3e0549bf34db4f25e1aebc3feb87e86d341e65d',
+          tx_hash_big_endian: '5de641d3867eb8fec3eb1a5ef2b44df39b54e0b3bb664ab520f2ae26a5b18ffc',
+          tx_output_n: 0,
+          script: '76a914c48a1737b35a9f9d9e3b624a910f1e22f7e80bbc88ac',
+          value: 100_000
+        }
+      ]
+    }
+    stub_request(
+      :get,
+      'https://blockchain.info/unspent?active=1JvCsJtLmCxEk7ddZFnVkGXpr9uhxZPmJi'
+    ).to_return(status: 200, body: JSON.pretty_generate(json))
+    stub_request(
+      :get,
+      'https://blockchain.info/unspent?active=1JvCsJtLmCxEk7ddZFnVkGXpr9uhxZPmJi&offset=1'
+    ).to_return(status: 200, body: '{"unspent_outputs": []}')
+    stub_request(:post, 'https://blockchain.info/pushtx').to_return(status: 200)
+    sibit = Sibit.new
+    target = sibit.create(sibit.generate)
+    change = sibit.create(sibit.generate)
+    tx = sibit.pay(
+      'fd2333686f49d8647e1ce8d5ef39c304520b08f3c756b67068b30a3db217dcb2',
+      '0.0001BTC', 'S',
+      ['1JvCsJtLmCxEk7ddZFnVkGXpr9uhxZPmJi'],
+      target, change
+    )
+    assert(!tx.nil?)
+    assert(tx.length > 30, tx)
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sibit
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Yegor Bugayenko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-08 00:00:00.000000000 Z
+date: 2019-04-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: backtrace
@@ -108,6 +108,20 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 1.3.17
+- !ruby/object:Gem::Dependency
+  name: debase
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.2.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.2.2
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -178,6 +192,34 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 1.31.0
+- !ruby/object:Gem::Dependency
+  name: ruby-debug-ide
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.6.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.6.1
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.4.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.4.2
 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, \