openassets-ruby 0.4.5 → 0.4.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 38a7d1efd4f24d1f1ebee399588b9f5bed87046c
-  data.tar.gz: aba53db228cc09483dcfc5b13c06e7b1f92dc46c
+  metadata.gz: b9d348974ed51f85bc9e72c5eb5a38bd0a184238
+  data.tar.gz: a693b29a1e8d88cb25b6babd4cabcfd42640502d
 SHA512:
-  metadata.gz: 3f290f1e69367ad04133c7c43787c9e65b552a5b51a2ef59e91912edf640c4e8a51c438c47dd18d0a14dd90eb6c052000f5ca527da2d97f3d873647452518e52
-  data.tar.gz: 31e8c748e7a9267e15c2e9489cfc017976515a2c1434c667fe156c7d08eebfa0fc2bca910310e1da67d2d3cbd2f2a81f591a03a8a75f29ae9b1bd4e8c70d8437
+  metadata.gz: 742fe44913fa3c9fe836ee659719236bc024cd6b655a5fcae74affdb22f0f07cf2ec7c7d4f72e47119e88030368b4069f8333f799f963348795411dbf0a0c72b
+  data.tar.gz: 1d0f68e09c1c0f61c78d130d211949f52822cc0617f20314e55515910cc3625f80c92917a8697d44b846c7cb8fe4f43033741f2f39042a80b00c363bcf49a26c

data/README.md

@@ -217,7 +217,25 @@ Creates a transaction for sending **multiple** asset from the open asset address
   params << OpenAssets::SendAssetParam.new('oGu4VXx2TU97d9LmPP8PMCkHckkcPqC5RY', 50, to)
   params << OpenAssets::SendAssetParam.new('oUygwarZqNGrjDvcZUpZdvEc7es6dcs1vs', 4, to)
   tx = api.send_assets(from, params)
-  ``` 
+  ```
+
+* **send_bitcoins**  
+Creates a transaction for sending **multiple** bitcoins from an address to others.  
+This transaction inputs use only uncolored outputs.  
+  ```ruby
+  # send bitcoins
+  # api.send_bitcoins(<from btc address>, <The array of send bitcoin information(see OpenAssets::SendBitcoinParam).>, <fees (The fess in satoshis for the transaction. use 10000 satoshi if specified nil)>, <mode=('broadcast', 'signed', 'unsigned')>, <output_qty default value is 1.>)
+
+  # example
+  from = 'mrxpeizRrF8ymNx5FrvcGGZVecZjtUFVP3'
+  to1 = 'n4MEsSUN8GktDFZzU3V55mP3jWGMN7e4wE'
+  to2 = 'mvYbB238p3rFYFjM56cHhNNHeQb5ypQJ3T'
+  params = []
+  params << OpenAssets::SendBitcoinParam.new(50000, to1)
+  params << OpenAssets::SendBitcoinParam.new(3000, to2)
+  tx = api.send_bitcoins(from, params)
+  ```
+
 
 * **burn_asset**  
 Creates a transaction for burn asset.  

data/lib/openassets/api.rb

@@ -7,7 +7,7 @@ module OpenAssets
     include Util
     include MethodFilter
 
-    before_filter :change_network, {:include => [:list_unspent, :get_balance, :issue_asset, :send_asset, :send_assets, :send_bitcoin]}
+    before_filter :change_network, {:include => [:list_unspent, :get_balance, :issue_asset, :send_asset, :send_assets, :send_bitcoin, :send_bitcoins]}
 
     attr_reader :config
     attr_reader :provider
@@ -159,6 +159,25 @@ module OpenAssets
       process_transaction(tx, mode)
     end
 
+    # Creates a transaction for sending multiple bitcoins from an address to others.
+    # @param[String] from The address to send the bitcoins from.
+    # @param[Array[OpenAssets::SendBitcoinParam]] send_params The send information(amount of satoshis and to).
+    # @param[Integer] fees The fees in satoshis for the transaction.
+    # @param[String] mode 'broadcast' (default) for signing and broadcasting the transaction,
+    # 'signed' for signing the transaction without broadcasting,
+    # 'unsigned' for getting the raw unsigned transaction without broadcasting"""='broadcast'
+    # @return[Bitcoin::Protocol:Tx] The resulting transaction.
+    def send_bitcoins(from, send_params, fees = nil, mode = 'broadcast')
+      colored_outputs = get_unspent_outputs([from])
+      btc_transfer_specs = send_params.map{|param|
+        OpenAssets::Transaction::TransferParameters.new(colored_outputs, param.to, from, param.amount)
+      }
+      tx = create_tx_builder.transfer_btcs(btc_transfer_specs, fees.nil? ? @config[:default_fees]: fees)
+      tx = process_transaction(tx, mode)
+      tx
+    end
+
+
     # Creates a transaction for burn asset.
     # @param[String] oa_address The open asset address to burn asset.
     # @param[String] asset_id The asset ID identifying the asset to burn.

data/lib/openassets/send_bitcoin_param.rb

@@ -0,0 +1,13 @@
+module OpenAssets
+
+    class SendBitcoinParam
+      attr_accessor :amount
+      attr_accessor :to
+
+      def initialize(amount, to)
+        @amount = amount
+        @to = to
+      end
+    end
+
+end

data/lib/openassets/transaction/transaction_builder.rb

@@ -48,13 +48,13 @@ module OpenAssets
       def transfer_asset(asset_id, asset_transfer_spec, btc_change_script, fees)
         btc_transfer_spec = OpenAssets::Transaction::TransferParameters.new(
             asset_transfer_spec.unspent_outputs, nil, oa_address_to_address(btc_change_script), 0)
-        transfer([[asset_id, asset_transfer_spec]], btc_transfer_spec, fees)
+        transfer([[asset_id, asset_transfer_spec]], [btc_transfer_spec], fees)
       end
 
       def transfer_assets(transfer_specs, btc_change_script, fees)
         btc_transfer_spec = OpenAssets::Transaction::TransferParameters.new(
             transfer_specs[0][1].unspent_outputs, nil, oa_address_to_address(btc_change_script), 0)
-        transfer(transfer_specs, btc_transfer_spec, fees)
+        transfer(transfer_specs, [btc_transfer_spec], fees)
       end
 
       # Creates a transaction for sending bitcoins.
@@ -62,9 +62,18 @@ module OpenAssets
       # @param[Integer] fees The fees to include in the transaction.
       # @return[Bitcoin::Protocol:Tx] The resulting unsigned transaction.
       def transfer_btc(btc_transfer_spec, fees)
-        transfer([], btc_transfer_spec, fees)
+        transfer_btcs([btc_transfer_spec], fees)
       end
 
+      # Creates a transaction for sending bitcoins to many.
+      # @param[Array[OpenAssets::Transaction::TransferParameters]] btc_transfer_specs The parameters of the bitcoins being transferred.
+      # @param[Integer] fees The fees to include in the transaction.
+      # @return[Bitcoin::Protocol:Tx] The resulting unsigned transaction.
+      def transfer_btcs(btc_transfer_specs, fees)
+        transfer([], btc_transfer_specs, fees)
+      end
+
+
       # Create a transaction for burn asset
       def burn_asset(unspents, asset_id, fee)
         tx = Bitcoin::Protocol::Tx.new
@@ -149,11 +158,18 @@ module OpenAssets
         Bitcoin::Protocol::TxOut.new(value, Bitcoin::Script.new(Bitcoin::Script.to_address_script(address)).to_payload)
       end
 
-      def transfer(asset_transfer_specs, btc_transfer_spec, fees)
-        inputs = []
-        outputs = []
+
+      # create a transaction
+      # @param[Array[OpenAssets::Transaction::TransferParameters]] asset_transfer_specs The parameters of the assets being transferred.
+      # @param[Array[OpenAssets::Transaction::TransferParameters]] btc_transfer_specs The parameters of the bitcoins being transferred.
+      # @param[Integer] fees The fees to include in the transaction.
+      # @return[Bitcoin::Protocol:Tx] The resulting unsigned transaction.
+      def transfer(asset_transfer_specs, btc_transfer_specs, fees)
+        inputs = []     # vin field
+        outputs = []    # vout field
         asset_quantities = []
 
+        # Only when assets are transferred
         asset_based_specs = {}
         asset_transfer_specs.each{|asset_id, transfer_spec|
           asset_based_specs[asset_id] = [] unless asset_based_specs.has_key?(asset_id)
@@ -178,19 +194,35 @@ module OpenAssets
           end
         }
 
+        # End of asset settings
+
+        ## For bitcoins transfer
+        # Assume that there is one address from
+        utxo = btc_transfer_specs[0].unspent_outputs.dup
+
+        # Calculate rest of bitcoins in asset settings
         # btc_excess = inputs(colored) total satoshi - outputs(transfer) total satoshi
-        utxo = btc_transfer_spec.unspent_outputs.dup
         btc_excess = inputs.inject(0) { |sum, i| sum + i.output.value } - outputs.inject(0){|sum, o| sum + o.value}
-        if btc_excess < btc_transfer_spec.amount + fees
+
+        # Calculate total amount of bitcoins to send
+        btc_transfer_total_amount = btc_transfer_specs.inject(0) {|sum, b| sum + b.amount}
+
+        if btc_excess < btc_transfer_total_amount + fees
+          # When there does not exist enough bitcoins to send in the inputs
+          # assign new address (utxo) to the inputs (does not include output coins)
+          # CREATING INPUT (if needed)
           uncolored_outputs, uncolored_amount =
-              TransactionBuilder.collect_uncolored_outputs(utxo, btc_transfer_spec.amount + fees - btc_excess)
+              TransactionBuilder.collect_uncolored_outputs(utxo, btc_transfer_total_amount + fees - btc_excess)
           utxo = utxo - uncolored_outputs
           inputs << uncolored_outputs
           btc_excess += uncolored_amount
         end
 
-        otsuri = btc_excess - btc_transfer_spec.amount - fees
+        otsuri = btc_excess - btc_transfer_total_amount - fees
         if otsuri > 0 && otsuri < @amount
+          # When there exists otsuri, but it is smaller than @amount (default is 600 satoshis)
+          # assign new address (utxo) to the input (does not include @amount - otsuri)
+          # CREATING INPUT (if needed)
           uncolored_outputs, uncolored_amount =
               TransactionBuilder.collect_uncolored_outputs(utxo, @amount - otsuri)
           inputs << uncolored_outputs
@@ -198,28 +230,38 @@ module OpenAssets
         end
 
         if otsuri > 0
-          outputs << create_uncolored_output(btc_transfer_spec.change_script, otsuri)
+          # When there exists otsuri, write it to outputs
+          # CREATING OUTPUT
+          outputs << create_uncolored_output(btc_transfer_specs[0].change_script, otsuri)
         end
 
-        if btc_transfer_spec.amount > 0
-          btc_transfer_spec.split_output_amount.each {|amount|
-            outputs << create_uncolored_output(btc_transfer_spec.to_script, amount)
-          }
-        end
+        btc_transfer_specs.each{|btc_transfer_spec|
+          if btc_transfer_spec.amount > 0
+            # Write output for bitcoin transfer by specifics of the argument
+            # CREATING OUTPUT
+            btc_transfer_spec.split_output_amount.each {|amount|
+              outputs << create_uncolored_output(btc_transfer_spec.to_script, amount)
+            }
+          end
+        }
 
         # add marker output to outputs first.
         unless asset_quantities.empty?
           outputs.unshift(create_marker_output(asset_quantities))
         end
 
+        # create a bitcoin transaction (assembling inputs and output into one transaction)
         tx = Bitcoin::Protocol::Tx.new
+        # for all inputs (vin fields), add sigs to the same transaction
         inputs.flatten.each{|i|
           script_sig = i.output.script.to_binary
           tx_in = Bitcoin::Protocol::TxIn.from_hex_hash(i.out_point.hash, i.out_point.index)
           tx_in.script_sig = script_sig
           tx.add_in(tx_in)
         }
+
         outputs.each{|o|tx.add_out(o)}
+
         tx
       end
 

data/lib/openassets/version.rb

@@ -1,3 +1,3 @@
 module OpenAssets
-  VERSION = '0.4.5'
+  VERSION = '0.4.6'
 end

data/lib/openassets.rb

@@ -10,6 +10,7 @@ module OpenAssets
   autoload :Provider, 'openassets/provider'
   autoload :Error, 'openassets/error'
   autoload :SendAssetParam, 'openassets/send_asset_param'
+  autoload :SendBitcoinParam, 'openassets/send_bitcoin_param'
   autoload :Cache, 'openassets/cache'
 
   class << self

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openassets-ruby
 version: !ruby/object:Gem::Version
-  version: 0.4.5
+  version: 0.4.6
 platform: ruby
 authors:
 - azuchi
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-05-24 00:00:00.000000000 Z
+date: 2016-06-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bitcoin-ruby
@@ -176,6 +176,7 @@ files:
 - lib/openassets/provider/bitcoin_core_provider.rb
 - lib/openassets/provider/block_chain_provider_base.rb
 - lib/openassets/send_asset_param.rb
+- lib/openassets/send_bitcoin_param.rb
 - lib/openassets/transaction.rb
 - lib/openassets/transaction/dust_output_error.rb
 - lib/openassets/transaction/insufficient_asset_quantity_error.rb