openassets-ruby 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fa13af5ba17c13c7516e29819722ffc2a7a69766
-  data.tar.gz: d94cc426ab8af56d2e0967f415323c67de17a6f7
+  metadata.gz: ead0fb7292a8d56c01d8894f5bc693e05ae0f8fe
+  data.tar.gz: 4ffbc89805cfc72986233c5cdb1e34ea38bb3186
 SHA512:
-  metadata.gz: 3ebf299dbc652bffa5299bb23ab2cf32862f78cdadfcb010adf8d6a013a680d62b397fac19703de464612fa041ab01fd91959943414c65c9af04b869b3e07b20
-  data.tar.gz: d338cb28973172b73696a1acef698028d54904fef2fdebe7e5148478eff2acea596f65218c185808c35e1f76157b26d651b382347a11a7e991f80cad9831de32
+  metadata.gz: 8ca8fd248203727d065c00bb7c90d177bd3b4b31bd6fec3e85752ee0580fdc034db18e7baad20e644b0aa3fbaa98b29e6f81095067f50fa8a136f1ffe3e729ac
+  data.tar.gz: d6bad60c27e19fc8c2094fcfa889f001d470954e749c408115b2ec6d16a55591768e3919806a7ccbaeecbb69220d90583f220a789a517b8aa00954e3691a524c

data/README.md

@@ -1,6 +1,12 @@
 # openassets-ruby
 The implementation of the Open Assets Protocol for Ruby.
 
+## Install
+
+```ruby
+gem install openassets-ruby              
+```
+
 ## Configuration
 
 Initialize the connection information to the Bitcoin Core server.
@@ -17,7 +23,6 @@ api = OpenAssets::Api.new({:network => 'mainnet',
 ## API
 
 Currently openassets-ruby support the following API.   
-(The other API is in development. ex, send_asset)
 
 * **list_unspent**  
 Returns an array of unspent transaction outputs, argument with the asset ID and quantity of each output.
@@ -49,7 +54,18 @@ Creates a transaction for issuing an asset.
   address = 'akEJwzkzEFau4t2wjbXoMs7MwtZkB8xixmH'
   api.issue_asset(address, 150, 'u=https://goo.gl/bmVEuw', address, nil, 'broadcast')
   ``` 
+* **send_asset**  
+Creates a transaction for sending an asset from the open asset address to another.
+  ```ruby
+  # send asset
+  # api.send_asset(<from open asset address>, <asset ID>, <asset quantity>, <to open asset address>, <fees (The fess in satoshis for the transaction. use 10000 satoshi if specified nil)>, <mode=('broadcast', 'signed', 'unsigned')>)
 
+  # example
+  from = 'akXDPMMHHBrUrd1fM756M1GSB8viVAwMyBk'
+  to = 'akTfC7D825Cse4NvFiLCy7vr3B6x2Mpq8t6'
+  api.send_asset(from, 'AWo3R89p5REmoSyMWB8AeUmud8456bRxZL', 100, to, 10000, 'broadcast')
+  ``` 
+  
 ## License
 
 The MIT License (MIT)

data/lib/openassets/api.rb

@@ -104,6 +104,24 @@ module OpenAssets
       tx
     end
 
+    # Creates a transaction for sending an asset from an address to another.
+    # @param[String] from The open asset address to send the asset from.
+    # @param[String] asset_id The asset ID identifying the asset to send.
+    # @param[Integer] amount The amount of asset units to send.
+    # @param[String] to The open asset address to send the asset to.
+    # @param[Integer] fees The fess 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'
+    def send_asset(from, asset_id, amount, to, fees = nil, mode = 'broadcast')
+      builder = OpenAssets::Transaction::TransactionBuilder.new(@config[:dust_limit])
+      colored_outputs = get_unspent_outputs([oa_address_to_address(from)])
+      send_param = OpenAssets::Transaction::TransferParameters.new(colored_outputs, to, from, amount)
+      tx = builder.transfer_assets(asset_id, send_param, from, fees.nil? ? @config[:default_fees]: fees)
+      tx = process_transaction(tx, mode)
+      tx
+    end
+
     # Get unspent outputs.
     # @param [Array] addresses The array of Bitcoin address.
     # @return [Array[OpenAssets::Transaction::SpendableOutput]] The array of unspent outputs.

data/lib/openassets/protocol/marker_output.rb

@@ -17,7 +17,7 @@ module OpenAssets
 
       # @param [Array] asset_quantities The asset quantity array
       # @param [String] metadata The metadata in the marker output.
-      def initialize(asset_quantities, metadata)
+      def initialize(asset_quantities, metadata = '')
         @asset_quantities = asset_quantities
         @metadata = metadata
       end

data/lib/openassets/transaction/insufficient_asset_quantity_error.rb

@@ -0,0 +1,7 @@
+module OpenAssets
+  module Transaction
+    # An insufficient amount of assets is available.
+    class InsufficientAssetQuantityError < TransactionBuildError
+    end
+  end
+end

data/lib/openassets/transaction/transaction_builder.rb

@@ -11,11 +11,11 @@ module OpenAssets
         @amount = amount
       end
 
-      # issue asset.
+      # Creates a transaction for issuing an asset.
       # @param [TransferParameters] issue_spec The parameters of the issuance.
       # @param [bytes] metadata The metadata to be embedded in the transaction.
       # @param [Integer] fees The fees to include in the transaction.
-      # @return An unsigned transaction for issuing asset.
+      # @return[Bitcoin:Protocol:Tx] An unsigned transaction for issuing asset.
       def issue_asset(issue_spec, metadata, fees)
         inputs, total_amount =
             TransactionBuilder.collect_uncolored_outputs(issue_spec.unspent_outputs, 2 * @amount + fees)
@@ -35,8 +35,59 @@ module OpenAssets
         tx
       end
 
-      def transfer_assets
+      # Creates a transaction for sending an asset.
+      # @param[String] asset_id The ID of the asset being sent.
+      # @param[OpenAssets::Transaction::TransferParameters] transfer_spec The parameters of the asset being transferred.
+      # @param[String] btc_change_script The script where to send bitcoin change, if any.
+      # @param[Integer] fees The fees to include in the transaction.
+      # @return[Bitcoin::Protocol:Tx] The resulting unsigned transaction.
+      def transfer_assets(asset_id, transfer_spec, btc_change_script, fees)
+        btc_transfer_spec = OpenAssets::Transaction::TransferParameters.new(transfer_spec.unspent_outputs, nil, btc_change_script, 0)
+        outputs = []
+        asset_quantities = []
+        inputs, total_amount = TransactionBuilder.collect_colored_outputs(transfer_spec.unspent_outputs, asset_id, transfer_spec.amount)
 
+        # add asset transfer outpu
+        outputs << create_colored_output(oa_address_to_address(transfer_spec.to_script))
+        asset_quantities << transfer_spec.amount
+
+        # add the rest of the asset to the origin address
+        if total_amount > transfer_spec.amount
+          outputs << create_colored_output(oa_address_to_address(transfer_spec.change_script))
+          asset_quantities << (total_amount - transfer_spec.amount)
+        end
+
+        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
+          uncolored_outputs, uncolored_amount =
+              TransactionBuilder.collect_uncolored_outputs(btc_transfer_spec.unspent_outputs, btc_transfer_spec.amount + fees - btc_excess)
+          inputs << uncolored_outputs
+          btc_excess += uncolored_amount
+        end
+
+        change = btc_excess - btc_transfer_spec.amount - fees
+        if change > 0
+          outputs << create_uncolored_output(oa_address_to_address(btc_transfer_spec.change_script), change)
+        end
+
+        if btc_transfer_spec.amount > 0
+          outputs << create_uncolored_output(oa_address_to_address(btc_transfer_spec.to_script), btc_transfer_spec.amount)
+        end
+
+        # add marker output to outputs first.
+        unless asset_quantities.empty?
+          outputs.unshift(create_marker_output(asset_quantities))
+        end
+
+        tx = Bitcoin::Protocol::Tx.new
+        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
 
       def transfer_btc
@@ -60,6 +111,24 @@ module OpenAssets
         raise InsufficientFundsError
       end
 
+      # Returns a list of colored outputs for the specified quantity.
+      # @param[Array[OpenAssets::Transaction::SpendableOutput]] unspent_outputs
+      # @param[String] asset_id The ID of the asset to collect.
+      # @param[Integer] asset_quantity The asset quantity to collect.
+      # @return[Array[OpenAssets::Transaction::SpendableOutput], int] A list of outputs, and the total asset quantity collected.
+      def self.collect_colored_outputs(unspent_outputs, asset_id, asset_quantity)
+        total_amount = 0
+        result = []
+        unspent_outputs.each do |output|
+          if output.output.asset_id == asset_id
+            result << output
+            total_amount += output.output.asset_quantity
+          end
+          return result, total_amount if total_amount >= asset_quantity
+        end
+        raise InsufficientAssetQuantityError
+      end
+
       private
       # create colored output.
       # @param [String] address The Bitcoin address.
@@ -74,7 +143,7 @@ module OpenAssets
       # @param [Array] asset_quantities asset_quantity array.
       # @param [String] metadata
       # @return [Bitcoin::Protocol::TxOut] the marker output.
-      def create_marker_output(asset_quantities, metadata)
+      def create_marker_output(asset_quantities, metadata = '')
         script = OpenAssets::Protocol::MarkerOutput.new(asset_quantities, metadata).build_script
         Bitcoin::Protocol::TxOut.new(0, script.to_payload)
       end

data/lib/openassets/transaction.rb

@@ -6,6 +6,7 @@ module OpenAssets
     autoload :OutPoint, 'openassets/transaction/out_point'
     autoload :TransactionBuildError, 'openassets/transaction/transaction_build_error'
     autoload :InsufficientFundsError, 'openassets/transaction/insufficient_funds_error'
+    autoload :InsufficientAssetQuantityError, 'openassets/transaction/insufficient_asset_quantity_error'
     autoload :DustOutputError, 'openassets/transaction/dust_output_error'
   end
 end

data/lib/openassets/version.rb

@@ -1,3 +1,3 @@
 module OpenAssets
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openassets-ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - azuchi
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-08-07 00:00:00.000000000 Z
+date: 2015-08-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bitcoin-ruby
@@ -126,6 +126,7 @@ files:
 - lib/openassets/provider/block_chain_provider_base.rb
 - lib/openassets/transaction.rb
 - lib/openassets/transaction/dust_output_error.rb
+- lib/openassets/transaction/insufficient_asset_quantity_error.rb
 - lib/openassets/transaction/insufficient_funds_error.rb
 - lib/openassets/transaction/out_point.rb
 - lib/openassets/transaction/spendable_output.rb