glueby 0.5.1 → 0.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 37c10a4359a509cd4f86c35726161717bde07bc1ce459e19b0ba4c053e8dba86
-  data.tar.gz: 3cd0124ed69e0f34d1adf4ff5ed26005979689befc163c970b104245f267a479
+  metadata.gz: bd80045038551e7ffc41a613fb67401f3675c79098222e335359209070ff280a
+  data.tar.gz: f966a44bb7de60429e91d39681f63c6b827dbcb8806700cbfe6b5e961f013b2d
 SHA512:
-  metadata.gz: 68729802e9bcb1a51148c12daa1e1565180c300d43cc811c2c512056804ad2fb8cd0bd8dd0e0d915e19da2177b3a47a941a4911ce7f6376a47f598edade087fe
-  data.tar.gz: 902c5c0cf87cb940c9619e5f9af95367187a009ddc01d74a6604c22d8e9df9e50dec50df24455c6fb2f0a1a9020869e4d619bd879802739ba04118bf600fab6a
+  metadata.gz: 4e443a845c4d65eeba06c83d40617497b984f8a0c158e54debb1ac82d762af53ebba8073e8fc18855f93816370dc8969657bec8d8e95d5990df3fe50c9c7471a
+  data.tar.gz: 2c5f2670b48f6a1149052b239d89c626c323e21f222bd2deb201074b96d54ac935080624cb92a2399414aed03de44258a41da5b0fc4ecc5221d854ef201c06de

data/README.md

@@ -443,6 +443,20 @@ Configuration:
 
 ```
 
+## Other configurations
+
+### Default fixed fee for the FixedFeeEstimator
+
+The architecture of Glueby accepts any fee estimation strategies for paying transactions fee. However, we officially support only one strategy: the fixed fee strategy.
+It just returns a fixed fee value without any estimation.
+Here provides a configuration to modify the default fixed fee value it returns like this:
+
+```ruby
+Glueby.configure do |config|
+   config.default_fixed_fee = 10_000
+end
+```
+
 
 ## Development
 

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/configuration.rb

@@ -82,5 +82,11 @@ module Glueby
     def utxo_provider_config=(config)
       UtxoProvider.configure(config)
     end
+
+    # Set default fixed fee to the FixedFeeEstimator
+    # @param [Integer] fee The default fee value in tapyrus to the FixedFeeEstimator
+    def default_fixed_fee=(fee)
+      Contract::FixedFeeEstimator.default_fixed_fee = fee
+    end
   end
 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,7 +22,11 @@ module Glueby
     class FixedFeeEstimator
       include FeeEstimator
 
-      def initialize(fixed_fee: 10_000)
+      class << self
+        attr_accessor :default_fixed_fee
+      end
+
+      def initialize(fixed_fee: FixedFeeEstimator.default_fixed_fee || 10_000)
         @fixed_fee = 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/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.1"
+  VERSION = "0.6.2"
 end

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.1
+  version: 0.6.2
 platform: ruby
 authors:
 - azuchi
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-12-01 00:00:00.000000000 Z
+date: 2021-12-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tapyrus