glueby 0.4.0 → 0.4.4

data/lib/glueby/internal/wallet.rb

@@ -1,146 +1,162 @@
-module Glueby
-  module Internal
-    # # Glueby::Internal::Wallet
-    #
-    # This module provides the way to deal about wallet that includes key management, address management, getting UTXOs.
-    #
-    # ## How to use
-    #
-    # First, you need to configure which wallet implementation is used in Glueby::Internal::Wallet. For now, below wallets are
-    # supported.
-    #
-    # * [Tapyrus Core](https://github.com/chaintope/tapyrus-core)
-    #
-    # Here shows an example to use Tapyrus Core wallet.
-    #
-    # ```ruby
-    # # Setup Tapyrus Core RPC connection
-    # config = {schema: 'http', host: '127.0.0.1', port: 12381, user: 'user', password: 'pass'}
-    # Glueby::Internal::RPC.configure(config)
-    #
-    # # Setup wallet adapter
-    # Glueby::Internal::Wallet.wallet_adapter = Glueby::Internal::Wallet::TapyrusCoreWalletAdapter.new
-    #
-    # # Create wallet
-    # wallet = Glueby::Internal::Wallet.create
-    # wallet.balance # => 0
-    # wallet.list_unspent
-    # ```
-    class Wallet
-      autoload :AbstractWalletAdapter, 'glueby/internal/wallet/abstract_wallet_adapter'
-      autoload :AR, 'glueby/internal/wallet/active_record'
-      autoload :TapyrusCoreWalletAdapter, 'glueby/internal/wallet/tapyrus_core_wallet_adapter'
-      autoload :ActiveRecordWalletAdapter, 'glueby/internal/wallet/active_record_wallet_adapter'
-      autoload :Errors, 'glueby/internal/wallet/errors'
-
-      class << self
-        attr_writer :wallet_adapter
-
-        def create(wallet_id = nil)
-          begin
-            wallet_id = wallet_adapter.create_wallet(wallet_id)
-          rescue Errors::WalletAlreadyCreated => _
-            # Ignore when wallet is already created.
-          end
-          new(wallet_id)
-        end
-
-        def load(wallet_id)
-          begin
-            wallet_adapter.load_wallet(wallet_id)
-          rescue Errors::WalletAlreadyLoaded => _
-            # Ignore when wallet is already loaded.
-          end
-          new(wallet_id)
-        end
-
-        def wallets
-          wallet_adapter.wallets.map { |id| new(id) }
-        end
-
-        def wallet_adapter
-          @wallet_adapter or
-            raise Errors::ShouldInitializeWalletAdapter, 'You should initialize wallet adapter using `Glueby::Internal::Wallet.wallet_adapter = some wallet adapter instance`.'
-        end
-      end
-
-      attr_reader :id
-
-      def initialize(wallet_id)
-        @id = wallet_id
-      end
-
-      def balance(only_finalized = true)
-        wallet_adapter.balance(id, only_finalized)
-      end
-
-      def list_unspent(only_finalized = true)
-        wallet_adapter.list_unspent(id, only_finalized)
-      end
-
-      def delete
-        wallet_adapter.delete_wallet(id)
-      end
-
-      # @param [Tapyrus::Tx] tx The tx that is signed
-      # @param [Array<Hash>] prev_txs An array of hash that represents unbroadcasted transaction outputs used by signing tx
-      #   @option prev_txs [String] :txid
-      #   @option prev_txs [Integer] :vout
-      #   @option prev_txs [String] :scriptPubkey
-      #   @option prev_txs [Integer] :amount
-      # @param [Boolean] for_fee_provider_input The flag to notify whether the caller is FeeProvider and called for signing a input that is by FeeProvider.
-      def sign_tx(tx, prev_txs = [], for_fee_provider_input: false)
-        sighashtype = Tapyrus::SIGHASH_TYPE[:all]
-
-        if !for_fee_provider_input && Glueby.configuration.fee_provider_bears?
-          sighashtype |= Tapyrus::SIGHASH_TYPE[:anyonecanpay]
-        end
-
-        wallet_adapter.sign_tx(id, tx, prev_txs, sighashtype: sighashtype)
-      end
-
-      def broadcast(tx)
-        tx = FeeProvider.provide(tx) if Glueby.configuration.fee_provider_bears?
-        wallet_adapter.broadcast(id, tx)
-        tx
-      end
-
-      def receive_address
-        wallet_adapter.receive_address(id)
-      end
-
-      def change_address
-        wallet_adapter.change_address(id)
-      end
-
-      def create_pubkey
-        wallet_adapter.create_pubkey(id)
-      end
-
-      def collect_uncolored_outputs(amount)
-        utxos = list_unspent
-
-        utxos.inject([0, []]) do |sum, output|
-          next sum if output[:color_id]
-
-          new_sum = sum[0] + output[:amount]
-          new_outputs = sum[1] << output
-          return [new_sum, new_outputs] if new_sum >= amount
-
-          [new_sum, new_outputs]
-        end
-        raise Glueby::Contract::Errors::InsufficientFunds
-      end
-
-      def get_addresses
-        wallet_adapter.get_addresses(id)
-      end
-
-      private
-
-      def wallet_adapter
-        self.class.wallet_adapter
-      end
-    end
-  end
-end
+module Glueby
+  module Internal
+    # # Glueby::Internal::Wallet
+    #
+    # This module provides the way to deal about wallet that includes key management, address management, getting UTXOs.
+    #
+    # ## How to use
+    #
+    # First, you need to configure which wallet implementation is used in Glueby::Internal::Wallet. For now, below wallets are
+    # supported.
+    #
+    # * [Tapyrus Core](https://github.com/chaintope/tapyrus-core)
+    #
+    # Here shows an example to use Tapyrus Core wallet.
+    #
+    # ```ruby
+    # # Setup Tapyrus Core RPC connection
+    # config = {schema: 'http', host: '127.0.0.1', port: 12381, user: 'user', password: 'pass'}
+    # Glueby::Internal::RPC.configure(config)
+    #
+    # # Setup wallet adapter
+    # Glueby::Internal::Wallet.wallet_adapter = Glueby::Internal::Wallet::TapyrusCoreWalletAdapter.new
+    #
+    # # Create wallet
+    # wallet = Glueby::Internal::Wallet.create
+    # wallet.balance # => 0
+    # wallet.list_unspent
+    # ```
+    class Wallet
+      autoload :AbstractWalletAdapter, 'glueby/internal/wallet/abstract_wallet_adapter'
+      autoload :AR, 'glueby/internal/wallet/active_record'
+      autoload :TapyrusCoreWalletAdapter, 'glueby/internal/wallet/tapyrus_core_wallet_adapter'
+      autoload :ActiveRecordWalletAdapter, 'glueby/internal/wallet/active_record_wallet_adapter'
+      autoload :Errors, 'glueby/internal/wallet/errors'
+
+      class << self
+        def create(wallet_id = nil)
+          begin
+            wallet_id = wallet_adapter.create_wallet(wallet_id)
+          rescue Errors::WalletAlreadyCreated => _
+            # Ignore when wallet is already created.
+          end
+          new(wallet_id)
+        end
+
+        def load(wallet_id)
+          begin
+            wallet_adapter.load_wallet(wallet_id)
+          rescue Errors::WalletAlreadyLoaded => _
+            # Ignore when wallet is already loaded.
+          end
+          new(wallet_id)
+        end
+
+        def wallets
+          wallet_adapter.wallets.map { |id| new(id) }
+        end
+
+        def wallet_adapter=(adapter)
+          if adapter.is_a?(ActiveRecordWalletAdapter)
+            BlockSyncer.register_syncer(ActiveRecordWalletAdapter::Syncer)
+          else
+            BlockSyncer.unregister_syncer(ActiveRecordWalletAdapter::Syncer)
+          end
+
+          @wallet_adapter = adapter
+        end
+
+        def wallet_adapter
+          @wallet_adapter or
+            raise Errors::ShouldInitializeWalletAdapter, 'You should initialize wallet adapter using `Glueby::Internal::Wallet.wallet_adapter = some wallet adapter instance`.'
+        end
+      end
+
+      attr_reader :id
+
+      def initialize(wallet_id)
+        @id = wallet_id
+      end
+
+      def balance(only_finalized = true)
+        wallet_adapter.balance(id, only_finalized)
+      end
+
+      # @param only_finalized [Boolean] The flag to get a UTXO with status only finalized
+      # @param label [String] This label is used to filtered the UTXOs with labeled if a key or Utxo is labeled.
+      #                    - If label is not specified (label=nil), all UTXOs will be returned.
+      #                    - If label=:unlabeled, only unlabeled UTXOs will be returned.
+      def list_unspent(only_finalized = true, label = nil)
+        wallet_adapter.list_unspent(id, only_finalized, label)
+      end
+
+      def delete
+        wallet_adapter.delete_wallet(id)
+      end
+
+      # @param [Tapyrus::Tx] tx The tx that is signed
+      # @param [Array<Hash>] prev_txs An array of hash that represents unbroadcasted transaction outputs used by signing tx
+      #   @option prev_txs [String] :txid
+      #   @option prev_txs [Integer] :vout
+      #   @option prev_txs [String] :scriptPubkey
+      #   @option prev_txs [Integer] :amount
+      # @param [Boolean] for_fee_provider_input The flag to notify whether the caller is FeeProvider and called for signing a input that is by FeeProvider.
+      def sign_tx(tx, prev_txs = [], for_fee_provider_input: false)
+        sighashtype = Tapyrus::SIGHASH_TYPE[:all]
+
+        if !for_fee_provider_input && Glueby.configuration.fee_provider_bears?
+          sighashtype |= Tapyrus::SIGHASH_TYPE[:anyonecanpay]
+        end
+
+        wallet_adapter.sign_tx(id, tx, prev_txs, sighashtype: sighashtype)
+      end
+
+      # Broadcast a transaction via Tapyrus Core RPC
+      # @param [Tapyrus::Tx] tx The tx that would be broadcasted
+      # @option [Boolean] without_fee_provider The flag to avoid to use FeeProvider temporary.
+      # @param [Proc] block The block that is called before broadcasting. It can be used to handle tx that is modified by FeeProvider.
+      def broadcast(tx, without_fee_provider: false, &block)
+        tx = FeeProvider.provide(tx) if !without_fee_provider && Glueby.configuration.fee_provider_bears?
+        wallet_adapter.broadcast(id, tx, &block)
+        tx
+      end
+
+      def receive_address(label = nil)
+        wallet_adapter.receive_address(id, label)
+      end
+
+      def change_address
+        wallet_adapter.change_address(id)
+      end
+
+      def create_pubkey
+        wallet_adapter.create_pubkey(id)
+      end
+
+      def collect_uncolored_outputs(amount, label = nil, only_finalized = true)
+        utxos = list_unspent(only_finalized, label)
+
+        utxos.inject([0, []]) do |sum, output|
+          next sum if output[:color_id]
+
+          new_sum = sum[0] + output[:amount]
+          new_outputs = sum[1] << output
+          return [new_sum, new_outputs] if new_sum >= amount
+
+          [new_sum, new_outputs]
+        end
+        raise Glueby::Contract::Errors::InsufficientFunds
+      end
+
+      def get_addresses(label = nil)
+        wallet_adapter.get_addresses(id, label)
+      end
+
+      private
+
+      def wallet_adapter
+        self.class.wallet_adapter
+      end
+    end
+  end
+end

data/lib/glueby/railtie.rb

@@ -0,0 +1,10 @@
+module Glueby
+  class Railtie < ::Rails::Railtie
+    rake_tasks do
+      load "tasks/glueby/contract.rake"
+      load "tasks/glueby/contract/timestamp.rake"
+      load "tasks/glueby/block_syncer.rake"
+      load "tasks/glueby/fee_provider.rake"
+    end
+  end
+end

data/lib/glueby/version.rb

@@ -1,3 +1,3 @@
-module Glueby
-  VERSION = "0.4.0"
-end
+module Glueby
+  VERSION = "0.4.4"
+end

data/lib/glueby.rb

@@ -1,49 +1,39 @@
-require "glueby/version"
-require 'tapyrus'
-
-module Glueby
-  autoload :Contract, 'glueby/contract'
-  autoload :Generator, 'glueby/generator'
-  autoload :Wallet, 'glueby/wallet'
-  autoload :Internal, 'glueby/internal'
-  autoload :AR, 'glueby/active_record'
-  autoload :FeeProvider, 'glueby/fee_provider'
-  autoload :Configuration, 'glueby/configuration'
-
-  # Add prefix to activerecord table names
-  def self.table_name_prefix
-    'glueby_'
-  end
-
-  begin
-    class Railtie < ::Rails::Railtie
-      rake_tasks do
-        load "tasks/glueby/contract.rake"
-        load "tasks/glueby/contract/timestamp.rake"
-        load "tasks/glueby/contract/wallet_adapter.rake"
-        load "tasks/glueby/contract/block_syncer.rake"
-        load "tasks/glueby/fee_provider.rake"
-      end
-    end
-  rescue
-    # Rake task is unavailable
-    puts "Rake task is unavailable"
-  end
-
-  # Returns the global [Configuration](RSpec/Core/Configuration) object.
-  def self.configuration
-    @configuration ||= Glueby::Configuration.new
-  end
-
-  # Yields the global configuration to a block.
-  # @yield [Configuration] global configuration
-  #
-  # @example
-  #     Glueby.configure do |config|
-  #       config.wallet_adapter = :activerecord
-  #       config.rpc_config = { schema: 'http', host: '127.0.0.1', port: 12381, user: 'user', password: 'pass' }
-  #     end
-  def self.configure
-    yield configuration if block_given?
-  end
-end
+require "glueby/version"
+require 'tapyrus'
+
+module Glueby
+  autoload :Contract, 'glueby/contract'
+  autoload :Generator, 'glueby/generator'
+  autoload :Wallet, 'glueby/wallet'
+  autoload :Internal, 'glueby/internal'
+  autoload :AR, 'glueby/active_record'
+  autoload :FeeProvider, 'glueby/fee_provider'
+  autoload :Configuration, 'glueby/configuration'
+  autoload :BlockSyncer, 'glueby/block_syncer'
+
+  if defined? ::Rails::Railtie
+    require 'glueby/railtie'
+  end
+
+  # Add prefix to activerecord table names
+  def self.table_name_prefix
+    'glueby_'
+  end
+
+  # Returns the global [Configuration](RSpec/Core/Configuration) object.
+  def self.configuration
+    @configuration ||= Glueby::Configuration.new
+  end
+
+  # Yields the global configuration to a block.
+  # @yield [Configuration] global configuration
+  #
+  # @example
+  #     Glueby.configure do |config|
+  #       config.wallet_adapter = :activerecord
+  #       config.rpc_config = { schema: 'http', host: '127.0.0.1', port: 12381, user: 'user', password: 'pass' }
+  #     end
+  def self.configure
+    yield configuration if block_given?
+  end
+end

data/lib/tasks/glueby/block_syncer.rake

@@ -0,0 +1,29 @@
+namespace :glueby do
+  namespace :contract do
+    namespace :block_syncer do
+      desc '[Deprecated use glueby:block_syncer:start instead] sync block into database'
+      task :start, [] => [:environment] do |_, _|
+        puts '[Deprecated] glueby:contract:block_syncer:start is deprecated. Use \'glueby:block_syncer:start\''
+        Rake::Task['glueby:block_syncer:start'].execute
+      end
+    end
+  end
+end
+
+
+namespace :glueby do
+  namespace :block_syncer do
+    desc 'sync block into database'
+    task :start, [] => [:environment] do |_, _|
+      latest_block_num = Glueby::Internal::RPC.client.getblockcount
+      synced_block = Glueby::AR::SystemInformation.synced_block_height
+      (synced_block.int_value + 1..latest_block_num).each do |height|
+        ::ActiveRecord::Base.transaction do
+          Glueby::BlockSyncer.new(height).run
+          synced_block.update(info_value: height.to_s)
+        end
+        puts "success in synchronization (block height=#{height})"
+      end
+    end
+  end
+end

data/lib/tasks/glueby/contract/timestamp.rake

@@ -1,62 +1,40 @@
-module Glueby
-  module Contract
-    module Task
-      module Timestamp
-        module_function
-        extend Glueby::Contract::TxBuilder
-        extend Glueby::Contract::Timestamp::Util
-
-        def create
-          timestamps = Glueby::Contract::AR::Timestamp.where(status: :init)
-          timestamps.each do |t|
-            begin
-              ::ActiveRecord::Base.transaction do
-                wallet = Glueby::Wallet.load(t.wallet_id)
-                tx = create_tx(wallet, t.prefix, t.content_hash, Glueby::Contract::FixedFeeEstimator.new)
-                t.update(txid: tx.txid, status: :unconfirmed)
-
-                wallet.internal_wallet.broadcast(tx)
-                puts "broadcasted (id=#{t.id}, txid=#{tx.txid})"
-              end
-            rescue => e
-              puts "failed to broadcast (id=#{t.id}, reason=#{e.message})"
-            end
-          end
-        end
-
-        def confirm
-          timestamps = Glueby::Contract::AR::Timestamp.where(status: :unconfirmed)
-          timestamps.each do |t|
-            begin
-              ::ActiveRecord::Base.transaction do
-                tx = get_transaction(t)
-                if tx['confirmations'] &&  tx['confirmations'] > 0
-                  t.update(status: :confirmed)
-                  puts "confirmed (id=#{t.id}, txid=#{tx['txid']})"
-                end
-              end
-            rescue => e
-              puts "failed to confirm (id=#{t.id}, reason=#{e.message})"
-            end
-          end
-        end
-      end
-    end
-  end
-end
-
-namespace :glueby do
-  namespace :contract do
-    namespace :timestamp do
-      desc 'create and broadcast glueby timestamp tx'
-      task :create, [] => [:environment] do |_, _|
-        Glueby::Contract::Task::Timestamp.create
-      end
-
-      desc 'confirm glueby timestamp tx'
-      task :confirm, [] => [:environment] do |_, _|
-        Glueby::Contract::Task::Timestamp.confirm
-      end
-    end
-  end
+module Glueby
+  module Contract
+    module Task
+      module Timestamp
+        module_function
+        extend Glueby::Contract::TxBuilder
+        extend Glueby::Contract::Timestamp::Util
+
+        def create
+          timestamps = Glueby::Contract::AR::Timestamp.where(status: :init)
+          timestamps.each do |t|
+            begin
+              ::ActiveRecord::Base.transaction do
+                wallet = Glueby::Wallet.load(t.wallet_id)
+                tx = create_tx(wallet, t.prefix, t.content_hash, Glueby::Contract::FixedFeeEstimator.new)
+                wallet.internal_wallet.broadcast(tx) do |tx|
+                  t.update(txid: tx.txid, status: :unconfirmed)
+                end
+                puts "broadcasted (id=#{t.id}, txid=#{tx.txid})"
+              end
+            rescue => e
+              puts "failed to broadcast (id=#{t.id}, reason=#{e.message})"
+            end
+          end
+        end
+      end
+    end
+  end
+end
+
+namespace :glueby do
+  namespace :contract do
+    namespace :timestamp do
+      desc 'create and broadcast glueby timestamp tx'
+      task :create, [] => [:environment] do |_, _|
+        Glueby::Contract::Task::Timestamp.create
+      end
+    end
+  end
 end