openassets-ruby 0.5.9 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b6db9e2095845b0f41f8d2ce916eec8861e17e85
-  data.tar.gz: af64f14eac87c2c661880de228559c2a01857b0b
+  metadata.gz: 6049263ed6d5a4b2352121798443348afcff0d32
+  data.tar.gz: dc1a6b813c3b7c1680ba6812b14b9a1132c2aada
 SHA512:
-  metadata.gz: 2d842c800af1c6ec40bc9e89fdea57e7772c10971331d34b199318540ce65564bd6a547f5b050bcbb5d1c3928088a9e03a3f3db513a15e959e92dd0643e0c2d7
-  data.tar.gz: 1cc45ea3ac9b069f7220f72c24e5c0d94fd06c81af439cf3bd4d0f921c4cbfbf81348f7086f613cbdf8f019533dbe7c9e5fd15324ab89dd2f31053f1744fdb29
+  metadata.gz: b40d7c76bdfd510d9de15c7889269c8aa0792056f700bc721e7f4dced496f7ca4a02ccbc752998b7b75c0d8410c7881b22b0b9e4fa659424116848e9a05867fb
+  data.tar.gz: 98057b6457902d560748f09476db474ba3c7c94aef422eac83fdc4a72576015abef9be942f980acd2762778cb4cf9ff419bb34fa8958efc6521fb1aa662c1834

data/LICENSE

@@ -1,6 +1,7 @@
 The MIT License (MIT)
 
-Copyright (c) 2015 HAW International Inc.
+Copyright (c) 2015-2017 HAW International Inc.
+Copyright (c) 2015-2017 azuchi
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -4,60 +4,86 @@ The implementation of the [Open Assets Protocol](https://github.com/OpenAssets/o
 ## Install
 
 ```ruby
-gem install openassets-ruby              
+gem install openassets-ruby
 ```
 
 ## Configuration
 
 Initialize the connection information to the Bitcoin Core server.
 
-* **use mainnet**  
+* **use mainnet**
 ```ruby
 require 'openassets'
 
-api = OpenAssets::Api.new({:network => 'mainnet',
-                     :provider => 'bitcoind', :cache => 'cache.db',
-                     :dust_limit => 600, :default_fees => 10000, :min_confirmation => 1, :max_confirmation => 9999999,
-                     :rpc => {:user => 'xxx', :password => 'xxx', :schema => 'http', :port => 8332, :host => 'localhost', :timeout => 60, :open_timeout => 60}})
+api = OpenAssets::Api.new({
+    network:           'mainnet',
+    provider:         'bitcoind',
+    cache:            'cache.db',
+    dust_limit:              600,
+    default_fees:          10000,
+    min_confirmation:          1,
+    max_confirmation:    9999999,
+    rpc: {
+      user:                'xxx',
+      password:            'xxx',
+      schema:             'http',
+      port:                 8332,
+      host:          'localhost',
+      timeout:                60,
+      open_timeout:           60 }
+  })
 ```
 
-* **use testnet**  
-change :network and :port(depends on your server setting).
+* **use testnet**
+Change `network` and `port` depending on your server setting.
 ```ruby
 require 'openassets'
 
-api = OpenAssets::Api.new({:network => 'testnet',
-                     :provider => 'bitcoind', :cache => 'testnet.db',
-                     :dust_limit => 600, :default_fees => 10000, :min_confirmation => 1, :max_confirmation => 9999999,
-                     :rpc => {:user => 'xxx', :password => 'xxx', :schema => 'http', :port => 18332, :host => 'localhost', :timeout => 60, :open_timeout => 60}})
+api = OpenAssets::Api.new({
+    network:             'testnet',
+    provider:           'bitcoind',
+    cache:            'testnet.db',
+    dust_limit:                600,
+    default_fees:            10000,
+    min_confirmation:            1,
+    max_confirmation:      9999999,
+    rpc: {
+      user:                  'xxx',
+      password:              'xxx',
+      schema:               'http',
+      port:                  18332,
+      host:            'localhost',
+      timeout:                  60,
+      open_timeout:             60 }
+  })
 ```
 
 The configuration options are as follows:
 
-|option|describe|default|
+|option|description|default|
 |---|---|---|
-|**network**|The using network. "mainnet" or "testnet" or "regtest" |mainnet|
-|**provider**|The RPC server. Specify possible now only "bitcoind".|bitcoind|
-|**cache**|The path to the database file. If you want to use in-memory database, specify ':memory:'. |cache.db|
-|**dust_limit**|The amount of Bitcoin, which is set to the each output of the Open Assets Protocol(issue or transfer).|600 (satoshi)|
-|**default_fees**|The default transaction fee in satoshi. If you want to use auto fee settings, specify ':auto'. (used by issue_asset and send_asset, send_bitcoin )|10000 (satoshi)|
+|**network**|The using network. "mainnet" or "testnet" or "regtest" or "litecoin" or "litecoin_testnet" |mainnet|
+|**provider**|The RPC server. "bitcoind" is the only option for now.|bitcoind|
+|**cache**|The path to the database file. Specify ':memory: to use in-memory database.|cache.db|
+|**dust_limit**|The amount of Bitcoin, which is set to the each output of the Open Assets Protocol (issue or transfer).|600 (satoshi)|
+|**default_fees**|The default transaction fee in satoshi. Specify ':auto' to use auto fee settings. (used by issue_asset and send_asset, send_bitcoin )|10000 (satoshi)|
 |**min_confirmation**|The minimum number of confirmations the transaction containing an output that used to get UTXO.|1|
 |**max_confirmation**|The maximum number of confirmations the transaction containing an output that used to get UTXO.|9999999|
 |**rpc**|The access information to the RPC server of Bitcoin Core.|N/A|
 
 ## API
 
-Currently openassets-ruby support the following API.   
+Currently openassets-ruby support the following API.
 
-* **list_unspent**  
+* **list_unspent**
 Returns an array of unspent transaction outputs, argument with the asset ID and quantity of each output.
   ```ruby
   # get all unspent outputs in the wallet.
   api.list_unspent
-  
+
   # specify th open asset address.
   api.list_unspent(['akTfC7D825Cse4NvFiLCy7vr3B6x2Mpq8t6'])
-  
+
   > [
       {
         "txid": "1610a1f62597a3ea36e09e78354be22d2a958c1a38ed9e5d3f1c2811ee82dc37",
@@ -75,9 +101,9 @@ Returns an array of unspent transaction outputs, argument with the asset ID and
         "proof_of_authenticity": false
       },
       ...
-  ``` 
+  ```
   Output items are as follows.
-  
+
   |Item|description|
   |:---|:---|
   |txid|The TXID of the transaction containing the output.|
@@ -89,16 +115,16 @@ Returns an array of unspent transaction outputs, argument with the asset ID and
   |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_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.|
   |proof_of_authenticity|The result of [Proof of Authenticity](https://github.com/OpenAssets/open-assets-protocol/blob/master/asset-definition-protocol.mediawiki#Proof_of_Authenticity) that is checked consistent with the subject in the SSL certificate. If the result is true, issuer is verified. If the result is false, issuer is not verified. This verification is performed only if link_to_website that is defined in Asset Definition File is true.|
 
-* **get_balance**  
+* **get_balance**
 Returns the balance in both bitcoin and colored coin assets for all of the addresses available in your Bitcoin Core wallet.
   ```ruby
   # get all balance in the wallet.
   api.get_balance
-  
+
   # specify the open asset address.
   api.get_balance('akTfC7D825Cse4NvFiLCy7vr3B6x2Mpq8t6')
   > [
@@ -124,9 +150,9 @@ Returns the balance in both bitcoin and colored coin assets for all of the addre
         ],
         "account": "openassets-ruby"
       },
-  ``` 
+  ```
   Output items are as follows.
-  
+
   |Item|description|
   |:---|:---|
   |address| A P2PKH or P2SH address.|
@@ -135,12 +161,12 @@ Returns the balance in both bitcoin and colored coin assets for all of the addre
   |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_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.|
   |proof_of_authenticity|The result of [Proof of Authenticity](https://github.com/OpenAssets/open-assets-protocol/blob/master/asset-definition-protocol.mediawiki#Proof_of_Authenticity) that is checked consistent with the subject in the SSL certificate. If the result is true, issuer is verified. If the result is false, issuer is not verified. This verification is performed only if link_to_website that is defined in Asset Definition File is true.|
   |account|The name of an account.|
-  
-* **issue_asset**  
+
+* **issue_asset**
 Creates a transaction for issuing an asset.
   ```ruby
   # issue asset
@@ -149,11 +175,11 @@ Creates a transaction for issuing an asset.
   # example
   address = 'akEJwzkzEFau4t2wjbXoMs7MwtZkB8xixmH'
   api.issue_asset(address, 150, 'u=https://goo.gl/bmVEuw', address, nil, 'broadcast')
-  ``` 
-If specified ``output_qty``, the issue output is divided by the number of output_qty.   
+  ```
+If specified ``output_qty``, the issue output is divided by the number of output_qty.
 Ex, amount = 125 and output_qty = 2, the marker output asset quantity is [62, 63] and issue TxOut is two.
 
-* **send_asset**  
+* **send_asset**
 Creates a transaction for sending an asset from the open asset address to another.
   ```ruby
   # send asset
@@ -163,12 +189,12 @@ Creates a transaction for sending an asset from the open asset address to anothe
   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.   
+  ```
+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.  
+
+* **send_bitcoin**
+Creates a transaction for sending bitcoins from an address to another.
 This transaction inputs use only uncolored outputs.
   ```ruby
   # send bitcoin
@@ -178,11 +204,11 @@ This transaction inputs use only uncolored outputs.
   from = '14M4kbAtn71P1nnNYuhBDFTNYxa19t1XP6'
   to = '1MFW7BTwiNbAkmVz4SzAMQXboKYKGSzkq2'
   api.send_bitcoin(from, 60000, to)
-  ``` 
-If specified ``output_qty``, the send output is divided by the number of output_qty.   
+  ```
+If specified ``output_qty``, the send output is divided by the number of output_qty.
 Ex, amount = 60000 and output_qty = 2, send TxOut is two (each value is 30000, 30000) and change TxOut one.
 
-* **get_outputs_from_txid**  
+* **get_outputs_from_txid**
 Get tx outputs. (use for debug)
   ```ruby
   # api.get_outputs_from_txid(<txid>, <use_cache default value is false.>)
@@ -202,10 +228,10 @@ Get tx outputs. (use for debug)
       "txid": "3fba8bfb157ae29c293d5bd65c178fec169a87f880e2e62537fcce26612a6aa3",
       "vout": 1
     },..
-  ``` 
-  
-* **send_assets**  
-Creates a transaction for sending **multiple** asset from the open asset address(es) to another.  
+  ```
+
+* **send_assets**
+Creates a transaction for sending **multiple** asset from the open asset address(es) to another.
 `<from open asset address>` is used to send bitcoins **if** needed, and receive bitcoin change **if** any.
   ```ruby
   # send assets
@@ -218,7 +244,7 @@ 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 assets from multiple addresses.
   change_address = 'mwxeANpckdbdgZCpUMTceQhbbhLPJiqpfD'
   from = [
@@ -232,9 +258,9 @@ Creates a transaction for sending **multiple** asset from the open asset address
   tx = api.send_assets(change_address, params)
   ```
 
-* **send_bitcoins**  
-Creates a transaction for sending **multiple** bitcoins from an address to others.  
-This transaction inputs use only uncolored outputs.  
+* **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.>)
@@ -250,9 +276,9 @@ This transaction inputs use only uncolored outputs.
   ```
 
 
-* **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.  
+* **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.>)
@@ -266,15 +292,15 @@ This API is to burn the asset by spending the all UTXO of specified asset as Bit
 
 ## Command line interface
 
-Openassets-ruby comes with a `openassets` command line interface that allows easy interaction with OpenAssets. 
+Openassets-ruby comes with a `openassets` command line interface that allows easy interaction with OpenAssets.
 
 ### Usage
 
     openassets [options] [command]
-    
-    Options: 
+
+    Options:
     -c path to config JSON which is passed to OpenAssets::Api.new - see Configuration for details
-    -e load conifg from ENV variables (look at the exe/openassets file for details) 
+    -e load conifg from ENV variables (look at the exe/openassets file for details)
 
     commands:
     * console runs an IRB console and gives you an initialized Api instance to interact with OpenAssets
@@ -284,24 +310,4 @@ Openassets-ruby comes with a `openassets` command line interface that allows eas
 
 ## License
 
-The MIT License (MIT)
-
-Copyright (c) 2015 HAW International Inc.
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+openassets-ruby is licensed under the [MIT License](LICENSE).

data/lib/openassets/api.rb

@@ -362,6 +362,10 @@ module OpenAssets
           Bitcoin.network = :testnet3
         when 'regtest'
           Bitcoin.network = :regtest
+        when 'litecoin'
+          Bitcoin.network = :litecoin
+        when 'litecoin_testnet'
+          Bitcoin.network = :litecoin_testnet
         else
           Bitcoin.network = :bitcoin
       end

data/lib/openassets/version.rb

@@ -1,3 +1,3 @@
 module OpenAssets
-  VERSION = '0.5.9'
+  VERSION = '0.6.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openassets-ruby
 version: !ruby/object:Gem::Version
-  version: 0.5.9
+  version: 0.6.0
 platform: ruby
 authors:
 - azuchi
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-12-20 00:00:00.000000000 Z
+date: 2017-02-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bitcoin-ruby
@@ -180,7 +180,6 @@ files:
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE
-- LICENSE.txt
 - README.md
 - Rakefile
 - bin/console

data/LICENSE.txt

@@ -1,22 +0,0 @@
-Copyright (c) 2015 azuchi
-
-MIT License
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.