glueby 0.5.2 → 0.6.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 70bc38595142acecb4510e2bae12054de9bf4d8da4ddacbe220be0dab7c76324
-  data.tar.gz: 87f1bc6a29b3aa38a35aa929c1cf8cc5190ec768265b873cdebc7c4b47481996
+  metadata.gz: ea6c9da8fdd46b8e2d82e7d403580d160f8eded28723f7ee33c14e002be5428f
+  data.tar.gz: d74cc716d2ce35f19eb0ed5d9eb6d46cd464fa3a19a87073dd61a1e2180ef5fe
 SHA512:
-  metadata.gz: c87104af19662964d241fbd132fa351b3919c7c4c3079fbb3a0b1f1a2275b24c400d07edc570f63875b3f5884a18bae2720519377ea17e6bda38bfd1717d0702
-  data.tar.gz: aeae4f6edae4081df4288ee2ac35188abefefd8e240b2536447890de547f5b4136ed95caf8142fd4dc85b57947253221d641fde1c0fcd8a8fae1d22ae09ae420
+  metadata.gz: 6c6c75c349edfd4c5ee5fc0e752ce9c65f1ad2f5b323d38f2a51b2ab5d91de8786daf67f1bfb1fdd221a7cc10cf891b6f6551fd58afe8059593a81536027d25c
+  data.tar.gz: 38c2b4a8e2a085bf238ca37fd1a39930e2b337d0f80a9695adb45116dc8e2cc4478c3c0041c08b0def00cdf15235664bee9d4c6beb9e7a285c1320f8f1b768c2

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

@@ -2,10 +2,13 @@ class CreateTimestamp < ActiveRecord::Migration<%= migration_version %>
   def change
     create_table :glueby_timestamps<%= table_options %> do |t|
       t.string   :txid
-      t.integer  :status
+      t.integer  :status, null: false, default: 0
       t.string   :content_hash
       t.string   :prefix
       t.string   :wallet_id
+      t.integer  :timestamp_type, null: false, default: 0
+      t.string   :p2c_address
+      t.string   :payment_base
     end
   end
 end

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

@@ -4,15 +4,22 @@ module Glueby
       class Timestamp < ::ActiveRecord::Base
         include Glueby::Contract::Timestamp::Util
         enum status: { init: 0, unconfirmed: 1, confirmed: 2 }
+        enum timestamp_type: { simple: 0, trackable: 1 }
 
         # @param [Hash] attributes attributes which consist of:
         # - wallet_id
         # - content
         # - prefix(optional)
+        # - timestamp_type(optional)
         def initialize(attributes = nil)
           @content_hash = Tapyrus.sha256(attributes[:content]).bth
           super(wallet_id: attributes[:wallet_id], content_hash: @content_hash,
-                prefix: attributes[:prefix] ? attributes[:prefix] : '', status: :init)
+                prefix: attributes[:prefix] ? attributes[:prefix] : '', status: :init, timestamp_type: attributes[:timestamp_type] || :simple)
+        end
+
+        # Return true if timestamp type is 'trackable' and output in timestamp transaction has not been spent yet, otherwise return false.
+        def latest
+          trackable?
         end
       end
     end

data/lib/glueby/contract/errors.rb

@@ -5,6 +5,7 @@ module Glueby
       class InsufficientTokens < StandardError; end
       class InvalidAmount < StandardError; end
       class InvalidTokenType < StandardError; end
+      class InvalidTimestampType < StandardError; end
       class TxAlreadyBroadcasted < StandardError; end
       class UnsupportedTokenType < StandardError; end
       class UnknownScriptPubkey < StandardError; 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

@@ -9,6 +9,8 @@ module Glueby
     # Storing timestamp transaction to the blockchain enables everyone to verify that the data existed at that time and a user signed it.
     class Timestamp
       include Glueby::Contract::TxBuilder
+      
+      P2C_DEFAULT_VALUE = 1_000
 
       autoload :Syncer, 'glueby/contract/timestamp/syncer'
 
@@ -16,9 +18,28 @@ module Glueby
         include Glueby::Internal::Wallet::TapyrusCoreWalletAdapter::Util
         module_function
 
-        def create_txs(wallet, prefix, data, fee_estimator, utxo_provider)
+        # @param [Glueby::Wallet] wallet
+        # @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
+          group = ECDSA::Group::Secp256k1
+          p = Tapyrus::Key.new(pubkey: pubkey).to_point # P
+          commitment = Tapyrus.sha256(p.to_hex(true).htb + contents.join).bth.to_i(16) % group.order # H(P || 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] # [p2c address, P]
+        end
+
+        def create_txs(wallet, prefix, data, fee_estimator, utxo_provider, type: :simple)
           txb = Tapyrus::TxBuilder.new
-          txb.data(prefix + data)
+          if type == :simple
+            txb.data(prefix + data)
+          elsif type == :trackable
+            p2c_address, payment_base = create_pay_to_contract_address(wallet, contents: [prefix, data])
+            txb.pay(p2c_address, P2C_DEFAULT_VALUE)
+          end
+
           fee = fee_estimator.fee(dummy_tx(txb.build))
           if utxo_provider
             script_pubkey = Tapyrus::Script.parse_from_addr(wallet.internal_wallet.receive_address)
@@ -54,7 +75,7 @@ module Glueby
           end
 
           txb.fee(fee).change_address(wallet.internal_wallet.change_address)
-          [funding_tx, wallet.internal_wallet.sign_tx(txb.build, prev_txs)]
+          [funding_tx, wallet.internal_wallet.sign_tx(txb.build, prev_txs), p2c_address, payment_base]
         end
 
         def get_transaction(tx)
@@ -65,6 +86,9 @@ module Glueby
 
       attr_reader :tx, :txid
 
+      # p2c_address and payment_base is used in `trackable` type
+      attr_reader :p2c_address, :payment_base
+
       # @param [String] content Data to be hashed and stored in blockchain.
       # @param [String] prefix prefix of op_return data
       # @param [Glueby::Contract::FeeEstimator] fee_estimator
@@ -72,21 +96,29 @@ module Glueby
       # - :sha256
       # - :double_sha256
       # - :none
-      # @raise [Glueby::Contract::Errors::UnsupportedDigestType] if digest unsupport
+      # @param [Symbol] timestamp_type
+      # - :simple
+      # - :trackable
+      # @raise [Glueby::Contract::Errors::UnsupportedDigestType] if digest is unsupported
+      # @raise [Glueby::Contract::Errors::InvalidTimestampType] if timestamp_type is unsupported
       def initialize(
         wallet:,
         content:,
         prefix: '',
         fee_estimator: Glueby::Contract::FixedFeeEstimator.new,
         digest: :sha256,
-        utxo_provider: nil
+        utxo_provider: nil,
+        timestamp_type: :simple
       )
         @wallet = wallet
         @content = content
         @prefix = prefix
         @fee_estimator = fee_estimator
+        raise Glueby::Contract::Errors::UnsupportedDigestType, "#{digest} is invalid digest, supported digest are :sha256, :double_sha256, and :none."  unless [:sha256, :double_sha256, :none].include?(digest)
         @digest = digest
         @utxo_provider = utxo_provider
+        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
       end
 
       # broadcast to Tapyrus Core
@@ -96,7 +128,7 @@ module Glueby
       def save!
         raise Glueby::Contract::Errors::TxAlreadyBroadcasted if @txid
 
-        funding_tx, @tx = create_txs(@wallet, @prefix, digest_content, @fee_estimator, @utxo_provider)
+        funding_tx, @tx, @p2c_address, @payment_base = create_txs(@wallet, @prefix, digest_content, @fee_estimator, @utxo_provider, type: @timestamp_type)
         @wallet.internal_wallet.broadcast(funding_tx) if funding_tx
         @txid = @wallet.internal_wallet.broadcast(@tx)
       end

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)
@@ -190,9 +185,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
@@ -189,8 +187,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 +217,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 +280,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.5.2"
+  VERSION = "0.6.3"
 end

data/lib/glueby.rb

@@ -1,4 +1,5 @@
 require "glueby/version"
+require "glueby/constants"
 require 'tapyrus'
 
 module Glueby

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

@@ -12,7 +12,7 @@ module Glueby
           timestamps.each do |t|
             begin
               wallet = Glueby::Wallet.load(t.wallet_id)
-              funding_tx, tx = create_txs(wallet, t.prefix, t.content_hash, Glueby::Contract::FixedFeeEstimator.new, utxo_provider)
+              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)
@@ -21,7 +21,7 @@ module Glueby
               end
               ::ActiveRecord::Base.transaction do
                 wallet.internal_wallet.broadcast(tx) do |tx|
-                  t.update(txid: tx.txid, status: :unconfirmed)
+                  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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: glueby
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.6.3
 platform: ruby
 authors:
 - azuchi
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-12-06 00:00:00.000000000 Z
+date: 2021-12-22 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