glueby 0.4.0 → 0.4.4

data/lib/glueby/fee_provider/tasks.rb

@@ -1,136 +1,141 @@
-module Glueby
-  class FeeProvider
-    class Tasks
-      attr_reader :fee_provider
-
-      STATUS = {
-        # FeeProvider is ready to pay fees.
-        ready: 'Ready',
-        # FeeProvider is ready to pay fees, but it doesn't have enough amount to fill the UTXO pool by UTXOs which is for paying fees.
-        insufficient_amount: 'Insufficient Amount',
-        # FeeProvider is not ready to pay fees. It has no UTXOs for paying fee and amounts.
-        not_ready: 'Not Ready'
-      }
-
-      def initialize
-        @fee_provider = Glueby::FeeProvider.new
-      end
-
-      # Create UTXOs for paying fee from TPC amount of the wallet FeeProvider has. Then show the status.
-      #
-      # About the UTXO Pool
-      # FeeProvider have the UTXO pool. the pool is manged to keep some number of UTXOs that have fixed fee value. The
-      # value is configurable by :fixed_fee. This method do the management to the pool.
-      def manage_utxo_pool
-        txb = Tapyrus::TxBuilder.new
-
-        sum, utxos = collect_outputs
-        return if utxos.empty?
-
-        utxos.each { |utxo| txb.add_utxo(utxo) }
-        address = wallet.receive_address
-
-        shortage = [fee_provider.utxo_pool_size - current_utxo_pool_size, 0].max
-        can_create = (sum - fee_provider.fixed_fee) / fee_provider.fixed_fee
-        fee_outputs_count_to_be_created = [shortage, can_create].min
-
-        return if fee_outputs_count_to_be_created == 0
-
-        fee_outputs_count_to_be_created.times do
-          txb.pay(address, fee_provider.fixed_fee)
-        end
-
-        tx = txb.change_address(address)
-                .fee(fee_provider.fixed_fee)
-                .build
-        tx = wallet.sign_tx(tx)
-        wallet.broadcast(tx)
-      ensure
-        status
-      end
-
-      # Show the status of the UTXO pool
-      def status
-        status = :ready
-
-        if current_utxo_pool_size < fee_provider.utxo_pool_size
-          if tpc_amount < value_to_fill_utxo_pool
-            status = :insufficient_amount
-            message = <<~MESSAGE
-            1. Please replenishment TPC which is for paying fee to FeeProvider. 
-               FeeProvider needs #{value_to_fill_utxo_pool} tapyrus at least for paying 20 transaction fees. 
-               FeeProvider wallet's address is '#{wallet.receive_address}'
-            2. Then create UTXOs for paying in UTXO pool with 'rake glueby:fee_provider:manage_utxo_pool'
-            MESSAGE
-          else
-            message = "Please create UTXOs for paying in UTXO pool with 'rake glueby:fee_provider:manage_utxo_pool'\n"
-          end
-        end
-
-        status = :not_ready if current_utxo_pool_size == 0
-
-        puts <<~EOS
-        Status: #{STATUS[status]}
-        TPC amount: #{delimit(tpc_amount)}
-        UTXO pool size: #{delimit(current_utxo_pool_size)}
-        #{"\n" if message}#{message}
-        Configuration:
-          fixed_fee = #{delimit(fee_provider.fixed_fee)}
-          utxo_pool_size = #{delimit(fee_provider.utxo_pool_size)}
-        EOS
-      end
-
-      private
-
-      def check_wallet_amount!
-        if tpc_amount < fee_provider.fixed_fee
-          raise InsufficientTPC, <<~MESSAGE
-            FeeProvider has insufficient TPC to create fee outputs to fill the UTXO pool.
-            1. Please replenishment TPC which is for paying fee to FeeProvider. FeeProvider needs #{fee_provider.utxo_pool_size * fee_provider.fixed_fee} tapyrus at least. FeeProvider wallet's address is '#{wallet.receive_address}'
-            2. Then create UTXOs for paying in UTXO pool with 'rake glueby:fee_provider:manage_utxo_pool'
-          MESSAGE
-        end
-      end
-
-      def tpc_amount
-        wallet.balance(false)
-      end
-
-      def collect_outputs
-        wallet.list_unspent.inject([0, []]) do |sum, output|
-          next sum if output[:color_id] || output[:amount] == fee_provider.fixed_fee
-
-          new_sum = sum[0] + output[:amount]
-          new_outputs = sum[1] << {
-            txid: output[:txid],
-            script_pubkey: output[:script_pubkey],
-            value: output[:amount],
-            index: output[:vout] ,
-            finalized: output[:finalized]
-          }
-          return [new_sum, new_outputs] if new_sum >= value_to_fill_utxo_pool
-
-          [new_sum, new_outputs]
-        end
-      end
-
-      def current_utxo_pool_size
-        wallet
-          .list_unspent(false)
-          .count { |o| !o[:color_id] && o[:amount] == fee_provider.fixed_fee }
-      end
-
-      def value_to_fill_utxo_pool
-        fee_provider.fixed_fee * (fee_provider.utxo_pool_size + 1) #  +1 is for paying fee
-      end
-
-      def wallet
-        fee_provider.wallet
-      end
-
-      def delimit(num)
-        num.to_s.reverse.scan(/.{1,3}/).join('_').reverse
-      end
-    end
-  end
+module Glueby
+  class FeeProvider
+    class Tasks
+      attr_reader :fee_provider
+
+      STATUS = {
+        # FeeProvider is ready to pay fees.
+        ready: 'Ready',
+        # FeeProvider is ready to pay fees, but it doesn't have enough amount to fill the UTXO pool by UTXOs which is for paying fees.
+        insufficient_amount: 'Insufficient Amount',
+        # FeeProvider is not ready to pay fees. It has no UTXOs for paying fee and amounts.
+        not_ready: 'Not Ready'
+      }
+
+      def initialize
+        @fee_provider = Glueby::FeeProvider.new
+      end
+
+      # Create UTXOs for paying fee from TPC amount of the wallet FeeProvider has. Then show the status.
+      #
+      # About the UTXO Pool
+      # FeeProvider have the UTXO pool. the pool is manged to keep some number of UTXOs that have fixed fee value. The
+      # value is configurable by :fixed_fee. This method do the management to the pool.
+      def manage_utxo_pool
+        txb = Tapyrus::TxBuilder.new
+
+        sum, utxos = collect_outputs
+        return if utxos.empty?
+
+        utxos.each { |utxo| txb.add_utxo(utxo) }
+        address = wallet.receive_address
+
+        shortage = [fee_provider.utxo_pool_size - current_utxo_pool_size, 0].max
+        can_create = (sum - fee_provider.fixed_fee) / fee_provider.fixed_fee
+        fee_outputs_count_to_be_created = [shortage, can_create].min
+
+        return if fee_outputs_count_to_be_created == 0
+
+        fee_outputs_count_to_be_created.times do
+          txb.pay(address, fee_provider.fixed_fee)
+        end
+
+        tx = txb.change_address(address)
+                .fee(fee_provider.fixed_fee)
+                .build
+        tx = wallet.sign_tx(tx)
+        wallet.broadcast(tx, without_fee_provider: true)
+      ensure
+        status
+      end
+
+      # Show the status of the UTXO pool
+      def status
+        status = :ready
+
+        if current_utxo_pool_size < fee_provider.utxo_pool_size
+          if tpc_amount < value_to_fill_utxo_pool
+            status = :insufficient_amount
+            message = <<~MESSAGE
+            1. Please replenishment TPC which is for paying fee to FeeProvider. 
+               FeeProvider needs #{value_to_fill_utxo_pool} tapyrus at least for paying 20 transaction fees. 
+               FeeProvider wallet's address is '#{wallet.receive_address}'
+            2. Then create UTXOs for paying in UTXO pool with 'rake glueby:fee_provider:manage_utxo_pool'
+            MESSAGE
+          else
+            message = "Please create UTXOs for paying in UTXO pool with 'rake glueby:fee_provider:manage_utxo_pool'\n"
+          end
+        end
+
+        status = :not_ready if current_utxo_pool_size == 0
+
+        puts <<~EOS
+        Status: #{STATUS[status]}
+        TPC amount: #{delimit(tpc_amount)}
+        UTXO pool size: #{delimit(current_utxo_pool_size)}
+        #{"\n" if message}#{message}
+        Configuration:
+          fixed_fee = #{delimit(fee_provider.fixed_fee)}
+          utxo_pool_size = #{delimit(fee_provider.utxo_pool_size)}
+        EOS
+      end
+
+      # Show the address of Fee Provider 
+      def address
+        puts wallet.receive_address
+      end
+
+      private
+
+      def check_wallet_amount!
+        if tpc_amount < fee_provider.fixed_fee
+          raise InsufficientTPC, <<~MESSAGE
+            FeeProvider has insufficient TPC to create fee outputs to fill the UTXO pool.
+            1. Please replenishment TPC which is for paying fee to FeeProvider. FeeProvider needs #{fee_provider.utxo_pool_size * fee_provider.fixed_fee} tapyrus at least. FeeProvider wallet's address is '#{wallet.receive_address}'
+            2. Then create UTXOs for paying in UTXO pool with 'rake glueby:fee_provider:manage_utxo_pool'
+          MESSAGE
+        end
+      end
+
+      def tpc_amount
+        wallet.balance(false)
+      end
+
+      def collect_outputs
+        wallet.list_unspent.inject([0, []]) do |sum, output|
+          next sum if output[:color_id] || output[:amount] == fee_provider.fixed_fee
+
+          new_sum = sum[0] + output[:amount]
+          new_outputs = sum[1] << {
+            txid: output[:txid],
+            script_pubkey: output[:script_pubkey],
+            value: output[:amount],
+            index: output[:vout] ,
+            finalized: output[:finalized]
+          }
+          return [new_sum, new_outputs] if new_sum >= value_to_fill_utxo_pool
+
+          [new_sum, new_outputs]
+        end
+      end
+
+      def current_utxo_pool_size
+        wallet
+          .list_unspent(false)
+          .count { |o| !o[:color_id] && o[:amount] == fee_provider.fixed_fee }
+      end
+
+      def value_to_fill_utxo_pool
+        fee_provider.fixed_fee * (fee_provider.utxo_pool_size + 1) #  +1 is for paying fee
+      end
+
+      def wallet
+        fee_provider.wallet
+      end
+
+      def delimit(num)
+        num.to_s.reverse.scan(/.{1,3}/).join('_').reverse
+      end
+    end
+  end
 end

data/lib/glueby/internal/wallet/abstract_wallet_adapter.rb

@@ -1,146 +1,152 @@
-module Glueby
-  module Internal
-    class Wallet
-      # This is an abstract class for wallet adapters. If you want to use a wallet
-      # component with Glueby modules, you can use it by adding subclass of this abstract
-      # class for the wallet component.
-      class AbstractWalletAdapter
-        # Creates a new wallet inside the wallet component and returns `wallet_id`. The created
-        # wallet is loaded from at first.
-        # @params [String] wallet_id - Option. The wallet id that if for the wallet to be created. If this is nil, wallet adapter generates it.
-        # @return [String] wallet_id
-        # @raise [Glueby::Internal::Wallet::Errors::WalletAlreadyCreated] when the specified wallet has been already created.
-        def create_wallet(wallet_id = nil)
-          raise NotImplementedError, "You must implement #{self.class}##{__method__}"
-        end
-
-        # Delete the wallet inside the wallet component.
-        # This method expect that the wallet will be removed completely
-        # in the wallet and it cannot restore. It is assumed that the main use-case of
-        # this method is for testing.
-        #
-        # @param [String] wallet_id - The wallet id that is offered by `create_wallet()` method.
-        # @return [Boolean] The boolean value whether the deletion was success.
-        def delete_wallet(wallet_id)
-          raise NotImplementedError, "You must implement #{self.class}##{__method__}"
-        end
-
-        # Load the wallet inside the wallet component.
-        # This method makes the wallet to possible to use on other methods like `balance`,
-        # `list_unspent`, etc. All the methods that gets `wallet_id` as a argument needs to
-        # load the wallet before use it.
-        # If the wallet component doesn't need such as load operation to prepare to use the
-        # wallet, `load_wallet` can be empty method.
-        #
-        # @param [String] wallet_id - The wallet id that is offered by `create_wallet()` method.
-        # @raise [Glueby::Internal::Wallet::Errors::WalletAlreadyLoaded] when the specified wallet has been already loaded.
-        # @raise [Glueby::Internal::Wallet::Errors::WalletNotFound] when the specified wallet is not found.
-        def load_wallet(wallet_id)
-          raise NotImplementedError, "You must implement #{self.class}##{__method__}"
-        end
-
-        # Unload the wallet inside the wallet component.
-        #
-        # @param [String] wallet_id - The wallet id that is offered by `create_wallet()` method.
-        # @return [Boolean] The boolean value whether the unloading was success.
-        def unload_wallet(wallet_id)
-          raise NotImplementedError, "You must implement #{self.class}##{__method__}"
-        end
-
-        # Returns list of loaded wallet_id.
-        #
-        # @return [Array of String] - Array of wallet_id
-        def wallets
-          raise NotImplementedError, "You must implement #{self.class}##{__method__}"
-        end
-
-        # Returns amount of tapyrus that the wallet has.
-        #
-        # @param [String] wallet_id - The wallet id that is offered by `create_wallet()` method.
-        # @param [Boolean] only_finalized - The balance includes only finalized UTXO value if it
-        #                                   is true. Default is true.
-        # @return [Integer] The balance of the wallet. The unit is 'tapyrus'.
-        #                   1 TPC equals to 10^8 'tapyrus'.
-        def balance(wallet_id, only_finalized = true)
-          raise NotImplementedError, "You must implement #{self.class}##{__method__}"
-        end
-
-        # Returns all the UTXOs that the wallet has.
-        #
-        # @param [String] wallet_id - The wallet id that is offered by `create_wallet()` method.
-        # @param [Boolean] only_finalized - The UTXOs includes only finalized UTXO value if it
-        #                                   is true. Default is true.
-        # @return [Array of UTXO]
-        #
-        # ## The UTXO structure
-        #
-        # - txid: [String] Transaction id
-        # - vout: [Integer] Output index
-        # - amount: [Integer] Amount of the UTXO as tapyrus unit
-        # - finalized: [Boolean] Whether the UTXO is finalized
-        def list_unspent(wallet_id, only_finalized = true)
-          raise NotImplementedError, "You must implement #{self.class}##{__method__}"
-        end
-
-        # Sign to the transaction with a key in the wallet.
-        #
-        # @param [String] wallet_id - The wallet id that is offered by `create_wallet()` method.
-        # @param [Tapyrus::Tx] tx - The transaction will be signed.
-        # @param [Array] prevtxs - array of hash that represents unbroadcasted transaction outputs used by signing tx.
-        #                Each hash has `txid`, `vout`, `scriptPubKey`, `amount` fields.
-        # @param [Integer] sighashtype - The sighash flag for each signature that would be produced here.
-        # @return [Tapyrus::Tx]
-        # @raise [Glueby::Internal::Wallet::Errors::InvalidSighashType] when the specified sighashtype is invalid
-        def sign_tx(wallet_id, tx, prevtxs = [], sighashtype: Tapyrus::SIGHASH_TYPE[:all])
-          raise NotImplementedError, "You must implement #{self.class}##{__method__}"
-        end
-
-        # Broadcast the transaction to the Tapyrus Network.
-        #
-        # @param [String] wallet_id - The wallet id that is offered by `create_wallet()` method.
-        # @param [Tapyrus::Tx] tx - The transaction to be broadcasterd.
-        # @return [String] txid
-        def broadcast(wallet_id, tx)
-          raise NotImplementedError, "You must implement #{self.class}##{__method__}"
-        end
-
-        # Returns an address to receive coin.
-        #
-        # @param [String] wallet_id - The wallet id that is offered by `create_wallet()` method.
-        # @return [String] P2PKH address
-        def receive_address(wallet_id)
-          raise NotImplementedError, "You must implement #{self.class}##{__method__}"
-        end
-
-        # Returns an address to change coin.
-        #
-        # @param [String] wallet_id - The wallet id that is offered by `create_wallet()` method.
-        # @return [String] P2PKH address
-        def change_address(wallet_id)
-          raise NotImplementedError, "You must implement #{self.class}##{__method__}"
-        end
-
-        # Returns a new public key.
-        #
-        # This method is expected to returns a new public key. The key would generate internally. This key is provided
-        # for contracts that need public key such as multi sig transaction.
-        #
-        # @param [String] wallet_id - The wallet id that is offered by `create_wallet()` method.
-        # @return [Tapyrus::Key]
-        def create_pubkey(wallet_id)
-          raise NotImplementedError, "You must implement #{self.class}##{__method__}"
-        end
-
-        # Returns an array of addresses
-        #
-        # This method is expected to return the list of addresses that wallet has.
-        #
-        # @param [String] wallet_id - The wallet id that is offered by `create_wallet()` method.
-        # @return [Array<String>] array of P2PKH address
-        def get_addresses(wallet_id)
-          raise NotImplementedError, "You must implement #{self.class}##{__method__}"
-        end
-      end
-    end
-  end
+module Glueby
+  module Internal
+    class Wallet
+      # This is an abstract class for wallet adapters. If you want to use a wallet
+      # component with Glueby modules, you can use it by adding subclass of this abstract
+      # class for the wallet component.
+      class AbstractWalletAdapter
+        # Creates a new wallet inside the wallet component and returns `wallet_id`. The created
+        # wallet is loaded from at first.
+        # @params [String] wallet_id - Option. The wallet id that if for the wallet to be created. If this is nil, wallet adapter generates it.
+        # @return [String] wallet_id
+        # @raise [Glueby::Internal::Wallet::Errors::WalletAlreadyCreated] when the specified wallet has been already created.
+        def create_wallet(wallet_id = nil)
+          raise NotImplementedError, "You must implement #{self.class}##{__method__}"
+        end
+
+        # Delete the wallet inside the wallet component.
+        # This method expect that the wallet will be removed completely
+        # in the wallet and it cannot restore. It is assumed that the main use-case of
+        # this method is for testing.
+        #
+        # @param [String] wallet_id - The wallet id that is offered by `create_wallet()` method.
+        # @return [Boolean] The boolean value whether the deletion was success.
+        def delete_wallet(wallet_id)
+          raise NotImplementedError, "You must implement #{self.class}##{__method__}"
+        end
+
+        # Load the wallet inside the wallet component.
+        # This method makes the wallet to possible to use on other methods like `balance`,
+        # `list_unspent`, etc. All the methods that gets `wallet_id` as a argument needs to
+        # load the wallet before use it.
+        # If the wallet component doesn't need such as load operation to prepare to use the
+        # wallet, `load_wallet` can be empty method.
+        #
+        # @param [String] wallet_id - The wallet id that is offered by `create_wallet()` method.
+        # @raise [Glueby::Internal::Wallet::Errors::WalletAlreadyLoaded] when the specified wallet has been already loaded.
+        # @raise [Glueby::Internal::Wallet::Errors::WalletNotFound] when the specified wallet is not found.
+        def load_wallet(wallet_id)
+          raise NotImplementedError, "You must implement #{self.class}##{__method__}"
+        end
+
+        # Unload the wallet inside the wallet component.
+        #
+        # @param [String] wallet_id - The wallet id that is offered by `create_wallet()` method.
+        # @return [Boolean] The boolean value whether the unloading was success.
+        def unload_wallet(wallet_id)
+          raise NotImplementedError, "You must implement #{self.class}##{__method__}"
+        end
+
+        # Returns list of loaded wallet_id.
+        #
+        # @return [Array of String] - Array of wallet_id
+        def wallets
+          raise NotImplementedError, "You must implement #{self.class}##{__method__}"
+        end
+
+        # Returns amount of tapyrus that the wallet has.
+        #
+        # @param [String] wallet_id - The wallet id that is offered by `create_wallet()` method.
+        # @param [Boolean] only_finalized - The balance includes only finalized UTXO value if it
+        #                                   is true. Default is true.
+        # @return [Integer] The balance of the wallet. The unit is 'tapyrus'.
+        #                   1 TPC equals to 10^8 'tapyrus'.
+        def balance(wallet_id, only_finalized = true)
+          raise NotImplementedError, "You must implement #{self.class}##{__method__}"
+        end
+
+        # Returns the UTXOs that the wallet has.
+        # If label is specified, return UTXOs filtered with label
+        #
+        # @param [String] wallet_id - The wallet id that is offered by `create_wallet()` method.
+        # @param [Boolean] only_finalized - The UTXOs includes only finalized UTXO value if it
+        #                                   is true. Default is true.
+        # @param [String] label - Label for filtering UTXOs
+        # @return [Array of UTXO]
+        #
+        # ## The UTXO structure
+        #
+        # - txid: [String] Transaction id
+        # - vout: [Integer] Output index
+        # - amount: [Integer] Amount of the UTXO as tapyrus unit
+        # - finalized: [Boolean] Whether the UTXO is finalized
+        def list_unspent(wallet_id, only_finalized = true, label = nil)
+          raise NotImplementedError, "You must implement #{self.class}##{__method__}"
+        end
+
+        # Sign to the transaction with a key in the wallet.
+        #
+        # @param [String] wallet_id - The wallet id that is offered by `create_wallet()` method.
+        # @param [Tapyrus::Tx] tx - The transaction will be signed.
+        # @param [Array] prevtxs - array of hash that represents unbroadcasted transaction outputs used by signing tx.
+        #                Each hash has `txid`, `vout`, `scriptPubKey`, `amount` fields.
+        # @param [Integer] sighashtype - The sighash flag for each signature that would be produced here.
+        # @return [Tapyrus::Tx]
+        # @raise [Glueby::Internal::Wallet::Errors::InvalidSighashType] when the specified sighashtype is invalid
+        def sign_tx(wallet_id, tx, prevtxs = [], sighashtype: Tapyrus::SIGHASH_TYPE[:all])
+          raise NotImplementedError, "You must implement #{self.class}##{__method__}"
+        end
+
+        # Broadcast the transaction to the Tapyrus Network.
+        #
+        # @param [String] wallet_id - The wallet id that is offered by `create_wallet()` method.
+        # @param [Tapyrus::Tx] tx - The transaction to be broadcasterd.
+        # @yield Option. If a block given, the block is called before actual broadcasting.
+        #   @yieldparam [Tapyrus::Tx] tx - The tx that is going to be broadcasted as is.
+        # @return [String] txid
+        def broadcast(wallet_id, tx, &block)
+          raise NotImplementedError, "You must implement #{self.class}##{__method__}"
+        end
+
+        # Returns an address to receive coin.
+        #
+        # @param [String] wallet_id - The wallet id that is offered by `create_wallet()` method.
+        # @param [String] label The label associated with this address.
+        # @return [String] P2PKH address
+        def receive_address(wallet_id, label = nil)
+          raise NotImplementedError, "You must implement #{self.class}##{__method__}"
+        end
+
+        # Returns an address to change coin.
+        #
+        # @param [String] wallet_id - The wallet id that is offered by `create_wallet()` method.
+        # @return [String] P2PKH address
+        def change_address(wallet_id)
+          raise NotImplementedError, "You must implement #{self.class}##{__method__}"
+        end
+
+        # Returns a new public key.
+        #
+        # This method is expected to returns a new public key. The key would generate internally. This key is provided
+        # for contracts that need public key such as multi sig transaction.
+        #
+        # @param [String] wallet_id - The wallet id that is offered by `create_wallet()` method.
+        # @return [Tapyrus::Key]
+        def create_pubkey(wallet_id)
+          raise NotImplementedError, "You must implement #{self.class}##{__method__}"
+        end
+
+        # Returns an array of addresses
+        #
+        # This method is expected to return the list of addresses that wallet has.
+        #
+        # @param [String] wallet_id - The wallet id that is offered by `create_wallet()` method.
+        # @param [String] label The label to filter the addresses.
+        # @return [Array<String>] array of P2PKH address
+        def get_addresses(wallet_id, label = nil)
+          raise NotImplementedError, "You must implement #{self.class}##{__method__}"
+        end
+      end
+    end
+  end
 end