openassets-ruby 0.3.4 → 0.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bcc95426e060b6c7e00a0e7e42ddb497ea4621d5
-  data.tar.gz: f50086936278851d11ed8136e7ab19a210f87efe
+  metadata.gz: 10d7759652e07b134eee52b630c86a5694bf9370
+  data.tar.gz: dacced4d83bbc49aa52cf6aa2eed2a1d6e83d6a4
 SHA512:
-  metadata.gz: 2ea9d0902779030e3b9a80174bc5646c714f60904298d5a3196556920bd3eecf34ec6c805db40ae68c9f338c7c6a071c2f089b1c89ad34e559f81045183be35a
-  data.tar.gz: 94b2f561b2c7601faf9b7388253fa84baf32db56e203306d19d3541ff5a9afad3707cd5ad288b55bfda0aef1f38a782b908b569398d6c2cca14957bc15dc3aa3
+  metadata.gz: 0ea0b2089ab5bda555d36b599e080b104b95f86587330f9836e6c07c32151d92b8545e24a2c4badb66597c24af728016b90ac96c328a35850f78562b37a6a0fb
+  data.tar.gz: 93582e63690146c92f6794f72ea6fb590a98e7dc68c848dd4f1fa04dfad1263b9db7705ddd47961592b91362acb9a9b1217c14064317f6d97beced0442d673ce

data/.gitignore

@@ -9,3 +9,4 @@
 /tmp/
 .idea
 *.iml
+cache.db

data/README.md

@@ -16,7 +16,7 @@ Initialize the connection information to the Bitcoin Core server.
 require 'openassets'
 
 api = OpenAssets::Api.new({:network => 'mainnet',
-                     :provider => 'bitcoind',
+                     :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'}})                      
 ```
@@ -27,7 +27,7 @@ change :network and :port(depends on your server setting).
 require 'openassets'
 
 api = OpenAssets::Api.new({:network => 'testnet',
-                     :provider => 'bitcoind',
+                     :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'}})                      
 ```
@@ -38,6 +38,7 @@ The configuration options are as follows:
 |---|---|---|
 |**network**|The using network. "mainnet" or "testnet" |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 transaction fee. (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|
@@ -227,7 +228,6 @@ This API is to burn the asset by spending the all UTXO of specified asset as Bit
   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

data/exe/openassets

@@ -32,6 +32,7 @@ if options[:env]
   config = {
     :network	    => ENV['OA_NETWORK'] || 'mainnet',
     :provider     => 'bitcoind',
+    :cache        => ENV['OA_CACHE'] || 'cache.db',
     :dust_limit   => (ENV['OA_DUST_LIMIT'] || 600).to_i,
     :default_fees => (ENV['OA_DEFAULT_FEES'] || 10000).to_i,
     :rpc					=> rpc

data/lib/openassets/api.rb

@@ -11,12 +11,11 @@ module OpenAssets
 
     attr_reader :config
     attr_reader :provider
-    attr_reader :cache
+    attr_reader :tx_cache
 
     def initialize(config = nil)
-      @cache = {}
       @config = {:network => 'mainnet',
-                 :provider => 'bitcoind',
+                 :provider => 'bitcoind', :cache => 'cache.db',
                  :dust_limit => 600, :default_fees => 10000, :min_confirmation => 1, :max_confirmation => 9999999,
                  :rpc => { :host => 'localhost', :port => 8332 , :user => '', :password => '', :schema => 'https'}}
       if config
@@ -27,6 +26,7 @@ module OpenAssets
       else
         raise OpenAssets::Error, 'specified unsupported provider.'
       end
+      @tx_cache = Cache::TransactionCache.new(@config[:cache])
     end
 
     def provider
@@ -186,13 +186,14 @@ module OpenAssets
     end
 
     def get_output(txid, output_index)
-      cached_output = @cache[txid + output_index.to_s]
-      return cached_output if cached_output
-      decode_tx = provider.get_transaction(txid, 0)
-      raise OpenAssets::Transaction::TransactionBuildError, "txid #{txid} could not be retrieved." if decode_tx.nil?
+      decode_tx = tx_cache.get(txid)
+      if decode_tx.nil?
+        decode_tx = provider.get_transaction(txid, 0)
+        raise OpenAssets::Transaction::TransactionBuildError, "txid #{txid} could not be retrieved." if decode_tx.nil?
+        tx_cache.put(txid, decode_tx)
+      end
       tx = Bitcoin::Protocol::Tx.new(decode_tx.htb)
       colored_outputs = get_color_outputs_from_tx(tx)
-      colored_outputs.each_with_index { |o, index | @cache[txid + index.to_s] = o}
       colored_outputs[output_index]
     end
 
@@ -213,7 +214,7 @@ module OpenAssets
       tx.outputs.map{|out| OpenAssets::Protocol::TransactionOutput.new(out.value, out.parsed_script, nil, 0, OpenAssets::Protocol::OutputType::UNCOLORED)}
     end
 
-    # Get tx outputs. (use for debug)
+    # Get tx outputs. This method will always get the latest transaction without the cache.
     # @param[String] txid Transaction ID.
     # @return[Array] Return array of the transaction output Hash with coloring information.
     def get_outputs_from_txid(txid)

data/lib/openassets/cache/transaction_cache.rb

@@ -0,0 +1,39 @@
+require 'sqlite3'
+module OpenAssets
+  module Cache
+
+    # An object that can be used for caching serialized transaction in a Sqlite database.
+    class TransactionCache
+
+      attr_reader :db
+
+      # Initializes the connection to the database, and creates the table if needed.
+      # @param[String] path The path to the database file. Use ':memory:' for an in-memory database.
+      def initialize(path)
+        @db = SQLite3::Database.new path
+        @db.execute <<-SQL
+          CREATE TABLE IF NOT EXISTS Tx(
+                  TransactionHash BLOB,
+                  SerializedTx BLOB,
+                  PRIMARY KEY (TransactionHash))
+        SQL
+      end
+
+      # Return the serialized transaction.
+      # @param[String] txid The transaction id.
+      # @return[String] The serialized transaction. If not found transaction, return nil.
+      def get(txid)
+        rows = db.execute('SELECT SerializedTx FROM Tx WHERE TransactionHash = ?', [txid])
+        rows.empty? ? nil : rows[0][0]
+      end
+
+      # Saves a serialized transaction in cache.
+      # @param[String] txid A transaction id.
+      # @param[String] serialized_tx A a hex-encoded serialized transaction.
+      def put(txid, serialized_tx)
+        db.execute('INSERT INTO Tx (TransactionHash, SerializedTx) VALUES (?, ?)', [txid, serialized_tx])
+      end
+    end
+
+  end
+end

data/lib/openassets/cache.rb

@@ -0,0 +1,5 @@
+module OpenAssets
+  module Cache
+    autoload :TransactionCache, 'openassets/cache/transaction_cache'
+  end
+end

data/lib/openassets/version.rb

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

data/lib/openassets.rb

@@ -10,5 +10,6 @@ module OpenAssets
   autoload :Provider, 'openassets/provider'
   autoload :Error, 'openassets/error'
   autoload :SendAssetParam, 'openassets/send_asset_param'
+  autoload :Cache, 'openassets/cache'
 
 end

data/openassets-ruby.gemspec

@@ -22,6 +22,7 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency "ffi", "~>1.9.8"
   spec.add_runtime_dependency "rest-client", "~>1.8.0"
   spec.add_runtime_dependency "httpclient"
+  spec.add_runtime_dependency "sqlite3"
   spec.add_development_dependency "bundler", "~> 1.9"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openassets-ruby
 version: !ruby/object:Gem::Version
-  version: 0.3.4
+  version: 0.3.5
 platform: ruby
 authors:
 - azuchi
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-02-06 00:00:00.000000000 Z
+date: 2016-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bitcoin-ruby
@@ -66,6 +66,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -131,6 +145,8 @@ files:
 - exe/openassets
 - lib/openassets.rb
 - lib/openassets/api.rb
+- lib/openassets/cache.rb
+- lib/openassets/cache/transaction_cache.rb
 - lib/openassets/error.rb
 - lib/openassets/medhod_filter.rb
 - lib/openassets/protocol.rb