glueby 0.6.1 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2b053cde5755947020d018939a4efa0a042e830232aff3e4d2a4a4a9b53caa54
-  data.tar.gz: 5fcfb3f983b687f6942901d7f56c9f70a5123b97e0f5eb313d3a011632824f76
+  metadata.gz: 165b5d6b9fc1cfae9bb7ba852632a0f099ef356bcb52fe0a9937b2c2d1289b51
+  data.tar.gz: 6d1a3b9cc1c3668a40ce11920af51cb8af8fc9d94163e43eca295a40d48889f0
 SHA512:
-  metadata.gz: 440cd7203e5d411dc0aca3571e2eaa14b2c2ef85ca97d9ed60c7b9099d206dc9d4fbaa4dfb65190ddcc9fc71bbb57555abc42cde5cf2d3319fa4c8c18f3b70cf
-  data.tar.gz: 4dac9b8cb1a8a6670e8ee0458f467c66c91994b103e8d9513bbbfb926c27f9b0541de4bdfe12085edb58b1ac9f761775abf88f3dcb93ab43f9ba17ad0c96f840
+  metadata.gz: d7d6f4cf39f9b2c4580d1360817baa960bf72fe77075a038a7784b2f9191bb0cb9925c27d8b697c5d0a75e0d0bc31d35cfda14e3a88e18da88dba09e38aa5246
+  data.tar.gz: 691dd9cec6eb183f537c70efab553bd9224bea93fe21da6cb8ce2afea14549e74bd02fa8e73dd3518703b6b390f217d0b02ad3d85649b8eea4e6b6583c1fd196

data/lib/glueby/constants.rb

@@ -0,0 +1,4 @@
+module Glueby
+  # The minimum limit of transaction output value to avoid to be recognized as a dust output.
+  DUST_LIMIT = 600
+end

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

@@ -2,7 +2,10 @@ module Glueby
   module Contract
     module AR
       class Timestamp < ::ActiveRecord::Base
+        include Glueby::GluebyLogger
         include Glueby::Contract::Timestamp::Util
+        include Glueby::Contract::TxBuilder
+
         enum status: { init: 0, unconfirmed: 1, confirmed: 2 }
         enum timestamp_type: { simple: 0, trackable: 1 }
 
@@ -21,6 +24,33 @@ module Glueby
         def latest
           trackable?
         end
+
+        # Broadcast and save timestamp
+        # @param [Glueby::Contract::FixedFeeEstimator] fee_estimator
+        # @return true if tapyrus transactions were broadcasted and the timestamp was updated successfully, otherwise false.
+        def save_with_broadcast(fee_estimator: Glueby::Contract::FixedFeeEstimator.new)
+          utxo_provider = Glueby::UtxoProvider.new if Glueby.configuration.use_utxo_provider?
+          wallet = Glueby::Wallet.load(wallet_id)
+          funding_tx, tx, p2c_address, payment_base = create_txs(wallet, prefix, content_hash, fee_estimator, utxo_provider, type: timestamp_type.to_sym)
+          if funding_tx
+            ::ActiveRecord::Base.transaction(joinable: false, requires_new: true) do
+              wallet.internal_wallet.broadcast(funding_tx)
+              logger.info("funding tx was broadcasted(id=#{id}, funding_tx.txid=#{funding_tx.txid})")
+            end
+          end
+          ::ActiveRecord::Base.transaction(joinable: false, requires_new: true) do
+            wallet.internal_wallet.broadcast(tx) do |tx|
+              assign_attributes(txid: tx.txid, status: :unconfirmed, p2c_address: p2c_address, payment_base: payment_base)
+              save!
+            end
+            logger.info("timestamp tx was broadcasted (id=#{id}, txid=#{tx.txid})")
+          end
+          true
+        rescue => e
+          logger.error("failed to broadcast (id=#{id}, reason=#{e.message})")
+          errors.add(:base, "failed to broadcast (id=#{id}, reason=#{e.message})")
+          false
+        end
       end
     end
   end

data/lib/glueby/contract/fee_estimator.rb

@@ -22,6 +22,8 @@ module Glueby
     class FixedFeeEstimator
       include FeeEstimator
 
+      attr_reader :fixed_fee
+
       class << self
         attr_accessor :default_fixed_fee
       end

data/lib/glueby/contract/timestamp.rb

@@ -19,9 +19,8 @@ module Glueby
         module_function
 
         # @param [Glueby::Wallet] wallet
-        # @param [Array] data The data to be used for generating pay-to-contract address
-        # @return [Array(String, String)]
-        #    Return (pay-to-contract address, public key used for generating address)
+        # @param [Array] contents The data to be used for generating pay-to-contract address
+        # @return [pay-to-contract address, public key used for generating address]
         def create_pay_to_contract_address(wallet, contents: nil)
           pubkey = wallet.internal_wallet.create_pubkey.pubkey
           # Calculate P + H(P || contents)G

data/lib/glueby/contract/token.rb

@@ -80,8 +80,7 @@ module Glueby
         private
 
         def issue_reissuable_token(issuer:, amount:)
-          utxo_provider = Glueby::UtxoProvider.new if Glueby.configuration.use_utxo_provider?
-          funding_tx = create_funding_tx(wallet: issuer, utxo_provider: utxo_provider)
+          funding_tx = create_funding_tx(wallet: issuer)
           script_pubkey = funding_tx.outputs.first.script_pubkey
           color_id = Tapyrus::Color::ColorIdentifier.reissuable(script_pubkey)
 
@@ -97,8 +96,7 @@ module Glueby
         end
 
         def issue_non_reissuable_token(issuer:, amount:)
-          utxo_provider = Glueby::UtxoProvider.new if Glueby.configuration.use_utxo_provider?
-          funding_tx = create_funding_tx(wallet: issuer, utxo_provider: utxo_provider) if utxo_provider
+          funding_tx = create_funding_tx(wallet: issuer) if Glueby.configuration.use_utxo_provider?
           funding_tx = issuer.internal_wallet.broadcast(funding_tx) if funding_tx
 
           tx = create_issue_tx_for_non_reissuable_token(funding_tx: funding_tx, issuer: issuer, amount: amount)
@@ -114,8 +112,7 @@ module Glueby
         end
 
         def issue_nft_token(issuer:)
-          utxo_provider = Glueby::UtxoProvider.new if Glueby.configuration.use_utxo_provider?
-          funding_tx = create_funding_tx(wallet: issuer, utxo_provider: utxo_provider) if utxo_provider
+          funding_tx = create_funding_tx(wallet: issuer) if Glueby.configuration.use_utxo_provider?
           funding_tx = issuer.internal_wallet.broadcast(funding_tx) if funding_tx
 
           tx = create_issue_tx_for_nft_token(funding_tx: funding_tx, issuer: issuer)
@@ -145,10 +142,9 @@ module Glueby
       def reissue!(issuer:, amount:)
         raise Glueby::Contract::Errors::InvalidAmount unless amount.positive?
         raise Glueby::Contract::Errors::InvalidTokenType unless token_type == Tapyrus::Color::TokenTypes::REISSUABLE
-        utxo_provider = Glueby::UtxoProvider.new if Glueby.configuration.use_utxo_provider?
 
         if validate_reissuer(wallet: issuer)
-          funding_tx = create_funding_tx(wallet: issuer, script: @script_pubkey, utxo_provider: utxo_provider)
+          funding_tx = create_funding_tx(wallet: issuer, script: @script_pubkey)
           funding_tx = issuer.internal_wallet.broadcast(funding_tx)
           tx = create_reissue_tx(funding_tx: funding_tx, issuer: issuer, amount: amount, color_id: color_id)
           tx = issuer.internal_wallet.broadcast(tx)
@@ -171,8 +167,7 @@ module Glueby
       def transfer!(sender:, receiver_address:, amount: 1)
         raise Glueby::Contract::Errors::InvalidAmount unless amount.positive?
 
-        utxo_provider = Glueby::UtxoProvider.new if Glueby.configuration.use_utxo_provider?
-        funding_tx = create_funding_tx(wallet: sender, utxo_provider: utxo_provider) if utxo_provider
+        funding_tx = create_funding_tx(wallet: sender) if Glueby.configuration.use_utxo_provider?
         funding_tx = sender.internal_wallet.broadcast(funding_tx) if funding_tx
 
         tx = create_transfer_tx(funding_tx: funding_tx, color_id: color_id, sender: sender, receiver_address: receiver_address, amount: amount)
@@ -180,6 +175,26 @@ module Glueby
         [color_id, tx]
       end
 
+      # Send the tokens to multiple wallets
+      #
+      # @param sender [Glueby::Wallet] wallet to send this token
+      # @param receivers [Array<Hash>] array of hash, which keys are :address and :amount
+      # @return [Array<String, tx>] Tuple of color_id and tx object
+      # @raise [InsufficientFunds] if wallet does not have enough TPC to send transaction.
+      # @raise [InsufficientTokens] if wallet does not have enough token to send.
+      # @raise [InvalidAmount] if amount is not positive integer.
+      def multi_transfer!(sender:, receivers:)
+        receivers.each do |r|
+          raise Glueby::Contract::Errors::InvalidAmount unless r[:amount].positive?
+        end
+        funding_tx = create_funding_tx(wallet: sender) if Glueby.configuration.use_utxo_provider?
+        funding_tx = sender.internal_wallet.broadcast(funding_tx) if funding_tx
+
+        tx = create_multi_transfer_tx(funding_tx: funding_tx, color_id: color_id, sender: sender, receivers: receivers)
+        sender.internal_wallet.broadcast(tx)
+        [color_id, tx]
+      end
+
       # Burn token
       # If amount is not specified or 0, burn all token associated with the wallet.
       #
@@ -190,9 +205,24 @@ module Glueby
       # @raise [InvalidAmount] if amount is not positive integer.
       def burn!(sender:, amount: 0)
         raise Glueby::Contract::Errors::InvalidAmount unless amount.positive?
+        balance = sender.balances[color_id.to_hex]
+        raise Glueby::Contract::Errors::InsufficientTokens unless balance
+        raise Glueby::Contract::Errors::InsufficientTokens if balance < amount
+
+        burn_all_amount_flag = true if balance - amount == 0
 
         utxo_provider = Glueby::UtxoProvider.new if Glueby.configuration.use_utxo_provider?
-        funding_tx = create_funding_tx(wallet: sender, utxo_provider: utxo_provider) if utxo_provider
+        if utxo_provider
+          funding_tx = create_funding_tx(
+            wallet: sender,
+            # When it burns all the amount of the color id, burn tx is not going to be have any output
+            # because change outputs is not necessary. Transactions needs one output at least.
+            # At that time, set true to this option to get more value to be created change output to
+            # the tx.
+            need_value_for_change_output: burn_all_amount_flag
+          )
+        end
+
         funding_tx = sender.internal_wallet.broadcast(funding_tx) if funding_tx
 
         tx = create_burn_tx(funding_tx: funding_tx, color_id: color_id, sender: sender, amount: amount)

data/lib/glueby/contract/tx_builder.rb

@@ -3,24 +3,22 @@
 module Glueby
   module Contract
     module TxBuilder
-      # The amount of output in funding tx for Reissuable token.
-      FUNDING_TX_AMOUNT = 10_000
-
       def receive_address(wallet:)
         wallet.receive_address
       end
 
       # Create new public key, and new transaction that sends TPC to it
-      def create_funding_tx(wallet:, script: nil, fee_estimator: FixedFeeEstimator.new, utxo_provider: nil)
-        if utxo_provider
+      def create_funding_tx(wallet:, script: nil, fee_estimator: FixedFeeEstimator.new, need_value_for_change_output: false)
+        if Glueby.configuration.use_utxo_provider?
+          utxo_provider = UtxoProvider.new
           script_pubkey = script ? script : Tapyrus::Script.parse_from_addr(wallet.internal_wallet.receive_address)
-          funding_tx, _index = utxo_provider.get_utxo(script_pubkey, FUNDING_TX_AMOUNT)
+          funding_tx, _index = utxo_provider.get_utxo(script_pubkey, funding_tx_amount(need_value_for_change_output: need_value_for_change_output))
           utxo_provider.wallet.sign_tx(funding_tx)
         else
           txb = Tapyrus::TxBuilder.new
           fee = fee_estimator.fee(dummy_tx(txb.build))
 
-          sum, outputs = wallet.internal_wallet.collect_uncolored_outputs(fee + FUNDING_TX_AMOUNT)
+          sum, outputs = wallet.internal_wallet.collect_uncolored_outputs(fee + funding_tx_amount(need_value_for_change_output: need_value_for_change_output))
           outputs.each do |utxo|
             txb.add_utxo({
               script_pubkey: Tapyrus::Script.parse_from_payload(utxo[:script_pubkey].htb),
@@ -31,7 +29,7 @@ module Glueby
           end
   
           receiver_address = script ? script.addresses.first : wallet.internal_wallet.receive_address
-          tx = txb.pay(receiver_address, FUNDING_TX_AMOUNT)
+          tx = txb.pay(receiver_address, funding_tx_amount)
             .change_address(wallet.internal_wallet.change_address)
             .fee(fee)
             .build
@@ -135,15 +133,23 @@ module Glueby
       end
 
       def create_transfer_tx(funding_tx:nil, color_id:, sender:, receiver_address:, amount:, fee_estimator: FixedFeeEstimator.new)
+        receivers = [{ address: receiver_address, amount: amount }]
+        create_multi_transfer_tx(funding_tx: funding_tx, color_id: color_id, sender: sender, receivers: receivers, fee_estimator: fee_estimator)
+      end
+
+      def create_multi_transfer_tx(funding_tx:nil, color_id:, sender:, receivers:, fee_estimator: FixedFeeEstimator.new)
         tx = Tapyrus::Tx.new
 
+        amount = receivers.reduce(0) { |sum, r| sum + r[:amount].to_i }
         utxos = sender.internal_wallet.list_unspent
         sum_token, outputs = collect_colored_outputs(utxos, color_id, amount)
         fill_input(tx, outputs)
 
-        receiver_script = Tapyrus::Script.parse_from_addr(receiver_address)
-        receiver_colored_script = receiver_script.add_color(color_id)
-        tx.outputs << Tapyrus::TxOut.new(value: amount, script_pubkey: receiver_colored_script)
+        receivers.each do |r|
+          receiver_script = Tapyrus::Script.parse_from_addr(r[:address])
+          receiver_colored_script = receiver_script.add_color(color_id)
+          tx.outputs << Tapyrus::TxOut.new(value: r[:amount].to_i, script_pubkey: receiver_colored_script)
+        end
 
         fill_change_token(tx, sender, sum_token - amount, color_id)
 
@@ -189,8 +195,7 @@ module Glueby
           tx.inputs << Tapyrus::TxIn.new(out_point: out_point)
           funding_tx.outputs.first.value
         else
-          dust = 600 # in case that the wallet has output which has just fee amount.
-          sum_tpc, outputs = sender.internal_wallet.collect_uncolored_outputs(fee + dust)
+          sum_tpc, outputs = sender.internal_wallet.collect_uncolored_outputs(fee + DUST_LIMIT)
           fill_input(tx, outputs)
           sum_tpc
         end
@@ -220,7 +225,12 @@ module Glueby
       def fill_change_tpc(tx, wallet, change)
         return unless change.positive?
 
-        change_script = Tapyrus::Script.parse_from_addr(wallet.internal_wallet.change_address)
+        if Glueby.configuration.use_utxo_provider?
+          change_script = Tapyrus::Script.parse_from_addr(UtxoProvider.new.wallet.change_address)
+        else
+          change_script = Tapyrus::Script.parse_from_addr(wallet.internal_wallet.change_address)
+        end
+
         tx.outputs << Tapyrus::TxOut.new(value: change, script_pubkey: change_script)
       end
 
@@ -278,6 +288,21 @@ module Glueby
         tx.outputs << Tapyrus::TxOut.new(value: 0, script_pubkey: receiver_colored_script)
         dummy_tx(tx)
       end
+
+      private
+
+      # The amount of output in funding tx
+      # It returns same amount with FixedFeeEstimator's fixed fee. Because it is enough for paying fee for consumer
+      # transactions of the funding transactions.
+      #
+      # @option [Boolean] need_value_for_change_output If it is true, adds more value than the fee for producing change output.
+      def funding_tx_amount(need_value_for_change_output: false)
+        if need_value_for_change_output
+          FixedFeeEstimator.new.fixed_fee + DUST_LIMIT
+        else
+          FixedFeeEstimator.new.fixed_fee
+        end
+      end
     end
   end
 end

data/lib/glueby/utxo_provider/tasks.rb

@@ -29,7 +29,6 @@ module Glueby
         return if utxos.empty?
 
         utxos.each { |utxo| txb.add_utxo(utxo) }
-        address = wallet.receive_address
 
         shortage = [utxo_provider.utxo_pool_size - current_utxo_pool_size, 0].max
         return if shortage == 0
@@ -65,7 +64,7 @@ module Glueby
             message = <<~MESSAGE
             1. Please replenishment TPC which is for paying tpc to UtxoProvider. 
               UtxoProvider needs #{value_to_fill_utxo_pool} tapyrus in UTXO pool. 
-              UtxoProvider wallet's address is '#{wallet.receive_address}'
+              UtxoProvider wallet's address is '#{address}'
             2. Then create UTXOs for paying in UTXO pool with 'rake glueby:utxo_provider:manage_utxo_pool'
             MESSAGE
           else
@@ -88,7 +87,7 @@ module Glueby
 
       # Show the address of Utxo Provider 
       def print_address
-        puts wallet.receive_address
+        puts address
       end
 
       private
@@ -130,6 +129,10 @@ module Glueby
       def delimit(num)
         num.to_s.reverse.scan(/.{1,3}/).join('_').reverse
       end
+
+      def address
+        @address ||= wallet.get_addresses.first || wallet.receive_address
+      end
     end
   end
 end

data/lib/glueby/utxo_provider.rb

@@ -44,7 +44,7 @@ module Glueby
 
       fee = fee_estimator.fee(dummy_tx(txb.build))
       # The outputs need to be shuffled so that no utxos are spent twice as possible.
-      sum, outputs = wallet.collect_uncolored_outputs(fee + value, nil, true, true)
+      sum, outputs = collect_uncolored_outputs(wallet, fee + value)
 
       outputs.each do |utxo|
         txb.add_utxo({
@@ -73,6 +73,20 @@ module Glueby
       end
     end
 
+    def collect_uncolored_outputs(wallet, amount)
+      utxos = wallet.list_unspent.select { |o| !o[:color_id] && o[:amount] == @default_value }
+      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]
+      end
+      raise Glueby::Contract::Errors::InsufficientFunds
+    end
+
     def validate_config!
       if UtxoProvider.config
         utxo_pool_size = UtxoProvider.config[:utxo_pool_size]

data/lib/glueby/version.rb

@@ -1,3 +1,3 @@
 module Glueby
-  VERSION = "0.6.1"
+  VERSION = "0.7.0"
 end

data/lib/glueby.rb

@@ -1,4 +1,5 @@
 require "glueby/version"
+require "glueby/constants"
 require 'tapyrus'
 
 module Glueby
@@ -16,6 +17,16 @@ module Glueby
     require 'glueby/railtie'
   end
 
+  module GluebyLogger
+    def logger
+      if defined?(Rails)
+        Rails.logger
+      else
+        Logger.new(STDOUT)
+      end
+    end
+  end
+
   # Add prefix to activerecord table names
   def self.table_name_prefix
     'glueby_'

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

@@ -8,27 +8,8 @@ module Glueby
 
         def create
           timestamps = Glueby::Contract::AR::Timestamp.where(status: :init)
-          utxo_provider = Glueby::UtxoProvider.new if Glueby.configuration.use_utxo_provider?
-          timestamps.each do |t|
-            begin
-              wallet = Glueby::Wallet.load(t.wallet_id)
-              funding_tx, tx, p2c_address, payment_base = create_txs(wallet, t.prefix, t.content_hash, Glueby::Contract::FixedFeeEstimator.new, utxo_provider, type: t.timestamp_type.to_sym)
-              if funding_tx
-                ::ActiveRecord::Base.transaction do
-                  wallet.internal_wallet.broadcast(funding_tx)
-                  puts "funding tx was broadcasted(id=#{t.id}, funding_tx.txid=#{funding_tx.txid})"
-                end
-              end
-              ::ActiveRecord::Base.transaction do
-                wallet.internal_wallet.broadcast(tx) do |tx|
-                  t.update(txid: tx.txid, status: :unconfirmed, p2c_address: p2c_address, payment_base: payment_base)
-                end
-                puts "timestamp tx was broadcasted (id=#{t.id}, txid=#{tx.txid})"
-              end
-            rescue => e
-              puts "failed to broadcast (id=#{t.id}, reason=#{e.message})"
-            end
-          end
+          fee_estimator = Glueby::Contract::FixedFeeEstimator.new
+          timestamps.each { |t| t.save_with_broadcast(fee_estimator: fee_estimator) }
         end
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: glueby
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.7.0
 platform: ruby
 authors:
 - azuchi
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-12-09 00:00:00.000000000 Z
+date: 2022-01-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tapyrus
@@ -103,6 +103,7 @@ files:
 - lib/glueby/active_record/system_information.rb
 - lib/glueby/block_syncer.rb
 - lib/glueby/configuration.rb
+- lib/glueby/constants.rb
 - lib/glueby/contract.rb
 - lib/glueby/contract/active_record.rb
 - lib/glueby/contract/active_record/reissuable_token.rb
@@ -147,7 +148,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
@@ -163,7 +164,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.2.3
-signing_key: 
+signing_key:
 specification_version: 4
 summary: A Ruby library of smart contracts that can be used on Tapyrus.
 test_files: []