glueby 1.2.2 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d9a8e99610f76e6d765a52a645ead25eb8cf71343ba259ed25e5ec2fbdb0d5e5
-  data.tar.gz: 0ee19c244501e854cbe59f6957e5e0c8a25bca403a9fa58d0367ad95de3f0a38
+  metadata.gz: 41286c658b45bd9914f4c46f27e8e0f8696b61a8d763b5fcc2b0117d0e91668d
+  data.tar.gz: 3237815c98b14f3fc126e5531c8ff229d468fe77832bcca4b22828ffd386c7bd
 SHA512:
-  metadata.gz: 47dfd21bdd71bf99379f448816a58b3cef5fd093352d0f7a53806a85db5b2509765fa4f2f4813621a36fe0edc98c7491aca162f445ab9bb0708e3b3ca68756cc
-  data.tar.gz: a8cd80a311e74759b6bf1351974888e787ddeb084a435dd6a13aadc4c1fb2a65d0be5d993ee0303e6e08d67bfecd7e09cd0763ecb92d0a19146838544479ee85
+  metadata.gz: dad03d9f436a2720b854450fb95e8fab7fedde3d721f5db3bf0c69c1aa7b818ebfc359cda0c1057f4d98075295459f55f5261c69a4cc99a49f752bba3683e95c
+  data.tar.gz: eb8f0724b6b7b849a343b14e5630480584df5b6f408509dcdeebcca711055f8bcd3a62c188130b75118a7f93e18e015aeb2afd60784d4382cd27741b010f2c06

data/.github/workflows/ruby.yml

@@ -7,19 +7,15 @@
 
 name: Ruby
 
-on:
-  push:
-    branches: [master, v1.1, v1.2]
-  pull_request:
-    branches: [master, v1.1, v1.2]
+on: [push,pull_request]
 
 jobs:
   test:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby-version: ["2.7", "3.0", "3.1", "3.2"]
-
+        ruby-version: ["3.0", "3.1", "3.2", "3.3"]
+    permissions: write-all
     steps:
       - run: docker pull tapyrus/tapyrusd:v0.5.2
       - uses: actions/checkout@v2
@@ -31,4 +27,4 @@ jobs:
           ruby-version: ${{ matrix.ruby-version }}
           bundler-cache: true # runs 'bundle install' and caches installed gems automatically
       - name: Run tests
-        run: bundle exec rake
+        run: bundle exec rake

data/.ruby-version

@@ -1 +1 @@
-ruby-3.2.2
+ruby-3.3.0

data/Gemfile

@@ -6,3 +6,5 @@ gemspec
 gem "rake", "~> 12.0"
 gem "rspec", "~> 3.0"
 gem "docker-api", "~> 2.1.0"
+
+gem "simplecov", require: false

data/glueby.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.description   = %q{A Ruby library of smart contracts that can be used on Tapyrus.}
   spec.homepage      = "https://github.com/chaintope/glueby"
   spec.license       = "MIT"
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.7.0")
+  spec.required_ruby_version = Gem::Requirement.new(">= 3.0.0")
 
 
   spec.metadata["homepage_uri"] = spec.homepage
@@ -28,6 +28,7 @@ Gem::Specification.new do |spec|
 
   spec.add_runtime_dependency 'tapyrus', '>= 0.3.1'
   spec.add_runtime_dependency 'activerecord', '~> 7.0.0'
+  spec.add_runtime_dependency 'kaminari'
   spec.add_development_dependency 'sqlite3'
   spec.add_development_dependency 'mysql2'
   spec.add_development_dependency 'rails', '~> 7.0.0'

data/lib/generators/glueby/contract/templates/timestamp_table.rb.erb

@@ -13,6 +13,7 @@ class CreateTimestamp < ActiveRecord::Migration<%= migration_version %>
       t.string   :payment_base
       t.bigint   :prev_id
       t.boolean  :latest, null: false, default: true
+      t.string   :version, null: false, default: "1"
     end
 
     add_index :glueby_timestamps, [:prev_id], unique: true

data/lib/generators/glueby/contract/templates/utxo_table.rb.erb

@@ -4,6 +4,7 @@ class CreateUtxo < ActiveRecord::Migration<%= migration_version %>
       t.string     :txid
       t.integer    :index
       t.bigint     :value
+      t.string     :color_id, index: true
       t.string     :script_pubkey
       t.string     :label, index: true
       t.integer    :status

data/lib/glueby/active_record.rb

@@ -4,5 +4,22 @@ require 'active_record'
 module Glueby
   module AR
     autoload :SystemInformation, 'glueby/active_record/system_information'
+
+    def transaction(isolation: nil)
+      options = { joinable: false, requires_new: true }
+
+      adapter_type = ActiveRecord::Base.connection.adapter_name.downcase
+
+      # SQLite3 does not support transaction isolation level READ COMMITTED.
+      if isolation == :read_committed && adapter_type == 'mysql2'
+        options[:isolation] = :read_committed
+      end
+
+      ActiveRecord::Base.transaction(**options) do
+        yield
+      end
+    end
+
+    module_function :transaction
   end
 end

data/lib/glueby/configuration.rb

@@ -24,7 +24,7 @@ module Glueby
     end
 
     # Specify wallet adapter.
-    # @param [Symbol] adapter - The adapter type :activerecord or :core is currently supported.
+    # @param [Symbol] adapter - The adapter type :activerecord, :core, or :mysql is currently supported.
     def wallet_adapter=(adapter)
       case adapter
       when :core

data/lib/glueby/contract/active_record/timestamp.rb

@@ -9,16 +9,25 @@ module Glueby
 
         attr_reader :tx
 
-        belongs_to :prev, class_name: 'Glueby::Contract::AR::Timestamp', optional: true
+        belongs_to :prev, class_name: 'Glueby::Contract::AR::Timestamp', inverse_of: :next, optional: true
+        has_one :next, class_name: 'Glueby::Contract::AR::Timestamp', foreign_key: 'prev_id'
+
+        validates :version, presence: true, inclusion: { in: ['1', '2'] }
+
+        def next_id
+          self.next&.id
+        end
 
         validate :validate_prev
 
         class << self
-          def digest_content(content, digest)
+          def digest_content(content, digest, hex = false)
             case digest&.downcase
             when :sha256
+              content = hex ? content.htb : content
               Tapyrus.sha256(content).bth
             when :double_sha256
+              content = hex ? content.htb : content
               Tapyrus.double_sha256(content).bth
             when :none
               content
@@ -33,17 +42,23 @@ module Glueby
         # - content
         # - prefix(optional)
         # - timestamp_type(optional)
+        # - version [String] Version of the timestamp recording method.
+        #     The format in which the timestamp is recorded differs depending on the version.
+        #     Version "1" treats the specified content and prefix as a binary string.
+        #     Version "2" treats the specified content and prefix as a hexadecimal string with the string set to prefix and content.
         # @raise [Glueby::ArgumentError] If the timestamp_type is not in :simple or :trackable
         def initialize(attributes = nil)
           # Set content_hash from :content attribute
-          content_hash = Timestamp.digest_content(attributes[:content], attributes[:digest] || :sha256)
+          hex = attributes[:version] == '1' ? false : true
+          content_hash = Timestamp.digest_content(attributes[:content], attributes[:digest] || :sha256, hex)
           super(
             wallet_id: attributes[:wallet_id],
             content_hash: content_hash,
-            prefix: attributes[:prefix] ? attributes[:prefix] : '',
+            prefix: attributes[:prefix] || '',
             status: :init,
             timestamp_type: attributes[:timestamp_type] || :simple,
-            prev_id: attributes[:prev_id]
+            prev_id: attributes[:prev_id],
+            version: attributes[:version]
           )
         rescue ::ArgumentError => e
           raise Glueby::ArgumentError, e.message
@@ -109,6 +124,7 @@ module Glueby
 
               if update_trackable?
                 prev.latest = false
+                prev.next = self
                 prev.save!
               end
             end
@@ -124,6 +140,12 @@ module Glueby
           raise Errors::FailedToBroadcast, "failed to broadcast (id=#{id}, reason=#{e.message})"
         end
 
+        def hex?
+          version != '1'
+        end
+
+        alias_method :hex, :hex?
+
         private
 
         def wallet
@@ -134,14 +156,18 @@ module Glueby
           builder = builder_class.new(wallet, fee_estimator)
 
           if builder.instance_of?(Contract::Timestamp::TxBuilder::UpdatingTrackable)
+            prev_prefix = prev.hex ? prev.prefix&.htb : prev.prefix
+            prev_content_hash = prev.hex ? prev.content_hash&.htb : prev.content_hash
             builder.set_prev_timestamp_info(
               timestamp_utxo: prev.utxo,
               payment_base: prev.payment_base,
-              prefix: prev.prefix,
-              data: prev.content_hash
+              prefix: prev_prefix,
+              data: prev_content_hash
             )
           end
 
+          prefix = hex ? self.prefix&.htb : self.prefix
+          content_hash = hex ? self.content_hash&.htb : self.content_hash
           tx = builder.set_data(prefix, content_hash)
                       .set_inputs(utxo_provider)
                       .build

data/lib/glueby/contract/errors.rb

@@ -15,6 +15,7 @@ module Glueby
       class UnsupportedTokenType < ArgumentError; end
       class UnknownScriptPubkey < ArgumentError; end
       class UnsupportedDigestType < ArgumentError; end
+      class UnsupportedTimestampVersion < ArgumentError; end
       class PrevTimestampNotFound < ArgumentError; end
       class PrevTimestampIsNotTrackable < ArgumentError; end
       class UnnecessaryPrevTimestamp < ArgumentError; end

data/lib/glueby/contract/timestamp.rb

@@ -7,6 +7,51 @@ module Glueby
     # * 1 output to send the change TPC back to the wallet.
     #
     # Storing timestamp transaction to the blockchain enables everyone to verify that the data existed at that time and a user signed it.
+    #
+    # == Versioning Timestamp
+    #
+    # The timestamp has an attribute called "version".
+    # Version indicates how the timestamp is recorded in the blockchain. Currently, only versions 1 and 2 are supported, and each is recorded in the following manner
+    # * Version 1: The first version of the blockchain is used to record timestamps.
+    #     treats the content and prefix received as parameters as a binary string
+    # * Version 2:.
+    #     treats the specified content and prefix as a hexadecimal string with the string set to prefix and content.
+    #
+    # For example, when recording a simple type of timestamp, the difference between the content recorded by version 1 and version 2 is as follows
+    # Version 1: 
+    #   Save the timestamp as follows:
+    #
+    #  Glueby::Contract::Timestamp.new(
+    #    wallet: wallet,
+    #    content: "1234",
+    #    prefix: "071222",
+    #    digest: :none,
+    #    version: "1"
+    #  )
+    #
+    # The output script of the recorded transaction will include OP_RETURN and will look like this:
+    #
+    # OP_RETURN 30373132323231323334
+    #
+    # Note that prefix: "071222" and content: "1234" are interpreted as ASCII strings and their hexadecimal representation "3037313232323132323334" is recorded in the actual blockchain, respectively.
+    #
+    # Version 2: 
+    #
+    # To save the timestamp in version 2, simply change the version of the previous example to "2".
+    #
+    #  Glueby::Contract::Timestamp.new(
+    #    wallet: wallet,
+    #    content: "1234",
+    #    prefix: "071222",
+    #    digest: :none,
+    #    version: "2"
+    #  )
+    #
+    # The output script will look like this:
+    #
+    # OP_RETURN 0712221234
+    #
+    # In this case, prefix: "071222" and content: "1234" are treated as a hexadecimal string and recorded directly in the blockchain.
     class Timestamp
       P2C_DEFAULT_VALUE = 1_000
 
@@ -29,6 +74,10 @@ module Glueby
       # - :simple
       # - :trackable
       # @param [Integer] prev_timestamp_id The id column of glueby_timestamps that will be updated by the timestamp that will be created
+      # @param [String] version Version of the timestamp recording method.
+      #     The format in which the timestamp is recorded differs depending on the version.
+      #     Version "1" treats the specified content and prefix as a binary string.
+      #     Version "2" treats the specified content and prefix as a hexadecimal string with the string set to prefix and content.
       # @raise [Glueby::Contract::Errors::UnsupportedDigestType] if digest is unsupported
       # @raise [Glueby::Contract::Errors::InvalidTimestampType] if timestamp_type is unsupported
       def initialize(
@@ -39,7 +88,8 @@ module Glueby
         digest: :sha256,
         utxo_provider: nil,
         timestamp_type: :simple,
-        prev_timestamp_id: nil
+        prev_timestamp_id: nil,
+        version:
       )
         @wallet = wallet
         @content = content
@@ -51,6 +101,8 @@ module Glueby
         raise Glueby::Contract::Errors::InvalidTimestampType, "#{timestamp_type} is invalid type, supported types are :simple, and :trackable." unless [:simple, :trackable].include?(timestamp_type)
         @timestamp_type = timestamp_type
         @prev_timestamp_id = prev_timestamp_id
+        raise Glueby::Contract::Errors::UnsupportedTimestampVersion, "#{version} is unsupported, supported versions are '1' and '2'." unless ['1', '2'].include?(version)
+        @version = version
       end
 
       # broadcast to Tapyrus Core
@@ -66,7 +118,8 @@ module Glueby
           content: @content,
           timestamp_type: @timestamp_type,
           digest: @digest,
-          prev_id: @prev_timestamp_id
+          prev_id: @prev_timestamp_id,
+          version: @version
         )
         @ar.save_with_broadcast!(fee_estimator: @fee_estimator, utxo_provider: @utxo_provider)
         @ar.txid

data/lib/glueby/contract/token.rb

@@ -79,7 +79,6 @@ module Glueby
                          else
                            raise Glueby::Contract::Errors::UnsupportedTokenType
                          end
-
           [new(color_id: color_id), txs]
         end
 
@@ -87,27 +86,8 @@ module Glueby
           Glueby::AR::SystemInformation.use_only_finalized_utxo?
         end
 
-        # Sign to pay-to-contract output.
-        #
-        # @param issuer [Glueby::Walelt] Issuer of the token
-        # @param tx [Tapyrus::Tx] The transaction to be signed with metadata
-        # @param funding_tx [Tapyrus::Tx] The funding transaction that has pay-to-contract output in its first output
-        # @param payment_base [String] The public key used to generate pay to contract public key
-        # @param metadata [String] Data that represents token metadata
-        # @return [Tapyrus::Tx] signed tx
-        def sign_to_p2c_output(issuer, tx, funding_tx, payment_base, metadata)
-          utxo = { txid: funding_tx.txid, vout: 0, script_pubkey: funding_tx.outputs[0].script_pubkey.to_hex }
-          issuer.internal_wallet.sign_to_pay_to_contract_address(tx, utxo, payment_base, metadata)
-        end
-
         private
 
-        def create_p2c_address(wallet, metadata)
-          p2c_address, payment_base = wallet.internal_wallet.create_pay_to_contract_address(metadata)
-          script = Tapyrus::Script.parse_from_addr(p2c_address)
-          [script, p2c_address, payment_base]
-        end
-
         def issue_reissuable_token(issuer:, amount:, split: 1, fee_estimator:, metadata: nil)
           txb = Internal::ContractBuilder.new(
             sender_wallet: issuer.internal_wallet,
@@ -135,7 +115,7 @@ module Glueby
           script_pubkey = funding_tx.outputs.first.script_pubkey
           color_id = Tapyrus::Color::ColorIdentifier.reissuable(script_pubkey)
 
-          ActiveRecord::Base.transaction(joinable: false, requires_new: true) do
+          Glueby::AR.transaction(isolation: :read_committed) do
             # Store the script_pubkey for reissue the token.
             Glueby::Contract::AR::ReissuableToken.create!(
               color_id: color_id.to_hex,
@@ -226,7 +206,7 @@ module Glueby
                     .build
           end
 
-          ActiveRecord::Base.transaction(joinable: false, requires_new: true) do
+          Glueby::AR.transaction(isolation: :read_committed) do
             if metadata
               p2c_utxo = txb.p2c_utxos.first
               Glueby::Contract::AR::TokenMetadata.create!(
@@ -245,14 +225,6 @@ module Glueby
             end
           end
         end
-
-        # Add dummy inputs and outputs to tx for issue non-reissuable transaction and nft transaction
-        def dummy_issue_tx_from_out_point
-          tx = Tapyrus::Tx.new
-          receiver_colored_script = Tapyrus::Script.parse_from_payload('21c20000000000000000000000000000000000000000000000000000000000000000bc76a914000000000000000000000000000000000000000088ac'.htb)
-          tx.outputs << Tapyrus::TxOut.new(value: 0, script_pubkey: receiver_colored_script)
-          FeeEstimator.dummy_tx(tx)
-        end
       end
 
       attr_reader :color_id
@@ -354,7 +326,10 @@ module Glueby
           txb.pay(r[:address], r[:amount].to_i, color_id)
         end
 
-        tx = sender.internal_wallet.broadcast(txb.build)
+        tx = nil
+        Glueby::AR.transaction(isolation: :read_committed) do
+          tx = sender.internal_wallet.broadcast(txb.build)
+        end
         [color_id, tx]
       end
 
@@ -373,7 +348,7 @@ module Glueby
         raise Glueby::Contract::Errors::InsufficientTokens unless balance
         raise Glueby::Contract::Errors::InsufficientTokens if balance < amount
 
-        tx = Internal::ContractBuilder
+        builder = Internal::ContractBuilder
                 .new(
                   sender_wallet: sender.internal_wallet,
                   fee_estimator: fee_estimator,
@@ -382,9 +357,11 @@ module Glueby
                 )
                 .burn(amount, color_id)
                 .change_address(sender.internal_wallet.receive_address, color_id)
-                .build
 
-        sender.internal_wallet.broadcast(tx)
+        Glueby::AR.transaction(isolation: :read_committed) do
+          tx = builder.build
+          sender.internal_wallet.broadcast(tx)
+        end
       end
 
       # Return balance of token in the specified wallet.

data/lib/glueby/contract/tx_builder.rb

@@ -206,8 +206,8 @@ module Glueby
         tx = Tapyrus::Tx.new
 
         amount = receivers.reduce(0) { |sum, r| sum + r[:amount].to_i }
-        utxos = sender.internal_wallet.list_unspent(only_finalized)
-        sum_token, outputs = collect_colored_outputs(utxos, color_id, amount)
+        utxos = sender.internal_wallet.list_unspent(only_finalized, color_id: color_id)
+        sum_token, outputs = collect_colored_outputs(utxos, amount)
         fill_input(tx, outputs)
 
         receivers.each do |r|
@@ -247,8 +247,8 @@ module Glueby
       def create_burn_tx(color_id:, sender:, amount: 0, fee_estimator: FeeEstimator::Fixed.new, only_finalized: true)
         tx = Tapyrus::Tx.new
 
-        utxos = sender.internal_wallet.list_unspent(only_finalized)
-        sum_token, outputs = collect_colored_outputs(utxos, color_id, amount)
+        utxos = sender.internal_wallet.list_unspent(only_finalized, color_id: color_id)
+        sum_token, outputs = collect_colored_outputs(utxos, amount)
         fill_input(tx, outputs)
 
         fill_change_token(tx, sender, sum_token - amount, color_id) if amount.positive?
@@ -319,12 +319,9 @@ module Glueby
       # Returns the set of utxos that satisfies the specified amount and has the specified color_id.
       # if amount is not specified or 0, return all utxos with color_id
       # @param results [Array] response of Glueby::Internal::Wallet#list_unspent
-      # @param color_id [Tapyrus::Color::ColorIdentifier] color identifier
       # @param amount [Integer]
-      def collect_colored_outputs(results, color_id, amount = 0)
+      def collect_colored_outputs(results, amount = 0)
         results = results.inject([0, []]) do |sum, output|
-          next sum unless output[:color_id] == color_id.to_hex
-
           new_sum = sum[0] + output[:amount]
           new_outputs = sum[1] << output
           return [new_sum, new_outputs] if new_sum >= amount && amount.positive?

data/lib/glueby/fee_provider/tasks.rb

@@ -90,16 +90,6 @@ module Glueby
 
       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

data/lib/glueby/internal/contract_builder.rb

@@ -130,26 +130,26 @@ module Glueby
       )
         tx, index = nil
 
-        if Glueby.configuration.use_utxo_provider? || utxo_provider
-          utxo_provider ||= UtxoProvider.new
-          script_pubkey = Tapyrus::Script.parse_from_addr(address)
-          tx, index = utxo_provider.get_utxo(script_pubkey, amount)
-        else
-          fee_estimator ||= @fee_estimator
-          txb = Tapyrus::TxBuilder.new
-          fee = fee_estimator.fee(Contract::FeeEstimator.dummy_tx(txb.build))
-          _sum, utxos = sender_wallet
-                         .collect_uncolored_outputs(fee + amount, nil, only_finalized)
-          utxos.each { |utxo| txb.add_utxo(to_tapyrusrb_utxo_hash(utxo)) }
-          tx = txb.pay(address, amount)
-                  .change_address(sender_wallet.change_address)
-                  .fee(fee)
-                  .build
-          sender_wallet.sign_tx(tx)
-          index = 0
-        end
+        Glueby::AR.transaction(isolation: :read_committed) do
+          if Glueby.configuration.use_utxo_provider? || utxo_provider
+            utxo_provider ||= UtxoProvider.new
+            script_pubkey = Tapyrus::Script.parse_from_addr(address)
+            tx, index = utxo_provider.get_utxo(script_pubkey, amount)
+          else
+            fee_estimator ||= @fee_estimator
+            txb = Tapyrus::TxBuilder.new
+            fee = fee_estimator.fee(Contract::FeeEstimator.dummy_tx(txb.build))
+            _sum, utxos = sender_wallet
+                           .collect_uncolored_outputs(fee + amount, nil, only_finalized)
+            utxos.each { |utxo| txb.add_utxo(to_tapyrusrb_utxo_hash(utxo)) }
+            tx = txb.pay(address, amount)
+                    .change_address(sender_wallet.change_address)
+                    .fee(fee)
+                    .build
+            sender_wallet.sign_tx(tx)
+            index = 0
+          end
 
-        ActiveRecord::Base.transaction(joinable: false, requires_new: true) do
           # Here needs to use the return tx from Internal::Wallet#broadcast because the txid
           # is changed if you enable FeeProvider.
           tx = sender_wallet.broadcast(tx)
@@ -357,7 +357,7 @@ module Glueby
       end
 
       def get_fee_estimator(fee_estimator_name)
-        Glueby::Contract::FeeEstimator.get_const("#{fee_estimator_name.capitalize}", false).new
+        Glueby::Contract::FeeEstimator.const_get(fee_estimator_name.capitalize, false).new
       end
 
       def valid_fee_estimator?(fee_estimator)

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

@@ -65,6 +65,21 @@ module Glueby
           raise NotImplementedError, "You must implement #{self.class}##{__method__}"
         end
 
+        # Returns all tokens with specified color_id
+        #
+        # @param [String] wallet_id - The wallet id that is offered by `create_wallet()` method.
+        # @param [Boolean] only_finalized - includes only finalized UTXO value if it
+        #                                   is true. Default is true.
+        # @param [Tapyrus::Color::ColorIdentifier] color_id The color identifier associated with UTXO.
+        #                                                     It will return only UTXOs with specified color_id. If color_id is nil, it will return all UTXOs.
+        #                                                     If Tapyrus::Color::ColorIdentifier.default is specified, it will return uncolored UTXOs(i.e. TPC)
+        # @param [Integer] page - The page parameter is responsible for specifying the current page being viewed within the paginated results. default is 1.
+        # @param [Integer] per - The per parameter is used to determine the number of items to display per page. default is 25.
+        # @return [Array<Utxo>] The array of the utxos with specified color_id
+        def list_unspent_with_count(wallet_id, only_finalized = true, label = nil, color_id: nil, page: 1, per: 25)
+          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
         #
@@ -74,6 +89,9 @@ module Glueby
         # @param [String] label - Label for filtering UTXOs
         #                       - If label is nil or :unlabeled, only unlabeled UTXOs will be returned.
         #                       - If label=:all, it will return all utxos
+        # @param [Tapyrus::Color::ColorIdentifier] color_id - The color identifier. 
+        #                                                     It will return only UTXOs with specified color_id. If color_id is nil, it will return all UTXOs.
+        #                                                     If Tapyrus::Color::ColorIdentifier.default is specified, it will return uncolored UTXOs(i.e. TPC)
         # @return [Array of UTXO]
         #
         # ## The UTXO structure
@@ -84,7 +102,7 @@ module Glueby
         # - finalized: [Boolean] Whether the UTXO is finalized
         # - color_id: [String] Color id of the UTXO. If it is TPC UTXO, color_id is nil.
         # - script_pubkey: [String] Script pubkey of the UTXO
-        def list_unspent(wallet_id, only_finalized = true, label = nil)
+        def list_unspent(wallet_id, only_finalized = true, label = nil, color_id: nil)
           raise NotImplementedError, "You must implement #{self.class}##{__method__}"
         end
 
@@ -139,7 +157,7 @@ module Glueby
 
         # Returns information for the addresses
         #
-        # @param [String] address - The p2pkh address to get information about
+        # @param [String, Array<String>] addresses - The p2pkh address to get information about
         # @return [Array<Hash>] The array of hash instance which has keys wallet_id, label and purpose.
         #                       Returns blank array if the key correspond with the address is not exist.
         def get_addresses_info(addresses)

data/lib/glueby/internal/wallet/active_record/utxo.rb

@@ -38,6 +38,7 @@ module Glueby
               utxo = Utxo.find_or_initialize_by(txid: tx.txid, index: index)
               utxo.update!(
                 label: key.label,
+                color_id: output.script_pubkey.color_id&.to_hex,
                 script_pubkey: output.script_pubkey.to_hex,
                 value: output.value,
                 status: status,

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

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'securerandom'
+require 'kaminari'
 
 module Glueby
   module Internal
@@ -89,29 +90,18 @@ module Glueby
           utxos.sum(&:value)
         end
 
-        def list_unspent(wallet_id, only_finalized = true, label = nil)
-          wallet = AR::Wallet.find_by(wallet_id: wallet_id)
-          utxos = wallet.utxos.where(locked_at: nil)
-          utxos = utxos.where(status: :finalized) if only_finalized
-          if [:unlabeled, nil].include?(label)
-            utxos = utxos.where(label: nil)
-          elsif label && (label != :all)
-            utxos = utxos.where(label: label)
-          else
-            utxos
-          end
+        def list_unspent_with_count(wallet_id, only_finalized = true, label = nil, color_id: nil, page: 1, per: 25)
+          utxos = list_unspent_internal(wallet_id, color_id, only_finalized, label)
+          utxos = utxos.page(page).per(per) if per > 0
+          {
+            count: utxos.total_count,
+            outputs: utxos_to_h(utxos)
+          }
+        end 
 
-          utxos.map do |utxo|
-            {
-              txid: utxo.txid,
-              vout: utxo.index,
-              script_pubkey: utxo.script_pubkey,
-              color_id: utxo.color_id,
-              amount: utxo.value,
-              finalized: utxo.status == 'finalized',
-              label: utxo.label
-            }
-          end
+        def list_unspent(wallet_id, only_finalized = true, label = nil, color_id: nil)
+          utxos = list_unspent_internal(wallet_id, color_id, only_finalized, label)
+          utxos_to_h(utxos)
         end
 
         def sign_tx(wallet_id, tx, prevtxs = [], sighashtype: Tapyrus::SIGHASH_TYPE[:all])
@@ -120,7 +110,7 @@ module Glueby
         end
 
         def broadcast(wallet_id, tx, &block)
-          ::ActiveRecord::Base.transaction do
+          ::ActiveRecord::Base.transaction(joinable: false, requires_new: true) do
             AR::Utxo.destroy_for_inputs(tx)
             AR::Utxo.create_or_update_for_outputs(tx, status: :broadcasted)
             block.call(tx) if block
@@ -245,6 +235,37 @@ module Glueby
             key_type: Tapyrus::Key::TYPES[:compressed]
           )
         end
+
+        def list_unspent_internal(wallet_id, color_id = nil, only_finalized = true, label = nil)
+          wallet = AR::Wallet.find_by(wallet_id: wallet_id)
+          utxos = wallet.utxos.where(locked_at: nil)
+          utxos = utxos.where(color_id: color_id.to_hex) if color_id && !color_id.default?
+          utxos = utxos.where(color_id: nil) if color_id && color_id.default?
+          utxos = utxos.where(status: :finalized) if only_finalized
+          utxos = utxos.order(:id)
+          utxos = if [:unlabeled, nil].include?(label)
+            utxos = utxos.where(label: nil)
+          elsif label && (label != :all)
+            utxos = utxos.where(label: label)
+          else
+            utxos
+          end
+          utxos
+        end
+
+        def utxos_to_h(utxos)
+          utxos.map do |utxo|
+            {
+              txid: utxo.txid,
+              vout: utxo.index,
+              script_pubkey: utxo.script_pubkey,
+              color_id: utxo.color_id,
+              amount: utxo.value,
+              finalized: utxo.status == 'finalized',
+              label: utxo.label
+            }
+          end
+        end
       end
     end
   end

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

@@ -84,7 +84,7 @@ module Glueby
 
         # If label=nil, it will return unlabeled utxos to protect labeled utxos for specific purpose
         # If label=:all, it will return all utxos
-        def list_unspent(wallet_id, only_finalized = true, label = nil)
+        def list_unspent(wallet_id, only_finalized = true, label = nil, color_id: nil)
           perform_as(wallet_id) do |client|
             min_conf = only_finalized ? 1 : 0
             res = client.listunspent(min_conf)
@@ -97,6 +97,13 @@ module Glueby
               res
             end
 
+            if color_id
+              res = res.filter do |i|
+                script = Tapyrus::Script.parse_from_payload(i['scriptPubKey'].htb)
+                script.cp2pkh? || script.cp2sh? && color_id == Tapyrus::Color::ColorIdentifier.parse_from_payload(script.chunks[0].pushed_data)
+              end
+            end
+
             res.map do |i|
               script = Tapyrus::Script.parse_from_payload(i['scriptPubKey'].htb)
               color_id = if script.cp2pkh? || script.cp2sh?
@@ -177,7 +184,7 @@ module Glueby
           type = case sighashtype & (~(Tapyrus::SIGHASH_TYPE[:anyonecanpay]))
                  when Tapyrus::SIGHASH_TYPE[:all] then 'ALL'
                  when Tapyrus::SIGHASH_TYPE[:none] then 'NONE'
-                 when Tapyrus::SIGHASH_TYPE[:single] then 'SIGNLE'
+                 when Tapyrus::SIGHASH_TYPE[:single] then 'SINGLE'
                  else
                    raise Errors::InvalidSighashType, "Invalid sighash type '#{sighashtype}'"
                  end

data/lib/glueby/internal/wallet.rb

@@ -93,9 +93,25 @@ module Glueby
       # @param label [String] This label is used to filtered the UTXOs with labeled if a key or Utxo is labeled.
       #                    - If label is nil or :unlabeled, only unlabeled UTXOs will be returned.
       #                    - If label=:all, all UTXOs will be returned.
-      def list_unspent(only_finalized = true, label = :unlabeled)
+      # @param color_id [Tapyrus::Color::ColorIdentifier] The color identifier associated with UTXO.
+      #                    It will return only UTXOs with specified color_id. If color_id is nil, it will return all UTXOs.
+      #                    If Tapyrus::Color::ColorIdentifier.default is specified, it will return uncolored UTXOs(i.e. TPC)
+      # @param page [Integer] The page parameter is responsible for specifying the current page being viewed within the paginated results. default is 1.
+      # @param per [Integer] The per parameter is used to determine the number of items to display per page. default is 25.
+      def list_unspent_with_count(only_finalized = true, label = nil, color_id: nil, page: 1, per: 25)
+        wallet_adapter.list_unspent_with_count(id, only_finalized, label, color_id: color_id, page: page, per: per)
+      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 nil or :unlabeled, only unlabeled UTXOs will be returned.
+      #                    - If label=:all, all UTXOs will be returned.
+      # @param color_id [Tapyrus::Color::ColorIdentifier] The color identifier associated with UTXO.
+      #                    It will return only UTXOs with specified color_id. If color_id is nil, it will return all UTXOs.
+      #                    If Tapyrus::Color::ColorIdentifier.default is specified, it will return uncolored UTXOs(i.e. TPC)
+      def list_unspent(only_finalized = true, label = :unlabeled, color_id: nil )
         label = :unlabeled unless label
-        wallet_adapter.list_unspent(id, only_finalized, label)
+        wallet_adapter.list_unspent(id, only_finalized, label, color_id: color_id)
       end
 
       def lock_unspent(utxo)
@@ -171,8 +187,7 @@ module Glueby
         lock_utxos = false,
         excludes = []
       )
-        collect_utxos(amount, label, only_finalized, shuffle, lock_utxos, excludes) do |output|
-          next false unless output[:color_id].nil?
+        collect_utxos(amount, label, Tapyrus::Color::ColorIdentifier.default, only_finalized, shuffle, lock_utxos, excludes) do |output|
           next yield(output) if block_given?
 
           true
@@ -206,8 +221,7 @@ module Glueby
         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
+        collect_utxos(amount, label, color_id, only_finalized, shuffle, lock_utxos, excludes) do |output|
           next yield(output) if block_given?
 
           true
@@ -261,7 +275,7 @@ module Glueby
         while current_amount - fee < target_amount
           sum, utxos = collect_uncolored_outputs(
             fee + target_amount - current_amount,
-            nil, nil, true, true,
+            nil, false, true, true,
             provided_utxos,
             &block
           )
@@ -288,7 +302,8 @@ module Glueby
       def collect_utxos(
         amount,
         label,
-        only_finalized,
+        color_id,
+        only_finalized = true,
         shuffle = true,
         lock_utxos = false,
         excludes = []
@@ -296,7 +311,7 @@ module Glueby
         collect_all = amount.nil?
 
         raise Glueby::ArgumentError, 'amount must be positive' unless collect_all || amount.positive?
-        utxos = list_unspent(only_finalized, label)
+        utxos = list_unspent(only_finalized, label, color_id: color_id)
         utxos = utxos.shuffle if shuffle
 
         r = utxos.inject([0, []]) do |(sum, outputs), output|

data/lib/glueby/version.rb

@@ -1,3 +1,3 @@
 module Glueby
-  VERSION = "1.2.2"
+  VERSION = "1.3.0"
 end

data/lib/glueby/wallet.rb

@@ -46,6 +46,10 @@ module Glueby
       end
     end
 
+    def token_utxos(color_id = nil, only_finalized = true, page = 1, per = 25)
+      @internal_wallet.list_unspent_with_count(only_finalized, nil, color_id: color_id, page: page, per: per)
+    end
+
     private
 
     def initialize(internal_wallet)

data/lib/glueby.rb

@@ -19,7 +19,7 @@ module Glueby
 
   module GluebyLogger
     def logger
-      if defined?(Rails)
+      if defined?(Rails) && Rails.logger
         Rails.logger
       else
         Logger.new(STDOUT)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: glueby
 version: !ruby/object:Gem::Version
-  version: 1.2.2
+  version: 1.3.0
 platform: ruby
 authors:
 - azuchi
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-09-27 00:00:00.000000000 Z
+date: 2024-01-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tapyrus
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 7.0.0
+- !ruby/object:Gem::Dependency
+  name: kaminari
+  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: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -173,7 +187,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
@@ -181,15 +195,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
-signing_key: 
+rubygems_version: 3.5.3
+signing_key:
 specification_version: 4
 summary: A Ruby library of smart contracts that can be used on Tapyrus.
 test_files: []