glueby 1.0.0 → 1.1.0

data/lib/glueby/fee_provider/tasks.rb

@@ -38,10 +38,13 @@ module Glueby
 
         fee_outputs_count_to_be_created.times do
           txb.pay(address, fee_provider.fixed_fee)
+          sum -= fee_provider.fixed_fee
         end
+        fee = fee_provider.fixed_fee
+        fee += (sum - fee) if sum - fee < DUST_LIMIT
 
         tx = txb.change_address(address)
-                .fee(fee_provider.fixed_fee)
+                .fee(fee)
                 .build
         tx = wallet.sign_tx(tx)
         wallet.broadcast(tx, without_fee_provider: true)

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

@@ -86,6 +86,14 @@ module Glueby
           raise NotImplementedError, "You must implement #{self.class}##{__method__}"
         end
 
+        # Attempt to lock a specified utxo and update lock_at field
+        #
+        # @param wallet_id [String] The wallet id that is offered by `create_wallet()` method.
+        # @param utxo [Hash] The utxo hash object
+        def lock_unspent(wallet_id, utxo)
+          true
+        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.
@@ -157,6 +165,15 @@ module Glueby
           raise NotImplementedError, "You must implement #{self.class}##{__method__}"
         end
 
+        # Create pay to contract key
+        # @param [String] wallet_id - The wallet id that is offered by `create_wallet()` method.
+        # @param [Tapyrus::Key] payment_base - The public key used to generate pay to contract public key
+        # @param [String] contents - The data to be used for generating pay-to-contract address
+        # @return [Tapyrus::Key] Key for pay to contract 
+        def pay_to_contract_key(wallet_id, payment_base, contents)
+          raise NotImplementedError, "You must implement #{self.class}##{__method__}"
+        end
+
         # Sign to the pay to contract input
         # @param [String] wallet_id - The wallet id that is offered by `create_wallet()` method.
         # @param [Tapyrus::Tx] tx - The tx that has pay to contract input in the inputs list
@@ -170,9 +187,18 @@ module Glueby
         # @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
+        # @raise [Glueby::Internal::Wallet::Errors::InvalidSigner] when the wallet don't have any private key of the specified payment_base
         def sign_to_pay_to_contract_address(wallet_id, tx, utxo, payment_base, contents, sighashtype: Tapyrus::SIGHASH_TYPE[:all])
           raise NotImplementedError, "You must implement #{self.class}##{__method__}"
         end
+
+        # Return if wallet has the address
+        # @param wallet_id [String] The wallet id that is offered by `create_wallet()` method.
+        # @param address [String] address
+        # @return [Boolean] true if the wallet has an address, false otherwise
+        def has_address?(wallet_id, address)
+          raise NotImplementedError, "You must implement #{self.class}##{__method__}"
+        end
       end
     end
   end

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

@@ -20,7 +20,7 @@ module Glueby
           end
 
           def sign(data)
-            Tapyrus::Key.new(priv_key: self.private_key).sign(data, algo: :schnorr)
+            Tapyrus::Key.new(priv_key: self.private_key, key_type: Tapyrus::Key::TYPES[:compressed]).sign(data, algo: :schnorr)
           end
 
           def address
@@ -54,7 +54,7 @@ module Glueby
 
           def generate_key
             key = if private_key
-              Tapyrus::Key.new(priv_key: private_key)
+              Tapyrus::Key.new(priv_key: private_key, key_type: Tapyrus::Key::TYPES[:compressed])
             else
               Tapyrus::Key.generate
             end

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

@@ -8,6 +8,7 @@ module Glueby
           belongs_to :key
 
           validates :txid, uniqueness: { scope: :index, case_sensitive: false }
+          validate :check_dust_output
 
           enum status: { init: 0, broadcasted: 1, finalized: 2 }
 
@@ -44,6 +45,14 @@ module Glueby
               )
             end
           end
+
+        private
+
+          def check_dust_output
+            if !color_id && value < DUST_LIMIT
+              errors.add(:value, "is less than dust limit(#{DUST_LIMIT})")
+            end
+          end
         end
       end
     end

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

@@ -84,16 +84,15 @@ module Glueby
 
         def balance(wallet_id, only_finalized = true)
           wallet = AR::Wallet.find_by(wallet_id: wallet_id)
-          utxos = wallet.utxos
+          utxos = wallet.utxos.where(locked_at: nil)
           utxos = utxos.where(status: :finalized) if only_finalized
           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
+          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)
@@ -144,7 +143,7 @@ module Glueby
         def create_pubkey(wallet_id)
           wallet = AR::Wallet.find_by(wallet_id: wallet_id)
           key = wallet.keys.create(purpose: :receive)
-          Tapyrus::Key.new(pubkey: key.public_key)
+          Tapyrus::Key.new(pubkey: key.public_key, key_type: Tapyrus::Key::TYPES[:compressed])
         end
 
         def get_addresses(wallet_id, label = nil)
@@ -155,13 +154,17 @@ module Glueby
         end
 
         def create_pay_to_contract_address(wallet_id, contents)
+          pubkey = create_pubkey(wallet_id)
+          [pay_to_contract_key(wallet_id, pubkey, contents).to_p2pkh, pubkey.pubkey]
+        end
+
+        def pay_to_contract_key(wallet_id, pubkey, contents)
           # Calculate P + H(P || contents)G
           group = ECDSA::Group::Secp256k1
-          pubkey = create_pubkey(wallet_id)
           p = pubkey.to_point # P
           commitment = create_pay_to_contract_commitment(pubkey, contents)
           point = p + group.generator.multiply_by_scalar(commitment) # P + H(P || contents)G
-          [Tapyrus::Key.new(pubkey: point.to_hex(true)).to_p2pkh, pubkey.pubkey] # [p2c address, P]
+          Tapyrus::Key.new(pubkey: point.to_hex(true), key_type: Tapyrus::Key::TYPES[:compressed])
         end
 
         def sign_to_pay_to_contract_address(wallet_id, tx, utxo, payment_base, contents)
@@ -174,6 +177,12 @@ module Glueby
           tx
         end
 
+        def has_address?(wallet_id, address)
+          script_pubkey = Tapyrus::Script.parse_from_addr(address)
+          wallet = AR::Wallet.find_by(wallet_id: wallet_id)
+          wallet.keys.exists?(script_pubkey: script_pubkey.to_hex)
+        end
+
         private
 
         # Calculate commitment = H(P || contents)
@@ -181,22 +190,26 @@ module Glueby
         # @param [String] contents
         # @return Integer
         def create_pay_to_contract_commitment(pubkey, contents)
+          contents = (+contents).force_encoding('binary')
           group = ECDSA::Group::Secp256k1
           p = pubkey.to_point # P
-          Tapyrus.sha256(p.to_hex(true).htb + contents).bth.to_i(16) % group.order # H(P || contents)
+          Tapyrus.sha256(p.to_hex(true).htb + contents).bth.to_i(16) % group.order # H(P || contents) 
         end
 
         # @param [String] wallet_id
         # @param [String] payment_base The public key hex string
         # @param [String] contents
         # @return [Tapyrus::Key] pay to contract private key
+        # @raise [Errors::InvalidSigner] raises when the wallet don't have any private key of the specified payment_base
         def create_pay_to_contract_private_key(wallet_id, payment_base, contents)
           group = ECDSA::Group::Secp256k1
           wallet = AR::Wallet.find_by(wallet_id: wallet_id)
           ar_key = wallet.keys.where(public_key: payment_base).first
-          key = Tapyrus::Key.new(pubkey: payment_base)
+          raise Errors::InvalidSigner, "The wallet don't have any private key of the specified payment_base" unless ar_key
+
+          key = Tapyrus::Key.new(pubkey: payment_base, key_type: Tapyrus::Key::TYPES[:compressed])
           commitment = create_pay_to_contract_commitment(key, contents)
-          Tapyrus::Key.new(priv_key: ((ar_key.private_key.to_i(16) + commitment) % group.order).to_even_length_hex) # K + commitment
+          Tapyrus::Key.new(priv_key: ((ar_key.private_key.to_i(16) + commitment) % group.order).to_even_length_hex, key_type: Tapyrus::Key::TYPES[:compressed]) # K + commitment
         end
       end
     end

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

@@ -8,6 +8,7 @@ module Glueby
         class WalletAlreadyCreated < Error; end
         class WalletNotFound < Error; end
         class InvalidSighashType < Error; end
+        class InvalidSigner < Error; end
       end
     end
   end

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

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Glueby
+  module Internal
+    class Wallet
+      class MySQLWalletAdapter < ActiveRecordWalletAdapter
+        def lock_unspent(wallet_id, utxo)
+          ActiveRecord::Base.transaction(joinable: false, requires_new: true) do
+            record = AR::Utxo.lock("FOR UPDATE SKIP LOCKED").find_by(txid: utxo[:txid], index: utxo[:vout], locked_at: nil)
+            record&.update!(locked_at: Time.now)
+            record
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -149,7 +149,7 @@ module Glueby
           perform_as(wallet_id) do |client|
             address = client.getnewaddress('')
             info = client.getaddressinfo(address)
-            Tapyrus::Key.new(pubkey: info['pubkey'])
+            Tapyrus::Key.new(pubkey: info['pubkey'], key_type: Tapyrus::Key::TYPES[:compressed])
           end
         end
 

data/lib/glueby/internal/wallet.rb

@@ -31,8 +31,11 @@ module Glueby
       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 :MySQLWalletAdapter, 'glueby/internal/wallet/mysql_wallet_adapter'
       autoload :Errors, 'glueby/internal/wallet/errors'
 
+      include GluebyLogger
+
       class << self
         def create(wallet_id = nil)
           begin
@@ -91,6 +94,10 @@ module Glueby
         wallet_adapter.list_unspent(id, only_finalized, label)
       end
 
+      def lock_unspent(utxo)
+        wallet_adapter.lock_unspent(id, utxo)
+      end
+
       def delete
         wallet_adapter.delete_wallet(id)
       end
@@ -118,6 +125,7 @@ module Glueby
       # @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?
+        logger.info("Try to broadcast a tx (tx payload: #{tx.to_hex} )")
         wallet_adapter.broadcast(id, tx, &block)
         tx
       end
@@ -158,10 +166,18 @@ module Glueby
         wallet_adapter.create_pay_to_contract_address(id, contents)
       end
 
+      def pay_to_contract_key(payment_base, contents)
+        wallet_adapter.pay_to_contract_key(id, payment_base, contents)
+      end
+
       def sign_to_pay_to_contract_address(tx, utxo, payment_base, contents)
         wallet_adapter.sign_to_pay_to_contract_address(id, tx, utxo, payment_base, contents)
       end
 
+      def has_address?(address)
+        wallet_adapter.has_address?(id, address)
+      end
+
       private
 
       def wallet_adapter

data/lib/glueby/util/digest.rb

@@ -0,0 +1,23 @@
+module Glueby
+  module Util
+    module Digest
+      # Hash content with specified digest algorithm
+      #
+      # @param content [String] content to be hashed
+      # @param digest [Symbol] The symbol represents algorithm used for hashing. :sha256, :double_sha256, :none are available
+      # @return [String] hex string hashed from content
+      def digest_content(content, digest)
+        case digest&.downcase
+        when :sha256
+          Tapyrus.sha256(content).bth
+        when :double_sha256
+          Tapyrus.double_sha256(content).bth
+        when :none
+          content
+        else
+          raise Glueby::Contract::Errors::UnsupportedDigestType
+        end
+      end
+    end
+  end
+end

data/lib/glueby/utxo_provider/tasks.rb

@@ -15,7 +15,7 @@ module Glueby
       }
 
       def initialize
-        @utxo_provider = Glueby::UtxoProvider.new
+        @utxo_provider = Glueby::UtxoProvider.instance
       end
 
       # Create UTXOs for paying tpc
@@ -46,6 +46,8 @@ module Glueby
         return if added_outputs == 0
 
         fee = fee_estimator.fee(Contract::FeeEstimator.dummy_tx(txb.build))
+        fee += (sum - fee) if sum - fee < DUST_LIMIT
+
         tx = txb.change_address(utxo_provider.address)
                 .fee(fee)
                 .build

data/lib/glueby/utxo_provider.rb

@@ -1,6 +1,7 @@
 module Glueby
   class UtxoProvider
     include Glueby::Contract::TxBuilder
+    include Singleton
 
     autoload :Tasks, 'glueby/utxo_provider/tasks'
 
@@ -63,6 +64,41 @@ module Glueby
       [signed_tx, 0]
     end
 
+    # Fill inputs in the tx up to target_amount of TPC from UTXO pool
+    # 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_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
+      end
+
+      [tx, fee, current_amount, provided_utxos]
+    end
+
     def default_value
       @default_value ||=
         (
@@ -110,16 +146,27 @@ module Glueby
       end
     end
 
-    def collect_uncolored_outputs(wallet, amount)
-      utxos = wallet.list_unspent.select { |o| !o[:color_id] && o[:amount] == default_value }
+    # Collects and returns TPC UTXOs.
+    # @param [Glueby::Internal::Wallet] wallet The wallet that funds the caller
+    # @param [Integer] amount The target amount which to be collected
+    # @param [Array<Hash>] excludes The exclusion UTXO list. It excludes this UTXOs from the targets that will be collected TPC UTXOs.
+    # @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, output|
-        new_sum = sum[0] + output[:amount]
-        new_outputs = sum[1] << output
-        return [new_sum, new_outputs] if new_sum >= amount
-
-        [new_sum, new_outputs]
+      
+      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]
       end
       raise Glueby::Contract::Errors::InsufficientFunds
     end

data/lib/glueby/version.rb

@@ -1,3 +1,3 @@
 module Glueby
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

data/lib/tasks/glueby/block_syncer.rake

@@ -25,5 +25,12 @@ namespace :glueby do
         puts "success in synchronization (block height=#{height})"
       end
     end
+
+    desc 'Update the block height in Glueby::AR::SystemInformation and do not run Glueby::BlockSyncer. This task is intended to skip the synchronization process until the latest block height.'
+    task :update_height, [] => [:environment] do |_, _|
+      new_height = Glueby::Internal::RPC.client.getblockcount
+      synced_block = Glueby::AR::SystemInformation.synced_block_height
+      synced_block.update(info_value: new_height.to_s)
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: glueby
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - azuchi
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-04-07 00:00:00.000000000 Z
+date: 2022-11-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tapyrus
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.2.13
+        version: 0.3.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.2.13
+        version: 0.3.1
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: mysql2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
@@ -88,15 +102,16 @@ files:
 - glueby.gemspec
 - lib/generators/glueby/contract/block_syncer_generator.rb
 - lib/generators/glueby/contract/initializer_generator.rb
-- lib/generators/glueby/contract/reissuable_token_generator.rb
 - lib/generators/glueby/contract/templates/initializer.rb.erb
 - lib/generators/glueby/contract/templates/key_table.rb.erb
 - lib/generators/glueby/contract/templates/reissuable_token_table.rb.erb
 - lib/generators/glueby/contract/templates/system_information_table.rb.erb
 - lib/generators/glueby/contract/templates/timestamp_table.rb.erb
+- lib/generators/glueby/contract/templates/token_metadata_table.rb.erb
 - lib/generators/glueby/contract/templates/utxo_table.rb.erb
 - lib/generators/glueby/contract/templates/wallet_table.rb.erb
 - lib/generators/glueby/contract/timestamp_generator.rb
+- lib/generators/glueby/contract/token_generator.rb
 - lib/generators/glueby/contract/wallet_adapter_generator.rb
 - lib/glueby.rb
 - lib/glueby/active_record.rb
@@ -108,6 +123,7 @@ files:
 - lib/glueby/contract/active_record.rb
 - lib/glueby/contract/active_record/reissuable_token.rb
 - lib/glueby/contract/active_record/timestamp.rb
+- lib/glueby/contract/active_record/token_metadata.rb
 - lib/glueby/contract/errors.rb
 - lib/glueby/contract/fee_estimator.rb
 - lib/glueby/contract/fee_estimator/auto.rb
@@ -136,8 +152,10 @@ files:
 - lib/glueby/internal/wallet/active_record_wallet_adapter.rb
 - lib/glueby/internal/wallet/active_record_wallet_adapter/syncer.rb
 - lib/glueby/internal/wallet/errors.rb
+- lib/glueby/internal/wallet/mysql_wallet_adapter.rb
 - lib/glueby/internal/wallet/tapyrus_core_wallet_adapter.rb
 - lib/glueby/railtie.rb
+- lib/glueby/util/digest.rb
 - lib/glueby/utxo_provider.rb
 - lib/glueby/utxo_provider/tasks.rb
 - lib/glueby/version.rb