glueby 1.1.1 → 1.2.0.beta.1

data/lib/glueby/internal/wallet.rb

@@ -73,6 +73,10 @@ module Glueby
           @wallet_adapter or
             raise Errors::ShouldInitializeWalletAdapter, 'You should initialize wallet adapter using `Glueby::Internal::Wallet.wallet_adapter = some wallet adapter instance`.'
         end
+
+        def get_addresses_info(addresses)
+          @wallet_adapter.get_addresses_info(addresses)
+        end
       end
 
       attr_reader :id
@@ -142,20 +146,74 @@ module Glueby
         wallet_adapter.create_pubkey(id)
       end
 
-      def collect_uncolored_outputs(amount, label = nil, only_finalized = true, shuffle = false)
-        utxos = list_unspent(only_finalized, label)
-        utxos.shuffle! if shuffle
+      # Collect TPC UTXOs up to the specified amount.
+      # @param [Integer] amount The amount of colored token to collect. If the amount is nil, return all TPC UTXOs
+      # @param [String] label The label of UTXO to collect
+      # @param [Boolean] only_finalized The flag to collect only finalized UTXO
+      # @param [Boolean] shuffle The flag to shuffle UTXO before collecting
+      # @param [Boolean] lock_utxos The flag to lock returning UTXOs to prevent to be used from other threads or processes
+      # @param [Array<Hash] excludes The UTXO list to exclude the method result. Each hash must hub keys that are :txid and :vout
+      # @return [Integer] The sum of return UTXOs
+      # @return [Array<Hash>] An array of UTXO hash
+      #
+      # ## 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
+      # - script_pubkey: [String] ScriptPubkey of the UTXO
+      def collect_uncolored_outputs(
+        amount = nil,
+        label = nil,
+        only_finalized = true,
+        shuffle = false,
+        lock_utxos = false,
+        excludes = []
+      )
+        collect_utxos(amount, label, only_finalized, shuffle, lock_utxos, excludes) do |output|
+          next false unless output[:color_id].nil?
+          next yield(output) if block_given?
 
-        utxos.inject([0, []]) do |sum, output|
-          next sum if output[:color_id]
+          true
+        end
+      end
 
-          new_sum = sum[0] + output[:amount]
-          new_outputs = sum[1] << output
-          return [new_sum, new_outputs] if new_sum >= amount
+      # Collect colored coin UTXOs up to the specified amount.
+      # @param [Tapyrus::Color::ColorIdentifier] color_id The color identifier of colored token
+      # @param [Integer] amount The amount of colored token to collect. If the amount is nil, return all UTXOs with color_id
+      # @param [String] label The label of UTXO to collect
+      # @param [Boolean] only_finalized The flag to collect only finalized UTXO
+      # @param [Boolean] shuffle The flag to shuffle UTXO before collecting
+      # @param [Boolean] lock_utxos The flag to lock returning UTXOs to prevent to be used from other threads or processes
+      # @param [Array<Hash] excludes The UTXO list to exclude the method result. Each hash must hub keys that are :txid and :vout
+      # @return [Integer] The sum of return UTXOs
+      # @return [Array<Hash>] An array of UTXO hash
+      #
+      # ## 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
+      # - script_pubkey: [String] ScriptPubkey of the UTXO
+      def collect_colored_outputs(
+        color_id,
+        amount = nil,
+        label = nil,
+        only_finalized = true,
+        shuffle = false,
+        lock_utxos = false,
+        excludes = []
+      )
+        collect_utxos(amount, label, only_finalized, shuffle, lock_utxos, excludes) do |output|
+          next false unless output[:color_id] == color_id.to_hex
+          next yield(output) if block_given?
 
-          [new_sum, new_outputs]
+          true
         end
-        raise Glueby::Contract::Errors::InsufficientFunds
+      rescue Glueby::Contract::Errors::InsufficientFunds
+        raise Glueby::Contract::Errors::InsufficientTokens
       end
 
       def get_addresses(label = nil)
@@ -178,11 +236,94 @@ module Glueby
         wallet_adapter.has_address?(id, address)
       end
 
+      # Fill inputs in the tx up to target_amount of TPC from UTXOs in the wallet.
+      # This method should be called before adding change output and script_sig in outputs.
+      # FeeEstimator.dummy_tx returns fee amount to the TX that will be added one TPC input, a change TPC output and
+      # script sigs in outputs.
+      # @param [Tapyrus::Tx] tx The tx that will be filled the inputs
+      # @param [Integer] target_amount The tapyrus amount the tx is expected to be added in this method
+      # @param [Integer] current_amount The tapyrus amount the tx already has in its inputs
+      # @param [Glueby::Contract::FeeEstimator] fee_estimator
+      # @return [Tapyrus::Tx] tx The tx that is added inputs
+      # @return [Integer] fee The final fee after the inputs are filled
+      # @return [Integer] current_amount The final amount of the tx inputs
+      # @return [Array<Hash>] provided_utxos The utxos that are added to the tx inputs
+      def fill_uncolored_inputs(
+        tx,
+        target_amount: ,
+        current_amount: 0,
+        fee_estimator: Contract::FeeEstimator::Fixed.new,
+        &block
+      )
+        fee = fee_estimator.fee(Contract::FeeEstimator.dummy_tx(tx, dummy_input_count: 0))
+        provided_utxos = []
+
+        while current_amount - fee < target_amount
+          sum, utxos = collect_uncolored_outputs(
+            fee + target_amount - current_amount,
+            nil, nil, true, true,
+            provided_utxos,
+            &block
+          )
+
+          utxos.each do |utxo|
+            tx.inputs << Tapyrus::TxIn.new(out_point: Tapyrus::OutPoint.from_txid(utxo[:txid], utxo[:vout]))
+            provided_utxos << utxo
+          end
+          current_amount += sum
+
+          new_fee = fee_estimator.fee(Contract::FeeEstimator.dummy_tx(tx, dummy_input_count: 0))
+          fee = new_fee
+        end
+
+        [tx, fee, current_amount, provided_utxos]
+      end
+
       private
 
       def wallet_adapter
         self.class.wallet_adapter
       end
+
+      def collect_utxos(
+        amount,
+        label,
+        only_finalized,
+        shuffle = true,
+        lock_utxos = false,
+        excludes = []
+      )
+        collect_all = amount.nil?
+
+        raise Glueby::ArgumentError, 'amount must be positive' unless collect_all || amount.positive?
+        utxos = list_unspent(only_finalized, label)
+        utxos = utxos.shuffle if shuffle
+
+        r = utxos.inject([0, []]) do |(sum, outputs), output|
+          if excludes.is_a?(Array) &&
+            !excludes.empty? &&
+            excludes.find { |i| i[:txid] == output[:txid] && i[:vout] == output[:vout] }
+            next [sum, outputs]
+          end
+
+          if block_given?
+            next [sum, outputs] unless yield(output)
+          end
+
+          if lock_utxos
+            next [sum, outputs] unless lock_unspent(output)
+          end
+
+          sum += output[:amount]
+          outputs << output
+          return [sum, outputs] unless collect_all || sum < amount
+
+          [sum, outputs]
+        end
+        raise Glueby::Contract::Errors::InsufficientFunds unless collect_all
+
+        r
+      end
     end
   end
 end

data/lib/glueby/internal.rb

@@ -2,5 +2,6 @@ module Glueby
   module Internal
     autoload :Wallet, 'glueby/internal/wallet'
     autoload :RPC, 'glueby/internal/rpc'
+    autoload :ContractBuilder, 'glueby/internal/contract_builder'
   end
 end

data/lib/glueby/utxo_provider/tasks.rb

@@ -1,8 +1,6 @@
 module Glueby
   class UtxoProvider
     class Tasks
-      include Glueby::Contract::TxBuilder
-
       attr_reader :utxo_provider
 
       STATUS = {

data/lib/glueby/utxo_provider.rb

@@ -1,6 +1,5 @@
 module Glueby
   class UtxoProvider
-    include Glueby::Contract::TxBuilder
     include Singleton
 
     autoload :Tasks, 'glueby/utxo_provider/tasks'
@@ -77,26 +76,20 @@ module Glueby
     # @return [Integer] current_amount The final amount of the tx inputs
     # @return [Array<Hash>] provided_utxos The utxos that are added to the tx inputs
     def fill_inputs(tx, target_amount: , current_amount: 0, fee_estimator: Contract::FeeEstimator::Fixed.new)
-      fee = fee_estimator.fee(Contract::FeeEstimator.dummy_tx(tx, dummy_input_count: 0))
-      provided_utxos = []
-
-      # If the change output value is less than DUST_LIMIT, tapyrus core returns "dust" error while broadcasting.
-      target_amount += DUST_LIMIT if target_amount < DUST_LIMIT
-
-      while current_amount - fee < target_amount
-        sum, utxos = collect_uncolored_outputs(wallet, fee + target_amount - current_amount, provided_utxos)
-
-        utxos.each do |utxo|
-          tx.inputs << Tapyrus::TxIn.new(out_point: Tapyrus::OutPoint.from_txid(utxo[:txid], utxo[:vout]))
-          provided_utxos << utxo
-        end
-        current_amount += sum
-
-        new_fee = fee_estimator.fee(Contract::FeeEstimator.dummy_tx(tx, dummy_input_count: 0))
-        fee = new_fee
+      wallet.fill_uncolored_inputs(
+        tx,
+        target_amount: target_amount,
+        current_amount: current_amount,
+        fee_estimator: fee_estimator
+      ) do |utxo|
+        # It must use only UTXOs that has defalut_value amount.
+        utxo[:amount] == default_value
       end
+    end
+    alias fill_uncolored_inputs fill_inputs
 
-      [tx, fee, current_amount, provided_utxos]
+    def change_address
+      wallet.change_address
     end
 
     def default_value
@@ -153,22 +146,10 @@ module Glueby
     # @return [Integer] sum The sum amount of the funds
     # @return [Array<Hash>] outputs The UTXO set of the funds
     def collect_uncolored_outputs(wallet, amount, excludes = [])
-      utxos = wallet.list_unspent.select do |o|
-        !o[:color_id] &&
-          o[:amount] == default_value &&
-          !excludes.find { |i| i[:txid] == o[:txid] && i[:vout] == o[:vout] }
-      end
-      utxos.shuffle!
-      
-      utxos.inject([0, []]) do |(sum, outputs), output|
-        if wallet.lock_unspent(output)
-          sum += output[:amount]
-          outputs << output
-          return [sum, outputs] if sum >= amount
-        end
-        [sum, outputs]
+      wallet.collect_uncolored_outputs(amount, nil, true, true, true) do |utxo|
+        utxo[:amount] == default_value &&
+          !excludes.find { |i| i[:txid] == utxo[:txid] && i[:vout] == utxo[:vout] }
       end
-      raise Glueby::Contract::Errors::InsufficientFunds
     end
 
     def validate_config!

data/lib/glueby/version.rb

@@ -1,3 +1,3 @@
 module Glueby
-  VERSION = "1.1.1"
+  VERSION = "1.2.0.beta.1"
 end

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

@@ -3,7 +3,6 @@ module Glueby
     module Task
       module Timestamp
         module_function
-        extend Glueby::Contract::TxBuilder
 
         def create
           timestamps = Glueby::Contract::AR::Timestamp.where(status: :init)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: glueby
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.0.beta.1
 platform: ruby
 authors:
 - azuchi
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-04-07 00:00:00.000000000 Z
+date: 2023-06-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tapyrus
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 6.1.3
+        version: 7.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 6.1.3
+        version: 7.0.0
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 6.1.3
+        version: 7.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 6.1.3
+        version: 7.0.0
 description: A Ruby library of smart contracts that can be used on Tapyrus.
 email:
 - azuchi@chaintope.com
@@ -142,6 +142,7 @@ files:
 - lib/glueby/generator.rb
 - lib/glueby/generator/migrate_generator.rb
 - lib/glueby/internal.rb
+- lib/glueby/internal/contract_builder.rb
 - lib/glueby/internal/rpc.rb
 - lib/glueby/internal/wallet.rb
 - lib/glueby/internal/wallet/abstract_wallet_adapter.rb
@@ -172,7 +173,7 @@ metadata:
   homepage_uri: https://github.com/chaintope/glueby
   source_code_uri: https://github.com/chaintope/glueby
   changelog_uri: https://github.com/chaintope/glueby
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -180,15 +181,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubygems_version: 3.2.3
-signing_key:
+rubygems_version: 3.4.10
+signing_key: 
 specification_version: 4
 summary: A Ruby library of smart contracts that can be used on Tapyrus.
 test_files: []