openassets-ruby 0.1.6 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ab88032ced409505e81e4ce0ed7ec27e59b61e3c
-  data.tar.gz: d2b86f52973527638af824c70fbd2a57c734b5cc
+  metadata.gz: c4b3524d199fabcdbcb114a60fdc5ccb72537dfa
+  data.tar.gz: b6b4e4073d70fd1328c56758600de98bb702872c
 SHA512:
-  metadata.gz: 4a95fda64c3b67b08c1f8496628a095800f79a23fb323362f5d4d8813a4cdb44e62890eecf78ef7908344c36a9a63ad28e16a04d79c925bf45e22286adfc82df
-  data.tar.gz: efd6548365827737a57d08dde0740bfaa0c2c8ba9426c4357ad5b02e4176f56935edccb81f553e2d45de3e5f2d778470a17a7755459c8bc27f612aeae72250f3
+  metadata.gz: 4979c48dcc97d4d3d0bd40cfa2750b4ed8c309e791f9ee670ebe1688b702432a9d55c5c85161190a77e0e789887f336cc07ec82fa38689e5c3c774b962099f83
+  data.tar.gz: c9549400f7c66178df05cebb6441db3da8b0605e1c124ed938415bee3d1804d79c2d9a9748b2115cad6ae3e0a0e6457614b91aa15f59344f35147d1273f7bd94

data/README.md

@@ -32,7 +32,39 @@ Returns an array of unspent transaction outputs, argument with the asset ID and
   
   # specify th open asset address.
   api.list_unspent(['akTfC7D825Cse4NvFiLCy7vr3B6x2Mpq8t6'])
+  
+  > [
+      {
+        "txid": "1610a1f62597a3ea36e09e78354be22d2a958c1a38ed9e5d3f1c2811ee82dc37",
+        "vout": 1,
+        "address": "1HhJs3JgbiyxC8ktfi6nU4wTqVmrMtCVkG",
+        "oa_address": "akTfC7D825Cse4NvFiLCy7vr3B6x2Mpq8t6",
+        "script": "76a914b7218fe503cd18555255e5b13d4f07f3fd00d0c988ac",
+        "amount": "0.00000600",
+        "confirmations": 8338,
+        "asset_id": "AWo3R89p5REmoSyMWB8AeUmud8456bRxZL",
+        "account": "openassets-ruby",
+        "asset_quantity": "67",
+        "asset_amount": "6.7",
+        "asset_definition_url": "http://goo.gl/fS4mEj"
+      },
+      ...
   ``` 
+  Output items are as follows.
+  
+  |Item|description|
+  |:---|:---|
+  |txid|The TXID of the transaction containing the output.|
+  |address| A P2PKH or P2SH address.|
+  |oa_address|The Open Asset address.|
+  |script|The output script.|
+  |amount|The Bitcoin amount.|
+  |confirmations|A score indicating the number of blocks on the best block chain that would need to be modified to remove or modify a particular transaction. |
+  |asset_id|The asset ID is a 160 bits hash, used to uniquely identify the asset stored on the output.|
+  |account|The name of an account.|
+  |asset_quantity|The asset quantity is an unsigned integer representing how many units of that asset are stored on the output.|
+  |asset_amount| The asset amount is the value obtained by converting the asset quantity to the unit of divisibility that are defined in the Asset definition file. |  
+  |asset_definition_url|The url of asset definition file.|
 
 * **get_balance**  
 Returns the balance in both bitcoin and colored coin assets for all of the addresses available in your Bitcoin Core wallet.
@@ -42,7 +74,41 @@ Returns the balance in both bitcoin and colored coin assets for all of the addre
   
   # specify the open asset address.
   api.get_balance('akTfC7D825Cse4NvFiLCy7vr3B6x2Mpq8t6')
+  > [
+      {
+        "address": "1HhJs3JgbiyxC8ktfi6nU4wTqVmrMtCVkG",
+        "oa_address": "akTfC7D825Cse4NvFiLCy7vr3B6x2Mpq8t6",
+        "value": "0.00018200",
+        "assets": [
+          {
+            "asset_id": "AWo3R89p5REmoSyMWB8AeUmud8456bRxZL",
+            "quantity": "81",
+            "amount": "20.7",
+            "asset_definition_url": "http://goo.gl/fS4mEj"
+          },
+          {
+            "asset_id": "AJk2Gx5V67S2wNuwTK5hef3TpHunfbjcmX",
+            "quantity": "67",
+            "amount": "6.7",
+            "asset_definition_url": ""
+          }
+        ],
+        "account": "openassets-ruby"
+      },
   ``` 
+  Output items are as follows.
+  
+  |Item|description|
+  |:---|:---|
+  |address| A P2PKH or P2SH address.|
+  |oa_address|The Open Asset address.|
+  |value|The Bitcoin amount.|
+  |assets|The array of the assets.|
+  |asset_id|The asset ID is a 160 bits hash, used to uniquely identify the asset stored on the output.|
+  |asset_quantity|The asset quantity is an unsigned integer representing how many units of that asset are stored on the output.|
+  |asset_amount| The asset amount is the value obtained by converting the asset quantity to the unit of divisibility that are defined in the Asset definition file. |  
+  |asset_definition_url|The url of asset definition file.|
+  |account|The name of an account.|
   
 * **issue_asset**  
 Creates a transaction for issuing an asset.
@@ -61,13 +127,15 @@ Ex, amount = 125 and output_qty = 2, the marker output asset quantity is [62, 63
 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')>)
+  # 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')>, <output_qty default value is 1.>)
 
   # example
   from = 'akXDPMMHHBrUrd1fM756M1GSB8viVAwMyBk'
   to = 'akTfC7D825Cse4NvFiLCy7vr3B6x2Mpq8t6'
   api.send_asset(from, 'AWo3R89p5REmoSyMWB8AeUmud8456bRxZL', 100, to, 10000, 'broadcast')
   ``` 
+If specified ``output_qty``, the send output is divided by the number of output_qty.   
+Ex, asset holding amount = 200, and send  amount = 125 and output_qty = 2, the marker output asset quantity is [62, 63, 75] and send TxOut is three. The last of the asset quantity is change asset output.
   
 * **send_bitcoin**  
 Creates a transaction for sending bitcoins from an address to another.  

data/lib/openassets/api.rb

@@ -53,6 +53,8 @@ module OpenAssets
           'asset_id' => out.output.asset_id,
           'account' => out.output.account,
           'asset_quantity' => out.output.asset_quantity.to_s,
+          'asset_amount' => out.output.asset_amount.to_s,
+          'asset_definition_url' => out.output.asset_definition_url
         }
       }
       oa_address.empty? ? result : result.select{|r|oa_address.include?(r['oa_address'])}
@@ -72,7 +74,9 @@ module OpenAssets
         assets = group_assets.map{|asset_id, outputs|
           {
               'asset_id' => asset_id,
-              'quantity' => outputs.inject(0) { |sum, o| sum + o.asset_quantity }.to_s
+              'quantity' => outputs.inject(0) { |sum, o| sum + o.asset_quantity }.to_s,
+              'amount' => outputs.inject(0) { |sum, o| sum + o.asset_amount }.to_s,
+              'asset_definition_url' => outputs[0].asset_definition_url
           }
         }
         {
@@ -197,11 +201,13 @@ module OpenAssets
     # @param [Array[OpenAssets::Protocol::TransactionOutput] inputs The outputs referenced by the inputs of the transaction.
     # @param [Integer] marker_output_index The position of the marker output in the transaction.
     # @param [Array[Bitcoin::Protocol::TxOUt]] outputs The outputs of the transaction.
-    # @param [Array[Integer]] asset_quantities The list of asset quantities of the outputs.
+    # @param [Array[OpenAssets::Protocol::TransactionOutput]] asset_quantities The list of asset quantities of the outputs.
     def compute_asset_ids(inputs, marker_output_index, outputs, asset_quantities)
       return nil if asset_quantities.length > outputs.length - 1 || inputs.length == 0
       result = []
 
+      marker_output = outputs[marker_output_index]
+
       # Add the issuance outputs
       issuance_asset_id = pubkey_hash_to_asset_id(inputs[0].script.get_hash160)
 
@@ -209,7 +215,14 @@ module OpenAssets
         value = outputs[i].value
         script = outputs[i].parsed_script
         if i < asset_quantities.length && asset_quantities[i] > 0
-          output = OpenAssets::Protocol::TransactionOutput.new(value, script, issuance_asset_id, asset_quantities[i], OpenAssets::Protocol::OutputType::ISSUANCE)
+          payload = OpenAssets::Protocol::MarkerOutput.parse_script(marker_output.parsed_script.to_payload)
+          metadata = OpenAssets::Protocol::MarkerOutput.deserialize_payload(payload).metadata
+          if metadata.nil?
+            output = OpenAssets::Protocol::TransactionOutput.new(value, script, issuance_asset_id, asset_quantities[i], OpenAssets::Protocol::OutputType::ISSUANCE)
+          else
+            output = OpenAssets::Protocol::TransactionOutput.new(
+                value, script, issuance_asset_id, asset_quantities[i], OpenAssets::Protocol::OutputType::ISSUANCE, metadata)
+          end
         else
           output = OpenAssets::Protocol::TransactionOutput.new(value, script, nil, 0, OpenAssets::Protocol::OutputType::ISSUANCE)
         end
@@ -217,7 +230,6 @@ module OpenAssets
       end
 
       # Add the marker output
-      marker_output = outputs[marker_output_index]
       result << OpenAssets::Protocol::TransactionOutput.new(marker_output.value, marker_output.parsed_script, nil, 0, OpenAssets::Protocol::OutputType::MARKER_OUTPUT)
 
       # Add the transfer outputs
@@ -228,6 +240,7 @@ module OpenAssets
         output_asset_quantity = (i <= asset_quantities.length) ? asset_quantities[i-1] : 0
         output_units_left = output_asset_quantity
         asset_id = nil
+        metadata = nil
         while output_units_left > 0
           index += 1
           if input_units_left == 0
@@ -245,13 +258,14 @@ module OpenAssets
             if asset_id.nil?
               # This is the first input to map to this output
               asset_id = current_input.asset_id
+              metadata = current_input.metadata
             elsif asset_id != current_input.asset_id
               return nil
             end
           end
         end
         result << OpenAssets::Protocol::TransactionOutput.new(outputs[i].value, outputs[i].parsed_script,
-                                                              asset_id, output_asset_quantity, OpenAssets::Protocol::OutputType::TRANSFER)
+                                                              asset_id, output_asset_quantity, OpenAssets::Protocol::OutputType::TRANSFER, metadata)
       end
       result
     end

data/lib/openassets/protocol/marker_output.rb

@@ -1,3 +1,4 @@
+require 'rest-client'
 module OpenAssets
   module Protocol
 
@@ -45,7 +46,7 @@ module OpenAssets
         list = to_bytes(payload).map{|x|(x.to_i(16)>=128 ? x : x+"|")}.join.split('|')[0..(asset_quantity - 1)].join
         asset_quantities = decode_leb128(list)
         meta = to_bytes(payload[list.size..-1])
-        metadata = meta[1..-1].map{|x|x.to_i(16).chr}.join
+        metadata =  meta.empty? ? '' : meta[1..-1].map{|x|x.to_i(16).chr}.join
         new(asset_quantities, metadata)
       end
 

data/lib/openassets/protocol/transaction_output.rb

@@ -1,3 +1,5 @@
+require 'rest-client'
+
 module OpenAssets
   module Protocol
 
@@ -10,20 +12,79 @@ module OpenAssets
       attr_accessor :output_type
 
       attr_accessor :account
+      attr_accessor :metadata
+      attr_accessor :asset_definition_url
+      attr_accessor :valid_asset_definition
+
 
       # @param [Integer] value The satoshi value of the output.
       # @param [Bitcoin::Script] script The script controlling redemption of the output.
       # @param [String] asset_id The asset ID of the output.
       # @param [Integer] asset_quantity The asset quantity of the output.
       # @param [OpenAssets::Transaction::OutPutType] output_type The type of the output.
-      def initialize(value, script, asset_id = nil, asset_quantity = 0, output_type = OutputType::UNCOLORED)
+      def initialize(value, script, asset_id = nil, asset_quantity = 0, output_type = OutputType::UNCOLORED, metadata = '')
         raise ArgumentError, "invalid output_type : #{output_type}" unless OutputType.all.include?(output_type)
-        raise ArgumentError, "invalid asset_quantity asset_quantity should be unsignd integer. " unless asset_quantity.between?(0, MarkerOutput::MAX_ASSET_QUANTITY)
+        raise ArgumentError, "invalid asset_quantity. asset_quantity should be unsignd integer. " unless asset_quantity.between?(0, MarkerOutput::MAX_ASSET_QUANTITY)
         @value = value
         @script = script
         @asset_id = asset_id
         @asset_quantity = asset_quantity
         @output_type = output_type
+        @metadata = metadata
+        load_asset_definition_url
+      end
+
+      # calculate asset amount.
+      # asset amount is the value obtained by converting the asset quantity to the unit of divisibility that are defined in the Asset definition file.
+      def asset_amount
+        d = divisibility
+        d > 0 ? (@asset_quantity.to_f / (10 ** d)).to_f : @asset_quantity
+      end
+
+      # get divisibility defined by asset definition file.
+      def divisibility
+        json = metadata_to_json
+        if json.nil? || json.length == 0
+          return 0
+        else
+          return json['divisibility']
+        end
+      end
+
+      # get Asset definition url that is included metadata.
+      private
+      def load_asset_definition_url
+        @valid_asset_definition = true
+        @asset_definition_url = ''
+        return if @metadata.nil? || @metadata.length == 0
+        if @metadata.start_with?('u=')
+          json = metadata_to_json
+          if json['asset_ids'].include?(@asset_id)
+            @asset_definition_url = metadata_url
+          else
+            @asset_definition_url = "The asset definition is invalid. #{metadata_url}"
+            @valid_asset_definition = false
+          end
+        else
+          @asset_definition_url = 'Invalid metadata format.'
+          @valid_asset_definition = false
+        end
+      end
+
+      private
+      def metadata_to_json
+        url = metadata_url
+        if url.nil?
+          ''
+        else
+          JSON.parse(RestClient.get url, :accept => :json)
+        end
+      end
+
+      def metadata_url
+        unless @metadata.nil?
+           @metadata.slice(2..-1)
+        end
       end
     end
 

data/lib/openassets/transaction/transaction_builder.rb

@@ -30,12 +30,8 @@ module OpenAssets
         from_address = oa_address_to_address(issue_spec.change_script)
         validate_address([issue_address, from_address])
         asset_quantities =[]
-        issue_spec.output_qty.times {|index|
-          if index == issue_spec.output_qty - 1
-            asset_quantities[index] = issue_spec.amount / issue_spec.output_qty + issue_spec.amount % issue_spec.output_qty
-          else
-            asset_quantities[index] = issue_spec.amount / issue_spec.output_qty
-          end
+        issue_spec.split_output_amount.each{|amount|
+          asset_quantities << amount
           tx.add_out(create_colored_output(issue_address))
         }
         tx.add_out(create_marker_output(asset_quantities, metadata))
@@ -136,12 +132,7 @@ module OpenAssets
           inputs = inputs + colored_outputs
 
           # add asset transfer output
-          transfer_spec.output_qty.times{|index|
-            if index == transfer_spec.output_qty - 1
-              amount = transfer_spec.amount / transfer_spec.output_qty + transfer_spec.amount % transfer_spec.output_qty
-            else
-              amount = transfer_spec.amount / transfer_spec.output_qty
-            end
+          transfer_spec.split_output_amount.each {|amount|
             outputs << create_colored_output(oa_address_to_address(transfer_spec.to_script))
             asset_quantities << amount
           }
@@ -168,12 +159,7 @@ module OpenAssets
         end
 
         if btc_transfer_spec.amount > 0
-          btc_transfer_spec.output_qty.times {|index|
-            if index == btc_transfer_spec.output_qty - 1
-              amount = btc_transfer_spec.amount / btc_transfer_spec.output_qty + btc_transfer_spec.amount % btc_transfer_spec.output_qty
-            else
-              amount = btc_transfer_spec.amount / btc_transfer_spec.output_qty
-            end
+          btc_transfer_spec.split_output_amount.each {|amount|
             outputs << create_uncolored_output(btc_transfer_spec.to_script, amount)
           }
         end

data/lib/openassets/transaction/transfer_parameters.rb

@@ -23,6 +23,18 @@ module OpenAssets
         @output_qty = output_qty
       end
 
+      def split_output_amount
+        split_amounts = []
+        output_qty.times{|index|
+          if index == output_qty - 1
+            value = amount / output_qty + amount % output_qty
+          else
+            value = amount / output_qty
+          end
+          split_amounts << value
+        }
+        split_amounts
+      end
     end
 
   end

data/lib/openassets/version.rb

@@ -1,3 +1,3 @@
 module OpenAssets
-  VERSION = "0.1.6"
+  VERSION = "0.1.7"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openassets-ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.7
 platform: ruby
 authors:
 - azuchi
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-08-29 00:00:00.000000000 Z
+date: 2015-10-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bitcoin-ruby