openassets-ruby 0.3.3 → 0.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 55f541af3749707d21e550e2fa82882062a203f1
-  data.tar.gz: 00909d9fb3f0eef92d696b1fd97ed34554c5c805
+  metadata.gz: bcc95426e060b6c7e00a0e7e42ddb497ea4621d5
+  data.tar.gz: f50086936278851d11ed8136e7ab19a210f87efe
 SHA512:
-  metadata.gz: 748937bd4d011a5ee5b62a3527c032a230ad154812526fc0dccf01127dca1213c7bd90fd21a03d4c37c05b254f3a3c1a4760d30237b052a11bb20432d18aa3df
-  data.tar.gz: 5c97eb9169a61a16b645fcf697d63f09fcefa2fd78c96b64208e6d4d9c81fc5b202f089a1f7b3b3b919224ccace384a9f0b575b2f3454fbfc39ac21e5e6b8293
+  metadata.gz: 2ea9d0902779030e3b9a80174bc5646c714f60904298d5a3196556920bd3eecf34ec6c805db40ae68c9f338c7c6a071c2f089b1c89ad34e559f81045183be35a
+  data.tar.gz: 94b2f561b2c7601faf9b7388253fa84baf32db56e203306d19d3541ff5a9afad3707cd5ad288b55bfda0aef1f38a782b908b569398d6c2cca14957bc15dc3aa3

data/README.md

@@ -215,6 +215,21 @@ Creates a transaction for sending **multiple** asset from the open asset address
   tx = api.send_assets(from, params)
   ``` 
 
+* **burn_asset**  
+Creates a transaction for burn asset.  
+This API is to burn the asset by spending the all UTXO of specified asset as Bitcoin.  
+  ```ruby
+  # burn_asset
+  # api.burn_asset(<from open asset address>, <asset ID>,, <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
+  oa_address = 'bX2vhttomKj2fdd7SJV2nv8U4zDjusE5Y4B'
+  asset_id = 'oGu4VXx2TU97d9LmPP8PMCkHckkcPqC5RY'
+  tx = api.burn_asset(oa_address, asset_id, 10000)
+  ```
+  
+**Note:** Burned asset will not be able to again get.
+
 ## Command line interface
 
 Openassets-ruby comes with a `openassets` command line interface that allows easy interaction with OpenAssets. 

data/lib/openassets/api.rb

@@ -93,10 +93,9 @@ module OpenAssets
     # @return[Bitcoin::Protocol::Tx] The Bitcoin::Protocol::Tx object.
     def issue_asset(from, amount, metadata = nil, to = nil, fees = nil, mode = 'broadcast', output_qty = 1)
       to = from if to.nil?
-      builder = OpenAssets::Transaction::TransactionBuilder.new(@config[:dust_limit])
       colored_outputs = get_unspent_outputs([oa_address_to_address(from)])
       issue_param = OpenAssets::Transaction::TransferParameters.new(colored_outputs, to, from, amount, output_qty)
-      tx = builder.issue_asset(issue_param, metadata, fees.nil? ? @config[:default_fees]: fees)
+      tx = create_tx_builder.issue_asset(issue_param, metadata, fees.nil? ? @config[:default_fees]: fees)
       tx = process_transaction(tx, mode)
       tx
     end
@@ -112,10 +111,9 @@ module OpenAssets
     # 'unsigned' for getting the raw unsigned transaction without broadcasting"""='broadcast'
     # @return[Bitcoin::Protocol:Tx] The resulting transaction.
     def send_asset(from, asset_id, amount, to, fees = nil, mode = 'broadcast', output_qty = 1)
-      builder = OpenAssets::Transaction::TransactionBuilder.new(@config[:dust_limit])
       colored_outputs = get_unspent_outputs([oa_address_to_address(from)])
       asset_transfer_spec = OpenAssets::Transaction::TransferParameters.new(colored_outputs, to, from, amount, output_qty)
-      tx = builder.transfer_asset(asset_id, asset_transfer_spec, from, fees.nil? ? @config[:default_fees]: fees)
+      tx = create_tx_builder.transfer_asset(asset_id, asset_transfer_spec, from, fees.nil? ? @config[:default_fees]: fees)
       tx = process_transaction(tx, mode)
       tx
     end
@@ -129,12 +127,11 @@ module OpenAssets
     # 'unsigned' for getting the raw unsigned transaction without broadcasting"""='broadcast'
     # @return[Bitcoin::Protocol:Tx] The resulting transaction.
     def send_assets(from, send_asset_params, fees = nil, mode = 'broadcast')
-      builder = OpenAssets::Transaction::TransactionBuilder.new(@config[:dust_limit])
       colored_outputs = get_unspent_outputs([oa_address_to_address(from)])
       transfer_specs = send_asset_params.map{|param|
         [param.asset_id, OpenAssets::Transaction::TransferParameters.new(colored_outputs, param.to, from, param.amount)]
       }
-      tx = builder.transfer_assets(transfer_specs, from, fees.nil? ? @config[:default_fees]: fees)
+      tx = create_tx_builder.transfer_assets(transfer_specs, from, fees.nil? ? @config[:default_fees]: fees)
       tx = process_transaction(tx, mode)
       tx
     end
@@ -152,10 +149,22 @@ module OpenAssets
     # @return[Bitcoin::Protocol:Tx] The resulting transaction.
     def send_bitcoin(from, amount, to, fees = nil, mode = 'broadcast', output_qty = 1)
       validate_address([from, to])
-      builder = OpenAssets::Transaction::TransactionBuilder.new(@config[:dust_limit])
       colored_outputs = get_unspent_outputs([from])
       btc_transfer_spec = OpenAssets::Transaction::TransferParameters.new(colored_outputs, to, from, amount, output_qty)
-      tx = builder.transfer_btc(btc_transfer_spec, fees.nil? ? @config[:default_fees]: fees)
+      tx = create_tx_builder.transfer_btc(btc_transfer_spec, fees.nil? ? @config[:default_fees]: fees)
+      process_transaction(tx, mode)
+    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.
+    # @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 burn_asset(oa_address, asset_id, fees = nil, mode = 'broadcast')
+      unspents = get_unspent_outputs([oa_address_to_address(oa_address)])
+      tx = create_tx_builder.burn_asset(unspents, asset_id, fees.nil? ? @config[:default_fees]: fees)
       process_transaction(tx, mode)
     end
 
@@ -309,6 +318,10 @@ module OpenAssets
       end
     end
 
+    def create_tx_builder
+      OpenAssets::Transaction::TransactionBuilder.new(@config[:dust_limit])
+    end
+
   end
 
 end

data/lib/openassets/protocol/transaction_output.rb

@@ -54,7 +54,6 @@ module OpenAssets
 
       # convert to hash object.
       def to_hash
-        address = script_to_address(@script)
         {
             'address' =>  address,
             'oa_address' => address.nil? ? nil : address_to_oa_address(address),
@@ -63,14 +62,14 @@ module OpenAssets
             'asset_id' => @asset_id,
             'asset_quantity' => @asset_quantity.to_s,
             'asset_amount' => asset_amount.to_s,
-            'account' => account,
+            'account' => @account,
             'asset_definition_url' => @asset_definition_url,
             'proof_of_authenticity' => proof_of_authenticity
         }
       end
 
-      def account
-        @account.nil? ? nil : @account.encode('ISO-8859-1').force_encoding('UTF-8')
+      def address
+        script_to_address(@script)
       end
 
       private

data/lib/openassets/provider/bitcoin_core_provider.rb

@@ -106,7 +106,7 @@ module OpenAssets
           :id => 'jsonrpc'
         }
         RestClient.post(server_url, data.to_json, content_type: :json) do |respdata, request, result|
-          response = JSON.parse(respdata)
+          response = JSON.parse(respdata.gsub(/\\u([\da-fA-F]{4})/) { [$1].pack('H*').unpack('n*').pack('U*').encode('ISO-8859-1').force_encoding('UTF-8') })
           raise ApiError, response['error'] if response['error']
           response['result']
         end

data/lib/openassets/transaction/transaction_builder.rb

@@ -65,6 +65,29 @@ module OpenAssets
         transfer([], btc_transfer_spec, fees)
       end
 
+      # Create a transaction for burn asset
+      def burn_asset(unspents, asset_id, fee)
+        tx = Bitcoin::Protocol::Tx.new
+        targets = unspents.select{|o|o.output.asset_id == asset_id}
+        raise TransactionBuildError.new('There is no asset.') if targets.length == 0
+        total_amount = targets.inject(0){|sum, o|o.output.value + sum}
+        otsuri = total_amount - fee
+        if otsuri < @amount
+          uncolored_outputs, uncolored_amount =
+            TransactionBuilder.collect_uncolored_outputs(unspents, @amount - otsuri)
+          targets = targets + uncolored_outputs
+          otsuri += uncolored_amount
+        end
+        targets.each{|o|
+          script_sig = o.output.script.to_binary
+          tx_in = Bitcoin::Protocol::TxIn.from_hex_hash(o.out_point.hash, o.out_point.index)
+          tx_in.script_sig = script_sig
+          tx.add_in(tx_in)
+        }
+        tx.add_out(create_uncolored_output(targets[0].output.address, otsuri))
+        tx
+      end
+
       # collect uncolored outputs in unspent outputs(contains colored output).
       # @param [Array[OpenAssets::Transaction::SpendableOutput]] unspent_outputs The Array of available outputs.
       # @param [Integer] amount The amount to collect.

data/lib/openassets/util.rb

@@ -99,6 +99,16 @@ module OpenAssets
       }
     end
 
+    # validate asset ID
+    def valid_asset_id?(asset_id)
+      return false if asset_id.nil? || asset_id.length != 34
+      decoded = decode_base58(asset_id)
+      return false if  decoded[0,2].to_i(16) != oa_version_byte
+      p2pkh_script_hash = decoded[2..-9]
+      address = hash160_to_address(p2pkh_script_hash)
+      valid_address?(address)
+    end
+
     # generate Asset ID from open asset address.
     def oa_address_to_asset_id(oa_address)
       address_to_asset_id(oa_address_to_address(oa_address))

data/lib/openassets/version.rb

@@ -1,3 +1,3 @@
 module OpenAssets
-  VERSION = '0.3.3'
+  VERSION = '0.3.4'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openassets-ruby
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.3.4
 platform: ruby
 authors:
 - azuchi
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-02-02 00:00:00.000000000 Z
+date: 2016-02-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bitcoin-ruby