coin-op 0.4.5 → 0.4.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ddcac303efc3cea02f7d42a2a2a7a9c89d16c292
-  data.tar.gz: 9a14fbb3178a73eeb5379fa486d6551c3c57835a
+  metadata.gz: daa2b1357a473f001974e80e34fcdd52358f906e
+  data.tar.gz: a0da314f07e56ad68d776de5234ddbbb8e49d4aa
 SHA512:
-  metadata.gz: b7f368cf4336f909d61a54cad255936c9c8cc5b95bef6ffbdd6025df699b18d7bad1c6e25e2900a05a49df1586a2ed230260a5e1d9c8612d6dd52150ef9db041
-  data.tar.gz: bc80f5346aa7d29608cb3d115188be258cf01e7b0d21b80b8a8d55a77a79fd636c44cd6d90b24ad9e070f25d1f2a3835af5901efcbe2b4ecb264a1937411cc87
+  metadata.gz: e076e686da9b9dc3a6212df1a21757317bd20792d4e9c342c6afaaa19d9acd41e60fb058f0e2b2859ea1ccf50b2f9a22c4ba2e4ac8e5945b42950be96b62c2ae
+  data.tar.gz: 4ff3f5c89ebb5d8e6ae0294904b9db02545bc3d2c1fe8b3598e20d293ebb518e86db9293170b609b862101fbc1865a831098a1cbb5f9d056d6e04d0ed7b0d3f6

checksums.yaml.gz.sig

@@ -1,3 +1,2 @@
-i��O��YI)1��p��E����W�4o�2����z�X�i�a,�Ga�Ӊ5�P���1��O۸��Z��ҏ���U�n��7����i�˙��
-�~6,r� ��N��O&��}�ݶy���G�PSk�ܸ��P�m`^˿�wwm�B�%?�3ǚ?N��Y�S�}�̮m��NrYҏt'�Hc[+gOT#%�l�����3�Q
-�h��U��
+�.ˤ'-<��DmW
+��ɂ1 %�dvJQ/�$�1ſ���	��.��@�nY�C

data/lib/coin-op/bit/fee.rb

@@ -3,59 +3,76 @@ module CoinOp::Bit
 
   module Fee
 
+    # From http://bitcoinfees.com
+    AVG_P2PKH_BYTES = 148
+    AVG_OUTPUT_SIZE = 34
+
+    # From rough tests of Gem p2sh txs on 2015-09-08
+    AVG_P2SH_BYTES = 300
+
     module_function
 
     # Given an array of unspent Outputs and an array of Outputs for a
     # Transaction, estimate the fee required for the transaction to be
-    # included in a block.  Optionally takes an Integer specifying the
-    # transaction size in bytes, which is necessary when using unspents
-    # that deviate from the customary single signature.
+    # included in a block.
+    #
+    # Optionally takes an Integer tx_size specifying the transaction size in bytes
+    #   This is useful if you have the scriptSigs for the unspents, because
+    #   you can get a more accurate size than the estimate which is generated
+    #   here by default
+    #
+    # Optionally takes an Integer fee_per_kb specifying the chosen cost per 1000
+    #   bytes to use
     #
     # Returns the estimated fee in satoshis.
-    def estimate(unspents, payees, tx_size=nil, network:)
+    def estimate(unspents, payees, network:, tx_size: nil, fee_per_kb: nil)
       # https://en.bitcoin.it/wiki/Transaction_fees
 
       # dupe because we'll need to add a change output
       payees = payees.dup
 
-      unspent_total = unspents.inject(0) {|sum, output| sum += output.value}
-      payee_total = payees.inject(0) {|sum, payee| sum += payee.value}
+      unspent_total = unspents.inject(0) { |sum, output| sum += output.value }
+      payee_total = payees.inject(0) { |sum, payee| sum += payee.value }
+
       nominal_change = unspent_total - payee_total
-      payees << Output.new(value: nominal_change, network: network)
+      payees << Output.new(value: nominal_change, network: network) if nominal_change > 0
 
-      tx_size ||= estimate_tx_size(unspents.size, payees.size)
-      min = payees.min_by {|payee| payee.value }
+      tx_size ||= estimate_tx_size(unspents, payees)
 
+      # conditions for 0-fee transactions
       small = tx_size < 1000
-      big_outputs = min.value > 1_000_000
 
-      p = priority :size => tx_size, :unspents => (unspents.map do |output|
-        {:value => output.value, :age => output.confirmations}
-      end)
-      high_priority = p > PRIORITY_THRESHOLD
+      min_payee = payees.min_by { |payee| payee.value }
+      big_outputs = min_payee.value > 1_000_000
+      high_priority = priority(
+        size: tx_size,
+        unspents: unspents.map { |output| { value: output.value, age: output.confirmations } }
+      ) > PRIORITY_THRESHOLD
 
-      if small && big_outputs && high_priority
-        0
-      else
-        fee_for_bytes(tx_size, network: network)
-      end
+      # 0-fee requirements met
+      return 0 if small && big_outputs && high_priority
 
+      # Otherwise, calculate the fee by size
+      fee_for_bytes(tx_size, network: network, fee_per_kb: fee_per_kb)
     end
 
-    def fee_for_bytes(bytes, network:) 
+    def fee_for_bytes(bytes, network:, fee_per_kb: nil)
       # https://en.bitcoin.it/wiki/Transaction_fees
       # > the reference implementation will round up the transaction size to the
       # > next thousand bytes and add a fee of 0.1 mBTC (0.0001 BTC) per thousand bytes
       size = (bytes / 1000) + 1
+      return size * fee_per_kb if fee_per_kb
       CoinOp.syncbit(network) { Bitcoin.network[:min_tx_fee] * size }
     end
 
-    # From http://bitcoinfees.com.  This estimation is only valid for
-    # transactions with all inputs using the common "public key hash" method
-    # for authorization.
-    def estimate_tx_size(num_inputs, num_outputs)
-      # From http://bitcoinfees.com.
-      (148 * num_inputs) + (34 * num_outputs) + 10
+    def estimate_tx_size(inputs, outputs)
+      # tx overhead
+      10 +
+        # outputs don't vary much in size
+        (AVG_OUTPUT_SIZE * outputs.size) +
+        # p2sh outputs are usually larger than p2pkh outputs, which don't vary much
+        inputs.inject(0) { |sum, input|
+          sum += input.script.type == :script_hash ? AVG_P2SH_BYTES : AVG_P2PKH_BYTES }
     end
 
 

data/lib/coin-op/bit/transaction.rb

@@ -10,8 +10,7 @@ module CoinOp::Bit
       transaction
     end
 
-    # Construct a Transaction from a data structure of nested Hashes
-    # and Arrays.
+    # Construct a Transaction from a data structure of nested Hashes and Arrays.
     def self.data(data, network:)
       version, lock_time, fee, inputs, outputs, confirmations =
         data.values_at :version, :lock_time, :fee, :inputs, :outputs, :confirmations
@@ -25,20 +24,17 @@ module CoinOp::Bit
       )
 
       outputs.each do |output_hash|
-        transaction.add_output(Output.new(output_hash, network: network))
+        transaction.add_output(output_hash, network: network)
       end
 
       #FIXME: we're not handling sig_scripts for already signed inputs.
 
-      if inputs
-        # TODO: use #each instead of #each_with_index
-        inputs.each_with_index do |input_hash, index|
-          transaction.add_input(input_hash, network: network)
+      inputs.each do |input_hash|
+        transaction.add_input(input_hash, network: network)
 
-          ## FIXME: verify that the supplied and computed sig_hashes match
-          #puts :sig_hashes_match => (data[:sig_hash] == input.sig_hash)
-        end
-      end
+        ## FIXME: verify that the supplied and computed sig_hashes match
+        #puts :sig_hashes_match => (data[:sig_hash] == input.sig_hash)
+      end if inputs
 
       transaction
     end
@@ -160,17 +156,14 @@ module CoinOp::Bit
     # * an instance of Output
     # * a Hash describing an Output
     #
-    def add_input(input, network:)
+    def add_input(input, network: @network)
       # TODO: allow specifying prev_tx and index with a Hash.
       # Possibly stop using SparseInput.
 
-      unless input.is_a?(Input)
-        input = Input.new input.merge(
-          transaction: self,
-          index: @inputs.size,
-          network: network
-        )
-      end
+      input = Input.new(input.merge(transaction: self,
+                                    index: @inputs.size,
+                                    network: network)
+                       ) unless input.is_a?(Input)
 
       @inputs << input
       self.update_native do |native|
@@ -180,15 +173,15 @@ module CoinOp::Bit
     end
 
     # Takes either an Output or a Hash describing an output.
-    def add_output(output)
-      unless output.is_a? Output
-        output = Output.new(output, network: @network)
+    def add_output(output, network: @network)
+      if output.is_a?(Output)
+        output.set_transaction(self, @outputs.size)
+      else
+        output = Output.new(output.merge(transaction: self,
+                                         index: @outputs.size),
+                            network: network)
       end
 
-      index = @outputs.size
-      # TODO: stop using set_transaction and just pass self to Output.new
-      # Then remove output.set_transaction
-      output.set_transaction self, index
       @outputs << output
       self.update_native do |native|
         native.add_out(output.native)
@@ -301,10 +294,11 @@ module CoinOp::Bit
     # Estimate the fee in satoshis for this transaction.  Takes an optional
     # tx_size argument because it is impossible to determine programmatically
     # the size of the scripts used to create P2SH outputs.
-    # Rough testing of the size of a 2of3 multisig p2sh input: 297
-    def estimate_fee(tx_size=nil)
+    # Rough testing of the size of a 2of3 multisig p2sh input: 297 +/- 40 bytes
+    def estimate_fee(tx_size: nil, network: @network, fee_per_kb: nil)
       unspents = inputs.map(&:output)
-      Fee.estimate(unspents, outputs, tx_size)
+      Fee.estimate(unspents, outputs,
+                   network: network, tx_size: tx_size, fee_per_kb: fee_per_kb)
     end
 
     # Returns the transaction fee computed from the actual input and output

data/lib/coin-op/encodings.rb

@@ -24,7 +24,7 @@ module CoinOp
 
     def int_to_byte_array(i, endianness: :little)
       arr = i.to_s(16).scan(/../).map { |x| x.hex.chr }
-      if endianness = :little
+      if endianness == :little
         arr.reverse.join
       else
         arr.join

data/lib/coin-op/version.rb

@@ -1,3 +1,3 @@
 module CoinOp
-  VERSION = "0.4.5"
+  VERSION = "0.4.6"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: coin-op
 version: !ruby/object:Gem::Version
-  version: 0.4.5
+  version: 0.4.6
 platform: ruby
 authors:
 - Matthew King
@@ -32,7 +32,7 @@ cert_chain:
   tdc4VS7IlSRxlZ3dBOgiigy9GXpJ+7F831AqjxL39EPwdr7RguTNz+pi//RKaT/U
   IlpVB+Xfk0vQdP7iYfjGxDzUf0FACMjsR95waJmadKW1Iy6STw2hwPhYIQz1Hu1A
   -----END CERTIFICATE-----
-date: 2015-08-07 00:00:00.000000000 Z
+date: 2015-09-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bitcoin-ruby