btcruby 0.0.0 → 1.0.0

data/spec/transaction_builder_spec.rb

@@ -0,0 +1,338 @@
+require_relative 'spec_helper'
+describe BTC::TransactionBuilder do
+
+  class SignerByKey
+    include TransactionBuilder::Signer
+    def initialize(&block)
+      @block = block
+    end
+    def signing_key_for_output(output: nil, address: nil)
+      @block.call(output, address)
+    end
+  end
+
+  class SignerBySignatureScript
+    include TransactionBuilder::Signer
+    def initialize(&block)
+      @block = block
+    end
+    def signature_script_for_input(input: nil, output: nil)
+      @block.call(input, output)
+    end
+  end
+
+  describe "TransactionBuilder with no outputs" do
+    before do
+      @builder = TransactionBuilder.new
+      @all_utxos = self.mock_utxos
+
+      @builder.input_addresses = self.mock_addresses
+      @builder.provider = TransactionBuilder::Provider.new do |txb|
+        addrs = txb.public_addresses
+        addrs.must_equal self.mock_addresses
+        scripts = addrs.map{|a| a.script }.uniq
+        @all_utxos.find_all{|utxo| scripts.include?(utxo.script) }
+      end
+      @builder.change_address = Address.parse("1CBtcGivXmHQ8ZqdPgeMfcpQNJrqTrSAcG")
+    end
+
+    it "should fill unspent_outputs using Provider" do
+      @builder.unspent_outputs.must_equal @all_utxos
+    end
+
+    it "should have a default fee rate" do
+      @builder.fee_rate.must_equal Transaction::DEFAULT_FEE_RATE
+    end
+
+    it "should return a result" do
+      result = @builder.build
+      result.class.must_equal TransactionBuilder::Result
+    end
+
+    it "should compose a fully-spending transaction when no outputs are given" do
+      result = @builder.build
+      tx = result.transaction
+      tx.inputs.size.must_equal mock_utxos.size
+      tx.outputs.size.must_equal 1 # only one change address
+    end
+
+    it "should have a list of unsigned indexes" do
+      result = @builder.build
+      result.unsigned_input_indexes.must_equal (0...(mock_utxos.size)).to_a
+    end
+
+    it "should have a reasonable fee" do
+      result = @builder.build
+      size = result.transaction.data.bytesize # size of unsigned transaction
+      result.fee.must_be :>=, (size / 1000)*Transaction::DEFAULT_FEE_RATE
+      result.fee.must_be :<, 0.01 * BTC::COIN
+    end
+
+    it "should have valid amounts" do
+      result = @builder.build
+      result.inputs_amount.must_equal mock_utxos.inject(0){|sum, out| sum + out.value}
+      result.outputs_amount.must_be :<=, result.inputs_amount
+      # Balance should be correct
+      result.inputs_amount.must_equal (result.outputs_amount + result.fee)
+      result.transaction.inputs.each do |txin|
+        # Unsigned txins contain respective output scripts.
+        # Signed txins contain data-only signature script (for P2PKH it is signature + pubkey)
+        txin.signature_script.data_only?.must_equal false
+        txin.signature_script.p2pkh?.must_equal true
+      end
+    end
+
+    it "should sign if WIFs are provided" do
+      @builder.input_addresses = mock_wifs
+      result = @builder.build
+      result.unsigned_input_indexes.must_equal []
+      result.transaction.inputs.each do |txin|
+        # Unsigned txins contain respective output scripts.
+        # Signed txins contain data-only signature script (for P2PKH it is signature + pubkey)
+        txin.signature_script.data_only?.must_equal true
+        txin.signature_script.p2pkh?.must_equal false
+      end
+    end
+
+    it "should sign if signer provides a key" do
+      @builder.signer = SignerByKey.new do |txout, addr|
+        wif = mock_wifs.find{|wif| wif.public_address == addr}
+        wif.key
+      end
+      result = @builder.build
+      result.unsigned_input_indexes.must_equal []
+      result.transaction.inputs.each do |txin|
+        # Unsigned txins contain respective output scripts.
+        # Signed txins contain data-only signature script (for P2PKH it is signature + pubkey)
+        txin.signature_script.data_only?.must_equal true
+        txin.signature_script.p2pkh?.must_equal false
+      end
+    end
+
+    it "should sign if signer provides a signature script" do
+      @builder.signer = SignerBySignatureScript.new do |txin, txout|
+        Script.new << "signature" << "pubkey"
+      end
+      result = @builder.build
+      result.unsigned_input_indexes.must_equal []
+      result.transaction.inputs.each do |txin|
+        # Unsigned txins contain respective output scripts.
+        # Signed txins contain data-only signature script (for P2PKH it is signature + pubkey)
+        txin.signature_script.data_only?.must_equal true
+        txin.signature_script.p2pkh?.must_equal false
+      end
+    end
+
+    it "should include all prepended unspents AND all normal unspents" do
+      @builder.prepended_unspent_outputs = [ BTC::TransactionOutput.new(
+        value: 6_666_666,
+        script: Address.parse("3EktnHQD7RiAE6uzMj2ZifT9YgRrkSgzQX").script,
+        index: 0,
+        transaction_hash: "some mock tx".hash256
+      ) ]
+      result = @builder.build
+      result.inputs_amount.must_equal mock_utxos.inject(0){|sum, out| sum + out.value} + 6_666_666
+      result.transaction.inputs.size.must_equal mock_utxos.size + 1
+    end
+  end
+
+
+
+
+  describe "TransactionBuilder with some outputs" do
+    before do
+      @builder = TransactionBuilder.new
+      @all_utxos = self.mock_utxos
+      @builder.input_addresses = self.mock_addresses
+      @builder.provider = TransactionBuilder::Provider.new do |txb|
+        addrs = txb.public_addresses
+        addrs.must_equal self.mock_addresses
+        scripts = addrs.map{|a| a.script }.uniq
+        @all_utxos.find_all{|utxo| scripts.include?(utxo.script) }
+      end
+      @builder.change_address = Address.parse("1CBtcGivXmHQ8ZqdPgeMfcpQNJrqTrSAcG")
+      @builder.outputs = [ TransactionOutput.new(value: 1000_500,
+                            script: Address.parse("1TipsuQ7CSqfQsjA9KU5jarSB1AnrVLLo").script) ]
+    end
+
+    it "should fill unspent_outputs using provider" do
+      @builder.unspent_outputs.must_equal @all_utxos
+    end
+
+    it "should have a default fee rate" do
+      @builder.fee_rate.must_equal Transaction::DEFAULT_FEE_RATE
+    end
+
+    it "should compose a minimal transaction to pay necessary amount" do
+      result = @builder.build
+      tx = result.transaction
+      tx.inputs.size.must_equal 11
+      tx.outputs.size.must_equal 2 # one change address and one output address
+
+      # Payment address
+      tx.outputs.first.value.must_equal 1000_500
+      tx.outputs.first.script.standard_address.to_s.must_equal "1TipsuQ7CSqfQsjA9KU5jarSB1AnrVLLo"
+
+      # Change address
+      tx.outputs.last.value.must_equal (1000_00*11 - 1000_500 - result.fee)
+      tx.outputs.last.script.standard_address.to_s.must_equal "1CBtcGivXmHQ8ZqdPgeMfcpQNJrqTrSAcG"
+    end
+
+    it "should have a list of unsigned indexes" do
+      result = @builder.build
+      result.unsigned_input_indexes.must_equal (0...(result.transaction.inputs.size)).to_a
+    end
+
+    it "should have a reasonable fee" do
+      result = @builder.build
+      size = result.transaction.data.bytesize # size of unsigned transaction
+      result.fee.must_be :>=, (size / 1000)*Transaction::DEFAULT_FEE_RATE
+      result.fee.must_be :<, 0.01 * BTC::COIN
+    end
+
+    it "should have valid amounts" do
+      result = @builder.build
+      result.inputs_amount.must_equal 11*1000_00
+      result.outputs_amount.must_be :<=, result.inputs_amount
+      # Balance should be correct
+      result.inputs_amount.must_equal (result.outputs_amount + result.fee)
+      result.transaction.inputs.each do |txin|
+        # Unsigned txins contain respective output scripts.
+        # Signed txins contain data-only signature script (for P2PKH it is signature + pubkey)
+        txin.signature_script.data_only?.must_equal false
+        txin.signature_script.p2pkh?.must_equal true
+      end
+    end
+
+    it "should sign if WIFs are provided" do
+      @builder.input_addresses = mock_wifs
+      result = @builder.build
+      result.unsigned_input_indexes.must_equal []
+      result.transaction.inputs.each do |txin|
+        # Unsigned txins contain respective output scripts.
+        # Signed txins contain data-only signature script (for P2PKH it is signature + pubkey)
+        txin.signature_script.data_only?.must_equal true
+        txin.signature_script.p2pkh?.must_equal false
+      end
+    end
+
+    it "should include all prepended unspents and none of normal unspents if amount is covered" do
+      @builder.prepended_unspent_outputs = [ BTC::TransactionOutput.new(
+        value: 6_666_666,
+        script: Address.parse("3EktnHQD7RiAE6uzMj2ZifT9YgRrkSgzQX").script,
+        index: 0,
+        transaction_hash: "some mock tx".hash256
+      ) ]
+      result = @builder.build
+      result.inputs_amount.must_equal 6_666_666
+      result.transaction.inputs.size.must_equal 1
+    end
+
+    it "should include all prepended unspents and just enough of normal unspents" do
+      @builder.prepended_unspent_outputs = [ BTC::TransactionOutput.new(
+        value: @builder.outputs.first.value - (self.mock_utxos.first.value / 2),
+        script: Address.parse("3EktnHQD7RiAE6uzMj2ZifT9YgRrkSgzQX").script,
+        index: 0,
+        transaction_hash: "some mock tx".hash256
+      ) ]
+      result = @builder.build
+      result.inputs_amount.must_equal(@builder.outputs.first.value + (self.mock_utxos.first.value / 2))
+      result.transaction.inputs.size.must_equal 2
+    end
+  end
+
+  describe "TransactionBuilder edge cases" do
+    before do
+      @builder = TransactionBuilder.new
+      @all_utxos = self.mock_utxos
+      @builder.input_addresses = self.mock_addresses
+      @builder.provider = TransactionBuilder::Provider.new do |txb|
+        addrs = txb.public_addresses
+        addrs.must_equal self.mock_addresses
+        scripts = addrs.map{|a| a.script }.uniq
+        @all_utxos.find_all{|utxo| scripts.include?(utxo.script) }
+      end
+      @builder.change_address = Address.parse("1CBtcGivXmHQ8ZqdPgeMfcpQNJrqTrSAcG")
+    end
+
+    it "should detect missing change address" do
+      @builder.change_address = nil
+      lambda do
+        result = @builder.build
+      end.must_raise TransactionBuilder::MissingChangeAddressError
+    end
+
+    it "should detect missing unspents" do
+      @builder.provider = nil
+      lambda do
+        result = @builder.build
+      end.must_raise TransactionBuilder::MissingUnspentOutputsError
+    end
+
+    it "should detect missing unspents" do
+      @builder.unspent_outputs = [ ]
+      lambda do
+        result = @builder.build
+      end.must_raise TransactionBuilder::MissingUnspentOutputsError
+    end
+
+    it "should detect not enough unspents" do
+      @builder.outputs = [ TransactionOutput.new(value: 100*COIN, script: @builder.change_address.script) ]
+      lambda do
+        result = @builder.build
+      end.must_raise TransactionBuilder::InsufficientFundsError
+    end
+
+    it "should detect not enough unspents because of change constraints" do
+      @builder.dust_change = 0 # no coins are allowed to be lost
+      @builder.minimum_change = 10000
+      @builder.unspent_outputs = mock_utxos[0, 1]
+      @builder.outputs = [ TransactionOutput.new(value: 1000_00 - @builder.fee_rate - 10, script: @builder.change_address.script) ]
+      lambda do
+        result = @builder.build
+      end.must_raise TransactionBuilder::InsufficientFundsError
+    end
+
+    it "should forgo change if it's below dust level" do
+      @builder.dust_change = 42
+      @builder.minimum_change = 1000
+      @builder.unspent_outputs = mock_utxos[0, 1]
+      assumed_fee = 2590 #@builder.fee_rate # we assume we'll have sub-1K transaction
+      amount = 1000_00 - assumed_fee - @builder.dust_change
+      @builder.outputs = [ TransactionOutput.new(value: amount, script: @builder.change_address.script) ]
+
+      result = @builder.build
+      result.fee.must_equal assumed_fee
+      result.transaction.wont_equal nil
+      result.transaction.outputs.size.must_equal 1
+      result.transaction.outputs.first.value.must_equal amount
+    end
+
+  end
+
+  def mock_keys
+    @mock_keys ||= [
+      Key.new(private_key: "Wallet1".sha256),
+      Key.new(private_key: "Wallet2".sha256)
+    ]
+  end
+
+  def mock_addresses
+    mock_keys.map{|k| k.address }
+  end
+
+  def mock_wifs
+    mock_keys.map{|k| k.to_wif_object }
+  end
+
+  def mock_utxos
+    scripts = mock_addresses.map{|a| a.script }
+    (0...32).map do |i|
+      TransactionOutput.new(value:  100_000,
+                           script: scripts[i % scripts.size],
+                 transaction_hash: ((16+i).to_s(16)*32).from_hex,
+                            index: i)
+    end
+  end
+
+end

data/spec/transaction_spec.rb

@@ -0,0 +1,162 @@
+require_relative 'spec_helper'
+describe BTC::Transaction do
+
+  it "should have core attributes" do
+
+    tx = BTC::Transaction.new
+
+    tx.data.to_hex.must_equal("01000000" + "0000" + "00000000")
+
+    tx.to_h.must_equal({
+      "hash"=>"d21633ba23f70118185227be58a63527675641ad37967e2aa461559f577aec43",
+      "ver"=>1,
+      "vin_sz"=>0,
+      "vout_sz"=>0,
+      "lock_time"=>0,
+      "size"=>10,
+      "in"=>[],
+      "out"=>[]
+    })
+
+  end
+
+  describe "Hash <-> ID conversion" do
+    before do
+      @txid   = "43ec7a579f5561a42a7e9637ad4156672735a658be2752181801f723ba3316d2"
+      @txhash = @txid.from_hex.reverse
+    end
+
+    it "should convert tx ID to binary hash" do
+      BTC.hash_from_id(nil).must_equal nil
+      BTC.hash_from_id(@txid).must_equal @txhash
+    end
+
+    it "should convert binary hash to tx ID" do
+      BTC.id_from_hash(nil).must_equal nil
+      BTC.id_from_hash(@txhash).must_equal @txid
+    end
+
+    it "should convert hash to/from id for TransactionOutput" do
+      txout = TransactionOutput.new
+      txout.transaction_hash = @txhash
+      txout.transaction_id.must_equal @txid
+      txout.transaction_id = "deadbeef"
+      txout.transaction_hash.to_hex.must_equal "efbeadde"
+    end
+  end
+
+
+  describe "Amounts calculation" do
+    before do
+      @tx = Transaction.new
+      @tx.add_input(TransactionInput.new)
+      @tx.add_input(TransactionInput.new)
+      @tx.add_output(TransactionOutput.new(value: 123))
+      @tx.add_output(TransactionOutput.new(value: 50_000))
+    end
+
+    it "should have good defaults" do
+      @tx.inputs_amount.must_equal nil
+      @tx.fee.must_equal nil
+      @tx.outputs_amount.must_equal 50_123
+    end
+
+    it "should derive inputs_amount from fee" do
+      @tx.fee = 10_000
+      @tx.fee.must_equal 10_000
+      @tx.inputs_amount.must_equal 60_123
+      @tx.outputs_amount.must_equal 50_123
+    end
+
+    it "should derive fee from inputs_amount" do
+      @tx.inputs_amount = 55_123
+      @tx.fee.must_equal 5_000
+      @tx.inputs_amount.must_equal 55_123
+      @tx.outputs_amount.must_equal 50_123
+    end
+
+    it "should derive inputs_amount from input values if present" do
+      @tx.inputs[0].value = 50_523
+      @tx.inputs[1].value = 100
+      @tx.fee.must_equal 500
+      @tx.inputs_amount.must_equal 50_623
+      @tx.outputs_amount.must_equal 50_123
+    end
+
+    it "should not derive inputs_amount from input values if some value is nil" do
+      @tx.inputs[0].value = 50_523
+      @tx.inputs[1].value = nil
+      @tx.fee.must_equal nil
+      @tx.inputs_amount.must_equal nil
+      @tx.outputs_amount.must_equal 50_123
+    end
+  end
+
+
+  describe "Certain transaction" do
+
+    before do
+      @txdata =("0100000001dfb32e172d6cdc51215c28b83415f977fc6ce281e057f7cf40c700" +
+                "8003f7230f000000008a47304402207f5561ac3cfb05743cab6ca914f7eb93c4" +
+                "89f276f10cdf4549e7f0b0ef4e85cd02200191c0c2fd10f10158973a0344fdaf" +
+                "2438390e083a509d2870bcf2b05445612b0141043304596050ca119efccada1d" +
+                "d7ca8e511a76d8e1ddb7ad050298d208455b8bcd09593d823ca252355bf0b41c" +
+                "2ac0ba2afa7ada4660bd38e27585aac7d4e6e435ffffffff02c0791817000000" +
+                "0017a914bd224370f93a2b0435ded92c7f609e71992008fc87ac7b4d1d000000" +
+                "001976a914450c22770eebb00d376edabe7bb548aa64aa235688ac00000000").from_hex
+      @tx = Transaction.new(hex: @txdata.to_hex)
+      @tx = Transaction.new(data: @txdata)
+    end
+
+    it "should decode inputs and outputs correctly" do
+      @tx.version.must_equal 1
+      @tx.lock_time.must_equal 0
+      @tx.inputs.size.must_equal 1
+      @tx.outputs.size.must_equal 2
+      @tx.transaction_id.must_equal "f2d0daf07409e44216fe71075df88f3c8c0c5f8e313582ab256e7af2765dd14e"
+    end
+
+    it "should support dup" do
+      @tx2 = @tx.dup
+      @tx2.data.must_equal @txdata
+      @tx2.must_equal @tx
+      @tx2.object_id.wont_equal @tx.object_id
+    end
+
+    it "detect script kinds" do
+      @tx.outputs[0].script.standard?.must_equal true
+      @tx.outputs[0].script.script_hash_script?.must_equal true
+
+      @tx.outputs[1].script.standard?.must_equal true
+      @tx.outputs[1].script.public_key_hash_script?.must_equal true
+    end
+
+    it "input script should have a valid signature" do
+
+      @tx.inputs.first.signature_script.to_a.map{|c|c.to_hex}.must_equal [
+        "304402207f5561ac3cfb05743cab6ca914f7eb93c489f276f10cdf4549e7f0b0ef4e85cd02200191c0c2fd10f10158973a0344fdaf2438390e083a509d2870bcf2b05445612b01",
+        "043304596050ca119efccada1dd7ca8e511a76d8e1ddb7ad050298d208455b8bcd09593d823ca252355bf0b41c2ac0ba2afa7ada4660bd38e27585aac7d4e6e435"
+      ]
+
+      Diagnostics.current.trace do
+        BTC::Key.validate_script_signature(@tx.inputs.first.signature_script.to_a[0], verify_lower_s: true).must_equal true
+      end
+    end
+
+  end
+
+  describe "Coinbase Transaction" do
+    before do
+      @txdata =("0100000001000000000000000000000000000000000000000000000000000000" +
+                "0000000000ffffffff130301e6040654188d181202119700de00000fccffffff" +
+                "ff0108230595000000001976a914ca6ecc7d4d671d8c5c964a48dbb0bc194407" +
+                "a30688ac00000000").from_hex
+      @tx = Transaction.new(data: @txdata)
+    end
+
+    it "should encode coinbase inputs correctly" do
+      @tx.data.must_equal @txdata
+    end
+  end
+
+end